Method: customers.accountLinks.mutate

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

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

HTTP リクエスト

POST https://googleads.googleapis.com/v19/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 Overview をご覧ください。

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

オペレーションが成功した場合に返されます。