Method: attributes.list

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

בקשת HTTP

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

בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.

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

פרמטרים
parent

string

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

string

המזהה היציב של הקטגוריה הראשית, שבו אפשר למצוא את המאפיינים הזמינים. חייב להיות בפורמט {category_id}/קטגוריות הפורמט.
regionCode

string

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

string

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

boolean

כאשר השדה הזה מוגדר כ-True, המטא-נתונים של כל המאפיינים הזמינים מוחזרים, תוך התעלמות מהשדות של ההורה ומ-categoryName. יש להזין קוד שפה ו-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.

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)

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

boolean

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

AttributeValueMetadata

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

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

value (Value format)

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

string

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

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