クリエイティブ

ウェブサイトカード

Postmanで実行 ❯

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

GET accounts/:account_id/cards/website

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

リソースURL

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

パラメーター

名前 説明
account_id
必須

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

タイプ: 文字列

例: 18ce54d4x5t
card_ids
任意

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

タイプ: 文字列

例: 59wh0
count
任意

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

タイプ: 整数

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

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

タイプ: 文字列

例: 8x7v00oow
q
任意

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

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

タイプ: 文字列

例: shuttle
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/website?card_ids=59wh0

応答の例

{
  "request": {
    "params": {
      "card_type": "website",
      "card_ids": [
        "59wh0"
      ],
      "account_id": "18ce54d4x5t"
    }
  },
  "next_cursor": null,
  "data": [
    {
      "name": "website card",
      "website_shortened_url": "https://t.co/zadeUSVD18",
      "image_display_height": "418",
      "media_url": "https://pbs.twimg.com/media/DUKjmp8V4AAhrrB.jpg",
      "website_display_url": "developer.twitter.com",
      "id": "59wh0",
      "website_dest_url": "https://developer.twitter.com",
      "created_at": "2018-01-27T00:15:19Z",
      "media_key": "3_955505955445268480",
      "image_display_width": "800",
      "website_title": "Twitter Developers",
      "card_uri": "card://957044309437526017",
      "website_url": "https://developer.twitter.com",
      "updated_at": "2018-01-27T00:15:19Z",
      "deleted": false,
      "card_type": "WEBSITE"
    }
  ]
}

GET accounts/:account_id/cards/website/:card_id

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

リソースURL

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

パラメーター

名前 説明
account_id
必須

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

タイプ: 文字列

例: 18ce54d4x5t
card_id
必須

リクエスト内で操作するウェブサイトカードへの参照。

タイプ: 文字列

例: 59wh0
with_deleted
任意

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

タイプ: ブール値

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

リクエストの例

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

応答の例

{
  "request": {
    "params": {
      "card_type": "website",
      "card_id": "59wh0",
      "account_id": "18ce54d4x5t"
    }
  },
  "data": {
    "name": "website card",
    "website_shortened_url": "https://t.co/zadeUSVD18",
    "image_display_height": "418",
    "media_url": "https://pbs.twimg.com/media/DUKjmp8V4AAhrrB.jpg",
    "website_display_url": "developer.twitter.com",
    "id": "59wh0",
    "website_dest_url": "https://developer.twitter.com",
    "created_at": "2018-01-27T00:15:19Z",
    "media_key": "3_955505955445268480",
    "image_display_width": "800",
    "website_title": "Twitter Developers",
    "card_uri": "card://957044309437526017",
    "website_url": "https://developer.twitter.com",
    "updated_at": "2018-01-27T00:15:19Z",
    "deleted": false,
    "card_type": "WEBSITE"
  }
}

POST accounts/:account_id/cards/website

現在のアカウントに関連付けられている新しいウェブサイトカードを作成します。

リソースURL

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

パラメーター

名前 説明
account_id
必須

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

タイプ: 文字列

例: 18ce54d4x5t
media_key
必須

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

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

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

タイプ: 文字列

例: 3_1151345051104991073
name
必須

カードの名前。

タイプ: 文字列

例: website card
website_title
必須

カードのタイトル。

タイプ: 文字列

例: Twitter Developers
website_url
必須

ユーザーのリダイレクト先となるウェブサイトのURL。

タイプ: 文字列

例: https://developer.twitter.com

リクエストの例

POST https://ads-api.x.com/10/accounts/18ce54d4x5t/cards/website?media_key=3_955505955445268480&name=website card&website_title=Twitter Developers&website_url=https://developer.twitter.com

応答の例

