Method: categories.list

傳回業務類別清單。搜尋會比對類別名稱，但不會比對類別 ID。

搜尋只會比對類別名稱的前面 (也就是說，「食物」可能會傳回「美食廣場」，但不會傳回「速食餐廳」)。

HTTP 要求

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

這個網址使用 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.ListCategories 的回應訊息。

如果成功，回應主體會含有以下結構的資料：

JSON 表示法 
{
  "categories": [
    {
      object (Category)
    }
  ],
  "nextPageToken": string
}
欄位
categories[]

object (Category)

根據所要求參數建立的比對類別。
nextPageToken

string

如果類別數量超過要求的頁面大小，這個欄位就會填入符記，以便在後續呼叫 categories.list 時擷取下一個類別。

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱 OAuth 2.0 總覽。