Method: users.threads.get

指定されたスレッドを取得します。

HTTP リクエスト

GET https://gmail.googleapis.com/gmail/v1/users/{userId}/threads/{id}

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
userId

string

ユーザーのメールアドレス。特別な値 me を使用すると、認証済みユーザーを示すことができます。
id

string

取得するスレッドの ID。

クエリ パラメータ

パラメータ
format

enum (Format)

メッセージを返す形式。
metadataHeaders[]

string

指定され、形式が METADATA の場合、指定されたヘッダーのみを含めます。

リクエスト本文

リクエストの本文は空にする必要があります。

レスポンスの本文

成功した場合、レスポンスの本文には Thread のインスタンスが含まれます。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://mail.google.com/
  • https://www.googleapis.com/auth/gmail.modify
  • https://www.googleapis.com/auth/gmail.readonly
  • https://www.googleapis.com/auth/gmail.metadata

詳細については、承認ガイドをご覧ください。

形式

列挙型
full payload フィールドで解析された本文を含むメール メッセージ全体を返します。raw フィールドは使用しません。gmail.metadata スコープを使用して API にアクセスする場合、この形式は使用できません。
metadata メールのメッセージ ID、ラベル、メールヘッダーのみを返します。
minimal メールのメッセージ ID とラベルのみを返し、メールのヘッダー、本文、ペイロードは返しません。