従来版の Search Ads 360 Reporting API は、2024 年 6 月 30 日に廃止され、廃止されます。なお、Search Ads 360 Conversion API は影響を受けず、引き続きサポートされます。新しいレポートの作成には、必ず新しい Search Ads 360 Reporting API を使用してください。

2024 年 4 月以降、レポートをリクエストすると、unsupportedApiVersion エラーが返されます。詳しくはこちらをご覧ください。

また、既存の検索広告 360 の実装を新しい API に移行することを強くおすすめします。詳しくは、新しい Search Ads 360 Reporting API のスタートガイドと移行ガイドをご覧ください。

このページは Cloud Translation API によって翻訳されました。

Conversion

コンバージョンリソースには、Floodlight コンバージョンを一括で作成、変更、取得できるメソッドが用意されています。

このリソースのメソッドの一覧は、このページの最後に掲載されています。

リソース表記

コンバージョンのリスト。

{
  "kind": "doubleclicksearch#conversionList",
  "conversion": [
    {
      "agencyId": long,
      "advertiserId": long,
      "engineAccountId": long,
      "campaignId": long,
      "customerId": string,
      "adGroupId": long,
      "criterionId": long,
      "adId": long,
      "clickId": string,
      "dsConversionId": long,
      "conversionId": string,
      "state": string,
      "type": string,
      "revenueMicros": long,
      "currencyCode": string,
      "quantityMillis": long,
      "segmentationType": string,
      "segmentationId": long,
      "segmentationName": string,
      "conversionTimestamp": unsigned long,
      "conversionModifiedTimestamp": unsigned long,
      "floodlightOrderId": string,
      "customMetric": [
        {
          "name": string,
          "value": double
        }
      ],
      "customDimension": [
        {
          "name": string,
          "value": string
        }
      ],
      "countMillis": long,
      "attributionModel": string,
      "productGroupId": long,
      "inventoryAccountId": long,
      "productId": string,
      "productCountry": string,
      "productLanguage": string,
      "channel": string,
      "storeId": string,
      "deviceType": string,
      "adUserDataConsent": string
    }
  ]
}

