Method: users.threads.get

מחזירה את השרשור שצוין.

בקשת HTTP

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

כתובת ה-URL כתובה בתחביר של gRPC Transcoding.

פרמטרים של נתיב

פרמטרים
userId

string

כתובת האימייל של המשתמש. אפשר להשתמש בערך המיוחד me כדי לציין את המשתמש המאומת.
id

string

המזהה של השרשור שרוצים לאחזר.

פרמטרים של שאילתה

פרמטרים
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.

פורמט

טיפוסים בני מנייה (enum)
full הפונקציה מחזירה את הנתונים המלאים של הודעת האימייל עם תוכן הגוף שנותח בשדה payload. השדה raw לא נמצא בשימוש. אי אפשר להשתמש בפורמט כשניגשים ל-API באמצעות ההיקף gmail.metadata.
metadata הפונקציה מחזירה רק מזהי הודעות אימייל, תוויות וכותרות אימייל.
minimal הפונקציה מחזירה רק מזהים ותוויות של הודעות אימייל, ולא מחזירה את הכותרות, הגוף או המטען הייעודי (payload) של האימייל.