<a class="hxr-hoverxref hxr-tooltip reference internal" href="#tweepy.API" title="tweepy.API"> API 

https://developer.twitter.com/en/docs/twitter-api/premium/search-api/api-reference/premium-search

参照

API.search_full_archive(label, query, *, tag, fromDate, toDate, maxResults, next)

2006 年の初め頃からのツイートを対象としたプレミアムサーチ. 2006 年 3 月の最初のツイートからすべて.

パラメータ:

label -- 検索用の Developer Environment に紐付けるラベル (大文字と小文字は区別される). 以下のページで表示できるもの. https://developer.twitter.com/en/account/environments.
query --
最大 1024 文字 (サンドボックス開発環境では 256 文字) のプレミアムルールまたはフィルターに相当するもの.

このパラメータはルールまたはフィルターの全ての要素及び全ての操作を含む必要があり, ルールの一部を他のクエリパラメータに分割してはいけない.
tag --
タグを使用することで, ルールとそのマッチングデータを異なる論理グループに分離することができる. 与えられたルールタグは 'matching_rules' 属性に含まれる.

ルールタグにルール固有の UUID を与え, クライアント側で必要なマッピングを行うことが推奨される.
fromDate --
The oldest UTC timestamp (from most recent 30 days) from which the Tweets will be provided. Timestamp is in minute granularity and is inclusive (i.e. 12:00 includes the 00 minute).

Specified: Using only the fromDate with no toDate parameter will deliver results for the query going back in time from now( ) until the fromDate.

Not Specified: If a fromDate is not specified, the API will deliver all of the results for 30 days prior to now( ) or the toDate (if specified).

If neither the fromDate or toDate parameter is used, the API will deliver all results for the most recent 30 days, starting at the time of the request, going backwards.
toDate --
The latest, most recent UTC timestamp to which the Tweets will be provided. Timestamp is in minute granularity and is not inclusive (i.e. 11:59 does not include the 59th minute of the hour).

Specified: Using only the toDate with no fromDate parameter will deliver the most recent 30 days of data prior to the toDate.

Not Specified: If a toDate is not specified, the API will deliver all of the results from now( ) for the query going back in time to the fromDate.

If neither the fromDate or toDate parameter is used, the API will deliver all results for the entire 30-day index, starting at the time of the request, going backwards.
maxResults -- The maximum number of search results to be returned by a request. A number between 10 and the system limit (currently 500, 100 for Sandbox environments). By default, a request response will return 100 results.
next -- This parameter is used to get the next 'page' of results. The value used with the parameter is pulled directly from the response provided by the API, and should not be modified.

戻り値の型:

https://developer.twitter.com/en/docs/twitter-api/premium/search-api/api-reference/premium-search

参照

Tweets

Get Tweet timelines

API.home_timeline(*, count, since_id, max_id, trim_user, exclude_replies, include_entities)

20 件のもっとも最近のステータスを返す. リツイートを含む, 認証したユーザ及びそのアカウントでフォローしているユーザのツイートを返す. これはいわゆるウェブブラウザで開く /timeline/home と同じ.

パラメータ:

count -- ページごとに試行して取得する結果の数.
since_id -- 指定した ID よりも大きい (すなわち, より最新の) ツイートを返す.
max_id -- 指定した ID よりも小さいツイート (すなわち古いツイート) 及び ID が同じツイートを返す.
trim_user -- ユーザオブジェクト全体の代わりに, ユーザ ID を返すかどうかの真偽値. デフォルトでは False
exclude_replies -- このパラメータによってリプライを含まないタイムラインを返す. exclude_replies と count パラメータを組み合わせて使うことでツイートが最大まで取得できるようになる. (count パラメータによる取得数はリツイートやリプライを除外する前に処理されるため)
include_entities -- False に設定すると entities ノードを含めない. デフォルトでは True.

戻り値の型:

https://developer.twitter.com/en/docs/twitter-api/v1/tweets/timelines/api-reference/get-statuses-home_timeline

参照

API.mentions_timeline(*, count, since_id, max_id, trim_user, include_entities)

20 件のもっとも最近のリプライを返す. リツイートを含む.

パラメータ:

count -- ページごとに試行して取得する結果の数.
since_id -- 指定した ID よりも大きい (すなわち, より最新の) ツイートを返す.
max_id -- 指定した ID よりも小さいツイート (すなわち古いツイート) 及び ID が同じツイートを返す.
trim_user -- ユーザオブジェクト全体の代わりに, ユーザ ID を返すかどうかの真偽値. デフォルトでは False
include_entities -- False に設定すると entities ノードを含めない. デフォルトでは True.

戻り値の型:

https://developer.twitter.com/en/docs/twitter-api/v1/tweets/timelines/api-reference/get-statuses-mentions_timeline

参照

API.user_timeline(*, user_id, screen_name, since_id, count, max_id, trim_user, exclude_replies, include_rts)

認証したユーザがツイートしたもっとも最近 20 件のステータスを返す. ユーザ ID を渡すことで, 任意のユーザのツイートのステータスを取得することもできる.

パラメータ:

user_id -- ユーザ ID の指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.
screen_name -- スクリーンネームの指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.
since_id -- 指定した ID よりも大きい (すなわち, より最新の) ツイートを返す.
count -- ページごとに試行して取得する結果の数.
max_id -- 指定した ID よりも小さいツイート (すなわち古いツイート) 及び ID が同じツイートを返す.
trim_user -- ユーザオブジェクト全体の代わりに, ユーザ ID を返すかどうかの真偽値. デフォルトでは False
exclude_replies -- このパラメータによってリプライを含まないタイムラインを返す. exclude_replies と count パラメータを組み合わせて使うことでツイートが最大まで取得できるようになる. (count パラメータによる取得数はリツイートやリプライを除外する前に処理されるため)
include_rts -- When set to false, the timeline will strip any native retweets (though they will still count toward both the maximal length of the timeline and the slice selected by the count parameter). Note: If you're using the trim_user parameter in conjunction with include_rts, the retweets will still contain a full user object.

戻り値の型:

https://developer.twitter.com/en/docs/twitter-api/v1/tweets/timelines/api-reference/get-statuses-user_timeline

参照

Post, retrieve, and engage with Tweets

API.get_favorites(*, user_id, screen_name, count, since_id, max_id, include_entities)

認証したユーザか, ユーザ ID で指定したユーザの「いいね」ステータスを返す.

バージョン 4.0 で変更: Renamed from API.favorites

パラメータ:

user_id -- ユーザ ID の指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.
screen_name -- スクリーンネームの指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.
count -- ページごとに試行して取得する結果の数.
since_id -- 指定した ID よりも大きい (すなわち, より最新の) ツイートを返す.
max_id -- 指定した ID よりも小さいツイート (すなわち古いツイート) 及び ID が同じツイートを返す.
include_entities -- False に設定すると entities ノードを含めない. デフォルトでは True.

戻り値の型:

https://developer.twitter.com/en/docs/twitter-api/v1/tweets/post-and-engage/api-reference/get-favorites-list

参照

API.lookup_statuses(id, *, include_entities, trim_user, map, include_ext_alt_text, include_card_uri)

リクエストごとに最大 100 ツイートまで, id パラメータで指定したツイートのツイートオブジェクトを返す.

バージョン 4.0 で変更: Renamed from API.statuses_lookup

パラメータ:

id -- A list of Tweet IDs to lookup, up to 100
include_entities -- False に設定すると entities ノードを含めない. デフォルトでは True.
trim_user -- ユーザオブジェクト全体の代わりに, ユーザ ID を返すかどうかの真偽値. デフォルトでは False
map -- A boolean indicating whether or not to include Tweets that cannot be shown. Defaults to False.
include_ext_alt_text -- もしメディアに代替テキストが添付されたいた場合, このパラメータはメディアのトップレベルのキーとして``ext_alt_text`` 値を返す.
include_card_uri -- ツイートに広告カードが添付されており, そのカードが card_uri 値を使って指定されている場合に, 取得したツイートに card_uri 属性を含めるかどうかの真偽値.

戻り値の型:

https://developer.twitter.com/en/docs/twitter-api/v1/tweets/post-and-engage/api-reference/get-statuses-lookup

参照

API.get_oembed(url, *, maxwidth, hide_media, hide_thread, omit_script, align, related, lang, theme, link_color, widget_type, dnt)

ツイートの URL かツイート ID で指定したツイートをoEmbed-compatible 形式で返す. 返された HTML スニペットは Twitter ウィジェット JavaScript がページ内にあれば, 自動的に埋め込みツイートとして認識される.

The oEmbed endpoint allows customization of the final appearance of an Embedded Tweet by setting the corresponding properties in HTML markup to be interpreted by Twitter's JavaScript bundled with the HTML response by default. The format of the returned markup may change over time as Twitter adds new features or adjusts its Tweet representation.

The Tweet fallback markup is meant to be cached on your servers for up to the suggested cache lifetime specified in the cache_age.

パラメータ:

