Method: customers.customAudiences.mutate

建立或更新自訂目標對象。會傳回作業狀態。

擲回錯誤清單:AuthenticationError AuthorizationError CustomAudienceError CustomInterestError FieldError FieldMaskError HeaderError InternalError MutateError OperationAccessDeniedError PolicyViolationErrorQuotaErrorRequestError

HTTP 要求

POST https://googleads.googleapis.com/v14/customers/{customerId}/customAudiences:mutate

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
customerId

string

必要欄位。要修改自訂目標對象的客戶 ID。

要求主體

要求主體的資料會採用以下結構:

JSON 表示法
{
  "operations": [
    {
      object (CustomAudienceOperation)
    }
  ],
  "validateOnly": boolean
}
欄位
operations[]

object (CustomAudienceOperation)

必要欄位。針對個別自訂目標對象執行的作業清單。

validateOnly

boolean

如果為 true,則驗證要求但尚未執行。系統只會傳回錯誤,而非傳回結果。

回應主體

自訂目標對象變更的回應訊息。

如果成功,回應主體即會包含具有以下結構的資料:

JSON 表示法
{
  "results": [
    {
      object (MutateCustomAudienceResult)
    }
  ]
}
欄位
results[]

object (MutateCustomAudienceResult)

變更的所有結果。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/adwords

詳情請參閱 OAuth 2.0 總覽

CustomAudienceOperation

對自訂目標對象的一項作業 (建立、更新)。

JSON 表示法
{
  "updateMask": string,

  // Union field operation can be only one of the following:
  "create": {
    object (CustomAudience)
  },
  "update": {
    object (CustomAudience)
  },
  "remove": string
  // End of list of possible types for union field operation.
}
欄位
updateMask

string (FieldMask format)

可決定更新中要修改哪些資源欄位的 FieldMask。

此為以半形逗號分隔的完整欄位名稱清單。範例:"user.displayName,photo"

聯集欄位 operation。修改作業。operation 只能是下列其中一項:
create

object (CustomAudience)

建立作業:新的自訂目標對像不需要任何資源名稱。

update

object (CustomAudience)

更新作業:自訂目標對象必須具備有效的資源名稱。

remove

string

移除作業:已移除自訂目標對象的資源名稱,格式如下:

customers/{customerId}/customAudiences/{custom_audience_id}

MutateCustomAudienceResult

自訂目標對象的結果發生變化。

JSON 表示法
{
  "resourceName": string
}
欄位
resourceName

string

傳回成功的作業。