Method: attributes.list

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

בקשת HTTP

GET https://mybusiness.googleapis.com/v4/attributes

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

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

פרמטרים
name

string

שם המשאב של המיקום לחיפוש מאפיינים זמינים.
categoryId

string

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

string

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

string

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

integer

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

string

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

גוף הבקשה

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

גוף התגובה

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

הודעת תגובה עבור Locations.ListAttributeMetadata.

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

object (AttributeMetadata)

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

string

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

היקפי הרשאות

כדי להשתמש בתכונה הזו יש צורך באחד מההיקפים הבאים של OAuth:

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

למידע נוסף, עיין בסקירה הכללית על OAuth 2.0.