url -- The URL of the Tweet to be embedded
maxwidth -- The maximum width of a rendered Tweet in whole pixels. A supplied value under or over the allowed range will be returned as the minimum or maximum supported width respectively; the reset width value will be reflected in the returned width property. Note that Twitter does not support the oEmbed maxheight parameter. Tweets are fundamentally text, and are therefore of unpredictable height that cannot be scaled like an image or video. Relatedly, the oEmbed response will not provide a value for height. Implementations that need consistent heights for Tweets should refer to the hide_thread and hide_media parameters below.
hide_media -- When set to true, "t", or 1, links in a Tweet are not expanded to photo, video, or link previews.
hide_thread -- When set to true, "t", or 1, a collapsed version of the previous Tweet in a conversation thread will not be displayed when the requested Tweet is in reply to another Tweet.
omit_script -- When set to true, "t", or 1, the <script> responsible for loading widgets.js will not be returned. Your webpages should include their own reference to widgets.js for use across all Twitter widgets including Embedded Tweets.
align -- Specifies whether the embedded Tweet should be floated left, right, or center in the page relative to the parent element.
related -- A comma-separated list of Twitter usernames related to your content. This value will be forwarded to Tweet action intents if a viewer chooses to reply, like, or retweet the embedded Tweet.
lang -- Request returned HTML and a rendered Tweet in the specified Twitter language supported by embedded Tweets.
theme -- When set to dark, the Tweet is displayed with light text over a dark background.
link_color -- Adjust the color of Tweet text links with a hexadecimal color value.
widget_type -- Set to video to return a Twitter Video embed for the given Tweet.
dnt -- When set to true, the Tweet and its embedded page on your site are not used for purposes that include personalized suggestions and personalized ads.

戻り値:

JSON

戻り値の型:

https://developer.twitter.com/en/docs/twitter-api/v1/tweets/post-and-engage/api-reference/get-statuses-oembed

参照

API.get_retweeter_ids(id, *, count, cursor, stringify_ids)

id で指定した特定のツイートをリツイートしたユーザの ID を返す (最大 100 件).

バージョン 4.0 で変更: Renamed from API.retweeters

パラメータ:

id -- ツイート (status) の ID (数値).
count -- ページごとに試行して取得する結果の数.
cursor -- 結果をページに分けて出力する. ページングの開始には -1 を与える. 返り値に含まれる next_cursor 属性と p``revious_cursor`` 属性の値を利用してリストの前後にページを移動する.
stringify_ids -- ID の代わりに String 型で返す.

戻り値の型:

https://developer.twitter.com/en/docs/twitter-api/v1/tweets/post-and-engage/api-reference/get-statuses-retweeters-ids

参照

API.get_retweets(id, *, count, trim_user)

指定したツイートをリツイートした最初の 100 アカウントを返す.

バージョン 4.0 で変更: Renamed from API.retweets

パラメータ:

id -- ツイート (status) の ID (数値).
count -- ページごとに試行して取得する結果の数.
trim_user -- ユーザオブジェクト全体の代わりに, ユーザ ID を返すかどうかの真偽値. デフォルトでは False

戻り値の型:

https://developer.twitter.com/en/docs/twitter-api/v1/tweets/post-and-engage/api-reference/get-statuses-retweets-id

参照

API.get_retweets_of_me(*, count, since_id, max_id, trim_user, include_entities, include_user_entities)

認証されたユーザのツイートのうち, 他のユーザによってリツイートされた最新 20 件のツイートを返す.

バージョン 4.0 で変更: Renamed from API.retweets_of_me

パラメータ:

count -- ページごとに試行して取得する結果の数.
since_id -- 指定した ID よりも大きい (すなわち, より最新の) ツイートを返す.
max_id -- 指定した ID よりも小さいツイート (すなわち古いツイート) 及び ID が同じツイートを返す.
trim_user -- ユーザオブジェクト全体の代わりに, ユーザ ID を返すかどうかの真偽値. デフォルトでは False
include_entities -- False に設定すると entities ノードを含めない. デフォルトでは True.
include_user_entities -- False に設定するとユーザオブジェクトの entities ノードを含めない. デフォルトでは True.

戻り値の型:

https://developer.twitter.com/en/docs/twitter-api/v1/tweets/post-and-engage/api-reference/get-statuses-retweets_of_me

参照

API.get_status(id, *, trim_user, include_my_retweet, include_entities, include_ext_alt_text, include_card_uri)

ID パラメータで指定されたツイート返す.

パラメータ:

id -- ツイート (status) の ID (数値).
trim_user -- ユーザオブジェクト全体の代わりに, ユーザ ID を返すかどうかの真偽値. デフォルトでは False
include_my_retweet -- 認証ユーザによってリツイートされたツイートに, リツイート元のステータス ID を含む current_user_retweet ノードの情報を追加して返すかどうかの真偽値.
include_entities -- False に設定すると entities ノードを含めない. デフォルトでは True.
include_ext_alt_text -- もしメディアに代替テキストが添付されたいた場合, このパラメータはメディアのトップレベルのキーとして``ext_alt_text`` 値を返す.
include_card_uri -- ツイートに広告カードが添付されており, そのカードが card_uri 値を使って指定されている場合に, 取得したツイートに card_uri 属性を含めるかどうかの真偽値.

戻り値の型:

https://developer.twitter.com/en/docs/twitter-api/v1/tweets/post-and-engage/api-reference/get-statuses-show-id

参照

API.create_favorite(id, *, include_entities)

id で指定したツイートに (認証ユーザから) 「いいね」する.

パラメータ:

id -- ツイート (status) の ID (数値).
include_entities -- False に設定すると entities ノードを含めない. デフォルトでは True.

戻り値の型:

https://developer.twitter.com/en/docs/twitter-api/v1/tweets/post-and-engage/api-reference/post-favorites-create

参照

API.destroy_favorite(id, *, include_entities)

id で指定したツイートに (認証ユーザが) 「いいね」を外す.

パラメータ:

id -- ツイート (status) の ID (数値).
include_entities -- False に設定すると entities ノードを含めない. デフォルトでは True.

戻り値の型:

https://developer.twitter.com/en/docs/twitter-api/v1/tweets/post-and-engage/api-reference/post-favorites-destroy

参照

API.destroy_status(id, *, trim_user)

id パラメータで指定したツイートを削除する. 認証ユーザがツイートを削除する権限を持っていないといけない. (自分のツイートしか削除できない)

パラメータ:

id -- ツイート (status) の ID (数値).
trim_user -- ユーザオブジェクト全体の代わりに, ユーザ ID を返すかどうかの真偽値. デフォルトでは False

戻り値の型:

https://developer.twitter.com/en/docs/twitter-api/v1/tweets/post-and-engage/api-reference/post-statuses-destroy-id

参照

API.retweet(id, *, trim_user)

リツイートする. リツイートするツイートの ID が必要.

パラメータ:

id -- ツイート (status) の ID (数値).
trim_user -- ユーザオブジェクト全体の代わりに, ユーザ ID を返すかどうかの真偽値. デフォルトでは False

戻り値の型:

https://developer.twitter.com/en/docs/twitter-api/v1/tweets/post-and-engage/api-reference/post-statuses-retweet-id

参照

API.unretweet(id, *, trim_user)

リツイートを取り消す. リツイートを取り消すツイートの ID が必要.

パラメータ:

id -- ツイート (status) の ID (数値).
trim_user -- ユーザオブジェクト全体の代わりに, ユーザ ID を返すかどうかの真偽値. デフォルトでは False

戻り値の型:

https://developer.twitter.com/en/docs/twitter-api/v1/tweets/post-and-engage/api-reference/post-statuses-unretweet-id

参照

API.update_status(status, *, in_reply_to_status_id, auto_populate_reply_metadata, exclude_reply_user_ids, attachment_url, media_ids, possibly_sensitive, lat, long, place_id, display_coordinates, trim_user, card_uri)

認証されたユーザのステータスを更新する. すなわちツイートする.

ステータス更新 (ツイート) を試みるたびに, ツイート内容は最近のツイート内容と比較される. 内容が重複するようなものはブロックされ, 403 エラーが返ってくる. ユーザは同じ内容を 2 回連続で投稿することはできない.

API では制限されていないが, ユーザが一度に作成できるツイートの数は限られている. 投稿数が現在の許容範囲に到達した場合, 403 エラーが返ってくる.

パラメータ:

