メインコンテンツへスキップ

PostsClient

クラス 基底クラス: object 投稿に関する操作を行う Client

コンストラクタ

__init__

パラメーター

path.client
Client

create

ポストの作成または編集 認証済みユーザーの新しいポストを新規作成するか、edit_options が指定されている場合は既存のポストを編集します。 body: リクエストボディ :returns: レスポンスデータ :rtype: CreateResponse

パラメータ

body.body
CreateRequest

delete

ポストの削除 認証済みユーザーが所有している場合、そのIDを指定して特定のポストを削除します。

パラメータ

path.id
Any
削除対象のポストのID。

戻り値

DeleteResponse - レスポンスデータ

get_analytics

投稿のアナリティクスの取得 指定した期間内の特定の投稿のアナリティクスデータを取得します。

パラメーター

path.ids
List
カンマ区切りのポストIDのリストです。1回のリクエストで最大100個まで指定できます。
path.end_time
str
YYYY-MM-DDTHH:mm:ssZ。時間範囲の終了を表す UTC タイムスタンプです。
path.start_time
str
YYYY-MM-DDTHH:mm:ssZ。時間範囲の開始を表す UTC タイムスタンプです。
path.granularity
str
検索カウント結果の粒度を指定します。
path.analytics_fields
List or None
デフォルト:"None"
表示する Analytics フィールドのカンマ区切りリストです。

戻り値

GetAnalyticsResponse - レスポンスデータ

get_by_id

ID でポストを取得 指定した ID のポストの詳細を取得します。

パラメーター

path.id
Any
1つのポストのID。
path.tweet_fields
List or None
デフォルト:"None"
表示するツイートのフィールドをカンマ区切りリストで指定します。
path.expansions
List or None
デフォルト:"None"
展開するフィールドをカンマ区切りリストで指定します。
path.media_fields
List or None
デフォルト:"None"
表示するメディアのフィールドをカンマ区切りリストで指定します。
path.poll_fields
List or None
デフォルト:"None"
表示する投票のフィールドをカンマ区切りリストで指定します。
path.user_fields
List or None
デフォルト:"None"
表示するユーザーのフィールドをカンマ区切りリストで指定します。
path.place_fields
List or None
デフォルト:"None"
表示する場所のフィールドをカンマ区切りリストで指定します。

戻り値

GetByIdResponse - レスポンスデータ

get_by_ids

ID で複数の投稿を取得 複数の投稿を、その ID を指定して取得します。

パラメーター

path.ids
List
カンマ区切りのポストIDのリストです。1回のリクエストで最大100件まで指定できます。
path.tweet_fields
List or None
デフォルト:"None"
表示するツイートのフィールドをカンマ区切りのリストで指定します。
path.expansions
List or None
デフォルト:"None"
展開するフィールドをカンマ区切りのリストで指定します。
path.media_fields
List or None
デフォルト:"None"
表示するMediaオブジェクトのフィールドをカンマ区切りのリストで指定します。
path.poll_fields
List or None
デフォルト:"None"
表示するPollオブジェクトのフィールドをカンマ区切りのリストで指定します。
path.user_fields
List or None
デフォルト:"None"
表示するUserオブジェクトのフィールドをカンマ区切りのリストで指定します。
path.place_fields
List or None
デフォルト:"None"
表示するPlaceオブジェクトのフィールドをカンマ区切りのリストで指定します。

戻り値

GetByIdsResponse - レスポンスデータ

get_counts_all

すべての投稿数を取得します フルアーカイブから検索クエリに一致する投稿数を取得します。

Parameters

path.query
str
投稿にマッチするクエリ/ルール/フィルターを 1 つ指定します。最大クエリ長を確認するには https://t.co/rulelength を参照してください。
path.start_time
str or None
デフォルト:"None"
YYYY-MM-DDTHH:mm:ssZ。直近 7 日間の範囲で、投稿が取得される最も古い UTC タイムスタンプです。タイムスタンプは秒単位で、下限は含まれます(例: 12:00:01 はその分の最初の 1 秒を含みます)。
path.end_time
str or None
デフォルト:"None"
YYYY-MM-DDTHH:mm:ssZ。投稿が取得される最新の UTC タイムスタンプです。タイムスタンプは秒単位で、上限は含まれません(例: 12:00:01 はその分の最初の 1 秒を含みません)。
path.since_id
Any or None
デフォルト:"None"
指定した ID より大きい(つまり、より新しい)ポスト ID を持つ結果を返します。
path.until_id
Any or None
デフォルト:"None"
指定した ID より小さい(つまり、より古い)ポスト ID を持つ結果を返します。
path.next_token
Any or None
デフォルト:"None"
次の「ページ」の結果を取得するために使用されるパラメータです。このパラメータで使用する値は、API が返すレスポンスから直接取得されるものであり、変更してはいけません。
path.pagination_token
Any or None
デフォルト:"None"
次の「ページ」の結果を取得するために使用されるパラメータです。このパラメータで使用する値は、API が返すレスポンスから直接取得されるものであり、変更してはいけません。
path.granularity
str or None
デフォルト:"None"
検索カウント結果の集計粒度を指定します。
path.search_count_fields
List or None
デフォルト:"None"
表示する SearchCount フィールドをカンマ区切りで指定するリストです。

