Method: users.threads.get

取得指定討論串。

HTTP 要求

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

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
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
  • 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。

格式

列舉
full 傳回完整電子郵件訊息資料，並在 payload 欄位中剖析內文內容；系統不會使用 raw 欄位。使用 gmail.metadata 範圍存取 API 時，無法使用格式。
metadata 只會傳回電子郵件 ID、標籤和電子郵件標頭。
minimal 只會傳回電子郵件 ID 和標籤，不會傳回電子郵件標頭、內文或酬載。