Difference between revisions of "ATC/Current/SDK/Init"
From Genesys Documentation
DannaShirley (talk | contribs) (Published) |
DannaShirley (talk | contribs) (Published) |
||
| Line 5: | Line 5: | ||
|TocName=init | |TocName=init | ||
|ComingSoon=No | |ComingSoon=No | ||
| − | |Context= | + | |Context=Learn how to use the <tt>init</tt> method to initialize the Journey JavaScript SDK. |
|Section={{Section | |Section={{Section | ||
|sectionHeading=Description | |sectionHeading=Description | ||
| Line 79: | Line 79: | ||
{{!}}- | {{!}}- | ||
{{!}} style="width: 210.535px;" data-mce-style="width: 210.535px;"{{!}}autoLink | {{!}} style="width: 210.535px;" data-mce-style="width: 210.535px;"{{!}}autoLink | ||
| − | {{!}} style="width: 783.465px;" data-mce-style="width: 783.465px;"{{!}}An array of domains whose outbound links will be modified to contain tracking information. For an example, see{{Link-SomewhereInThisVersion|manual=SDK|topic=Configure_advanced_tracking|display text=Configure advanced tracking.}} | + | {{!}} style="width: 783.465px;" data-mce-style="width: 783.465px;"{{!}}An array of domains whose outbound links will be modified to contain tracking information. For an example, see {{Link-SomewhereInThisVersion|manual=SDK|topic=Configure_advanced_tracking|display text=Configure advanced tracking.}} |
{{!}} style="width: 42px;" data-mce-style="width: 42px;"{{!}}Array of strings | {{!}} style="width: 42px;" data-mce-style="width: 42px;"{{!}}Array of strings | ||
{{!}} style="width: 62px;" data-mce-style="width: 62px;"{{!}}Optional | {{!}} style="width: 62px;" data-mce-style="width: 62px;"{{!}}Optional | ||
| Line 85: | Line 85: | ||
{{!}}- | {{!}}- | ||
{{!}} style="width: 210.535px;" data-mce-style="width: 210.535px;"{{!}}allowedLinkers | {{!}} style="width: 210.535px;" data-mce-style="width: 210.535px;"{{!}}allowedLinkers | ||
| − | {{!}} style="width: 783.465px;" data-mce-style="width: 783.465px;"{{!}}An array of domains whose inbound referral will set tracking information. For an example, see{{Link-SomewhereInThisVersion|manual=SDK|topic=Configure_advanced_tracking|display text=Configure advanced tracking.}} | + | {{!}} style="width: 783.465px;" data-mce-style="width: 783.465px;"{{!}}An array of domains whose inbound referral will set tracking information. For an example, see {{Link-SomewhereInThisVersion|manual=SDK|topic=Configure_advanced_tracking|display text=Configure advanced tracking.}} |
{{!}} style="width: 42px;" data-mce-style="width: 42px;"{{!}}Array of strings | {{!}} style="width: 42px;" data-mce-style="width: 42px;"{{!}}Array of strings | ||
{{!}} style="width: 62px;" data-mce-style="width: 62px;"{{!}}Optional | {{!}} style="width: 62px;" data-mce-style="width: 62px;"{{!}}Optional | ||
| Line 97: | Line 97: | ||
{{!}}- | {{!}}- | ||
{{!}} style="width: 210.535px;" data-mce-style="width: 210.535px;"{{!}}globalTraitsMapper | {{!}} style="width: 210.535px;" data-mce-style="width: 210.535px;"{{!}}globalTraitsMapper | ||
| − | {{!}} style="width: 783.465px;" data-mce-style="width: 783.465px;"{{!}}Maps custom attributes to traits For more information, see{{Link-SomewhereInThisVersion|manual=SDK|topic=Traits_mapper|display text=Traits Mapper.}} | + | {{!}} style="width: 783.465px;" data-mce-style="width: 783.465px;"{{!}}Maps custom attributes to traits For more information, see {{Link-SomewhereInThisVersion|manual=SDK|topic=Traits_mapper|display text=Traits Mapper.}} |
{{!}} style="width: 42px;" data-mce-style="width: 42px;"{{!}}Array | {{!}} style="width: 42px;" data-mce-style="width: 42px;"{{!}}Array | ||
{{!}} style="width: 62px;" data-mce-style="width: 62px;"{{!}}Optional | {{!}} style="width: 62px;" data-mce-style="width: 62px;"{{!}}Optional | ||
Revision as of 20:44, October 10, 2019
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
Arguments
organizationId
options
- Description: configures the SDK with its region and other known default options.
- Type: object
- Status: required
- Properties:
| Name | Description | Type | Status | Default |
| region | Your organization's regions, which you can obtain from https://app.genesys.cloud/journey/admin/#/settings/tracking-snippet | 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 |
Comments or questions about this documentation? Contact us for support!