- HTTP 要求
- 路徑參數
- 要求主體
- 回應主體
- 授權範圍
- ConversionAdjustment
- GclidDateTimePair
- ConversionAdjustmentType
- RestatementValue
- ConversionAdjustmentResult
- 試試看!
處理指定的轉換調整項。
擲回錯誤清單:AuthenticationError AuthorizationError HeaderError InternalError PartialFailureError QuotaError RequestError
HTTP 要求
POST https://googleads.googleapis.com/v16/customers/{customerId}:uploadConversionAdjustments
這個網址使用 gRPC 轉碼語法。
路徑參數
參數 | |
---|---|
customerId |
必要欄位。執行上傳作業的客戶 ID。 |
要求主體
要求主體的資料會採用以下結構:
JSON 表示法 |
---|
{
"conversionAdjustments": [
{
object ( |
欄位 | |
---|---|
conversionAdjustments[] |
必要欄位。上傳中的轉換調整項。 |
partialFailure |
必要欄位。若為 true,將會執行成功的作業,而且無效的作業也會傳回錯誤。如為 false,則只有在所有作業都有效時,才會在一筆交易中執行所有作業。這個欄位必須一律設為 true。如要進一步瞭解部分失敗,請參閱 https://developers.google.com/google-ads/api/docs/best-practices/partial-failures。 |
validateOnly |
如果為 true,表示要求會完成驗證,但尚未執行。系統只會傳回錯誤,不會傳回結果。 |
jobId |
選用設定。設定工作 ID 的選填輸入內容。必須是小於 2^31 (如有提供) 的非負數數字。如未提供這個欄位,API 將產生 [2^31, (2^63)-1] 這個範圍的工作 ID。API 會在 |
回應主體
「ConversionAdjustmentUploadService.UploadConversionAdjustments
」的回應訊息。
如果成功,回應主體即會包含具有以下結構的資料:
JSON 表示法 |
---|
{ "partialFailureError": { object ( |
欄位 | |
---|---|
partialFailureError |
部分失敗模式下的轉換調整項失敗相關錯誤。調整範圍內發生所有錯誤時,系統會傳回這個數值。如果調整範圍以外發生任何錯誤 (例如驗證錯誤),系統會傳回遠端程序呼叫 (RPC) 層級錯誤。如要進一步瞭解部分失敗,請參閱 https://developers.google.com/google-ads/api/docs/best-practices/partial-failures。 |
results[] |
已處理完畢的轉換調整項傳回。如果出現收到錯誤的資料列,Proto 會是空白的。VerifyOnly 為 true 時,不會傳回結果。 |
jobId |
上傳批次的工作 ID。 |
授權範圍
需要下列 OAuth 範圍:
https://www.googleapis.com/auth/adwords
詳情請參閱 OAuth 2.0 總覽。
ConversionAdjustment
轉換調整項。
JSON 表示法 |
---|
{ "gclidDateTimePair": { object ( |
欄位 | |
---|---|
gclidDateTimePair |
調整項是專門用於識別未指定訂單 ID 所回報的轉換。如果調整項類型是「ENHANCEMENT」,這個值是選用項目,但除了 orderId 之外,也可以設定。 |
adjustmentType |
調整項類型。 |
restatementValue |
修改轉換價值所需的資訊。重編欄位必填。請勿用於撤銷作業。如果提交撤銷要求,系統會傳回錯誤。注意:如要上傳調整後值不同的第二次重編,該值必須具有新的調整發生時間。否則,系統會將其視為與先前重編的重複項目並忽略。 |
userIdentifiers[] |
可改善原始轉換的使用者 ID。Conversion 調整項 UploadService 只接受改善項目的使用者 ID。每項強化項目的使用者 ID 數量上限為 5 個。 |
orderId |
要調整轉換的訂單 ID。如果轉換記錄中的訂單有指定的訂單 ID,則必須使用該訂單 ID 做為此處的 ID。強化項目必須要有訂單 ID。 |
conversionAction |
與此轉換調整項相關聯的轉換動作資源名稱。注意:雖然這個資源名稱是由客戶 ID 和轉換動作 ID 組成,但驗證程序會忽略客戶 ID,並使用轉換動作 ID 做為轉換動作的唯一 ID。 |
adjustmentDateTime |
發生調整項的日期。必須晚於 conversionDateTime。必須指定時區。格式為「yyyy-mm-dd hh:mm:ss+|-hh:mm」,例如「2019-01-01 12:32:45-08:00」。 |
userAgent |
可增強原始轉換的使用者代理程式。如果使用者在您的網頁上完成轉換,您可以在使用者的 HTTP 要求標頭中找到這項資訊。例如:「Mozilla/5.0 (iPhone; CPU iPhone OS 12_2 like Mac OS X)」。您只能在內含使用者 ID 的強化項目中指定使用者代理程式。這個值應與傳送原始轉換的要求使用者代理程式相符,以便將轉換和相關強化作業全部歸因於相同裝置,或同時歸因於跨裝置。 |
GclidDateTimePair
用於識別未指定訂單 ID 記錄到的轉換。
JSON 表示法 |
---|
{ "gclid": string, "conversionDateTime": string } |
欄位 | |
---|---|
gclid |
與此調整項原始轉換相關聯的 Google 點擊 ID (gclid)。 |
conversionDateTime |
這項調整項原始轉換發生的日期。必須指定時區。格式為「yyyy-mm-dd hh:mm:ss+|-hh:mm」,例如「2019-01-01 12:32:45-08:00」。 |
ConversionAdjustmentType
廣告客戶可以採取哪些不同的動作來調整已記錄的轉換。撤銷對轉換的撤銷。帳戶復原會變更轉換價值。
列舉 | |
---|---|
UNSPECIFIED |
未指定。 |
UNKNOWN |
代表這個版本未知的值。 |
RETRACTION |
排除某次轉換,使其總價值和計數都是零。 |
RESTATEMENT |
變更轉換價值。 |
ENHANCEMENT |
在現有的轉換中加入所提供的使用者 ID 和使用者代理程式,有助 Google 提高轉換次數。 |
RestatementValue
包含重述轉換價值所需的資訊。
JSON 表示法 |
---|
{ "adjustedValue": number, "currencyCode": string } |
欄位 | |
---|---|
adjustedValue |
重新分配的轉換價值。這是重編後的轉換價值。舉例來說,如要將轉換價值從 100 改為 70,則應記錄調整後的值為 70。注意:如要上傳調整後值不同的第二次重編,該值必須具有新的調整發生時間。否則,系統會將其視為與先前重編的重複項目並忽略。 |
currencyCode |
重置值的貨幣。如未提供,則會採用轉換動作的預設貨幣;如未設定,則會使用帳戶貨幣。此為 ISO 4217 3 個字元的貨幣代碼,例如 USD 或 EUR。 |
ConversionAdjustmentResult
識別成功處理 Conversion 調整項的資訊。
JSON 表示法 |
---|
{ "gclidDateTimePair": { object ( |
欄位 | |
---|---|
gclidDateTimePair |
轉換的 Google 點擊 ID 和轉換日期時間。 |
orderId |
要調整轉換的訂單 ID。 |
adjustmentType |
調整項類型。 |
conversionAction |
與此轉換調整項相關聯的轉換動作資源名稱。 |
adjustmentDateTime |
發生調整項的日期。格式為「yyyy-mm-dd hh:mm:ss+|-hh:mm」,例如「2019-01-01 12:32:45-08:00」。 |