フィールド マッピング

表のマッピングを使用して、Google Ads API のメソッドとフィールドを Data Manager API の IngestEventsRequest の同等のメソッドとフィールドにマッピングします。

認証

Data Manager API には、Google Ads API とは異なるスコープの認証情報が必要です。API アクセスを設定するの手順に沿って、Data Manager API スコープを含む新しい認証情報を生成します。

API メソッド

Data Manager API を使用すると、店舗セールイベントの各バッチを 1 つの IngestEventsRequest でアップロードできます。

これに対し、Google Ads API では、OfflineUserDataJobService を使用して次の 3 つのステップを実行する必要がありました。

  1. CreateOfflineUserDataJob を使用してジョブを作成する
  2. AddOfflineUserDataJobOperations を使用してジョブにオペレーションを追加する
  3. RunOfflineUserDataJob を使用してジョブを実行する

リクエスト フィールド

各 IngestEventsRequest にはリクエストの上限が適用されます。AddOfflineUserDataJobOperations リクエストのオペレーション数がこれらの上限を超える場合は、複数の Data Manager API 取り込みリクエストに分割する必要があります。

Google Ads API リクエストのフィールドが Data Manager API にどのようにマッピングされるかを以下に示します。

CreateOfflineUserDataJobRequest

次の表に、CreateOfflineUserDataJobRequest のフィールドが IngestEventsRequest にどのようにマッピングされるかを示します。

CreateOfflineUserDataJobRequest（Google Ads API） IngestEventsRequest（Data Manager API） メモ
customer_id destinations.operating_account 顧客とコンバージョン アクションのフィールドをご覧ください。
  • developer-token リクエスト ヘッダー
  • login-customer_id リクエスト ヘッダー
  • linked-customer-id リクエスト ヘッダー
 destinations 顧客とコンバージョン アクションのフィールドをご覧ください。
  • job.status
  • job.failure_reason
 診断 IngestEventsResponse で返された request_id を使用して、コンバージョン アップロードに関する診断を取得します。
job.id request_id IngestEventsResponse で返された request_id を使用して、コンバージョン アップロードに関する診断を取得します。
job.external_id 同等のものはありません
job.type 同等のものはありません
job.store_sales_metadata.third_party_metadata.partner_id destinations.login_account 店舗販売コンバージョンをアップロードするデータ パートナーは、宛先の login_account によって識別されます。詳細については、宛先を構成するをご覧ください。
job.store_sales_metadata.third_party_metadata.advertiser_upload_date_time 同等のものはありません
job.store_sales_metadata.third_party_metadata.valid_transaction_fraction 同等のものはありません
job.store_sales_metadata.third_party_metadata.partner_match_fraction 同等のものはありません
job.store_sales_metadata.third_party_metadata.partner_upload_fraction 同等のものはありません
job.store_sales_metadata.third_party_metadata.bridge_map_version_id 同等のものはありません
job.store_sales_metadata.loyalty_fraction 同等のものはありません
job.store_sales_metadata.transaction_upload_fraction 同等のものはありません
job.store_sales_metadata.custom_key
  • events[].custom_variables[].variable
  • events[].cart_data.items[].custom_variables[].variable
 イベントレベルの CustomVariable またはアイテムレベルの ItemCustomVariable の variable フィールドにマッピングします。
enable_match_rate_range_preview 同等のものはありません
validate_only validate_only
同等のものはありません consent Google Ads API では、UserData のイベントレベルで consent を指定することのみがサポートされています。Data Manager API の場合、IngestEventsRequest の consent フィールドを設定することで、リクエスト内のすべてのイベントに対する同意を指定できます。この値は、Event の consent フィールドを設定することで、個々のイベントでオーバーライドできます。
同等のものはありません encoding UserData のアップロードに必須です。UserIdentifier 値に使用される Encoding に設定します。
同等のものはありません encryption_info リクエストに暗号化された UserData ユーザー ID が含まれている場合に設定します。詳細については、暗号化をご覧ください。

AddOfflineUserDataJobOperationsRequest

