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)

הקטגוריות. הקטגוריות הן תצוגת BASIC. הם לא מכילים מידע על ServiceType.
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.