クリエイティブ

メディアライブラリ

Postmanで実行 ❯

GET accounts/:account_id/media_library

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

リソースURL

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

パラメーター

名前 説明
account_id
必須

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

タイプ: 文字列

例: 18ce54d4x5t
count
任意

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

タイプ: 整数

デフォルト: 20
最小、最大: 1、50
cursor
任意

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

タイプ: 文字列

例: c-1
media_type
任意

応答の範囲を目的のメディアタイプのみに設定します。

タイプ: 列挙

使用可能な値: GIF、IMAGE、VIDEO
q
任意

リソースをname、title、file_name、descriptionのフィールドごとに範囲設定する任意のクエリ。

注: 用語の一致は大文字と小文字を区別します。

タイプ: 文字列

最小および最長の長さ: 1、255

リクエストの例

GET https://ads-api.x.com/10/accounts/18ce54d4x5t/media_library?count=1

応答の例

{
  "request": {
    "params": {
      "account_id": "18ce54d4x5t",
      "count": 1
    }
  },
  "data": [
    {
      "tweeted": true,
      "name": null,
      "file_name": "coffee https://t.co/4tcPU9XUon",
      "media_url": "https://pbs.twimg.com/media/DJvnJf_UEAAXnzC.jpg",
      "media_category": "TWEET_IMAGE",
      "media_key": "3_908573900237180928",
      "created_at": "2017-09-15T06:11:12Z",
      "media_status": "TRANSCODE_COMPLETED",
      "media_type": "IMAGE",
      "updated_at": "2017-11-16T06:00:01Z",
      "deleted": false
    }
  ],
  "next_cursor": "c-1"
}

GET accounts/:account_id/media_library/:media_key

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

リソースURL

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

パラメーター

名前 説明
account_id
必須

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

タイプ: 文字列

例: 18ce54d4x5t
media_key
必須

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

タイプ: 文字列

例: 13_909110614026444802

リクエストの例

GET https://ads-api.x.com/10/accounts/18ce54d4x5t/media_library/13_909110614026444802

応答の例

{
  "request": {
    "params": {
      "account_id": "18ce54d4x5t",
      "media_key": "13_909110614026444802"
    }
  },
  "data": {
    "tweeted": true,
    "duration": 39973,
    "name": null,
    "file_name": "buildings https://t.co/xFdzrHM5QG",
    "description": null,
    "media_url": "https://video.twimg.com/amplify_video/909110614026444802/vid/1280x720/mfahmfkKVjjk1nGm.mp4",
    "media_category": "AMPLIFY_VIDEO",
    "poster_media_url": "https://pbs.twimg.com/amplify_video_thumb/909110614026444802/img/QZUNoaiCia0UFNrw.jpg",
    "poster_media_key": "3_909110614026444802",
    "media_key": "13_909110614026444802",
    "created_at": "2017-09-16T17:43:55Z",
    "media_status": "TRANSCODE_COMPLETED",
    "title": "buildings",
    "media_type": "VIDEO",
    "aspect_ratio": "16:9",
    "updated_at": "2017-09-27T13:04:00Z",
    "deleted": false
  }
}

POST accounts/:account_id/media_library

メディアオブジェクトを現在のアカウントに関連付けます。その他の詳細については、「メディアライブラリガイド」を参照してください。

注: 動画をAMPLIFY_VIDEOメディアカテゴリーでメディアライブラリに追加すると、PREROLL account_mediaアセットとして自動的に利用可能になります。

リソースURL

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

パラメーター

名前 説明
account_id
必須

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

タイプ: 文字列

例: 18ce54d4x5t
media_key
必須

アップロードされたコンテンツのmedia_key。media_categoryが指定されると、POST media/upload応答でmedia_keyが返されます。

タイプ: 文字列

例: 3_931236738554519552
description
任意

ツイートされたときに動画の下に表示される説明。最大長: 200文字。

これはデフォルトではツイートに表示されません。動画のdescriptionを表示するには、POST accounts/:account_id/tweetエンドポイントとともにvideo_descriptionパラメーターを使います。

注: 動画でのみ使うことができます。

タイプ: 文字列

例: This is the description under the video.
file_name
任意

メディアライブラリオブジェクトのファイル名。最大長: 255。

ファイル名はads.twitter.comでメディアライブラリUIの各メディアアセットのメディア詳細に表示されます。file_nameが設定されていない場合、これは空になります。

タイプ: 文字列

例: coffee.jpeg
name
任意

メディアライブラリオブジェクトの名前。最大長: 100。

これは、ads.twitter.comのメディアライブラリUIの各メディアアセット下にあるラベルです。nameが設定されていない場合、ラベルは「無題」になります。

タイプ: 文字列

例: Latte
poster_media_key
任意

アップロードされた画像のmedia_keyを使って動画のポスター画像を指定します。指定しない場合は、最初のフレームが使われます。

注: 動画でのみ使うことができます。

タイプ: 文字列

例: 3_890599134483242005
title
任意

ツイートされたときに動画の下に表示されるタイトル（見出し）。最大長: 70文字。

これはデフォルトではツイートに表示されません。動画のtitleを表示するには、POST accounts/:account_id/tweetエンドポイントとともにvideo_titleパラメーターを使います。

注: 動画でのみ使うことができます。

