アプリ コンバージョン トラッキングとリマーケティング - リクエストとレスポンスの仕様

アプリのユーザー エージェント

スパム対策の取り組みの一環として、アプリユーザーに代わってアナリティクス/広告プロダクトから送信される User-Agent ヘッダーの標準化された仕様を開発しました。アプリの User-Agent は、次の仕様に準拠するためにネイティブ コードから導出できます。

name version (os_and_version; locale; device; build; Proxy)

これらのフィールドの定義は次のとおりです。

ユーザー エージェントのコンポーネント
name

アナリティクス/広告プロダクトの名前。(Google AdMob)

ユーザー エージェントがクライアント側で構築されている場合、name はクライアント アプリのバンドル ID になります。


Android
// Specified by API consumer.

iOS
// Specified by API consumer.
version

分析/広告サービスのバージョン。 (7.10.1)


Android
// Specified by API consumer.

iOS
// Specified by API consumer.
os_and_version

アプリが実行されているオペレーティング システムとオペレーティング システムのバージョン。(Android 6.0 )


Android
String osAndVersion =
    "Android " + Build.VERSION.RELEASE;

iOS
UIDevice *uid =
  [UIDevice currentDevice];
NSString *osAndVersion =
  [NSString
    stringWithFormat:@"%@ %@",
    [uid systemName],
    [uid systemVersion]];
locale

デバイスの IETF ロケールタグ。2 文字の言語コードと国コードをアンダースコアで区切って使用します。(en_US)


Android
String locale = Locale.getDefault();

iOS
NSString *locale =
  [[NSLocale currentLocale]
    localeIdentifier]
device

アナリティクス/広告プロダクトを実行している実機の名前。(iPhone9,1)


Android
String device = Build.MODEL;

iOS
@import Darwin.sys.sysctl;

NSString *device(void) {
  size_t bufferSize = 64;
  NSMutableData *buffer =
    [[NSMutableData alloc]
      initWithLength:bufferSize];
  int status =
    sysctlbyname("hw.machine",
      buffer.mutableBytes,
      &bufferSize, NULL, 0);
  if (status != 0) {
    return nil;
  }
  return [[NSString alloc]
    initWithCString:buffer.mutableBytes
    encoding:NSUTF8StringEncoding];
}
build

「Build/」の後にオペレーティング システムのビルド番号が続きます。(Build/13D15)


Android
String build = "Build/" + Build.ID;

iOS
@import Darwin.sys.sysctl;

NSString *build(void) {
  size_t bufferSize = 64;
  NSMutableData *buffer =
    [[NSMutableData alloc]
      initWithLength:bufferSize];
  int status =
    sysctlbyname("kern.osversion",
      buffer.mutableBytes,
      &bufferSize, NULL, 0);
  if (status != 0) {
    return nil;
  }
  return [[NSString alloc]
    initWithCString:buffer.mutableBytes
    encoding:NSUTF8StringEncoding];
}

アプリの User-Agent をサーバーサイドで構築する場合は、アプリの User-Agent の末尾にのみ ; Proxy を含めます。アプリの User-Agent が完全にクライアントサイドで構築されている場合は、; Proxy を除外します。したがって、アプリのユーザー エージェントは次のようになります。

  • Android: AdMob/7.10.1 (Android 6.0; en_US; SM-G900F; Build/MMB29M; Proxy)
  • iOS: AdMob/7.10.1 (iOS 10.0.2; en_US; iPhone9,1; Build/13D15; Proxy)

コンバージョン トラッキング リクエスト ガイド

コンバージョン トラッキング リクエストの目的は、コンバージョンとしてトラッキングし、リマーケティング リストの作成に使用するアプリ イベントを Google 広告に通知することと、イベントの前に発生したクリックを説明するメタデータを取得することです。

すべての API 呼び出しは www.googleadservices.com ドメインに対して行われます。変換リクエストは、次のパスの HTTPS 経由の POST リクエストです。

/pagead/conversion/app/version
ここで、version はコンバージョン トラッキング API の目的のバージョンです。

標準のアプリ コンバージョン リクエストには、App Conversion API v1.1 の次のパラメータが含まれます。

コンバージョン トラッキング リクエスト
dev_token

必須


場所: クエリ


API コンシューマーに発行された一意の静的デベロッパー トークン。

Z_eErE4DkvcKjDM1OVE4c4
link_id

必須


場所: クエリ


API コンシューマーのデベロッパー トークンを特定のアプリにバインドするリンク識別子。

31FF8D67E5BB5DD5029DCC2734C2F884
app_event_type

必須


場所: クエリ


発生したアプリ イベントの名前。このフィールドは列挙型であり、次の値のみを受け入れます。

 • first_open
 • session_start
 • in_app_purchase
 • view_item_list
 • view_item
 • view_search_results
 • add_to_cart
 • ecommerce_purchase
 • custom

first_open イベントはインストールのアトリビューションのために常に送信され、session_start イベントはセッションのリアトリビューションのために常に送信されます。ネイティブ アプリストア経由で購入された場合は in_app_purchase を使用し、その他の購入の場合は ecommerce_purchase を使用します。

app_event_name

特定の条件で必須


場所: クエリ


app_event_type フィールドで受け入れられないカスタムアプリ イベントの名前。このフィールドには、1 ~ 64 文字の Unicode 文字(UTF-8 エンコードを使用)を含める必要があります。app_event_type がカスタムの場合、このフィールドは必須です。

level_achieved
Level Achieved

このフィールドには、app_event_type 用に予約されている値を含めてはなりません。予約済みのイベント名が使用された場合、API は APP_EVENT_NAME_RESERVED_VALUE エラーを返します。

app_event_data

省略可


場所: Body


追加のリッチ イベントデータは、文字列キーを値にマッピングする単純な JSON オブジェクトとして転送します。指定できる値は文字列と文字列の配列です。

