フィールド マッピングを使用して、カスタマー マッチ ワークフローの各ステップを Google Ads API から Data Manager API にアップグレードします。
オーディエンス管理フィールド マッピングには、オーディエンスの作成、更新、取得のためのフィールド マッピングが含まれています。
取り込みフィールド マッピングには、オーディエンス メンバーの追加または削除のフィールド マッピングが含まれています。
認証
Data Manager API では、Google Ads API とは異なるスコープの認証情報が必要です。API アクセスを設定するの手順に沿って、Data Manager API スコープを含む新しい認証情報を生成します。
オーディエンス管理のフィールド マッピング
表のマッピングを使用して、Google Ads API の UserList を Data Manager API の同等の UserList にマッピングします。
UserList(Google Ads API) |
UserList(Data Manager API) |
メモ |
|---|---|---|
resource_name |
name |
詳細については、リソース名をご覧ください。 |
id |
id |
|
read_only |
read_only |
|
name |
display_name |
必須 |
description |
description |
必須 |
membership_status |
membership_status |
|
integration_code |
integration_code |
|
membership_life_span |
membership_duration |
オーディエンス メンバーがリストに追加されてからリストに残る期間。値は整数日に対応している必要があります。設定しない場合、デフォルトは最大値になります。 タイムスタンプ形式を使用して値をフォーマットします。 |
size_for_display |
size_info.display_network_members_count |
|
size_range_for_display |
同等のものはありません。 | サイズ情報には size_info.display_network_members_count を使用します。 |
size_for_search |
size_info.search_network_members_count |
|
size_range_for_search |
同等のものはありません。 | サイズ情報には size_info.search_network_members_count を使用します。 |
type |
同等のものはありません。 | |
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 |
カスタマー マッチには使用されません。 |
crm_based_user_list |
ingested_user_list_info |
必須。カスタマー マッチ オーディエンスの情報を参照してください。 |
| 同等のものはありません。 | ingested_user_list_info.pair_id_info |
カスタマー マッチには使用されません。 |
| 同等のものはありません。 | ingested_user_list_info.partner_audience_info |
カスタマー マッチには使用されません。 |
logical_user_list |
同等のものはありません。 | カスタマー マッチには使用されません。 |
logical_user_list |
同等のものはありません。 | カスタマー マッチには使用されません。 |
lookalike_user_list |
同等のものはありません。 | カスタマー マッチには使用されません。 |
rule_based_user_list |
同等のものはありません。 | カスタマー マッチには使用されません。 |
similar_user_list |
同等のものはありません。 | カスタマー マッチには使用されません。 |
カスタマー マッチ オーディエンスの情報
Google 広告 API では、カスタマー マッチ オーディエンスを作成するときに、crm_based_user_list フィールドを CrmBasedUserListInfo に設定する必要があります。
Data Manager API で、ingested_user_list_info フィールドを IngestedUserListInfo に設定して同等の属性を設定し、カスタマー マッチに必要なフィールドとユーザーデータの種類を設定します。
連絡先情報
upload_key_types-
CONTACT_IDを含むリストに設定します。これは、Google Ads API でupload_key_typeをCONTACT_INFOに設定するのと同じです。 contact_id_infoContactIdInfoに設定します。data_source_typeをDATA_SOURCE_TYPE_FIRST_PARTYに設定します。これは、Google Ads API でdata_source_typeをFIRST_PARTYに設定するのと同等です。
モバイル ID
upload_key_types-
MOBILE_IDを含むリストに設定します。これは、Google Ads API でupload_key_typeをMOBILE_ADVERTISING_IDに設定するのと同じです。 mobile_id_infoMobileIdInfoに設定します。data_source_typeをDATA_SOURCE_TYPE_FIRST_PARTYに設定します。これは、Google Ads API でdata_source_typeをFIRST_PARTYに設定するのと同等です。key_spaceをIOSまたはANDROIDに設定します。Data Manager API ではこの値が必要です。Google Ads API では、キー空間はapp_idから推測されます。app_idに、データの収集元であるモバイル アプリケーションを一意に識別する文字列を設定します。Google Ads API のapp_idで使用するのと同じ形式を使用します。
ユーザー ID
upload_key_types-
USER_IDを含むリストに設定します。これは、Google Ads API でupload_key_typeをCRM_IDに設定するのと同じです。 user_id_infoUserIdInfoに設定します。data_source_typeをDATA_SOURCE_TYPE_FIRST_PARTYに設定します。これは、Google Ads API でdata_source_typeをFIRST_PARTYに設定するのと同等です。
リソース名
Data Manager API では、Google Ads API とは異なるリソース名形式が使用されます。
- Google Ads API
Google Ads API では、
UserListリソース名には次の形式が使用されます。customers/{customer_id}/userLists/{user_list_id}- Data Manager API
Data Manager API では、
UserListリソース名に次の形式が使用されます。accountTypes/{accountType}/accounts/{account}/userLists/{userList}
フィールド マッピングをアップロードする
表のマッピングを使用して、Google Ads API の AddOfflineUserDataJobOperationsRequest を Data Manager API の同等の IngestAudienceMembersRequest にマッピングします。
リクエスト フィールド
AddOfflineUserDataJobOperationsRequest
(Google Ads API)
|
IngestAudienceMembersRequest
(Data Manager API)
|
メモ |
|---|---|---|
|
destinations |
顧客とオーディエンスのフィールドをご覧ください。 |
OfflineUserDataJob の
customer_match_user_list_metadata
から consent |
consent |
リクエスト内のオーディエンス メンバーのデフォルトの同意設定(省略可)。個々のオーディエンス メンバーに対してこの値をオーバーライドするには、AudienceMember の consent フィールドを設定します。 |
| 同等のものはありません | encoding |
必須: UserIdentifier 値に使用される Encoding に設定します。 |
| 同等のものはありません | encryption_info |
リクエストに暗号化された値が含まれているかどうかを設定します。詳細については、暗号化をご覧ください。 |
job_id |
同等のものはありません |
レスポンスで返された request_id を使用して、診断を取得します。 |
enable_partial_failure |
同等のものはありません |
Data Manager API は、高速フェイル エラーモデルを使用します。IngestAudienceMembersRequest のいずれかのフィールドの検証に失敗した場合、Data Manager API はリクエスト全体を拒否します。診断を使用して処理エラーを取得します。 |
enable_warnings |
同等のものはありません | Data Manager API は、レスポンスで警告を報告しません。診断を使用して処理上の警告を取得します。 |
validate_only |
validate_only |
|
operations |
audience_members |
オーディエンス メンバーのリスト。詳しくは、オーディエンス メンバーのフィールドのセクションをご覧ください。 |
| 同等のものはありません | terms_of_service |
必須。ユーザーがカスタマー マッチの利用規約に同意したか拒否したかを示すように設定します。 |
顧客とオーディエンスのフィールド
Google Ads API では、ジョブごとに1 つのユーザーリストにのみユーザーリスト メンバーをアップロードできます。また、developer-token リクエスト ヘッダーが必要であり、さまざまな認証シナリオに合わせて login-customer-id と linked-customer-id のリクエスト ヘッダーを設定します。
Data Manager API は、1 つのリクエストで複数のオーディエンスのオーディエンス メンバーを送信することをサポートしています。Data Manager API では、開発者トークンは必要ありません。リクエスト ヘッダーではなく Destination のフィールドを使用して、ログイン情報とリンクされた顧客情報を指定します。宛先の詳細については、宛先を構成するをご覧ください。
データ マネージャー API では、オーディエンスのすべてのメンバーを削除することはできません。Google Ads API では、OfflineUserDataJobOperation の remove_all フィールドを true に設定することで、オーディエンスのすべてのメンバーを削除できます。
単一のユーザーリストの Google Ads API フィールドを Destination の同等のフィールドにマッピングする方法は次のとおりです。
| Google Ads API | Destination
(Data Manager API) |
メモ |
|---|---|---|
リクエストの customer_id |
operating_account |
account_id をオーディエンスの顧客 ID に設定します。operating_account の account_type を GOOGLE_ADS に設定します。 |
developer-token リクエスト ヘッダー |
同等のものはありません | データマネージャー API には開発者トークンは必要ありません。 |
login-customer-id リクエスト ヘッダー |
login_account |
account_id をログイン アカウントのお客様 ID に設定します。ログイン アカウントが Google 広告アカウントの場合は account_type を GOOGLE_ADS に設定し、ログイン アカウントがデータ パートナー アカウントの場合は DATA_PARTNER に設定します。 |
linked-customer-id リクエスト ヘッダー |
linked_account |
パートナー リンクを使用して operating_account にアクセスしている場合は、account_id をリンクされたアカウントのお客様 ID に設定し、account_type を DATA_PARTNER に設定します。それ以外の場合は、linked_account フィールドを設定しないでください。 |
OfflineUserDataJob の customer_match_user_list_metadata から user_list |
product_destination_id |
必須。オーディエンスの数値 ID に設定します。UserList のリソース名は使用しないでください。 |
| 同等のものはありません | reference |
Destination のユーザー定義の識別子。1 回のリクエストで複数のオーディエンスのオーディエンス メンバーを送信する場合は、このフィールドを設定します。 |
オーディエンス メンバーのフィールド
UserData
(Google Ads API)
|
AudienceMember
(Data Manager API)
|
メモ |
|---|---|---|
consent |
consent |
オーディエンス メンバーの同意を指定するように設定します。 どちらの API も同様の Data Manager API の場合は、リクエスト レベルの |
transaction_attribute |
同等のものはありません。 | カスタマー マッチには適用されません。 |
user_attribute |
同等のものはありません。 | カスタマー マッチには適用されません。 |
user_identifiers |
|
オーディエンス メンバーに送信するデータのタイプに対応するフィールドに入力します。詳しくは、ユーザー識別子フィールドをご覧ください。 |
ユーザー識別子フィールド
Google Ads API では、連絡先情報、モバイル ID、ユーザー ID のいずれを送信する場合でも、UserIdentifier を使用します。データ マネージャー API では、データ型ごとに異なるフィールドを使用する、異なるアプローチが採用されています。
Data Manager API で、送信するデータのタイプに対応するフィールドに入力します。
連絡先情報
メールアドレス、電話番号、住所情報などの連絡先情報を使用する場合は、composite_data を CompositeData に設定し、user_data.user_identifiers に連絡先情報の項目ごとに個別のエントリを設定します。
user_data は引き続きサポートされますが、今後の改善に備えて、composite_data を使用することをおすすめします。詳しくは、複合データをご覧ください。
UserIdentifier
(Google Ads API)
|
UserIdentifier
(Data Manager API)
|
メモ |
|---|---|---|
address_info |
address |
詳しくは、住所フィールドをご覧ください。 |
hashed_email |
email_address |
書式設定とハッシュ化されたメールアドレスに設定します。ハッシュ化されたメールアドレスを暗号化することもできます。 |
hashed_phone_number |
phone_number |
フォーマットされハッシュ化された電話番号に設定します。ハッシュ化された電話番号を暗号化することもできます。 |
user_identifier_source |
同等のものはありません。 |
住所フィールド
Google Ads API の OfflineUserAddressInfo と Data Manager API の AddressInfo のフィールド マッピングは次のとおりです。連絡先情報を使用してカスタマー マッチ オーディエンスを設定する場合は、これらのマッピングを使用します。
OfflineUserAddressInfo
(Google Ads API)
|
AddressInfo
(Data Manager API)
|
メモ |
|---|---|---|
city |
同等のものはありません。 | |
country_code |
region_code |
必須 |
hashed_first_name |
given_name |
必須。フォーマットされハッシュ化された名に設定します。ハッシュ化された名前を暗号化することもできます。 |
hashed_last_name |
family_name |
必須。フォーマットされてハッシュ化されたファミリー名に設定します。ハッシュ化されたファミリー名を暗号化することもできます。 |
hashed_street_address |
同等のものはありません。 | |
postal_code |
postal_code |
必須 |
state |
同等のものはありません。 |
IP アドレス
Data Manager API では、ユーザー ID に加えて、カスタマー マッチのアップロードに IP アドレスを含めることができます。これらは CompositeData で提供されます。この CompositeData は UserData と IpData をバンドルします。これらのフィールドを一緒に指定すると、一致率の向上に役立ちます。
詳しくは、 カスタマー マッチの IP の取り込みをご覧ください。
| Google Ads API |
CompositeData
(Data Manager API)
|
メモ |
|---|---|---|
| 同等のものはありません。 | ip_data.ip_address |
未加工の IPv4 アドレスまたは IPv6 アドレスに設定します。IP アドレスの形式に関するガイダンスをご覧ください。 |
| 同等のものはありません。 | ip_data.observe_start_time |
IP アドレスが最初に検出されたときのタイムスタンプ(RFC 3339 形式)に設定します。 |
| 同等のものはありません。 | ip_data.observe_end_time |
IP アドレスが最後に観測されたときのタイムスタンプ(RFC 3339 形式)に設定します。 |
user_identifiers |
user_data |
UserData オブジェクトに設定します。 |
モバイル ID
モバイル ID を使用する場合は、mobile_data を MobileData に設定し、各 ID の mobile_ids にエントリを追加します。
UserIdentifier
(Google Ads API)
|
MobileData
(Data Manager API)
|
メモ |
|---|---|---|
mobile_id |
mobile_ids |
オーディエンス メンバーのモバイル ID のリストに設定します。
Google Ads API では、オーディエンス メンバーのモバイル ID ごとに、 |
user_identifier_source |
同等のものはありません。 |
ユーザー ID
ユーザー ID を使用する場合は、user_id_data を UserIdData に設定し、user_id をオーディエンス メンバーのユーザー ID に設定します。
UserIdentifier
(Google Ads API)
|
UserIdData
(Data Manager API)
|
メモ |
|---|---|---|
third_party_user_id |
user_id |
Google Ads API では、オーディエンス メンバーのユーザー ID ごとに、
データマネージャー API で、 |
user_identifier_source |
同等のものはありません。 |