Method: users.messages.get

指定したメッセージを取得します。

HTTP リクエスト

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

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

パスパラメータ

パラメータ
userId

string

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

id

string

取得するメッセージの ID。通常、この ID は messages.list を使用して取得されます。メッセージが挿入(messages.insert)またはインポート(messages.import)された場合、ID は結果にも含まれます。

クエリ パラメータ

パラメータ
format

enum (Format)

メッセージを返す形式。

metadataHeaders[]

string

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

リクエストの本文

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

レスポンスの本文

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

認可スコープ

次の 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
  • https://www.googleapis.com/auth/gmail.addons.current.message.metadata
  • https://www.googleapis.com/auth/gmail.addons.current.message.readonly
  • https://www.googleapis.com/auth/gmail.addons.current.message.action

詳細については、OAuth 2.0 Overview をご覧ください。