メディアクリエイティブ

GET accounts/:account_id/media_creatives

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

リソースURL

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

パラメーター

名前 説明
account_id
必須

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

タイプ: 文字列

例: 18ce54d4x5t

campaign_id
任意

応答の範囲を、指定したキャンペーンに関連付けられているメディアクリエイティブのみに設定します。

タイプ: 文字列

例: 8gdx6

count
任意

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

タイプ: 整数

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

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

タイプ: 文字列

例: 8x7v00oow

line_item_ids
任意

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

タイプ: 文字列

例: 8v7jo

media_creative_ids
任意

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

タイプ: 文字列

例: 1bzq3

sort_by
任意

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

タイプ: 文字列

例: created_at-asc

with_deleted
任意

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

タイプ: ブール値

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

total_count応答属性を含めます。

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

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

タイプ: ブール値

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

リクエストの例

GET https://ads-api.x.com/10/accounts/18ce54d4x5t/media_creatives?media_creative_ids=1bzq3

応答の例

{
  "request": {
    "params": {
      "account_id": "18ce54d4x5t",
      "media_creative_ids": [
        "1bzq3"
      ]
    }
  },
  "next_cursor": null,
  "data": [
    {
      "line_item_id": "8v7jo",
      "landing_url": "https://dev.twitter.com",
      "creative_type": "INTERSTITIAL_LANDSCAPE_TABLET",
      "id": "1bzq3",
      "entity_status": "ACTIVE",
      "created_at": "2017-07-05T06:00:42Z",
      "account_media_id": "10miy",
      "updated_at": "2019-01-11T20:21:26Z",
      "approval_status": "ACCEPTED",
      "deleted": false
    }
  ]
}

GET accounts/:account_id/media_creatives/:media_creative_id

現在のアカウントに関連付けられている特定のメディアクリエイティブの詳細を取得します。

リソースURL

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

パラメーター

名前 説明
account_id
必須

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

タイプ: 文字列

例: 18ce54d4x5t

media_creative_id
必須

リクエスト内で操作するメディアクリエイティブへの参照。

タイプ: 文字列

例: 43853bhii885

with_deleted
任意

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

タイプ: ブール値

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

リクエストの例

GET https://ads-api.x.com/10/accounts/18ce54d4x5t/media_creatives/1bzq3

応答の例

{
  "request": {
    "params": {
      "media_creative_id": "1bzq3",
      "account_id": "18ce54d4x5t"
    }
  },
  "data": {
    "line_item_id": "8v7jo",
    "landing_url": "https://dev.twitter.com",
    "creative_type": "INTERSTITIAL_LANDSCAPE_TABLET",
    "id": "1bzq3",
    "entity_status": "ACTIVE",
    "created_at": "2017-07-05T06:00:42Z",
    "account_media_id": "10miy",
    "updated_at": "2019-01-11T20:21:26Z",
    "approval_status": "ACCEPTED",
    "deleted": false
  }
}

POST accounts/:account_id/media_creatives

指定した行項目にアカウントメディアオブジェクトを関連付けます。

このエンドポイントを使用して、Twitterオーディエンスプラットフォームでインストリーム広告(アカウントメディアcreative_typePREROLLの場合)またはイメージ広告(BANNERINTERSTITIALなど)をプロモーションします。

: メディアアセットをアカウントメディアリソースに追加するには、POST accounts/:account_id/media_libraryエンドポイントを使用します。

リソースURL

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

パラメーター

名前 説明
account_id
required

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

タイプ: 文字列

例: 18ce54d4x5t

account_media_id
required

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

タイプ: 文字列

例: 10miy

line_item_id
required

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

タイプ: 文字列

例: 8v7jo

landing_url
sometimes required

ユーザーの誘導先となるウェブサイトのURL。これはTAPの画像(または [表示クリエイティブ] )でのみ使用する必要があります。この値はプレロールのアセットで使用された場合は無視されます。URLをプレロールのアセットと関連付けるには、POST accounts/:account_id/preroll_call_to_actionsエンドポイントを使用します。

: 行項目の目的がWEBSITE_CLICKSに設定されている場合は必須です。

タイプ: 文字列

例: https://blog.twitter.com/

リクエストの例

POST https://ads-api.x.com/10/accounts/18ce54d4x5t/media_creatives?line_item_id=8v7jo&account_media_id=10miy

応答の例

{
  "request": {
    "params": {
      "line_item_id": "8v7jo",
      "account_media_id": "10miy",
      "account_id": "18ce54d4x5t"
    }
  },
  "data": {
    "line_item_id": "8v7jo",
    "landing_url": "https://dev.twitter.com",
    "creative_type": "INTERSTITIAL_LANDSCAPE_TABLET",
    "id": "1bzq3",
    "entity_status": "ACTIVE",
    "created_at": "2017-07-05T06:00:42Z",
    "account_media_id": "10miy",
    "updated_at": "2019-01-11T20:21:26Z",
    "approval_status": "ACCEPTED",
    "deleted": false
  }
}

DELETE accounts/:account_id/media_creatives/:media_creative_id

現在のアカウントに属する、指定したメディアクリエイティブを削除します。

リソースURL

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

パラメーター

名前 説明
account_id
必須

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

タイプ: 文字列

例: 18ce54d4x5t

media_creative_id
必須

リクエスト内で操作するメディアクリエイティブへの参照。

タイプ: 文字列

例: 1bzq3

リクエストの例

DELETE https://ads-api.x.com/10/accounts/18ce54d4x5t/media_creatives/1bzq3

応答の例

{
  "request": {
    "params": {
      "media_creative_id": "1bzq3",
      "account_id": "18ce54d4x5t"
    }
  },
  "data": {
    "line_item_id": "8v7jo",
    "landing_url": "https://dev.twitter.com",
    "creative_type": "INTERSTITIAL_LANDSCAPE_TABLET",
    "id": "1bzq3",
    "entity_status": "ACTIVE",
    "created_at": "2017-07-05T06:00:42Z",
    "account_media_id": "10miy",
    "updated_at": "2021-04-16T21:02:55Z",
    "approval_status": "ACCEPTED",
    "deleted": true
  }
}