PostsClient
コンストラクタ
__init__
パラメーター
create
edit_options が指定されている場合は既存のポストを編集します。
body: リクエストボディ
:returns: レスポンスデータ
:rtype: CreateResponse
パラメータ
delete
パラメータ
削除対象のポストのID。
戻り値
DeleteResponse - レスポンスデータ
get_analytics
パラメーター
カンマ区切りのポストIDのリストです。1回のリクエストで最大100個まで指定できます。
YYYY-MM-DDTHH:mm:ssZ。時間範囲の終了を表す UTC タイムスタンプです。
YYYY-MM-DDTHH:mm:ssZ。時間範囲の開始を表す UTC タイムスタンプです。
検索カウント結果の粒度を指定します。
表示する Analytics フィールドのカンマ区切りリストです。
戻り値
GetAnalyticsResponse - レスポンスデータ
get_by_id
パラメーター
1つのポストのID。
表示するツイートのフィールドをカンマ区切りリストで指定します。
展開するフィールドをカンマ区切りリストで指定します。
表示するメディアのフィールドをカンマ区切りリストで指定します。
表示する投票のフィールドをカンマ区切りリストで指定します。
表示するユーザーのフィールドをカンマ区切りリストで指定します。
表示する場所のフィールドをカンマ区切りリストで指定します。
戻り値
GetByIdResponse - レスポンスデータ
get_by_ids
パラメーター
カンマ区切りのポストIDのリストです。1回のリクエストで最大100件まで指定できます。
表示するツイートのフィールドをカンマ区切りのリストで指定します。
展開するフィールドをカンマ区切りのリストで指定します。
表示するMediaオブジェクトのフィールドをカンマ区切りのリストで指定します。
表示するPollオブジェクトのフィールドをカンマ区切りのリストで指定します。
表示するUserオブジェクトのフィールドをカンマ区切りのリストで指定します。
表示するPlaceオブジェクトのフィールドをカンマ区切りのリストで指定します。
戻り値
GetByIdsResponse - レスポンスデータ
get_counts_all
Parameters
投稿にマッチするクエリ/ルール/フィルターを 1 つ指定します。最大クエリ長を確認するには https://t.co/rulelength を参照してください。
YYYY-MM-DDTHH:mm:ssZ。直近 7 日間の範囲で、投稿が取得される最も古い UTC タイムスタンプです。タイムスタンプは秒単位で、下限は含まれます(例: 12:00:01 はその分の最初の 1 秒を含みます)。
YYYY-MM-DDTHH:mm:ssZ。投稿が取得される最新の UTC タイムスタンプです。タイムスタンプは秒単位で、上限は含まれません(例: 12:00:01 はその分の最初の 1 秒を含みません)。
指定した ID より大きい(つまり、より新しい)ポスト ID を持つ結果を返します。
指定した ID より小さい(つまり、より古い)ポスト ID を持つ結果を返します。
次の「ページ」の結果を取得するために使用されるパラメータです。このパラメータで使用する値は、API が返すレスポンスから直接取得されるものであり、変更してはいけません。
次の「ページ」の結果を取得するために使用されるパラメータです。このパラメータで使用する値は、API が返すレスポンスから直接取得されるものであり、変更してはいけません。
検索カウント結果の集計粒度を指定します。
表示する SearchCount フィールドをカンマ区切りで指定するリストです。
戻り値
IteratorGetCountsAllResponse
get_counts_recent
Parameters
投稿にマッチさせるための 1 つのクエリ/ルール/フィルターです。クエリの最大長を確認するには https://t.co/rulelength を参照してください。
YYYY-MM-DDTHH:mm:ssZ。投稿が返されるうち、最も古い UTC タイムスタンプ(直近 7 日以内)です。タイムスタンプは秒単位の粒度で、包含的です(例: 12:00:01 はその分の最初の 1 秒を含みます)。
YYYY-MM-DDTHH:mm:ssZ。投稿が返されるうち、最新の UTC タイムスタンプです。タイムスタンプは秒単位の粒度で、排他的です(例: 12:00:01 はその分の最初の 1 秒を含みません)。
指定した ID より大きい(つまり、より新しい)ポスト ID を持つ結果を返します。
指定した ID より小さい(つまり、より古い)ポスト ID を持つ結果を返します。
このパラメータは、次の「ページ」の結果を取得するために使用します。パラメータに指定する値は、API が返すレスポンスから直接取得されるものであり、変更してはいけません。
このパラメータは、次の「ページ」の結果を取得するために使用します。パラメータに指定する値は、API が返すレスポンスから直接取得されるものであり、変更してはいけません。
検索結果数の集計粒度を指定します。
表示する SearchCount フィールドのカンマ区切りのリストです。
戻り値
IteratorGetCountsRecentResponse
get_insights28hr
パラメーター
28時間分のメトリクスを取得する対象PostIdのリスト。
メトリクスレスポンスの粒度。
履歴リクエストで取得を要求するメトリクス。
表示するエンゲージメントフィールドをカンマ区切りで指定するリスト。
戻り値
GetInsights28hrResponse - レスポンスデータ
get_insights_historical
Parameters
過去のメトリクスを取得するためのポストの id のリスト。
YYYY-MM-DDTHH:mm:ssZ。時間範囲の終了時刻を表す UTC タイムスタンプ。
YYYY-MM-DDTHH:mm:ssZ。時間範囲の開始時刻を表す UTC タイムスタンプ。
メトリクスレスポンスの粒度。
過去のメトリクス取得でリクエストするメトリクス。
表示するエンゲージメントのフィールドをカンマ区切りで指定したリスト。
戻り値
GetInsightsHistoricalResponse - レスポンスデータ
get_liking_users
パラメータ
1 つのポスト ID。
結果の最大数。
次の「ページ」の結果を取得するために使用されるパラメータです。
表示するユーザーのフィールドをカンマ区切りのリストで指定します。
展開するフィールドをカンマ区切りのリストで指定します。
表示するツイートのフィールドをカンマ区切りのリストで指定します。
戻り値
IteratorGetLikingUsersResponse
get_quoted
Parameters
1件のポストのID。
返される結果の最大数。
特定の「ページ」の結果を取得するために使用されるパラメータ。
除外するエンティティの集合(例:「replies」や「retweets」など)。
表示するツイートのフィールドをカンマ区切りのリストで指定します。
展開するフィールドをカンマ区切りのリストで指定します。
表示するMediaのフィールドをカンマ区切りのリストで指定します。
表示するPollのフィールドをカンマ区切りのリストで指定します。
表示するUserのフィールドをカンマ区切りのリストで指定します。
表示するPlaceのフィールドをカンマ区切りのリストで指定します。
戻り値
IteratorGetQuotedResponse
get_reposted_by
パラメーター
1つのポストのID。
結果の最大数。
次の「ページ」の結果を取得するために使用されるパラメータです。
表示するユーザーフィールドをカンマ区切りで指定するリスト。
展開するフィールドをカンマ区切りで指定するリスト。
表示するツイートフィールドをカンマ区切りで指定するリスト。
戻り値
IteratorGetRepostedByResponse
get_reposts
パラメーター
1つのポストID。
結果の最大数。
結果の次の「ページ」を取得するために使用するパラメーター。
表示するツイートのフィールドを、カンマ区切りのリストで指定します。
展開するフィールドを、カンマ区切りのリストで指定します。
表示するメディアのフィールドを、カンマ区切りのリストで指定します。
表示する投票のフィールドを、カンマ区切りのリストで指定します。
表示するユーザーのフィールドを、カンマ区切りのリストで指定します。
表示する場所のフィールドを、カンマ区切りのリストで指定します。
戻り値
IteratorGetRepostsResponse
hide_reply
パラメーター
非表示または再表示にする返信のID。
リクエストボディ
search_all
パラメーター
ポストにマッチさせるためのクエリ/ルール/フィルターを 1 つ指定します。最大クエリ長を確認するには https://t.co/rulelength を参照してください。
YYYY-MM-DDTHH:mm:ssZ。ポストが返される最も古い UTC タイムスタンプです。タイムスタンプは秒精度で、かつ両端を含みます(例: 12:00:01 はその分の最初の 1 秒を含みます)。
YYYY-MM-DDTHH:mm:ssZ。ポストが返される最も新しい UTC タイムスタンプです。タイムスタンプは秒精度で、かつ片側排他的です(例: 12:00:01 はその分の最初の 1 秒を含みません)。
指定した ID より大きい(つまり、より新しい)ポスト ID を持つ結果を返します。
指定した ID より小さい(つまり、より古い)ポスト ID を持つ結果を返します。
1 回のリクエストで返される検索結果の最大件数です。
次の「ページ」の結果を取得するために使用されるパラメーターです。このパラメーターで指定する値は、API が返すレスポンスから直接取得されるものであり、変更してはいけません。
次の「ページ」の結果を取得するために使用されるパラメーターです。このパラメーターで指定する値は、API が返すレスポンスから直接取得されるものであり、変更してはいけません。
結果を返す際の並び順を指定します。
表示するツイートのフィールドをカンマ区切りのリストで指定します。
展開するフィールドをカンマ区切りのリストで指定します。
表示する Media のフィールドをカンマ区切りのリストで指定します。
表示する Poll のフィールドをカンマ区切りのリストで指定します。
表示する User のフィールドをカンマ区切りのリストで指定します。
表示する Place のフィールドをカンマ区切りのリストで指定します。
戻り値
IteratorSearchAllResponse
search_recent
Parameters
投稿にマッチさせるための 1 つのクエリ/ルール/フィルターです。クエリの最大長を確認するには https://t.co/rulelength を参照してください。
YYYY-MM-DDTHH:mm:ssZ。投稿が提供される期間のうち、最も古い UTC タイムスタンプです。タイムスタンプは秒単位で、包含的です(例: 12:00:01 はその分の最初の 1 秒を含みます)。
YYYY-MM-DDTHH:mm:ssZ。投稿が提供される期間のうち、最新の UTC タイムスタンプです。タイムスタンプは秒単位で、排他的です(例: 12:00:01 はその分の最初の 1 秒を含みません)。
指定した ID より大きい(つまり、より新しい)ポスト ID を持つ結果を返します。
指定した ID より小さい(つまり、より古い)ポスト ID を持つ結果を返します。
1 回のリクエストで返される検索結果の最大数です。
次の「ページ」の結果を取得するために使用されるパラメータです。このパラメータで使用する値は、API が返すレスポンスからそのまま取得する必要があり、変更してはいけません。
次の「ページ」の結果を取得するために使用されるパラメータです。このパラメータで使用する値は、API が返すレスポンスからそのまま取得する必要があり、変更してはいけません。
結果を返す順序です。
表示するツイートのフィールドをカンマ区切りで指定したリストです。
展開するフィールドをカンマ区切りで指定したリストです。
表示するメディアのフィールドをカンマ区切りで指定したリストです。
表示する投票のフィールドをカンマ区切りで指定したリストです。
表示するユーザーのフィールドをカンマ区切りで指定したリストです。
表示する場所のフィールドをカンマ区切りで指定したリストです。
戻り値
IteratorSearchRecentResponse