Method: customers.uploadConversionAdjustments

指定されたコンバージョンの調整を処理します。

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

HTTP リクエスト

POST https://googleads.googleapis.com/v16/customers/{customerId}:uploadConversionAdjustments

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

パスパラメータ

パラメータ
customerId

string

必須。アップロードを行う顧客の ID。

リクエスト本文

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

JSON 表現 
{
  "conversionAdjustments": [
    {
      object (ConversionAdjustment)
    }
  ],
  "partialFailure": boolean,
  "validateOnly": boolean,
  "jobId": integer
}
フィールド
conversionAdjustments[]

object (ConversionAdjustment)

必須。アップロードされるコンバージョンの調整。
partialFailure

boolean

必須。true の場合、成功したオペレーションが実行され、無効なオペレーションはエラーを返します。false の場合、すべてのオペレーションが有効な場合にのみ、1 つのトランザクションで実行されます。これは常に true に設定する必要があります。部分的エラーについて詳しくは、https://developers.google.com/google-ads/api/docs/best-practices/partial-failures をご覧ください。
validateOnly

boolean

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

integer

（省略可）ジョブ ID を設定するためのオプションの入力。指定する場合は 2^31 未満の 0 以上の数値にする必要があります。このフィールドが指定されていない場合、API は [2^31, (2^63)-1] の範囲のジョブ ID を生成します。API はこのリクエストの値を UploadConversionAdjustmentsResponse の jobId フィールドに返します。

レスポンスの本文

ConversionAdjustmentUploadService.UploadConversionAdjustments に対するレスポンス メッセージです。

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

JSON 表現 
{
  "partialFailureError": {
    object (Status)
  },
  "results": [
    {
      object (ConversionAdjustmentResult)
    }
  ],
  "jobId": string
}
フィールド
partialFailureError

object (Status)

部分的な障害モードのコンバージョン調整の失敗に関連するエラー。調整内ですべてのエラーが発生した場合に返されます。この調整以外でエラー（認証エラーなど）が発生した場合は、RPC レベルのエラーが返されます。部分的エラーについて詳しくは、https://developers.google.com/google-ads/api/docs/best-practices/partial-failures をご覧ください。
results[]

object (ConversionAdjustmentResult)

コンバージョンの調整が正常に処理された場合に返されます。エラーが発生した行では、Proto は空になります。validateOnly が true の場合、結果は返されません。
jobId

string (int64 format)

アップロード バッチのジョブ ID。

承認スコープ

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

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

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

ConversionAdjustment

コンバージョンの調整。

JSON 表現 
{
  "gclidDateTimePair": {
    object (GclidDateTimePair)
  },
  "adjustmentType": enum (ConversionAdjustmentType),
  "restatementValue": {
    object (RestatementValue)
  },
  "userIdentifiers": [
    {
      object (UserIdentifier)
    }
  ],
  "orderId": string,
  "conversionAction": string,
  "adjustmentDateTime": string,
  "userAgent": string
}
フィールド
gclidDateTimePair

object (GclidDateTimePair)

調整の場合、オーダー ID の指定なしでレポートされたコンバージョンを一意に識別します。AlignmentType が ENHANCEMENT の場合、この値は省略可能ですが、orderId に加えて設定できます。
adjustmentType

enum (ConversionAdjustmentType)

調整タイプ。
restatementValue

object (RestatementValue)

コンバージョン値の説明に必要な情報。修正には必須。撤回用に指定することはできません。撤回に対して指定すると、エラーが返されます。注: 別の調整値で 2 回目の修正ステートメントをアップロードするには、新しい調整の発生時刻を指定する必要があります。それ以外の場合は、以前の修正と重複するものとして扱われ、無視されます。
userIdentifiers[]

object (UserIdentifier)

元のコンバージョンを強化するユーザー識別子。ConversionAdjustUploadService は拡張機能のユーザー識別子のみを受け入れます。各拡張機能のユーザー識別子の最大数は 5 個です。
orderId

string

調整されるコンバージョンの注文 ID。コンバージョンがオーダー ID を指定してレポートされた場合は、そのオーダー ID を ID として使用する必要があります。機能強化にはオーダー ID が必要です。
conversionAction

