モバイルコンバージョン

MACT の概要

X のモバイルアプリプロモーションにおける計測は、インストールやその他のアプリ内コンバージョンの促進を目的とした、X 上の広告キャンペーンの成果を広告主が把握・追跡できるようにします。X のモバイル計測パートナーは、広告主が X 上でプロモーションしているアプリについて、どのコンバージョンを追跡するかを管理できるようにします。広告主が追跡したいイベントの type と計測期間（時間ウィンドウ）を設定すると、モバイル計測パートナーはそれらのイベントをすべて X に送信し、コンバージョンに至るまでにユーザーが関与したキャンペーンおよびクリエイティブを示すアトリビューションの data を即時に受信します。

コンバージョンイベント

conversion event を X に報告してアトリビューションデータを取得するには、パートナーはモバイルアプリのID、コンバージョンのtype、タイムスタンプに加えて、広告/デバイスIDのハッシュ化値を送信する必要があります。これらのdataを提供することで、X のプラットフォーム上でコンバージョンイベントが記録され、該当する場合にはアトリビューションが返されます。さらに、広告主は購入金額、商品のID、登録方法など、コンバージョンイベントに関する追加のmetadataを任意で提供できます。

API リファレンス

コンバージョンイベント

POST conversion_event

モバイル計測のコンバージョンイベントを記録します。レスポンスには、X または X Audience Platform（TAP）のアトリビューションが示されます。これは GET conversion_attribution endpoint に関連します。レスポンスでは、X、TAP、またはアトリビューションなしのいずれかが示されます。X のアトリビューションがない場合でも、twitter_attribution ノードは常に存在し、その値は null になります（以下のレスポンス例を参照）。TAP のアトリビューションがある場合は、tpn_attribution ノードが存在し、適切に値が設定されます。詳細は TAP overview を参照してください。各コンバージョンイベントに関連付ける metadata を設定できる任意パラメータがいくつか用意されています。これらの metadata はアトリビューションの算出には影響しません。

リソースURL

https://ads-api.x.com/12/conversion_event

パラメータ

Name	Description
app_id required	対応するアプリストアでの一意の識別子。 Type: int, string Example: `333903271`, `com.vine.android`
conversion_time required	ミリ秒付きの ISO 8601 形式タイムスタンプで表すコンバージョンイベントの時刻。 Type: string Example: `2014-05-22T02:38:28.103Z`
conversion_type required	コンバージョンイベントの種別。 Type: enum Possible values: `PURCHASE`, `SIGN_UP`, `INSTALL`, `RE_ENGAGE`, `UPDATE`, `TUTORIAL_COMPLETE`, `RESERVATION`, `ADD_TO_CART`, `ADD_TO_WISHLIST`, `LOGIN`, `CHECKOUT_INITIATED`, `SEARCH`, `LEVEL_ACHIEVED`, `ACHIEVEMENT_UNLOCKED`, `CONTENT_VIEW`, `SHARE`, `INVITE`, `ADDED_PAYMENT_INFO`, `SPENT_CREDITS`, `RATED`
hashed_device_id required	HMAC_SHA-256 でハッシュ化された IDFA または AdID。 Type: string Example: `ABCD1234XYZ`
os_type required	App の OS 種別。 Type: enum Possible values: `IOS`, `ANDROID`
click_window optional	このイベントのクリック計測期間（日単位）。 Type: int Note: `click_window` は view_through_window 以上である必要があります。 Default: `14` Possible values: `1`, `7`, `14`, `30`
device_ip_address optional	コンバージョンイベント発生時のデバイスの IPv4 または IPv6 アドレス。 Type: string Example: `192.133.78.1`
level optional	このイベントに関連付けられたレベル。 Type: int Example: `2`
non_twitter_engagement_time optional	コンバージョン前の直近の X 外エンゲージメントの時刻。 Type: string Example: `2014-05-22T02:38:28.103Z`
non_twitter_engagement_type optional	コンバージョンイベント前の X 外エンゲージメントの種別。 Type: enum Possible values: `CLICK`, `VIEW`
number_items optional	このイベントに関連するアイテム数。 Type: int Example: `2`
price_currency optional	このイベントに関連する通貨を示す ISO 4217 コードを想定。 Type: String Examples: `EUR`,`USD`,`JPY`
price_micro optional	このイベントに関連する価格（金額、マイクロ単位）。 Type: int Example: `123450000`
user_payment_info optional	このイベントに関連する App にユーザーの支払い情報が保存されているかを示すブール値。 Type: bool Possible values: `true` or `false`
view_through_window optional	このイベントのビュースルー計測期間（日単位）。 Note: `click_window` は view_through_window 以上である必要があります。 Type: int Default: `1` Possible values: `0`, `1`, `7`, `14`, `30`