戻り値

IteratorGetCountsAllResponse

get_counts_recent

最近の投稿数を取得 検索クエリに一致する、過去7日間の投稿数を取得します。

Parameters

path.query
str
投稿にマッチさせるための 1 つのクエリ/ルール/フィルターです。クエリの最大長を確認するには https://t.co/rulelength を参照してください。
path.start_time
str or None
デフォルト:"None"
YYYY-MM-DDTHH:mm:ssZ。投稿が返されるうち、最も古い UTC タイムスタンプ(直近 7 日以内)です。タイムスタンプは秒単位の粒度で、包含的です(例: 12:00:01 はその分の最初の 1 秒を含みます)。
path.end_time
str or None
デフォルト:"None"
YYYY-MM-DDTHH:mm:ssZ。投稿が返されるうち、最新の UTC タイムスタンプです。タイムスタンプは秒単位の粒度で、排他的です(例: 12:00:01 はその分の最初の 1 秒を含みません)。
path.since_id
Any or None
デフォルト:"None"
指定した ID より大きい(つまり、より新しい)ポスト ID を持つ結果を返します。
path.until_id
Any or None
デフォルト:"None"
指定した ID より小さい(つまり、より古い)ポスト ID を持つ結果を返します。
path.next_token
Any or None
デフォルト:"None"
このパラメータは、次の「ページ」の結果を取得するために使用します。パラメータに指定する値は、API が返すレスポンスから直接取得されるものであり、変更してはいけません。
path.pagination_token
Any or None
デフォルト:"None"
このパラメータは、次の「ページ」の結果を取得するために使用します。パラメータに指定する値は、API が返すレスポンスから直接取得されるものであり、変更してはいけません。
path.granularity
str or None
デフォルト:"None"
検索結果数の集計粒度を指定します。
path.search_count_fields
List or None
デフォルト:"None"
表示する SearchCount フィールドのカンマ区切りのリストです。

戻り値

IteratorGetCountsRecentResponse

get_insights28hr

28時間分のポストインサイトを取得 指定した投稿の直近28時間分のエンゲージメント指標を取得します。

パラメーター

path.tweet_ids
List
28時間分のメトリクスを取得する対象PostIdのリスト。
path.granularity
str
メトリクスレスポンスの粒度。
path.requested_metrics
List
履歴リクエストで取得を要求するメトリクス。
path.engagement_fields
List or None
デフォルト:"None"
表示するエンゲージメントフィールドをカンマ区切りで指定するリスト。

戻り値

GetInsights28hrResponse - レスポンスデータ

get_insights_historical

過去のポストインサイトを取得する 指定した投稿の、指定した期間内における過去のエンゲージメント指標を取得します。

Parameters

path.tweet_ids
List
過去のメトリクスを取得するためのポストの id のリスト。
path.end_time
str
YYYY-MM-DDTHH:mm:ssZ。時間範囲の終了時刻を表す UTC タイムスタンプ。
path.start_time
str
YYYY-MM-DDTHH:mm:ssZ。時間範囲の開始時刻を表す UTC タイムスタンプ。
path.granularity
str
メトリクスレスポンスの粒度。
path.requested_metrics
List
過去のメトリクス取得でリクエストするメトリクス。
path.engagement_fields
List or None
デフォルト:"None"
表示するエンゲージメントのフィールドをカンマ区切りで指定したリスト。

戻り値

GetInsightsHistoricalResponse - レスポンスデータ

get_liking_users

いいねしたユーザーを取得 IDで指定した特定のポストをいいねしたユーザーのリストを取得します。

パラメータ