{"level": 5, "attempts": 20}
odm_info

iOS で統合コンバージョン測定を利用する場合に必要


場所: クエリ


Google オンデバイス測定(ODM): イベントデータ SDK から iOS アプリのインストールまたは再インストール時に取得される info クエリ パラメータの値。このフィールドを使用すると、 iOS アプリ キャンペーンの統合コンバージョン測定が有効になります。

XYZr_AB8C-_zGtKjUhqtzPLeQ8lbJB5dADVR0tpZ9f-28sN5qN9GTZ_FztjL0OL
FzgxUJDhZr8w6lwGxAwPcxSwR5orjWepZiVP7sRRoCiaHerR-1TP17eJKtazgeSg
_CVEs13LllDTfrhVM8uWISqlg8dXobsLzmj8C7WrOlktHA5P_E23
id_type

必須


rdid フィールドで渡される識別子のタイプ。


Android

advertisingid
appsetid

iOS

idfa
idfv
rdid

必須


場所: クエリ


未加工のデバイス ID を表す有効な UUID 文字列。

f10e1de2-e237-4f50-b6aa-843c45cc63d6

ATT の同意していないユーザーのデバイス ID など、デバイス ID がない場合は、すべてゼロに設定します。

00000000-0000-0000-0000-000000000000
ctry_c

必須


場所: クエリ


コンバージョンが発生した国を示す 2 文字の ISO 国コード。

このフィールドは、iOS と Android で非ユーザー単位のアプリ コンバージョンの測定を有効にするために必要です。

US, IN
eea

特定の条件下で必須


場所: クエリ


EEA スコープ。

0: このユーザーとコンバージョンには欧州の規制が適用されません。

1: このユーザーとコンバージョンには欧州の規制が適用されます。 たとえば、ユーザーが EEA 内に居住している場合、該当する欧州の規制の対象となります。


*Required to be sent when the value is known.

ad_personalization

特定の条件下で必須


場所: クエリ


パーソナライズド広告のフラグ

0: エンドユーザーが広告のパーソナライズの同意を拒否した

1: エンドユーザーが広告のパーソナライズの同意を許可した


*Required to be sent when the value is known.

ad_user_data

特定の条件下で必須


場所: クエリ


広告目的でのユーザーデータの使用に関する同意フラグ

0: ユーザーが広告目的でユーザーレベルのデータを Google に送信することに同意していない

1: ユーザーが広告目的でユーザーレベルのデータを Google に送信することに同意している


*Required to be sent when the value is known.

lat

必須


場所: クエリ


デバイスの広告トラッキング制限のステータス。

  • 0: ユーザーが広告のトラッキング制限を設定していない。
  • 1: ユーザーが広告のトラッキング制限を設定している。

app_version

必須


場所: クエリ


アプリの現在のバージョン。次のように標準化する必要があります。


Android

packageManager.getPackageInfo(packageName(),
  PackageManager.GET_META_DATA).versionName

iOS

[[[NSBundle mainBundle] infoDictionary]
  objectForKey:@"CFBundleShortVersionString"]

1.2.4
os_version

必須


場所: クエリ


アプリのホスト OS の現在のバージョン。これは次のように標準化する必要があります。


Android

android.os.Build.VERSION.RELEASE

iOS

[[UIDevice currentDevice] systemVersion]
sdk_version

必須


場所: クエリ


イベントを測定した SDK のバージョン。これは主にデバッグに使用されるため、SDK リリースで公開されるリリース バージョンを正確に反映する必要があります。アプリが SDK を使用していない場合は、app_version と同じ値を渡してください。

1.9.5r6
timestamp

必須


場所: クエリ


コンバージョン イベントが発生した UNIX タイムスタンプ(秒単位、マイクロ秒の精度)。

1432681913.123456
fot

必須


場所: クエリ


後続のすべてのセッションとインストール後のイベントについて、対応する first_open の UNIX タイムスタンプ(秒単位、マイクロ秒の精度)。

1432681913.123456
value

省略可


場所: クエリ


イベントの金銭的価値(ある場合)。これは常に、小数点を使用して値の整数部分と小数部分を区切る、機械可読の浮動小数点値としてフォーマットする必要があります。

1.99
currency_code

特定の条件で必須


場所: クエリ


value パラメータの ISO 4217 通貨コード。value パラメータが指定されていて、 空白でない場合、このフィールドは 必須です。

USD
gclid

特定の条件で必須


場所: クエリ


アプリを開いたディープリンク URL の gclid クエリ パラメータの値。

Cj0KEQjw0dy4BRCuuL_e5M
market_referrer_gclid

特定の条件で必須


場所: クエリ


Play Install Referrer API を介して install_referrer 値から取得されたディープリンク URL の gclid クエリ パラメータの値。

BX3QojHp4mY5MrJtFM_d1u
gclid_only_request

特定の条件で必須


場所: クエリ


rdid(advertisingid)が not 利用可能であるか、すべての zeroes と gclid または market_referrer_gclid のいずれかが存在する場合の gclid ベースのアトリビューションの識別子。

1
gbraid

特定の条件で必須


場所: クエリ


アプリを開いたディープリンク URL を介して送信された最終閲覧日時の gbraid 値。この値は、アプリで発生する今後のコンバージョンとともに送信できるように、アプリでキャッシュに保存する必要があります。

ChEI8IixhgYQrufHkIjz3YWRARIzALev_G_O
app_open_source

特定の条件で必須


場所: クエリ


広告クリックのディープリンクまたはオーガニック アプリ セッションを識別する値。

ad_click or organic
User-Agent

必須


場所: ヘッダー


前のセクションで定義したアプリのユーザー エージェント。

