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. צריך להזין את 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.

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

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

לדוגמה, במאפיין 'טיפוסים בני מנייה (enum)' 'Wi-Fi', המאפיין יכול להכיל את המילה 'בתשלום' (בתשלום) כדי לייצג Wi-Fi בתשלום.