フィールド マッピング

フィールド マッピングを使用して、カスタマー マッチ ワークフローの各ステップを 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

オーディエンス メンバーがリストに追加されてからリストに残る期間。値は、1 日単位で指定する必要があります。設定しない場合、デフォルトは最大値になります。

タイムスタンプ形式を使用して値をフォーマットします。

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 Ads 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_info

ContactIdInfo に設定します。

data_source_type を DATA_SOURCE_TYPE_FIRST_PARTY に設定します。これは、Google Ads API で data_source_type を FIRST_PARTY に設定するのと同じです。

Mobile ID

upload_key_types
MOBILE_ID を含むリストに設定します。これは、Google Ads API で upload_key_type を MOBILE_ADVERTISING_ID に設定するのと同じです。
mobile_id_info

MobileIdInfo に設定します。

  • data_source_type を DATA_SOURCE_TYPE_FIRST_PARTY に設定します。これは、Google Ads API で data_source_type を FIRST_PARTY に設定するのと同じです。
  • key_space を IOS または ANDROID に設定します。Data Manager API では、この値が必要です。これは、キースペースが app_id から推測される Google Ads API とは異なります。
  • app_id を、データが収集されたモバイルアプリを一意に識別する文字列に設定します。Google Ads API の app_id と同じ形式を使用します。

ユーザー ID

upload_key_types
USER_ID を含むリストに設定します。これは、Google Ads API で upload_key_type を CRM_ID に設定するのと同じです。
user_id_info

UserIdInfo に設定します。

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 の同等の IngestionService リクエストにマッピングします。

リクエスト フィールド

これらのマッピングでは、Data Manager API の IngestAudienceMembersRequest を参照として使用しますが、Google Ads API リクエストを RemoveAudienceMembersRequest または RemoveAllAudienceMembersRequest に変換する場合にも、これらのマッピングを使用できます。

AddOfflineUserDataJobOperationsRequest (Google Ads API) IngestAudienceMembersRequest (Data Manager API) メモ
  • customer_id フィールド
  • OfflineUserDataJob の customer_match_user_list_metadata フィールド
  • developer-token リクエスト ヘッダー
  • login-customer_id リクエスト ヘッダー
  • linked-customer-id リクエスト ヘッダー
destinations 顧客とオーディエンスのフィールドをご覧ください。
consent(OfflineUserDataJob の customer_match_user_list_metadata から) 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 のフィールドを使用して指定します。宛先の詳細については、宛先を構成するをご覧ください。

Google Ads API では、OfflineUserDataJobOperation の remove_all フィールドを true に設定することで、オーディエンスのすべてのメンバーを削除できます。

Data Manager API では、RemoveAllAudienceMembersRequest を送信することでこれを実現します。詳しくは、すべてのメンバーを削除するのガイドをご覧ください。

単一のオーディエンスの 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 リクエスト ヘッダー 同等のものはありません Data Manager 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 のユーザー定義 ID。1 つのリクエストで複数のオーディエンスのオーディエンス メンバーを送信する場合は、このフィールドを設定します。

オペレーション フィールド

Data Manager API には、オーディエンス メンバーを追加および削除するための個別のメソッドが含まれています。一方、 Google Ads API の AddOfflineUserDataJobOperationsRequest には operations のリストが含まれており、各 は オペレーションのタイプに基づいて、 メンバーの追加、メンバーの削除、すべてのメンバーの削除のいずれかを行います。各オペレーション タイプと Data Manager API の対応するメソッドのマッピングは次のとおりです。

OfflineUserDataJobOperation (Google Ads API) IngestionService メソッド(Data Manager API) メモ
create IngestAudienceMembers 詳細については、オーディエンス メンバーのフィールド セクションをご覧ください。
remove RemoveAudienceMembers 詳細については、オーディエンス メンバーのフィールド セクションをご覧ください。
remove_all RemoveAllAudienceMembers 詳しくは、すべてのオーディエンス メンバーを削除するをご覧ください。

オーディエンス メンバーのフィールド

UserData (Google Ads API) AudienceMember(Data Manager API) メモ
consent consent

オーディエンス メンバーの同意を指定するように設定します。

どちらの API も、同様の Consent オブジェクト(ad_user_data、ad_personalization)を使用します。

Data Manager API の場合は、リクエストレベルの consent フィールドを設定して、リクエスト内のすべてのオーディエンス メンバーに同意を設定することもできます。

transaction_attribute 同等のものはありません。 カスタマー マッチには適用されません。
user_attribute 同等のものはありません。 カスタマー マッチには適用されません。
user_identifiers
  • mobile_data
  • user_id_data
  • composite_data
    • user_data
    • ip_data

オーディエンス メンバーに送信するデータの種類に対応するフィールドに値を入力します。詳しくは、ユーザー識別子フィールドをご覧ください。

ユーザー識別子フィールド

Google Ads API では、連絡先情報、モバイル ID、ユーザー ID のいずれを送信する場合でも、UserIdentifier を使用します。Data Manager 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 で提供されます。これは 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 オブジェクトに設定します。

Mobile 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 ごとに、mobile_id を含む別個の UserIdentifier を追加します。Data Manager API で、mobile_ids がオーディエンス メンバーのすべての Mobile ID のリストに設定された単一の MobileData を追加します。

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 ごとに、third_party_user_id を含む別個の UserIdentifier を追加します。

Data Manager API で、user_id_data フィールドを UserIdData に設定し、user_id フィールドをオーディエンス メンバーのユーザー ID に設定します。同じオーディエンス メンバーに複数のユーザー ID を送信することはできません。

user_identifier_source 同等のものはありません。