Send data to Google Audience Partner API

Google Audience Partner API uses first-party data that your customers have shared with you to enable advertising across Google – including search and display advertising, the Shopping tab, Gmail, and YouTube – to your customers and to similar audiences.

Note

This destination uses the Google Audience Partner API .

Changes to audiences are not immediately available in Google Audience Partner API. Allow for up to 48 hours after the point at which Amperity has finished sending audience updates for them to be available.

This topic describes the steps that are required to send customer data to Google Audience Partner API from Amperity:

  1. Get details

  2. Authorize Amperity access to the customer’s account

  3. Add destination

  4. Add data template

Get details

Google Audience Partner API requires the following configuration details:

  1. The name of the custom audience to which Amperity will send data. Amperity will create the custom audience name if it does not already exist.

  2. The membership duration for the custom audience. Membership duration defines for how long a name stays in the custom audience list. When the duration expires, the name is removed from the list. The default is 30 days. The maximum is 540 days.

  3. The upload key type. The upload key type must be one of the following: “Contact Info”, “User ID”, or “Mobile ID”.

    If the upload key type is “Mobile ID”, add the ID for the iOS or Android application from which the data will be collected.

    Caution

    A list can be uploaded with only one type of data–contact info, mobile device ID, or user ID–and once uploaded will not accept any other list ID types.

  4. Authorize Amperity to send data to the customer’s Google Audience Partner API account.

Configure OAuth

OAuth is an open standard for access delegation, commonly used to grant websites or applications access to information on other websites.

To configure OAuth

  1. From the Destinations tab, click Add Destination. The Add Destination dialog box opens.

  2. From the Plugin drop-down, select Google Audience Partner API.

  3. From the Credential drop-down, select Create a new credential. This opens the Create New Credential dialog box.

  4. Generate an authorization link, and then visit the URL that was generated to complete the authorization process.

    Log in to Google Audience Partner API at the generated URL using the customer’s credentials to allow access to the customer’s instance of Google Audience Partner API.

    Tip

    Send the URL to an individual who can provide the customer’s credentials, and then ask them to log into Google Audience Partner API on your behalf.

  5. When complete, you will be redirected to the Credentials page in Amperity.

    Verify the credential is on the page, and then return to the Destinations tab.

Reauthorize Amperity

You may need to reauthorize access to Google Audience Partner API. This is necessary when an authorization token has expired or when it has been removed by someone with permission to manage access within Google Audience Partner API. To reauthorize access to Google Audience Partner API, follow the steps to configure OAuth and create a new credential.

Add destination

Configure Amperity to send data to Google Audience Partner API using the Google Audience Partner API.

Warning

Amperity must be authorized to send data to the customer’s Google Audience Partner API account prior to configuring the destination.

To add a destination

  1. From the Destinations tab, click Add Destination. This opens the Add Destination dialog box.

  2. Enter the name of the destination and a description. For example: “Google Audience Partner API” and “This sends customer data to Google Audience Partner API”.

  3. From the Plugin drop-down, select Google Audience Partner API.

  4. From the Credentials drop-down, select the “the OAuth credential you created for your Google Audience Partner API account” credential type. Select the OAuth credential you created for your Google Audience Partner API account, after which configuration settings are added automatically.

  5. Under Google Audience Partner API Settings, enter the customer ID.

  6. Select Allow customers to use this destination.

  7. Select Allow orchestrations from users with limited PII access. (A user with limited PII access has been assigned the Restrict PII Access policy option.)

  8. Click Save.

Add data template

A data template defines how columns in Amperity data structures are sent to downstream workflows. A data template is part of the configuration for sending query and segment results from Amperity to an external location.

You have two options for setting up data templates for Google Audience Partner API:

  1. For use with campaigns

  2. For use with orchestrations

for campaigns

You can configure Amperity to send campaigns to Google Customer Match. These results are sent from the Campaigns tab. Results default to a list of email addresses, but you may configure a campaign to send additional attributes to Google Audience Partner API.

