Method: customers.uploadClickConversions

指定されたクリック コンバージョンを処理します。

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

HTTP リクエスト

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

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

パスパラメータ

パラメータ
customerId

string

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

リクエスト本文

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

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

object (ClickConversion)

必須。アップロード中のコンバージョン。
partialFailure

boolean

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

boolean

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

boolean

true の場合、API はすべてのアップロード チェックを実行し、エラーが見つかった場合はエラーを返します。false の場合、基本的な入力検証のみを実行し、後続のアップロード チェックはスキップし、指定された userIdentifiers でクリックが見つからなくても成功を返します。

この設定は、GCLID、GBRAID、WBRAID ではなく userIdentifiers を使用するリードの拡張コンバージョンにのみ影響します。リードの拡張コンバージョンをアップロードする際は、Google 広告キャンペーンに由来しないものも含め、すべてのコンバージョン イベントを API にアップロードする必要があります。このフィールドが true に設定されている場合、Google 広告の広告キャンペーン以外のイベントをアップロードすると、CLICK_NOT_FOUND エラーが発生します。これらのエラーはこのようなイベントで発生することが予想されるため、このフィールドを false に設定して、アップロードの形式が正しいことを確認します。ただし、Google 広告キャンペーン以外で発生した CLICK_NOT_FOUND エラーはすべて無視されます。これにより、対処できるエラーのみに集中できます。

デフォルトは false です。
jobId

integer

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

レスポンスの本文

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

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

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

object (Status)

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

object (ClickConversionResult)

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

string (int64 format)

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

承認スコープ

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

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

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

ClickConversion

クリック コンバージョン。

JSON 表現 
{
  "gbraid": string,
  "wbraid": string,
  "externalAttributionData": {
    object (ExternalAttributionData)
  },
  "customVariables": [
    {
      object (CustomVariable)
    }
  ],
  "cartData": {
    object (CartData)
  },
  "userIdentifiers": [
    {
      object (UserIdentifier)
    }
  ],
  "conversionEnvironment": enum (ConversionEnvironment),
  "consent": {
    object (Consent)
  },
  "gclid": string,
  "conversionAction": string,
  "conversionDateTime": string,
  "conversionValue": number,
  "currencyCode": string,
  "orderId": string
}
フィールド
gbraid

string

iOS14 以降の iOS デバイスで発生した、アプリ コンバージョンに関連付けられたクリックのクリック ID。
wbraid

string

iOS14 以降の iOS デバイスで発生した、ウェブ コンバージョンに関連付けられたクリックのクリック ID。
externalAttributionData

object (ExternalAttributionData)

外部で貢献度が割り当てられたコンバージョンに関する追加データ。外部で貢献度が割り当てられたコンバージョン アクションがあるコンバージョンの場合、このフィールドは必須です。他の値を設定することはできません。
customVariables[]

object (CustomVariable)

このコンバージョンに関連付けられたカスタム変数。
cartData

object (CartData)

このコンバージョンに関連付けられたカートデータ。
userIdentifiers[]

object (UserIdentifier)

このコンバージョンに関連付けられたユーザー ID。コンバージョンのアップロードで使用できるのは、HashEmail と hashedPhoneNumber のみです。各コンバージョンのユーザー識別子の最大数は 5 個です。
conversionEnvironment

enum (ConversionEnvironment)

このコンバージョンが記録された環境（アプリ、ウェブなど）。
consent

object (Consent)

イベントの同意設定。
gclid

string

このコンバージョンに関連付けられた Google クリック ID（GCLID）。
conversionAction

string

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

string

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

number

広告主にとってのコンバージョンの価値。
currencyCode

string

コンバージョン値に関連付けられた通貨。3 文字の ISO 4217 通貨コードです。例: USD、EUR。
orderId

string

コンバージョンに関連付けられたオーダー ID。オーダー ID は、コンバージョン アクションごとに 1 つのコンバージョンにのみ使用できます。

ExternalAttributionData

外部で貢献度が割り当てられたコンバージョンに関する追加情報が含まれます。

JSON 表現 
{
  "externalAttributionCredit": number,
  "externalAttributionModel": string
}
フィールド
externalAttributionCredit

number

Google 広告のクリックに起因するコンバージョンの割合を表します。
externalAttributionModel

string

アトリビューション モデルの名前を指定します。

CartData

カートデータに関する追加情報が含まれます。

JSON 表現 
{
  "merchantId": string,
  "feedCountryCode": string,
  "feedLanguageCode": string,
  "localTransactionCost": number,
  "items": [
    {
      object (Item)
    }
  ]
}
フィールド
merchantId

string (int64 format)

商品アイテムのアップロード先の Merchant Center ID。
feedCountryCode

string

商品アイテムのアップロード先フィードに関連付けられている国コード。
feedLanguageCode

string

商品アイテムのアップロード先フィードに関連付けられている言語コード。
localTransactionCost

number

カート全体に対する送料無料やクーポン割引など、すべての注文単位の割引の合計。通貨コードは ClickConversion メッセージの通貨コードと同じです。
items[]

object (Item)

購入された商品アイテムのデータ。

商品

購入されたアイテムのデータが含まれます。

JSON 表現 
{
  "productId": string,
  "quantity": integer,
  "unitPrice": number
}
フィールド
productId

string

商品アイテムのショッピング ID。Merchant Center の商品 ID と同じにする必要があります。
quantity

integer

販売個数。
unitPrice

number

単価。税金、送料、注文単位での割引は含みません。通貨コードは ClickConversion メッセージの通貨コードと同じです。

ConversionEnvironment

アップロードされたコンバージョンのコンバージョン環境。

列挙型
UNSPECIFIED 指定されていません。
UNKNOWN 戻り値にのみ使用されます。このバージョンで不明な値を表します。
APP コンバージョンがアプリで記録された。
WEB コンバージョンがウェブサイトで記録された。

ClickConversionResult

正常に処理された ClickConversion の識別情報。

JSON 表現 
{
  "gbraid": string,
  "wbraid": string,
  "userIdentifiers": [
    {
      object (UserIdentifier)
    }
  ],
  "gclid": string,
  "conversionAction": string,
  "conversionDateTime": string
}
フィールド
gbraid

string

iOS14 以降の iOS デバイスで発生した、アプリ コンバージョンに関連付けられたクリックのクリック ID。
wbraid

string

iOS14 以降の iOS デバイスで発生した、ウェブ コンバージョンに関連付けられたクリックのクリック ID。
userIdentifiers[]

object (UserIdentifier)

このコンバージョンに関連付けられたユーザー ID。コンバージョンのアップロードで使用できるのは、HashEmail と hashedPhoneNumber のみです。各コンバージョンのユーザー識別子の最大数は 5 個です。
gclid

string

このコンバージョンに関連付けられた Google クリック ID（GCLID）。
conversionAction

string

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

string

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