status -- 投稿したい内容のテキスト.
in_reply_to_status_id -- リプライを送る先のツイートの ID. (注意: ツイート内容の status の中でリプライ先のツイートのアカウントについて言及していないと, このパラメータは無視されます. したがって status の中に @username (リプライ先のアカウント) を含める必要がある. )
auto_populate_reply_metadata -- in_reply_to_status_id が指定されている場合に True に設定されていると元のツイートの @メンションを追加してツイートする. これによって @メンションの上限に達するまでツイートのメタデータに @メンションが追加され, リプライツリーが大きくなる. 元のツイートが削除されているとリプライは失敗する.
exclude_reply_user_ids -- auto_populate_reply_metadata と一緒に使われるとツイートに Twitter サーバが付ける @メンションのうち除外したいユーザ ID のカンマ区切りリストを指定する. 先頭の @メンションは in-reply-to-status-id と整合がとれなくなってしまうことになるので除外できない. 先頭の @メンションを除外しようとするとエラーなしに無視される.
attachment_url -- ツイート内容の文字カウントに URL が含まれないようにするためにURL をツイート添付の形で与える必要がある. この URL はツイートへのパーマリンクかダイレクトメッセージへのディープリンクである必要がある. attachment_url に渡された URL がツイートへのパーマリンクでもダイレクトメッセージへのディープリンクのいずれでもない場合, 例外が発生してツイートは失敗する.
media_ids -- ツイートに紐付けるメディアの media_ids のリスト. 写真は最大 4 点, アニメーション GIF または動画は 1 点のみツイートに含められる.
possibly_sensitive -- ツイートするメディアがセンシティブな内容を含むもの (ヌードやグロテスクなど) である場合は True を設定する.
lat -- ツイートした場所の緯度. このパラメータは -90.0 から +90.0 の間 (正数は北緯) でないと無視される. また対応する long パラメータがない場合も無視される.
long -- ツイートした場所の経度. このパラメータは -180.0 から +180.0 の間 (正数は東経) でないと無視される. 数値でない場合, geo_enabled が disable のとき, もしくは対応する lat パラメータがない場合も無視される.
place_id -- 世界における場所の ID.
display_coordinates -- ツイートが発信された正確な座標にピンを立てるかどうか.
trim_user -- ユーザオブジェクト全体の代わりに, ユーザ ID を返すかどうかの真偽値. デフォルトでは False
card_uri -- 広告カードレスポンスにある card_uri 値を用いることでツイートに広告カードを紐付ける.

戻り値の型:

https://developer.twitter.com/en/docs/twitter-api/v1/tweets/post-and-engage/api-reference/post-statuses-update

参照

API.update_status_with_media(status, filename, *, file, possibly_sensitive, in_reply_to_status_id, lat, long, place_id, display_coordinates)

認証されたユーザで画像付きのツイートをする. 同じ内容の投稿や長過ぎる投稿は無視される.

バージョン 3.7.0 で非推奨: 非推奨 : 代わりに API.media_upload() を使用すること.

バージョン 4.0 で変更: Renamed from API.update_with_media

パラメータ:

status -- 投稿したい内容のテキスト.
filename -- アップロードするメディアのファイル名. 引数の file が指定されていない場合でも, 自動的にファイルオープンされる.
file -- filename を開く代わりに使用されるファイルオブジェクト. MIME タイプの検出と POST データのフォームフィールドとして使用するために, filename はまだ必要.
possibly_sensitive -- ツイートするメディアがセンシティブな内容を含むもの (ヌードやグロテスクなど) である場合は True を設定する.
in_reply_to_status_id -- リプライしたいツイートへの ID.
lat -- ツイートした場所の緯度.
long -- ツイートした場所の経度.
place_id -- ユーザが位置情報を有効にしている場合に, ツイートに載る位置情報の ID.
display_coordinates -- ツイートが発信された正確な座標にピンを立てるかどうか.

戻り値の型:

https://developer.twitter.com/en/docs/twitter-api/v1/tweets/post-and-engage/api-reference/post-statuses-update_with_media

参照

ツイート検索

API.search_tweets(q, *, geocode, lang, locale, result_type, count, until, since_id, max_id, include_entities)

指定されたクエリにマッチするツイートのコレクションを返す.

Twitter の検索サービス, すなわち検索 API はツイートを網羅するわけではないことに注意する. 全てのツイートが検索データベースにインデックスされている (登録されている) わけではなく, 検索インターフェースで全て利用できるわけではない.

注釈

Twitter's standard search API only "searches against a sampling of recent Tweets published in the past 7 days."

If you're specifying an ID range beyond the past 7 days or there are no results from the past 7 days, then no results will be returned.

See Twitter's documentation on the standard search API for more information.

注釈

API v1.1 では検索 API のレスポンスが改善され, REST API や Twitter プラットフォームで得られるオブジェクトと近いツイートオブジェクトを返すようになっている. ただし, このエンドポイントでは perspectival 属性(認証したユーザの視点に関連する属性) は現在サポートされていない. [1][2]

バージョン 4.0 で変更: Renamed from API.search

パラメータ:

q -- 検索コマンドを含んで最大 500 文字までの検索クエリ. クエリの複雑さによってはさらに制限されることもある.
geocode -- 与えた緯度 / 経度から指定された範囲内におけるユーザのツイートを返す. 位置情報は Geotagging API から優先的に取得されるが, ツイッタープロフィールに戻される. パラメータ値は "緯度,経度,半径" で指定され, 「半径」は "mi" (マイル) か "km" (キロメートル) のどちらかの単位をつける必要がある. なお, API の near 演算子を使って任意の場所を geocode にすることはできないが, この geocode パラメータを使って近くの geocode を直接検索することはできる. 「半径」の修飾子を使う場合には, 最大 1,000 までの「サブ地域」が考慮される.
lang -- ISO 639-1 形式で与えた「言語」に検索対象を制限する. 言語検出はベストエフォートでしかない.
locale -- 送信するクエリの言語を指定する (現在有効なのは ja のみ). これは言語固有の利用者を想定したものであり, 大半の場合はデフォルトで動作する.
result_type --
受け取りたい検索結果のタイプを指定する. 現在のデフォルトは "mixed" である. 有効な値は以下のとおり:
- mixed : 話題のツイートとリアルタイムの検索結果の療法を含む
- recent : 最新の検索結果のみ
- popular : 話題のツイートのみ
count -- ページごとに試行して取得する結果の数.
until -- 与えた日付より前のツイートだけを返す. 日付は YYYY-MM-DD のフォーマットで指定する必要がある. 検索インデックスは 7 日制限があることを意識する必要がある. すなわち, 1 週間前のツイートは検索することができない.
since_id -- Returns only statuses with an ID greater than (that is, more recent than) the specified ID. API を通じて取得できるツイートの数には制限がある. もし since_id より以降でツイートの取得制限に引っかかった場合, since_id は利用できるもっとも古い ID に変更される.
max_id -- 指定した ID よりも小さいツイート (すなわち古いツイート) 及び ID が同じツイートを返す.
include_entities -- False に設定すると entities ノードを含めない. デフォルトでは True.

戻り値の型:

SearchResults

参照

https://developer.twitter.com/en/docs/twitter-api/v1/tweets/search/api-reference/get-search-tweets

Accounts and users

Create and manage lists

API.get_lists(*, user_id, screen_name, reverse)

認証されたユーザか指定したユーザがフォローしているリストを返す (自分のリストを含む). ユーザの指定は user_id もしくは screen_name パラメータで行う. もしユーザが見つからなければ, 認証ユーザに対して実行される.

このメソッドでは最大 100 件までのリストが返ってくる. フォローしているリストが最初に返され, 次に自分で作成したリストが返される. つまり, あるユーザが 90 件のリストをフォローしており, 20 件のリストを作成している場合, このメソッドは90 件のフォローしているリストと 10 件の作成したリストを返す. reverse=true の場合は作成したリストを先に返すので, 20 件の作成したリストと 80 件のフォローしているリストを返す.

バージョン 4.0 で変更: Renamed from API.lists_all

パラメータ:

user_id -- ユーザ ID の指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.
screen_name -- スクリーンネームの指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.
reverse -- 作成したリストを先に返すかどうかを示す真偽値. 詳細は上記説明を参照.

戻り値の型:

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/get-lists-list

参照

API.get_list_members(*, list_id, slug, owner_screen_name, owner_id, count, cursor, include_entities, skip_status)

指定したリストのメンバーを返す.

バージョン 4.0 で変更: 指定したユーザが指定したリストのメンバーかどうか調べる.

パラメータ:

list_id -- リストの ID (数値).
slug -- リストを識別する際に、数値の ID ではなく``slug`` を使用することができる. その場合, owner_id または owner_screen_name パラメータでリストの所有者を指定する必要があることに注意する.
owner_screen_name -- slug で要求されているリストを所有するユーザーのスクリーンネーム.
owner_id -- slug で要求されているリストを所有するユーザーの ID.
count -- ページごとに試行して取得する結果の数.
cursor -- 結果をページに分けて出力する. ページングの開始には -1 を与える. 返り値に含まれる next_cursor 属性と p``revious_cursor`` 属性の値を利用してリストの前後にページを移動する.
include_entities -- False に設定すると entities ノードを含めない. デフォルトでは True.
skip_status -- 返されるユーザーオブジェクトに status を含めないかどうかを示すブール値. デフォルトは False.

戻り値の型:

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/get-lists-members

参照

API.get_list_member(*, list_id, slug, user_id, screen_name, owner_screen_name, owner_id, include_entities, skip_status)

Check if the specified user is a member of the specified list.

バージョン 4.0 で変更: Renamed from API.show_list_member

パラメータ:

list_id -- リストの ID (数値).
slug -- リストを識別する際に、数値の ID ではなく``slug`` を使用することができる. その場合, owner_id または owner_screen_name パラメータでリストの所有者を指定する必要があることに注意する.
user_id -- ユーザ ID の指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.
screen_name -- スクリーンネームの指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.
owner_screen_name -- slug で要求されているリストを所有するユーザーのスクリーンネーム.
owner_id -- slug で要求されているリストを所有するユーザーの ID.
include_entities -- False に設定すると entities ノードを含めない. デフォルトでは True.
skip_status -- 返されるユーザーオブジェクトに status を含めないかどうかを示すブール値. デフォルトは False.

例外:

NotFound -- The user is not a member of the list.

戻り値の型:

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/get-lists-members-show

参照

API.get_list_memberships(*, user_id, screen_name, count, cursor, filter_to_owned_lists)

指定したユーザがメンバーになっているリストを返す. user_id か screen_name が指定されていない場合, 認証したユーザがメンバーになっているリストを返す.

バージョン 4.0 で変更: Renamed from API.lists_memberships

パラメータ:

user_id -- ユーザ ID の指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.
screen_name -- スクリーンネームの指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.
count -- ページごとに試行して取得する結果の数.
cursor -- 結果をページに分けて出力する. ページングの開始には -1 を与える. 返り値に含まれる next_cursor 属性と p``revious_cursor`` 属性の値を利用してリストの前後にページを移動する.
filter_to_owned_lists -- 認証したユーザが作成し, user_id か screen_name で指定されたユーザがメンバーとなっているリストだけを返すかどうかを示す真偽値.

戻り値の型:

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/get-lists-memberships

参照

API.get_list_ownerships(*, user_id, screen_name, count, cursor)

指定したユーザが作成したリストを返す. プライベートリストは認証したユーザとの共同リストの場合のみ返ってくる. もし user_id または screen_name が指定されてなければ認証したユーザが作成したリストが返る.

パラメータ:

user_id -- ユーザ ID の指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.
screen_name -- スクリーンネームの指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.
count -- ページごとに試行して取得する結果の数.
cursor -- 結果をページに分けて出力する. ページングの開始には -1 を与える. 返り値に含まれる next_cursor 属性と p``revious_cursor`` 属性の値を利用してリストの前後にページを移動する.

戻り値の型:

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/get-lists-ownerships

参照

API.get_list(*, list_id, slug, owner_screen_name, owner_id)

指定したリストを返す. プライベートリストは認証したユーザが作成したリストの場合のみ返される.

パラメータ:

list_id -- リストの ID (数値).
slug -- リストを識別する際に、数値の ID ではなく``slug`` を使用することができる. その場合, owner_id または owner_screen_name パラメータでリストの所有者を指定する必要があることに注意する.
owner_screen_name -- slug で要求されているリストを所有するユーザーのスクリーンネーム.
owner_id -- slug で要求されているリストを所有するユーザーの ID.

戻り値の型:

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/get-lists-show

参照

API.list_timeline(*, list_id, slug, owner_screen_name, owner_id, since_id, max_id, count, include_entities, include_rts)

指定したリストのメンバーが投稿したツイートタイムラインが返ってくる. デフォルトではリツイートも含まれる. include_rts=false パラメータを指定するとリツイートは省略される.

パラメータ:

list_id -- リストの ID (数値).
slug -- リストを識別する際に、数値の ID ではなく``slug`` を使用することができる. その場合, owner_id または owner_screen_name パラメータでリストの所有者を指定する必要があることに注意する.
owner_screen_name -- slug で要求されているリストを所有するユーザーのスクリーンネーム.
owner_id -- slug で要求されているリストを所有するユーザーの ID.
since_id -- 指定した ID よりも大きい (すなわち, より最新の) ツイートを返す.
max_id -- 指定した ID よりも小さいツイート (すなわち古いツイート) 及び ID が同じツイートを返す.
count -- ページごとに試行して取得する結果の数.
include_entities -- False に設定すると entities ノードを含めない. デフォルトでは True.
include_rts -- リストのタイムラインに通常のツイートに加えて, (もしあれば) リツイートを含めるかどうかの真偽値. リツイートされたツイートの出力形式は home_timeline で表示されるものと同じ.

戻り値の型:

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/get-lists-statuses

参照

API.get_list_subscribers(*, list_id, slug, owner_screen_name, owner_id, count, cursor, include_entities, skip_status)

指定したリストのフォロワーを返す. プライベートリストのフォロワーは認証したユーザが指定したリストの所有者である場合のみ表示される.

バージョン 4.0 で変更: API.list_subscribers から名前変更

パラメータ:

list_id -- リストの ID (数値).
slug -- リストを識別する際に、数値の ID ではなく``slug`` を使用することができる. その場合, owner_id または owner_screen_name パラメータでリストの所有者を指定する必要があることに注意する.
owner_screen_name -- slug で要求されているリストを所有するユーザーのスクリーンネーム.
owner_id -- slug で要求されているリストを所有するユーザーの ID.
count -- ページごとに試行して取得する結果の数.
cursor -- 結果をページに分けて出力する. ページングの開始には -1 を与える. 返り値に含まれる next_cursor 属性と p``revious_cursor`` 属性の値を利用してリストの前後にページを移動する.
include_entities -- False に設定すると entities ノードを含めない. デフォルトでは True.
skip_status -- 返されるユーザーオブジェクトに status を含めないかどうかを示すブール値. デフォルトは False.

戻り値の型:

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/get-lists-subscribers

参照

API.get_list_subscriber(*, owner_screen_name, owner_id, list_id, slug, user_id, screen_name, include_entities, skip_status)

指定したユーザが指定したリストのフォロワーかどうか調べる.

バージョン 4.0 で変更: Renamed from API.show_list_subscriber

パラメータ:

owner_screen_name -- slug で要求されているリストを所有するユーザーのスクリーンネーム.
owner_id -- slug で要求されているリストを所有するユーザーの ID.
list_id -- リストの ID (数値).
slug -- リストを識別する際に、数値の ID ではなく``slug`` を使用することができる. その場合, owner_id または owner_screen_name パラメータでリストの所有者を指定する必要があることに注意する.
user_id -- ユーザ ID の指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.
screen_name -- スクリーンネームの指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.
include_entities -- False に設定すると entities ノードを含めない. デフォルトでは True.
skip_status -- 返されるユーザーオブジェクトに status を含めないかどうかを示すブール値. デフォルトは False.

例外:

NotFound -- The user is not a subscriber of the list.

戻り値の型:

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/get-lists-subscribers-show

参照

API.get_list_subscriptions(*, user_id, screen_name, count, cursor)

指定したユーザがフォローしているリストのコレクションが得られる. デフォルトでは 1 ページあたり 20 件のリストが得られる. 指定したユーザ自身が作成したリストは含まれない.

バージョン 4.0 で変更: Renamed from API.lists_subscriptions

パラメータ:

user_id -- ユーザ ID の指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.
screen_name -- スクリーンネームの指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.
count -- ページごとに試行して取得する結果の数.
cursor -- 結果をページに分けて出力する. ページングの開始には -1 を与える. 返り値に含まれる next_cursor 属性と p``revious_cursor`` 属性の値を利用してリストの前後にページを移動する.

戻り値の型:

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/get-lists-subscriptions

参照

API.create_list(name, *, mode, description)

認証したユーザによる新しいリストを作成する. アカウントごとに最大 1,000 件までしかリストが作成できないことに注意.

パラメータ:

name -- 新しいリストの名前.
mode -- リストを公開するか非公開にするかどうか. 値は public または private. モードが指定されていない場合, リストはデフォルトで公開となる.
description -- 作成するリストの説明.

戻り値の型:

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/post-lists-create

参照

API.destroy_list(*, owner_screen_name, owner_id, list_id, slug)

指定したリストを削除する. 認証したユーザが作成したリストでないと削除することはできない.

パラメータ:

owner_screen_name -- slug で要求されているリストを所有するユーザーのスクリーンネーム.
owner_id -- slug で要求されているリストを所有するユーザーの ID.
list_id -- リストの ID (数値).
slug -- リストを識別する際に、数値の ID ではなく``slug`` を使用することができる. その場合, owner_id または owner_screen_name パラメータでリストの所有者を指定する必要があることに注意する.

戻り値の型:

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/post-lists-destroy

参照

API.add_list_member(*, list_id, slug, user_id, screen_name, owner_screen_name, owner_id)

リストに新しいメンバーを追加する. 認証したユーザが作成したリストでないとメンバーを追加できない. リストのメンバーは最大 5,000 件.

パラメータ:

list_id -- リストの ID (数値).
slug -- リストを識別する際に、数値の ID ではなく``slug`` を使用することができる. その場合, owner_id または owner_screen_name パラメータでリストの所有者を指定する必要があることに注意する.
user_id -- ユーザ ID の指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.
screen_name -- スクリーンネームの指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.
owner_screen_name -- slug で要求されているリストを所有するユーザーのスクリーンネーム.
owner_id -- slug で要求されているリストを所有するユーザーの ID.

戻り値の型:

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/post-lists-members-create

参照

API.add_list_members(*, list_id, slug, user_id, screen_name, owner_screen_name, owner_id)