次の表に、AddOfflineUserDataJobOperationsRequest のフィールドが IngestEventsRequest にどのようにマッピングされるかを示します。

AddOfflineUserDataJobOperationsRequest（Google Ads API） IngestEventsRequest（Data Manager API） メモ
  • developer-token リクエスト ヘッダー
  • login-customer_id リクエスト ヘッダー
  • linked-customer-id リクエスト ヘッダー
 destinations 顧客とコンバージョン アクションのフィールドをご覧ください。
resource_name 同等のものはありません Data Manager API では、ジョブリソースを更新する必要はありません。
enable_partial_failure 同等のものはありません IngestEventsRequest が成功した場合、ダウンストリーム処理中に発生したエラーはイベントレベルで処理されるため、部分的に成功する可能性があります。診断を使用して、アップロードのステータスと、個々のイベントのエラーと警告を取得します。IngestEventsRequest が失敗した場合（BadRequest などが原因）、イベントは処理されません。エラーを解決してリクエストを再試行する必要があります。詳しくは、API エラーについてをご覧ください。
enable_warnings 同等のものはありません 診断を使用して、Data Manager API リクエストに関する警告を取得します。この機能を有効にする必要はありません。
operations events OfflineUserDataJobOperation.create オペレーションは、IngestEventsRequest を送信することと同等です。Data Manager API はイベントの削除をサポートしていません。
validate_only validate_only
同等のものはありません consent Google Ads API では、UserData のイベントレベルで consent を指定することのみがサポートされています。Data Manager API の場合、IngestEventsRequest の consent フィールドを設定することで、リクエスト内のすべてのイベントに対する同意を指定できます。この値は、Event の consent フィールドを設定することで、個々のイベントでオーバーライドできます。
同等のものはありません encoding UserData のアップロードに必須です。UserIdentifier 値に使用される Encoding に設定します。
同等のものはありません encryption_info リクエストに暗号化された UserData ユーザー ID が含まれている場合に設定します。詳細については、暗号化をご覧ください。

顧客とコンバージョン アクションのフィールド

Google Ads API では developer-token リクエスト ヘッダーが必要です。また、さまざまな認証シナリオで login-customer-id リクエスト ヘッダーと linked-customer-id リクエスト ヘッダーを設定します。

Data Manager API ではデベロッパー トークンは必要ありません。ログインとリンクされた顧客情報は、リクエスト ヘッダーではなく Destination のフィールドを使用して指定します。宛先の詳細については、宛先を構成するをご覧ください。

Google Ads API Destination（Data Manager API） メモ
リクエストの customer_id operating_account account_id を Google 広告コンバージョン アカウントのお客様 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 フィールドを設定しないでください。
conversion_action product_destination_id コンバージョン アクションの数値 ID に設定します。リソース名は使用しないでください。

イベント フィールド

次の表に、2 つの API 間で店舗販売コンバージョンのフィールドがどのようにマッピングされるかを示します。

ItemAttribute を使用してトランザクションごとに 1 つのアイテムのみを含めることができる Google Ads API とは異なり、Data Manager API では、CartData でイベントごとに複数のアイテムを含めることができます。

OfflineUserDataJobOperation.create（Google Ads API） Event（Data Manager API） メモ
同等のものはありません event_source 必須。店舗販売コンバージョンの場合は IN_STORE に設定します。
transaction_attribute.conversion_action destinations.product_destination_id 顧客とコンバージョン アクションのフィールドをご覧ください。リソース名の代わりに、コンバージョン アクションの数値 ID を使用します。
transaction_attribute.transaction_date_time event_timestamp
  • JSON 形式を使用する場合は、RFC 3339 形式の値に設定します。これは、Google Ads API の日時形式とは若干異なります。
  • プロトコル バッファを使用する場合は、Timestamp を使用して、seconds フィールドと nanoseconds フィールド（省略可）を設定します。

詳細については、タイムスタンプの形式をご覧ください。
transaction_attribute.transaction_amount_micros
  • conversion_value （必須）
  • cart_data.items[].conversion_value
 マイクロ単位の値ではなく、通貨単位の値に設定します。たとえば、コンバージョン値が $5.23 の場合は、値 5.23 を使用します。