path.id
Any
1 つのポスト ID。
path.max_results
int or None
デフォルト:"None"
結果の最大数。
path.pagination_token
Any or None
デフォルト:"None"
次の「ページ」の結果を取得するために使用されるパラメータです。
path.user_fields
List or None
デフォルト:"None"
表示するユーザーのフィールドをカンマ区切りのリストで指定します。
path.expansions
List or None
デフォルト:"None"
展開するフィールドをカンマ区切りのリストで指定します。
path.tweet_fields
List or None
デフォルト:"None"
表示するツイートのフィールドをカンマ区切りのリストで指定します。

戻り値

IteratorGetLikingUsersResponse

get_quoted

引用された投稿を取得 指定したポストのidを指定して、そのポストを引用している投稿のリストを取得します。

Parameters

path.id
Any
1件のポストのID。
path.max_results
int or None
デフォルト:"None"
返される結果の最大数。
path.pagination_token
Any or None
デフォルト:"None"
特定の「ページ」の結果を取得するために使用されるパラメータ。
path.exclude
List or None
デフォルト:"None"
除外するエンティティの集合(例:「replies」や「retweets」など)。
path.tweet_fields
List or None
デフォルト:"None"
表示するツイートのフィールドをカンマ区切りのリストで指定します。
path.expansions
List or None
デフォルト:"None"
展開するフィールドをカンマ区切りのリストで指定します。
path.media_fields
List or None
デフォルト:"None"
表示するMediaのフィールドをカンマ区切りのリストで指定します。
path.poll_fields
List or None
デフォルト:"None"
表示するPollのフィールドをカンマ区切りのリストで指定します。
path.user_fields
List or None
デフォルト:"None"
表示するUserのフィールドをカンマ区切りのリストで指定します。
path.place_fields
List or None
デフォルト:"None"
表示するPlaceのフィールドをカンマ区切りのリストで指定します。

戻り値

IteratorGetQuotedResponse

get_reposted_by

Reposted by の取得 特定のポストIDを指定して、そのポストをリポストしたユーザーの一覧を取得します。

パラメーター

path.id
Any
1つのポストのID。
path.max_results
int or None
デフォルト:"None"
結果の最大数。
path.pagination_token
Any or None
デフォルト:"None"
次の「ページ」の結果を取得するために使用されるパラメータです。
path.user_fields
List or None
デフォルト:"None"
表示するユーザーフィールドをカンマ区切りで指定するリスト。
path.expansions
List or None
デフォルト:"None"
展開するフィールドをカンマ区切りで指定するリスト。
path.tweet_fields
List or None
デフォルト:"None"
表示するツイートフィールドをカンマ区切りで指定するリスト。

戻り値

IteratorGetRepostedByResponse

get_reposts

リポストを取得 特定のポストをそのIDで指定し、そのポストをリポストしている投稿のリストを取得します。

パラメーター

path.id
Any
1つのポストID。
path.max_results
int or None
デフォルト:"None"
結果の最大数。
path.pagination_token
Any or None
デフォルト:"None"
結果の次の「ページ」を取得するために使用するパラメーター。
path.tweet_fields
List or None
デフォルト:"None"
表示するツイートのフィールドを、カンマ区切りのリストで指定します。
path.expansions
List or None
デフォルト:"None"
展開するフィールドを、カンマ区切りのリストで指定します。
path.media_fields
List or None
デフォルト:"None"
表示するメディアのフィールドを、カンマ区切りのリストで指定します。
path.poll_fields
List or None
デフォルト:"None"
表示する投票のフィールドを、カンマ区切りのリストで指定します。
path.user_fields
List or None
デフォルト:"None"
表示するユーザーのフィールドを、カンマ区切りのリストで指定します。
path.place_fields
List or None
デフォルト:"None"
表示する場所のフィールドを、カンマ区切りのリストで指定します。

戻り値

IteratorGetRepostsResponse

hide_reply

返信を非表示にする 認証済みユーザーが所有する会話内の返信を、非表示または再表示します。

パラメーター

path.tweet_id
Any
非表示または再表示にする返信のID。
body.body
HideReplyRequest
リクエストボディ

search_all

すべての投稿を検索する 検索クエリに一致するフルアーカイブ内の投稿を取得します。

パラメーター