リストに最大 100 アカウントまでメンバーを追加する. 認証したユーザが作成したリストでないとメンバーを追加できない. リストのメンバーは最大 5,000 件.

パラメータ:

list_id -- リストの ID (数値).
slug -- リストを識別する際に、数値の ID ではなく``slug`` を使用することができる. その場合, owner_id または owner_screen_name パラメータでリストの所有者を指定する必要があることに注意する.
user_id -- カンマ区切りのユーザ ID リスト. 1 度のリクエストあたり 100 件まで.
screen_name -- カンマ区切りのスクリーンネームのリスト. 1 度のリクエストあたり 100 件まで.
owner_screen_name -- slug で要求されているリストを所有するユーザーのスクリーンネーム.
owner_id -- slug で要求されているリストを所有するユーザーの ID.

戻り値の型:

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/post-lists-members-create_all

参照

API.remove_list_member(*, list_id, slug, user_id, screen_name, owner_screen_name, owner_id)

指定したメンバーをリストから除外する. 認証したユーザが作成したリストでないとメンバーを除外できない.

パラメータ:

list_id -- リストの ID (数値).
slug -- リストを識別する際に、数値の ID ではなく``slug`` を使用することができる. その場合, owner_id または owner_screen_name パラメータでリストの所有者を指定する必要があることに注意する.
user_id -- ユーザ ID の指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.
screen_name -- スクリーンネームの指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.
owner_screen_name -- slug で要求されているリストを所有するユーザーのスクリーンネーム.
owner_id -- slug で要求されているリストを所有するユーザーの ID.

戻り値の型:

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/post-lists-members-destroy

参照

API.remove_list_members(*, list_id, slug, user_id, screen_name, owner_screen_name, owner_id)

リストから最大 100 アカウントまでメンバーを除外する. 認証したユーザが作成したリストでないとメンバーを除外できない. リストのメンバーは最大 5,000 件.

パラメータ:

list_id -- リストの ID (数値).
slug -- リストを識別する際に、数値の ID ではなく``slug`` を使用することができる. その場合, owner_id または owner_screen_name パラメータでリストの所有者を指定する必要があることに注意する.
user_id -- カンマ区切りのユーザ ID リスト. 1 度のリクエストあたり 100 件まで.
screen_name -- カンマ区切りのスクリーンネームのリスト. 1 度のリクエストあたり 100 件まで.
owner_screen_name -- slug で要求されているリストを所有するユーザーのスクリーンネーム.
owner_id -- slug で要求されているリストを所有するユーザーの ID.

戻り値の型:

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/post-lists-members-destroy_all

参照

API.subscribe_list(*, owner_screen_name, owner_id, list_id, slug)

指定したリストを認証したユーザでフォローする.

パラメータ:

owner_screen_name -- slug で要求されているリストを所有するユーザーのスクリーンネーム.
owner_id -- slug で要求されているリストを所有するユーザーの ID.
list_id -- リストの ID (数値).
slug -- リストを識別する際に、数値の ID ではなく``slug`` を使用することができる. その場合, owner_id または owner_screen_name パラメータでリストの所有者を指定する必要があることに注意する.

戻り値の型:

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/post-lists-subscribers-create

参照

API.unsubscribe_list(*, list_id, slug, owner_screen_name, owner_id)

指定したリストの認証したユーザでのフォローを外す.

パラメータ:

list_id -- リストの ID (数値).
slug -- リストを識別する際に、数値の ID ではなく``slug`` を使用することができる. その場合, owner_id または owner_screen_name パラメータでリストの所有者を指定する必要があることに注意する.
owner_screen_name -- slug で要求されているリストを所有するユーザーのスクリーンネーム.
owner_id -- slug で要求されているリストを所有するユーザーの ID.

戻り値の型:

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/post-lists-subscribers-destroy

参照

API.update_list(*, list_id, slug, name, mode, description, owner_screen_name, owner_id)

指定したリストを更新, 変更する. 認証したユーザが作成したリストでないと変更できない.

パラメータ:

list_id -- リストの ID (数値).
slug -- リストを識別する際に、数値の ID ではなく``slug`` を使用することができる. その場合, owner_id または owner_screen_name パラメータでリストの所有者を指定する必要があることに注意する.
name -- リストの名前.
mode -- リストを公開するか非公開にするかどうか. 値は public または private. モードが指定されていない場合, リストはデフォルトで公開となる.
description -- リストの説明.
owner_screen_name -- slug で要求されているリストを所有するユーザーのスクリーンネーム.
owner_id -- slug で要求されているリストを所有するユーザーの ID.

戻り値の型:

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/post-lists-update

参照

ユーザのフォロー, 検索, 取得

API.get_follower_ids(*, user_id, screen_name, cursor, stringify_ids, count)

指定したユーザをフォローしているユーザのユーザ ID を含む配列を返す.

バージョン 4.0 で変更: API.followers_ids から名前変更

パラメータ:

user_id -- ユーザ ID の指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.
screen_name -- スクリーンネームの指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.
cursor -- 結果をページに分けて出力する. ページングの開始には -1 を与える. 返り値に含まれる next_cursor 属性と p``revious_cursor`` 属性の値を利用してリストの前後にページを移動する.
stringify_ids -- ID の代わりに String 型で返す.
count -- ページごとに試行して取得する結果の数.

戻り値の型:

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/get-followers-ids

参照

API.get_followers(*, user_id, screen_name, cursor, count, skip_status, include_user_entities)

指定したユーザのフォロワーをフォローした順で返す. user_id も screen_name も指定されなければ, デフォルトでは認証したユーザのフォロワーについて返す.

バージョン 4.0 で変更: API.followers から名前変更

パラメータ:

user_id -- ユーザ ID の指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.
screen_name -- スクリーンネームの指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.
cursor -- 結果をページに分けて出力する. ページングの開始には -1 を与える. 返り値に含まれる next_cursor 属性と p``revious_cursor`` 属性の値を利用してリストの前後にページを移動する.
count -- ページごとに試行して取得する結果の数.
skip_status -- 返されるユーザーオブジェクトに status を含めないかどうかを示すブール値. デフォルトは False.
include_user_entities -- False に設定するとユーザオブジェクトの entities ノードを含めない. デフォルトでは True.

戻り値の型:

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/get-followers-list

参照

API.get_friend_ids(*, user_id, screen_name, cursor, stringify_ids, count)

指定したユーザがフォローしているユーザのユーザ ID を含む配列を返す.

バージョン 4.0 で変更: Renamed from API.friends_ids

パラメータ:

user_id -- ユーザ ID の指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.
screen_name -- スクリーンネームの指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.
cursor -- 結果をページに分けて出力する. ページングの開始には -1 を与える. 返り値に含まれる next_cursor 属性と p``revious_cursor`` 属性の値を利用してリストの前後にページを移動する.
stringify_ids -- ID の代わりに String 型で返す.
count -- ページごとに試行して取得する結果の数.

戻り値の型:

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/get-friends-ids

参照

API.get_friends(*, user_id, screen_name, cursor, count, skip_status, include_user_entities)

指定したユーザがフォローしているユーザを追加した順で 1 回あたり 100 件まで返す. もしユーザが指定されていないと, デフォルトでは認証したユーザに対して実行する.

バージョン 4.0 で変更: Renamed from API.friends

パラメータ:

user_id -- ユーザ ID の指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.
screen_name -- スクリーンネームの指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.
cursor -- 結果をページに分けて出力する. ページングの開始には -1 を与える. 返り値に含まれる next_cursor 属性と p``revious_cursor`` 属性の値を利用してリストの前後にページを移動する.
count -- ページごとに試行して取得する結果の数.
skip_status -- 返されるユーザーオブジェクトに status を含めないかどうかを示すブール値. デフォルトは False.
include_user_entities -- False に設定するとユーザオブジェクトの entities ノードを含めない. デフォルトでは True.

戻り値の型:

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/get-friends-list

参照

API.incoming_friendships(*, cursor, stringify_ids)

認証したユーザにフォローリクエスト送った全てのユーザのユーザ ID (数値) コレクションを返す.

バージョン 4.0 で変更: Renamed from API.friendships_incoming

パラメータ:

cursor -- 結果をページに分けて出力する. ページングの開始には -1 を与える. 返り値に含まれる next_cursor 属性と p``revious_cursor`` 属性の値を利用してリストの前後にページを移動する.
stringify_ids -- ID の代わりに String 型で返す.

戻り値の型:

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/get-friendships-incoming

参照

API.lookup_friendships(*, screen_name, user_id)

認証したユーザと 1 回あたり 100 件までの指定した screen_name または user_id のユーザとのフォロー・フォロワー・フォローリクエストの情報を返す.

パラメータ:

screen_name -- スクリーンネームのリスト. 1 度のリクエストあたり 100 件まで.
user_id -- ユーザ ID のリスト. 1 度のリクエストあたり 100 件まで.

戻り値の型:

List[Relationship]

参照

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/get-friendships-lookup

API.no_retweets_friendships(*, stringify_ids)

認証したユーザがリツイートを表示しないように指定しているユーザの``user_ids`` コレクションを返す.

