クリエイティブ

投票カード

Postmanで実行 ❯

GET accounts/:account_id/cards/poll

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

リソースURL

https://ads-api.twitter.com/10/accounts/:account_id/cards/poll

パラメーター

名前 説明
account_id
必須

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

タイプ: 文字列

例: 18ce54d4x5t
card_ids
任意

カンマ区切りのIDリストを指定して、応答の範囲を目的の投票カードのみに設定します。最大200件のIDを指定できます。

タイプ: 文字列

例: 57i77
count
任意

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

タイプ: 整数

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

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

タイプ: 文字列

例: 8x7v00oow
q
任意

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

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

タイプ: 文字列

例: night
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.twitter.com/10/accounts/18ce54d4x5t/cards/poll?card_ids=57i77

応答の例

{
  "request": {
    "params": {
      "card_type": "poll",
      "card_ids": [
        "57i77"
      ],
      "account_id": "18ce54d4x5t"
    }
  },
  "next_cursor": null,
  "data": [
    {
      "video_poster_height": "9",
      "name": "best coast poll",
      "start_time": "2018-01-09T04:51:34Z",
      "first_choice": "East",
      "video_height": "9",
      "video_url": "https://video.twimg.com/amplify_video/vmap/950589518557540353.vmap",
      "content_duration_seconds": "8",
      "second_choice": "West",
      "end_time": "2018-01-16T04:51:34Z",
      "id": "57i77",
      "video_width": "16",
      "video_hls_url": "https://video.twimg.com/amplify_video/950589518557540353/vid/1280x720/BRkAhPxFoBREIaFA.mp4",
      "created_at": "2018-01-09T04:51:34Z",
      "duration_in_minutes": "10080",
      "card_uri": "card://950590850777497601",
      "updated_at": "2018-01-09T04:51:34Z",
      "video_poster_url": "https://pbs.twimg.com/amplify_video_thumb/950589518557540353/img/nZ1vX_MXYqmvbsXP.jpg",
      "video_poster_width": "16",
      "deleted": false,
      "card_type": "VIDEO_POLLS"
    }
  ]
}

GET accounts/:account_id/cards/poll/:card_id

現在のアカウントに関連付けられている特定の投票カードを取得します。

リソースURL

https://ads-api.twitter.com/10/accounts/:account_id/cards/poll/:card_id

パラメーター

名前 説明
account_id
必須

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

タイプ: 文字列

例: 18ce54d4x5t
card_id
必須

リクエスト内で操作する投票カードへの参照。

タイプ: 文字列

例: 57i8t
with_deleted
任意

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

タイプ: ブール値

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

リクエストの例

GET https://ads-api.twitter.com/10/accounts/18ce54d4x5t/cards/poll/57i8t

応答の例

{
  "request": {
    "params": {
      "card_type": "poll",
      "card_id": "57i8t",
      "account_id": "18ce54d4x5t"
    }
  },
  "data": {
    "name": "text only poll",
    "start_time": "2018-01-09T05:03:05Z",
    "first_choice": "Morning",
    "second_choice": "Evening",
    "end_time": "2018-01-11T05:03:05Z",
    "id": "57i8t",
    "created_at": "2018-01-09T05:03:05Z",
    "duration_in_minutes": "2880",
    "card_uri": "card://950593749658189824",
    "updated_at": "2018-01-09T05:03:05Z",
    "deleted": false,
    "card_type": "TEXT_POLLS"
  }
}

POST accounts/:account_id/cards/poll

指定されたアカウントに関連付けられている新しい投票カードを作成します。このエンドポイントは画像、動画、メディアなしのいずれかの投票カードの作成をサポートします。メディア付き投票は、メディア転送投票と呼ばれます。

注: メディア転送投票はベータ版です。PROMOTED_MEDIA_POLLSアカウント機能が必要になります。

注: 投票カードを更新（PUT）することはできません。

リソースURL

https://ads-api.twitter.com/10/accounts/:account_id/cards/poll

パラメーター