path.query
str
ポストにマッチさせるためのクエリ/ルール/フィルターを 1 つ指定します。最大クエリ長を確認するには https://t.co/rulelength を参照してください。
path.start_time
str or None
デフォルト:"None"
YYYY-MM-DDTHH:mm:ssZ。ポストが返される最も古い UTC タイムスタンプです。タイムスタンプは秒精度で、かつ両端を含みます(例: 12:00:01 はその分の最初の 1 秒を含みます)。
path.end_time
str or None
デフォルト:"None"
YYYY-MM-DDTHH:mm:ssZ。ポストが返される最も新しい UTC タイムスタンプです。タイムスタンプは秒精度で、かつ片側排他的です(例: 12:00:01 はその分の最初の 1 秒を含みません)。
path.since_id
Any or None
デフォルト:"None"
指定した ID より大きい(つまり、より新しい)ポスト ID を持つ結果を返します。
path.until_id
Any or None
デフォルト:"None"
指定した ID より小さい(つまり、より古い)ポスト ID を持つ結果を返します。
path.max_results
int or None
デフォルト:"None"
1 回のリクエストで返される検索結果の最大件数です。
path.next_token
Any or None
デフォルト:"None"
次の「ページ」の結果を取得するために使用されるパラメーターです。このパラメーターで指定する値は、API が返すレスポンスから直接取得されるものであり、変更してはいけません。
path.pagination_token
Any or None
デフォルト:"None"
次の「ページ」の結果を取得するために使用されるパラメーターです。このパラメーターで指定する値は、API が返すレスポンスから直接取得されるものであり、変更してはいけません。
path.sort_order
str or None
デフォルト:"None"
結果を返す際の並び順を指定します。
path.tweet_fields
List or None
デフォルト:"None"
表示するツイートのフィールドをカンマ区切りのリストで指定します。
path.expansions
List or None
デフォルト:"None"
展開するフィールドをカンマ区切りのリストで指定します。
path.media_fields
List or None
デフォルト:"None"
表示する Media のフィールドをカンマ区切りのリストで指定します。
path.poll_fields
List or None
デフォルト:"None"
表示する Poll のフィールドをカンマ区切りのリストで指定します。
path.user_fields
List or None
デフォルト:"None"
表示する User のフィールドをカンマ区切りのリストで指定します。
path.place_fields
List or None
デフォルト:"None"
表示する Place のフィールドをカンマ区切りのリストで指定します。

戻り値

IteratorSearchAllResponse

search_recent

直近7日間の投稿を検索 指定した検索クエリに一致する過去7日間の投稿を取得します。

Parameters

path.query
str
投稿にマッチさせるための 1 つのクエリ/ルール/フィルターです。クエリの最大長を確認するには https://t.co/rulelength を参照してください。
path.start_time
str or None
デフォルト:"None"
YYYY-MM-DDTHH:mm:ssZ。投稿が提供される期間のうち、最も古い UTC タイムスタンプです。タイムスタンプは秒単位で、包含的です(例: 12:00:01 はその分の最初の 1 秒を含みます)。
path.end_time
str or None
デフォルト:"None"
YYYY-MM-DDTHH:mm:ssZ。投稿が提供される期間のうち、最新の UTC タイムスタンプです。タイムスタンプは秒単位で、排他的です(例: 12:00:01 はその分の最初の 1 秒を含みません)。
path.since_id
Any or None
デフォルト:"None"
指定した ID より大きい(つまり、より新しい)ポスト ID を持つ結果を返します。
path.until_id
Any or None
デフォルト:"None"
指定した ID より小さい(つまり、より古い)ポスト ID を持つ結果を返します。
path.max_results
int or None
デフォルト:"None"
1 回のリクエストで返される検索結果の最大数です。
path.next_token
Any or None
デフォルト:"None"
次の「ページ」の結果を取得するために使用されるパラメータです。このパラメータで使用する値は、API が返すレスポンスからそのまま取得する必要があり、変更してはいけません。
path.pagination_token
Any or None
デフォルト:"None"
次の「ページ」の結果を取得するために使用されるパラメータです。このパラメータで使用する値は、API が返すレスポンスからそのまま取得する必要があり、変更してはいけません。
path.sort_order
str or None
デフォルト:"None"
結果を返す順序です。
path.tweet_fields
List or None
デフォルト:"None"
表示するツイートのフィールドをカンマ区切りで指定したリストです。
path.expansions
List or None
デフォルト:"None"
展開するフィールドをカンマ区切りで指定したリストです。
path.media_fields
List or None
デフォルト:"None"
表示するメディアのフィールドをカンマ区切りで指定したリストです。
path.poll_fields
List or None
デフォルト:"None"
表示する投票のフィールドをカンマ区切りで指定したリストです。
path.user_fields
List or None
デフォルト:"None"
表示するユーザーのフィールドをカンマ区切りで指定したリストです。
path.place_fields
List or None
デフォルト:"None"
表示する場所のフィールドをカンマ区切りで指定したリストです。

戻り値

IteratorSearchRecentResponse