Use the field mappings to upgrade each step of your Customer Match workflow from the Google Ads API to the Data Manager API:
Audience management field mappings contains field mappings for creating, updating, and retrieving audiences.
Ingestion field mappings contains field mappings for adding or removing audience members.
Audience management field mappings
Use the mappings in the tables to map a
UserList in the
Google Ads API to its UserList
equivalent in the Data Manager API.
UserList (Google Ads API) |
UserList (Data Manager API) |
Notes |
|---|---|---|
resource_name |
name |
See Resource names for details. |
id |
id |
|
read_only |
read_only |
|
name |
display_name |
Required |
description |
description |
Required |
membership_status |
membership_status |
|
integration_code |
integration_code |
|
membership_life_span |
membership_duration |
The duration an audience member remains in the list after added. The value must correspond to whole days. If not set, defaults to the maximum. Format the value using the Timestamp format. |
size_for_display |
size_info.display_network_members_count |
|
size_range_for_display |
No equivalent. | Use the size_info.display_network_members_count for size information. |
size_for_search |
size_info.search_network_members_count |
|
size_range_for_search |
No equivalent. | Use the size_info.search_network_members_count for size information. |
type |
No equivalent. | |
access_reason |
access_reason |
|
account_user_list_status |
account_access_status |
|
closing_reason |
closing_reason |
|
eligible_for_search |
target_network_info.eligible_for_search |
|
eligible_for_display |
target_network_info.eligible_for_display |
|
match_rate_percentage |
ingested_user_list_info.contact_id_info.match_rate_percentage |
|
basic_user_list |
ingested_user_list_info.pseudonymous_id_info |
Not used for Customer Match. |
crm_based_user_list |
ingested_user_list_info |
Required. See Customer Match audience information. |
| No equivalent. | ingested_user_list_info.pair_id_info |
Not used for Customer Match. |
| No equivalent. | ingested_user_list_info.partner_audience_info |
Not used for Customer Match. |
logical_user_list |
No equivalent. | Not used for Customer Match. |
logical_user_list |
No equivalent. | Not used for Customer Match. |
lookalike_user_list |
No equivalent. | Not used for Customer Match. |
rule_based_user_list |
No equivalent. | Not used for Customer Match. |
similar_user_list |
No equivalent. | Not used for Customer Match. |
Customer Match audience information
In the Google Ads API, the crm_based_user_list field is required when creating
a Customer Match audience.
In the Data Manager API, set the equivalent attributes by
setting the ingested_user_list_info field to an
IngestedUserListInfo, then set the
required fields for Customer Match and the type of user data.
Contact information
upload_key_types- Set to a list containing
CONTACT_INFO. contact_id_infoSet to a
ContactIdInfo.Set
data_source_typetoDATA_SOURCE_TYPE_FIRST_PARTY.
Mobile IDs
upload_key_types- Set to a list containing
MOBILE_ID. mobile_id_infoSet to a
MobileIdInfo.- Set
data_source_typetoDATA_SOURCE_TYPE_FIRST_PARTY. - Set
key_spacetoIOSorANDROID. - Set
app_idto the string that uniquely identifies the mobile application from which the data was collected. Use the same format you use for the app ID in the Google Ads API.
- Set
User IDs
upload_key_types- Set to a list containing
USER_ID. user_id_infoSet to a
UserIdInfo.Set
data_source_typetoDATA_SOURCE_TYPE_FIRST_PARTY.
Resource names
The Data Manager API uses a different resource name format than the Google Ads API.
- Google Ads API
In the Google Ads API, a
UserListresource name uses the format:customers/{customer_id}/userLists/{user_list_id}- Data Manager API
In the Data Manager API, a
UserListresource name uses the format:accountTypes/{accountType}/accounts/{account}/userLists/{userList}
Upload field mappings
Use the mappings in the tables to map an
AddOfflineUserDataJobOperationsRequest in the
Google Ads API to its IngestAudienceMembersRequest
equivalent in the Data Manager API.
Request fields
AddOfflineUserDataJobOperationsRequest
(Google Ads API)
|
IngestAudienceMembersRequest
(Data Manager API)
|
Notes |
|---|---|---|
|
destinations |
See Customer and audience fields. |
consent from the
customer_match_user_list_metadata
of
OfflineUserDataJob
|
consent |
Optional default consent settings for audience members in the request. You
can override this value for an individual audience member by setting the
consent field of AudienceMember.
|
| No equivalent | encoding |
Required: Set to the
Encoding used for
UserIdentifier values.
|
| No equivalent | encryption_info |
Set if the request contains encrypted values. See Encryption for details. |
job_id |
No equivalent |
Use the request_id returned in the response to retrieve
diagnostics.
|
enable_partial_failure |
No equivalent |
The Data Manager API doesn't support partial failure. If any field of an
IngestAudienceMembersRequest fails validation, the
Data Manager API rejects the entire request. Retrieve processing errors
using diagnostics.
|
enable_warnings |
No equivalent | The Data Manager API doesn't report warnings in the response. Retrieve processing warnings using diagnostics. |
validate_only |
validate_only |
|
operations |
audience_members |
The list of audience members. See the Audience member fields section for details. |
| No equivalent | terms_of_service |
Required. Set to indicate that the user has accepted or rejected the terms of service for Customer Match. |
Customer and audience fields
The Google Ads API only supports uploading audience members to one audience
per job.In addition, the developer-token request header is required, and you
set the login-customer-id and linked-customer-id request
headers for different authentication scenarios.
The Data Manager API supports sending audience members for multiple audiences
in a single request. The Data Manager API doesn't require a
developer token, and you specify login and linked customer information using
fields of a Destination instead of request headers. Check out Configure
destinations for more information about destinations.
The Data Manager API doesn't support removing all members of an audience. In the
Google Ads API, you can remove all members of an audience by setting the
remove_all field of an OfflineUserDataJobOperation
to true.
Here's how to map the Google Ads API fields for a single audience
to the equivalent fields in a Destination:
| Google Ads API | Destination
(Data Manager API) |
Notes |
|---|---|---|
customer_id of the request |
operating_account |
Set the account_id to the customer ID of the audience. Set
the account_type of the operating_account to
GOOGLE_ADS. |
developer-token request header |
No equivalent | A developer token is not required for the Data Manager API. |
login-customer-id request header |
login_account |
Set the account_id to the customer ID of the login
account. Set account_type to GOOGLE_ADS if the
login account is a Google Ads account, or DATA_PARTNER if
the login account is a data partner account. |
linked-customer-id request header |
linked_account |
Set the account_id to the customer ID of the linked
account. Set account_type to DATA_PARTNER. |
user_list from the
customer_match_user_list_metadata
of OfflineUserDataJob |
product_destination_id |
Required. Set to the numeric ID of the audience. Don't use the
resource name of the UserList.
|
| No equivalent | reference |
A user-defined identifier for the Destination. Set this
field if you are sending audience
members for multiple audiences in a single request.
|
Audience member fields
UserData
(Google Ads API)
|
AudienceMember
(Data Manager API)
|
Notes |
|---|---|---|
consent |
consent |
Set to specify the consent for the audience member. Both APIs use a similar For the Data Manager API, you can also set consent for all audience
members in a request by setting the request-level |
transaction_attribute |
No equivalent. | Not applicable to Customer Match. |
user_attribute |
No equivalent. | Not applicable to Customer Match. |
user_identifiers |
|
Populate the field that corresponds to the type of data you're sending for audience members. See User identifier fields for details. |
User identifier fields
In the Google Ads API, whether you're sending contact information, mobile IDs,
or user IDs, you use UserIdentifier. The
Data Manager API uses a different approach, with different fields for each type of
data.
In the Data Manager API, populate the field that corresponds to the type of data you're sending:
Contact information
If using contact information such as email address, phone number, or
address information, set user_data to a
UserData with a separate
entry in user_identifiers for each contact information item.
UserIdentifier
(Google Ads API)
|
UserIdentifier
(Data Manager API)
|
Notes |
|---|---|---|
address_info |
address |
See Address fields for details. |
hashed_email |
email_address |
Set to the formatted and hashed email address. You can also encrypt the hashed email address. |
hashed_phone_number |
phone_number |
Set to the formatted and hashed phone number. You can also encrypt the hashed phone number. |
user_identifier_source |
No equivalent. |
Address fields
Here are the field mappings between
OfflineUserAddressInfo
in the
Google Ads API and
AddressInfo in the
Data Manager API. Use these mappings if you're using contact information to
populate your Customer Match audience.
OfflineUserAddressInfo
(Google Ads API)
|
AddressInfo
(Data Manager API)
|
Notes |
|---|---|---|
city |
No equivalent. | |
country_code |
region_code |
|
hashed_first_name |
given_name |
Set to the formatted and hashed given name. You can also encrypt the hashed given name. |
hashed_last_name |
family_name |
Set to the formatted and hashed family name. You can also encrypt the hashed family name. |
hashed_street_address |
No equivalent. | |
postal_code |
postal_code |
|
state |
No equivalent. |
Mobile IDs
If using mobile IDs, set mobile_data to a
MobileData with an
entry in mobile_ids for each ID.
UserIdentifier
(Google Ads API)
|
MobileData
(Data Manager API)
|
Notes |
|---|---|---|
mobile_id |
mobile_ids |
Set to the list of
mobile IDs
for the audience member.
In the Google Ads API, you add a separate
|
user_identifier_source |
No equivalent. |
User IDs
If using user IDs, set user_id_data to a
UserIdData, and set
user_id to the user ID for the audience member.
UserIdentifier
(Google Ads API)
|
UserIdData
(Data Manager API)
|
Notes |
|---|---|---|
third_party_user_id |
user_id |
In the Google Ads API, you add a separate
In the Data Manager API, set the |
user_identifier_source |
No equivalent. |