AdMob/7.10.1 (Android 6.0; en_US; SM-G900F; Build/MMB29M)
X-Forwarded-For

必須


場所: ヘッダー


イベントが測定されたデバイスのパブリック IPv4 または IPv6 アドレス。

216.58.194.174

すべてのリクエストは HTTPS 経由で送信する必要があります。HTTP 経由で受信した ping は拒否されます。

リクエスト本文が空の場合(app_event_data ペイロードでリッチ イベントデータが渡されない場合)、サーバーではリクエストに Content-Length: 0 ヘッダーを明示的に設定する必要があります。

イベントデータのエンコード

app_event_data 本体のパラメータには、プリミティブ データ型に次の規則を使用してください。

  • Float

    • アプリのローカライズに関係なく、小数点記号としてドット文字を使用
    • 金額を表すには、小数点以下 2 桁の精度を使用します(例: 2.99)。
    • 指数表記(例: 2E+9)は使用しないでください。
    • 数字のグループを区切るためにカンマ文字を使用しないでください(例: 1,000,000)。
    • 有効な例:
      • -0.5
      • 2.99
      • 1000000.123
  • 整数

    • 小数点以下の桁のない整数値のみを送信する
    • 数字のグループを区切るためにカンマ文字を使用しないでください(例: 1,000,000)
    • 有効な例:
      • 1000
      • -11
      • 0
  • 日付

    • 日付の形式: yyyy-mm-dd
      • yyyy = 4 桁の年(例: 2016)
      • mm = 2 桁の月(9 月の場合は 09 など)
      • dd = 2 桁の日付(例: 23 は 23 日)
    • 常に上記の桁数を送信します。たとえば、月の 5 日目の dd の値を送信する場合は、05 を送信します。
    • 有効な例:
      • "2016-09-23"
      • "1990-12-31"
  • タイムスタンプ

    • 時間形式: Unix/エポック タイムスタンプ(秒単位、UTC タイムゾーンで定義、マイクロ秒の精度)
    • 有効な例:
      • 1478713087(2016 年 11 月 9 日水曜日 17 時 38 分 7 秒 GMT)
      • 1073513982.123000(2004 年 1 月 7 日水曜日 22:19:42.123 GMT)
  • 配列

    • プリミティブ値(文字列、数値、ブール値)の配列のみを送信する
    • 有効な例:
      • [123, 456, 789]
      • ["abc"]

サンプル リクエスト

統合コンバージョン測定用のオンデバイス測定: イベントデータ SDK を使用した初回起動リクエストの例は次のとおりです。

POST /pagead/conversion/app/1.1
       ?dev_token=Z_eErE4DkvcKjDM1OVE4c4
       &link_id=31FF8D67E5BB5DD5029DCC2734C2F884
       &app_event_type=first_open
       &odm_info=abcdEfadGdaf
       &rdid=0F7AB11F-DA50-498E-B225-21AC1977A85D
       &id_type=idfv
       &eea=0
       &ad_personalization=1
       &ad_user_data=1
       &lat=0
       &app_version=1.2.4
       &os_version=9.3.2
       &sdk_version=1.9.5r6
       &timestamp=1432681913.123456
Host: www.googleadservices.com
User-Agent: MyAnalyticsCompany/1.0.0 (iOS 10.0.2; en_US; iPhone9,1; Build/13D15; Proxy)
X-Forwarded-For: 216.58.194.174
Content-Type: application/json; charset=utf-8

オンデバイス測定: 統合コンバージョン測定用イベントデータ SDK を含まない初回起動リクエストの例は次のとおりです。

POST /pagead/conversion/app/1.1
       ?dev_token=Z_eErE4DkvcKjDM1OVE4c4
       &link_id=31FF8D67E5BB5DD5029DCC2734C2F884
       &app_event_type=first_open
       &rdid=0F7AB11F-DA50-498E-B225-21AC1977A85D
       &id_type=idfv
       &eea=0
       &ad_personalization=1
       &ad_user_data=1
       &lat=0
       &app_version=1.2.4
       &os_version=9.3.2
       &sdk_version=1.9.5r6
       &timestamp=1432681913.123456
Host: www.googleadservices.com
User-Agent: MyAnalyticsCompany/1.0.0 (iOS 10.0.2; en_US; iPhone9,1; Build/13D15; Proxy)
X-Forwarded-For: 216.58.194.174
Content-Type: application/json; charset=utf-8

統合コンバージョン測定用のオンデバイス測定: イベントデータ SDK を使用したインストール後のリクエストの例は次のとおりです。

POST /pagead/conversion/app/1.1
       ?dev_token=Z_eErE4DkvcKjDM1OVE4c4
       &link_id=31FF8D67E5BB5DD5029DCC2734C2F884
       &app_event_type=first_open
       &odm_info=abcdEfadGdaf
       &rdid=0F7AB11F-DA50-498E-B225-21AC1977A85D
       &id_type=idfv
       &eea=0
       &ad_personalization=1
       &ad_user_data=1
       &lat=0
       &app_version=1.2.4
       &os_version=9.3.2
       &sdk_version=1.9.5r6
       &timestamp=1432681913.123456
       &&fot=1432681913.123456
Host: www.googleadservices.com
User-Agent: MyAnalyticsCompany/1.0.0 (iOS 10.0.2; en_US; iPhone9,1; Build/13D15; Proxy)
X-Forwarded-For: 216.58.194.174
Content-Type: application/json; charset=utf-8

オンデバイス測定: イベントデータ SDK なしの初回起動リクエストの例は次のとおりです。

