クリエイティブ

動画アプリダウンロードカード

Postmanで実行 ❯

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

GET accounts/:account_id/cards/video_app_download

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

このカードはモバイルアプリプロモーション商品スイートの一部です。

リソースURL

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

パラメーター

名前 説明
account_id
必須

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

タイプ: 文字列

例: 18ce54d4x5t
card_ids
任意

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

タイプ: 文字列

例: 5a4z3
count
任意

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

タイプ: 整数

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

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

タイプ: 文字列

例: 8x7v00oow
q
任意

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

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

タイプ: 文字列

例: twitter
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_app_download?card_ids=5a4z3

応答の例

{
  "request": {
    "params": {
      "card_type": "video_app_download",
      "card_ids": [
        "5a4z3"
      ],
      "account_id": "18ce54d4x5t"
    }
  },
  "next_cursor": null,
  "data": [
    {
      "name": "video app download",
      "googleplay_app_id": "com.twitter.android",
      "media_url": "https://video.twimg.com/amplify_video/vmap/958231855240589313.vmap",
      "video_owner_id": "756201191646691328",
      "media_key": "13_958231855240589313",
      "id": "5a4z3",
      "country_code": "US",
      "created_at": "2018-01-30T07:00:24Z",
      "card_uri": "card://958233417929261056",
      "updated_at": "2018-01-30T07:00:24Z",
      "poster_media_url": "https://pbs.twimg.com/amplify_video_thumb/958231855240589313/img/rjhswYG084qYYgF6.jpg",
      "app_cta": "INSTALL",
      "deleted": false,
      "card_type": "VIDEO_APP_DOWNLOAD"
    }
  ]
}

GET accounts/:account_id/cards/video_app_download/:card_id

現在のアカウントに関連付けられている特定の動画アプリダウンロードカードを取得します。

このカードはモバイルアプリプロモーション商品スイートの一部です。

リソースURL

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

パラメーター

名前 説明
account_id
必須

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

タイプ: 文字列

例: 18ce54d4x5t
card_id
必須

リクエスト内で操作する動画アプリダウンロードカードへの参照。

タイプ: 文字列

例: 5a4z3
with_deleted
任意

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

タイプ: ブール値

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

リクエストの例

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

応答の例

{
  "request": {
    "params": {
      "card_type": "video_app_download",
      "card_id": "5a4z3",
      "account_id": "18ce54d4x5t"
    }
  },
  "data": {
    "name": "video app download",
    "googleplay_app_id": "com.twitter.android",
    "media_url": "https://video.twimg.com/amplify_video/vmap/958231855240589313.vmap",
    "video_owner_id": "756201191646691328",
    "media_key": "13_958231855240589313",
    "id": "5a4z3",
    "country_code": "US",
    "created_at": "2018-01-30T07:00:24Z",
    "card_uri": "card://958233417929261056",
    "updated_at": "2018-01-30T07:00:24Z",
    "poster_media_url": "https://pbs.twimg.com/amplify_video_thumb/958231855240589313/img/rjhswYG084qYYgF6.jpg",
    "app_cta": "INSTALL",
    "deleted": false,
    "card_type": "VIDEO_APP_DOWNLOAD"
  }
}

POST accounts/:account_id/cards/video_app_download

現在のアカウントに関連付けられている新しい動画アプリダウンロードカードを作成します。

このカードはモバイルアプリプロモーション商品スイートの一部です。

リソースURL

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

パラメーター

名前 説明
account_id
必須

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

タイプ: 文字列

例: 18ce54d4x5t
country_code
必須

アプリが販売されている国の2文字のISOコード。

タイプ: 文字列

例: US
media_key
必須

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

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

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

タイプ: 文字列

例: 13_1168079965037467209
name
必須

カードの名前。

タイプ: 文字列

例: video app download card
ipad_app_id
必須の場合あり

iPadアプリID。

注: ipad_app_id、iphone_app_id、googleplay_app_idの1つ以上が必須となります。

