Difference between revisions of "ATC/Current/SDK/Init"

From Genesys Documentation
Jump to: navigation, search
(Published)
Line 2: Line 2:
 
|Standalone=No
 
|Standalone=No
 
|DisplayName=init
 
|DisplayName=init
−
|Platform=PureEngage, PureConnect, PureCloud
 
 
|TocName=init
 
|TocName=init
 +
|Context=Learn how to use the <tt>init</tt> method to initialize the Journey JavaScript SDK.
 
|ComingSoon=No
 
|ComingSoon=No
−
|Context=Learn how to use the <tt>init</tt> method to initialize the Journey JavaScript SDK.
+
|Platform=PureEngage, PureConnect, PureCloud
 
|Section={{Section
 
|Section={{Section
 
|sectionHeading=Description
 
|sectionHeading=Description
−
|Standalone=No
 
−
|ComingSoon=No
 
 
|alignment=Vertical
 
|alignment=Vertical
 
|structuredtext=The i<tt>nit</tt> method initializes the {{MINTYDOCSPRODUCT}} SDK.
 
|structuredtext=The i<tt>nit</tt> method initializes the {{MINTYDOCSPRODUCT}} SDK.
Line 15: Line 13:
  
 
{{NoteFormat|For GDPR compliance, be sure to obtain a customer's consent before you call the <tt>init</tt> method. For more information about how to use {{MINTYDOCSPRODUCT}} in a GDPR-compliant manner, see {{#mintydocs_link:manual=AdminGuide|topic=GDPR|link text=GDPR}}. |1}}
 
{{NoteFormat|For GDPR compliance, be sure to obtain a customer's consent before you call the <tt>init</tt> method. For more information about how to use {{MINTYDOCSPRODUCT}} in a GDPR-compliant manner, see {{#mintydocs_link:manual=AdminGuide|topic=GDPR|link text=GDPR}}. |1}}
−
|fullwidth=No
 
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
 
|sectionHeading=Signature
 
|sectionHeading=Signature
−
|Standalone=No
 
−
|ComingSoon=No
 
 
|alignment=Vertical
 
|alignment=Vertical
 
|structuredtext=<tt>ac('init', organisationId, options)</tt>
 
|structuredtext=<tt>ac('init', organisationId, options)</tt>
Line 26: Line 21:
 
}}{{Section
 
}}{{Section
 
|sectionHeading=Arguments
 
|sectionHeading=Arguments
−
|Standalone=No
 
−
|ComingSoon=No
 
 
|alignment=Vertical
 
|alignment=Vertical
−
|structuredtext=* [[#organizationID|organizationId]]
+
|structuredtext=*[[#organizationID|organizationId]]
−
* [[#options|options]]
+
*[[#options|options]]
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
 
|sectionHeading=organizationId
 
|sectionHeading=organizationId
−
|Standalone=No
+
|anchor=organizationID
−
|ComingSoon=No
 
 
|alignment=Vertical
 
|alignment=Vertical
−
|anchor=organizationID
+
|structuredtext=*Description: your organization's unique ID. {{Link-SomewhereInThisVersion|manual=SDK|topic=Init|anchor=FindOrgRegion|display text=Find your organization ID}}
−
|structuredtext=* Description: your organization's unique ID, which you can get from [https://app.genesys.cloud/journey/admin/#/settings/tracking-snippet https://app.genesys.cloud/journey/admin/#/settings/tracking-snippet].
+
*Type: string
−
* Type: string
+
*Status: required
−
* Status: required
+
 
 +
<br /><br />
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
 
|sectionHeading=options
 
|sectionHeading=options
 
|anchor=options
 
|anchor=options
−
|Standalone=No
 
−
|ComingSoon=No
 
 
|alignment=Vertical
 
|alignment=Vertical
 
|structuredtext={{NoteFormat|For detailed explanations of how you can use these options to configure tracking, see {{Link-SomewhereInThisVersion|manual=SDK|topic=Configure_advanced_tracking}}.|2}}
 
|structuredtext={{NoteFormat|For detailed explanations of how you can use these options to configure tracking, see {{Link-SomewhereInThisVersion|manual=SDK|topic=Configure_advanced_tracking}}.|2}}
−
* Description: configures the Journey JavaScript SDK with its region and other known default options.
+
 
−
* Type: object
+
*Description: configures the Journey JavaScript SDK with its region and other known default options.
−
* Status: required
+
*Type: object
−
* Properties:
+
*Status: required
 +
*Properties:
 +
 
 
{{{!}} class="wikitable" style="width: 1150px;" data-mce-style="width: 1150px;"
 
{{{!}} class="wikitable" style="width: 1150px;" data-mce-style="width: 1150px;"
 
{{!}}-
 
{{!}}-
Line 62: Line 55:
 
{{!}}-
 
{{!}}-
 
{{!}} style="width: 210.535px;" data-mce-style="width: 210.535px;"{{!}}region
 
{{!}} style="width: 210.535px;" data-mce-style="width: 210.535px;"{{!}}region
−
{{!}} style="width: 783.465px;" data-mce-style="width: 783.465px;"{{!}}Your organization's regions, which you can obtain from [https://app.genesys.cloud/journey/admin/#/settings/tracking-snippet https://app.genesys.cloud/journey/admin/#/settings/tracking-snippet]
+
{{!}} style="width: 783.465px;" data-mce-style="width: 783.465px;"{{!}}Your organization's region. {{Link-SomewhereInThisVersion|manual=SDK|topic=Init|anchor=FindOrgRegion|display text=Find your region ID}}
 
{{!}} style="width: 42px;" data-mce-style="width: 42px;"{{!}}String
 
{{!}} style="width: 42px;" data-mce-style="width: 42px;"{{!}}String
 
{{!}} style="width: 62px;" data-mce-style="width: 62px;"{{!}}Required
 
{{!}} style="width: 62px;" data-mce-style="width: 62px;"{{!}}Required
Line 109: Line 102:
 
{{!}} style="width: 62px;" data-mce-style="width: 62px;"{{!}} 
 
{{!}} style="width: 62px;" data-mce-style="width: 62px;"{{!}} 
 
{{!}}}
 
{{!}}}
−
|fullwidth=No
+
|Status=No
 +
}}{{Section
 +
|sectionHeading=Find your org ID and region ID
 +
|anchor=FindOrgRegion
 +
|alignment=Horizontal
 +
|Media=Image
 +
|image=InitOrgIDRegionID.png
 +
|structuredtext=Go to '''PureCloud''' > '''Admin''' > '''Tracking Snippet'''.
 
|Status=No
 
|Status=No
 
}}
 
}}
 
}}
 
}}

Revision as of 20:52, March 10, 2020

This topic is part of the manual Journey JavaScript SDK for version Current of Genesys Predictive Engagement.

Learn how to use the init method to initialize the Journey JavaScript SDK.

Description

The init method initializes the Genesys Predictive Engagement SDK.


Important
For GDPR compliance, be sure to obtain a customer's consent before you call the init method. For more information about how to use Genesys Predictive Engagement in a GDPR-compliant manner, see GDPR.

Signature

ac('init', organisationId, options)

Arguments

organizationId



options

Tip
For detailed explanations of how you can use these options to configure tracking, see Advanced tracking with cookies.
  • Description: configures the Journey JavaScript SDK with its region and other known default options.
  • Type: object
  • Status: required
  • Properties:
Name Description Type Status Default
region Your organization's region. Find your region ID String Required  
cookieDomain Sets a custom cookie domain String Optional Highest level domain possible
cookieExpires Sets a time in seconds for a customer's cookie to expire Number Optional 31536000 (1 year)
cookiePrefix Sets a custom cookie prefix String Optional  
autoLink An array of domains whose outbound links will be modified to contain tracking information. For an example, see Configure advanced tracking. Array of strings Optional  
allowedLinkers An array of domains whose inbound referral will set tracking information. For an example, see Configure advanced tracking. Array of strings Optional  
canonicalLink Uses canonical links Boolean Optional False
globalTraitsMapper Maps custom attributes to traits For more information, see Traits Mapper. Array Optional  

Find your org ID and region ID

Go to PureCloud > Admin > Tracking Snippet.
Retrieved from "https://all.docs.genesys.com/ATC/Current/SDK/Init (2025-06-19 11:04:34)"
Comments or questions about this documentation? Contact us for support!