クリエイティブ

動画ダイレクトメッセージカード

Postmanで実行 ❯

注: カードをツイートに関連付けるには、POST accounts/:account_id/tweet、POST statuses/update、またはPOST accounts/:account_id/scheduled_tweetsエンドポイントでcard_uriパラメーターを使います。

GET accounts/:account_id/cards/video_direct_message

現在のアカウントに関連付けられている一部またはすべての動画ダイレクトメッセージカードの詳細を取得します。

リソースURL

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

パラメーター

名前 説明
account_id
必須

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

タイプ: 文字列

例: 18ce54d4x5t
card_ids
任意

カンマ区切りのIDリストを指定して、応答の範囲を目的の動画ダイレクトメッセージカードのみに設定します。最大200件のIDを指定できます。

タイプ: 文字列

例: 5a8av
count
任意

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

タイプ: 整数

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

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

タイプ: 文字列

例: 8x7v00oow
q
任意

nameでカード範囲を指定する省略可能なクエリです。このパラメーターを省略すると、すべてが取得されます。最大長: 80文字。

注: プレフィックスの一致は大文字と小文字を区別します。

タイプ: 文字列

例: aerial
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/cards/video_direct_message?card_ids=5a8av

応答の例

{
  "request": {
    "params": {
      "card_type": "video_direct_message",
      "card_ids": [
        "5a8av"
      ],
      "account_id": "18ce54d4x5t"
    }
  },
  "next_cursor": null,
  "data": [
    {
      "name": "video direct message card",
      "first_cta": "DM me",
      "first_cta_welcome_message_id": "865707372148174852",
      "media_url": "https://video.twimg.com/amplify_video/vmap/953023103654797312.vmap",
      "recipient_user_id": "756201191646691328",
      "video_owner_id": "756201191646691328",
      "media_key": "13_953023103654797312",
      "id": "5a8av",
      "created_at": "2018-01-30T18:18:00Z",
      "card_uri": "card://958403939703054336",
      "updated_at": "2018-01-30T18:18:00Z",
      "poster_media_url": "https://pbs.twimg.com/amplify_video_thumb/953023103654797312/img/56BNaul3VVrxf9Hw.jpg",
      "deleted": false,
      "card_type": "VIDEO_DIRECT_MESSAGE"
    }
  ]
}

GET accounts/:account_id/cards/video_direct_message/:card_id

現在のアカウントに属する、特定の動画ダイレクトメッセージカードを取得します。

リソースURL

https://ads-api.x.com/10/accounts/:account_id/cards/video_direct_message/:card_id

パラメーター

名前 説明
account_id
必須

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

タイプ: 文字列

例: 18ce54d4x5t
card_id
必須

リクエスト内で操作する動画ダイレクトメッセージカードへの参照。

タイプ: 文字列

例: 5a8av
with_deleted
任意

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

タイプ: ブール値

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

リクエストの例

GET https://ads-api.x.com/10/accounts/18ce54d4x5t/cards/video_direct_message/5a8av

応答の例

{
  "request": {
    "params": {
      "card_type": "video_direct_message",
      "card_id": "5a8av",
      "account_id": "18ce54d4x5t"
    }
  },
  "data": {
    "name": "video direct message card",
    "first_cta": "DM me",
    "first_cta_welcome_message_id": "865707372148174852",
    "media_url": "https://video.twimg.com/amplify_video/vmap/953023103654797312.vmap",
    "recipient_user_id": "756201191646691328",
    "video_owner_id": "756201191646691328",
    "media_key": "13_953023103654797312",
    "id": "5a8av",
    "created_at": "2018-01-30T18:18:00Z",
    "card_uri": "card://958403939703054336",
    "updated_at": "2018-01-30T18:18:00Z",
    "poster_media_url": "https://pbs.twimg.com/amplify_video_thumb/953023103654797312/img/56BNaul3VVrxf9Hw.jpg",
    "deleted": false,
    "card_type": "VIDEO_DIRECT_MESSAGE"
  }
}

POST accounts/:account_id/cards/video_direct_message

特定のアカウントに関連付けられている新しい動画ダイレクトメッセージカードを作成します。

リソースURL

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

パラメーター

名前 説明
account_id
必須

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

タイプ: 文字列

例: 18ce54d4x5t
first_cta
必須

最初のオプションのアクション誘導（CTA）テキスト。最大長: 20文字。

タイプ: 文字列

例: DM me
first_cta_welcome_message_id
必須

最初のCTAに関連付けられるウェルカムメッセージID。

注: このウェルカムメッセージはrecipient_user_idで指定したユーザーが所有する必要があります。

