プロモーション可能なユーザー
GET accounts/:account_id/promotable_users¶
現在のアカウントに関連付けられている一部またはすべてのプロモーション可能なユーザーの詳細を取得します。
プロモーション可能なユーザーのタイプは、FULL
またはRETWEETS_ONLY
です。これにより、アカウントでプロモーション可能なコンテンツのタイプが制御されます。広告主は他のユーザーのコンテンツをプロモーションするための権限を取得し、Twitterに問い合わせてRETWEETS_ONLY
プロモーション可能なユーザーとして自分のアカウントへの追加を依頼する必要があります。
権限が正しく設定されていると、プロモーションするツイートのツイートIDを直接参照するプロモ商品エンドポイントに、リクエストを送信できます。投稿済みのツイートをプロモーションするには、POST accounts/:account_id/promoted-tweetsエンドポイントを、他のTwitter広告アカウントの予約投稿ツイートをプロモーションするにはPOST accounts/:account_id/scheduled-promoted-tweetsを使用します。
ターゲットのツイートをリツイートする必要はありません。この方法でツイートをプロモーションすると、返されるtweet_id
は、指定したツイートIDとは別のものになります。バックグラウンドでは、そのツイートはヌルキャストツイートとしてリツイートされてからプロモーションされます。返されるtweet_id
は、この新しいツイートに対応します。
リソースURL¶
https://ads-api.x.com/10/accounts/:account_id/promotable_users
パラメーター¶
名前 | 説明 |
---|---|
account_id 必須 |
利用するアカウントのID。リソースのパス内に表示され、通常、GET accountsを除くすべての広告主APIリクエストに必須のパラメーターです。指定するアカウントは、認証済みユーザーに関連付けられている必要があります。 タイプ: 文字列 例: |
count 任意 |
個別のリクエストごとに試行および取得するレコード数を指定します。 タイプ: 整数 デフォルト: 200 最小、最大: 1 、1000 |
cursor 任意 |
結果の次のページを取得するためのカーソルを指定します。詳細については、「ページネーション」を参照してください。 タイプ: 文字列 例: |
promotable_user_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/promotable_users?promotable_user_ids=l310s
応答の例¶
{
"request": {
"params": {
"promotable_user_ids": [
"l310s"
],
"account_id": "18ce54d4x5t"
}
},
"next_cursor": null,
"data": [
{
"user_id": "756201191646691328",
"id": "l310s",
"created_at": "2016-07-21T22:42:09Z",
"updated_at": "2016-07-21T22:42:09Z",
"deleted": false,
"promotable_user_type": "FULL"
}
]
}
GET accounts/:account_id/promotable_users/:promotable_user_id¶
現在のアカウントに関連付けられている特定のプロモーション可能なユーザーを取得します。
プロモーション可能なユーザーのタイプは、FULL
またはRETWEETS_ONLY
です。これにより、アカウントでプロモーション可能なコンテンツのタイプが制御されます。
広告主は他のユーザーのコンテンツをプロモーションするための権限を取得する必要があります。権限が正しく設定されていると、プロモーションするツイートのツイートIDを直接参照するプロモ商品エンドポイントに、リクエストを送信できます。
ターゲットのツイートをリツイートする必要はありません。この方法でツイートをプロモーションすると、返されるtweet_id
は、指定したツイートIDとは別のものになります。バックグラウンドでは、そのツイートはヌルキャストツイートとしてリツイートされてからプロモーションされます。返されるtweet_id
は、この新しいツイートに対応します。
リソースURL¶
https://ads-api.x.com/10/accounts/:account_id/promotable_users/:promotable_user_id
パラメーター¶
名前 | 説明 |
---|---|
account_id 必須 |
利用するアカウントのID。リソースのパス内に表示され、通常、GET accountsを除くすべての広告主APIリクエストに必須のパラメーターです。指定するアカウントは、認証済みユーザーに関連付けられている必要があります。 タイプ: 文字列 例: |
promotable_user_id 任意 |
リクエストで操作するプロモーション可能なユーザーへの参照 タイプ: 文字列 例: |
with_deleted 任意 |
削除した結果をリクエストに含めます。 タイプ: ブール値 デフォルト: false 使用可能な値: true 、false |
リクエストの例¶
GET https://ads-api.x.com/10/accounts/18ce54d4x5t/promotable_users/l310s
応答の例¶
{
"request": {
"params": {
"promotable_user_id": "l310s",
"account_id": "18ce54d4x5t"
}
},
"data": {
"user_id": "2417045708",
"id": "l310s",
"created_at": "2017-03-10T17:51:24Z",
"updated_at": "2017-03-10T17:51:24Z",
"deleted": false,
"promotable_user_type": "RETWEETS_ONLY"
}
}