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

כשהערך של given והפורמט הוא 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

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

פורמט

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