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.