As you go through this template, replace or delete all the paragraphs in italics (starting with this one).
Start by updating the metadata (title and description) at the top of the page. Please ignore all instances of UICONTROL on this page. This is a tag that helps our machine translation processes correctly translate the page into the multiple languages that we support. We will add tags to your documentation after you submit it.
Provide a short overview of your company, including the value it provides to customers. Include a link to your product documentation homepage, for further reading.
This destination connector and documentation page are created and maintained by the YourDestination team. For any inquiries or update requests, please contact them directly at Insert link or email address where you can be reached for updates, for example support@YourDestination.com
.
To help you better understand how and when you should use the YourDestination destination, here are sample use cases that Adobe Experience Platform customers can solve by using this destination.
For mobile messaging platforms:
A home rental and sales platform wants to push mobile notifications to customers’ Android and iOS devices to let them know that there are 100 updated listings in the area where they previously searched for a rental.
For social network platforms:
An athletic apparel brand wants to reach existing customers through their social media accounts. The apparel brand can ingest email addresses from their own CRM to Adobe Experience Platform, build audiences from their own offline data, and send these audiences to YourDestination, to display ads in their customers’ social media feeds.
Add information in this section about anything that customers need to be aware of before starting to set up the destination in the Adobe Experience Platform user interface. This can be about:
You can link out to your relevant documentation if that would be useful to customers.
Add information in this section about the identities supported by your destination. We have prefilled the table with some standard values. Delete the values that don’t apply to your destination and/or add any values that are not prefilled.
YourDestination supports the activation of identities described in the table below. Learn more about identities.
Target Identity | Description | Considerations |
---|---|---|
GAID | Google Advertising ID | Select the GAID target identity when your source identity is a GAID namespace. |
IDFA | Apple ID for Advertisers | Select the IDFA target identity when your source identity is an IDFA namespace. |
ECID | Experience Cloud ID | A namespace that represents ECID. This namespace can also be referred to by the following aliases: “Adobe Marketing Cloud ID”, “Adobe Experience Cloud ID”, “Adobe Experience Platform ID”. Read the following document on ECID for more information. |
phone_sha256 | Phone numbers hashed with the SHA256 algorithm | Both plain text and SHA256 hashed phone numbers are supported by Adobe Experience Platform. When your source field contains unhashed attributes, check the Apply transformation option, to have Platform automatically hash the data on activation. |
email_lc_sha256 | Email addresses hashed with the SHA256 algorithm | Both plain text and SHA256 hashed email addresses are supported by Adobe Experience Platform. When your source field contains unhashed attributes, check the Apply transformation option, to have Platform automatically hash the data on activation. |
extern_id | Custom user IDs | Select this target identity when your source identity is a custom namespace. |
Add information in this section about the audiences supported by your destination. We have prefilled the table with some standard values. Use the ✓
and X
characters to mark whether your audience type is supported by this destination.
This section describes which types of audiences you can export to this destination.
Audience origin | Supported | Description |
---|---|---|
Segmentation Service | ✓ | Audiences generated through the Experience Platform Segmentation Service. |
Custom uploads | X | Audiences imported into Experience Platform from CSV files. |
In the table, keep only the lines that correspond to your destination. You should have one line for Export type and one line for Export frequency. Delete the values that don’t apply to your destination.
Refer to the table below for information about the destination export type and frequency.
Item | Type | Notes |
---|---|---|
Export type | Audience export | You are exporting all members of an audience with the identifiers (name, phone number, or others) used in the YourDestination destination. |
Export type | Profile-based | You are exporting all members of an audience, together with the desired schema fields (for example: email address, phone number, last name), as chosen in the select profile attributes screen of the destination activation workflow. |
Export type | Dataset export | You are exporting raw datasets, which are not grouped or structured by audience interests or qualifications. |
Export frequency | Streaming | Streaming destinations are “always on” API-based connections. As soon as a profile is updated in Experience Platform based on audience evaluation, the connector sends the update downstream to the destination platform. Read more about streaming destinations. |
Export frequency | Batch | Batch destinations export files to downstream platforms in increments of three, six, eight, twelve, or twenty-four hours. Read more about batch file-based destinations. |
To connect to the destination, you need the View Destinations and Manage Destinations access control permissions. Read the access control overview or contact your product administrator to obtain the required permissions.
To connect to this destination, follow the steps described in the destination configuration tutorial. In the configure destination workflow, fill in the fields listed in the two sections below.
Add the fields that customers must fill in when authenticating to your destination. These fields are destination-specific and depend on your configuration in Destination SDK. Your destination’s fields may not be the same as the ones listed below. Please also include a screenshot similar to the sample screenshot shown below.
To authenticate to the destination, fill in the required fields and select Connect to destination.
Add the fields that customers must fill in when configuring a new destination. These fields are destination-specific and depend on your configuration in Destination SDK. Your destination’s fields may not be the same as the ones listed below. Please also include a screenshot similar to the sample screenshot shown below.
To configure details for the destination, fill in the required and optional fields below. An asterisk next to a field in the UI indicates that the field is required.
You can enable alerts to receive notifications on the status of the dataflow to your destination. Select an alert from the list to subscribe to receive notifications on the status of your dataflow. For more information on alerts, read the guide on subscribing to destinations alerts using the UI.
When you are finished providing details for your destination connection, select Next.
Delete as appropriate - If you are documenting a new streaming destination, keep the first paragraph below. If you are documenting a new file-based destination, keep the second paragraph. If you are documenting a destination that exports datasets, keep the third paragraph.
Read Activate profiles and audiences to streaming audience export destinations for instructions on activating audiences to this destination.
Read Activate audience data to batch profile export destinations for instructions on activating audiences to this destination.
Read (Beta) Export datasets for extensive instructions on exporting datasets to this destination.
Add information about supported mappings between source and target fields in the Mapping step of the activation workflow. Your destination might support exporting profile attributes, identity namespaces, or both. Some fields might be mandatory. Target attributes might be predefined or custom. Call out the important caveats and use examples, preferably with screenshots. Two examples of destination pages which you can use as reference are:
Add a paragraph about how data is exported to your destination. This would help the customer make sure that they have correctly integrated with your destination. For example, you could provide a sample JSON like the one below. Or, you could provide screenshots and information from your destination’s interface that show how customers should expect audiences to be populating in the destination platform.
{
"person": {
"email": "yourstruly@adobe.com"
},
"segmentMembership": {
"ups": {
"7841ba61-23c1-4bb3-a495-00d3g5fe1e93": {
"lastQualificationTime": "2020-05-25T21:24:39Z",
"status": "exited"
},
"59bd2fkd-3c48-4b18-bf56-4f5c5e6967ae": {
"lastQualificationTime": "2020-05-25T23:37:33Z",
"status": "realized"
}
}
},
"identityMap": {
"ecid": [
{
"id": "14575006536349286404619648085736425115"
},
{
"id": "66478888669296734530114754794777368480"
}
],
"email_lc_sha256": [
{
"id": "655332b5fa2aea4498bf7a290cff017cb4"
},
{
"id": "66baf76ef9de8b42df8903f00e0e3dc0b7"
}
]
}
}
All Adobe Experience Platform destinations are compliant with data usage policies when handling your data. For detailed information on how Adobe Experience Platform enforces data governance, read the Data Governance overview.
You can provide further links to your product documentation or any other resources that you consider important for the customer to be successful.