クリエイティブ

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

Postmanで実行 ❯

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

GET accounts/:account_id/cards/image_direct_message

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

リソースURL

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

パラメーター

名前 説明
account_id
必須

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

タイプ: 文字列

例: 18ce54d4x5t
card_ids
任意

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

タイプ: 文字列

例: 59wpi
count
任意

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

タイプ: 整数

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

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

タイプ: 文字列

例: 8x7v00oow
q
任意

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

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

タイプ: 文字列

例: space
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/image_direct_message?card_ids=59wpi

応答の例

{
  "request": {
    "params": {
      "card_type": "image_direct_message",
      "card_ids": [
        "59wpi"
      ],
      "account_id": "18ce54d4x5t"
    }
  },
  "next_cursor": null,
  "data": [
    {
      "name": "space card",
      "first_cta": "DM me",
      "first_cta_welcome_message_id": "865707372148174852",
      "image_display_height": "418",
      "media_url": "https://pbs.twimg.com/media/DUfy_2JU8AAMAOk.jpg",
      "recipient_user_id": "756201191646691328",
      "id": "59wpi",
      "created_at": "2018-01-27T05:44:31Z",
      "media_key": "3_957000624519835648",
      "image_display_width": "800",
      "card_uri": "card://957127157993500678",
      "updated_at": "2018-01-30T01:33:49Z",
      "deleted": false,
      "card_type": "IMAGE_DIRECT_MESSAGE"
    }
  ]
}

GET accounts/:account_id/cards/image_direct_message/:card_id

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

リソースURL

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

パラメーター

名前 説明
account_id
必須

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

タイプ: 文字列

例: 18ce54d4x5t
card_id
必須

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

タイプ: 文字列

例: 59wpi
with_deleted
任意

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

タイプ: ブール値

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

リクエストの例

GET https://ads-api.x.com/10/accounts/18ce54d4x5t/cards/image_direct_message/59wpi

応答の例

{
  "request": {
    "params": {
      "card_type": "image_direct_message",
      "card_id": "59wpi",
      "account_id": "18ce54d4x5t"
    }
  },
  "data": {
    "name": "space card",
    "first_cta": "DM me",
    "first_cta_welcome_message_id": "865707372148174852",
    "image_display_height": "418",
    "media_url": "https://pbs.twimg.com/media/DUfy_2JU8AAMAOk.jpg",
    "recipient_user_id": "756201191646691328",
    "id": "59wpi",
    "created_at": "2018-01-27T05:44:31Z",
    "media_key": "3_957000624519835648",
    "image_display_width": "800",
    "card_uri": "card://957127157993500678",
    "updated_at": "2018-01-30T01:33:49Z",
    "deleted": false,
    "card_type": "IMAGE_DIRECT_MESSAGE"
  }
}

POST accounts/:account_id/cards/image_direct_message

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

リソースURL

https://ads-api.x.com/10/accounts/:account_id/cards/image_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
必須

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

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

注: 画像幅が800ピクセル以上で、幅と高さのアスペクト比が1.91:1である必要があります。

タイプ: 文字列

例: 3_1151345051104991073
name
必須

カードの名前。

タイプ: 文字列

例: direct message card
recipient_user_id
必須

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

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

タイプ: 長整数型

例: 756201191646691328
second_cta
任意

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

タイプ: 文字列

例: Browse Moments
second_cta_welcome_message_id
任意

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

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

タイプ: 長整数型

例: 926684855910800782
third_cta
任意

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

タイプ: 文字列

例: Play a bot song
third_cta_welcome_message_id
任意

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

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

タイプ: 長整数型

例: 948027689453946009
fourth_cta
任意

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

タイプ: 文字列

例: Play Twitter Trivia
fourth_cta_welcome_message_id
任意

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

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

タイプ: 長整数型

例: 913349640786179035

リクエストの例

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

応答の例