注: 指定しない場合、提供されていればiphone_app_id値に設定されます。

注: これはApple App Store URLから取得できます。

タイプ: 長整数型

例: 333903271
iphone_app_id
必須の場合あり

iPhoneアプリID。

注: ipad_app_id、iphone_app_id、googleplay_app_idの1つ以上が必須となります。

注: これはApple App Store URLから取得できます。

タイプ: 長整数型

例: 333903271
googleplay_app_id
必須の場合あり

Google Playアプリケーションパッケージの名前。

注: ipad_app_id、iphone_app_id、googleplay_app_idの1つ以上が必須となります。

タイプ: 文字列

例: com.twitter.android
app_cta
任意

カードボタンのアクション誘導（CTA）テキスト。

タイプ: 列挙

使用可能な値: BOOK、CONNECT、INSTALL、OPEN、ORDER、PLAY、SHOP
ipad_deep_link
任意

宣伝しているiPadアプリへのディープリンク。

注: ipad_app_idが提供されている場合にのみ利用できます。

注: 指定しない場合、提供されていればiphone_deep_link値に設定されます。

タイプ: 文字列
iphone_deep_link
任意

宣伝しているiPhoneアプリへのディープリンク。

注: iphone_app_idが提供されている場合にのみ利用できます。

タイプ: 文字列
googleplay_deep_link
任意

宣伝しているAndroidアプリへのディープリンク。

注: googleplay_app_idが提供されている場合にのみ利用できます。

タイプ: 文字列
poster_media_key
任意

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

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

タイプ: 長整数型

例: 3_882726458191298561

リクエストの例

POST https://ads-api.x.com/10/accounts/18ce54d4x5t/cards/video_app_download?country_code=US&name=video app download&media_key=13_958231855240589313&googleplay_app_id=com.twitter.android

応答の例

{
  "data": {
    "name": "video app download",
    "googleplay_app_id": "com.twitter.android",
    "media_url": "https://video.twimg.com/amplify_video/vmap/958231855240589313.vmap",
    "video_owner_id": "756201191646691328",
    "media_key": "13_958231855240589313",
    "id": "5a4z3",
    "country_code": "US",
    "created_at": "2018-01-30T07:00:24Z",
    "card_uri": "card://958233417929261056",
    "updated_at": "2018-01-30T07:00:24Z",
    "poster_media_url": "https://pbs.twimg.com/amplify_video_thumb/958231855240589313/img/rjhswYG084qYYgF6.jpg",
    "app_cta": "INSTALL",
    "deleted": false,
    "card_type": "VIDEO_APP_DOWNLOAD"
  },
  "request": {
    "params": {
      "name": "video app download",
      "googleplay_app_id": "com.twitter.android",
      "media_url": "https://video.twimg.com/amplify_video/vmap/958231855240589313.vmap",
      "video_stream_content_type": "video/mp4; codecs="avc1.42E01E, mp4a.40.2"",
      "video_owner_id": "756201191646691328",
      "media_key": "13_958231855240589313",
      "account_id": "18ce54d4x5t",
      "country_code": "US",
      "poster_media_url": "https://pbs.twimg.com/amplify_video_thumb/958231855240589313/img/rjhswYG084qYYgF6.jpg",
      "app_cta": "INSTALL",
      "card_type": "VIDEO_APP_DOWNLOAD"
    }
  }
}

PUT accounts/:account_id/cards/video_app_download/:card_id

現在のアカウントに属する、指定した動画アプリダウンロードカードを更新します。

このカードはモバイルアプリプロモーション商品スイートの一部です。

リソースURL

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

パラメーター

名前 説明
account_id
必須

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

タイプ: 文字列

例: 18ce54d4x5t
card_id
必須

リクエスト内で操作する動画アプリダウンロードカードへの参照。

タイプ: 文字列

例: 5a4z3
country_code
任意

アプリが販売されている国の2文字のISOコード。

タイプ: 文字列

例: US
app_cta
任意

