予約投稿ツイート

GET accounts/:account_id/scheduled_tweets

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

リソースURL

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

パラメーター

名前 説明
account_id
必須

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

タイプ: 文字列

例: 18ce54d4x5t

count
任意

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

タイプ: 整数

デフォルト: 100
最小、最大: 1200
cursor
任意

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

タイプ: 文字列

例: c-j3cn6n40

user_id
任意

予約投稿ツイートを取得するユーザーを指定します。設定しない場合は、アカウントのFULLプロモーション可能なユーザーがデフォルト値になります。

タイプ: 長整数型

例: 756201191646691328

リクエストの例

GET https://ads-api.x.com/10/accounts/18ce54d4x5t/scheduled_tweets?count=1

応答の例

{
  "request": {
    "params": {
      "count": 1
    }
  },
  "data": [
    {
      "completed_at": "2017-06-18T22:00:05Z",
      "id_str": "875828692081037312",
      "text": "where you want to be",
      "user_id": "756201191646691328",
      "scheduled_status": "SUCCESS",
      "id": 875828692081037312,
      "nullcast": true,
      "created_at": "2017-06-16T21:33:27Z",
      "scheduled_at": "2017-06-18T22:00:00Z",
      "card_uri": null,
      "updated_at": "2017-06-19T18:02:20Z",
      "tweet_id": "876560168963645440",
      "media_keys": []
    }
  ],
  "next_cursor": "c-j41uw400"
}

GET accounts/:account_id/scheduled_tweets/:scheduled_tweet_id

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

リソースURL

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

パラメーター

名前 説明
account_id
必須

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

タイプ: 文字列

例: 18ce54d4x5t

scheduled_tweet_id
必須

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

タイプ: 長整数型

例: 917438609065623552

リクエストの例

GET https://ads-api.x.com/10/accounts/18ce54d4x5t/scheduled_tweets/917438609065623552

応答の例

{
  "request": {
    "params": {
      "scheduled_tweet_id": 917438609065623552
    }
  },
  "data": {
    "completed_at": null,
    "id_str": "917438609065623552",
    "text": "",
    "user_id": "756201191646691328",
    "scheduled_status": "SCHEDULED",
    "id": 917438609065623552,
    "nullcast": true,
    "created_at": "2017-10-09T17:16:24Z",
    "scheduled_at": "2018-01-01T00:00:00Z",
    "card_uri": null,
    "updated_at": "2017-10-09T17:16:24Z",
    "tweet_id": null,
    "media_keys": [
      "3_917438348871983104"
    ]
  }
}

POST accounts/:account_id/scheduled_tweets

アカウントの完全にプロモーション可能なユーザー(デフォルト)またはas_user_idパラメーターで指定されたユーザーの予約投稿ツイートを作成します。

リソースURL

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

パラメーター

名前 説明
account_id
必須

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

タイプ: 文字列

例: 18ce54d4x5t

scheduled_at
必須

ツイートの投稿(ライブ放送)時間。ISO 8601で表します。

: ツイートを予約投稿できるのは1年先までです。

: また、予約投稿は分単位でのみ設定できます。秒は無視されます。

タイプ: 文字列

例: 2017-12-31T23:59:00Z

as_user_id
必須

ツイートの投稿者を代表する広告主のユーザーID。広告主はads.twitter.comで広告アカウントへのアクセスをユーザー名に付与する必要があります。このアクセス許可により、広告主のユーザー名ではなく御社のユーザー名のOAuthトークンを使ってAPIを呼び出すことができます。

タイプ: 長整数型

例: 756201191646691328

text
必須の場合あり

ステータス更新のテキスト。media_keysが指定されていない場合は必須です。

タイプ: 文字列

例: just setting up my twttr

card_uri
任意

可能であれば、カード応答からのcard_uri値を使って、カードをツイートに関連付けます。

タイプ: 文字列

例: card://855591459410511943

media_keys
任意

IDのカンマ区切りリストを指定して、メディアをツイートに関連付けます。最大で4つの画像、1つのアニメーションGIF、または1つの動画を含めることができます。

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

タイプ: 文字列

例: 13_1153584529292270722

nullcast
任意

ヌルキャスト(または「プロモーション専用」)ツイートを作成するかどうか。

タイプ: ブール値

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

リクエストの例

