Method: spaces.findDirectMessage

הפונקציה מחזירה את הצ'אט האישי הקיים עם המשתמש שצוין. אם לא נמצא מקום בצ'אט האישי, הפונקציה מחזירה את השגיאה 404 NOT_FOUND. דוגמה לכך מופיעה בקטע חיפוש צ'אט אישי.

עם אימות אפליקציה, הפונקציה מחזירה את המרחב של הצ'אט האישי בין המשתמש שצוין לבין אפליקציית Chat שביצעה את הקריאה.

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

יש תמיכה בסוגי אימות הבאים:

  • אימות אפליקציה עם היקף ההרשאה:

    • https://www.googleapis.com/auth/chat.bot
  • אימות משתמשים עם אחד מההיקפים הבאים של הרשאות:

    • https://www.googleapis.com/auth/chat.spaces.readonly
    • https://www.googleapis.com/auth/chat.spaces

בקשת HTTP

GET https://chat.googleapis.com/v1/spaces:findDirectMessage

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

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

פרמטרים
name

string

חובה. שם המשאב של המשתמש שרוצים למצוא את הצ'אט האישי איתו.

הפורמט: users/{user}, כאשר {user} הוא id של האדם מ-People API, או id של המשתמש ב-Directory API. לדוגמה, אם מזהה הפרופיל ב-People API הוא 123456789, אפשר למצוא הודעה ישירה עם אותו אדם באמצעות users/123456789 כ-name. כשמתבצעת אימות כמשתמש, אפשר להשתמש בכתובת האימייל ככתובת חלופית ל-{user}. לדוגמה, users/[email protected], כאשר [email protected] היא כתובת האימייל של המשתמש ב-Google Chat.

גוף הבקשה

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

גוף התשובה

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

היקפי הרשאה

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.bot

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