パラメータ:: stringify_ids -- ID の代わりに String 型で返す.
戻り値の型:: List[int]

参照

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/get-friendships-no_retweets-ids

API.outgoing_friendships(*, cursor, stringify_ids)

認証したユーザがフォローリクエストを保留している全ての非公開アカウントのユーザ ID (数値) のコレクションを返す.

バージョン 4.0 で変更: Renamed from API.friendships_outgoing

パラメータ:

cursor -- 結果をページに分けて出力する. ページングの開始には -1 を与える. 返り値に含まれる next_cursor 属性と p``revious_cursor`` 属性の値を利用してリストの前後にページを移動する.
stringify_ids -- ID の代わりに String 型で返す.

戻り値の型:

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/get-friendships-outgoing

参照

API.get_friendship(*, source_id, source_screen_name, target_id, target_screen_name)

指定した 2 つのユーザの間におけるフォロー・フォロワー・フォローリクエストの情報を返す.

バージョン 4.0 で変更: Renamed from API.show_friendship

パラメータ:

source_id -- 主体となるユーザの user_id.
source_screen_name -- 主体となるユーザの screen_name.
target_id -- ターゲットユーザの user_id.
target_screen_name -- ターゲットユーザの screen_name.

戻り値の型:

Friendship

参照

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/get-friendships-show

API.lookup_users(*, screen_name, user_id, include_entities, tweet_mode)

1 度のリクエストにつき 100 件まで, 指定されたユーザの全ての情報を返す.

このメソッドを使うときのいくつかの注意事項は以下のとおり.

非公開ユーザの最近の投稿を表示するためには, フォローしている必要がある. 非公開ユーザをフォローしていない場合, 投稿は表示されない.
ユーザ ID やスクリーンネームの順番は, 返ってくる配列で順番が一致しない場合がある.
リクエストしたユーザが見つからない, 凍結されている, 削除されている場合は返り値のリストには含まれない.
返ってきたユーザオブジェクトにおいて検索条件が満たされない場合, HTTP 404 エラーが投げられる.

パラメータ:

screen_name -- スクリーンネームのリスト. 1 度のリクエストあたり 100 件まで.
user_id -- ユーザ ID のリスト. 1 度のリクエストあたり 100 件まで.
include_entities -- False に設定すると entities ノードを含めない. デフォルトでは True.
tweet_mode -- 使用できるリクエストは compat または extended で, 互換モード (compatibility mode) と拡張モード (extended mode) に対応する. それぞれ 140 文字を超えるツイートに対して作用する.

戻り値の型:

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/get-users-lookup

参照

API.search_users(q, *, page, count, include_entities)

Twitter.com における「友達をさがす」と同様のユーザ検索を実行する. Twitter.com の「友達をさがす」と同じ結果がこの API でも返ってくる. この API では最初の 1,000 件までしか検索できない.

パラメータ:

q -- 「友達を探す」に対して実行するクエリ.
page -- 結果を取得するページを指定する. 注意: ページネーションには制限がある.
count -- ページごとに試行して取得する結果の数.
include_entities -- False に設定すると entities ノードを含めない. デフォルトでは True.

戻り値の型:

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/get-users-search

参照

API.get_user(*, user_id, screen_name, include_entities)

指定したユーザに関する情報を返す.

パラメータ:

user_id -- ユーザ ID の指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.
screen_name -- スクリーンネームの指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.
include_entities -- False に設定すると entities ノードを含めない. デフォルトでは True.

戻り値の型:

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/get-users-show

参照

API.create_friendship(*, screen_name, user_id, follow)

指定したユーザを新しくフォローする.

パラメータ:

screen_name -- スクリーンネームの指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.
user_id -- ユーザ ID の指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.
follow -- フォローするだけでなく, 当該ユーザのツイート通知もオンにする.

戻り値の型:

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/post-friendships-create

参照

API.destroy_friendship(*, screen_name, user_id)

指定したユーザのフォローを外す.

パラメータ:

screen_name -- スクリーンネームの指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.
user_id -- ユーザ ID の指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.

戻り値の型:

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/post-friendships-destroy

参照

API.update_friendship(*, screen_name, user_id, device, retweets)

指定したユーザのリツイート通知およびデバイス通知のオンオフを切り替える.

パラメータ:

screen_name -- スクリーンネームの指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.
user_id -- ユーザ ID の指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.
device -- 指定したユーザのデバイス通知のオンオフを切り替える.
retweets -- 指定したユーザのリツイート通知のオンオフを切り替える.

戻り値の型:

Friendship

参照

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/post-friendships-update

アカウント設定とプロフィールの管理

API.get_settings()

認証したユーザの設定を返す (現在地, 通知のスリープ状態なども含まれる).

戻り値:: JSON
戻り値の型:: dict

参照

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/manage-account-settings/api-reference/get-account-settings

API.verify_credentials(*, include_entities, skip_status, include_email)

与えた認証情報が有効であることを確認する.

パラメータ:

include_entities -- False に設定すると entities ノードを含めない. デフォルトでは True.
skip_status -- 返されるユーザーオブジェクトに status を含めないかどうかを示すブール値. デフォルトは False.
include_email -- True に設定するとユーザオブジェクトの中に文字列としてメールアドレスを含めて返す.

例外:

Unauthorized -- Authentication unsuccessful

戻り値の型:

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/manage-account-settings/api-reference/get-account-verify_credentials

参照

API.get_saved_searches()

認証したユーザの「保存した検索」を返す.

バージョン 4.0 で変更: Renamed from API.saved_searches

戻り値の型:: List[SavedSearch]

参照

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/manage-account-settings/api-reference/get-saved_searches-list

API.get_saved_search(id)

認証したユーザによる「保存した検索」のうち, ID で与えられたもののデータを取得する.

パラメータ:: id -- 取得したい「保存した検索」の ID.
戻り値の型:: SavedSearch

参照

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/manage-account-settings/api-reference/get-saved_searches-show-id

API.get_profile_banner(*, user_id, screen_name)

指定したユーザのプロフィールヘッダー画像を利用可能な様々なサイズ別の map を返す. もしユーザがプロフィールヘッダー画像を設定していない場合, HTTP 404 エラーが返ってくる.

サイズ別に取得できるプロフィールヘッダー画像の URL は PNG 形式のデータとなる.

パラメータ:

user_id -- ユーザ ID の指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.
screen_name -- スクリーンネームの指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.

戻り値:

JSON

戻り値の型:

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/manage-account-settings/api-reference/get-users-profile_banner

参照

API.remove_profile_banner()

認証したユーザのプロフィールヘッダー画像を削除する.

参照

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/manage-account-settings/api-reference/post-account-remove_profile_banner

API.set_settings(*, sleep_time_enabled, start_sleep_time, end_sleep_time, time_zone, trend_location_woeid, lang)

認証したユーザの設定を更新する.

パラメータ:

sleep_time_enabled -- true または t または 1 に設定するとスリープタイムを有効にする. スリープタイムはプッシュ通知や SMS 通知を送らない時間.
start_sleep_time -- スリープ機能をオンのときにスリープを有効にする時刻. このパラメータの値は ISO 8601 形式 (例: 00-23) で与える必要がある. 時刻はユーザの time_zone 設定と同じタイムゾーンで扱われる.
end_sleep_time -- スリープ機能をオンのときにスリープを無効にする時刻. このパラメータの値は ISO 8601 形式 (例: 00-23) で与える必要がある. 時刻はユーザの time_zone 設定と同じタイムゾーンで扱われる.
time_zone -- ユーザに表示される日付時刻のタイムゾーン. タイムゾーンは Rails TimeZone の名称を用いる.
trend_location_woeid -- ユーザのデフォルトのトレンドに使われる場所の Yahoo! WOEID (Where On Earth ID). WOEID に 1 を設定するとグローバルトレンドが得られる.
lang -- ユーザの Twitter 表示に使う言語. 言語は ISO 639-1 形式の 2 文字で指定する必要がある.

戻り値:

JSON

戻り値の型:

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/manage-account-settings/api-reference/post-account-settings

参照

API.update_profile(*, name, url, location, description, profile_link_color, include_entities, skip_status)

ユーザがプロフィールで設定可能な値を設定する.

パラメータ:

name -- プロフィールに設定されている名前.
url -- プロフィールに設定されているウェブサイトの URL. http:// がない場合は, 先頭に追加される.
location -- ユーザアカウントの都市や国などの位置情報. この内容はジオコードなどで正規化されることはない.
description -- ユーザプロフィールに設定されている自己紹介の内容.
profile_link_color -- 認証したユーザの twitter.com におけるプロフィールページで使用されるリンクの色を指定する 16 進数の値を設定する. この値は有効な 16 進数である必要があり, 3 文字または 6 文字のいずれか. (例: F00 または FF0000)
include_entities -- False に設定すると entities ノードを含めない. デフォルトでは True.
skip_status -- 返されるユーザーオブジェクトに status を含めないかどうかを示すブール値. デフォルトは False.

戻り値の型:

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/manage-account-settings/api-reference/post-account-update_profile

参照

API.update_profile_banner(filename, *, file, width, height, offset_left, offset_top)