To add a data template for campaigns

  1. From the Destinations tab, open the menu for a destination that is configured for Google Audience Partner API, and then select Add data template.

    This opens the Add Data Template dialog box.

  2. Enter the name of the data template and a description. For example: “Google Audience Partner API audiences” and “Send audiences to Google Audience Partner API.”

  3. Enable the Allow customers to use this data template option, and then enable the Make available to campaigns option. This allows users to send campaign results from Amperity to Google Audience Partner API.

  4. Verify all template settings and make any required updates.

  5. Click Save.

for orchestrations

You can configure Amperity to send query results to Google Customer Match. These results are sent using an orchestration.

To add a data template for orchestrations

  1. From the Destinations tab, open the menu for a destination that is configured for Google Audience Partner API, and then select Add data template.

    This opens the Add Data Template dialog box.

  2. Enter the name of the data template and a description. For example: “Google Audience Partner API customer profiles” and “Send email addresses and customer profiles to Google Audience Partner API.”

  3. Enable the Allow customers to use this data template option. This allows users to build queries, and then configure orchestrations that send results from Amperity to a configured destination.

  4. Optional. Enable the Allow orchestrations from customers with limited PII access option. This allows users who have been assigned the Restrict PII Access policy option to send results from Amperity.

  5. Verify all template settings and make any required updates.

  6. Click Save.

Google Audience Partner API Matching

Google Audience Partner API matching can be done through the following list ID types:

Note

This is the same matching process that is used by the Google Ads destination.

Contact Info Matching

Personally identifiable information (PII) is any data that could potentially identify a specific individual. PII data includes details like names, addresses, email addresses, and other profile attributes, but can also include attributes like a loyalty number, customer relationship management (CRM) system identifiers, and foreign keys in customer data.

A list can be matched to contact information that contains PII data. If a row contains a NULL value, it will be automatically filtered out by the connector and will be shown in the error logs. Each field should be matched to (at least) one of the following columns:

Amperity Column

Google API Key

Description

Email Address

email

For this key, the connector:

  • Trims leading and trailing whitespace

  • Converts to lower-case

  • Hashes data as SHA-256

Phone Number

phone

Converts each phone number to E.164 format which represents a phone number as a number up to fifteen digits in length (without spaces) that starts with a + symbol. For example: +12061234567.

For this key, the connector:

  • Trims leading and trailing whitespace

  • Hashes data as SHA-256

Last Name

lastname

For this key, the connector:

  • Trims leading and trailing whitespace

  • Removes spaces in-between

  • Converts to lower-case

  • Hashes data as SHA-256

First Name

firstname

For this key, the connector:

  • Trims leading and trailing whitespace

  • Removes spaces in-between

  • Converts to lower-case

  • Hashes data as SHA-256

Zip Code

zip

For this key, the connector:

  • Trims leading and trailing whitespace

  • Converts to lower-case

Country Code

country

A two-letter country code in ISO 3166-1 alpha-2 format.

For this key, the connector:

  • Trims leading and trailing whitespace

  • Converts to upper-case

Mobile Device ID Matching

A list can be matched to mobile device IDs. These may be identifier for advertising (IDFA) or Google advertising IDs (AAID) for mobile devices. If a row contains a NULL value, it will be automatically filtered out by the connector and will be shown in the error logs.

Amperity Column

Google API Key

Description

Mobile Device ID

mobile-id

A list of mobile device IDs provided to Amperity by the customer. For this key, the connector:

  • Trims leading and trailing whitespace

  • Converts to lower-case

  • Retains any hyphens in the mobile device ID

User ID Matching

A list can be matched to advertiser-generated and assigned user IDs and/or to custom IDs created by the customer. This list of IDs must be provided to Amperity by the customer so they may be returned as part of the query data sent to Google Audience Partner API. If a row contains a NULL value, it will be automatically filtered out by the connector and will be shown in the error logs.

Amperity Column

Google API Key

Description

User ID

user-id

A list of customer IDs provided to Amperity by the customer. For this key, the connector:

  • Trims leading and trailing whitespace

  • Optional. Hashes data as SHA-256