POST /pagead/conversion/app/1.1
       ?dev_token=Z_eErE4DkvcKjDM1OVE4c4
       &link_id=31FF8D67E5BB5DD5029DCC2734C2F884
       &app_event_type=first_open
       &rdid=0F7AB11F-DA50-498E-B225-21AC1977A85D
       &id_type=idfv
       &eea=0
       &ad_personalization=1
       &ad_user_data=1
       &lat=0
       &app_version=1.2.4
       &os_version=9.3.2
       &sdk_version=1.9.5r6
       &timestamp=1432681913.123456
Host: www.googleadservices.com
User-Agent: MyAnalyticsCompany/1.0.0 (iOS 10.0.2; en_US; iPhone9,1; Build/13D15; Proxy)
X-Forwarded-For: 216.58.194.174
Content-Type: application/json; charset=utf-8

ACAPI v1.1 の Android 非決定論的コンバージョンの初回起動リクエストの例は次のとおりです。

POST /pagead/conversion/app/1.1
       ?dev_token=Z_eErE4DkvcKjDM1OVE4c4
       &link_id=31FF8D67E5BB5DD5029DCC2734C2F884
       &app_event_type=first_open
       &rdid=0F7AB11F-DA50-498E-B225-21AC1977A85D
       &id_type=appsetid
       &eea=0
       &ad_personalization=1
       &ad_user_data=1
       &lat=0
       &app_version=1.2.4
       &os_version=9.3.2
       &sdk_version=1.9.5r6
       &timestamp=1432681913.123456
       &ctry_c=IN
Host: www.googleadservices.com
User-Agent: MyAnalyticsCompany/1.0.0 (android 11; en-GB; RMX2040; Build/_; Proxy)
X-Forwarded-For: 216.58.194.174
Content-Type: application/json; charset=utf-8

カスタム以外のイベントタイプと収益情報を含む有効なコンバージョン トラッキング リクエストの例は次のとおりです。

POST /pagead/conversion/app/1.1
       ?dev_token=Z_eErE4DkvcKjDM1OVE4c4
       &link_id=31FF8D67E5BB5DD5029DCC2734C2F884
       &app_event_type=in_app_purchase
       &rdid=0F7AB11F-DA50-498E-B225-21AC1977A85D
       &id_type=idfa
       &eea=0
       &ad_personalization=1
       &ad_user_data=1
       &lat=0
       &app_version=1.2.4
       &os_version=9.3.2
       &sdk_version=1.9.5r6
       &timestamp=1432681913.123456
       &value=1.99
       &currency_code=USD
       &market_referrer_gclid=BX3QojHp4mY5MrJtFM_d1u
       &gclid=Cj0KEQjw0dy4BRCuuL_e5M
       &gclid_only_request=0
       &gbraid=ChEI8IixhgYQrufHkIjz3YWRARIzALev_G_O
Host: www.googleadservices.com
User-Agent: MyAnalyticsCompany/1.0.0 (iOS 10.0.2; en_US; iPhone9,1; Build/13D15; Proxy)
X-Forwarded-For: 216.58.194.174
Content-Type: application/json; charset=utf-8
{"app_event_data":{"item_id":["Crayons","Markers"]}}

カスタム以外のイベントタイプと収益情報を含む有効なコンバージョン トラッキング リクエストの例(rdid(advertisingid)が利用できない場合)は次のとおりです。

POST /pagead/conversion/app/1.1
       ?dev_token=Z_eErE4DkvcKjDM1OVE4c4
       &link_id=31FF8D67E5BB5DD5029DCC2734C2F884
       &app_event_type=in_app_purchase
       &rdid=00000000-0000-0000-0000-000000000000
       &id_type=advertisingid
       &eea=0
       &ad_personalization=1
       &ad_user_data=1
       &lat=1
       &app_version=1.2.4
       &os_version=9.3.2
       &sdk_version=1.9.5r6
       &timestamp=1432681913.123456
       &value=1.99
       &currency_code=USD
       &market_referrer_gclid=BX3QojHp4mY5MrJtFM_d1u
       &gclid=Cj0KEQjw0dy4BRCuuL_e5M
       &gclid_only_request=1
       &gbraid=ChEI8IixhgYQrufHkIjz3YWRARIzALev_G_O
Host: www.googleadservices.com
User-Agent: MyAnalyticsCompany/1.0.0 (iOS 10.0.2; en_US; Android,1; Build/13D15; Proxy)
X-Forwarded-For: 216.58.194.174
Content-Type: application/json; charset=utf-8
{"app_event_data":{"item_id":["Crayons","Markers"]}}

有効なセッション開始リクエストの例を次に示します。

POST /pagead/conversion/app/1.1
       ?dev_token=Z_eErE4DkvcKjDM1OVE4c4
       &link_id=31FF8D67E5BB5DD5029DCC2734C2F884
       &app_event_type=session_start
       &rdid=0F7AB11F-DA50-498E-B225-21AC1977A85D
       &id_type=idfa
       &eea=0
       &ad_personalization=1
       &ad_user_data=1
       &lat=0
       &app_version=1.2.4
       &os_version=9.3.2
       &sdk_version=1.9.5r6
       &timestamp=1432681913.123456
       &gclid=Cj0KEQjw0dy4BRCuuL_e5M
       &gbraid=ChEI8IixhgYQrufHkIjz3YWRARIzALev_G_O
Host: www.googleadservices.com
User-Agent: MyAnalyticsCompany/1.0.0 (iOS 10.0.2; en_US; iPhone9,1; Build/13D15; Proxy)
X-Forwarded-For: 216.58.194.174
Content-Type: application/json; charset=utf-8

ディープリンク example://product/123?gclid=Cj0KEQjw0dy4BRCuuL_e5M から開始されたセッションの有効なセッション開始 リアトリビューション リクエストの例は次のとおりです。