{
  "data": {
    "name": "website card",
    "website_shortened_url": "https://t.co/zadeUSVD18",
    "image_display_height": "418",
    "media_url": "https://pbs.twimg.com/media/DUKjmp8V4AAhrrB.jpg",
    "website_display_url": "developer.twitter.com",
    "id": "59wh0",
    "website_dest_url": "https://developer.twitter.com",
    "created_at": "2018-01-27T00:15:19Z",
    "media_key": "3_955505955445268480",
    "image_display_width": "800",
    "website_title": "Twitter Developers",
    "card_uri": "card://957044309437526017",
    "website_url": "https://developer.twitter.com",
    "updated_at": "2018-01-27T00:15:19Z",
    "deleted": false,
    "card_type": "WEBSITE"
  },
  "request": {
    "params": {
      "name": "website card",
      "website_shortened_url": "https://t.co/zadeUSVD18",
      "image_display_height": "418",
      "media_url": "https://pbs.twimg.com/media/DUKjmp8V4AAhrrB.jpg",
      "media_key": "3_955505955445268480",
      "website_display_url": "developer.twitter.com",
      "account_id": "18ce54d4x5t",
      "website_dest_url": "https://developer.twitter.com",
      "image_display_width": "800",
      "website_title": "Twitter Developers",
      "website_url": "https://developer.twitter.com",
      "card_type": "WEBSITE"
    }
  }
}

PUT accounts/:account_id/cards/website/:card_id

現在のアカウントに属する、指定したウェブサイトカードを更新します。

リソースURL

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

パラメーター

名前 説明
account_id
必須

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

タイプ: 文字列

例: 18ce54d4x5t
card_id
必須

リクエスト内で操作するウェブサイトカードへの参照。

タイプ: 文字列

例: 4i91t
media_key
任意

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

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

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

タイプ: 文字列

例: 3_1151345051104991073
name
任意

カードの名前。

タイプ: 文字列

例: coffee card
website_title
任意

カードのタイトル。

タイプ: 文字列

例: Twitter Developers
website_url
任意

ユーザーのリダイレクト先となるウェブサイトのURL。

タイプ: 文字列

例: https://twittercommunity.com/c/advertiser-api

リクエストの例

PUT https://ads-api.x.com/10/accounts/18ce54d4x5t/cards/website/59w2c?name=coffee card

応答の例

{
  "data": {
    "name": "coffee card",
    "website_shortened_url": "https://t.co/TvmIOd0wXq",
    "image_display_height": "418",
    "media_url": "https://pbs.twimg.com/media/DUKjmp8V4AAhrrB.jpg",
    "website_display_url": "developer.twitter.com",
    "id": "59w2c",
    "website_dest_url": "https://developer.twitter.com/",
    "created_at": "2018-01-26T21:11:48Z",
    "media_key": "3_955505955445268480",
    "image_display_width": "800",
    "website_title": "Twitter Developers",
    "card_uri": "card://956998127856177153",
    "website_url": "https://developer.twitter.com/",
    "updated_at": "2018-01-27T00:20:18Z",
    "deleted": false,
    "card_type": "WEBSITE"
  },
  "request": {
    "params": {
      "account_id": "18ce54d4x5t",
      "card_type": "WEBSITE",
      "card_id": "59w2c",
      "name": "coffee card"
    }
  }
}

DELETE accounts/:account_id/cards/website/:card_id

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

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

リソースURL

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

パラメーター

名前 説明
account_id
必須

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

タイプ: 文字列

例: 18ce54d4x5t
card_id
必須

リクエスト内で操作するウェブサイトカードへの参照。

タイプ: 文字列

例: 4i91t

リクエストの例

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

応答の例

{
  "data": {
    "name": "website card",
    "id": "4i91t",
    "created_at": "2017-07-08T06:05:17Z",
    "updated_at": "2017-08-23T13:33:50Z",
    "deleted": true,
    "card_type": "WEBSITE"
  },
  "request": {
    "params": {
      "card_id": "4i91t",
      "card_type": "website",
      "account_id": "18ce54d4x5t"
    }
  }
}