From Genesys Documentation
(Published) |
(Published) |
||
Line 3: | Line 3: | ||
|DisplayName=init | |DisplayName=init | ||
|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 | |Dimension=initialization methods | ||
|ComingSoon=No | |ComingSoon=No | ||
|Platform=PureConnect, GenesysCloud, GenesysEngage-cloud | |Platform=PureConnect, GenesysCloud, GenesysEngage-cloud | ||
|Section={{Section | |Section={{Section | ||
+ | |alignment=Vertical | ||
+ | |structuredtext={{NoteFormat|1=This article only applies to customers using {{Link-AnywhereElse|product=ATC|version=Current|manual=AdminGuide|topic=About_web_chats|display text=web chat}}. If you are a Genesys Cloud customer, we encourage you to use the new {{Link-AnywhereElse|product=ATC|version=Current|manual=AdminGuide|topic=About_web_messaging|display text=web messaging}} feature to replace web chat.|2=}}<br /> | ||
+ | |Status=No | ||
+ | }}{{Section | ||
|sectionHeading=Description | |sectionHeading=Description | ||
|alignment=Vertical | |alignment=Vertical |
Revision as of 10:37, August 10, 2021
Difference between revisions of "ATC/Current/SDK/Init"
Learn how to use the init method to initialize the Journey JavaScript SDK.
Important
This article only applies to customers using web chat. If you are a Genesys Cloud customer, we encourage you to use the new web messaging feature to replace web chat.Description
The init method initializes the Journey JavaScript SDK.
Important
For GDPR compliance, 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
- Description: Your organization's unique ID. Find your organization ID
- Type: String
- Status: Required
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: See the following table.
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 visitor'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
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 |
Comments or questions about this documentation? Contact us for support!