POST /pagead/conversion/app/1.1
       ?dev_token=Z_eErE4DkvcKjDM1OVE4c4
       &link_id=31FF8D67E5BB5DD5029DCC2734C2F884
       &app_event_type=session_start
       &rdid=0F7AB11F-DA50-498E-B225-21AC1977A85D
       &id_type=idfa
       &eea=0
       &ad_personalization=1
       &ad_user_data=1
       &lat=0
       &app_version=1.2.4
       &os_version=9.3.2
       &sdk_version=1.9.5r6
       &timestamp=1432681913.123456
       &gclid=Cj0KEQjw0dy4BRCuuL_e5M
       &gbraid=ChEI8IixhgYQrufHkIjz3YWRARIzALev_G_O
Host: www.googleadservices.com
User-Agent: MyAnalyticsCompany/1.0.0 (iOS 10.0.2; en_US; iPhone9,1; Build/13D15; Proxy)
X-Forwarded-For: 216.58.194.174
Content-Type: application/json; charset=utf-8

広告ユーザーデータの同意が得られており、広告のパーソナライズが拒否されている EEA ユーザーの有効なコンバージョン トラッキング リクエストの例は次のとおりです。

POST /pagead/conversion/app/1.1
       ?dev_token=Z_eErE4DkvcKjDM1OVE4c4
       &link_id=31FF8D67E5BB5DD5029DCC2734C2F884
       &app_event_type=in_app_purchase
       &rdid=0F7AB11F-DA50-498E-B225-21AC1977A85D
       &id_type=idfa
       &eea=1
       &ad_personalization=0
       &ad_user_data=1
       &lat=0
       &app_version=1.2.4
       &os_version=9.3.2
       &sdk_version=1.9.5r6
       &timestamp=1432681913.123456
       &value=1.99
       &currency_code=USD
Host: www.googleadservices.com
User-Agent: MyAnalyticsCompany/1.0.0 (iOS 10.0.2; en_US; iPhone9,1; Build/13D15; Proxy)
X-Forwarded-For: 216.58.194.174
Content-Type: application/json; charset=utf-8

コンバージョン トラッキングの回答ガイド

コンバージョン トラッキングのレスポンスの形式は次のとおりです。

{
  "ad_events": [<ad event objects>],
  "errors": [<error strings>],
  "attributed": true|false
}

ad_events 配列と errors 配列の両方が空になることがあります。

エラーは、invalid_timestamp などの機械可読エラーコードになることが想定されます。

エラーコード

  • invalid_timestamp - リクエストに有効なタイムスタンプがありませんでした。

  • eea_missing_or_invalid - リクエストに「eea」フィールドが設定されていないか、無効です。

  • ad_user_data_missing - 「ad_user_data」リクエスト フィールドが設定されていませんでした。「ad_user_data」フィールドは、対象となるすべての DMA リクエストで必須です。

  • ad_user_data_invalid - 「ad_user_data」リクエスト値が無効でした。「ad_user_data」フィールドは、対象となるすべての DMA リクエストで必須です。

  • ad_personalization_missing_or_invalid - リクエストに「ad_personalization」フィールドが設定されていないか、無効です。「ad_personalization」フィールドは、対象となるすべての DMA リクエストで必須です。

広告イベントはアプリ アトリビューションのコア オブジェクトであり、次のプロパティが含まれます。

ユーザーの同意に基づくレスポンスの動作に関する重要な注意事項:
コンバージョンに広告ユーザーデータの同意があり、ユーザーが Google ユーザー設定でクロスユースの同意をしている場合、Google 広告はすべての CPS で単一のラストクリックで応答します。ユーザーが Google ユーザー設定でクロスユースの同意をしていない場合、Google 広告は CPS ごとに複数のラストクリックで応答します。

コンバージョンに、ユーザーが選択したクロスユースの同意に含まれる CPS と含まれない CPS がある場合、Google 広告は、クロスユースの同意が得られた CPS については単一のラストクリックで応答しますが、クロスユースの同意が得られなかった CPS については、CPS ごとに複数のラストクリックで応答します。

コンバージョン トラッキングのレスポンス
ad_event_id

常に存在


文字列


ad_event_id は、広告イベントの固有識別子として機能します。これはクロスネットワーク アトリビューション リクエストで再利用され、デバッグ目的でログに記録して保持する必要があります。

Q2owS0VRancwZHk0QlJDdXVMX2U1TQ
conversion_metric

常に存在


文字列


アトリビューションに使用されるコンバージョン指標。最初は 1 つのコンバージョン指標のみがサポートされます。

conversion
timestamp

常に存在


数値


広告イベントが発生した UNIX タイムスタンプ(マイクロ秒単位の精度)。この値はラストクリック アトリビューションに使用する必要があります。

1432681913.123456
campaign_type

常に存在


文字列


このフィールドは、広告イベントを生成したキャンペーンのタイプを識別します。使用できる値は次のとおりです。

ACI
ACE
ACPRE
Search
Display
Video
Shopping
Hotel
Performance_Max
Other

ACI は、アプリ インストール キャンペーンの略称です。ACE は、アプリ エンゲージメント キャンペーンの略称です。

campaign_id

常に存在


数値


広告イベントを生成したキャンペーンの数値 ID。この値は一意であることが保証されています。

123456789
campaign_name

常に存在


文字列


広告イベントを生成したキャンペーンの、広告主が定義したキャンペーン名。この値は一意であるとは限りません。

Occasional Gamers (Video)
ad_type

常に存在


文字列


広告イベントが発生した広告の種類。この値を使用して、さまざまなタイプのインベントリを次のように区別できます。

アプリのプロモーション
ClickToDownload
アプリ エンゲージメント
AppDeepLink
アプリのエンゲージメント - インストールして続行フロー
AppDeepLinkContinue
その他の値のキャッチオール
Unknown
external_customer_id

常に存在


数値


広告イベントを生成したキャンペーンを所有する広告主の広告主 ID。この値は、Google 広告アカウントを区別するために使用できます。