タイプ: 文字列

例: Video title

リクエストの例

POST https://ads-api.x.com/10/accounts/18ce54d4x5t/media_library?media_key=3_931236738554519552

応答の例

{
  "request": {
    "params": {
      "account_id": "18ce54d4x5t",
      "media_key": "3_931236738554519552"
    }
  },
  "data": {
    "tweeted": false,
    "name": null,
    "file_name": null,
    "media_url": "https://pbs.twimg.com/media/DOxq4TtV4AAlvh_.jpg",
    "media_category": "TWEET_IMAGE",
    "media_key": "3_931236738554519552",
    "created_at": "2017-11-16T19:05:14Z",
    "media_status": "TRANSCODE_COMPLETED",
    "media_type": "IMAGE",
    "updated_at": "2017-11-16T19:05:23Z",
    "deleted": false
  }
}

PUT accounts/:account_id/media_library/:media_key

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

リソースURL

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

パラメーター

名前 説明
account_id
必須

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

タイプ: 文字列

例: 18ce54d4x5t
media_key
必須

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

タイプ: 文字列

例: 16_844800354743074820
description
任意

ツイートされたときに動画の下に表示される説明。最大長: 200文字。

これはデフォルトではツイートに表示されません。動画のdescriptionを表示するには、POST accounts/:account_id/tweetエンドポイントとともにvideo_descriptionパラメーターを使います。

注: 動画でのみ使うことができます。

タイプ: 文字列

例: This is the description under the video.
file_name
任意

メディアライブラリオブジェクトのファイル名。最大長: 255。

ファイル名はads.twitter.comでメディアライブラリUIの各メディアアセットのメディア詳細に表示されます。file_nameが設定されていない場合、これは空になります。

タイプ: 文字列

例: coffee.jpeg
name
任意

メディアライブラリオブジェクトの名前。最大長: 100。

これは、ads.twitter.comのメディアライブラリUIの各メディアアセット下にあるラベルです。nameが設定されていない場合、ラベルは「無題」になります。

タイプ: 文字列

例: Latte
poster_media_key
任意

アップロードされた画像のmedia_keyを使って動画のポスター画像を指定します。

注: 動画でのみ使うことができます。

タイプ: 文字列

例: 3_885003359340375465
title
任意

ツイートされたときに動画の下に表示されるタイトル（見出し）。最大長: 70文字。

これはデフォルトではツイートに表示されません。動画のtitleを表示するには、POST accounts/:account_id/tweetエンドポイントとともにvideo_titleパラメーターを使います。

注: 動画でのみ使うことができます。

タイプ: 文字列

例: Video title

リクエストの例

PUT https://ads-api.x.com/10/accounts/18ce54d4x5t/media_library/16_844800354743074820?title=cat GIF&description=in space

応答の例

{
  "request": {
    "params": {
      "account_id": "18ce54d4x5t",
      "media_key": "16_844800354743074820",
      "title": "cat GIF",
      "description": "in space"
    }
  },
  "data": {
    "tweeted": true,
    "duration": null,
    "name": null,
    "file_name": null,
    "description": "in space",
    "media_url": "https://video.twimg.com/tweet_video/C7lVclqVwAQqTCZ.mp4",
    "media_category": "TWEET_GIF",
    "poster_media_url": "https://pbs.twimg.com/tweet_video_thumb/C7lVclqVwAQqTCZ.jpg",
    "poster_media_key": "3_844800354743074820",
    "media_key": "16_844800354743074820",
    "created_at": "2017-10-20T09:51:54Z",
    "media_status": "TRANSCODE_COMPLETED",
    "title": "cat GIF",
    "media_type": "GIF",
    "aspect_ratio": "125:79",
    "updated_at": "2017-10-23T06:37:56Z",
    "deleted": false
  }
}

DELETE accounts/:account_id/media_library/:media_key

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

リソースURL

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

パラメーター

名前 説明
account_id
必須

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

タイプ: 文字列

例: 18ce54d4x5t
media_key
必須

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

タイプ: 文字列

例: 7_860318603387600896

リクエストの例

DELETE https://ads-api.x.com/10/accounts/18ce54d4x5t/media_library/7_860318603387600896

応答の例

{
  "request": {
    "params": {
      "account_id": "18ce54d4x5t",
      "media_key": "7_860318603387600896"
    }
  },
  "data": {
    "tweeted": true,
    "duration": 14330,
    "name": "mountains-on-ads.twitter.com",
    "file_name": "mountains.mp4",
    "description": "",
    "media_url": "https://video.twimg.com/ext_tw_video/860318603387600896/pu/vid/1280x720/xI3DbvWKxdvICsFW.mp4",
    "media_category": "TWEET_VIDEO",
    "poster_media_url": "https://pbs.twimg.com/media/C_B3bTRVYAAFBFt.jpg",
    "poster_media_key": "3_860318839740915712",
    "media_key": "7_860318603387600896",
    "created_at": "2017-05-05T02:21:53Z",
    "media_status": "TRANSCODE_COMPLETED",
    "title": "uploaded on ads.twitter.com",
    "media_type": "VIDEO",
    "aspect_ratio": "16:9",
    "updated_at": "2017-05-05T02:26:58Z",
    "deleted": true
  }
}