string

このコンバージョン調整に関連付けられたコンバージョン アクションのリソース名。注: このリソース名は顧客 ID とコンバージョン アクション ID で構成されますが、検証では顧客 ID は無視され、コンバージョン アクション ID がコンバージョン アクションの唯一の ID として使用されます。
adjustmentDateTime

string

調整が発生した日時。conversionDateTime より後である必要があります。タイムゾーンを指定する必要があります。形式は「yyyy-mm-dd hh:mm:ss+|-hh:mm」です（例: 2019-01-01 12:32:45-08:00）。
userAgent

string

元のコンバージョンを強化するユーザー エージェント。この情報は、ユーザーがウェブページでコンバージョンを達成したときに、HTTP リクエスト ヘッダーで確認できます。例: 「Mozilla/5.0 (iPhone; CPU iPhone OS 12_2 like Mac OS X)」。ユーザー エージェントは、ユーザー ID を使用する拡張機能でのみ指定できます。元のコンバージョンを送信したリクエストのユーザー エージェントと一致している必要があります。これにより、コンバージョンとその拡張が両方とも同じデバイスに分類されるか、両方がクロスデバイスに分類されます。

GclidDateTimePair

オーダー ID の指定なしでレポートされたコンバージョンを一意に識別します。

JSON 表現 
{
  "gclid": string,
  "conversionDateTime": string
}
フィールド
gclid

string

この調整の対象となる、元のコンバージョンに関連付けられた Google クリック ID（GCLID）。
conversionDateTime

string

この調整で元のコンバージョンが発生した日時。タイムゾーンを指定する必要があります。形式は「yyyy-mm-dd hh:mm:ss+|-hh:mm」です（例: 2019-01-01 12:32:45-08:00）。

ConversionAdjustmentType

レポート済みのコンバージョンを調整するために実施できるさまざまなアクション。撤回を行うと、コンバージョンが無効になります。修正ステートメントはコンバージョン値を変更します。

列挙型
UNSPECIFIED 指定されていません。
UNKNOWN このバージョンで不明な値を表します。
RETRACTION 合計値と数の両方がゼロになるようにコンバージョンを否定します。
RESTATEMENT コンバージョン値を変更します。
ENHANCEMENT 提供されたユーザー ID とユーザー エージェントで既存のコンバージョンを補完します。ユーザー ID とユーザー エージェントを Google が使用して、コンバージョン数を増やします。

RestatementValue

コンバージョンの値を修正するために必要な情報が含まれています。

JSON 表現 
{
  "adjustedValue": number,
  "currencyCode": string
}
フィールド
adjustedValue

number

修正後のコンバージョン値。修正後のコンバージョン値です。たとえば、コンバージョンの値を 100 から 70 に変更するには、調整値 70 を報告します。注: 別の調整値で 2 回目の修正ステートメントをアップロードするには、新しい調整の発生時刻を指定する必要があります。それ以外の場合は、以前の修正と重複するものとして扱われ、無視されます。
currencyCode

string

修正された値の通貨。指定しない場合はコンバージョン アクションのデフォルトの通貨が使用され、設定しない場合はアカウントの通貨が使用されます。USD や EUR などの 3 文字の ISO 4217 通貨コードです。

ConversionAdjustmentResult

正常に処理された ConversionAdjust を識別する情報。

JSON 表現 
{
  "gclidDateTimePair": {
    object (GclidDateTimePair)
  },
  "orderId": string,
  "adjustmentType": enum (ConversionAdjustmentType),
  "conversionAction": string,
  "adjustmentDateTime": string
}
フィールド
gclidDateTimePair

object (GclidDateTimePair)

コンバージョンの GCLID とコンバージョン日時。
orderId

string

調整されるコンバージョンの注文 ID。
adjustmentType

enum (ConversionAdjustmentType)

調整タイプ。
conversionAction

string

このコンバージョン調整に関連付けられたコンバージョン アクションのリソース名。
adjustmentDateTime

string

調整が発生した日時。形式は「yyyy-mm-dd hh:mm:ss+|-hh:mm」です（例: 2019-01-01 12:32:45-08:00）。