轉換資源提供的方法可讓使用者大量建立、修改及擷取 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) 偏好的同意聲明。沒有預設值。可接受的值如下:已授予:所需同意聲明狀態為「授予」。從 GTE 設定讀取 CPS 偏好設定。已拒絕:所需同意聲明狀態為「拒絕」;CPS 清單為空白。
可接受的值如下:
|
|
conversion[].advertiserId |
long |
DS 廣告主 ID。 | |
conversion[].agencyId |
long |
DS 代理商 ID。 | |
conversion[].attributionModel |
string |
廣告主必須先與 DoubleClick Search 客戶服務團隊聯絡,才能使用這項功能。 | |
conversion[].campaignId |
long |
DS 廣告活動 ID。 | |
conversion[].channel |
string |
產品的銷售通路。可接受的值如下:
|
|
conversion[].clickId |
string |
轉換的 DS 點擊 ID。 | |
conversion[].conversionId |
string |
如為離線轉換,則由廣告主提供這個 ID。廣告主可以指定任何對自己有意義的 ID。要求中的每筆轉換都必須指定專屬 ID,且 ID 和時間戳記的組合在廣告主內不得重複。 針對線上轉換,DS 會根據廣告主的 Floodlight 指示,將 dsConversionId 或 floodlightOrderId 複製到這項屬性。 |
|
conversion[].conversionModifiedTimestamp |
unsigned long |
上次修改轉換的時間,以世界標準時間紀元紀元時間戳記毫秒為單位。 | |
conversion[].conversionTimestamp |
unsigned long |
轉換發生的時間,以世界標準時間紀元毫秒為單位。 | |
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 |
新版 Search Ads 360 客戶 ID。必須是客戶帳戶。設定這個欄位後,請將所有其他 ID 欄位設為新版 Search Ads 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 |
DS 產品群組 ID。 | |
conversion[].productId |
string |
產品 ID (SKU)。 | |
conversion[].productLanguage |
string |
為內含產品的 Merchant Center 動態饋給註冊的語言。使用 ISO 639 代碼指定語言。 | |
conversion[].quantityMillis |
long |
此轉換的數量 (以毫秒為單位)。 | 可寫入 |
conversion[].revenueMicros |
long |
這個 TRANSACTION 轉換的收益金額,以微為單位 (值乘以 1000000,不含小數點)。舉例來說,如要指定「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 ) 和電子商務購買 (TRANSACTION )。
可接受的值如下:
|
|
kind |
string |
表示這是 ConversionList 資源。值:固定字串 doubleclicksearch#conversionList 。 |
方法
- get
- 從 DoubleClick Search 引擎帳戶擷取轉換清單。
- getByCustomerId
- 使用新的 Search Ads 360 客戶 ID,從 DoubleClick Search 引擎帳戶擷取轉換清單。
- 插入
- 將一批新的轉換插入 DoubleClick Search。
- update
- 更新 DoubleClick Search 中的一批轉換。
- updateAvailability
- 更新 DoubleClick Search 中一批 Floodlight 活動的可用性。