NewsClient

​

サブモジュール

• xdk.news.client モジュール
  • NewsClient
    • NewsClient.__init__()
    • NewsClient.get()
    • NewsClient.search()
• xdk.news.models モジュール
  • GetResponse
    • GetResponse.model_config
  • SearchResponse
    • SearchResponse.model_config

​

モジュールの内容

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

​

class xdk.news.NewsClient

ニュース関連操作用の Client

​

パラメータ

path.client · Client

​

__init__

​

パラメータ

path.client · Client

​

get

id でニュースストーリーを取得する 指定した id のニュースストーリーを取得します。

​

パラメーター

path.id · Any

ニュース記事のID。

path.news_fields · List or None · デフォルト: "None"

表示するニュースのフィールドをカンマ区切りのリストで指定します。

​

戻り値

GetResponse - レスポンスデータ

​

search

ニュースを検索 指定した検索クエリに一致するニュース記事のリストを取得します。

​

パラメーター

path.query · str

検索クエリ。

path.max_results · int or None · デフォルト: "None"

取得する結果の数。

path.max_age_hours · int or None · デフォルト: "None"

検索対象とするニュース記事の最大経過時間 (時間単位) 。

path.news_fields · List or None · デフォルト: "None"

表示するニュースのフィールドをカンマ区切りで指定したリスト。

​

戻り値

SearchResponse - レスポンスデータ