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

​
サブモジュール

​
モジュール内容

このモジュールは X API の投稿エンドポイントへのアクセス機能を提供し、 投稿関連のすべての機能に対するメインエントリーポイントとして機能します。

​
class xdk.posts.PostsClient

投稿に関する操作を行う Client

​
パラメータ

​
path.client
Client

​
__init__

​
パラメーター

​
path.client
Client

​
create

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

​
パラメータ

​
body.body
CreateRequest

​
delete

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

​
パラメーター

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

​
戻り値

DeleteResponse - レスポンスデータ

​
get_analytics

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

​
Parameters

​
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"
表示するアナリティクスフィールドをカンマ区切りで指定します。

​
戻り値

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"
表示する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のフィールドをカンマ区切りで指定したリスト。

​
戻り値

GetByIdResponse - レスポンスデータ

​
get_by_ids

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

​
Parameters

​
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"
表示するメディアフィールドのカンマ区切りのリスト。
​
path.poll_fields
List or None
デフォルト:"None"
表示する投票フィールドのカンマ区切りのリスト。
​
path.user_fields
List or None
デフォルト:"None"
表示するユーザーフィールドのカンマ区切りのリスト。
​
path.place_fields
List or None
デフォルト:"None"
表示する場所フィールドのカンマ区切りのリスト。

​
戻り値

GetByIdsResponse - レスポンスデータ

​
get_counts_all

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

​
パラメーター

​
path.query
str
投稿にマッチさせるための単一のクエリ、ルール、またはフィルターです。最大クエリ長については https://t.co/rulelength を参照してください。
​
path.start_time
str or None
デフォルト:"None"
YYYY-MM-DDTHH:mm:ssZ。投稿が取得される最も古い UTC タイムスタンプ (直近 7 日間の範囲内) です。タイムスタンプは秒単位の粒度で、この時刻を含みます (例: 12:00:01 の場合、その 1 分間の最初の 1 秒を含みます) 。
​
path.end_time
str or None
デフォルト:"None"
YYYY-MM-DDTHH:mm:ssZ。投稿が取得される最も新しい UTC タイムスタンプです。タイムスタンプは秒単位の粒度で、この時刻を含みません (例: 12:00:01 の場合、その 1 分間の最初の 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日間の投稿数を取得する 検索クエリに一致する直近7日間の投稿数を取得します。

​
パラメーター

​
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時間メトリクスを取得する対象の PostIds のリスト。
​
path.granularity
str
メトリクスレスポンスの粒度。
​
path.requested_metrics
List
履歴データの取得でリクエストするメトリクス。
​
path.engagement_fields
List or None
デフォルト:"None"
表示する Engagement フィールドをカンマ区切りで指定したリスト。

​
戻り値

GetInsights28hrResponse - レスポンスデータ

​
get_insights_historical

履歴の投稿インサイトを取得する 指定した投稿について、指定した期間内の履歴エンゲージメント指標を取得します。

​
パラメーター

​
path.tweet_ids
List
履歴メトリクスを取得するための Post 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"
表示するUserフィールドをカンマ区切りのリストで指定します。
​
path.expansions
List or None
デフォルト:"None"
展開するフィールドをカンマ区切りのリストで指定します。
​
path.tweet_fields
List or None
デフォルト:"None"
表示するツイートフィールドをカンマ区切りのリストで指定します。

​
戻り値

IteratorGetLikingUsersResponse

​
get_quoted

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

​
パラメーター

​
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"
表示するメディアフィールドをカンマ区切りのリストで指定します。
​
path.poll_fields
List or None
デフォルト:"None"
表示する投票フィールドをカンマ区切りのリストで指定します。
​
path.user_fields
List or None
デフォルト:"None"
表示するユーザーフィールドをカンマ区切りのリストで指定します。
​
path.place_fields
List or None
デフォルト:"None"
表示する場所フィールドをカンマ区切りのリストで指定します。

​
戻り値

IteratorGetQuotedResponse

​
get_reposted_by

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

​
パラメータ

​
path.id
Any
単一のポストの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で指定し、そのポストをリポストしている投稿の一覧を取得します。

​
Parameters

​
path.id
Any
単一のポスト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

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

​
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"
表示する場所フィールドをカンマ区切りのリストで指定します。

​
戻り値

IteratorSearchAllResponse

​
search_recent

最近の投稿を検索 検索クエリに一致する、過去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"
表示する Tweet のフィールドを指定するカンマ区切りリストです。
​
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 のフィールドを指定するカンマ区切りリストです。

​
戻り値

IteratorSearchRecentResponse