Measurement

アプリイベントタグ

Postmanで実行 ❯

GET accounts/:account_id/app_event_tags

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

これらは、モバイルアプリのコンバージョントラッキングのコンバージョンタイプごとに設定されるコンバージョン枠を定義します。

リソースURL

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

パラメーター

名前 説明
account_id
必須

利用するアカウントのID。リソースのパス内に表示され、通常、GET accountsを除くすべての広告主APIリクエストに必須のパラメーターです。指定するアカウントは、認証済みユーザーに関連付けられている必要があります。

タイプ: 文字列

例: 18ce54d4x5t
app_event_tag_ids
任意

カンマ区切りのIDリストを指定して、応答の範囲を目的のアプリイベントタグのみに設定します。最大200件のIDを指定できます。

タイプ: 文字列

例: jhp
count
任意

個別のリクエストごとに試行および取得するレコード数を指定します。

タイプ: 整数

デフォルト: 200
最小、最大: 1、1000
cursor
任意

結果の次のページを取得するためのカーソルを指定します。詳細については、「ページネーション」を参照してください。

タイプ: 文字列

例: 8x7v00oow
sort_by
任意

サポートされている属性で昇順または降順に並べ替えます。詳細については、「並べ替え」を参照してください。

タイプ: 文字列

例: created_at-asc
with_deleted
任意

削除した結果をリクエストに含めます。

タイプ: ブール値

デフォルト: false
使用可能な値: true、false
with_total_count
任意

total_count応答属性を含めます。

注: このパラメーターとcursorとは相互に排他的です。

注: total_countを含むリクエストの場合、レート制限が低くなります。現在15分あたり200に設定されています。

タイプ: ブール値

デフォルト: false
使用可能な値: true、false

リクエストの例

GET https://ads-api.x.com/10/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,
      "updated_at": "2016-12-08T23:07:54Z",
      "os_type": "ANDROID",
      "deleted": false
    }
  ]
}

GET accounts/:account_id/app_event_tags/:app_event_tag_id

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

これらは、モバイルアプリのコンバージョントラッキングのコンバージョンタイプごとに設定されるコンバージョン枠を定義します。

リソースURL

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

パラメーター

名前 説明
account_id
必須

利用するアカウントのID。リソースのパス内に表示され、通常、GET accountsを除くすべての広告主APIリクエストに必須のパラメーターです。指定するアカウントは、認証済みユーザーに関連付けられている必要があります。

タイプ: 文字列

例: 18ce54d4x5t
app_event_tag_id
必須

リクエスト内で操作するアプリイベントタグへの参照。

タイプ: 文字列

例: jhp
with_deleted
任意

削除した結果をリクエストに含めます。

タイプ: ブール値

デフォルト: false
使用可能な値: true、false

リクエストの例

GET https://ads-api.x.com/10/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,
    "updated_at": "2016-12-08T23:07:54Z",
    "os_type": "ANDROID",
    "deleted": false
  }
}

POST accounts/:account_id/app_event_tags

現在のアカウントに関連付けられている新しいアプリイベントタグを取得します。

リソースURL

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

パラメーター

名前 説明
account_id
必須

利用するアカウントのID。リソースのパス内に表示され、通常、GET accountsを除くすべての広告主APIリクエストに必須のパラメーターです。指定するアカウントは、認証済みユーザーに関連付けられている必要があります。

タイプ: 文字列

例: 18ce54d4x5t
app_store_identifier
必須

アプリストアID。

タイプ: 文字列

例: com.twitter.android
conversion_type
必須

コンバージョンイベントのタイプ。

タイプ: 列挙

使用可能な値: 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
必須

アプリのOSタイプ。

タイプ: 列挙

使用可能な値: IOS、ANDROID
provider_app_event_id
必須

プロバイダーサイトのコンバージョンタグのID。

タイプ: 文字列

例: provider_tag_j5394
provider_app_event_name
必須

プロバイダーサイトのコンバージョンタグの名前。

タイプ: 文字列

例: provider_name_a4382
deep_link_scheme
任意

このタグに関連付けられているアプリのディープリンクURIを指定します。

タイプ: 文字列

例: twitter://
post_engagement_attribution_window
任意

これらのイベントに対するポストエンゲージメントアトリビューション期間。

タイプ: 整数

デフォルト: 30
使用可能な値: 1、7、14、30
post_view_attribution_window
任意

これらのイベントに対するポストビューアトリビューション期間。

タイプ: 整数

デフォルト: 1
使用可能な値: 0、1、7、14、30
retargeting_enabled
任意

このアプリイベントタグのリターゲティングを有効にすべきかどうかを指定します。

タイプ: ブール値

デフォルト: true
使用可能な値: true、false

リクエストの例

POST https://ads-api.x.com/10/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

現在のアカウントに属する、指定されたアプリイベントタグを削除します。

リソースURL

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

パラメーター

名前 説明
account_id
必須

利用するアカウントのID。リソースのパス内に表示され、通常、GET accountsを除くすべての広告主APIリクエストに必須のパラメーターです。指定するアカウントは、認証済みユーザーに関連付けられている必要があります。

タイプ: 文字列

例: 18ce54d4x5t
id
必須

リクエスト内で操作するアプリイベントタグへの参照。

タイプ: 文字列

例: jhp

リクエストの例

DELETE https://ads-api.x.com/10/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,
    "updated_at": "2017-08-30T05:44:57Z",
    "os_type": "ANDROID",
    "deleted": true
  },
  "request": {
    "params": {
      "id": "jhp",
      "account_id": "5gvk9h"
    }
  }
}