Method: customEmojis.list

רשימה של אמוג'י מותאמים אישית שגלויים למשתמש המאומת.

אפשר ליצור אמוג'י בהתאמה אישית ולהשתמש בהם רק בחשבונות Google Workspace, והאדמין צריך להפעיל את האמוג'י בהתאמה אישית בארגון. מידע נוסף זמין במאמרים הסבר על אמוג'י בהתאמה אישית ב-Google Chat וניהול ההרשאות של אמוג'י בהתאמה אישית.

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

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

בקשת HTTP

GET https://chat.googleapis.com/v1/customEmojis

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

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

פרמטרים
pageSize

integer

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

string

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

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

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

string

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

תמיכה בסינון לפי יוצר.

כדי לסנן לפי יוצר, צריך לציין ערך חוקי. בשלב הזה, רק creator("users/me") ו-NOT creator("users/me") יתקבלו כדי לסנן אמוג'י בהתאמה אישית לפי הקריטריון 'נוצר על ידי המשתמש המתקשר'.

לדוגמה, השאילתה הבאה מחזירה אמוג'י בהתאמה אישית שנוצרו על ידי מבצע הקריאה החוזרת:

creator("users/me")

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

גוף הבקשה

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

גוף התשובה

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

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

ייצוג ב-JSON 
{
  "customEmojis": [
    {
      object (CustomEmoji)
    }
  ],
  "nextPageToken": string
}
שדות
customEmojis[]

object (CustomEmoji)

רשימה לא ממוינת. רשימת אמוג'י בהתאמה אישית.
nextPageToken

string

אסימון שאפשר לשלוח כ-pageToken כדי לאחזר את דף התוצאות הבא. אם השדה ריק, אין דפים נוספים.

היקפי הרשאה

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

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

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