Difference between revisions of "ATC/Current/SDK/Init"
From Genesys Documentation
DannaShirley (talk | contribs) (Published) |
DannaShirley (talk | contribs) (Published) |
||
| Line 4: | Line 4: | ||
|Platform=PureEngage, PureConnect, PureCloud | |Platform=PureEngage, PureConnect, PureCloud | ||
|TocName=init | |TocName=init | ||
| + | |ComingSoon=No | ||
|Context=The <tt>init</tt> method initializes the {{MINTYDOCSPRODUCT}} SDK. | |Context=The <tt>init</tt> method initializes the {{MINTYDOCSPRODUCT}} SDK. | ||
|Section={{Section | |Section={{Section | ||
| Line 15: | Line 16: | ||
{{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 | |fullwidth=No | ||
| + | |Status=No | ||
}}{{Section | }}{{Section | ||
|sectionHeading=Signature | |sectionHeading=Signature | ||
|Type=Unstructured | |Type=Unstructured | ||
|freetext=<tt>ac('init', organisationId, options)</tt> | |freetext=<tt>ac('init', organisationId, options)</tt> | ||
| + | |Status=No | ||
}}{{Section | }}{{Section | ||
|sectionHeading=Arguments | |sectionHeading=Arguments | ||
| Line 24: | Line 27: | ||
|freetext=* [[#organizationID|organizationId]] | |freetext=* [[#organizationID|organizationId]] | ||
* [[#options|options]] | * [[#options|options]] | ||
| + | |Status=No | ||
}}{{Section | }}{{Section | ||
|sectionHeading=organizationId | |sectionHeading=organizationId | ||
| Line 31: | Line 35: | ||
* Type: string | * Type: string | ||
* Status: required | * Status: required | ||
| + | |Status=No | ||
}}{{Section | }}{{Section | ||
|sectionHeading=options | |sectionHeading=options | ||
| Line 92: | 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 | + | {{!}} 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 | ||
| Line 98: | Line 103: | ||
{{!}}} | {{!}}} | ||
|fullwidth=No | |fullwidth=No | ||
| + | |Status=No | ||
}} | }} | ||
}} | }} | ||
Revision as of 12:14, June 28, 2019
This topic is part of the manual Journey JavaScript SDK for version Current of Genesys Predictive Engagement.
The init method initializes the Genesys Predictive Engagement 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 | Array of strings | Optional | |
| allowedLinkers | An array of domains whose inbound referral will set tracking information | Array of strings | Optional | |
| canonicalLink | Uses canonical links | Boolean | Optional | False |
| globalTraitsMapper | Maps custom attributes to traits For more information, seeTraits Mapper. | Array | Optional |
Comments or questions about this documentation? Contact us for support!