REST Resource: accounts.icons

משאב: סמל

מידע על הסמל של שותף.

ייצוג ב-JSON
{
  "name": string,
  "imageData": string,
  "state": enum (State),
  "iconUri": string,
  "reference": string,
  "disapprovalReasons": [
    enum (ImageDisapprovalReason)
  ]
}
שדות
name

string

חובה. פלט בלבד. שם המשאב של הסמל בפורמט accounts/{account_id}/icons/{icon_id}. ‫Google יוצרת את icon_id במהלך הפעולה create. משתמשים ב-icon_id כדי לשייך את הסמל למותג באמצעות accounts.brands API.

imageData

string (bytes format)

חובה. קלט בלבד. תוכן הסמל, שחייב להיות בפורמט PNG או ניתן להמרה ל-PNG.

מחרוזת בקידוד Base64.

state

enum (State)

פלט בלבד. המצב הנוכחי של הסמל.

iconUri

string

פלט בלבד. ה-URI של הסמל שאושר, שמתארח ב-Google. ההגדרה חלה רק על סמלים במצב APPROVED.

reference

string

אופציונלי. ערך למעקב אחר הסמל. יכול להיות שזה המפתח הראשי של הסמל במערכת, או שם הקובץ של הסמל. ‫Google לא משתמשת בערך הזה.

disapprovalReasons[]

enum (ImageDisapprovalReason)

פלט בלבד. הסיבות לפסילה של הסמל. ההגדרה חלה רק על סמלים במצב REJECTED.

מדינה (State)

מצבי הסמל האפשריים.

טיפוסים בני מנייה (enum)
STATE_UNSPECIFIED ערך ברירת המחדל.
NEW ‫Google קיבלה את הסמל ובודקת את התוכן שלו.
APPROVED הסמל אושר והוא מוכן להצגה לציבור. אפשר לקשר סמלים שאושרו למותגים.
REJECTED הסמל נדחה. הסמל הזה לא יוצג ב-Google.

Methods

create

העלאת סמל חדש והתחלת תהליך הבדיקה שלו.

get

הפונקציה מחזירה את מופע Icon שמשויך לשם משאב של סמל שצוין ב-URI של הבקשה.

list

הפונקציה מחזירה את Icons של חשבון שותף.