Skip to content

Commit c096b41

Browse files
authored
Merge pull request #5870 from segmentio/DOC-775
Edits to Yahoo Audiences destination doc
2 parents c8c3f35 + 1eefb18 commit c096b41

File tree

1 file changed

+46
-58
lines changed
  • src/connections/destinations/catalog/actions-yahoo-audiences

1 file changed

+46
-58
lines changed

src/connections/destinations/catalog/actions-yahoo-audiences/index.md

Lines changed: 46 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -20,37 +20,38 @@ To connect your Yahoo Audiences Destination:
2020
2. Navigate to **Engage** > **Engage Settings** > **Destinations** and click **Add Destination**.
2121
3. Select **Yahoo Audiences**, select your Engage space as the source, and name your destination.
2222
4. Configure global destination settings on the **Settings** tab:
23-
- **Name**: Specify the destination name, for example “Yahoo Audiences Production”. This value will be only available in Segment.
24-
- **MDM ID**: Specify the MDM ID provided by your Yahoo DSP representative.
25-
- **Engage Space ID**: Specify the Engage Space ID. To locate Engage Space ID navigate to **Unify** > **Unify Settings** > **API Access**. This value identifies your customer node in Yahoo Data Taxonomy. Do not provide arbitrary values in this field, or any values other than your Engage Space ID.
26-
- **NOTE:** The destination displays an error if the provided value includes any characters other than [a-zA-Z0-9] and “_” (underscore). This is to prevent passing values not supported by Yahoo.
27-
- **Customer Description**: Provide an optional description for the integration.
28-
- Turn on the **Enable Destination** toggle.
29-
- Click **Save Changes** to save the destination.
30-
- This creates a new customer node in the Yahoo Data Taxonomy. The Customer node ID matches the Engage Space ID provided in the settings.
31-
5. Configure destination Action Mappings. Action Mappings determine the information sent from Engage to Yahoo Audiences destination. Below you will find general information on configuring the mapping, as well as specific configuration for various use-cases.
32-
- On the **Mapping** tab click **Add Mapping** and select **Sync to Yahoo Ads Segment**.
33-
- Within the mapping’s **Select events to map and send** configure whether the mapping should be triggered for all audiences connected to the destination, or for specific audiences only.
34-
- **NOTE:** Action mapping settings apply to all audiences that are processed by the mapping. The mapping can be configured to (1) process all audiences connected to the destination, or (2) only specific audiences. This can be helpful when enabling the GDPR flag only for specific audiences.
23+
24+
Settings | Details
25+
-------- | -------
26+
Name | Specify the destination name, for example “Yahoo Audiences Production”. This value is only available in Segment.
27+
MDM ID | Specify the MDM ID provided by your Yahoo DSP representative.
28+
Engage Space ID | Specify the Engage Space ID. To locate Engage Space ID navigate to **Unify** > **Unify Settings** > **API Access**. This value identifies your customer node in Yahoo Data Taxonomy. Don't provide arbitrary values in this field, or any values other than your Engage Space ID. <br><br>**Note:** The destination displays an error if the provided value includes any characters other than [a-zA-Z0-9] and “_” (underscore). This is to prevent passing values not supported by Yahoo.
29+
Customer Description | Provide an optional description for the integration.
30+
5. Turn on the **Enable Destination** toggle.
31+
6. Click **Save Changes** to save the destination.
32+
7. Configure destination Action Mappings. Action Mappings determine the information sent from Engage to the Yahoo Audiences destination.
33+
1. On the **Mapping** tab click **Add Mapping** and select **Sync to Yahoo Ads Segment**.
34+
2. Within the mapping’s **Select events to map and send** configure whether the mapping should be triggered for all audiences connected to the destination, or for specific audiences only.
35+
- **Note:** Action mapping settings apply to all audiences that are processed by the mapping. The mapping can be configured to process all audiences connected to the destination, or only specific audiences. This can be helpful when enabling the GDPR flag only for specific audiences.
3536
- To apply the mapping only to specific audiences, modify the trigger as follows:
3637
![A screenshot subscription settingsfor specific audience](images/yahoo-1.png)
3738
- To apply the mapping to all audiences, modify the trigger as follows:
3839
![A screenshot subscription settings for all audiences](images/yahoo-2.png)
39-
- Configure the mapping for **Email**, **Phone**, **Mobile Advertising Id** and **Device Type** fields. You can keep default mapping for these fields, if your data matches default mappings.
40-
- **NOTE:** The destination expects mobile advertising Id to be a combination of 2 fields: advertising Id and device type. If device type field is not available in your data, the destination deduces the platform (iOS /Android) based on advertising Id value formatting. If the value is capitalized - the destination assumes that this is iOS IDFA, otherwise the destination assumes that is Android DSP ID.
41-
- Configure whether **GDPR Flag** should be sent.
42-
- **NOTE:** **GDPR Flag** setting applies to the entire audience. Set this setting to TRUE if the audience is subject to GDPR regulations. If you have set **GDPR Flag** to YES, then populate **GDPR Consent Attributes** setting with the following IAB user consent attributes: “Access of Information” and “Personalization”. See more in [Yahoo DSP API documentation](https://developer.yahooinc.com/datax/guide/gdpr/faq/){:target="_blank"}. If **GDPR Flag** setting is set to YES, and **GDPR Consent Attributes** is not populated, audience sync will fail.
43-
- If you’ve opted to send a **GDPR Flag**, provide **GDPR Consent Attributes**.
44-
- Save the mapping by clicking **Save** button.
45-
6. Connect the Destination to the Audience and configure Audience Sync settings:
46-
- Navigate to **Engage** > **Audiences** > **(your audience)**, click **Add Destination** and select the destination you just created.
47-
- Configure how the audience should be synced. Enable **Send Track** and disable **Send Identify**.
48-
- Select the identifiers to be synced to Yahoo:
49-
- **Default Setup** - sends all email Ids available on a user profile
50-
- **Customized Setup** - configure the identifiers to be sent to Yahoo DSP*
51-
- If you’d like to send iOS IDFA and Android Advertising ID - turn on **Send Mobile IDs** and map MAIDs using **Customized Setup**.
52-
- Do not modify the **Placeholder** setting.
53-
- Click **Save Settings**.
40+
3. Configure the mapping for **Email**, **Phone**, **Mobile Advertising Id** and **Device Type** fields. You can keep default mapping for these fields, if your data matches default mappings.
41+
- **Note:** The destination expects the mobile advertising ID to be a combination of 2 fields: advertising ID and device type. If device type field is not available in your data, the destination deduces the platform (iOS /Android) based on advertising ID value formatting. If the value is capitalized - the destination assumes that this is iOS IDFA, otherwise the destination assumes that is Android DSP ID.
42+
4. Configure whether **GDPR Flag** should be sent.
43+
- **Note:** **GDPR Flag** setting applies to the entire audience. Set this setting to TRUE if the audience is subject to GDPR regulations. If you set the **GDPR Flag** to YES, then populate **GDPR Consent Attributes** setting with the following IAB user consent attributes: “Access of Information” and “Personalization”. See more in [Yahoo DSP API documentation](https://developer.yahooinc.com/datax/guide/gdpr/faq/){:target="_blank"}. If the **GDPR Flag** setting is set to YES, and **GDPR Consent Attributes** is not populated, the audience sync fails.
44+
5. Provide **GDPR Consent Attributes** if you opted to send a **GDPR Flag**.
45+
6. Save the mapping.
46+
8. Connect the Destination to the Audience and configure the Audience Sync settings.
47+
1. Navigate to **Engage** > **Audiences** > **(your audience)**. Click **Add Destination** and select the destination you just created.
48+
2. Configure how the audience should be synced. Enable **Send Track** and disable **Send Identify**.
49+
3. Select the identifiers to be synced to Yahoo:
50+
- **Default Setup**: Sends all email IDs available on a user profile.
51+
- **Customized Setup**: Configure the identifiers to be sent to Yahoo DSP.
52+
4. If you’d like to send iOS IDFA and Android Advertising ID - turn on **Send Mobile IDs** and map MAIDs using **Customized Setup**.
53+
5. Don't modify the **Placeholder** setting.
54+
6. Click **Save Settings**.
5455

5556
> info ""
5657
> Yahoo DSP supports the following identifiers: **email**, **phone**, **iOS IDFA**, **Android Advertising Id**. Segment hashes email and phone per Yahoo DSP requirements, so you don’t have to hash email and phone. Segment formats the phone to meet E.164 requirements: removes non-digit characters and adds “+” sign. Your phone trait/identifier must include country code, as Segment does not prepend phone with country code.
@@ -59,52 +60,39 @@ Once the Audience is connected to the Destination, Segment makes a request to Ya
5960

6061
{% include components/actions-fields.html %}
6162

62-
## Destination configurations for various use-cases
63+
## Destination configurations for various use cases
6364

64-
### Use-case 1
65+
### Use case 1
6566

6667
Email, phone, IOS IDFA and Android Advertising ID are available as Engage Identifiers.
6768

68-
- **Action Mappings**:
69-
Keep default field mappings.
70-
- **Audience Sync settings**:
71-
Select **Customized Setup**, and map available identifiers under the Identifiers section. You can select whether Engage should send First, Last or All Available identifiers.
72-
![A screenshot customized setup configuration](images/yahoo-3.png)
69+
Setting | Details
70+
------- | --------
71+
Action Mappings | Keep default field mappings.
72+
Audience Sync settings | Select **Customized Setup**, and map available identifiers under the Identifiers section. You can select whether Engage should send First, Last, or All Available identifiers.
7373

74-
### Use-case 2
74+
### Use case 2
7575

7676
Email, phone, IOS IDFA and Android Advertising Id are available as Engage Identifiers and/or Traits.
7777

78-
- **Action Mappings**:
79-
Modify the mapping to reflect your custom trait names. For example, if you’re planning to send ‘email_addr’ trait as email to Yahoo Audiences, map ‘email_addr’ trait in the **User Email** field.
80-
![A screenshot user email field configuration](images/yahoo-4.png)
81-
- **Audience Sync settings**:
82-
Click **Customized Setup** and select the **Identifiers** and **Traits** that you are planning to send to Yahoo Audiences. For example, if you are planning to send ‘phone’ identifier and ‘email_addr’ trait, map these fields as shown below:
83-
![A screenshot customized setup configuration with traits](images/yahoo-5.png)
84-
85-
### Use-case 3
86-
Sending mobile advertising Id custom traits to Yahoo Audiences.
87-
88-
- **Action Mappings**:
89-
The destination expects 2 fields for mobile advertising Id: advertising Id field (trait) storing the Id value itself, and device type field (trait) storing mobile platform name (‘ios’ or ‘android’).
90-
91-
If your Engage data includes these 2 fields, you can map them as follows:
92-
![A screenshot mapping settings for 2 fields](images/yahoo-6.png)
78+
Settings | Details
79+
-------- | --------
80+
Action Mappings | Modify the mapping to reflect your custom trait names. For example, if you’re planning to send `email_addr` trait as email to Yahoo Audiences, map `email_addr` trait in the **User Email** field.
81+
Audience Sync settings | Click **Customized Setup** and select the **Identifiers** and **Traits** that you plan to send to Yahoo Audiences. For example, if you plan to send `phone` identifier and `email_addr` trait, map these fields as shown below: ![A screenshot customized setup configuration with traits](images/yahoo-5.png)
9382

94-
If your data does not include a field with the device type, you can map only the advertising Id trait. The destination detects device type based on the Id value format: Apple IDFA is typically capitalized, and Android advertising Id is typically lowercase.
95-
![A screenshot mapping settings for when device type is not included](images/yahoo-7.png)
83+
### Use case 3
84+
Send mobile advertising ID custom traits to Yahoo Audiences.
9685

97-
If you have separate traits for iOS IDFA and Android Advertising Id, you can map them using coalesce() function:
98-
![A screenshot mapping settings for iOS IDFA](images/yahoo-8.png)
86+
Settings | Details
87+
-------- | --------
88+
Action Mappings | The destination expects 2 fields for mobile advertising ID: 1) advertising ID field (trait) storing the ID value iteself, and 2) device type field (trait) storing mobile platform name (`ios` or `android`). <br><br>* If your Engage data includes these 2 fields, you can map them as: `traits.advertising_id_trait` &rarr; `User Mobile Advertising ID` and `traits.device_type_trait` &rarr; `User Mobile Device Type`. <br><br> * If your data doesn't include a field with the device type, you can only map the advertising ID trait. The destination detects device type based on the ID value format. Apple IDFA is typically capitalized, and Android advertising ID is typically lowercase. <br><br> * If you have separate traits for iOS IDFA and Android Advertising ID, you can map them using the coalesce() function: `coalesce( traits.ios_ad_id_trait`, `traits.android_ad_id_trait)` &rarr; `User Mobile Advertising ID`
89+
Audience Sync settings | Use **Customized Setup** to map custom advertising ID and, if available, device type traits. ![A screenshot customized setup configuration for use-case 3](images/yahoo-9.png)
9990

100-
- **Audience Sync settings**:
101-
Use Customized Setup to map custom advertising Id and, if available, device type traits:
102-
![A screenshot customized setup configuration for use-case 3](images/yahoo-9.png)
10391

10492
## FAQs
10593

10694
### Why am I seeing the difference between audience size in Engage and in Yahoo DSP?
10795
The difference between audience size in Segment and in Yahoo DSP is expected due to ID matching. Yahoo DSP will recognize only users it has matching ID (email / phone / MAID) for.
10896

10997
### The audience has synced, but I’m seeing 0 population in Yahoo DSP UI.
110-
As soon as user records land in Yahoo DSP, users become targetable in minutes. However, Yahoo DSP reporting is not realtime, and might take 24-48 hrs to catch up. This delay does not affect targeting. Because of that you might see 0 users in the Yahoo DSP audience immediately after the sync.
98+
As soon as user records land in Yahoo DSP, users become targetable in minutes. However, Yahoo DSP reporting is not realtime, and might take 24-48 hours to catch up. This delay does not affect targeting. Because of that you might see 0 users in the Yahoo DSP audience immediately after the sync.

0 commit comments

Comments
 (0)