カードボタンのアクション誘導（CTA）テキスト。

タイプ: 列挙

使用可能な値: BOOK、CONNECT、INSTALL、OPEN、ORDER、PLAY、SHOP
ipad_app_id
任意

iPadアプリID。

注: ipad_app_id、iphone_app_id、googleplay_app_idの1つ以上が必須となります。

注: iphone_app_idが指定されているものの、これ以外の場合、iPhoneアプリ値が設定されます。

注: これはApple App Store URLから取得できます。

タイプ: 長整数型

例: 333903271
ipad_deep_link
任意

宣伝しているiPadアプリへのディープリンク。

注: ipad_app_idが提供されている場合にのみ利用できます。

注: iphone_deep_linkが指定されているものの、これ以外の場合、iPhoneディープリンク値が設定されます。

タイプ: 文字列
iphone_app_id
任意

iPhoneアプリID。

注: ipad_app_id、iphone_app_id、googleplay_app_idの1つ以上が必須となります。

注: これはApple App Store URLから取得できます。

タイプ: 長整数型

例: 333903271
iphone_deep_link
任意

宣伝しているiPhoneアプリへのディープリンク。

注: iphone_app_idが提供されている場合にのみ利用できます。

タイプ: 文字列
googleplay_app_id
任意

Google Playアプリケーションパッケージの名前。

注: ipad_app_id、iphone_app_id、googleplay_app_idの1つ以上が必須となります。

タイプ: 文字列

例: com.twitter.android
googleplay_deep_link
任意

宣伝しているAndroidアプリへのディープリンク。

注: googleplay_app_idが提供されている場合にのみ利用できます。

タイプ: 文字列
media_key
任意

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

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

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

タイプ: 文字列

例: 13_1168079965037467209
name
任意

カードの名前。

タイプ: 文字列

例: aerial card
poster_media_key
任意

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

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

タイプ: 長整数型

例: 3_882726458191298561

リクエストの例

PUT https://ads-api.x.com/10/accounts/18ce54d4x5t/cards/video_app_download/5a4z3?name=aerial card

応答の例

{
  "data": {
    "name": "aerial card",
    "media_url": "https://video.twimg.com/amplify_video/vmap/958231855240589313.vmap",
    "video_owner_id": "756201191646691328",
    "media_key": "13_958231855240589313",
    "id": "5a4z3",
    "created_at": "2018-01-30T07:00:24Z",
    "card_uri": "card://958233417929261056",
    "updated_at": "2018-01-30T07:32:00Z",
    "poster_media_url": "https://pbs.twimg.com/amplify_video_thumb/958231855240589313/img/rjhswYG084qYYgF6.jpg",
    "app_cta": "install",
    "deleted": false,
    "card_type": "VIDEO_APP_DOWNLOAD"
  },
  "request": {
    "params": {
      "account_id": "18ce54d4x5t",
      "card_type": "VIDEO_APP_DOWNLOAD",
      "card_id": "5a4z3",
      "name": "aerial card"
    }
  }
}

DELETE accounts/:account_id/cards/video_app_download/:card_id

現在のアカウントに属する、指定した動画アプリダウンロードカードを完全に削除します。

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

このカードはモバイルアプリプロモーション商品スイートの一部です。

リソースURL

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

パラメーター

名前 説明
account_id
必須

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

タイプ: 文字列

例: 18ce54d4x5t
card_id
必須

リクエスト内で操作する動画アプリダウンロードカードへの参照。

タイプ: 文字列

例: 4hug6

リクエストの例

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

応答の例

{
  "data": {
    "name": "video app download",
    "id": "4hug6",
    "created_at": "2017-07-05T23:01:42Z",
    "updated_at": "2017-08-23T13:21:40Z",
    "deleted": true,
    "card_type": "VIDEO_APP_DOWNLOAD"
  },
  "request": {
    "params": {
      "card_id": "4hug6",
      "card_type": "video_app_download",
      "account_id": "18ce54d4x5t"
    }
  }
}