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 にアクセスする場合、format は使用できません。
metadata メール メッセージ ID、ラベル、メール ヘッダーのみを返します。
minimal メール メッセージ ID とラベルのみを返します。メールのヘッダー、本文、ペイロードは返されません。