Method: categories.list

מחזירה רשימה של קטגוריות של עסקים. החיפוש יתאים לשם הקטגוריה, אבל לא למזהה הקטגוריה.

החיפוש תואם רק לתחילת שם הקטגוריה (כלומר, 'אוכל' יכול להחזיר 'מתחם אוכל' אבל לא 'מסעדת מזון מהיר').

בקשת HTTP

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

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

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

פרמטרים
regionCode

string

חובה. קוד מדינה בפורמט ISO 3166-1 alpha-2.
languageCode

string

חובה. קוד השפה של BCP 47.
filter

string

זה שינוי אופציונלי. סינון מחרוזת מהמשתמש. השדה היחיד שנתמך הוא displayName. לדוגמה: filter=displayName=foo.
pageSize

integer

זה שינוי אופציונלי. כמה קטגוריות לאחזר בכל דף. ברירת המחדל היא 100, המינימום הוא 1 וגודל הדף המקסימלי הוא 100.
pageToken

string

זה שינוי אופציונלי. אם צוין, הדף הבא של הקטגוריות יאוחזר.
view

enum (CategoryView)

חובה. מציינת אילו חלקים של המשאב 'קטגוריה' יוחזרו בתשובה.

גוף הבקשה

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

גוף התשובה

הודעת תגובה בנושא BusinessCategory.ListCategory.

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

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

object (Category)

הקטגוריות התואמות על סמך הפרמטרים הנדרשים.
nextPageToken

string

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

היקפי ההרשאות

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

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

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