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.