名前 説明
account_id
必須

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

タイプ: 文字列

例: 18ce54d4x5t
duration_in_minutes
必須

投票が受け付け中になる時間（分）。指定したduration_in_minutesが経過すると、投票は締め切られ、受け付けられなくなります。これは応答のend_timeに対応します。

注: これはカードが作成されるとすぐに開始されます（ツイートに追加されたときではありません）。

タイプ: 整数

最小、最大: 5、10080
first_choice
必須

投票の最初の選択肢。最大長: 25文字。

タイプ: 文字列

例: One
name
必須

カードの名前。

タイプ: 文字列

例: poll card
second_choice
必須

投票の2つ目の選択肢。最大長: 25文字。

タイプ: 文字列

例: Two
fourth_choice
任意

投票の4つ目の選択肢。最大長: 25文字。

注: このパラメーターを使う際は、1つ目、2つ目、3つ目の選択肢を設定する必要があります。

タイプ: 文字列

例: Four
media_key
任意

このカードで使われるメディアライブラリ画像または動画のmedia_key。

このフィールドは書き込み専用です。応答でAPIからこのメディアのTwitter URLが提供されます。

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

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

投票の3つ目の選択肢。最大長: 25文字。

注: このパラメーターを使う際は、1つ目と2つ目の選択肢を設定する必要があります。

タイプ: 文字列

例: Three

リクエストの例

POST https://ads-api.twitter.com/10/accounts/18ce54d4x5t/cards/poll?duration_in_minutes=10080&first_choice=East&second_choice=West&media_key=13_950589518557540353&name=best coast poll

応答の例

{
  "request": {
    "params": {
      "first_choice": "East",
      "name": "best coast poll",
      "second_choice": "West",
      "media_key": "13_950589518557540353",
      "duration_in_minutes": 10080
    }
  },
  "data": {
    "video_poster_height": "9",
    "name": "best coast poll",
    "start_time": "2018-01-09T04:51:34Z",
    "first_choice": "East",
    "video_height": "9",
    "video_url": "https://video.twimg.com/amplify_video/vmap/950589518557540353.vmap",
    "content_duration_seconds": "8",
    "second_choice": "West",
    "end_time": "2018-01-16T04:51:34Z",
    "id": "57i77",
    "video_width": "16",
    "video_hls_url": "https://video.twimg.com/amplify_video/950589518557540353/vid/1280x720/BRkAhPxFoBREIaFA.mp4",
    "created_at": "2018-01-09T04:51:34Z",
    "duration_in_minutes": "10080",
    "card_uri": "card://950590850777497601",
    "updated_at": "2018-01-09T04:51:34Z",
    "video_poster_url": "https://pbs.twimg.com/amplify_video_thumb/950589518557540353/img/nZ1vX_MXYqmvbsXP.jpg",
    "video_poster_width": "16",
    "deleted": false,
    "card_type": "VIDEO_POLLS"
  }
}

DELETE accounts/:account_id/cards/poll/:card_id

現在のアカウントに属する、指定した投票カードを完全に削除します。

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

リソースURL

https://ads-api.twitter.com/10/accounts/:account_id/cards/poll/:card_id

パラメーター

名前 説明
account_id
必須

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

タイプ: 文字列

例: 18ce54d4x5t
card_id
必須

リクエスト内で操作する投票カードへの参照。

タイプ: 文字列

例: 57i9t

リクエストの例

DELETE https://ads-api.twitter.com/10/accounts/18ce54d4x5t/cards/poll/57i9t

応答の例

{
  "data": {
    "name": "poll with image",
    "start_time": "2018-01-09T05:10:51Z",
    "id": "57i9t",
    "created_at": "2018-01-09T05:10:51Z",
    "updated_at": "2018-01-09T05:11:04Z",
    "deleted": true,
    "card_type": "IMAGE_POLLS"
  },
  "request": {
    "params": {
      "card_id": "57i9t",
      "card_type": "poll",
      "account_id": "18ce54d4x5t"
    }
  }
}