Method: customers.userLists.mutate

建立或更新使用者名單。會傳回作業狀態。

擲回錯誤清單:AuthenticationError AuthorizationError CollectionSizeError DatabaseError DistinctError FieldError FieldMaskError HeaderError InternalError NewResourceCreationErrorNotAllowlistedErrorNotEmptyErrorOperationAccessDeniedErrorQuotaErrorRangeErrorRequestErrorStringFormatErrorStringLengthErrorUserListError

HTTP 要求

POST https://googleads.googleapis.com/v15/customers/{customerId}/userLists:mutate

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

路徑參數

參數
customerId

string

必要欄位。要修改使用者名單的客戶 ID。

要求主體

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

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

object (UserListOperation)

必要欄位。列出要針對個別使用者名單執行的作業。

partialFailure

boolean

如果為 true,系統就會執行成功的作業,且無效的作業會傳回錯誤。如果為 false,只有在所有作業皆有效的情況下,系統才會在單筆交易中執行所有作業。預設值為 false。

validateOnly

boolean

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

回應主體

使用者名單變更的回應訊息。

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

JSON 表示法
{
  "partialFailureError": {
    object (Status)
  },
  "results": [
    {
      object (MutateUserListResult)
    }
  ]
}
欄位
partialFailureError

object (Status)

在部分失敗模式下,與作業失敗相關的錯誤。只有在部分失敗 = true 且作業內發生所有錯誤時,才會傳回這個編號。如果在作業之外發生任何錯誤 (例如驗證錯誤),我們會傳回遠端程序呼叫 (RPC) 層級錯誤。

results[]

object (MutateUserListResult)

變更的所有結果。

授權範圍

需要下列 OAuth 範圍:

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

詳情請參閱 OAuth 2.0 總覽