123456789
location

常に存在


数値


広告イベントの地理的位置の地域 ID コード。 Google Ads API リファレンスを参照して、地域コードを解釈します。

network_type

常に存在


文字列


このフィールドは、広告イベントが発生した Google 広告の広告掲載ネットワークを識別します。使用できる値は次のとおりです。

Search
Display
YouTube
GoogleTv
cross-network
network_subtype

campaign_type が ACI または ACE で、network_type が Display の場合、null になります。


文字列


このフィールドは、広告イベントが発生した Google 広告の広告掲載ネットワークの「サブタイプ」を識別します。可能な値は、プライマリ ネットワークの種類によって異なります。


通常の Google 検索
GoogleSearch
Google 検索パートナー
SearchPartners

ディスプレイ

モバイルウェブ パブリッシャー
mGDN
アプリ パブリッシャー
Google AdMob

YouTube

YouTube 動画ネットワーク
YouTubeVideos
YouTube 検索ネットワーク
YouTubeSearch
動画パートナー
VideoPartners

GoogleTv

GoogleTV Videos ネットワーク
GoogleTvVideos

クロスネットワーク

P-MAX のクロス ネットワーク
cross-network
video_id

network_type が YouTube で、campaign_type が ACI と ACE でない場合にのみ指定されます。


文字列


広告イベントに関連付けられた YouTube 動画 ID。

dQw4w9WgXcQ
keyword

network_type が Search で、campaign_type が ACI と ACE でない場合にのみ指定されます。


文字列


広告イベントに関連付けられた検索広告キーワード。

+food +delivery
match_type

network_type が Search で、campaign_type が ACI と ACE でない場合にのみ指定されます。


文字列


検索キーワードのマッチタイプ。

完全一致
e
フレーズ
p
広範囲
b
placement

network_type が Display で、 campaign_type が ACI と ACE でない場合にのみ指定されます。


文字列


広告イベントに関連付けられているプレースメント。

mobileapp::1-343200656
ad_group_id

campaign_type が Performance_Max ではない場合にのみ提供されます。


数値


広告イベントを生成した広告グループの数値 ID。この値は一意であることが保証されています。

このフィールドは、ディープリンク アトリビューションなど、決定論的にアトリビューションされる gbraid アトリビューション広告イベント(is_deterministic が true)には提供されません。

123456789
ad_group_name

campaign_type が ACI、ACE、または ACPRE の場合にのみ指定されます。


文字列


広告イベントを生成した広告グループの、広告主が定義した広告グループ名。この値は一意であるとは限りません。

このフィールドは、ディープリンク アトリビューションなど、決定論的にアトリビューションされる(is_deterministic が true である)gbraid アトリビューションありの広告イベントには提供されません。

My App AdGroup
asset_group_id

campaign_type が Performance_Max の場合にのみ提供されます。


数値


広告イベントを生成したアセット グループの数値 ID。この値は一意です。

123456789
creative_id

campaign_type が ACI、ACE、ACPRE、Performance_Max ではない場合にのみ提供されます。


数値


広告イベントを生成したクリエイティブ広告ユニットの数値 ID。この値は一意であることが保証されています。

123456789
interaction_type

このフィールドは常にエンゲージメントになります。


文字列

is_deterministic

アトリビューション方法が決定論的かどうかを示します。


ブール値


true, false
device_model

広告イベントを生成したデバイスのモデル。


文字列


sm-s936w, sm-3936w
os_version

広告イベントが発生した OS のメジャー バージョン。


文字列


14, 12
country

広告イベントが発生した国の 2 文字の国コード。


文字列


CA, US
city

広告イベントが発生した都市。


文字列


san jose, london
region

広告イベントが発生した都道府県。


文字列


california, british columbia

レスポンス例

確定的なコンバージョンのレスポンスの例を次に示します。

{
  "ad_events": [{
    "ad_event_id": "Q2owS0VRancwZHk0QlJDdXVMX2U1TQ",
    "conversion_metric": "conversion",
    "interaction_type": "engagement",
    "campaign_type": "ACI",
    "campaign_id": 123456789,
    "campaign_name": "My App Campaign",
    "network_type": null,
    "network_subtype": null,
    "ad_group_id": 123456789,
    "ad_group_name": "My App AdGroup",
    "asset_group_id": null,
    "is_deterministic": true,
    "timestamp": 1234567.898765
  }],
  "errors": [],
  "attributed": true
}

iOS の非確定的コンバージョンのレスポンスの例は次のとおりです。

{
  "ad_events": [{
    "ad_event_id": "Q2owS0VRancwZHk0QlJDdXVMX2U1TQ",
    "conversion_metric": "conversion",
    "interaction_type": "engagement",
    "campaign_type": "ACI",
    "campaign_id": 123456789,
    "campaign_name": "My App Campaign",
    "network_type": null,
    "network_subtype": null,
    "ad_group_id": 123456789,
    "ad_group_name": "My App AdGroup",
    "asset_group_id": null,
    "is_deterministic": false,
    },
    "device_info": {
        "device_model": "iphone12,3",
        "os_version": "14"
    },
    "timestamp": 1432681918.123456
    }],
  "errors": [],
  "attributed": true
}

Android の非確定的コンバージョンのレスポンスの例を次に示します。

{
  "ad_events": [
    {
      "ad_event_id": "Q2owS0VRancwZHk0QlJDdXVMX2U1TQ",
      "conversion_metric": "conversion",
      "interaction_type": "click",
      "campaign_type": "ACI",
      "campaign_id": 123456789,
      "campaign_name": "My App Campaign",
      "network_type": null,
      "network_subtype": null,
      "ad_group_id": 123456789,
      "ad_group_name": "My App AdGroup",
      "asset_group_id": null,
      "is_deterministic": false,
      "geo_info": {
        "city": "san jose",
        "country": "US",
        "region": "california"
      },
      "device_info": {
          "device_model": "sm-s926u",
          "os_version": "14"
      },
      "timestamp": 1432681918.123456
    },
    ],
    "errors": [],
    "warnings": []
  }