リクエスト例

https://ads-api.x.com/12/conversion_event?app_id=333903271&os_type=IOS&hashed_device_id=ABCD1234XYZ&conversion_type=INSTALL&conversion_time=2013-04-16T07:00:00.123Z&click_window=14&view_through_window=1

レスポンス例

    {
      "data": {
        "conversion_value_micro": 0,
        "view_through_window": 1,
        "tpn_attribution": null,
        "conversion_time": "2017-01-21T01:14:00.602Z",
        "click_window": 30,
        "limit_ad_tracking": false,
        "event_metadata": null,
        "non_twitter_engagement_type": null,
        "conversion_type": "INSTALL",
        "partner_client_id": "com.appname contact id",
        "app_id": "com.appname",
        "hashed_device_id": "lke1GZa3AseB343ZcCQq7svfHzLfuSqyYnE+Rf49MOI=",
        "twitter_attribution": {
          "country_code": "US",
          "engagement_time": "2017-01-21T01:13:00.602Z",
          "engagement_type": "CLICK",
          "attribution_type": "PROMOTED",
          "promoted_properties": {
            "campaign_id": "4ns44",
            "line_item_id": "3x44d",
            "publisher_app_id": "333903271"
            "account_id":"18ce11e3egb",
            "line_item_objective": "APP_INSTALLS",
            "campaign_name": null
          },
          "tweet_id": "11434635565377600"
        },
        "os_type": "ANDROID",
        "non_twitter_engagement_time": null
      },
      "request": {
        "params": {
          "version_number": "1",
          "app_id": "com.appname",
          "conversion_type": "INSTALL",
          "os_type": "ANDROID",
          "hashed_device_id": "lke1GZa3AseB343ZcCQq7svfHzLfuSqyYnE+Rf49MOI=",
          "conversion_time": "2017-01-21T01:14:00.602Z",
          "click_window": "30",
          "view_through_window": "1",
          "limit_ad_tracking": "false"
        }
      }
    }

App イベントタグ

GET accounts/:account_id/app_event_tags

現在のアカウントに関連付けられているアプリイベントタグの一部またはすべての詳細を取得します。これらは、Mobile App Conversion Tracking における各コンバージョンタイプに対して設定されたコンバージョンウィンドウを定義します。

リソースURL

https://ads-api.x.com/12/accounts/:account_id/app_event_tags

パラメータ

名前	説明
account_id 必須	レバレッジドアカウントの識別子。リソースのパスに含まれ、GET accounts を除くすべての Advertiser API リクエストで一般的に必須のパラメータです。指定したアカウントは認証済みユーザーに関連付けられている必要があります。 Type: string Example: `18ce54d4x5t`
app_event_tag_ids 任意	目的の App Event Tag のみを対象にするため、識別子をカンマ区切りで指定します。最大 200 個の ID を指定できます。 Type: string Example: `jhp`
count 任意	各リクエストで取得を試みるレコード数を指定します。 Type: int Default: `200` Min, Max: `1`, `1000`
cursor 任意	次ページの結果を取得するためのカーソルを指定します。詳細は Pagination を参照してください。 Type: string Example: `8x7v00oow`
sort_by 任意	サポートされている属性で昇順または降順に並べ替えます。詳細は Sorting を参照してください。 Type: string Example: `created_at-asc`
with_deleted 任意	削除済みの結果を含めます。 Type: boolean Default: `false` Possible values: `true`, `false`
with_total_count 任意	レスポンスに `total_count` 属性を含めます。注: このパラメータと `cursor` は同時指定できません。注: `total_count` を含むリクエストはレートリミットが低く、現在は 15 分あたり 200 に設定されています。 Type: boolean Default: `false` Possible values: `true`, `false`

リクエスト例

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/app_event_tags?app_event_tag_ids=jhp

