コンバージョン リソースには、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,
"sessionAttributesEncoded": bytes
}
]
}| プロパティ名 | 値 | 説明 | メモ |
|---|---|---|---|
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 |
動的検索広告キャンペーン ID。 | |
conversion[].channel |
string |
商品の販売チャネル。有効な値は次のとおりです。
|
|
conversion[].clickId |
string |
コンバージョンの DS クリック ID。 | |
conversion[].conversionId |
string |
オフライン コンバージョンの場合は、広告主がこの ID を提供します。広告主様は、わかりやすい ID を指定できます。リクエスト内の各コンバージョンには一意の ID を指定する必要があります。また、ID とタイムスタンプの組み合わせは、広告主様のすべてのコンバージョンの中で一意である必要があります。 オンライン コンバージョンの場合、DS は広告主の Floodlight の指示に応じて、 dsConversionId または floodlightOrderId をこのプロパティにコピーします。 |
|
conversion[].conversionModifiedTimestamp |
unsigned long |
コンバージョンが最後に変更された日時(UTC エポックからのミリ秒数)。 | |
conversion[].conversionTimestamp |
unsigned long |
コンバージョンが発生した日時(UTC エポックからのミリ秒数)。 | |
conversion[].countMillis |
long |
DoubleClick Search カスタマー サポートにお問い合わせいただいた広告主様のみご利用いただけます。 | |
conversion[].criterionId |
long |
動的検索広告の条件(キーワード)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 |
コンバージョンが発生したデバイスのタイプ。
有効な値は次のとおりです。
|
|
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 |
動的検索広告の商品グループ 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)。
有効な値は次のとおりです。
|
|
conversion[].sessionAttributesEncoded |
bytes |
イベントのセッション属性。base64 でエンコードされた JSON 文字列で表されます。コンテンツは Google 提供のライブラリによって生成される必要があります。 | |
conversion[].state |
string |
コンバージョンのステータス(ACTIVE または REMOVED)。注: 状態 DELETED は非推奨になりました。有効な値は次のとおりです。
|
書き込み可能 |
conversion[].storeId |
string |
商品が宣伝されたローカル ストアの ID。チャネルが「local」の場合にのみ適用されます。 |
|
conversion[].type |
string |
コンバージョンのタイプ(ACTION または TRANSACTION)。ACTION コンバージョンは、金銭的に定量化できないユーザー アクションです。一方、TRANSACTION コンバージョンは、金銭的に定量化できるユーザー アクションです。例: メーリング リストへの登録(ACTION)と e コマース購入(TRANSACTION)。
有効な値は次のとおりです。
|
|
kind |
string |
これは ConversionList リソースであることを示します。値: 固定文字列 doubleclicksearch#conversionList。 |
メソッド
- get
- DoubleClick Search エンジン アカウントからコンバージョンのリストを取得します。
- getByCustomerId
- 検索広告 360 リニューアル版の新しいお客様 ID を使用して、DoubleClick Search エンジン アカウントのコンバージョンのリストを取得します。
- insert
- 新しいコンバージョンのバッチを DoubleClick Search に挿入します。
- update
- DoubleClick Search でコンバージョンを一括更新します。
- updateAvailability
- 検索広告 360 で、Floodlight アクティビティのバッチの公開設定を更新します。