transaction_attribute.currency_code currency 必須。
transaction_attribute.order_id transaction_id 必須。
transaction_attribute.store_attribute.store_code event_location.store_id 必須 EventLocation オブジェクトの store_id フィールドに店舗コードを設定します。
transaction_attribute.custom_value
  • custom_variables[].value
  • cart_data.items[].custom_variables[].value
 イベントレベルの CustomVariable の value フィールド、またはアイテムレベルの ItemCustomVariable にマッピングします。
transaction_attribute.item_attribute.item_id cart_data.items[].merchant_product_id
transaction_attribute.item_attribute.merchant_id
  • cart_data.merchant_id
  • cart_data.items[].merchant_id
 cart_data.merchant_id を設定すると、すべての商品アイテムのデフォルトとして機能しますが、個々の商品アイテムでオーバーライドできます。
transaction_attribute.item_attribute.country_code
  • cart_data.merchant_feed_label
  • cart_data.items[].merchant_feed_label
 cart_data.merchant_feed_label を設定すると、すべての商品アイテムのデフォルトとして機能しますが、個々の商品アイテムでオーバーライドできます。
transaction_attribute.item_attribute.language_code
  • cart_data.merchant_feed_language_code
  • cart_data.items[].merchant_feed_language_code
 cart_data.merchant_feed_language_code を設定すると、すべての商品アイテムのデフォルトとして機能しますが、個々の商品アイテムでオーバーライドできます。
transaction_attribute.item_attribute.quantity cart_data.items[].quantity
同等のものはありません cart_data.items[].unit_price このアイテムの単価（税金、送料、イベント スコープ（トランザクション単位）の割引を除く）に設定します。
user_identifiers
  • user_data.user_identifiers
  • third_party_user_data.user_identifiers
 必須。

third_party_user_data は user_data と同じ構造を使用しますが、ユーザー識別子がファーストパーティの広告主データではなく、サードパーティのソースから取得されていることを示します。

third_party_user_data に値を入力できるのは、ログイン アカウントがデータ パートナー（login_account.account_type が DATA_PARTNER）の場合のみです。

詳しくは、ユーザー識別子フィールドをご覧ください。

consent consent どちらの API も、同様の Consent オブジェクト（ad_user_data、ad_personalization）を使用します。Data Manager API の場合は、IngestEventsRequest の consent フィールドを設定することで、リクエスト内のすべてのイベントに同意を設定することもできます。

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

UserIdentifier（Google Ads API） UserIdentifier（Data Manager API） メモ
user_identifier_source

ソースによって、Data Manager API Event に入力されるフィールドが決まります。

  • user_data
  • third_party_user_data

third_party_user_data は user_data と同じ構造を使用しますが、ユーザー識別子がファーストパーティの広告主データではなく、サードパーティのソースから取得されていることを示します。

third_party_user_data に値を入力できるのは、ログイン アカウントがデータ パートナー（login_account.account_type が DATA_PARTNER）の場合のみです。

詳しくは、ユーザー識別子フィールドをご覧ください。

hashed_email email_address フォーマットしてハッシュ化したメールアドレスに設定します。ハッシュ化されたメールアドレスを暗号化することもできます。
hashed_phone_number phone_number フォーマットしてハッシュ化した電話番号に設定します。ハッシュ化された電話番号を暗号化することもできます。
address_info address AddressInfo オブジェクトに設定します。フォーマットとハッシュ化のガイドラインに沿って対応してください。アドレスのハッシュ化された属性を暗号化することもできます。
address_info.hashed_first_name address.given_name
address_info.hashed_last_name address.family_name
address_info.country_code address.region_code
address_info.postal_code address.postal_code
address_info.city 同等のものはありません Google 広告のリンク先ではサポートされていません。
address_info.state 同等のものはありません Google 広告のリンク先ではサポートされていません。
address_info.hashed_street_address 同等のものはありません Google 広告のリンク先ではサポートされていません。
前へ
アップグレードの手順