プロモツイート
GET accounts/:account_id/promoted_tweets¶
現在のアカウントの行項目に関連付けられているツイートへの参照を取得します。
ツイートオブジェクトを取得するには、GET accounts/:account_id/tweetsを使用します。promoted_tweetsの各オブジェクトには、tweet_id
の値を使用します。
注: 親の行項目が削除された場合、promoted_tweetsはリクエストにwith_deleted=true
が指定されている場合にのみ返されます。これらのpromoted_tweetsは、実際には削除されていません(応答は"deleted": false
)。
リソースURL¶
https://ads-api.x.com/10/accounts/:account_id/promoted_tweets
パラメーター¶
名前 | 説明 |
---|---|
account_id 必須 |
利用するアカウントのID。リソースのパス内に表示され、通常、GET accountsを除くすべての広告主APIリクエストに必須のパラメーターです。指定するアカウントは、認証済みユーザーに関連付けられている必要があります。 タイプ: 文字列 例: |
count 任意 |
個別のリクエストごとに試行および取得するレコード数を指定します。 タイプ: 整数 デフォルト: 200 最小、最大: 1 、1000 |
cursor 任意 |
結果の次のページを取得するためのカーソルを指定します。詳細については、「ページネーション」を参照してください。 タイプ: 文字列 例: |
line_item_ids 任意 |
カンマ区切りのIDリストを指定して、応答の範囲を特定の行項目に関連付けられているツイートのみに設定します。最大200件のIDを指定できます。 タイプ: 文字列 例: |
promoted_tweet_ids 任意 |
カンマ区切りのIDリストを指定して、応答の範囲を目的のプロモツイートのみに設定します。最大200件のIDを指定できます。 タイプ: 文字列 例: |
sort_by 任意 |
サポートされている属性で昇順または降順に並べ替えます。詳細については、「並べ替え」を参照してください。 タイプ: 文字列 例: |
with_deleted 任意 |
削除した結果をリクエストに含めます。 タイプ: ブール値 デフォルト: false 使用可能な値: true 、false |
with_total_count 任意 |
注: このパラメーターと 注: タイプ: ブール値 デフォルト: false 使用可能な値: true 、false |
リクエストの例¶
GET https://ads-api.x.com/10/accounts/18ce54d4x5t/promoted_tweets?promoted_tweet_ids=1efwlo
応答の例¶
{
"request": {
"params": {
"promoted_tweet_ids": [
"1efwlo"
],
"account_id": "18ce54d4x5t"
}
},
"next_cursor": null,
"data": [
{
"line_item_id": "96uzp",
"id": "1efwlo",
"entity_status": "ACTIVE",
"created_at": "2017-06-29T05:06:57Z",
"updated_at": "2017-06-29T05:08:46Z",
"approval_status": "ACCEPTED",
"tweet_id": "880290790664060928",
"deleted": false
}
]
}
GET accounts/:account_id/promoted_tweets/:promoted_tweet_id¶
現在のアカウントの行項目に関連付けられているツイートへの特定の参照を取得します。
注: 親の行項目が削除された場合、promoted_tweetsはリクエストにwith_deleted=true
が指定されている場合にのみ返されます。これらのpromoted_tweetsは、実際には削除されていません(応答は"deleted": false
)。
リソースURL¶
https://ads-api.x.com/10/accounts/:account_id/promoted_tweets/:promoted_tweet_id
パラメーター¶
名前 | 説明 |
---|---|
account_id 必須 |
利用するアカウントのID。リソースのパス内に表示され、通常、GET accountsを除くすべての広告主APIリクエストに必須のパラメーターです。指定するアカウントは、認証済みユーザーに関連付けられている必要があります。 タイプ: 文字列 例: |
promoted_tweet_id 必須 |
リクエスト内で操作するプロモツイートへの参照。 タイプ: 文字列 例: |
with_deleted 任意 |
削除した結果をリクエストに含めます。 タイプ: ブール値 デフォルト: false 使用可能な値: true 、false |
リクエストの例¶
GET https://ads-api.x.com/10/accounts/18ce54d4x5t/promoted_tweets/1efwlo
応答の例¶
{
"request": {
"params": {
"promoted_tweet_id": "1efwlo",
"account_id": "18ce54d4x5t"
}
},
"data": {
"line_item_id": "96uzp",
"id": "1efwlo",
"entity_status": "ACTIVE",
"created_at": "2017-06-29T05:06:57Z",
"updated_at": "2017-06-29T05:08:46Z",
"approval_status": "ACCEPTED",
"tweet_id": "880290790664060928",
"deleted": false
}
}
POST accounts/:account_id/promoted_tweets¶
指定した行項目に1つ以上のツイートを関連付けます。キャンペーンの目的によっては、すべてのツイートがプロモーションに適しているわけではありません。詳細については、「目的ベースのキャンペーン」を参照してください。
PROMOTED_ACCOUNT
商品タイプを使用する場合、ツイートをline_item
に関連付けると、標準のPROMOTED_ACCOUNT
配置に加えて、タイムライン配置がモバイルに追加されます。
注: プロモツイートエンティティを更新(PUT)することはできません。
リソースURL¶
https://ads-api.x.com/10/accounts/:account_id/promoted_tweets
パラメーター¶
名前 | 説明 |
---|---|
account_id 必須 |
利用するアカウントのID。リソースのパス内に表示され、通常、GET accountsを除くすべての広告主APIリクエストに必須のパラメーターです。指定するアカウントは、認証済みユーザーに関連付けられている必要があります。 タイプ: 文字列 例: |
line_item_id 必須 |
リクエスト内で操作する行項目への参照。 タイプ: 文字列 例: |
tweet_ids 必須 |
特定のツイートに対応するIDのカンマ区切りのリスト。最大50件のIDを指定できます。 タイプ: 長整数型 例: |
リクエストの例¶
POST https://ads-api.x.com/10/accounts/18ce54d4x5t/promoted_tweets?line_item_id=8v7jo&tweet_ids=822333526255120384
応答の例¶
{
"data": [
{
"line_item_id": "8v7jo",
"id": "1e8i2k",
"entity_status": "ACTIVE",
"created_at": "2017-06-24T04:21:36Z",
"updated_at": "2017-06-24T04:21:36Z",
"approval_status": "ACCEPTED",
"tweet_id": "822333526255120384",
"deleted": false
}
],
"request": {
"params": {
"line_item_id": "8v7jo",
"tweet_ids": [
822333526255120384
],
"account_id": "18ce54d4x5t"
}
},
"total_count": 1
}
DELETE accounts/:account_id/promoted_tweets/:promoted_tweet_id¶
指定した行項目からツイートの関連付けを解除します。
注: 削除されたpromoted_tweetsエンティティは、ads.twitter.comのUIでは「停止中」と表示されます。同様に、UIからの「停止中」によって、このツイートと行項目との関連付けが解除されます。
リソースURL¶
https://ads-api.x.com/10/accounts/:account_id/promoted_tweets/:promoted_tweet_id
パラメーター¶
名前 | 説明 |
---|---|
account_id 必須 |
利用するアカウントのID。リソースのパス内に表示され、通常、GET accountsを除くすべての広告主APIリクエストに必須のパラメーターです。指定するアカウントは、認証済みユーザーに関連付けられている必要があります。 タイプ: 文字列 例: |
promoted_tweet_id 必須 |
IDは、行項目に関連付けられているプロモツイートのインスタンスを表します。これは、GET accounts/:account_id/promoted_tweetsに対する応答項目の タイプ: 文字列 例: |
リクエストの例¶
DELETE https://ads-api.x.com/10/accounts/18ce54d4x5t/promoted_tweets/1gp8a5
応答の例¶
{
"data": {
"line_item_id": "9pl99",
"id": "1gp8a5",
"entity_status": "ACTIVE",
"created_at": "2017-08-17T17:02:21Z",
"updated_at": "2017-08-18T06:43:48Z",
"approval_status": "ACCEPTED",
"tweet_id": "844796297743757315",
"deleted": true
},
"request": {
"params": {
"promoted_tweet_id": "1gp8a5",
"account_id": "18ce54d4x5t"
}
}
}