クリエイティブ

アカウントメディア

Postmanで実行 ❯

GET accounts/:account_id/account_media

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

リソースURL

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

パラメーター

名前 説明
account_id
必須

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

タイプ: 文字列

例: 18ce54d4x5t
account_media_ids
任意

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

タイプ: 文字列

例: 3wpx
count
任意

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

タイプ: 整数

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

応答の範囲を、指定したクリエイティブタイプと一致するアカウントメディアのみに設定します。カンマ区切りで値を列挙することで、クリエイティブタイプを複数指定できます。

タイプ: 列挙

使用可能な値: BANNER、BANNER_TABLET、INTERSTITIAL、INTERSTITIAL_LANDSCAPE、INTERSTITIAL_LANDSCAPE_TABLET、INTERSTITIAL_TABLET、MEDIUM_RECTANGLE、PREROLL、VAST_PREROLL
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/account_media?account_media_ids=3wpx

応答の例

{
  "request": {
    "params": {
      "account_media_ids": [
        "3wpx"
      ],
      "account_id": "18ce54d4x5t"
    }
  },
  "next_cursor": null,
  "data": [
    {
      "video_id": "13_771791717175468032",
      "media_url": null,
      "creative_type": "PREROLL",
      "id": "3wpx",
      "created_at": "2016-09-02T19:27:52Z",
      "updated_at": "2016-09-02T19:27:52Z",
      "deleted": false
    }
  ]
}

GET accounts/:account_id/account_media/:account_media_id

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

リソースURL

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

パラメーター

名前 説明
account_id
必須

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

タイプ: 文字列

例: 18ce54d4x5t
account_media_id
必須

リクエスト内で操作するアカウントメディアへの参照。

タイプ: 文字列

例: 2pnfd
with_deleted
任意

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

タイプ: ブール値

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

リクエストの例

GET https://ads-api.x.com/10/accounts/18ce54d4x5t/account_media/2pnfd

応答の例

{
  "request": {
    "params": {
      "account_media_id": "2pnfd",
      "account_id": "18ce54d4x5t"
    }
  },
  "data": {
    "video_id": null,
    "media_url": "https://pbs.twimg.com/ad_img/890749735862026242/Up07zMym?format=jpg&name=orig",
    "creative_type": "INTERSTITIAL_LANDSCAPE_TABLET",
    "id": "2pnfd",
    "created_at": "2017-07-28T01:44:41Z",
    "updated_at": "2017-07-28T01:44:41Z",
    "deleted": false
  }
}

DELETE accounts/:account_id/account_media/:account_media_id

現在のアカウントに属する、指定したアカウントメディアオブジェクトを削除します。

リソースURL

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

パラメーター

名前 説明
account_id
必須

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

タイプ: 文字列

例: 18ce54d4x5t
account_media_id
必須

リクエスト内で操作するアカウントメディアへの参照。

タイプ: 文字列

例: 2pnfd

リクエストの例

DELETE https://ads-api.x.com/10/accounts/18ce54d4x5t/account_media/2pnfd

応答の例

{
  "data": {
    "video_id": null,
    "media_url": "https://pbs.twimg.com/ad_img/890749735862026242/Up07zMym?format=jpg&name=orig",
    "creative_type": "INTERSTITIAL_LANDSCAPE_TABLET",
    "id": "2pnfd",
    "created_at": "2017-07-28T01:44:41Z",
    "updated_at": "2017-08-25T17:16:26Z",
    "deleted": true
  },
  "request": {
    "params": {
      "account_id": "18ce54d4x5t",
      "account_media_id": "2pnfd"
    }
  }
}