認証したユーザの代わりにプロフィールヘッダー画像をアップロードする.

パラメータ:

filename -- アップロードするメディアのファイル名. 引数の file が指定されていない場合でも, 自動的にファイルオープンされる.
file -- filename を開く代わりに使用されるファイルオブジェクト. MIME タイプの検出と POST データのフォームフィールドとして使用するために, filename はまだ必要.
width -- アップロードする画像の, 希望する部分の幅 (ピクセル単位). height, offset_left, offset_top と一緒に利用することで, 画像のほしい領域を選択することができる.
height -- アップロードする画像の, 希望する部分の高さ (ピクセル単位). width, offset_left, offset_top と一緒に利用することで, 画像のほしい領域を選択することができる.
offset_left -- アップロードする画像の, 希望する左端 (オフセット) の初期値 (ピクセル数). width, height, offset_top と一緒に利用することで, 画像のほしい領域を選択することができる.
offset_top -- アップロードする画像の, 希望する上端 (オフセット) の初期値 (ピクセル数). width, height, offset_top と一緒に利用することで, 画像のほしい領域を選択することができる.

参照

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/manage-account-settings/api-reference/post-account-update_profile_banner

API.update_profile_image(filename, *, file, include_entities, skip_status)

認証したユーザのプロフィール画像を更新する. 使える画像フォーマットは GIF, JPG, PNG.

パラメータ:

filename -- アップロードするメディアのファイル名. 引数の file が指定されていない場合でも, 自動的にファイルオープンされる.
file -- filename を開く代わりに使用されるファイルオブジェクト. MIME タイプの検出と POST データのフォームフィールドとして使用するために, filename はまだ必要.
include_entities -- False に設定すると entities ノードを含めない. デフォルトでは True.
skip_status -- 返されるユーザーオブジェクトに status を含めないかどうかを示すブール値. デフォルトは False.

戻り値の型:

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/manage-account-settings/api-reference/post-account-update_profile_image

参照

API.create_saved_search(query)

認証したユーザの「保存した検索」を新たに増やす.

パラメータ:: query -- 保存したい検索クエリ.
戻り値の型:: SavedSearch

参照

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/manage-account-settings/api-reference/post-saved_searches-create

API.destroy_saved_search(id)

認証したユーザの「保存した検索」を削除する. 「保存した検索」は ID で指定し, 認証したユーザの設定である必要がある.

パラメータ:: id -- 削除したい「保存した検索」の ID.
戻り値の型:: SavedSearch

参照

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/manage-account-settings/api-reference/post-saved_searches-destroy-id

ミュート, ブロック, ユーザの報告

API.get_blocked_ids(*, stringify_ids, cursor)

認証したユーザがブロックしたユーザのユーザ ID (数値) 配列を返す.

バージョン 4.0 で変更: Renamed from API.blocks_ids

パラメータ:

stringify_ids -- ID の代わりに String 型で返す.
cursor -- 結果をページに分けて出力する. ページングの開始には -1 を与える. 返り値に含まれる next_cursor 属性と p``revious_cursor`` 属性の値を利用してリストの前後にページを移動する.

戻り値の型:

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/mute-block-report-users/api-reference/get-blocks-ids

参照

API.get_blocks(*, include_entities, skip_status, cursor)

認証したユーザがブロックしたユーザのユーザオブジェクトの配列を返す.

バージョン 4.0 で変更: Renamed from API.blocks

パラメータ:

include_entities -- False に設定すると entities ノードを含めない. デフォルトでは True.
skip_status -- 返されるユーザーオブジェクトに status を含めないかどうかを示すブール値. デフォルトは False.
cursor -- 結果をページに分けて出力する. ページングの開始には -1 を与える. 返り値に含まれる next_cursor 属性と p``revious_cursor`` 属性の値を利用してリストの前後にページを移動する.

戻り値の型:

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/mute-block-report-users/api-reference/get-blocks-list

参照

API.get_muted_ids(*, stringify_ids, cursor)

認証したユーザがミュートしたユーザのユーザ ID (数値) 配列を返す.

バージョン 4.0 で変更: Renamed from API.mutes_ids

パラメータ:

stringify_ids -- ID の代わりに String 型で返す.
cursor -- 結果をページに分けて出力する. ページングの開始には -1 を与える. 返り値に含まれる next_cursor 属性と p``revious_cursor`` 属性の値を利用してリストの前後にページを移動する.

戻り値の型:

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/mute-block-report-users/api-reference/get-mutes-users-ids

参照

API.get_mutes(*, cursor, include_entities, skip_status)

認証したユーザがミュートしたユーザのユーザオブジェクトの配列を返す.

バージョン 4.0 で変更: Renamed from API.mutes

パラメータ:

cursor -- 結果をページに分けて出力する. ページングの開始には -1 を与える. 返り値に含まれる next_cursor 属性と p``revious_cursor`` 属性の値を利用してリストの前後にページを移動する.
include_entities -- False に設定すると entities ノードを含めない. デフォルトでは True.
skip_status -- 返されるユーザーオブジェクトに status を含めないかどうかを示すブール値. デフォルトは False.

戻り値の型:

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/mute-block-report-users/api-reference/get-mutes-users-list

参照

API.create_block(*, screen_name, user_id, include_entities, skip_status)

指定したユーザが認証したユーザをフォローできないようにブロックする. ブロックしたユーザは認証したユーザのメンションやタイムラインに現れることはなくなる (他のユーザがリツイートした場合は除く). もしフォローやフォロワーで会った場合は解除される.

パラメータ:

screen_name -- スクリーンネームの指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.
user_id -- ユーザ ID の指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.
include_entities -- False に設定すると entities ノードを含めない. デフォルトでは True.
skip_status -- 返されるユーザーオブジェクトに status を含めないかどうかを示すブール値. デフォルトは False.

戻り値の型:

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/mute-block-report-users/api-reference/post-blocks-create

参照

API.destroy_block(*, screen_name, user_id, include_entities, skip_status)

ID パラメータで指定したユーザの認証したユーザによるブロックを解く.

パラメータ:

screen_name -- スクリーンネームの指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.
user_id -- ユーザ ID の指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.
include_entities -- False に設定すると entities ノードを含めない. デフォルトでは True.
skip_status -- 返されるユーザーオブジェクトに status を含めないかどうかを示すブール値. デフォルトは False.

戻り値の型:

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/mute-block-report-users/api-reference/post-blocks-destroy

参照

API.create_mute(*, screen_name, user_id)

ID パラメータで指定したユーザを認証したユーザでミュートする.

パラメータ:

screen_name -- スクリーンネームの指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.
user_id -- ユーザ ID の指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.

戻り値の型:

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/mute-block-report-users/api-reference/post-mutes-users-create

参照

API.destroy_mute(*, screen_name, user_id)

ID パラメータで指定したユーザの認証したユーザによるミュートを解く.

パラメータ:

screen_name -- スクリーンネームの指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.
user_id -- ユーザ ID の指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.

戻り値の型:

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/mute-block-report-users/api-reference/post-mutes-users-destroy

参照

API.report_spam(*, screen_name, user_id, perform_block)

指定したユーザをスパムアカウントとして Twitter に報告する.

パラメータ:

screen_name -- スクリーンネームの指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.
user_id -- ユーザ ID の指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.
perform_block -- 報告したアカウントをブロックするかどうかを示す真偽値. デフォルトでは True.

戻り値の型:

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/mute-block-report-users/api-reference/post-users-report_spam

参照

ダイレクトメッセージ

送信と受信イベント

API.delete_direct_message(id)

ID パラメータで指定したダイレクトメッセージ (DM) を削除する. 認証したユーザは指定した DM の受信者である必要がある. DM はユーザインターフェースから見えなくなるだけで会話に参加している他のメンバーからは DM の内容を見ることができる.

バージョン 4.0 で変更: Renamed from API.destroy_direct_message

パラメータ:: id -- 削除したい DM の ID.

参照

https://developer.twitter.com/en/docs/twitter-api/v1/direct-messages/sending-and-receiving/api-reference/delete-message-event

API.get_direct_messages(*, count, cursor)

最近 30 日間の全てのダイレクトメッセージのイベント (送信及び受信) を返す. 時間逆順にソートされている.

バージョン 4.0 で変更: Renamed from API.list_direct_messages

パラメータ:

count -- ページごとに試行して取得する結果の数.
cursor -- 結果をページに分けて出力する. ページングの開始には -1 を与える. 返り値に含まれる next_cursor 属性と p``revious_cursor`` 属性の値を利用してリストの前後にページを移動する.

戻り値の型:

List[DirectMessage]

参照

https://developer.twitter.com/en/docs/twitter-api/v1/direct-messages/sending-and-receiving/api-reference/list-events

API.get_direct_message(id)

指定したダイレクトメッセージを返す.

パラメータ:: id -- 取得したいダイレクトメッセージのイベントの ID.
戻り値の型:: DirectMessage

参照

https://developer.twitter.com/en/docs/twitter-api/v1/direct-messages/sending-and-receiving/api-reference/get-event

