動画ウェブサイトカード
注: カードをツイートに関連付けるには、POST accounts/:account_id/tweet、POST statuses/update、またはPOST accounts/:account_id/scheduled_tweetsエンドポイントでcard_uri
パラメーターを使います。
GET accounts/:account_id/cards/video_website¶
現在のアカウントに関連付けられている一部またはすべての動画ウェブサイトカードの詳細を取得します。
リソースURL¶
https://ads-api.x.com/10/accounts/:account_id/cards/video_website
パラメーター¶
名前 | 説明 |
---|---|
account_id 必須 |
利用するアカウントのID。リソースのパス内に表示され、通常、GET accountsを除くすべての広告主APIリクエストに必須のパラメーターです。指定するアカウントは、認証済みユーザーに関連付けられている必要があります。 タイプ: 文字列 例: |
card_ids 任意 |
カンマ区切りのIDリストを指定して、応答の範囲を目的の動画ウェブサイトカードのみに設定します。最大200件のIDを指定できます。 タイプ: 文字列 例: |
count 任意 |
個別のリクエストごとに試行および取得するレコード数を指定します。 タイプ: 整数 デフォルト: 200 最小、最大: 1 、1000 |
cursor 任意 |
結果の次のページを取得するためのカーソルを指定します。詳細については、「ページネーション」を参照してください。 タイプ: 文字列 例: |
q 任意 |
注: プレフィックスの一致は大文字と小文字を区別します。 タイプ: 文字列 例: |
sort_by 任意 |
サポートされている属性で昇順または降順に並べ替えます。詳細については、「並べ替え」を参照してください。 タイプ: 文字列 例: |
with_deleted 任意 |
削除した結果をリクエストに含めます。 タイプ: ブール値 デフォルト: false 使用可能な値: true 、false |
with_total_count 任意 |
注: このパラメーターと 注: タイプ: ブール値 デフォルト: false 使用可能な値: true 、false |
リクエストの例¶
GET https://ads-api.x.com/10/accounts/18ce54d4x5t/cards/video_website?card_ids=5a4vf
応答の例¶
{
"request": {
"params": {
"card_type": "video_website",
"card_ids": [
"5a4vf"
],
"account_id": "18ce54d4x5t"
}
},
"next_cursor": null,
"data": [
{
"video_poster_height": "9",
"name": "video website card",
"website_shortened_url": "https://t.co/zadeUSVD18",
"video_height": "9",
"media_url": "https://video.twimg.com/amplify_video/vmap/958224897255211013.vmap",
"content_duration_seconds": "8",
"video_owner_id": "756201191646691328",
"media_key": "13_958224897255211013",
"website_display_url": "developer.twitter.com",
"id": "5a4vf",
"video_width": "16",
"website_dest_url": "https://developer.twitter.com",
"created_at": "2018-01-30T06:30:01Z",
"card_uri": "card://958225772740714496",
"title": "Twitter Developers",
"website_url": "https://developer.twitter.com",
"updated_at": "2018-01-30T06:30:01Z",
"poster_media_url": "https://pbs.twimg.com/amplify_video_thumb/958224897255211013/img/EnyDab6vErGm4Avd.jpg",
"video_poster_width": "16",
"deleted": false,
"card_type": "VIDEO_WEBSITE"
}
]
}
GET accounts/:account_id/cards/video_website/:card_id¶
現在のアカウントに関連付けられている特定の動画ウェブサイトカードを取得します。
リソースURL¶
https://ads-api.x.com/10/accounts/:account_id/cards/video_website/:card_id
パラメーター¶
名前 | 説明 |
---|---|
account_id 必須 |
利用するアカウントのID。リソースのパス内に表示され、通常、GET accountsを除くすべての広告主APIリクエストに必須のパラメーターです。指定するアカウントは、認証済みユーザーに関連付けられている必要があります。 タイプ: 文字列 例: |
card_id 必須 |
リクエスト内で操作する動画ウェブサイトカードへの参照。 タイプ: 文字列 例: |
with_deleted 任意 |
削除した結果をリクエストに含めます。 タイプ: ブール値 デフォルト: false 使用可能な値: true 、false |
リクエストの例¶
GET https://ads-api.x.com/10/accounts/18ce54d4x5t/cards/video_website/5a4vf
応答の例¶
{
"request": {
"params": {
"card_type": "video_website",
"card_id": "5a4vf",
"account_id": "18ce54d4x5t"
}
},
"data": {
"video_poster_height": "9",
"name": "video website card",
"website_shortened_url": "https://t.co/zadeUSVD18",
"video_height": "9",
"media_url": "https://video.twimg.com/amplify_video/vmap/958224897255211013.vmap",
"content_duration_seconds": "8",
"video_owner_id": "756201191646691328",
"media_key": "13_958224897255211013",
"website_display_url": "developer.twitter.com",
"id": "5a4vf",
"video_width": "16",
"website_dest_url": "https://developer.twitter.com",
"created_at": "2018-01-30T06:30:01Z",
"card_uri": "card://958225772740714496",
"title": "Twitter Developers",
"website_url": "https://developer.twitter.com",
"updated_at": "2018-01-30T06:30:01Z",
"poster_media_url": "https://pbs.twimg.com/amplify_video_thumb/958224897255211013/img/EnyDab6vErGm4Avd.jpg",
"video_poster_width": "16",
"deleted": false,
"card_type": "VIDEO_WEBSITE"
}
}
POST accounts/:account_id/cards/video_website¶
指定されたアカウントに関連付けられている新しい動画ウェブサイトカードを作成します。
リソースURL¶
https://ads-api.x.com/10/accounts/:account_id/cards/video_website
パラメーター¶
名前 | 説明 |
---|---|
account_id 必須 |
利用するアカウントのID。リソースのパス内に表示され、通常、GET accountsを除くすべての広告主APIリクエストに必須のパラメーターです。指定するアカウントは、認証済みユーザーに関連付けられている必要があります。 タイプ: 文字列 例: |
media_key 必須 |
このカードでは動画のメディアキーが使用されます。 注: このビデオはアカウントのメディアライブラリ内にある必要があります。 注: アスペクト比は16:9または1:1である必要があります。 タイプ: 文字列 例: |
name 必須 |
カードの名前。最大長: 80文字。 タイプ: 文字列 例: |
title 必須 |
カードのタイトル。最大長: 70文字。 タイプ: 文字列 例: |
website_url 必須 |
ユーザーのリダイレクト先となるウェブサイトのURL。 タイプ: 文字列 例: |
リクエストの例¶
POST https://ads-api.x.com/10/accounts/18ce54d4x5t/cards/video_website?name=video website card&title=Twitter Developers&media_key=13_958224897255211013&website_url=https://developer.twitter.com
応答の例¶
{
"data": {
"video_poster_height": "9",
"name": "video website card",
"website_shortened_url": "https://t.co/zadeUSVD18",
"video_height": "9",
"media_url": "https://video.twimg.com/amplify_video/vmap/958224897255211013.vmap",
"content_duration_seconds": "8",
"video_owner_id": "756201191646691328",
"media_key": "13_958224897255211013",
"website_display_url": "developer.twitter.com",
"id": "5a4vf",
"video_width": "16",
"website_dest_url": "https://developer.twitter.com",
"created_at": "2018-01-30T06:30:01Z",
"card_uri": "card://958225772740714496",
"title": "Twitter Developers",
"website_url": "https://developer.twitter.com",
"updated_at": "2018-01-30T06:30:01Z",
"poster_media_url": "https://pbs.twimg.com/amplify_video_thumb/958224897255211013/img/EnyDab6vErGm4Avd.jpg",
"video_poster_width": "16",
"deleted": false,
"card_type": "VIDEO_WEBSITE"
},
"request": {
"params": {
"video_poster_height": "9",
"name": "video website card",
"website_shortened_url": "https://t.co/zadeUSVD18",
"video_height": "9",
"media_url": "https://video.twimg.com/amplify_video/vmap/958224897255211013.vmap",
"content_duration_seconds": "8",
"video_stream_content_type": "video/mp4; codecs="avc1.42E01E, mp4a.40.2"",
"video_owner_id": "756201191646691328",
"media_key": "13_958224897255211013",
"website_display_url": "developer.twitter.com",
"account_id": "18ce54d4x5t",
"video_width": "16",
"website_dest_url": "https://developer.twitter.com",
"title": "Twitter Developers",
"website_url": "https://developer.twitter.com",
"poster_media_url": "https://pbs.twimg.com/amplify_video_thumb/958224897255211013/img/EnyDab6vErGm4Avd.jpg",
"video_poster_width": "16",
"card_type": "VIDEO_WEBSITE"
}
}
}
PUT accounts/:account_id/cards/video_website/:card_id¶
現在のアカウントに属する、指定した動画ウェブサイトカードを更新します。
リソースURL¶
https://ads-api.x.com/10/accounts/:account_id/cards/video_website/:card_id
パラメーター¶
名前 | 説明 |
---|---|
account_id 必須 |
利用するアカウントのID。リソースのパス内に表示され、通常、GET accountsを除くすべての広告主APIリクエストに必須のパラメーターです。指定するアカウントは、認証済みユーザーに関連付けられている必要があります。 タイプ: 文字列 例: |
card_id 必須 |
リクエスト内で操作する動画ウェブサイトカードへの参照。 タイプ: 文字列 例: |
media_key 任意 |
このカードでは動画のメディアキーが使用されます。 注: このビデオはアカウントのメディアライブラリ内にある必要があります。 注: アスペクト比は16:9または1:1である必要があります。 タイプ: 文字列 例: |
name 任意 |
カードの名前。最大長: 80文字。 タイプ: 文字列 例: |
title 任意 |
カードのタイトル。最大長: 70文字。 タイプ: 文字列 例: |
website_url 任意 |
ユーザーのリダイレクト先となるウェブサイトのURL。 タイプ: 文字列 例: |
リクエストの例¶
PUT https://ads-api.x.com/10/accounts/18ce54d4x5t/cards/video_website/5a4vf?name=star card
応答の例¶
{
"data": {
"video_poster_height": "9",
"name": "stars card",
"website_shortened_url": "https://t.co/zadeUSVD18",
"video_height": "9",
"media_url": "https://video.twimg.com/amplify_video/vmap/958224897255211013.vmap",
"content_duration_seconds": "8",
"video_owner_id": "756201191646691328",
"media_key": "13_958224897255211013",
"website_display_url": "developer.twitter.com",
"id": "5a4vf",
"video_width": "16",
"website_dest_url": "https://developer.twitter.com",
"created_at": "2018-01-30T06:30:01Z",
"card_uri": "card://958225772740714496",
"title": "Twitter Developers",
"website_url": "https://developer.twitter.com",
"updated_at": "2018-01-30T06:47:51Z",
"poster_media_url": "https://pbs.twimg.com/amplify_video_thumb/958224897255211013/img/EnyDab6vErGm4Avd.jpg",
"video_poster_width": "16",
"deleted": false,
"card_type": "VIDEO_WEBSITE"
},
"request": {
"params": {
"account_id": "18ce54d4x5t",
"card_type": "VIDEO_WEBSITE",
"card_id": "5a4vf",
"name": "stars card"
}
}
}
DELETE accounts/:account_id/cards/video_website/:card_id¶
現在のアカウントに属する、指定した動画ウェブサイトカードを完全に削除します。
注: これは物理的な削除です。このため、削除したカードを取得することはできません。
リソースURL¶
https://ads-api.x.com/10/accounts/:account_id/cards/video_website/:card_id
パラメーター¶
名前 | 説明 |
---|---|
account_id 必須 |
利用するアカウントのID。リソースのパス内に表示され、通常、GET accountsを除くすべての広告主APIリクエストに必須のパラメーターです。指定するアカウントは、認証済みユーザーに関連付けられている必要があります。 タイプ: 文字列 例: |
card_id 必須 |
リクエスト内で操作する動画ウェブサイトカードへの参照。 タイプ: 文字列 例: |
リクエストの例¶
DELETE https://ads-api.x.com/10/accounts/18ce54d4x5t/cards/video_website/4h053
応答の例¶
{
"data": {
"name": "twitter blog card",
"id": "4h053",
"created_at": "2017-07-01T00:23:06Z",
"updated_at": "2017-07-01T00:28:31Z",
"deleted": true,
"card_type": "VIDEO_WEBSITE"
},
"request": {
"params": {
"card_id": "4h053",
"account_id": "18ce54d4x5t"
}
}
}