プロパティ名	値	説明	メモ
`conversion[]`	`list`	リクエスト対象のコンバージョン。
`conversion[].adGroupId`	`long`	DS 広告グループ ID。
`conversion[].adId`	`long`	DS 広告 ID。
`conversion[].adUserDataConsent`	`string`	コアプラットフォームサービス（CPS）の設定に対する同意を表します。デフォルト値はありません。指定できる値は次のとおりです。GRANTED: 希望する同意ステータスは「許可」です。GTE の設定から CPS の設定を読み取ります。DENIED: 希望する同意ステータスは「拒否」です。CPS リストが空です。
`conversion[].advertiserId`	`long`	DS 広告主 ID。
`conversion[].agencyId`	`long`	DS 代理店 ID。
`conversion[].attributionModel`	`string`	この機能をご利用いただけるのは、DoubleClick Search カスタマーサポートへの連絡が完了した後のみです。
`conversion[].campaignId`	`long`	DS キャンペーン ID。
`conversion[].channel`	`string`	商品の販売チャネル。指定できる値は次のとおりです。「`local`」: 実店舗「`online`」: オンラインショップ
`conversion[].clickId`	`string`	コンバージョンの DS クリック ID。
`conversion[].conversionId`	`string`	オフラインコンバージョンの場合は、広告主がこの ID を指定します。広告主は、自分にとって意味のある任意の ID を指定できます。リクエストの各コンバージョンには一意の ID を指定する必要があります。また、ID とタイムスタンプの組み合わせは広告主のすべてのコンバージョン間で一意である必要があります。オンラインコンバージョンの場合、広告主の Floodlight 指示に応じて、`dsConversionId` または `floodlightOrderId` がこのプロパティにコピーされます。
`conversion[].conversionModifiedTimestamp`	`unsigned long`	コンバージョンが最後に変更された時刻（エポックミリ秒（UTC））。
`conversion[].conversionTimestamp`	`unsigned long`	コンバージョンが発生した時刻（エポックミリ秒（UTC））。
`conversion[].countMillis`	`long`	この機能をご利用いただけるのは、DoubleClick Search カスタマーサポートへの連絡が完了した後のみです。
`conversion[].criterionId`	`long`	DS の条件（キーワード）ID。
`conversion[].currencyCode`	`string`	コンバージョンの収益の通貨コード。ISO 4217 英字（3 文字）形式である必要があります。	書き込み可能
`conversion[].customDimension[]`	`list`	コンバージョンのカスタムディメンション。レポートのデータをフィルタするために使用できます。
`conversion[].customDimension[].name`	`string`	カスタムディメンション名。
`conversion[].customDimension[].value`	`string`	カスタムディメンション値。
`conversion[].customMetric[]`	`list`	コンバージョンのカスタム指標。
`conversion[].customMetric[].name`	`string`	カスタム指標名。
`conversion[].customMetric[].value`	`double`	カスタム指標の数値。
`conversion[].customerId`	`string`	検索広告 360 リニューアル版のお客様 ID。クライアントアカウントである必要があります。このフィールドが設定されている場合、他のすべての ID フィールドでは検索広告 360 リニューアル版の ID を設定する必要があります。
`conversion[].deviceType`	`string`	コンバージョンが発生したデバイスのタイプ。有効な値は次のとおりです。 "`DESKTOP`" "`HIGH_END_MOBILE`" "`OTHER_DEVICE`" 「`TABLET`」
`conversion[].dsConversionId`	`long`	DoubleClick Search がコンバージョンごとに生成する ID。
`conversion[].engineAccountId`	`long`	DS エンジンアカウント ID。
`conversion[].floodlightOrderId`	`string`	コンバージョンに関して広告主から提供された Floodlight オーダー ID。
`conversion[].inventoryAccountId`	`long`	商品を含む在庫アカウントを一意に識別するために DS によって生成され、使用される ID。
`conversion[].productCountry`	`string`	商品を含む Merchant Center フィードに登録されている国。国の指定には ISO 3166 コードを使用します。
`conversion[].productGroupId`	`long`	DS 商品グループ ID。
`conversion[].productId`	`string`	商品 ID（SKU）。
`conversion[].productLanguage`	`string`	商品を含む Merchant Center フィードに登録されている言語。言語は ISO 639 コードで指定します。
`conversion[].quantityMillis`	`long`	このコンバージョンの数量（ミリ秒）。	書き込み可能
`conversion[].revenueMicros`	`long`	この「`TRANSACTION`」コンバージョンの収益額。マイクロ秒単位（1, 000, 000 を掛けた値、小数なし）で指定します。たとえば、収益の値を「10」に指定する場合「10000000」と入力します1,000 万）。	書き込み可能
`conversion[].segmentationId`	`long`	数値のセグメンテーション ID（例: DoubleClick Search Floodlight アクティビティ ID）。
`conversion[].segmentationName`	`string`	わかりやすいセグメンテーション ID（例: DoubleClick Search Floodlight アクティビティ名）。
`conversion[].segmentationType`	`string`	このコンバージョンのセグメントタイプ（例: `FLOODLIGHT`）。指定できる値は次のとおりです。 <ph type="x-smartling-placeholder"> </ph> 「`FLOODLIGHT`」
`conversion[].state`	`string`	コンバージョンの状態（`ACTIVE` または `REMOVED`）。注: DELETED 状態は非推奨となりました。指定できる値は次のとおりです。 <ph type="x-smartling-placeholder"> </ph> 「`ACTIVE`」 "`DELETED`": （非推奨）「`REMOVED`」	書き込み可能
`conversion[].storeId`	`string`	広告で宣伝された実店舗の ID。チャンネルが「`local`」の場合のみ該当。
`conversion[].type`	`string`	コンバージョンのタイプ（`ACTION` または `TRANSACTION`）。`ACTION` コンバージョンは、金銭的に定量化できる値を持たないユーザーによるアクションで、`TRANSACTION` コンバージョンは、金銭的に定量化できる値があるアクションです。たとえば、メーリングリストの登録（`ACTION`）や e コマースの購入（`TRANSACTION`）などです。有効な値は次のとおりです。 <ph type="x-smartling-placeholder"> </ph> 「`ACTION`」「`TRANSACTION`」
`kind`	`string`	ConversionList リソースであることが示されます。値: 固定文字列 `doubleclicksearch#conversionList`。

メソッド

get: DoubleClick Search エンジンアカウントからコンバージョンのリストを取得します。
getByCustomerId: 検索広告 360 リニューアル版のお客様 ID を使用して、DoubleClick Search エンジンアカウントからコンバージョンのリストを取得します。
insert: 一連の新しいコンバージョンを DoubleClick Search に挿入します。
update: DoubleClick Search で一連のコンバージョンを更新します。
updateAvailability: DoubleClick Search で一連の Floodlight アクティビティの配信状況を更新します。