応答例

    {
      "request": {
        "params": {
          "app_event_tag_ids": [
            "jhp"
          ],
          "account_id": "18ce54d4x5t"
        }
      },
      "next_cursor": null,
      "data": [
        {
          "provider_app_event_name": null,
          "app_store_identifier": "co.vine.android",
          "post_view_attribution_window": 1,
          "deep_link_scheme": "vine://",
          "id": "jhp",
          "retargeting_enabled": true,
          "conversion_type": "INSTALL",
          "created_at": "2016-12-08T07:49:58Z",
          "post_engagement_attribution_window": 14,
          "provider_app_event_id": null,
          "last_tracked_at": "2021-05-22T17:00:04Z",
          "status": "TRACKING",
          "updated_at": "2016-12-08T23:07:54Z",
          "os_type": "ANDROID",
          "deleted": false
        }
      ]
    }

GET accounts/:account_id/app_event_tags/:app_event_tag_id

現在のアカウントに紐づく特定のアプリイベントタグを取得します。これは、Mobile App Conversion Tracking において、各コンバージョンタイプごとに設定されたコンバージョンウィンドウを規定する要素です。

リソース URL

https://ads-api.x.com/12/accounts/:account_id/app_event_tags/:app_event_tag_id

パラメータ

Name	Description
account_id 必須	レバレッジドアカウントの識別子。リソースのパスに含まれ、GET accounts を除くすべての Advertiser API リクエストで一般的に必須のパラメータです。指定したアカウントは認証済みユーザーに関連付けられている必要があります。 Type: string Example: `18ce54d4x5t`
app_event_tag_id 必須	リクエストで操作する app event tag への参照。 Type: string Example: `jhp`
with_deleted 任意	削除済みの結果を含めます。 Type: boolean Default: `false` Possible values: `true`, `false`

リクエスト例

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/app_event_tags/jhp

