Method: customers.accountLinks.mutate

アカウントのリンクを作成または削除します。V5 以降では、AccountLinkService.MutateAccountLink による作成はサポートされていません。代わりに AccountLinkService.CreateAccountLink を使用してください。

スローされるエラーのリスト: AccountLinkError AuthenticationError AuthorizationError FieldMaskError HeaderError InternalError MutateError QuotaError RequestError

HTTP リクエスト

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

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

パスパラメータ

パラメータ
customerId

string

必須。変更対象のお客様の ID。

リクエスト本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現
{
  "operation": {
    object (AccountLinkOperation)
  },
  "partialFailure": boolean,
  "validateOnly": boolean
}
フィールド
operation

object (AccountLinkOperation)

必須。リンクで実行するオペレーション。

partialFailure

boolean

true の場合、成功したオペレーションが実行され、無効なオペレーションはエラーを返します。false の場合、すべての操作が有効である場合にのみ、すべての操作が 1 つのトランザクションで実行されます。デフォルトは false です。

validateOnly

boolean

true の場合、リクエストは検証されますが、実行されません。エラーのみが返され、結果は返されません。

レスポンスの本文

アカウントのリンクの変更に対するレスポンス メッセージです。

成功すると、レスポンスの本文に次の構造のデータが含まれます。

JSON 表現
{
  "result": {
    object (MutateAccountLinkResult)
  },
  "partialFailureError": {
    object (Status)
  }
}
フィールド
result

object (MutateAccountLinkResult)

ミューテーションの結果。

partialFailureError

object (Status)

部分障害モードのオペレーションの失敗に関連するエラー。partialFailure が true で、オペレーション内ですべてのエラーが発生した場合にのみ返されます。オペレーションの外部でエラー(認証エラーなど)が発生した場合は、RPC レベルのエラーが返されます。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、OAuth 2.0 の概要をご覧ください。

AccountLinkOperation

アカウントのリンクに関する 1 つの更新。

JSON 表現
{
  "updateMask": string,

  // Union field operation can be only one of the following:
  "update": {
    object (AccountLink)
  },
  "remove": string
  // End of list of possible types for union field operation.
}
フィールド
updateMask

string (FieldMask format)

更新で変更されるリソース フィールドを決定する FieldMask。

完全修飾フィールド名のカンマ区切りリストです。(例: "user.displayName,photo")。

共用体フィールド operation。実行するオペレーション。operation は次のいずれかになります。
update

object (AccountLink)

更新オペレーション: アカウントのリンクには有効なリソース名が必要です。

remove

string

削除オペレーション: 削除するアカウント リンクのリソース名が必要です。形式は次のとおりです。

customers/{customerId}/accountLinks/{accountLinkId}

MutateAccountLinkResult

アカウントのリンクの結果が変わります。

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

string

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