Method: users.messages.get

הפונקציה מקבלת את ההודעה שצוינה.

בקשת HTTP

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

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

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

פרמטרים
userId

string

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

string

המזהה של ההודעה שיש לאחזר. המזהה הזה מאוחזר בדרך כלל באמצעות messages.list. המזהה נכלל בתוצאה גם כשהודעה נוספת (messages.insert) או מיובאת (messages.import).

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

פרמטרים
format

enum (Format)

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

string

אם השדה צוין והפורמט הוא METADATA, יש לכלול רק את הכותרות שצוינו.

גוף הבקשה

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

גוף התגובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכלול מופע של Message.

היקפי הרשאות

כדי להשתמש בתכונה הזו יש צורך באחד מההיקפים הבאים של 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

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