Method: customers.uploadClickConversions

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

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

HTTP リクエスト

POST https://googleads.googleapis.com/v15/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 未満の負でない数値を指定する必要があります。このフィールドを指定しない場合は、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。コンバージョンのアップロードでは、hashedEmail と hashedPhoneNumber のみがサポートされます。各コンバージョンのユーザー識別子の最大数は 5 です。
conversionEnvironment

enum (ConversionEnvironment)

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

object (Consent)

イベントの同意設定。
gclid

string

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

string

このコンバージョンに関連付けられたコンバージョン アクションのリソース名。注: このリソース名には顧客 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 つのコンバージョン アクションにつき 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。コンバージョンのアップロードでは、hashedEmail と 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）。