Method: users.threads.get

הפונקציה מקבלת את ה-thread שצוין.

בקשת HTTP

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

בכתובת ה-URL נעשה שימוש בתחביר המרת gRPC.

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

פרמטרים
userId

string

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

string

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

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

פרמטרים
format

enum (Format)

הפורמט שבו יש להחזיר את ההודעות.
metadataHeaders[]

string

אם נתון זה והפורמט הוא 'מטא-נתונים', כלול רק את הכותרות שצוינו.

גוף הבקשה

גוף הבקשה חייב להיות ריק.

גוף התגובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכלול מופע של 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

למידע נוסף, ניתן לעיין במדריך ההרשאות.

פורמט

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