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

From Genesys Documentation
Jump to: navigation, search
m (Text replacement - "\|Platform=([^\|]*)GenesysEngage-onpremises([\|]*)" to "|Platform=$1GenesysEngage-cloud$2")
(Published)
Line 6: Line 6:
 
|Dimension=initialization methods
 
|Dimension=initialization methods
 
|ComingSoon=No
 
|ComingSoon=No
−
|Platform=GenesysEngage-cloud, PureConnect, GenesysCloud
+
|Platform=PureConnect, GenesysCloud, GenesysEngage-cloud
−
|Prereq=
 
 
|Section={{Section
 
|Section={{Section
 
|sectionHeading=Description
 
|sectionHeading=Description
−
|anchor=
 
 
|alignment=Vertical
 
|alignment=Vertical
−
|Media=
+
|structuredtext=The <tt>init</tt> method initializes the Journey JavaScript SDK.
−
|image=
 
−
|structuredtext=The <tt>init</tt> method initializes the Journey JavaScriipt SDK.
 
  
  
 
{{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}}
−
|structuredtextwide=
 
−
|FAQHeading=
 
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
 
|sectionHeading=Signature
 
|sectionHeading=Signature
−
|anchor=
 
 
|alignment=Vertical
 
|alignment=Vertical
−
|Media=
 
−
|image=
 
 
|structuredtext=<tt>ac('init', organisationId, options)</tt>
 
|structuredtext=<tt>ac('init', organisationId, options)</tt>
−
|structuredtextwide=
 
−
|FAQHeading=
 
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
 
|sectionHeading=Arguments
 
|sectionHeading=Arguments
−
|anchor=
 
 
|alignment=Vertical
 
|alignment=Vertical
−
|Media=
 
−
|image=
 
 
|structuredtext=*[[#organizationID|organizationId]]
 
|structuredtext=*[[#organizationID|organizationId]]
 
*[[#options|options]]
 
*[[#options|options]]
−
|structuredtextwide=
 
−
|FAQHeading=
 
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
Line 46: Line 30:
 
|anchor=organizationID
 
|anchor=organizationID
 
|alignment=Vertical
 
|alignment=Vertical
−
|Media=
 
−
|image=
 
 
|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. {{Link-SomewhereInThisVersion|manual=SDK|topic=Init|anchor=FindOrgRegion|display text=Find your organization ID}}
 
*Type: string
 
*Type: string
Line 53: Line 35:
  
 
<br /><br />
 
<br /><br />
−
|structuredtextwide=
 
−
|FAQHeading=
 
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
Line 60: Line 40:
 
|anchor=options
 
|anchor=options
 
|alignment=Vertical
 
|alignment=Vertical
−
|Media=
 
−
|image=
 
 
|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}}
  
Line 125: Line 103:
 
{{!}} style="width: 62px;" data-mce-style="width: 62px;"{{!}} 
 
{{!}} style="width: 62px;" data-mce-style="width: 62px;"{{!}} 
 
{{!}}}
 
{{!}}}
−
|structuredtextwide=
 
−
|FAQHeading=
 
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
Line 135: Line 111:
 
|image=InitOrgIDRegionID.png
 
|image=InitOrgIDRegionID.png
 
|structuredtext=Go to '''Genesys Cloud''' > '''Admin''' > '''Tracking Snippet'''.
 
|structuredtext=Go to '''Genesys Cloud''' > '''Admin''' > '''Tracking Snippet'''.
−
|structuredtextwide=
 
−
|FAQHeading=
 
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
Line 142: Line 116:
 
|anchor=RegionNamesIDs
 
|anchor=RegionNamesIDs
 
|alignment=Vertical
 
|alignment=Vertical
−
|Media=
 
−
|image=
 
 
|structuredtext=The following table lists the available region names and corresponding Ids.
 
|structuredtext=The following table lists the available region names and corresponding Ids.
 
{{{!}} class="wikitable"
 
{{{!}} class="wikitable"
Line 177: Line 149:
 
{{!}}apse2
 
{{!}}apse2
 
{{!}}}
 
{{!}}}
−
|structuredtextwide=
 
−
|FAQHeading=
 
 
|Status=No
 
|Status=No
 
}}
 
}}
 
}}
 
}}

Revision as of 13:38, September 14, 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 Journey JavaScript 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 Genesys Cloud > Admin > Tracking Snippet.

Region names and IDs

The following table lists the available region names and corresponding Ids.

Region name ID
Americas (US West) usw2
Americas (US East) use1
Americas (Canada) cac1
EMEA (Dublin) euw1
EMEA (London) euw2
EMEA (Frankfurt) euc1
Asia Pacific (Tokyo) apne1
Asia Pacific (Seoul) apne2
Asia Pacific (Sydney) apse2
Retrieved from "https://all.docs.genesys.com/ATC/Current/SDK/Init (2025-06-19 02:20:18)"
Comments or questions about this documentation? Contact us for support!