タイプ: 長整数型

例: 865707372148174852
media_key
必須

このカードでは動画のメディアキーが使用されます。

注: このビデオはアカウントのメディアライブラリ内にある必要があります。

注: アスペクト比は16:9である必要があります。

タイプ: 文字列

例: 13_1168079965037467209
name
必須

カードの名前。

タイプ: 文字列

例: video direct message card
recipient_user_id
必須

会話を開始するユーザー（カードに反応するユーザーの観点から）。

注: このユーザーは指定したウェルカムメッセージの所有者である必要があります。

タイプ: 長整数型

例: 756201191646691328
poster_media_key
任意

このカードではポスター画像のメディアキーが使用されます。指定しない場合は、最初のフレームが使われます。

注: このビデオはアカウントのメディアライブラリ内にある必要があります。

タイプ: 長整数型

例: 3_882726458191298561
second_cta
任意

2番目のオプションのアクション誘導（CTA）テキスト。最大長: 20文字。

タイプ: 文字列

例: Browse Moments
second_cta_welcome_message_id
任意

2番目のCTAに関連付けられるウェルカムメッセージID。

注: このウェルカムメッセージはrecipient_user_idで指定したユーザーが所有する必要があります。

タイプ: 長整数型

例: 905953936925695848
third_cta
任意

3番目のオプションのアクション誘導（CTA）テキスト。最大長: 20文字。

タイプ: 文字列

例: Play a bot song
third_cta_welcome_message_id
任意

3番目のCTAに関連付けられるウェルカムメッセージID。

注: このウェルカムメッセージはrecipient_user_idで指定したユーザーが所有する必要があります。

タイプ: 長整数型

例: 933237054790401013
fourth_cta
任意

4番目のオプションのアクション誘導（CTA）テキスト。最大長: 20文字。

タイプ: 文字列

例: Play Twitter Trivia
fourth_cta_welcome_message_id
任意

4番目のCTAに関連付けられるウェルカムメッセージID。

注: このウェルカムメッセージはrecipient_user_idで指定したユーザーが所有する必要があります。

タイプ: 長整数型

例: 929280268839051451

リクエストの例

POST https://ads-api.x.com/10/accounts/18ce54d4x5t/cards/video_direct_message?first_cta=DM me&first_cta_welcome_message_id=865707372148174852&name=video direct message card&recipient_user_id=756201191646691328&media_key=13_953023103654797312

応答の例

{
  "data": {
    "name": "video direct message card",
    "first_cta": "DM me",
    "first_cta_welcome_message_id": "865707372148174852",
    "media_url": "https://video.twimg.com/amplify_video/vmap/953023103654797312.vmap",
    "recipient_user_id": "756201191646691328",
    "video_owner_id": "756201191646691328",
    "media_key": "13_953023103654797312",
    "id": "5a8av",
    "created_at": "2018-01-30T18:18:00Z",
    "card_uri": "card://958403939703054336",
    "updated_at": "2018-01-30T18:18:00Z",
    "poster_media_url": "https://pbs.twimg.com/amplify_video_thumb/953023103654797312/img/56BNaul3VVrxf9Hw.jpg",
    "deleted": false,
    "card_type": "VIDEO_DIRECT_MESSAGE"
  },
  "request": {
    "params": {
      "video_poster_height": "9",
      "name": "video direct message card",
      "first_cta": "DM me",
      "first_cta_welcome_message_id": "865707372148174852",
      "media_url": "https://video.twimg.com/amplify_video/vmap/953023103654797312.vmap",
      "recipient_user_id": "756201191646691328",
      "video_owner_id": "756201191646691328",
      "media_key": "13_953023103654797312",
      "account_id": "18ce54d4x5t",
      "poster_media_url": "https://pbs.twimg.com/amplify_video_thumb/953023103654797312/img/56BNaul3VVrxf9Hw.jpg",
      "video_poster_width": "16",
      "card_type": "VIDEO_DIRECT_MESSAGE"
    }
  }
}

PUT accounts/:account_id/cards/video_direct_message/:card_id

現在のアカウントに属する、指定した動画ダイレクトメッセージカードを更新します。

注: すべてのウェルカムメッセージは作成（POST）リクエストで指定したユーザーの所有である必要があるため、recipient_user_idを更新することはできません。

リソースURL

https://ads-api.x.com/10/accounts/:account_id/cards/video_direct_message/:card_id

パラメーター

名前 説明
account_id
必須

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

タイプ: 文字列

例: 18ce54d4x5t
card_id
必須

リクエスト内で操作する動画ダイレクトメッセージカードへの参照。

タイプ: 文字列

例: 4zjee
first_cta
任意