API.send_direct_message(recipient_id, text, *, quick_reply_options, attachment_type, attachment_media_id, ctas)

認証したユーザから指定したユーザへ新しくダイレクトメッセージ (DM) を送る.

パラメータ:

recipient_id -- DM 送信先ユーザの ID.
text -- DM の内容. 最大 10,000 文字.
quick_reply_options -- オプションオブジェクトの配列 (最大 20).
attachment_type -- 添付形式. メディアまたは位置情報.
attachment_media_id -- DM に添付するメディアの ID. DM は 1 つの media_id だけ参照できる.
ctas -- 1 から 3 の call-to-action (CTA) ボタンオブジェクト配列.

戻り値の型:

DirectMessage

参照

https://developer.twitter.com/en/docs/twitter-api/v1/direct-messages/sending-and-receiving/api-reference/new-event

入力中表示と既読表示

API.indicate_direct_message_typing(recipient_id)

受信者と送信者のダイレクトメッセージの会話画面に, 視覚的な入力中アニメーションを表示する. 各リクエストは, ~3 秒間の入力中アニメーション表示をする.

バージョン 4.9 で追加.

パラメータ:: recipient_id -- 入力中表示を受け取るユーザの user ID

参照

https://developer.twitter.com/en/docs/twitter-api/v1/direct-messages/typing-indicator-and-read-receipts/api-reference/new-typing-indicator

API.mark_direct_message_read(last_read_event_id, recipient_id)

受信者と送信者のダイレクトメッセージ画面で, メッセージを既読する.

バージョン 4.9 で追加.

パラメータ:

last_read_event_id -- 既読にする最も直近のメッセージの ID. それ以前のメッセージもすべて既読になる.
recipient_id -- メッセージを送信したユーザの ID

参照

https://developer.twitter.com/en/docs/twitter-api/v1/direct-messages/typing-indicator-and-read-receipts/api-reference/new-read-receipt

メディア

メディアアップロード

API.get_media_upload_status(media_id)

複数メディアのアップロード進行状況を確認する. もしアップロードが成功していれば, media_id を使って画像つきツイートを作成できる.

パラメータ:: media_id -- 確認したいメディアの ID.
戻り値の型:: Media

参照

https://developer.twitter.com/en/docs/twitter-api/v1/media/upload-media/api-reference/get-media-upload-status

API.create_media_metadata(media_id, alt_text)

このメソッドはアップロードした media_id のメディアに追加情報を与えることができる. この機能は現在, 画像ファイルと GIF ファイルがサポートされている. これを呼び出すことで画像の代替テキスト (alt 要素) などを追加できる.

パラメータ:

media_id -- alt テキストを追加したいメディアの ID.
alt_text -- 画像に追加したい alt テキスト.

参照

https://developer.twitter.com/en/docs/twitter-api/v1/media/upload-media/api-reference/post-media-metadata-create

API.media_upload(filename, *, file, chunked, media_category, additional_owners)

Twitter にメディアをアップロードする際に使用する. これは API.simple_upload() か API.chunked_upload() を呼ぶことになる. API.chunked_upload() は動画のアップロード時に自動的に使用される. もし chunked が設定されているか, メディアが動画であった場合, API.chunked_upload() にキーワード引数として wait_for_async_finalize を指定することができる.

パラメータ:

filename -- アップロードするメディアのファイル名. 引数の file が指定されていない場合でも, 自動的にファイルオープンされる.
file -- filename を開く代わりに使用されるファイルオブジェクト. MIME タイプの検出と POST データのフォームフィールドとして使用するために, filename はまだ必要.
chunked -- chunked media upload (複数メディアアップロード用メソッド) を使用するかどうかのフラグ. デフォルトでは False.
media_category -- The category that represents how the media will be used. This field is required when using the media with the Ads API.
additional_owners -- A list of user IDs to set as additional owners allowed to use the returned media_id in Tweet or Cards. Up to 100 additional owners may be specified.

戻り値の型:

https://developer.twitter.com/en/docs/twitter-api/v1/media/upload-media/overview

参照

API.simple_upload(filename, *, file, media_category, additional_owners)

メディアを Twitter にアップロードする際はこの関数を使用する. この場合は chunked アップロード (複数ファイルのアップロード) を使用しない.

パラメータ:

filename -- アップロードするメディアのファイル名. 引数の file が指定されていない場合でも, 自動的にファイルオープンされる.
file -- filename を開く代わりに使用されるファイルオブジェクト. MIME タイプの検出と POST データのフォームフィールドとして使用するために, filename はまだ必要.
media_category -- The category that represents how the media will be used. This field is required when using the media with the Ads API.
additional_owners -- A list of user IDs to set as additional owners allowed to use the returned media_id in Tweet or Cards. Up to 100 additional owners may be specified.

戻り値の型:

https://developer.twitter.com/en/docs/twitter-api/v1/media/upload-media/api-reference/post-media-upload

参照

API.chunked_upload(filename, *, file, file_type, wait_for_async_finalize, media_category, additional_owners)

メディアを Twitter にアップロードする際はこの関数を使用する. この関数はチャンクアップロードエンドポイントを使用し, API.chunked_upload_init(),:func:API.chunked_upload_append, 及び:func:API.chunked_upload_finalize を呼ぶ. もし wait_for_async_finalize が設定されていれば:func:API.get_media_upload_status も呼びだす.

パラメータ:

filename -- アップロードするメディアのファイル名. 引数の file が指定されていない場合でも, 自動的にファイルオープンされる.
file -- filename を開く代わりに使用されるファイルオブジェクト. MIME タイプの検出と POST データのフォームフィールドとして使用するために, filename はまだ必要.
file_type -- アップロードしようとしているメディアの MIME タイプ.
wait_for_async_finalize -- Twitter API がメディアの処理を終えるのを待つかどうか. デフォルトでは True.
media_category -- The category that represents how the media will be used. This field is required when using the media with the Ads API.
additional_owners -- A list of user IDs to set as additional owners allowed to use the returned media_id in Tweet or Cards. Up to 100 additional owners may be specified.

戻り値の型:

https://developer.twitter.com/en/docs/twitter-api/v1/media/upload-media/uploading-media/chunked-media-upload

参照

API.chunked_upload_append(media_id, media, segment_index)

このメソッドではメディアファイルのチャンク (連続したバイト範囲) をアップロードする.

パラメータ:

media_id -- アップロード開始メソッド chunked_upload_init が返す media_id.
media -- アップロードする生のバイナリファイル. 5 MB 以下である必要がある.
segment_index -- ファイルチャンクの順序付きインデックス. 0 - 999 の範囲である必要がある. 最初のセグメントは 0, 次のセグメントは 1, ...と続く.

参照

https://developer.twitter.com/en/docs/twitter-api/v1/media/upload-media/api-reference/post-media-upload-append

API.chunked_upload_finalize(media_id)

メディアファイル全体が chunked_upload_append メソッドでアップロードされたあとに使うメソッド. レスポンスに processing_info field のみが含まれている場合, ツイートを作成処理をする前にステータスをチェックし, 成功するまで待つことが必要かもしれない.

パラメータ:: media_id -- アップロード開始メソッド chunked_upload_init が返す media_id.
戻り値の型:: Media

参照

https://developer.twitter.com/en/docs/twitter-api/v1/media/upload-media/api-reference/post-media-upload-finalize

API.chunked_upload_init(total_bytes, media_type, *, media_category, additional_owners)

チャンクファイル (連続したファイル) のアップロードセッションを開始するときに使うメソッド.

パラメータ:

total_bytes -- アップロードされるメディアのサイズ (バイト表示).
media_type -- アップロードしようとしているメディアの MIME タイプ.
media_category -- The category that represents how the media will be used. This field is required when using the media with the Ads API.
additional_owners -- A list of user IDs to set as additional owners allowed to use the returned media_id in Tweet or Cards. Up to 100 additional owners may be specified.

戻り値の型:

https://developer.twitter.com/en/docs/twitter-api/v1/media/upload-media/api-reference/post-media-upload-init

参照

トレンド

近くの場所のトレンド取得

API.get_place_trends(id *, exclude)

特定の WOEID (Where On Earth IDentifier; 地球上の場所に付けた識別子) において利用できるトレンド情報があれば TOP 50 までを返します.

返り値の「トレンド」オブジェクト配列は, エンコードされたトレンドトピックの名称, Twitter 検索でトピックを検索するためのクエリ及び Twitter 検索の URL を含みます.

この情報は 5 分間キャッシュされ, それ以上の頻度でリクエストしても新しい情報は返されません. さらに利用制限の使用量にカウントされます.

また可能であれば, 多くのトレンドにおける過去 24 時間の tweet_volume も返されます.

バージョン 4.0 で変更: Renamed from API.trends_place

パラメータ:

id -- トレンド情報を返したい場所の Yahoo! WOEID. WOEID として 1 を指定するとグローバルトレンドが得られる. (訳注: WOEID は海外の YAHOO! によって割り当てられている)
exclude -- ここにハッシュタグのキーワードを設定するとトレンドリストから除外する.

戻り値:

JSON

戻り値の型: