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

From Genesys Documentation
Jump to: navigation, search
(Published)
(Published)
Line 4: Line 4:
 
|TocName=init
 
|TocName=init
 
|Context=Learn how to use the <tt>init</tt> method to initialize the Journey JavaScript SDK.
 
|Context=Learn how to use the <tt>init</tt> method to initialize the Journey JavaScript SDK.
 +
|Dimension= initialization methods
 
|ComingSoon=No
 
|ComingSoon=No
 
|Platform=PureEngage, PureConnect, PureCloud
 
|Platform=PureEngage, PureConnect, PureCloud
 +
|Prereq=
 
|Section={{Section
 
|Section={{Section
 
|sectionHeading=Description
 
|sectionHeading=Description
 +
|anchor=
 
|alignment=Vertical
 
|alignment=Vertical
−
|structuredtext=The i<tt>nit</tt> method initializes the {{MINTYDOCSPRODUCT}} SDK.
+
|Media=
 +
|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 29: Line 46:
 
|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 34: Line 53:
  
 
<br /><br />
 
<br /><br />
 +
|structuredtextwide=
 +
|FAQHeading=
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
Line 39: Line 60:
 
|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 102: Line 125:
 
{{!}} 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 110: Line 135:
 
|image=InitOrgIDRegionID.png
 
|image=InitOrgIDRegionID.png
 
|structuredtext=Go to '''PureCloud''' > '''Admin''' > '''Tracking Snippet'''.
 
|structuredtext=Go to '''PureCloud''' > '''Admin''' > '''Tracking Snippet'''.
 +
|structuredtextwide=
 +
|FAQHeading=
 
|Status=No
 
|Status=No
 
}}
 
}}
 
}}
 
}}

Revision as of 10:13, June 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 Journey JavaScriipt 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 06:28:13)"
Comments or questions about this documentation? Contact us for support!