- HTTP リクエスト
- パスパラメータ
- リクエストの本文
- レスポンスの本文
- 認可スコープ
- ConversionAdjustment
- GclidDateTimePair
- ConversionAdjustmentType
- RestatementValue
- ConversionAdjustmentResult
- 試してみる
指定されたコンバージョンの調整を処理します。
スローされるエラーのリスト: AuthenticationError AuthorizationError HeaderError InternalError PartialFailureError QuotaError RequestError
HTTP リクエスト
POST https://googleads.googleapis.com/v15/customers/{customerId}:uploadConversionAdjustments
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
パラメータ | |
---|---|
customerId |
必須。アップロードを行った顧客の ID。 |
リクエスト本文
リクエストの本文には、次の構造のデータが含まれます。
JSON 表現 |
---|
{
"conversionAdjustments": [
{
object ( |
フィールド | |
---|---|
conversionAdjustments[] |
必須。アップロードされるコンバージョンの調整です。 |
partialFailure |
必須。true の場合、成功したオペレーションが実行され、無効なオペレーションはエラーを返します。false の場合、すべての操作が有効である場合にのみ、すべての操作が 1 つのトランザクションで実行されます。常に true に設定する必要があります。部分的エラーについて詳しくは、https://developers.google.com/google-ads/api/docs/best-practices/partial-failures をご覧ください。 |
validateOnly |
true の場合、リクエストは検証されますが、実行されません。エラーのみが返され、結果は返されません。 |
jobId |
(省略可)ジョブ ID を設定するための入力(省略可)。指定する場合は、2^31 未満の負でない数値を指定する必要があります。このフィールドを指定しない場合は、API によって範囲 [2^31, (2^63)-1] のジョブ ID が生成されます。API は、このリクエストの値を |
レスポンスの本文
ConversionAdjustmentUploadService.UploadConversionAdjustments
に対するレスポンス メッセージです。
成功すると、レスポンスの本文に次の構造のデータが含まれます。
JSON 表現 |
---|
{ "partialFailureError": { object ( |
フィールド | |
---|---|
partialFailureError |
部分的障害モードにおけるコンバージョンの調整の失敗に関連するエラー。調整内ですべてのエラーが発生した場合に返されます。調整範囲外でエラー(認証エラーなど)が発生した場合は、RPC レベルのエラーが返されます。部分的エラーについて詳しくは、https://developers.google.com/google-ads/api/docs/best-practices/partial-failures をご覧ください。 |
results[] |
正常に処理されたコンバージョンの調整に対して返されます。エラーが発生した行の Proto は空になります。validateOnly が true の場合、結果は返されません。 |
jobId |
アップロード バッチのジョブ ID。 |
認可スコープ
次の OAuth スコープが必要です。
https://www.googleapis.com/auth/adwords
詳細については、OAuth 2.0 の概要をご覧ください。
ConversionAdjustment
コンバージョンの調整。
JSON 表現 |
---|
{ "gclidDateTimePair": { object ( |
フィールド | |
---|---|
gclidDateTimePair |
調整の場合、オーダー ID の指定なしでレポートされたコンバージョンを一意に識別します。AlignmentType が ENHANCEMENT の場合、この値は省略できますが、orderId に加えて設定することもできます。 |
adjustmentType |
調整タイプ。 |
restatementValue |
コンバージョンの価値を言い換えるために必要な情報。言い換えのために必要です。撤回の場合、この URL は提供しないでください。撤回に対して指定した場合はエラーが返されます。注: 別の調整値で 2 回目の修正をアップロードする場合は、より新しい調整の発生時刻を指定する必要があります。それ以外の場合は、以前の修正ステートメントと重複するものとして扱われ、無視されます。 |
userIdentifiers[] |
元のコンバージョンを強化するユーザー ID。ConversionAdjustUploadService は拡張でユーザー ID のみを受け付けます。各拡張機能のユーザー識別子の最大数は 5 個です。 |
orderId |
調整するコンバージョンのオーダー ID。コンバージョンがオーダー ID を指定してレポートされた場合は、そのオーダー ID を ID として使用する必要があります。拡張にはオーダー ID が必要です。 |
conversionAction |
このコンバージョン調整に関連付けられたコンバージョン アクションのリソース名。注: このリソース名には顧客 ID とコンバージョン アクション ID が含まれますが、検証ではお客様 ID は無視され、コンバージョン アクションの識別子としてコンバージョン アクション ID が使用されます。 |
adjustmentDateTime |
調整が発生した日時。conversionDateTime より後である必要があります。タイムゾーンを指定してください。形式は「yyyy-mm-dd hh:mm:ss+|-hh:mm」です(例: 2019-01-01 12:32:45-08:00)。 |
userAgent |
元のコンバージョンを強化するユーザー エージェント。この ID は、ユーザーがウェブページでコンバージョンを達成したときに、ユーザーの HTTP リクエスト ヘッダーで確認できます。例: 「Mozilla/5.0 (iPhone; CPU iPhone OS 12_2 like Mac OS X」)。ユーザー エージェントは、ユーザー ID を使用する拡張機能でのみ指定できます。これは、元のコンバージョンを送信したリクエストのユーザー エージェントと一致している必要があります。これにより、コンバージョンとその拡張の両方が同じデバイスとしてカウントされるか、両方がクロスデバイスとしてアトリビューションされます。 |
GclidDateTimePair
オーダー ID の指定なしでレポートされたコンバージョンを一意に識別します。
JSON 表現 |
---|
{ "gclid": string, "conversionDateTime": string } |
フィールド | |
---|---|
gclid |
この調整の対象となる元のコンバージョンに関連付けられている Google クリック ID(GCLID)。 |
conversionDateTime |
この調整の対象となる元のコンバージョンが発生した日時。タイムゾーンを指定してください。形式は「yyyy-mm-dd hh:mm:ss+|-hh:mm」です(例: 2019-01-01 12:32:45-08:00)。 |
ConversionAdjustmentType
レポート済みのコンバージョンを調整するために広告主が実施できるさまざまなアクション。撤回を行うと、コンバージョンが無効になります。修正ステートメントはコンバージョン値を変更します。
列挙型 | |
---|---|
UNSPECIFIED |
指定されていません。 |
UNKNOWN |
このバージョンで不明な値を表します。 |
RETRACTION |
合計値と合計数がゼロになるようにコンバージョンを否定します。 |
RESTATEMENT |
コンバージョン値を変更します。 |
ENHANCEMENT |
提供されたユーザー ID とユーザー エージェントで既存のコンバージョンを補完します。Google はこれらを使用して、コンバージョン数を増やします。 |
RestatementValue
コンバージョン値を修正するために必要な情報が含まれています。
JSON 表現 |
---|
{ "adjustedValue": number, "currencyCode": string } |
フィールド | |
---|---|
adjustedValue |
修正後のコンバージョン値。修正後のコンバージョン値です。たとえば、コンバージョンの値を 100 から 70 に変更するには、調整値 70 を報告します。注: 別の調整値で 2 回目の修正をアップロードする場合は、より新しい調整の発生時刻を指定する必要があります。それ以外の場合は、以前の修正ステートメントと重複するものとして扱われ、無視されます。 |
currencyCode |
修正後の値の通貨。指定しない場合は、コンバージョン アクションのデフォルトの通貨が使用されます。指定しない場合は、アカウントの通貨が使用されます。USD、EUR などの 3 文字の ISO 4217 通貨コードを指定します。 |
ConversionAdjustmentResult
正常に処理された ConversionAdjust を識別する情報です。
JSON 表現 |
---|
{ "gclidDateTimePair": { object ( |
フィールド | |
---|---|
gclidDateTimePair |
コンバージョンが達成された GCLID とコンバージョン日時。 |
orderId |
調整するコンバージョンのオーダー ID。 |
adjustmentType |
調整タイプ。 |
conversionAction |
このコンバージョン調整に関連付けられたコンバージョン アクションのリソース名。 |
adjustmentDateTime |
調整が発生した日時。形式は「yyyy-mm-dd hh:mm:ss+|-hh:mm」です(例: 2019-01-01 12:32:45-08:00)。 |