Campaign management

行項目アプリ

Postmanで実行 ❯ 

GET accounts/:account_id/line_item_apps

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

リソースURL

https://ads-api.twitter.com/8/accounts/:account_id/line_item_apps

パラメーター

名前 説明
account_id
必須

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

タイプ: 文字列

例: 18ce54d4x5t
count
任意

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

タイプ: 整数

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

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

タイプ: 文字列

例: 8x7v00oow
line_item_ids
任意

カンマ区切りのIDリストを指定して、応答の範囲を指定した行項目に関連付けられているアプリのみに設定します。最大200件のIDを指定できます。

タイプ: 文字列

例: 6syda
line_item_app_ids
任意

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

タイプ: 文字列

例: 1eegy
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.twitter.com/8/accounts/18ce54d4x5t/line_item_apps?line_item_app_ids=1eegy

応答の例

{
  "data": [
    {
      "line_item_id": "6syda",
      "app_store_identifier": "com.twitter.android",
      "id": "1eegy",
      "created_at": "2016-11-18T18:20:18Z",
      "updated_at": "2016-11-18T18:20:18Z",
      "os_type": "Android",
      "deleted": false
    }
  ],
  "next_cursor": null,
  "request": {
    "params": {
      "line_item_app_ids": [
        "1eegy"
      ],
      "account_id": "18ce54d4x5t"
    }
  }
}

GET accounts/:account_id/line_item_apps/:line_item_app_id

特定の行項目とモバイルアプリの関連付けを取得します。

リソースURL

https://ads-api.twitter.com/8/accounts/:account_id/line_item_apps/:line_item_app_id

パラメーター

名前 説明
account_id
必須

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

タイプ: 文字列

例: 18ce54d4x5t
line_item_app_id
必須

リクエスト内で操作する行項目アプリへの参照。

タイプ: 文字列

例: vbbj
with_deleted
任意

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

タイプ: ブール値

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

リクエストの例

GET https://ads-api.twitter.com/8/accounts/hkk5/line_items_apps/vbbj

応答の例

{
  "data": {
    "line_item_id": "4w9x5",
    "app_store_identifier": "87654321",
    "id": "vbbj",
    "created_at": "2016-04-10T01:46:33Z",
    "updated_at": "2016-04-10T01:46:33Z",
    "os_type": "iOS",
    "deleted": false
  },
  "request": {
    "params": {
      "line_item_app_id": "vbbj",
      "account_id": "hkk5"
    }
  }
}

POST accounts/:account_id/line_item_apps

モバイルアプリを指定した行項目に関連付け、Twitterオーディエンスプラットフォームでのモバイルアプリプロモーションを有効にします。

注: 行項目アプリを更新（PUT）することはできません。

リソースURL

https://ads-api.twitter.com/8/accounts/:account_id/line_item_apps

パラメーター

名前 説明
account_id
必須

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

タイプ: 文字列

例: 18ce54d4x5t
app_store_identifier
必須

アプリストアID。

タイプ: 文字列

例: com.twitter.android
line_item_id
必須

リクエスト内で操作する行項目への参照。

タイプ: 文字列

例: 6syld
os_type
必須

オペレーションシステムのタイプ。

タイプ: 列挙

使用可能な値: ANDROID、IOS

リクエストの例

POST https://ads-api.twitter.com/8/accounts/18ce54d4x5t/line_item_apps?line_item_id=6syld&app_store_identifier=com.twitter.android&os_type=ANDROID

応答の例

{
  "data": {
    "line_item_id": "6syld",
    "app_store_identifier": "com.twitter.android",
    "id": "1x153",
    "created_at": "2017-08-23T19:41:33Z",
    "updated_at": "2017-08-23T19:41:33Z",
    "os_type": "Android",
    "deleted": false
  }
}

DELETE accounts/:account_id/line_item_apps/:line_item_app_id

指定した行項目からモバイルアプリの関連付けを解除します。

リソースURL

https://ads-api.twitter.com/8/accounts/:account_id/line_item_apps/:line_item_app_id

パラメーター

名前 説明
account_id
必須

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

タイプ: 文字列

例: 18ce54d4x5t
line_item_app_id
必須

リクエスト内で操作する行項目アプリへの参照。

タイプ: 文字列

例: 1wu1i

リクエストの例

DELETE https://ads-api.twitter.com/8/accounts/18ce54d4x5t/line_item_apps/1wu1i

応答の例

{
  "data": {
    "line_item_id": "9pl99",
    "app_store_identifier": "com.twitter.android",
    "id": "1wu1i",
    "created_at": "2017-08-17T15:51:19Z",
    "updated_at": "2017-08-23T19:11:49Z",
    "os_type": "Android",
    "deleted": true
  },
  "request": {
    "params": {
      "line_item_app_id": "1wu1i",
      "account_id": "18ce54d4x5t"
    }
  }
}