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.