gbraid でアトリビューションされた iOS/Android コンバージョンのレスポンスの例は次のとおりです。

{
  "ad_events": [{
    "ad_event_id": "Q2owS0VRancwZHk0QlJDdXVMX2U1TQ",
    "conversion_metric": "conversion",
    "interaction_type": "engagement",
    "campaign_type": "ACI",
    "campaign_id": 123456789,
    "campaign_name": "My App Campaign",
    "ad_type": "ClickToDownload",
    "external_customer_id": 123456789,
    "interaction_type": "engagement",
    "network_type": null,
    "ad_group_id": null,
    "ad_group_name": null,
    "asset_group_id": null,
    "is_deterministic": true,
    "timestamp": 0.000000
  }],
  "errors": [],
  "attributed": true,
  "warnings": [],
}

リクエストにエラーが含まれている場合のコンバージョン トラッキング レスポンスの例は次のとおりです。

{
  "ad_events": [],
  "errors": ["INVALID_CURRENCY_CODE"],
  "attributed": false
}

負のコンバージョン トラッキング レスポンスの例を次に示します。

{
  "ad_events": [],
  "errors": [],
  "attributed": false
}

コンバージョン トラッキング リクエストに対して、コンバージョン トラッキング レスポンスが返されます。

ユニバーサル アプリ キャンペーンの EEA 以外のユーザーに対するコンバージョン トラッキングの肯定的なレスポンスの例は次のとおりです。

{
  "ad_events": [{
    "ad_event_id": "Q2owS0VRancwZHk0QlJDdXVMX2U1TQ",
    "conversion_metric": "conversion",
    "interaction_type": "engagement",
    "campaign_type": "ACI",
    "campaign_id": 123456789,
    "campaign_name": "My App Campaign",
    "ad_type": "ClickToDownload",
    "external_customer_id": 123456789,
    "location": 21144,
    "network_type": "Search",
    "network_subtype": "GoogleSearch",
    "video_id": null,
    "keyword": null,
    "match_type": null,
    "placement": null,
    "ad_group_id": 123456789,
    "ad_group_name": "My App AdGroup",
    "asset_group_id": null,
    "creative_id": null,
    "timestamp": 1432681913.123456
  }],
  "errors": [],
  "attributed": true,
  "warnings": []
}

検索キャンペーンの EEA 以外のユーザーに対するコンバージョン トラッキングの肯定的なレスポンスの例は次のとおりです。

{
  "ad_events": [{
    "ad_event_id": "Q2owS0VRancwZHk0QlJDdXVMX2U1TQ",
    "conversion_metric": "conversion",
    "interaction_type": "engagement",
    "campaign_type": "Search",
    "campaign_id": 123456789,
    "campaign_name": "My App Campaign",
    "ad_type": "ClickToDownload",
    "external_customer_id": 123456789,
    "location": 21144,
    "network_type": "Search",
    "network_subtype": "GoogleSearch",
    "video_id": null,
    "keyword": "+space +birds",
    "match_type": "b",
    "placement": null,
    "ad_group_id": 123456789,
    "ad_group_name": null,
    "asset_group_id": null,
    "creative_id": 123456789,
    "timestamp": 1432681913.123456
  }],
  "errors": [],
  "attributed": true,
  "warnings": []
}

ディスプレイ キャンペーンで EEA 以外のユーザーに対してコンバージョン トラッキングを有効にするレスポンスの例を次に示します。

{
  "ad_events": [{
    "ad_event_id": "Q2owS0VRancwZHk0QlJDdXVMX2U1TQ",
    "conversion_metric": "conversion",
    "interaction_type": "engagement",
    "campaign_type": "Display",
    "campaign_id": 123456789,
    "campaign_name": "My App Campaign",
    "ad_type": "ClickToDownload",
    "external_customer_id": 123456789,
    "location": 21144,
    "network_type": "Display",
    "network_subtype": "mGDN",
    "video_id": null,
    "keyword": null,
    "match_type": null,
    "placement": "mobile-app::2-343200656",
    "ad_group_id": 123456789,
    "ad_group_name": null,
    "asset_group_id": null,
    "creative_id": 123456789,
    "timestamp": 1432681913.123456
  }],
  "errors": [],
  "attributed": true,
  "warnings": []
}

YouTube キャンペーンで EEA 以外のユーザーに対してコンバージョン トラッキングを有効にするレスポンスの例は次のとおりです。

