Method: customers.customAudiences.mutate

カスタム オーディエンスを作成または更新します。オペレーションのステータスが返されます。

スローされるエラーのリスト: AuthenticationError AuthorizationError CustomAudienceError CustomInterestError FieldError FieldMaskError HeaderError InternalError MutateError OperationAccessDeniedError PolicyViolationError QuotaErrorRequestError

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
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。mute オペレーションです。operation は次のいずれかになります。
create

object (CustomAudience)

作成オペレーション: 新しいカスタム オーディエンスにはリソース名は不要です。
update

object (CustomAudience)

更新オペレーション: カスタム オーディエンスには有効なリソース名が必要です。
remove

string

削除オペレーション: 削除されたカスタム オーディエンスのリソース名は次の形式で指定します。

customers/{customerId}/customAudiences/{custom_audience_id}

MutateCustomAudienceResult

カスタム オーディエンスの結果は変動します。

JSON 表現 
{
  "resourceName": string
}
フィールド
resourceName

string

成功したオペレーションに対して返されます。