応答例

    {
      "request": {
        "params": {
          "app_event_tag_id": "jhp",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "provider_app_event_name": null,
        "app_store_identifier": "co.vine.android",
        "post_view_attribution_window": 1,
        "deep_link_scheme": "vine://",
        "id": "jhp",
        "retargeting_enabled": true,
        "conversion_type": "INSTALL",
        "created_at": "2016-12-08T07:49:58Z",
        "post_engagement_attribution_window": 14,
        "provider_app_event_id": null,
        "last_tracked_at": "2021-05-22T17:00:04Z",
        "status": "TRACKING",
        "updated_at": "2016-12-08T23:07:54Z",
        "os_type": "ANDROID",
        "deleted": false
      }
    }

POST accounts/:account_id/app_event_tags

現在のアカウントに関連付けられる新しい App イベントタグを作成します。

リソース URL

https://ads-api.x.com/12/accounts/:account_id/app_event_tags

パラメーター

Name	Description
account_id 必須	利用するアカウントの識別子。リソースのパス内に含まれ、GET accounts を除くすべての Advertiser API リクエストで一般的に必須です。指定したアカウントは認証済みユーザーに関連付けられている必要があります。 Type: string Example: `18ce54d4x5t`
app_store_identifier 必須	アプリストアの識別子。 Type: string Example: `com.twitter.android`
conversion_type 必須	コンバージョンイベントの種類。 Type: enum Possible values: `ACHIEVEMENT_UNLOCKED`, `ADDED_PAYMENT_INFO`, `ADD_TO_CART`, `ADD_TO_WISHLIST`, `CHECKOUT_INITIATED`, `CONTENT_VIEW`, `INSTALL`, `INVITE`, `LEVEL_ACHIEVED`, `LOGIN`, `PURCHASE`, `RATED`, `RESERVATION`, `RE_ENGAGE`, `SEARCH`, `SHARE`, `SIGN_UP`, `SPENT_CREDITS`, `TUTORIAL_COMPLETE`, `UPDATE`
os_type 必須	App の OS 種別。 Type: enum Possible values: `IOS`, `ANDROID`
provider_app_event_id 必須	プロバイダーサイト上のコンバージョンタグの ID。 Type: string Example: `provider_tag_j5394`
provider_app_event_name 必須	プロバイダーサイト上のコンバージョンタグの名称。 Type: string Example: `provider_name_a4382`
deep_link_scheme 任意	このタグに関連付けられた App のディープリンク URI を指定します。 Type: string Example: `twitter://`
post_engagement_attribution_window 任意	これらのイベントのポストエンゲージメント・アトリビューションウィンドウ。 Type: int Default: 30 Possible values: `1`, `7`, `14`, `30`
post_view_attribution_window 任意	これらのイベントのポストビュー・アトリビューションウィンドウ。 Type: int Default: 1 Possible values: `0`, `1`, `7`, `14`, `30`
retargeting_enabled 任意	この App イベントタグでリターゲティングを有効にするかどうかを指定します。 Type: boolean Default: true Possible values: `true`, `false`

リクエスト例

POST https://ads-api.x.com/12/accounts/18ce54d4x5t/app_event_tags?app_store_identifier=com.twitter.android&os_type=ANDROID&conversion_type=PURCHASE&provider_app_event_id=abc123&provider_app_event_name=test-tag

応答例

    {
      "data": {
        "provider_app_event_name": "test-tag",
        "app_store_identifier": "com.twitter.android",
        "post_view_attribution_window": 1,
        "deep_link_scheme": "https://",
        "id": "3p3t",
        "retargeting_enabled": true,
        "conversion_type": "PURCHASE",
        "created_at": "2017-09-06T06:58:22Z",
        "post_engagement_attribution_window": 30,
        "provider_app_event_id": "abc123",
        "updated_at": "2017-09-06T06:58:22Z",
        "os_type": "ANDROID",
        "deleted": false
      },
      "request": {
        "params": {
          "provider_app_event_name": "test-tag",
          "app_store_identifier": "com.twitter.android",
          "account_id": "18ce54d4x5t",
          "conversion_type": "PURCHASE",
          "provider_app_event_id": "abc123",
          "os_type": "ANDROID"
        }
      }
    }

DELETE accounts/:account_id/app_event_tags/:id

現在のアカウントに属する指定の app event tag を削除します。

リソース URL

https://ads-api.x.com/12/accounts/:account_id/app_event_tags/:id

パラメーター

名前	説明
account_id 必須	レバレッジドアカウントの識別子。リソースのパスに含まれ、GET accounts を除くすべての Advertiser API リクエストで一般的に必須のパラメーターです。指定したアカウントは、認証済みのユーザーに関連付けられている必要があります。 Type: string Example: `18ce54d4x5t`
id 必須	リクエストで操作する App イベントタグへの参照。 Type: string Example: `jhp`

リクエストの例

DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/app_event_tags/jhp

応答例

    {
      "data": {
        "provider_app_event_name": null,
        "app_store_identifier": "co.vine.android",
        "post_view_attribution_window": 1,
        "deep_link_scheme": "vine://",
        "id": "jhp",
        "retargeting_enabled": true,
        "conversion_type": "INSTALL",
        "created_at": "2016-12-08T07:49:58Z",
        "post_engagement_attribution_window": 14,
        "provider_app_event_id": null,
        "last_tracked_at": "2021-05-22T17:00:04Z",
        "status": "TRACKING",
        "updated_at": "2017-08-30T05:44:57Z",
        "os_type": "ANDROID",
        "deleted": true
      },
      "request": {
        "params": {
          "id": "jhp",
          "account_id": "5gvk9h"
        }
      }
    }

App Lists

GET accounts/:account_id/app_lists

現在のアカウントに関連付けられている一部またはすべての app list の詳細を取得します。

リソースURL

https://ads-api.x.com/12/accounts/:account_id/app_lists

パラメータ

Name	Description
account_id 必須	対象となるアカウントの識別子。リソースのパス内に含まれ、GET accounts を除くすべての Advertiser API リクエストで一般的に必須のパラメータです。指定したアカウントは、認証済みユーザーに関連付けられている必要があります。 Type: string Example: `18ce54d4x5t`
app_list_ids 任意	識別子のカンマ区切りリストを指定して、目的の App List のみをレスポンス対象に絞り込みます。最大 200 個の ID を指定できます。 Type: string Example: `wm7x`
count 任意	各リクエストで取得を試みるレコード数を指定します。 Type: int Default: `200` Min, Max: `1`, `1000`
cursor 任意	次ページの結果を取得するためのカーソルを指定します。詳細は Pagination を参照してください。 Type: string Example: `8x7v00oow`
sort_by 任意	サポートされている属性で昇順または降順に並べ替えます。詳細は Sorting を参照してください。 Type: string Example: `created_at-asc`
with_deleted 任意	削除済みの結果を含めます。 Type: boolean Default: `false` Possible values: `true`, `false`
with_total_count 任意	レスポンスに `total_count` 属性を含めます。注: このパラメータと `cursor` は同時指定できません。注: `total_count` を含むリクエストには、より低いレートリミットが適用され、現在は 15 分あたり 200 に設定されています。 Type: boolean Default: `false` Possible values: `true`, `false`

リクエスト例

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/app_lists?app_list_ids=wm7x

応答例

    {
      "request": {
        "params": {
          "app_list_ids": [
            "wm7x"
          ],
          "account_id": "18ce54d4x5t"
        }
      },
      "next_cursor": null,
      "data": [
        {
          "id": "wm7x",
          "name": "foo @ 14026528192426843"
        }
      ]
    }

GET accounts/:account_id/app_lists/:app_list_id

現在のアカウントに関連付けられている特定のアプリリストを取得します。

リソースURL

https://ads-api.x.com/12/accounts/:account_id/app_lists/:app_list_id

パラメーター

Name	Description
account_id 必須	対象アカウントの識別子。リソースのパスに含まれ、GET accounts を除くすべての Advertiser API リクエストで一般的に必須となるパラメーターです。指定したアカウントは、認証済みユーザーに関連付けられている必要があります。 Type: string Example: `18ce54d4x5t`
app_list_id 必須	リクエストで操作する App リストへの参照。 Type: string Example: `28ukf`
with_deleted 任意	削除済みの結果を含めます。 Type: boolean Default: `false` Possible values: `true`, `false`

リクエスト例

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/app_lists/28ukf

応答例

    {
      "data": {
        "name": "twitter @ 262689209670784",
        "id": "28ukf",
        "created_at": "2017-08-17T17:07:42Z",
        "updated_at": "2017-08-17T17:07:42Z",
        "deleted": false,
        "apps": [
          {
            "app_store_identifier": "com.twitter.android",
            "os_type": "Android"
          }
        ]
      },
      "request": {
        "params": {
          "app_list_id": "28ukf",
          "account_id": "18ce54d4x5t"
        }
      }
    }

POST accounts/:account_id/app_lists

現在のアカウントに関連付けられた app_list を作成します。現在、account_id ごとに app_list オブジェクトは最大 100 個、app_list ごとに App は最大 500 個までという制限があります。

リソースURL

https://ads-api.x.com/12/accounts/:account_id/app_lists

パラメーター

Name	Description
account_id 必須	利用するアカウントの識別子。リソースのパス内に含まれ、GET accounts を除くすべての Advertiser API リクエストで通常必須のパラメーターです。指定したアカウントは、認証済みユーザーに紐づいている必要があります。 Type: string Example: `18ce54d4x5t`
app_store_identifiers 必須	`app_list` に含めるアプリストアの識別子 Type: string Example: `com.twitter.android`
name 必須	`app_list` に付与する名前 Type: string Example: `My First App List`

リクエスト例

POST https://ads-api.x.com/12/accounts/18ce54d4x5t/app_lists?name=app list&app_store_identifiers=com.twitter.android

例: レスポンス

    {
      "data": {
        "name": "アプリ一覧",
        "id": "2a4um",
        "created_at": "2017-09-06T07:17:26Z",
        "updated_at": "2017-09-06T07:17:26Z",
        "deleted": false,
        "apps": [
          {
            "app_store_identifier": "com.twitter.android",
            "os_type": "Android",
          }
        ]
      },
      "request": {
        "params": {
          "app_store_identifiers": [
            "com.twitter.android"
          ],
          "name": "アプリ一覧",
          "account_id": "18ce54d4x5t"
        }
      }
    }

DELETE accounts/:account_id/app_lists/:app_list_id

現在のアカウントに関連付けられた指定のアプリリストを削除します。

リソース URL

https://ads-api.x.com/12/accounts/:account_id/app_lists/:app_list_id

パラメーター

Name	Description
account_id 必須	対象アカウントの識別子。リソースのパス内に含まれ、GET accounts を除くすべての Advertiser API リクエストで原則必須のパラメーターです。指定したアカウントは、認証済みユーザーに関連付けられている必要があります。 Type: string Example: `18ce54d4x5t`
app_list_id 必須	リクエストで操作する App List を参照します。 Type: string Example: `28ukf`

リクエスト例

DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/app_lists/28ukf

応答例

    {
      "data": {
        "name": "twitter @ 262689209670784",
        "id": "28ukf",
        "created_at": "2017-08-17T17:07:42Z",
        "updated_at": "2017-09-12T22:20:33Z",
        "deleted": true,
        "apps": [
          {
            "app_store_identifier": "com.twitter.android",
            "os_type": "Android"
          }
        ]
      },
      "request": {
        "params": {
          "app_list_id": "28ukf",
          "account_id": "18ce54d4x5t"
        }
      }
    }

App Event Provider の構成

❯

GET accounts/:account_id/app_event_provider_configurations¶

現在のアカウントに関連付けられている、App Event Provider の設定（Mobile Application Conversion Tracking の中核となる設定）の一部またはすべての詳細を取得します。

リソースURL

https://ads-api.x.com/11/accounts/:account_id/app_event_provider_configurations

パラメーター

Name	Description
account_id 必須	レバレッジドアカウントの識別子。リソースのパス内に含まれ、GET accounts を除くすべての Advertiser API リクエストで一般的に必須のパラメーターです。指定したアカウントは認証済みユーザーに紐づいている必要があります。 Type: string Example: `18ce54d4x5t`
count 任意	個々のリクエストごとに取得を試みるレコード数を指定します。 Type: int Default: `200` Min, Max: `1`, `1000`
cursor 任意	次ページの結果を取得するためのカーソルを指定します。詳細は Pagination を参照してください。 Type: string Example: `8x7v00oow`
ids 任意	目的の設定に限定するために、カンマ区切りの識別子リストを指定します。最大 200 個の ID を指定できます。 Type: string Example: `25n`
sort_by 任意	サポートされている属性で昇順または降順に並べ替えます。詳細は Sorting を参照してください。 Type: string Example: `created_at-asc`
with_deleted 任意	削除済みの結果をレスポンスに含めます。 Type: boolean Default: `false` Possible values: `true`, `false`
with_total_count 任意	レスポンスに `total_count` 属性を含めます。注: このパラメーターと `cursor` は同時指定できません。注: `total_count` を含むリクエストはレートリミットが低く、現在は 15 分あたり 200 に設定されています。 Type: boolean Default: `false` Possible values: `true`, `false`

リクエスト例

GET https://ads-api.x.com/11/accounts/18ce54d4x5t/app_event_provider_configurations?ids=25n

応答例

    {
      "data": [
        {
          "provider_name": "Answers powered by Fabric",
          "id": "25n",
          "provider_advertiser_id": "54ac2766f0de9e1f7a00001a",
          "created_at": "2016-12-08T07:49:58Z",
          "provider_advertiser_identifier": "54ac2766f0de9e1f7a00001a",
          "updated_at": "2017-05-12T21:37:15Z",
          "deleted": false
        }
      ],
      "next_cursor": null,
      "request": {
        "params": {
          "ids": [
            "25n"
          ],
          "account_id": "18ce54d4x5t"
        }
      }
    }

GET accounts/:account_id/app_event_provider_configurations/:id

現在のアカウントに関連付けられているイベントプロバイダー設定（Mobile Application Conversion Tracking の中核設定）の特定の設定の id を取得します。

リソース URL

https://ads-api.x.com/11/accounts/:account_id/app_event_provider_configurations/:id

パラメータ

Name	Description
account_id 必須	レバレッジドアカウントの識別子。リソースのパス内に含まれ、GET accounts を除くすべての Advertiser API リクエストで通常必須のパラメータです。指定したアカウントは、認証済みユーザーに関連付けられている必要があります。 Type: string Example: `18ce54d4x5t`
id 必須	リクエストで操作対象としている app event provider 構成への参照。 Type: string Example: `25n`
with_deleted 任意	削除済みの結果をレスポンスに含めます。 Type: boolean Default: `false` Possible values: `true`, `false`

リクエスト例

GET https://ads-api.x.com/11/accounts/18ce54d4x5t/app_event_provider_configurations/25n

レスポンスの例

    {
      "data_type": "app_event_provider_configuration",
      "data": {
        "provider_name": "API McTestface",
        "id": "25n",
        "provider_advertiser_id": "123",
        "created_at": "2017-03-24T22:24:56Z",
        "provider_advertiser_identifier": "123",
        "updated_at": "2017-03-24T22:24:56Z",
        "deleted": false
      },
      "request": {
        "params": {
          "id": "25n",
          "account_id": "18ce54d4x5t"
        }
      }
    }

POST accounts/:account_id/app_event_provider_configurations

現在のアカウントに関連付けられた新しい app event provider 構成を作成します。特定の広告アカウントには、MACT プロバイダーを 1 つだけ関連付けることができます。

リソース URL

https://ads-api.x.com/11/accounts/:account_id/app_event_provider_configurations

パラメーター

名前	説明
account_id 必須	レバレッジドアカウントの識別子。リソースのパスに含まれ、GET accounts を除くすべての Advertiser API リクエストで通常必須のパラメーターです。指定したアカウントは、認証済みユーザーに関連付けられている必要があります。 Type: string Example: `18ce54d4x5t`
provider_advertiser_id 必須	プロバイダーのサイトでの広告主の識別子。 Type: string Example: `client1`

リクエスト例

POST https://ads-api.x.com/11/accounts/18ce54d4x5t/app_event_provider_configurations?provider_advertiser_id=client1

応答例

    {
      "data": {
        "provider_name": "InternalTestProvider",
        "id": "e5g",
        "provider_advertiser_id": "client1",
        "created_at": "2017-08-30T05:40:07Z",
        "provider_advertiser_identifier": "client1",
        "updated_at": "2017-09-06T06:39:03Z",
        "deleted": false
      },
      "request": {
        "params": {
          "provider_advertiser_id": "client1",
          "account_id": "18ce54d4x5t"
        }
      }
    }

DELETE accounts/:account_id/app_event_provider_configurations/:id[¶]

現在のアカウントに属する指定の App イベントプロバイダー設定を削除します。

リソース URL

https://ads-api.x.com/11/accounts/:account_id/app_event_provider_configurations/:id

パラメータ

名前	説明
account_id 必須	対象となるアカウントの識別子。リソースのパスに含まれ、GET accounts を除くすべての Advertiser API リクエストで一般的に必須のパラメータです。指定したアカウントは認証済みユーザーに関連付けられている必要があります。 Type: string Example: `18ce54d4x5t`
id 必須	リクエストで操作対象となる app event provider の構成を参照する識別子。 Type: string Example: `e5g`

リクエスト例

DELETE https://ads-api.x.com/11/accounts/18ce54d4x5t/app_event_provider_configurations/e5g

応答例

    {
      "data": {
        "provider_name": "InternalTestProvider",
        "id": "e5g",
        "provider_advertiser_id": "client1",
        "created_at": "2017-08-30T05:40:07Z",
        "provider_advertiser_identifier": "client1",
        "updated_at": "2017-08-30T05:40:26Z",
        "deleted": true
      },
      "request": {
        "params": {
          "id": "e5g",
          "account_id": "18ce54d4x5t"
        }
      }
    }

コンバージョンアトリビューション

GET conversion_attribution

コンバージョンイベントを作成せずに、コンバージョンアトリビューションを確認するための X へのクエリです。レスポンスには X によるアトリビューション結果が示されます。これは POST conversion_event endpoint に関連します。レスポンスでは、X、TAP、または「アトリビューションなし」のいずれかが返されます。twitter_attribution ノードは常に存在し、X によるアトリビューションがない場合は値が null、ある場合は下記の例のレスポンスのとおり値が設定されます。TAP によるアトリビューションがある場合は、tpn_attribution ノードが存在し、適切に設定されます。詳細は TAP overview を参照してください。

リソースURL

https://ads-api.x.com/12/conversion_attribution

パラメーター

Name	Description
app_id required	対応するアプリストアにおける一意の識別子。 Type: int, string Example: `333903271`, `com.vine.android`
conversion_time required	ミリ秒付きの ISO-8601 タイムスタンプ形式で表したコンバージョンイベントの発生時刻。 Type: string Example: `2014-05-22T02:38:28.103Z`
conversion_type required	コンバージョンイベントの種類。 Type: enum Possible values: `ACHIEVEMENT_UNLOCKED`, `ADDED_PAYMENT_INFO`, `ADD_TO_CART`, `ADD_TO_WISHLIST`, `CHECKOUT_INITIATED`, `CONTENT_VIEW`, `INSTALL`, `INVITE`, `LEVEL_ACHIEVED`, `LOGIN`, `PURCHASE`, `RATED`, `RESERVATION`, `RE_ENGAGE`, `SEARCH`, `SHARE`, `SIGN_UP`, `SPENT_CREDITS`, `TUTORIAL_COMPLETE`, `UPDATE`
hashed_device_id required	HMAC_SHA-256 でハッシュ化された IDFA または AdID。 Type: string Example: `ABCD1234XYZ`
os_type required	App の OS 種別。 Type: enum Possible values: `IOS`, `ANDROID`
click_window optional	このイベントのクリックスルー計測ウィンドウ（日数）。 Type: int Default: `14` Possible values: `1`, `7`, `14`, `30`
extra_device_ids optional	`hashed_device_id` に渡されたデバイス ID の SHA1 をさらに SHA256 にしたものに、追加のハッシュ化デバイス ID を加えたもの。 Type: string Example: `ABCD1234XYZ`, `DCBA4321XYZ`
non_twitter_engagement_time optional	コンバージョン前の直近の非 Twitter エンゲージメント時刻。 Type: string Example: `2014-05-22T02:38:28.103Z`
non_twitter_engagement_type optional	コンバージョンイベント前の非 Twitter エンゲージメントの種類。 Type: enum Possible values: `CLICK`, `VIEW`
view_through_window optional	このイベントのビュースルー計測ウィンドウ（日数）。 Type: int Default: `1` Possible values: `0`, `1`, `7`, `14`, `30`

リクエスト例

GET https://ads-api.x.com/12/conversion_attribution?app_id=333903271&os_type=IOS&hashed_device_id=ABCD1234XYZ&conversion_type=INSTALL&conversion_time=2013-04-16T07:00:00.123Z&click_window=14&view_through_window=0

応答例

    {
      data:{
        "app_id":"333903271",
        "os_type":"IOS",
        "hashed_device_id":"ABCD1234XYZ",
        "conversion_type":"INSTALL",
        "partner_client_id":"123abc",
        "conversion_time":"2013-04-16T07:00:00.123Z",
        "click_window":14,
        "view_through_window":0,
        "extra_device_ids":null,
        "twitter_attribution":{
          "engagement_type":"VIEW",
          "engagement_time":"2013-04-16T07:00:00.123Z",
          "country_code":"US",
          "tweet_id":"383034667764441088",
          "attribution_type":"PROMOTED",
          "promoted_properties":{
            "campaign_id":"54a21",
            "campaign_name":"Vine_Contest",
            "line_item_id":"23ab2d4"
          }
        }
      },
      "data_type":"conversion_attribution",
      "request":{
        "params":{
          "app_id":"333903271",
          "os_type":"IOS",
          "hashed_device_id":"ABCD1234XYZ",
          "conversion_time":"2013-04-16T07:00:00.123Z",
          "conversion_type":"INSTALL",
          "click_window":14,
          "view_through_window":0
        }
      }
    }

X Ads API

基礎

リソース

計測

​MACT の概要

​コンバージョンイベント

​API リファレンス

​コンバージョンイベント

​POST conversion_event

リソースURL

パラメータ

リクエスト例

レスポンス例

​App イベントタグ

​GET accounts/:account_id/app_event_tags

リソースURL

パラメータ

リクエスト例

応答例

​GET accounts/:account_id/app_event_tags/:app_event_tag_id

リソース URL

パラメータ

​リクエスト例

​応答例

​POST accounts/:account_id/app_event_tags

リソース URL

パラメーター

リクエスト例

応答例

​DELETE accounts/:account_id/app_event_tags/:id

リソース URL

パラメーター

リクエストの例

応答例

​App Lists

​GET accounts/:account_id/app_lists

リソースURL

​パラメータ

リクエスト例

応答例

​GET accounts/:account_id/app_lists/:app_list_id

リソースURL

パラメーター

リクエスト例

応答例

​POST accounts/:account_id/app_lists

リソースURL

パラメーター

リクエスト例

例: レスポンス

​DELETE accounts/:account_id/app_lists/:app_list_id

リソース URL

パラメーター

リクエスト例

応答例

​App Event Provider の構成

​GET accounts/:account_id/app_event_provider_configurations¶

リソースURL

パラメーター

リクエスト例

応答例

​GET accounts/:account_id/app_event_provider_configurations/:id

リソース URL

パラメータ

リクエスト例

レスポンスの例

POST accounts/:account_id/app_event_provider_configurations

リソース URL

パラメーター

リクエスト例

応答例

​DELETE accounts/:account_id/app_event_provider_configurations/:id[¶]

リソース URL

パラメータ

リクエスト例

応答例

​コンバージョンアトリビューション

​GET conversion_attribution

リソースURL

パラメーター

MACT の概要

コンバージョンイベント

API リファレンス

コンバージョンイベント

POST conversion_event

App イベントタグ

GET accounts/:account_id/app_event_tags

GET accounts/:account_id/app_event_tags/:app_event_tag_id

リクエスト例

応答例

POST accounts/:account_id/app_event_tags

DELETE accounts/:account_id/app_event_tags/:id

App Lists

GET accounts/:account_id/app_lists

パラメータ

GET accounts/:account_id/app_lists/:app_list_id

POST accounts/:account_id/app_lists

DELETE accounts/:account_id/app_lists/:app_list_id

App Event Provider の構成

GET accounts/:account_id/app_event_provider_configurations¶

GET accounts/:account_id/app_event_provider_configurations/:id

DELETE accounts/:account_id/app_event_provider_configurations/:id[¶]

コンバージョンアトリビューション

GET conversion_attribution