DirectMessagesClient

​

DirectMessagesClient

クラス 基底クラス: object

ダイレクトメッセージの操作を行う Client

​

コンストラクタ

​

__init__

​

パラメーター

path.client · Client

​

create_by_conversation_id

会話IDでDMメッセージを作成 会話のidを指定して、その会話に新しいダイレクトメッセージを送信します。

​

パラメーター

path.dm_conversation_id · str

DM会話ID。

body.body · CreateByConversationIdRequest

リクエストボディ

​

create_by_participant_id

参加者IDを指定してDMメッセージを作成します
指定した参加者のid宛てに、新しいダイレクトメッセージを送信します。

​

パラメーター

path.participant_id · Any

DMを受信するユーザーのID。

body.body · CreateByParticipantIdRequest

リクエストボディ

​

create_conversation

DM会話を作成します 指定した参加者との新しいダイレクトメッセージの会話を開始します。 body: リクエストボディ :returns: レスポンスデータ :rtype: CreateConversationResponse

​

パラメータ

body.body · CreateConversationRequest

​

delete_events

DMイベントを削除 認証済みユーザーが所有している場合に、id を指定して特定のダイレクトメッセージイベントを削除します。

​

パラメーター

path.event_id · Any

削除対象のダイレクトメッセージイベントのID。

​

戻り値

DeleteEventsResponse - レスポンスデータ

​

get_events

DMイベントを取得します すべての会話の最近のダイレクトメッセージイベントの一覧を取得します。

​

パラメーター

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

返される結果の最大数。

path.pagination_token · Any or None · デフォルト: "None"

結果の特定の「ページ」を取得するために使用されるパラメーター。

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

結果に含める event_types のセット。

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

表示する DmEvent フィールドのカンマ区切りのリスト。

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

展開するフィールドのカンマ区切りのリスト。

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

表示する Media フィールドのカンマ区切りのリスト。

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

表示する User フィールドのカンマ区切りのリスト。

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

表示する Tweet フィールドのカンマ区切りのリスト。

​

戻り値

IteratorGetEventsResponse

​

get_events_by_conversation_id

DM 会話内の DM イベントを取得します 特定の会話に紐づくダイレクトメッセージイベントを取得します。

​

パラメーター

path.id · Any

DM会話のID。

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

結果の最大件数。

path.pagination_token · Any or None · デフォルト: "None"

結果の特定の「ページ」を取得するために使用するパラメーターです。

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

結果に含める event_types の集合。

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

表示する DmEvent フィールドのカンマ区切りリスト。

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

展開するフィールドのカンマ区切りリスト。

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

表示する Media フィールドのカンマ区切りリスト。

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

表示する User フィールドのカンマ区切りリスト。

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

表示する Tweet フィールドのカンマ区切りリスト。

​

戻り値

IteratorGetEventsByConversationIdResponse

​

get_events_by_id

ID で DM イベントを取得 指定した id に対応するダイレクトメッセージイベントの詳細を取得します。

​

パラメータ

path.event_id · Any

DM イベントの id。

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

表示する DmEvent フィールドのカンマ区切りリスト。

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

展開するフィールドのカンマ区切りリスト。

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

表示する Media フィールドのカンマ区切りリスト。

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

表示する User フィールドのカンマ区切りリスト。

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

表示する Tweet フィールドのカンマ区切りリスト。

​

戻り値

GetEventsByIdResponse - レスポンスデータ

​

get_events_by_participant_id

DM会話のDMイベントを取得します 特定のDM会話に対するダイレクトメッセージイベントを取得します。

​

パラメーター

path.participant_id · Any

1対1のDM会話の参加ユーザーのID。

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

結果の最大数。

path.pagination_token · Any or None · デフォルト: "None"

指定した「ページ」の結果を取得するために使用するパラメーター。

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

結果に含める event_types の集合。

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

表示する DmEvent フィールドのカンマ区切りリスト。

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

展開するフィールドのカンマ区切りリスト。

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

表示する Media フィールドのカンマ区切りリスト。

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

表示する User フィールドのカンマ区切りリスト。

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

表示する Tweet フィールドのカンマ区切りリスト。

​

戻り値

IteratorGetEventsByParticipantIdResponse