REST Resource: customEmojis

משאב: CustomEmoji

מייצג אמוג'י בהתאמה אישית.

ייצוג ב-JSON 
{
  "name": string,
  "uid": string,
  "emojiName": string,
  "temporaryImageUri": string,
  "payload": {
    object (CustomEmojiPayload)
  }
}
שדות
name

string

מזהה. שם המשאב של האמוג'י בהתאמה אישית, שהוקצה על ידי השרת.

פורמט: customEmojis/{customEmoji}

uid

string

פלט בלבד. מפתח ייחודי למשאב האמוג'י בהתאמה אישית.
emojiName

string

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

חובה כשיוצרים את האמוג'י בהתאמה אישית, פלט בלבד במקרים אחרים.

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

לדוגמה: :valid-emoji-name:

temporaryImageUri

string

פלט בלבד. כתובת ה-URL של התמונה של האמוג'י המותאם אישית, שתהיה תקפה למשך 10 דקות לפחות. לתשומת ליבכם: השדה הזה לא מאוכלס בתשובה כשהאמוג'י בהתאמה אישית נוצר.

payload

object (CustomEmojiPayload)

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

CustomEmojiPayload

נתוני עומס העבודה של האמוג'י בהתאמה אישית.

ייצוג ב-JSON 
{
  "fileContent": string,
  "filename": string
}
שדות
fileContent

string (bytes format)

חובה. קלט בלבד. התמונה שבה נעשה שימוש באמוג'י המותאם אישית.

עומס העבודה צריך להיות קטן מ-256KB והמידות של התמונה צריכות להיות בין 64 ל-500 פיקסלים. המגבלות עשויות להשתנות.
filename

string

חובה. קלט בלבד. שם קובץ התמונה.

סיומות הקובץ הנתמכות: .png, ‏ .jpg, ‏ .gif.

Methods

create

 יצירת אמוג'י בהתאמה אישית.

delete

 מחיקה של אמוג'י בהתאמה אישית.

get

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

list

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