下書きツイート

GET accounts/:account_id/draft_tweets

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

リソースURL

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

パラメーター

名前 説明
account_id
必須

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

タイプ: 文字列

例: 18ce54d4x5t

count
任意

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

タイプ: 整数

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

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

タイプ: 文字列

例: c-jh1g0ryb

user_id
任意

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

タイプ: 長整数型

例: 756201191646691328

リクエストの例

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

応答の例

{
  "request": {
    "params": {
      "count": 1
    }
  },
  "data": [
    {
      "id_str": "994791681219231744",
      "text": "hello, world",
      "user_id": "756201191646691328",
      "id": 994791681219231744,
      "nullcast": true,
      "created_at": "2018-05-11T04:09:53Z",
      "card_uri": null,
      "updated_at": "2018-05-11T04:09:53Z",
      "media_keys": []
    }
  ],
  "next_cursor": "c-jh1g0ryb"
}

GET accounts/:account_id/draft_tweets/:draft_tweet_id

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

リソースURL

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

パラメーター

名前 説明
account_id
必須

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

タイプ: 文字列

例: 18ce54d4x5t

draft_tweet_id
必須

リクエスト内で操作する下書きツイートへの参照。

タイプ: 長整数型

例: 994788364334325760

リクエストの例

GET https://ads-api.x.com/10/accounts/18ce54d4x5t/draft_tweets/994788364334325760

応答の例

{
  "request": {
    "params": {
      "draft_tweet_id": 994788364334325760
    }
  },
  "data": {
    "id_str": "994788364334325760",
    "text": "#TwitterDev",
    "user_id": "756201191646691328",
    "id": 994788364334325760,
    "nullcast": true,
    "created_at": "2018-05-11T03:56:42Z",
    "card_uri": "card://958225772740714496",
    "updated_at": "2018-05-11T03:56:42Z",
    "media_keys": []
  }
}

POST accounts/:account_id/draft_tweets

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

リソースURL

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

パラメーター

名前 説明
account_id
必須

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

タイプ: 文字列

例: 18ce54d4x5t

as_user_id
必須

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

タイプ: 長整数型

例: 756201191646691328

text
必須の場合あり

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

タイプ: 文字列

例: Just setting up my Twitter.

card_uri
任意

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

タイプ: 文字列

例: card://960880280705392541

media_keys
任意

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

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

タイプ: 文字列

例: 13_1153584529292270722

nullcast
任意

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

タイプ: ブール値

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

リクエストの例

POST https://ads-api.x.com/10/accounts/18ce54d4x5t/draft_tweets?as_user_id=756201191646691328&text=Just setting up my Twitter.

応答の例

{
  "request": {
    "params": {
      "text": "Just setting up my Twitter.",
      "as_user_id": 756201191646691328
    }
  },
  "data": {
    "id_str": "994747471329873920",
    "text": "Just setting up my Twitter.",
    "user_id": "756201191646691328",
    "id": 994747471329873920,
    "nullcast": true,
    "created_at": "2018-05-11T01:14:13Z",
    "card_uri": null,
    "updated_at": "2018-05-11T01:14:13Z",
    "media_keys": []
  }
}

PUT accounts/:account_id/draft_tweets/:draft_tweet_id

現在のアカウントに属する、指定した下書きツイートを更新します。

リソースURL

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

パラメーター

名前 説明
account_id
必須

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

タイプ: 文字列

例: 18ce54d4x5t

draft_tweet_id
必須

リクエスト内で操作する下書きツイートへの参照。

タイプ: 長整数型

例: 994747471329873920

card_uri
任意

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

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

タイプ: 文字列

例: card://970582057284129151

media_keys
任意

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

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

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

タイプ: 文字列

例: 13_1153584529292270722

nullcast
任意

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

タイプ: ブール値

使用可能な値: truefalse

text
任意

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

タイプ: 文字列

例: just setting up my twttr

リクエストの例

PUT https://ads-api.x.com/10/accounts/18ce54d4x5t/draft_tweets/994747471329873920?text=just setting up my twttr

応答の例

{
  "request": {
    "params": {
      "draft_tweet_id": 994747471329873920,
      "text": "just setting up my twttr"
    }
  },
  "data": {
    "id_str": "994747471329873920",
    "text": "just setting up my twttr",
    "user_id": "756201191646691328",
    "id": 994747471329873920,
    "nullcast": true,
    "created_at": "2018-05-11T01:14:13Z",
    "card_uri": null,
    "updated_at": "2018-05-11T01:16:59Z",
    "media_keys": []
  }
}

DELETE accounts/:account_id/draft_tweets/:draft_tweet_id

現在のアカウントに属する、指定した下書きツイートを完全に削除します。

: メタデータを使ってツイートまたは予約投稿ツイートが作成されたら、下書きを削除することを強くお勧めします。

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

リソースURL

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

パラメーター

名前 説明
account_id
必須

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

タイプ: 文字列

例: 18ce54d4x5t

draft_tweet_id
必須

リクエスト内で操作する下書きツイートへの参照。

タイプ: 長整数型

例: 994787835663155200

リクエストの例

DELETE https://ads-api.x.com/10/accounts/18ce54d4x5t/draft_tweets/994787835663155200

応答の例

{
  "request": {
    "params": {
      "draft_tweet_id": 994787835663155200
    }
  },
  "data": {
    "id_str": "994787835663155200",
    "text": "hello, world",
    "user_id": "756201191646691328",
    "id": 994787835663155200,
    "nullcast": true,
    "status": "DELETED",
    "created_at": "2018-05-11T03:54:36Z",
    "card_uri": null,
    "updated_at": "2018-05-11T04:07:31Z",
    "media_keys": []
  }
}

POST accounts/:account_id/draft_tweets/preview/:draft_tweet_id

モバイル端末で下書きツイートをプレビューします。

リクエストが成功すると、認証されたユーザーがログインしている各端末に通知が送られます。その通知をクリックするとタイムラインが開き、ユーザーは下書きツイートを確認して操作を行うことができます。自動再生、音量、フルスクリーン表示、動画ウェブサイトカードのドッキングなどのアクションを取ることができます。

: 端末でプレビューを見ることができるのは、通知を受け取ったユーザーのみです。

: 通知はTwitterの公式アプリにのみ送られます。

リソースURL

https://ads-api.x.com/10/accounts/:account_id/draft_tweets/preview/:draft_tweet_id

パラメーター

名前 説明
account_id
必須

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

タイプ: 文字列

例: 18ce54d4x5t

draft_tweet_id
必須

リクエスト内で操作する下書きツイートへの参照。

タイプ: 長整数型

例: 996132315829948416

リクエストの例

POST https://ads-api.x.com/10/accounts/18ce54d4x5t/draft_tweets/preview/996132315829948416

応答の例

{
  "request": {
    "params": {
      "account_id": "18ce54d4x5t",
      "draft_tweet_id": "996132315829948416"
    }
  },
  "message": "See @apimctestface's notifications in the Twitter app to preview your Tweet."
}