## Configuring the Zeotap Collect Extension
Enter the following details to configure the Zeotap Collect Extension:
* **Write Key** - When you create an Adobe Experience Platform Tag Extension source in your Sources account, a Write Key is auto-generated by the system. This is a mandatory field for recording events.
* **Consent Method** – The Zeotap Collect Extension has three different options to communicate consent. While initialising, you can set options for the extension to consume consent according to your requirements. **Note that, in any of these methods, you can send** **Brand Consent fields.**
* **Default Opt-in** – This option signifies whether the extension can record events or not. When selected, the extension has the consent to capture events, collect user identities or cookie syncing and is used as a fallback when user consent is not specified. By default, Explicit is enabled as the Consent Method unless you select otherwise.
\--> Note that for this consent type, the `setConsent` string (including the **Track, Cookie Sync, and Identify** fields) will not be considered.
\--> When the **TCF API** is available, you can also send the **TC string**.
\--> To send **Brand Consent** fields, use the options under **Rules > Actions > Extension: Zeotap Collect**, and select **Action Type: Set Custom Consent**, as shown below.
* **Custom** – This method is relevant when you do not want to give consent explicitly or even use the TCF API. Instead, you have your own custom consent flow. If you opt for this option, ensure that you are also implementing the `setConsent` **(Track, Cookie Sync and Identify)** action provided by the extension, in order to resolve consent for Zeotap extension.
\--> When the **TCF API** is available, you can also send the **TC string**.
\--> To send **Brand Consent** fields, use the options under **Rules > Actions > Extension: Zeotap Collect**, and select **Action Type: Set Custom Consent**.
* **GDPR** – This method automatically checks for a [TCF 2.0 Consent Management Platform (CMP)](https://iabeurope.eu/tcf-2-0/) implemented on your website. If you already have a TCF 2.0 CMP implemented on your website, then the extension resolves consent by querying the [TCF API](https://github.com/InteractiveAdvertisingBureau/GDPR-Transparency-and-Consent-Framework/blob/master/TCFv2/IAB%20Tech%20Lab%20-%20CMP%20API%20v2.md). The JavaScript that the extension adds to the page also queries the TCF consent string to fetch the Publisher’s consent before recording the events.
\--> When the **TCF API** is available, you can also send the **TC string**.
\--> To send **Brand Consent** fields, use the options under **Rules > Actions > Extension: Zeotap Collect**, and select **Action Type: Set Custom Consent**.
The following are the parameters that need to be configured while using the GDPR consent type:
* **Purposes for track** – This option is used to pass a list of purpose IDs, based on which you can manage the consent for tracking. By default, the three options shown in the image below are selected. However, You can modify them using the drop-down menu.
* **Check for Zeotap vendor consent** – You can select the **Check for Zeotap vendor consent** checkbox to allow the extension to verify the Zeotap vendor consent in the `tcdata` (consent data JSON generated by the CMP on the website) before capturing events. By default, the **Check for Zeotap vendor consent** checkbox is unchecked.
* **PII Hashing Configurations** – This option allows you to configure how Personally Identifiable Information ([PIIs](/articles/integrate-customer/implement-an-adobe-experience-platform-tag-extension-source#h3_1165312883)) like email, cellphone and more must be collected by Zeotap. The following are the PIIs hashing configurations available:
* **PIIs (email, cellphone) are hashed by the customer** – The client sends [hashed user PIIs](/articles/integrate-customer/implement-an-adobe-experience-platform-tag-extension-source#h4_1951363256) in the formats of `SHA256`, `MD5` and `SHA1` as mentioned in the table below.
* **PIIs (email, cellphone) are raw and must be hashed by Zeotap** – The client sends [raw user PIIs](/articles/integrate-customer/implement-an-adobe-experience-platform-tag-extension-source#h4__2008758683), but they want Zeotap to hash them in the formats of `SHA256`, `MD5` and `SHA1` as mentioned in the table below.
* **PIIs (email, cellphone) are raw and must be consumed as is** – The client sends [raw user PIIs](/articles/integrate-customer/implement-an-adobe-experience-platform-tag-extension-source#h4__2008758683) and they do not want Zeotap to hash them
* **Country Code**– This option allows you to enter the ISO Alpha 3 country code for the country that you want to associate your users with.
## User Identities
User information is available in the form of identifiers that can be categorised as below.
* Personal Identifiable Information (PII)
* Raw User PII
* Hashed User PII
* Custom Identities
### Personal Identifiable Information (PII)
Personal Identifiable Information (PII) is any data that confirms an individual's identity. Zeotap extension accepts email address, cellphone number, login Id and so on as PIIs. PII can be categorised as *Raw User PII* and *Hashed User PII*.
#### Raw User PII
The client captures user identities in the raw form and may or may not want Zeotap to hash them. The Raw User PIIs supported by Zeotap are listed below.
| **Raw User PII** | **Description** |
| ---------------- | ------------------------------------------------------------------------- |
| fpuid | This is the first-party ID for a given user, such as a `crmID` or `DBID`. |
| email | This is the user's raw email address. |
| cellno | This is the user's raw cell phone number. |
| loginid | This is the user’s login ID. |
| cellno\_cc | This is the user's raw cell phone number with the country code. |
#### Hashed User PII
The client only sends in user PII that are hashed using algorithms like `SHA-256`, `SHA1` and `MD5`. The Hashed User PIIs supported by Zeotap are listed below.
| **HASHED USER PII** | **DESCRIPTION** |
| ------------------------------------ | ------------------------------------------------------------------------------------------------------------- |
| `fpuid` | This is the first-party ID for a given user, such as a `crmID` or `DBID`. |
| `email_sha256_lowercase` | This is the user's email address hashed to `sha256` after converting it to lowercase. |
| `email_sha256_uppercase` | This is the user's email address hashed to `sha256` after converting it to uppercase. |
| `email_md5_lowercase` | This is the user's email address hashed to `md5` after converting it to lowercase. |
| `email_md5_uppercase` | This is the user's email address hashed to `md5` after converting to uppercase. |
| `email_sha1_lowercase` | This is the user's email address hashed to `sha1` after converting to lowercase. |
| `email_sha1_uppercase` | This is the user's email address hashed to `sha1` after converting to uppercase. |
| `cellno_without_country_code_sha256` | This is the user's cell phone number without the country code and hashed to `sha256`. |
| `cellno_without_country_code_md5` | This is the user's cell phone number without the country code and hashed to `md5`. |
| `cellno_without_country_code_sha1` | This is the user's cell phone number without the country code and hashed to `sha1`. |
| `cellno_with_country_code_sha256` | This is the user's cell phone number with the country code and hashed to `sha256`. |
| `cellno_with_country_code_md5` | This is the user's cell phone number with the country code and hashed to `md5`. |
| `cellno_with_country_code_sha1` | This is the user's cell phone number with the country code and hashed to `sha1`. |
| `cellno_e164_sha256` | This is the user's cell phone number in e164 format hashed to `sha256`. |
| `cellno_e164_sha1` | This is the user's cell phone number in e164 format hashed to `sha1`. |
| `cellno_e164_md5` | This is the user's cell phone number in e164 format hashed to `md5`. |
| `loginid_sha256_lowercase` | This is the user’s login ID that is logged. The login ID is hashed to `sha256` after converting to lowercase. |
| `loginid_sha256_uppercase` | This is the user’s login ID that is logged. The login ID is hashed to `sha256` after converting to uppercase. |
| `loginid_md5_lowercase` | This is the user’s login ID that is logged. The login ID is hashed to `md5` after converting to lowercase. |
| `loginid_md5_uppercase` | This is the user’s login ID that is logged. The login ID is hashed to `md5` after converting to uppercase. |
| `loginid_sha1_lowercase` | This is the user’s login ID that is logged. The login ID is hashed to `sha1` after converting to lowercase. |
| `loginid_sha1_uppercase` | This is the user’s login ID that is logged. The login ID is hashed to `sha1` after converting to uppercase. |
### Custom Identities
Custom identities are the identities that the client chooses to input and can be any of their first-party identifiers. Hashing configurations are not applicable for custom identities. Some examples of custom identities are `crmID`, `ECID` and `visitorID`.
* **Load Zeotap SDK** – You can select Load Zeotap SDK as the action type for all the rules that involve the Zeotap Collect Extension. This ensures that the Collect JavaScript is stamped on the client's website.
* **Set Custom Consent** – If you choose **Custom** as the consent mechanism while configuring the Zeotap Collect Extension, then ensure to set up the **Set Custom Consent** action under **Rules**.
* **Sync User Identities** – Set the key-value pairs for the identities to be captured (includes User PIIs and Custom Identities like ECID, crmID, visitorID).
* **Track Event**– The available **Event Types** and the resulting actions are explained in the table below.
| **EVENT TYPE** | **DESCRIPTION** |
| --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Page View | • Set the key-value pair based on your data tracking requirement. For example, page name, page category and so on.
|
| User Attributes | • Set the key-value pair based on the user attributes that you want to capture as a part of the event. For example, age, gender and so on.
|
## Cookie Sync
Zeotap allows you to collect the user’s web data from different platforms and target the users by cookie syncing with selected partners. You can use the Zeotap's list of integrated partners for cookie syncing.
* To verify that the integration is functioning properly, enter Zeotap on the Console tab. The expected response is the object displayed below.
`e {_q: Array(0), _qcmp:Array(0)}`
* **POST call:** After you implement the Zeotap Track Event action, you can see these POST calls under the Network section. The expected POST call is 204 > ok.
### Step 3: Transmission of ID5 id to Zeotap
1. Zeotap interacts with ID5 and attempts to retrieve the ID5 id.
2. This ID (if obtained) is then transmitted in all events under user node in the payload.
3. ID5 User id is then logged into the zeotap platform.
## Troubleshooting
| **Known Issue** | **Error** | **Reason** | **Resolution** |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| In some cases, the Zeotap action scripts can run into a race condition. In such cases the rules implementing **Track Event** or **Sync User Identities** can throw an error. | • VM3703:2 Uncaught (in promise) TypeError: `Cannot read properties of undefined (reading 'setPageProperties')`• Uncaught (in promise) TypeError: `Cannot read properties of undefined (reading 'setUserIdentities';)` | This occurs when the Zeotap Init and Track Event/Sync User Identities actions are occurring at the same time. As a result, the Zeotap SDK methods are being called before the Zeotap JS is initialised on the page. | To fix this, a Custom Code Event is used to fire the *Track Event/Sync User Identities* rule, which checks if the Zeotap SDK is initialised or not. Here is an example of how to create a Custom Code Event:
`// this code checks if zeotap is initialised after every 1 second, once initialised it triggers the event and clears the interval.`
`const interval = setInterval(() => {`
`if (window.zeotap) {`
`// Zeotap script initialised`
`trigger()`
`clearInterval(interval)`
`}`
`}, 1000)`
| ## Use Cases Learn more about implementing the Adobe Experience Platform Tag Extension through the use cases explained below. ### Use Case 1: Add to Cart Event This use case explains how to configure the Add to Cart event on the Adobe Experience Platform. After you add and configure the Tag by providing the Write key, Consent method and PII hashing configuration, you must set the Rules for the Add to Cart event by specifying the actions to occur if the condition is met.
