Configure destinations for StackAdapt¶
StackAdapt is a programmatic advertising platform for running campaigns across display, native, video, connected TV, audio, and digital out-of-home channels. Send customer profiles and audiences to StackAdapt for audience targeting.
You can configure Amperity to send customer profiles and audience membership to a StackAdapt CRM audience using the StackAdapt GraphQL API. The email field is required and is the only audience primary key. Amperity sends email addresses and every other value as they appear in Amperity; it does not hash or normalize them. Rows with no email address are skipped and counted as failed.
Amperity matches column names to StackAdapt profile fields without regard to case:
Amperity column |
StackAdapt profile field |
|---|---|
amperity_id |
|
|
|
first_name |
|
last_name |
|
phone |
|
address |
|
city |
|
state |
|
country |
|
postal_code |
|
timezone |
|
birth_date |
|
Every other column is sent as a custom field named after the column. Its type follows the column’s type: dates and datetimes are sent as dates, integers and decimals as numbers, booleans as booleans, and everything else as text.
Amperity does not send blank or empty values. A field that is blank in Amperity is left out of the profile that Amperity sends, rather than sent as an empty value.
Note
This destination uses the StackAdapt GraphQL API .
Beta
The StackAdapt connector is in beta. Contact your Amperity representative to learn more.
Note
Amperity sends only what changed since the previous run. Each run sends, in order:
Profiles whose fields changed, without changing their audience membership.
Customers who left the audience, with an
exitaction for the CRM audience.Customers who joined the audience, with an
enteraction for the CRM audience.
The List name is both the name and the ID of the StackAdapt CRM audience. StackAdapt has no separate step for creating an audience, so the CRM audience is created from this name the first time Amperity sends to it. The first run, and the first run after the list name changes, sends every customer. When nothing changed since the previous run, Amperity sends nothing and reports every row as succeeded.
Amperity splits each run into several requests, keeps only a few requests in progress at a time, and limits how quickly it sends them.
Important
Amperity treats each request as a whole and does not report a result for each profile: an error in StackAdapt’s response fails the whole request. A run reports success when every request succeeds; Amperity does not wait to confirm that the profiles appear in StackAdapt.
A failed request fails the run. Requests that succeeded earlier in that run stay applied, so a failed run can leave some profiles updated.
A rejected API key, or an error that StackAdapt reports inside an otherwise successful response, fails the run without a retry, because the same request would fail again. For a rejected API key, ask your StackAdapt account team to check the API key. For any other error, the run shows StackAdapt’s error message; check the Advertiser ID and External provider settings on the destination.
A request that times out, exceeds the StackAdapt rate limit, or fails because StackAdapt is unavailable is retried. If it still fails, or if StackAdapt returns any other HTTP error, Amperity retries the whole run every 10 minutes for up to an hour.
Get details¶
Review the following details before configuring credentials for StackAdapt and before configuring Amperity to send customer profiles and audiences to StackAdapt.
|
Credential settings API Key
|
|
Required configuration settings Advertiser ID
Audience primary key
External provider
List name (Required at orchestration)
|
|
Optional configuration settings Profiles are opted in to marketing
|
|
A query that outputs the fields to send to StackAdapt. The email field is required. Columns that match a StackAdapt profile field, such as first_name or postal_code, update that field; every other column is sent as a custom field. |
Configure credentials¶
Configure credentials for StackAdapt before adding a destination.
An individual with access to StackAdapt should use SnapPass to securely share “API Key” details with the individual who configures Amperity.
To configure credentials for StackAdapt
|
From the Settings page, select the Credentials tab, and then click the Add credential button. |
|
In the Create credential dialog box, do the following:
|
|
The settings that are available for a credential vary by credential type. For the “stackadapt” credential type, configure settings, and then click Save. API Key
|
Add destination¶
Use a sandbox to configure a destination for StackAdapt. Before promoting your changes, send a sample audience, and then verify the results in StackAdapt. After verifying the end-to-end workflow, push the destination from the sandbox to production.
To add a destination for StackAdapt
|
Open the Destinations page, select the New destinations button, and then select Orchestration.
To configure a destination for StackAdapt, do one of the following:
|
|
Select the credential for StackAdapt from the Credential dropdown, and then click Continue. Tip Amperity validates the connection when the destination is saved. If the connection cannot be validated, an error is shown and the destination is not saved. The connection test checks that the API key can see the advertiser in the Advertiser ID setting and has write access to it. |
|
In the “Destination settings” dialog box, assign the destination a name and description that ensures other users of Amperity can recognize when to use this destination. Configure business user access By default a destination is available to all users who have permission to view personally identifiable information (PII). Enable the Admin only checkbox to restrict access to only users assigned to the Datagrid Operator and Datagrid Administrator policies. Enable the PII setting checkbox to allow limited access to PII for this destination. Use the Restrict PII access policy option to prevent users from viewing data marked as PII anywhere in Amperity and from sending data to downstream workflows. |
|
Configure the following settings, and then click “Save”. Advertiser ID
Audience primary key
External provider
List name (Required at orchestration)
Profiles are opted in to marketing
|
|
After configuring this destination users may use:
|
|
Validate the audience with StackAdapt by using a sample audience with a very small membership. For example: 10 or 100 members or the minimum audience size recommended by StackAdapt. Send the sample audience to StackAdapt and verify the sample audience is correct in StackAdapt. Make adjustments if necessary. Only send full audiences after validation is complete. |