{
  "ad_events": [{
    "ad_event_id": "Q2owS0VRancwZHk0QlJDdXVMX2U1TQ",
    "conversion_metric": "conversion",
    "interaction_type": "engagement",
    "campaign_type": "Video",
    "campaign_id": 123456789,
    "campaign_name": "My App Campaign",
    "ad_type": "ClickToDownload",
    "external_customer_id": 123456789,
    "location": 21144,
    "network_type": "YouTube",
    "network_subtype": "YouTubeVideos",
    "video_id": "dQw4w9WgXcQ",
    "keyword": null,
    "match_type": null,
    "placement": null,
    "ad_group_id": 123456789,
    "ad_group_name": null,
    "asset_group_id": null,
    "creative_id": 123456789,
    "timestamp": 1432681913.123456
  }],
  "errors": [],
  "attributed": true,
  "warnings": []
}
{
  "ad_events": [{
    "ad_event_id": "Q2owS0VRancwZHk0QlJDdXVMX2U1TQ",
    "conversion_metric": "conversion",
    "interaction_type": "click",
    "campaign_type": "ACI",
    "campaign_id": 123456789,
    "campaign_name": "My App Campaign",
    "ad_type": "ClickToDownload",
    "external_customer_id": 123456789,
    "location": 21144,
    "network_type": "Display",
    "network_subtype": "",
    "video_id": null,
    "keyword": null,
    "match_type": null,
    "placement": null,
    "ad_group_id": 123456789,
    "ad_group_name": "My App AdGroup",
    "asset_group_id": null,
    "creative_id": null,
    "timestamp": 1432681913.123456
  },
  {
    "ad_event_id": "I8YUwWqxvOyqcwOcqBAkYZBMaOONSd",
    "conversion_metric": "conversion",
    "interaction_type": "click",
    "campaign_type": "ACI",
    "campaign_id": 123456789,
    "campaign_name": "My App Campaign",
    "ad_type": "ClickToDownload",
    "external_customer_id": 123456789,
    "location": 21144,
    "network_type": "Search",
    "network_subtype": "",
    "video_id": null,
    "keyword": null,
    "match_type": null,
    "placement": null,
    "ad_group_id": 123456789,
    "ad_group_name": "My App AdGroup",
    "asset_group_id": null,
    "creative_id": null,
    "timestamp": 1432681913.123456
  }
  ],
  "errors": [],
  "warnings": [],
  "attributed": true
}
{
  "ad_events": [{
    "ad_event_id": "Q2owS0VRancwZHk0QlJDdXVMX2U1TQ",
    "conversion_metric": "conversion",
    "interaction_type": "click",
    "campaign_type": "ACI",
    "campaign_id": 123456789,
    "campaign_name": "My App Campaign",
    "ad_type": "ClickToDownload",
    "external_customer_id": 123456789,
    "location": 21144,
    "network_type": "Display",
    "network_subtype": "",
    "video_id": null,
    "keyword": null,
    "match_type": null,
    "placement": null,
    "ad_group_id": 123456789,
    "ad_group_name": "My App AdGroup",
    "asset_group_id": null,
    "creative_id": null,
    "timestamp": 1432681913.123456
  }
  ],
  "errors": [],
  "warnings": [],
  "attributed": true
}
{
  "ad_events": [{
    "ad_event_id": "Q2owS0VRancwZHk0QlJDdXVMX2U1TQ",
    "conversion_metric": "conversion",
    "interaction_type": "click",
    "campaign_type": "ACI",
    "campaign_id": 123456789,
    "campaign_name": "My App Campaign",
    "ad_type": "ClickToDownload",
    "external_customer_id": 123456789,
    "location": 21144,
    "network_type": "Display",
    "network_subtype": "",
    "video_id": null,
    "keyword": null,
    "match_type": null,
    "placement": null,
    "ad_group_id": 123456789,
    "ad_group_name": "My App AdGroup",
    "asset_group_id": null,
    "creative_id": null,
    "timestamp": 1432681913.123456
  },
  {
    "ad_event_id": "I8YUwWqxvOyqcwOcqBAkYZBMaOONSd",
    "conversion_metric": "conversion",
    "interaction_type": "click",
    "campaign_type": "ACI",
    "campaign_id": 123456789,
    "campaign_name": "My App Campaign",
    "ad_type": "ClickToDownload",
    "external_customer_id": 123456789,
    "location": 21144,
    "network_type": "YouTube",
    "network_subtype": "YouTubeVideos",
    "video_id": null,
    "keyword": null,
    "match_type": null,
    "placement": null,
    "ad_group_id": 123456789,
    "ad_group_name": "My App AdGroup",
    "asset_group_id": null,
    "creative_id": null,
    "timestamp": 1432681913.123456
  }
  ],
  "errors": [],
  "warnings": [],
  "attributed": true
}


クロスネットワーク アトリビューション リクエスト

Google 広告がコンバージョン トラッキング リクエストに肯定的なレスポンスを返した場合、API コンシューマーはラストクリックを特定した後、クロス ネットワーク アトリビューションの決定を Google 広告に通知する必要があります。

クロス ネットワーク アトリビューション リクエストは、元のコンバージョン トラッキング リクエストと同じですが、リクエスト パスは次のようになります。

/pagead/conversion/app/1.1/cross_network

と、2 つの必須パラメータの追加:

クロスネットワーク アトリビューション リクエスト
ad_event_id

必須


場所: クエリ


前のリクエストのアトリビューションに関連付けられた広告イベントの ad_event_id ID。

attributed

必須


場所: クエリ


API コンシューマーによって Google 広告にコンバージョンに対する貢献度が割り当てられたかどうか。0 または 1 のいずれか。

有効なクロスネットワーク アトリビューション リクエストの例を次に示します。

POST /pagead/conversion/app/1.1/cross_network
       ?dev_token=Z_eErE4DkvcKjDM1OVE4c4
       &link_id=31FF8D67E5BB5DD5029DCC2734C2F884
       &app_event_type=custom
       &app_event_name=level_achieved
       &rdid=0F7AB11F-DA50-498E-B225-21AC1977A85D
       &id_type=idfa
       &lat=0
       &app_version=1.2.4
       &os_version=9.3.2
       &sdk_version=1.9.5r6
       &timestamp=1432681913.123456
       &value=1.99
       &currency_code=USD
       &ad_event_id=Q2owS0VRancwZHk0QlJDdXVMX2U1TQ
       &attributed=1
Host: www.googleadservices.com
User-Agent: MyAnalyticsCompany/1.0.0 (iOS 10.0.2; en_US; iPhone9,1; Build/13D15; Proxy)
X-Forwarded-For: 216.58.194.174
Content-Type: application/json; charset=utf-8

有効なクロス ネットワーク アトリビューション リクエストに対しては、レスポンス本文のない汎用的な 200 レスポンスが常に返されます。