POST https://ads-api.x.com/10/accounts/18ce54d4x5t/scheduled_tweets?as_user_id=756201191646691328&media_keys=3_917438348871983104&scheduled_at=2018-01-01

応答の例

{
  "request": {
    "params": {
      "media_keys": [
        "3_917438348871983104"
      ],
      "scheduled_at": "2018-01-01T00:00:00Z",
      "as_user_id": 756201191646691328
    }
  },
  "data": {
    "completed_at": null,
    "id_str": "917438609065623552",
    "text": "",
    "user_id": "756201191646691328",
    "scheduled_status": "SCHEDULED",
    "id": 917438609065623552,
    "nullcast": true,
    "created_at": "2017-10-09T17:16:24Z",
    "scheduled_at": "2018-01-01T00:00:00Z",
    "card_uri": null,
    "updated_at": "2017-10-09T17:16:24Z",
    "tweet_id": null,
    "media_keys": [
      "3_917438348871983104"
    ]
  }
}

PUT accounts/:account_id/scheduled_tweets/:scheduled_tweet_id

現在のアカウントに属する、指定した予約投稿ツイートを更新します。

リソースURL

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

パラメーター

名前 説明
account_id
必須

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

タイプ: 文字列

例: 18ce54d4x5t

scheduled_tweet_id
必須

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

タイプ: 長整数型

例: 870321875435442177

card_uri
任意

可能であれば、カード応答からのcard_uri値を使って、カードをツイートに関連付けます。

: 値を含めずにパラメーターを指定すると設定が解除(削除)されます。

タイプ: 文字列

例: card://875146925316386347

media_keys
任意

IDのカンマ区切りリストを指定して、メディアをツイートに関連付けます。最大で4つの画像、1つのアニメーションGIF、または1つの動画を含めることができます。

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

: 値を含めずにパラメーターを指定すると設定が解除(削除)されます。

タイプ: 文字列

例: 13_1153584529292270722

nullcast
任意

ヌルキャスト(または「プロモーション専用」)ツイートを作成するかどうか。

タイプ: ブール値

使用可能な値: truefalse

scheduled_at
任意

ツイートの投稿(ライブ放送)時間。ISO 8601で表します。

タイプ: 文字列

例: 2017-12-31T23:59:59Z

text
任意

ステータス更新のテキスト。

タイプ: 文字列

例: just setting up my twttr

リクエストの例

PUT https://ads-api.x.com/10/accounts/18ce54d4x5t/scheduled_tweets/875057751231037440?text=winter solstice

応答の例

{
  "request": {
    "params": {
      "scheduled_tweet_id": 875057751231037440,
      "text": "winter solstice"
    }
  },
  "data": {
    "completed_at": null,
    "id_str": "875057751231037440",
    "scheduled_status": "SCHEDULED",
    "text": "winter solstice",
    "user_id": "756201191646691328",
    "id": 875057751231037440,
    "nullcast": true,
    "created_at": "2017-06-14T18:30:00Z",
    "scheduled_at": "2017-12-21T00:00:00Z",
    "card_uri": null,
    "updated_at": "2017-06-14T18:30:00Z",
    "tweet_id": null,
    "media_keys": []
  }
}

DELETE accounts/:account_id/scheduled_tweets/:scheduled_tweet_id

現在のアカウントに属する、指定した予約投稿ツイートを完全に削除します。

: これは物理的な削除です。このため、削除した予約投稿ツイートを取得することはできません。

リソースURL

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

パラメーター

名前 説明
account_id
必須

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

タイプ: 文字列

例: 18ce54d4x5t

scheduled_tweet_id
必須

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

タイプ: 長整数型

例: 870321875435442177

リクエストの例

DELETE https://ads-api.x.com/10/accounts/18ce54d4x5t/scheduled_tweets/875064008595787776

応答の例

{
  "request": {
    "params": {
      "scheduled_tweet_id": 875064008595787776
    }
  },
  "data": {
    "completed_at": null,
    "id_str": "875064008595787776",
    "scheduled_status": "DELETED",
    "text": "hello, world",
    "user_id": "756201191646691328",
    "id": 875064008595787776,
    "nullcast": true,
    "created_at": "2017-06-14T18:54:52Z",
    "scheduled_at": "2017-06-15T00:00:00Z",
    "card_uri": null,
    "updated_at": "2017-06-14T19:01:16Z",
    "tweet_id": null,
    "media_keys": []
  }
}