Method: categories.list

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

בקשת HTTP

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

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

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

פרמטרים
regionCode

string

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

string

קוד השפה BCP 47. אם השפה לא זמינה, ברירת המחדל תהיה אנגלית.
searchTerm

string

מחרוזת אופציונלית לסינון ממשתמש.
pageSize

integer

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

string

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

enum (CategoryView)

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

גוף הבקשה

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

גוף התגובה

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

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

object (Category)

הקטגוריות. הקטגוריות הן תצוגה בסיסית. הם לא מכילים מידע על סוג השירות.
totalCategoryCount

integer

המספר הכולל של קטגוריות לפרמטרים של הבקשה.
nextPageToken

string

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

היקפי הרשאות

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

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

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