予約投稿プロモツイート

GET accounts/:account_id/scheduled_promoted_tweets

現在のアカウントに関連付けられている一部またはすべての予約投稿プロモツイートの詳細を取得します。

リソースURL

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

パラメーター

名前 説明
account_id
必須

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

タイプ: 文字列

例: 18ce54d4x5t

count
任意

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

タイプ: 整数

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

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

タイプ: 文字列

例: 8x7v00oow

line_item_ids
任意

カンマ区切りのIDリストを指定して、応答の範囲を特定の行項目に関連付けられている予約投稿ツイートのみに設定します。最大200件のIDを指定できます。

タイプ: 文字列

例: 8xdpe

scheduled_promoted_tweet_ids
任意

カンマ区切りのIDリストを指定して、応答の範囲を目的の予約投稿プロモツイートのみに設定します。最大200件のIDを指定できます。

タイプ: 文字列

例: 1xboq

sort_by
任意

サポートされている属性で昇順または降順に並べ替えます。詳細については、「並べ替え」を参照してください。

タイプ: 文字列

例: created_at-asc

with_deleted
任意

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

タイプ: ブール値

デフォルト: false
使用可能な値: truefalse
with_total_count
任意

total_count応答属性を含めます。

: このパラメーターとcursorとは相互に排他的です。

: total_countを含むリクエストの場合、レート制限が低くなります。現在15分あたり200に設定されています。

タイプ: ブール値

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

リクエストの例

GET https://ads-api.x.com/10/accounts/18ce54d4x5t/scheduled_promoted_tweets?scheduled_promoted_tweet_ids=1xboq

応答の例

{
  "request": {
    "params": {
      "scheduled_promoted_tweet_ids": [
        "1xboq"
      ],
      "account_id": "18ce54d4x5t"
    }
  },
  "next_cursor": null,
  "data": [
    {
      "line_item_id": "8xdpe",
      "id": "1xboq",
      "created_at": "2017-06-01T19:53:32Z",
      "updated_at": "2017-06-01T20:00:06Z",
      "scheduled_tweet_id": "870366669373194240",
      "tweet_id": "870369382207070208",
      "deleted": false
    }
  ]
}

GET accounts/:account_id/scheduled_promoted_tweets/:scheduled_promoted_tweet_id

現在のアカウントに関連付けられている特定の予約投稿プロモツイートを取得します。

リソースURL

https://ads-api.x.com/10/accounts/:account_id/scheduled_promoted_tweets/:scheduled_promoted_tweet_id

パラメーター

名前 説明
account_id
必須

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

タイプ: 文字列

例: 18ce54d4x5t

scheduled_promoted_tweet_id
必須

リクエスト内で操作する予約投稿プロモツイートへの参照。

タイプ: 文字列

例: 1xboq

with_deleted
任意

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

タイプ: ブール値

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

リクエストの例

GET https://ads-api.x.com/10/accounts/18ce54d4x5t/scheduled_promoted_tweets/1xboq

応答の例

{
  "request": {
    "params": {
      "scheduled_promoted_tweet_id": "1xboq",
      "account_id": "18ce54d4x5t"
    }
  },
  "data": {
    "line_item_id": "8xdpe",
    "id": "1xboq",
    "created_at": "2017-06-01T19:53:32Z",
    "updated_at": "2017-06-01T20:00:06Z",
    "scheduled_tweet_id": "870366669373194240",
    "tweet_id": "870369382207070208",
    "deleted": false
  }
}

POST accounts/:account_id/scheduled_promoted_tweets

予約投稿ツイートを指定した行項目に関連付けます。

: 予約投稿プロモツイートエンティティを更新(PUT)することはできません。

リソースURL

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

パラメーター

名前 説明
account_id
必須

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

タイプ: 文字列

例: 18ce54d4x5t

line_item_id
必須

リクエスト内で操作する行項目への参照。

タイプ: 文字列

例: 8xdpe

scheduled_tweet_id
必須

リクエスト内で操作する予約投稿ツイートへの参照。

タイプ: 長整数型

例: 870358555227860992

リクエストの例

POST https://ads-api.x.com/10/accounts/18ce54d4x5t/scheduled_promoted_tweets?line_item_id=8xdpe&scheduled_tweet_id=870358555227860992

応答の例

{
  "data": {
    "line_item_id": "8xdpe",
    "id": "1xtfl",
    "created_at": "2017-06-08T07:25:26Z",
    "updated_at": "2017-06-08T07:25:26Z",
    "scheduled_tweet_id": "870358555227860992",
    "tweet_id": null,
    "deleted": false
  },
  "request": {
    "params": {
      "line_item_id": "8xdpe",
      "scheduled_tweet_id": 870358555227860992,
      "account_id": "18ce54d4x5t"
    }
  }
}

DELETE accounts/:account_id/scheduled_promoted_tweets/:scheduled_promoted_tweet_id

指定した行項目から予約投稿ツイートの関連付けを解除します。

: scheduled_promoted_tweetsは、予約投稿ツイートのscheduled_at時間より前にのみ削除できます。

リソースURL

https://ads-api.x.com/10/accounts/:account_id/scheduled_tweets/:scheduled_tweet_id

パラメーター

名前 説明
account_id
必須

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

タイプ: 文字列

例: 18ce54d4x5t

scheduled_promoted_tweet_id
必須

リクエスト内で操作する予約投稿プロモツイートへの参照。これは、GET accounts/:account_id/scheduled_promoted_tweets応答オブジェクトのid属性です。

タイプ: 文字列

例: 1xtfl

リクエストの例

DELETE https://ads-api.x.com/10/accounts/18ce54d4x5t/scheduled_promoted_tweets/1xtfl

応答の例

{
  "data": {
    "line_item_id": "8xdpe",
    "id": "1xtfl",
    "created_at": "2017-06-08T07:25:26Z",
    "updated_at": "2017-06-15T05:14:12Z",
    "scheduled_tweet_id": "870358555227860992",
    "tweet_id": null,
    "deleted": true
  },
  "request": {
    "params": {
      "scheduled_promoted_tweet_id": "1xtfl",
      "account_id": "18ce54d4x5t"
    }
  }
}