Twitter Rest APIで取得できるデータのまとめ
公開日:
Twitter Rest APIで取得できるJSONの内容をまとめています。各オブジェクトのサンプルを見たい場合は個別のページをご覧下さい。
ユーザーオブジェクト
ユーザーの情報を含んだオブジェクトです。プロフィールを取得した時などに含まれます。
- contributors_enabled
- 型: Boolean
- このアカウントが共用アカウントか否か。TweetDeckではアカウントを複数ユーザーで共用できるチームの機能がある。
trueなら共用アカウント。 - created_at
- 型: String
- アカウントの作成日時。
- default_profile
- 型: Boolean
- アカウントを登録してから、プロフィールを設定していないままの状態か。
trueなら、まだ設定していない状態。 - default_profile_image
- 型: Boolean
- アカウントを登録してから、アイコン画像を設定していないままの状態か。
trueなら、まだ設定していない状態(タマゴアイコン)。 - description
- 型: String
- プロフィールの詳細文。
- entities
- 型: Object
- プロフィールに含まれるエンティティ。エンティティオブジェクトを参照。
- favourites_count
- 型: Int
- 自分がお気に入りに登録したツイートの数。
- followers_count
- 型: Int
- フォロワーの数。
- following
- 型: Boolean
- アクセストークンの主がこのユーザーをフォローしているか否か。ユーザー認証でJSONを取得した場合に含まれる。
- follow_request_sent
- 型: Boolean
- アクセストークンの主がこのユーザーにフォローリクエストを送信している最中か否か。ユーザー認証でJSONを取得した場合に含まれる。
- friends_count
- 型: Int
- フォローしているユーザーの数。
- geo_enabled
- 型: Boolean
- ツイートに位置情報を追加するのを許可しているか。
- has_extended_profile
- 型: Boolean
- 何のプロパティか不明でした。情報提供をお待ちしております。
- id
- 型: Int
- 数値型のユーザーID。桁数が多い場合、サーバーによっては末尾の数が丸められてしまう。
- id_str
- 型: String
- 文字列型のユーザーID。
- is_translation_enabled
- 型: Boolean
- 何のプロパティか不明でした。情報提供をお待ちしております。
- is_translator
- 型: Boolean
- Twitterの翻訳コミュニティに参加しているか。
trueなら参加している。 - lang
- 型: String
- 言語。
- listed_count
- 型: Int
- 自分がユーザー(発言者)として加えられているリストの数。
- location
- 型: String
- ロケーション。
- name
- 型: String
- 名前。
- needs_phone_verification
- 型: Boolean
- 電話番号の認証が必要な状態か否か。
trueなら必要な状態で、操作が制限されている。 - notifications
- 型: Boolean
- アクセストークンの主がこのユーザーのツイートをモバイル通知するように設定しているか否か。ユーザー認証でJSONを取得した場合に含まれる。
- profile_background_color
- 型: String
- プロフィールの背景色。利用されていない。
- profile_background_image_url
- 型: String
- プロフィールの背景画像ファイルのURLアドレス。利用されていない。
- profile_background_image_url_https
- 型: String
- プロフィールの背景画像ファイルのSSL通信のURLアドレス。利用されていない。
- profile_background_tile
- 型: Boolean
- プロフィールの背景画像を繰り返し表示するか。
trueなら繰り返し表示をする。利用されていない。 - profile_banner_url
- 型: String
- ヘッダー画像ファイルのSSL通信のURLアドレス。
- profile_image_url
- 型: String
- アイコンの画像ファイルのURLアドレス。
- profile_image_url_https
- 型: String
- アイコンの画像ファイルのSSL通信のURLアドレス。
- profile_link_color
- 型: String
- テーマカラー。
- profile_location
- 型: Object
- ロケーションに場所の情報を紐付けている場合、その場所のPlace Objectが含まれる。
- profile_sidebar_border_color
- 型: String
- サイドバーの境界線の色。利用されていない。
- profile_sidebar_fill_color
- 型: String
- サイドバーの塗りつぶしの色。利用されていない。
- profile_text_color
- 型: String
- 文字色。利用されていない。
- profile_use_background_image
- 型: Boolean
- プロフィールの背景画像を有効にするか。
trueなら有効にする。利用されていない。 - protected
- 型: Boolean
- ツイートを非公開にしているか。
trueなら非公開、falseなら公開。 - screen_name
- 型: String
- スクリーンネーム。
- status
- 型: Object
- 最新のツイートを表すTweet Object。
- statuses_count
- 型: Int
- ツイートの合計数。
- suspended
- 型: Boolean
- アカウントが凍結中か否か。
trueなら凍結中。ただし、凍結中のユーザーを取得しようとするとそもそもエラーになるので、このプロパティの意味があるかは不明。 - time_zone
- 型: String
- タイムゾーン。
- translator_type
- 型: String
- 翻訳者のランク。
- url
- 型: String
- ウェブサイト。
- utc_offset
- 型: Int
- このユーザーのタイムゾーンにおける、UTCからのオフセット秒数。
- verified
- 型: Boolean
- 認証アカウントか否か。
trueなら認証アカウントで、ユーザー名の横にチェックマークが付く。
- User Object(ユーザーオブジェクト)の説明
- Twitter Rest APIで取得できるUser Object(ユーザーオブジェクト)の、各プロパティがどんなデータなのかをまとめてあります。
ツイートオブジェクト
ツイートの情報を含んだオブジェクトです。ツイートを取得した時などに含まれます。
- contributors
- 型: Array
- TweetDeckにある、1つのアカウントを複数人で運用するチーム機能を使ってツイートを投稿した場合に、チームのユーザー全員のユーザーIDとスクリーンネームが含まれる。
- coordinates
- 型: Object
- ツイートに正確な位置情報が紐づいている場合、geoJSONが含まれる。
- type
- ジオメトリーの種類。値は
Point。 - coordinates
- 位置座標の配列。第1要素が経度で、第2要素が緯度。
- created_at
- 型: String
- ツイートの投稿日時。
- entities
- 型: Object
- ツイート本文のエンティティ。本文にリンクを付けてリッチテキスト化する材料となる情報。エンティティオブジェクトを参照。
- extended_entities
- 型: Object
- ツイート本文を拡張するエンティティ。画像や動画などを、本文に付け足すための情報。エンティティオブジェクトを参照。
- favorited
- 型: Boolean
- アクセストークンの主が、このツイートをお気に入りに登録しているか。ユーザー認証で取得した場合に含まれる。
- favorite_count
- 型: Int
- このツイートがお気に入りに登録された数。
- geo
- 型: Object
- ツイートに正確な位置情報が紐づいている場合、geoJSONが含まれる。このプロパティは非推奨で、代わりにcoordinatesを利用するのが望ましい。
- type
- ジオメトリーの種類。値は
Point。 - coordinates
- 位置座標の配列。第1要素が緯度で、第2要素が経度。
- id
- 型: Int
- 数値型のツイートID。桁数が多い場合、サーバーによっては末尾の数が丸められてしまう。
- id_str
- 型: String
- 文字列型のツイートID。
- in_reply_to_screen_name
- 型: String
- ツイートがリプライの場合、返信先のユーザーのスクリーンネーム。
- in_reply_to_status_id
- 型: Int
- ツイートがリプライの場合、返信先のツイートのID。数値なので、桁数が多いとサーバーによっては末尾が丸められる。
- in_reply_to_status_id_str
- 型: String
- ツイートがリプライの場合、返信先のツイートのID。文字列型。
- in_reply_to_user_id
- 型: Int
- ツイートがリプライの場合、返信先のユーザーのID。数値なので、桁数が多いとサーバーによっては末尾が丸められる。
- in_reply_to_user_id_str
- 型: String
- ツイートがリプライの場合、返信先のユーザーのID。文字列型。
- is_quote_status
- 型: Boolean
- ツイートが引用リツイートの場合、
trueになる。 - lang
- 型: String
- ツイートの言語。
- place
- 型: Object
- ツイートに場所の情報が紐づいている場合、Place Objectが含まれる。
- quoted_status
- 型: Object
- ツイートが引用リツイートの場合、元のツイートのTweet Object。
- quoted_status_id
- 型: Int
- ツイートが引用リツイートの場合、元のツイートのID。数値なので、桁数が多いとサーバーによっては末尾が丸められる。
- quoted_status_id_str
- 型: Int
- ツイートが引用リツイートの場合、元のツイートのID。文字列型。
- retweeted
- 型: Boolean
- アクセストークンの主が、このツイートをリツイートしているか。ユーザー認証で取得した場合に含まれる。
- retweeted_status
- 型: Object
- ツイートが公式リツイートの場合、元のツイートのTweet Object。
- retweet_count
- 型: Int
- このツイートがリツイートされた数。
- source
- 型: String
- ツイートを投稿したアプリケーション。リッチテキストになっている。
- text
- 型: String
- ツイートの本文。URLやハッシュタグにリンクが付いていない状態。
- truncated
- 型: Boolean
- 取得したツイート(
text)が切り取られているか否か。例えば、こちらのツイートのように本文を140文字にして画像を添付したツイートは、APIで取得した時に末尾が…となって切り取られる。 - user
- 型: Object
- ツイートを投稿したユーザーの情報を含んだUser Object。
- Tweet Object(ツイートオブジェクト)の説明
- Twitter Rest APIで取得できるTweet Object(ツイートオブジェクト)の、各プロパティがどんなデータなのかをまとめてあります。
エンティティオブジェクト
テキストをリッチテキスト化したり、画像や動画を表示するための情報を含んだオブジェクトです。ユーザーオブジェクトやツイートオブジェクトに含まれます。
- description
- 型: Array
- ユーザーオブジェクトに含まれる。プロフィールの紹介文をリッチテキスト化するための情報。中身はurlsプロパティが含まれる。
- hashtags
- 型: Array
- ハッシュタグのエンティティ。ツイートに含まれるハッシュタグの数だけオブジェクトを含む。各オブジェクトのプロパティは下記の通り。
- text
- 置換後に適した文字列。
- indices
- テキスト中の該当部分の位置を表す配列。第1要素が開始の位置、第2要素が終了の位置。
- media
- 型: Array
- メディアファイルのエンティティ。ツイートに含まれるメディアファイルの数だけオブジェクトを含む。各オブジェクトのプロパティは下記の通り。画像と動画で内容が違うので注意。
- id
- メディアID。数値型。
- id_str
- メディアID。文字列型。
- indices
- テキスト中の該当部分の位置を表す配列。第1要素が開始の位置、第2要素が終了の位置。
- media_url
- メディアファイルそのもののURL。
- media_url_https
- メディアファイルそのもののURL。SSL版。
- url
- 置換後に適した文字列。短縮URL。
- display_url
- リッチテキスト化する時に、これに置換すると見栄えが良い文字列。URLのホスト。
- expanded_url
- メディアファイルを表示するページのURL。
- type
- メディアファイルの種類。画像は
photo、動画はvideo。 - sizes
- リサイズされたメディアファイルの各サイズ。リサイズの種類には切り取り(
crop)と、アスペクト比を維持した縮小(fit)がある。 - video_info
- 動画ファイルの場合に、情報が含まれる。動画ファイルのアスペクト比(
aspect_ratio)と、リサイズされた各サイズ(variants)。
- symbols
- 型: Array
- シンボルタグのエンティティ。ツイートに含まれるシンボルタグの数だけオブジェクトを含む。各オブジェクトのプロパティは下記の通り。
- text
- 置換後に適した文字列。
- indices
- テキスト中の該当部分の位置を表す配列。第1要素が開始の位置、第2要素が終了の位置。
- url
- 型: Array
- ユーザーオブジェクトに含まれる。プロフィールのウェブサイトをリッチテキスト化するための情報。中身はurlsプロパティが含まれる。
- urls
- 型: Array
- URLのエンティティ。ツイートやプロフィールに含まれるURLの数だけオブジェクトを含む。各オブジェクトのプロパティは下記の通り。
- url
- 置換後に適した文字列。短縮URL。
- expanded_url
- 本来のURL。
- display_url
- リッチテキスト化する時に、これに置換すると見栄えが良い文字列。URLのホスト。
- indices
- テキスト中の該当部分の位置を表す配列。第1要素が開始の位置、第2要素が終了の位置。
- user_mentions
- 型: Array
- ユーザーメンションのエンティティ。ツイートに含まれるメンションの数だけオブジェクトを含む。各オブジェクトのプロパティは下記の通り。
- screen_name
- メンションを送った相手ユーザーのスクリーンネーム。
- name
- メンションを送った相手ユーザーの名前。
- id
- メンションを送った相手ユーザーのユーザーID。数値型。
- id_str
- メンションを送った相手ユーザーのユーザーID。文字列型。
- indices
- テキスト中の該当部分の位置を表す配列。第1要素が開始の位置、第2要素が終了の位置。
- Entity Object(エンティティオブジェクト)の説明
- Twitter Rest APIで取得できるEntity Object(エンティティオブジェクト)の、各プロパティがどんなデータなのかをまとめてあります。
リストオブジェクト
リストの情報を含んだオブジェクトです。リストを取得した時に含まれます。
- created_at
- 型: String
- リストの作成日時。
- description
- 型: String
- リストの説明文。
- following
- 型: Boolean
- アクセストークンの主が、このリストを購読している場合は
trueになる。 - full_name
- 型: String
- リストのオーナー(作成者)のスクリーンネームと、スラッグの組み合わせ。何に利用するデータかは不明。
- id
- 型: Int
- 数値型のリストID。桁数が多い場合、サーバーによっては末尾の数が丸められてしまう。
- id_str
- 型: String
- 文字列型のリストID。
- member_count
- 型: Int
- リストに追加されているユーザー(発言者)の数。
- mode
- 型: String
- リストのモード。公開の場合は
public、非公開の場合はprivateになる。 - name
- 型: String
- リストの名前。
- slug
- 型: String
- リストのスラッグ。
- subscriber_count
- 型: Int
- リストの購読者(保存したユーザー)の数。
- uri
- 型: String
- リストのパス。
https://twitter.comと繋げるとURLアドレスになる。 - user
- 型: Object
- オーナー(作成者)であるユーザーの情報を含んだユーザーオブジェクト。
- List Object(リストオブジェクト)の説明
- Twitter Rest APIで取得できるList Object(リストオブジェクト)の、各プロパティがどんなデータなのかをまとめてあります。
場所オブジェクト
場所の情報を含んだオブジェクトです。ユーザーのロケーションや、ツイートを投稿した場所などを表します。
- attributes
- 型: Object
- この場所の属性を含んだオブジェクト。場所によって含まれるプロパティが違う。日本の場所の場合、ほとんど情報が含まれていないので期待しない方がいい。
- id
- 属性ID。
- geotagCount
- ジオタグの数。
- street_address
- 番地。
- postal_code
- 郵便番号。
- phone
- 電話番号。
- region
- 地域。
- bounding_box
- 型: Object
- この場所の境界(範囲)を表すgeoJSON。
- type
- ジオメトリーの種類。値は
Polygon。 - coordinates
- 境界の角を表す位置座標の配列。何個含まれているかは境界の形によって違う。各要素の第1要素が経度、第2要素が緯度。
- centroid
- 型: Array
- この場所の中心の位置座標を表す配列。第1要素が経度で、第2要素が緯度。
- contained_within
- 型: Object
- 東京が日本に含まれているように、この場所が他の場所に含まれている場合は、その場所の場所オブジェクトがこのプロパティに含まれる。
- country
- 型: Boolean
- 場所の国名。
- country_code
- 型: Boolean
- 場所の国コード。
- full_name
- 型: Boolean
- 場所の正式名称。
- geometry
- 型: Object
- この場所がピンポイントの位置座標を持つ特定の場所だった場合にgeoJSONが含まれる。
- type
- ジオメトリーの種類。値は
Point。 - coordinates
- 位置座標の配列。第1要素が経度で、第2要素が緯度。
- id
- 型: Boolean
- 場所のID。
- name
- 型: Boolean
- 場所の通称。
- place_type
- 型: Boolean
- 場所の種類。
- polylines
- 型: Array
- 空の値以外を見たことがないため不明です。この場所がポリラインのジオタグを持っている場合、ポリラインのgeoJSONが含まれると予想しています。情報提供をお待ちしております。
- url
- 型: Boolean
- 場所のURL。これは、Twitter Rest APIのGET geo/id/:place_idを利用して場所を取得する時のエンドポイントのURL。
- Place Object(場所オブジェクト)の説明
- Twitter Rest APIで取得できるPlace Object(場所オブジェクト)の、各プロパティがどんなデータなのかをまとめてあります。
ダイレクトメッセージオブジェクト
ダイレクトメッセージの情報を含んだオブジェクトです。ダイレクトメッセージを取得した時に含まれます。
- created_at
- 型: String
- ダイレクトメッセージの送信日時。
- entities
- 型: Object
- ダイレクトメッセージのエンティティ。本文(
text)をリッチテキスト化するための情報が含まれている。エンティティオブジェクトを参照。 - id
- 型: Int
- 数値型のダイレクトメッセージID。桁数が多い場合、サーバーによっては末尾の数が丸められてしまう。
- id_str
- 型: String
- 文字列型のダイレクトメッセージID。
- recipient
- 型: Object
- メッセージを受け取ったユーザーの情報を含んだユーザーオブジェクト。
- recipient_id
- 型: Int
- メッセージの受け取ったユーザーのユーザーID。数値型なので桁数が多い場合、サーバーによっては末尾の数が丸められてしまう。。
- recipient_id_str
- 型: String
- メッセージの受け取ったユーザーのユーザーID。文字列型。
- recipient_screen_name
- 型: String
- メッセージの受け取ったユーザーのスクリーンネーム。
- sender
- 型: Object
- メッセージを送ったユーザーの情報を含んだユーザーオブジェクト。
- sender_id
- 型: Int
- メッセージの送ったユーザーのユーザーID。数値型なので桁数が多い場合、サーバーによっては末尾の数が丸められてしまう。。
- sender_id_str
- 型: String
- メッセージの送ったユーザーのユーザーID。文字列型。
- sender_screen_name
- 型: String
- メッセージの送ったユーザーのスクリーンネーム。
- text
- 型: Boolean
- ダイレクトメッセージの本文。リッチテキストにはなっていない。
- Direct Message Object(ダイレクトメッセージオブジェクト)の説明
- Twitter Rest APIで取得できるDirect Message Object(ダイレクトメッセージオブジェクト)の、各プロパティがどんなデータなのかをまとめてあります。
検索メモオブジェクト
検索メモの情報を含んだオブジェクトです。検索メモを取得した時に含まれます。
- created_at
- 型: String
- 検索メモの作成日時。
- id
- 型: Int
- 数値型の検索メモID。桁数が多い場合、サーバーによっては末尾の数が丸められてしまう。
- id_str
- 型: String
- 文字列型の検索メモID。
- name
- 型: String
- 検索メモに付けられた名前。ユーザー側で操作することはできない。
- position
- 何のプロパティなのか不明です。
null以外の値を見たことがありません。情報提供をお待ちしております。 - query
- 型: String
- 検索クエリ。
- Saved Search Object(検索メモオブジェクト)の説明
- Twitter Rest APIで取得できるSaved Search Object(検索メモオブジェクト)の、各プロパティがどんなデータなのかをまとめてあります。
トレンドオブジェクト
トレンドの情報を含んだオブジェクトです。トレンドワードを取得した時に含まれます。
- as_of
- 型: String
- トレンドを取得した日時。
- created_at
- 型: String
- トレンドのデータが更新された日時。
- locations
- 型: Array
- トレンドの対象地域の情報を含む配列。各要素は次のプロパティを持つ。
- name
- 地域の名称。
- woeid
- 地域のWOEID。
- trends
- 型: Array
- トレンドワードを含む配列。各要素は次のプロパティを持つ。
- name
- トレンドワード。
- url
- そのトレンドワードでツイートを検索した結果のURLアドレス。
- promoted_content
null以外の値を見たことがないので不明です。プロモーションのトレンドの場合にtrueになると予想される。情報提供をお待ちしております。- query
- このトレンドでツイートを検索するためのクエリ。
- tweet_volume
- このトレンドワードのツイート数。このプロパティの値がないトレンドワードもあるので注意。
- Trend Object(トレンドオブジェクト)の説明
- Twitter Rest APIで取得できるTrend Object(トレンドオブジェクト)の、各プロパティがどんなデータなのかをまとめてあります。