Method: attributes.list

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

בקשת HTTP

GET https://mybusinessbusinessinformation.googleapis.com/v1/attributes

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

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

פרמטרים
parent

string

אופציונלי. שם המשאב של המיקום שבו רוצים לחפש מאפיינים זמינים. אם השדה הזה מוגדר, השדות categoryName,‏ regionCode,‏ languageCode ו-showAll לא נדרשים ואסור להגדיר אותם.

פורמט: locations/{locationId} (למשל, locations/1234567890).
categoryName

string

אופציונלי. המזהה היציב של הקטגוריה הראשית שבו משתמשים כדי למצוא מאפיינים זמינים. הפורמט חייב להיות categories/{category_id} (למשל, categories/gcid:restaurant). חובה אם לא הוגדר parent והערך של showAll הוא false.
regionCode

string

אופציונלי. קוד המדינה בפורמט ISO 3166-1 alpha-2 כדי למצוא מאפיינים זמינים. חובה אם לא הוגדר parent.
languageCode

string

אופציונלי. קוד BCP 47 של השפה שבה רוצים לקבל את השמות המוצגים של המאפיינים. אם השפה הזו לא זמינה, הם יסופקו באנגלית.
showAll

boolean

אופציונלי. אם הערך הוא True, מוחזרים מטא-נתונים של כל המאפיינים הזמינים, בלי להתייחס לשדות parent ו-categoryName. צריך לציין ערכים בשדות languageCode ו-regionCode כשהשדה showAll מוגדר ל-true.
pageSize

integer

כמה מאפיינים לכלול בכל דף. ברירת המחדל היא 200, והערך המינימלי הוא 1.
pageToken

string

אם מציינים את הפרמטר הזה, המערכת מאחזרת את הדף הבא של המטא-נתונים של המאפיינים.

גוף הבקשה

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

גוף התשובה

תגובה ל-AttributesService.ListAttributeMetadata.

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

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

object (AttributeMetadata)

אוסף של מטא-נתונים של המאפיינים הזמינים.
nextPageToken

string

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

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/business.manage

ניתן למצוא מידע נוסף כאן: OAuth 2.0 Overview.

AttributeMetadata

מטא-נתונים של מאפיין. מכיל מידע על הצגת המאפיין, כולל שם מקומי וכותרת לקיבוץ מאפיינים קשורים יחד.

ייצוג ב-JSON 
{
  "parent": string,
  "valueType": enum (AttributeValueType),
  "displayName": string,
  "groupDisplayName": string,
  "repeatable": boolean,
  "valueMetadata": [
    {
      object (AttributeValueMetadata)
    }
  ],
  "deprecated": boolean
}
שדות
parent

string

המזהה הייחודי של המאפיין.
valueType

enum (AttributeValueType)

סוג הערך של המאפיין. הערכים שמוגדרים ונשלפים צריכים להיות מהסוג הזה.
displayName

string

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

string

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

boolean

אם הערך הוא true, המאפיין תומך בכמה ערכים. אם הערך הוא false, צריך לציין רק ערך אחד.
valueMetadata[]

object (AttributeValueMetadata)

לסוגים מסוימים של מאפיינים (לדוגמה, מאפייני enum), מוצגת רשימה של ערכים נתמכים ושמות תצוגה תואמים לערכים האלה.
deprecated

boolean

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

AttributeValueMetadata

מטא-נתונים של ערכי מאפיינים נתמכים.

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

value (Value format)

ערך המאפיין.
displayName

string

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

לדוגמה, במאפיין enum של "WiFi", הערך יכול להיות "Paid" כדי לייצג Wi-Fi בתשלום.