Method: spaces.messages.reactions.list

כאן אפשר לראות את רשימת התגובות להודעות. ראו דוגמה במאמר רשימת התגובות להודעות. נדרש אימות משתמש.

בקשת HTTP

GET https://chat.googleapis.com/v1/{parent=spaces/*/messages/*}/reactions

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

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

פרמטרים
parent

string

חובה. ההודעה שהמשתמשים הגיבו אליה.

פורמט: spaces/{space}/messages/{message}

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

פרמטרים
pageSize

integer

זה שינוי אופציונלי. המספר המקסימלי של תגובות שהוחזרו. השירות יכול להחזיר פחות תגובות מהערך הזה. אם לא צוין, ערך ברירת המחדל הוא 25. הערך המקסימלי הוא 200; ערכים מעל 200 משתנים ל-200.
pageToken

string

זה שינוי אופציונלי. (אם ממשיכים משאילתה קודמת).

אסימון דף שהתקבל מקריאה קודמת לתגובות ברשימה. צריך לספק את הכתובת הזו כדי לאחזר את הדף הבא.

במהלך החלוקה לדפים, ערך המסנן צריך להתאים לקריאה שסיפקה את אסימון הדף. העברת ערך אחר עלולה להוביל לתוצאות בלתי צפויות.
filter

string

זה שינוי אופציונלי. מסנן שאילתות.

אתם יכולים לסנן תגובות לפי אמוג'י (emoji.unicode או emoji.custom_emoji.uid) ולפי משתמש (user.name).

כדי לסנן תגובות מכמה אמוג'י או משתמשים, אפשר לאחד שדות דומים באמצעות האופרטור OR, כמו emoji.unicode = "🙂" OR emoji.unicode = "👍" ו-user.name = "users/AAAAAA" OR user.name = "users/BBBBBB".

כדי לסנן תגובות לפי אמוג'י ולפי משתמש, אפשר להשתמש באופרטור AND, למשל emoji.unicode = "🙂" AND user.name = "users/AAAAAA".

אם בשאילתה נעשה שימוש גם ב-AND וגם בשאילתה 'OR', צריך לקבץ אותם בסוגריים.

לדוגמה, השאילתות הבאות תקינות:

user.name = "users/{user}"
emoji.unicode = "🙂"
emoji.custom_emoji.uid = "{uid}"
emoji.unicode = "🙂" OR emoji.unicode = "👍"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}"
emoji.unicode = "🙂" AND user.name = "users/{user}"
(emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}")
AND user.name = "users/{user}"

השאילתות הבאות לא חוקיות:

emoji.unicode = "🙂" AND emoji.unicode = "👍"
emoji.unicode = "🙂" AND emoji.custom_emoji.uid = "{uid}"
emoji.unicode = "🙂" OR user.name = "users/{user}"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}" OR
user.name = "users/{user}"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}"
AND user.name = "users/{user}"

שאילתות לא חוקיות נדחות על ידי השרת עם השגיאה INVALID_ARGUMENT.

גוף הבקשה

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

גוף התשובה

תשובה לבקשת רשימה עם תגובות.

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

ייצוג JSON 
{
  "reactions": [
    {
      object (Reaction)
    }
  ],
  "nextPageToken": string
}
שדות
reactions[]

object (Reaction)

רשימת התגובות בדף המבוקש (או הראשון).
nextPageToken

string

אסימון המשך לאחזור דף התוצאות הבא. היא ריקה עבור הדף האחרון של התוצאות.

היקפי ההרשאות

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

  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly

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