Method: users.threads.get

رشته‌ی مشخص‌شده را دریافت می‌کند.

درخواست HTTP

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

این URL از سینتکس Transcoding در gRPC استفاده می‌کند.

پارامترهای مسیر

پارامترها
userId

string

آدرس ایمیل کاربر. مقدار ویژه me می‌تواند برای نشان دادن کاربر احراز هویت شده استفاده شود.

id

string

شناسه‌ی رشته‌ای که قرار است بازیابی شود.

پارامترهای پرس و جو

پارامترها
format

enum ( Format )

قالبی که پیام‌ها باید با آن برگردانده شوند.

metadataHeaders[]

string

وقتی داده شده و فرمت آن MADATA است، فقط هدرهای مشخص شده را لحاظ کنید.

درخواست بدنه

بدنه درخواست باید خالی باشد.

بدنه پاسخ

در صورت موفقیت، بدنه پاسخ شامل نمونه‌ای از 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 استفاده نمی‌شود. هنگام دسترسی به API با استفاده از دامنه gmail.metadata نمی‌توان از format استفاده کرد.
metadata فقط شناسه‌های پیام ایمیل، برچسب‌ها و سرصفحه‌های ایمیل را برمی‌گرداند.
minimal فقط شناسه‌ها و برچسب‌های پیام ایمیل را برمی‌گرداند؛ هدرها، بدنه یا محتوای ایمیل را برنمی‌گرداند.