Method: customEmojis.list

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

נדרש אימות משתמש.

בקשת 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

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