{
  "data": {
    "name": "direct message card",
    "first_cta": "DM me",
    "first_cta_welcome_message_id": "865707372148174852",
    "image_display_height": "418",
    "media_url": "https://pbs.twimg.com/media/DUfy_2JU8AAMAOk.jpg",
    "recipient_user_id": "756201191646691328",
    "id": "59wpi",
    "created_at": "2018-01-27T05:44:31Z",
    "media_key": "3_957000624519835648",
    "image_display_width": "800",
    "card_uri": "card://957127157993500678",
    "updated_at": "2018-01-27T05:44:31Z",
    "deleted": false,
    "card_type": "IMAGE_DIRECT_MESSAGE"
  },
  "request": {
    "params": {
      "name": "direct message card",
      "first_cta": "DM me",
      "first_cta_welcome_message_id": "865707372148174852",
      "image_display_height": "418",
      "media_url": "https://pbs.twimg.com/media/DUfy_2JU8AAMAOk.jpg",
      "recipient_user_id": "756201191646691328",
      "media_key": "3_957000624519835648",
      "account_id": "18ce54d4x5t",
      "image_display_width": "800",
      "card_type": "IMAGE_DIRECT_MESSAGE"
    }
  }
}

PUT accounts/:account_id/cards/image_direct_message

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

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

リソースURL

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

パラメーター

名前 説明
account_id
必須

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

タイプ: 文字列

例: 18ce54d4x5t
card_id
必須

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

タイプ: 文字列

例: 4zi61
first_cta
任意

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

タイプ: 文字列

例: Tell me a joke
first_cta_welcome_message_id
任意

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

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

タイプ: 長整数型

例: 910471490455820676
second_cta
任意

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

タイプ: 文字列

例: Browse Moments
second_cta_welcome_message_id
任意

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

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

タイプ: 長整数型

例: 933687438848534839
third_cta
任意

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

タイプ: 文字列

例: Play a bot song
third_cta_welcome_message_id
任意

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

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

タイプ: 長整数型

例: 936485028098425302
fourth_cta
任意

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

タイプ: 文字列

例: Play Twitter Trivia
fourth_cta_welcome_message_id
任意

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

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

タイプ: 長整数型

例: 919658669896157121
media_key
任意

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

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

注: 画像幅が800ピクセル以上で、幅と高さのアスペクト比が1.91:1である必要があります。

タイプ: 文字列

例: 3_1151345051104991073
name
任意

カードの名前。

タイプ: 文字列

例: space card

リクエストの例

PUT https://ads-api.x.com/10/accounts/18ce54d4x5t/cards/image_direct_message/59wpi?name=space card

応答の例

{
  "data": {
    "name": "space card",
    "first_cta": "DM me",
    "first_cta_welcome_message_id": "865707372148174852",
    "image_display_height": "418",
    "media_url": "https://pbs.twimg.com/media/DUfy_2JU8AAMAOk.jpg",
    "recipient_user_id": "756201191646691328",
    "id": "59wpi",
    "created_at": "2018-01-27T05:44:31Z",
    "media_key": "3_957000624519835648",
    "image_display_width": "800",
    "card_uri": "card://957127157993500678",
    "updated_at": "2018-01-30T01:33:49Z",
    "deleted": false,
    "card_type": "IMAGE_DIRECT_MESSAGE"
  },
  "request": {
    "params": {
      "account_id": "18ce54d4x5t",
      "card_type": "IMAGE_DIRECT_MESSAGE",
      "card_id": "59wpi",
      "name": "space card"
    }
  }
}

DELETE accounts/:account_id/cards/image_direct_message/:card_id

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

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

リソースURL

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

パラメーター

名前 説明
account_id
必須

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

タイプ: 文字列

例: 18ce54d4x5t
card_id
必須

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

タイプ: 文字列

例: 4zi61

リクエストの例

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

応答の例

{
  "data": {
    "name": "DM card",
    "id": "4zi61",
    "created_at": "2017-11-05T06:17:13Z",
    "updated_at": "2017-11-05T06:37:21Z",
    "deleted": true,
    "card_type": "IMAGE_DIRECT_MESSAGE"
  },
  "request": {
    "params": {
      "card_id": "4zi61",
      "card_type": "image_direct_message",
      "account_id": "18ce54d4x5t"
    }
  }
}