Models
List
- class tweepy.List
The list object contains Twitter Lists metadata describing the referenced List. The List object is the primary object returned in the List lookup endpoint. When requesting additional List fields on this endpoint, simply use the fields parameter
list.fields
.At the moment, the List object cannot be found as a child object from any other data object. However, user objects can be found and expanded in the user resource. These objects are available for expansion by adding
owner_id
to theexpansions
query parameter. Use the expansion with the field parameter:list.fields
when requesting additional fields to complete the primary List object anduser.fields
to complete the expansion object.버전 4.4에 추가.
- created_at
The UTC datetime that the List was created on Twitter.
- Type
참조
https://developer.twitter.com/en/docs/twitter-api/data-dictionary/object-model/lists
Media
- class tweepy.Media
Media refers to any image, GIF, or video attached to a Tweet. The media object is not a primary object on any endpoint, but can be found and expanded in the Tweet object.
The object is available for expansion with
?expansions=attachments.media_keys
to get the condensed object with only default fields. Use the expansion with the field parameter:media.fields
when requesting additional fields to complete the object..버전 4.0에 추가.
버전 4.5에서 변경: Added
url
field- non_public_metrics
Non-public engagement metrics for the media content at the time of the request.
Requires user context authentication.
- organic_metrics
Engagement metrics for the media content, tracked in an organic context, at the time of the request.
Requires user context authentication.
- promoted_metrics
Engagement metrics for the media content, tracked in a promoted context, at the time of the request.
Requires user context authentication.
- public_metrics
Public engagement metrics for the media content at the time of the request.
- alt_text
A description of an image to enable and support accessibility. Can be up to 1000 characters long. Alt text can only be added to images at the moment.
참조
https://developer.twitter.com/en/docs/twitter-api/data-dictionary/object-model/media
Place
- class tweepy.Place
The place tagged in a Tweet is not a primary object on any endpoint, but can be found and expanded in the Tweet resource.
The object is available for expansion with
?expansions=geo.place_id
to get the condensed object with only default fields. Use the expansion with the field parameter:place.fields
when requesting additional fields to complete the object.버전 4.0에 추가.
- id
The unique identifier of the expanded place, if this is a point of interest tagged in the Tweet.
- Type
- contained_within
Returns the identifiers of known places that contain the referenced place.
- Type
- place_type
Specified the particular type of information represented by this place information, such as a city name, or a point of interest.
참조
https://developer.twitter.com/en/docs/twitter-api/data-dictionary/object-model/place
Poll
- class tweepy.Poll
A poll included in a Tweet is not a primary object on any endpoint, but can be found and expanded in the Tweet object.
The object is available for expansion with
?expansions=attachments.poll_ids
to get the condensed object with only default fields. Use the expansion with the field parameter:poll.fields
when requesting additional fields to complete the object.버전 4.0에 추가.
- end_datetime
Specifies the end date and time for this poll.
- Type
- voting_status
Indicates if this poll is still active and can receive votes, or if the voting is now closed.
참조
https://developer.twitter.com/en/docs/twitter-api/data-dictionary/object-model/poll
Space
- class tweepy.Space
Spaces allow expression and interaction via live audio conversations. The Space data dictionary contains relevant metadata about a Space; all the details are updated in real time.
User objects can found and expanded in the user resource. These objects are available for expansion by adding at least one of
host_ids
,creator_id
,speaker_ids
,mentioned_user_ids
to theexpansions
query parameter.Unlike Tweets, Spaces are ephemeral and become unavailable after they end or when they are canceled by their creator. When your app handles Spaces data, you are responsible for returning the most up-to-date information, and must remove data that is no longer available from the platform. The Spaces lookup endpoints can help you ensure you respect the users’ expectations and intent.
버전 4.1에 추가.
버전 4.4에서 변경: Added
ended_at
andtopic_ids
fields버전 4.6에서 변경: Added
subscriber_count
field- created_at
Creation time of this Space.
- Type
- ended_at
Time when the Space was ended. Only available for ended Spaces.
- Type
- lang
Language of the Space, if detected by Twitter. Returned as a BCP47 language tag.
- invited_user_ids
The list of user IDs that were invited to join as speakers. Usually, users in this list are invited to speak via the Invite user option.
- Type
- participant_count
The current number of users in the Space, including Hosts and Speakers.
- scheduled_start
Indicates the start time of a scheduled Space, as set by the creator of the Space. This field is returned only if the Space has been scheduled; in other words, if the field is returned, it means the Space is a scheduled Space.
- Type
- speaker_ids
The list of users who were speaking at any point during the Space. This list contains all the users in
invited_user_ids
in addition to any user who requested to speak and was allowed via the Add speaker option.- Type
- started_at
Indicates the actual start time of a Space.
- Type
- updated_at
Specifies the date and time of the last update to any of the Space’s metadata, such as its title or scheduled time.
- Type
참조
https://developer.twitter.com/en/docs/twitter-api/data-dictionary/object-model/space
Tweet
- class tweepy.Tweet
Tweets are the basic building block of all things Twitter. The Tweet object has a long list of ‘root-level’ fields, such as
id
,text
, andcreated_at
. Tweet objects are also the ‘parent’ object to several child objects includinguser
,media
,poll
, andplace
. Use the field parametertweet.fields
when requesting these root-level fields on the Tweet object.The Tweet object that can be found and expanded in the user resource. Additional Tweets related to the requested Tweet can also be found and expanded in the Tweet resource. The object is available for expansion with
?expansions=pinned_tweet_id
in the user resource or?expansions=referenced_tweets.id
in the Tweet resource to get the object with only default fields. Use the expansion with the field parameter:tweet.fields
when requesting additional fields to complete the object.버전 4.0에 추가.
- text
The actual UTF-8 text of the Tweet. See twitter-text for details on what characters are currently considered valid.
- Type
- conversation_id
The Tweet ID of the original Tweet of the conversation (which includes direct replies, replies of replies).
- created_at
Creation time of the Tweet.
- Type
- entities
Entities which have been parsed out of the text of the Tweet. Additionally see entities in Twitter Objects.
- geo
Contains details about the location tagged by the user in this Tweet, if they specified one.
- in_reply_to_user_id
If the represented Tweet is a reply, this field will contain the original Tweet’s author ID. This will not necessarily always be the user directly mentioned in the Tweet.
- lang
Language of the Tweet, if detected by Twitter. Returned as a BCP47 language tag.
- non_public_metrics
Non-public engagement metrics for the Tweet at the time of the request.
Requires user context authentication.
- organic_metrics
Engagement metrics, tracked in an organic context, for the Tweet at the time of the request.
Requires user context authentication.
- possibly_sensitive
This field only surfaces when a Tweet contains a link. The meaning of the field doesn’t pertain to the Tweet content itself, but instead it is an indicator that the URL contained in the Tweet may contain content or media identified as sensitive content.
- promoted_metrics
Engagement metrics, tracked in a promoted context, for the Tweet at the time of the request.
Requires user context authentication.
- public_metrics
Public engagement metrics for the Tweet at the time of the request.
- referenced_tweets
A list of Tweets this Tweet refers to. For example, if the parent Tweet is a Retweet, a Retweet with comment (also known as Quoted Tweet) or a Reply, it will include the related Tweet referenced to by its parent.
- Type
- reply_settings
Shows you who can reply to a given Tweet. Fields returned are 《everyone》, 《mentioned_users》, and 《followers》.
- withheld
When present, contains withholding details for withheld content.
참조
https://developer.twitter.com/en/docs/twitter-api/data-dictionary/object-model/tweet
User
- class tweepy.User
The user object contains Twitter user account metadata describing the referenced user. The user object is the primary object returned in the users lookup endpoint. When requesting additional user fields on this endpoint, simply use the fields parameter
user.fields
.The user object can also be found as a child object and expanded in the Tweet object. The object is available for expansion with
?expansions=author_id
or?expansions=in_reply_to_user_id
to get the condensed object with only default fields. Use the expansion with the field parameter:user.fields
when requesting additional fields to complete the object.버전 4.0에 추가.
- name
The name of the user, as they’ve defined it on their profile. Not necessarily a person’s name. Typically capped at 50 characters, but subject to change.
- Type
- username
The Twitter screen name, handle, or alias that this user identifies themselves with. Usernames are unique but subject to change. Typically a maximum of 15 characters long, but some historical accounts may exist with longer names.
- Type
- created_at
The UTC datetime that the user account was created on Twitter.
- Type
- description
The text of this user’s profile description (also known as bio), if the user provided one.
- entities
Contains details about text that has a special meaning in the user’s description.
- location
The location specified in the user’s profile, if the user provided one. As this is a freeform value, it may not indicate a valid location, but it may be fuzzily evaluated when performing searches with location queries.
- profile_image_url
The URL to the profile image for this user, as shown on the user’s profile.
- protected
Indicates if this user has chosen to protect their Tweets (in other words, if this user’s Tweets are private).
- withheld
Contains withholding details for withheld content, if applicable.
참조
https://developer.twitter.com/en/docs/twitter-api/data-dictionary/object-model/user