最初のオプションのアクション誘導（CTA）テキスト。最大長: 20文字。

タイプ: 文字列

例: Tell me a joke
first_cta_welcome_message_id
任意

最初のCTAに関連付けられるウェルカムメッセージID。

注: このウェルカムメッセージはrecipient_user_idで指定したユーザーが所有する必要があります。

タイプ: 長整数型

例: 930384951649221544
second_cta
任意

2番目のオプションのアクション誘導（CTA）テキスト。最大長: 20文字。

タイプ: 文字列

例: Browse Moments
second_cta_welcome_message_id
任意

2番目のCTAに関連付けられるウェルカムメッセージID。

注: このウェルカムメッセージはrecipient_user_idで指定したユーザーが所有する必要があります。

タイプ: 長整数型

例: 915193968850536077
third_cta
任意

3番目のオプションのアクション誘導（CTA）テキスト。最大長: 20文字。

タイプ: 文字列

例: Play a bot song
third_cta_welcome_message_id
任意

3番目のCTAに関連付けられるウェルカムメッセージID。

注: このウェルカムメッセージはrecipient_user_idで指定したユーザーが所有する必要があります。

タイプ: 長整数型

例: 908983224974380367
fourth_cta
任意

4番目のオプションのアクション誘導（CTA）テキスト。最大長: 20文字。

タイプ: 文字列

例: Play Twitter Trivia
fourth_cta_welcome_message_id
任意

4番目のCTAに関連付けられるウェルカムメッセージID。

注: このウェルカムメッセージはrecipient_user_idで指定したユーザーが所有する必要があります。

タイプ: 長整数型

例: 936232223055682535
media_key
任意

このカードでは動画のメディアキーが使用されます。

注: このビデオはアカウントのメディアライブラリ内にある必要があります。

注: アスペクト比は16:9である必要があります。

タイプ: 文字列

例: 13_1168079965037467209
name
任意

カードの名前。

タイプ: 文字列

例: winter card
poster_media_key
任意

このカードではポスター画像のメディアキーが使用されます。指定しない場合は、最初のフレームが使われます。

注: このビデオはアカウントのメディアライブラリ内にある必要があります。

タイプ: 長整数型

例: 3_882726458191298561

リクエストの例

PUT https://ads-api.x.com/10/accounts/18ce54d4x5t/cards/video_direct_message/5a8av?name=winter card

応答の例

{
  "data": {
    "name": "winter card",
    "first_cta": "DM me",
    "first_cta_welcome_message_id": "865707372148174852",
    "media_url": "https://video.twimg.com/amplify_video/vmap/953023103654797312.vmap",
    "recipient_user_id": "756201191646691328",
    "video_owner_id": "756201191646691328",
    "media_key": "13_953023103654797312",
    "id": "5a8av",
    "created_at": "2018-01-30T18:18:00Z",
    "card_uri": "card://958403939703054336",
    "updated_at": "2018-01-30T18:24:54Z",
    "poster_media_url": "https://pbs.twimg.com/amplify_video_thumb/953023103654797312/img/56BNaul3VVrxf9Hw.jpg",
    "deleted": false,
    "card_type": "VIDEO_DIRECT_MESSAGE"
  },
  "request": {
    "params": {
      "account_id": "18ce54d4x5t",
      "card_type": "VIDEO_DIRECT_MESSAGE",
      "card_id": "5a8av",
      "name": "winter card"
    }
  }
}

DELETE accounts/:account_id/cards/video_direct_message/:card_id

現在のアカウントに属する、指定した動画ダイレクトメッセージカードを完全に削除します。

注: これは物理的な削除です。このため、削除したカードを取得することはできません。

リソースURL

https://ads-api.x.com/10/accounts/:account_id/cards/video_direct_message/:card_id

パラメーター

名前 説明
account_id
必須

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

タイプ: 文字列

例: 18ce54d4x5t
card_id
必須

リクエスト内で操作する動画ダイレクトメッセージカードへの参照。

タイプ: 文字列

例: 4zjee

リクエストの例

DELETE https://ads-api.x.com/10/accounts/18ce54d4x5t/cards/video_direct_message/4zjee

応答の例

{
  "data": {
    "name": "video DM card",
    "id": "4zjee",
    "created_at": "2017-11-06T04:35:44Z",
    "updated_at": "2017-11-06T04:43:42Z",
    "deleted": true,
    "card_type": "VIDEO_DIRECT_MESSAGE"
  },
  "request": {
    "params": {
      "card_id": "4zjee",
      "card_type": "video_direct_message",
      "account_id": "18ce54d4x5t"
    }
  }
}