Method: attributes.list

傳回特定主要類別和國家/地區的地點可用的屬性清單。

HTTP 要求

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

這個網址使用 gRPC 轉碼語法。

查詢參數

參數
parent

string

用於查詢可用屬性的位置資源名稱。如果設定了這個欄位，就不必設定 categoryName、regionCode、languageCode 和 showAll。
categoryName

string

主要類別固定 ID，用於尋找可用屬性。格式必須為「category/{category_id}」。
regionCode

string

用於尋找可用屬性的 ISO 3166-1 alpha-2 國家/地區代碼。
languageCode

string

要產生屬性顯示名稱的 BCP 47 語言代碼。如果無法使用這個語言，系統將以英文提供相關內容。
showAll

boolean

這個欄位設為 true 時，系統會傳回所有可用屬性的中繼資料，並忽略父項和類別名稱欄位。如果 showAll 設為 true，則顯示 languageCode 和 regionCode 為必填。
pageSize

integer

每頁要加入的屬性數量。預設值為 200，最小值為 1。
pageToken

string

如有指定，系統會擷取屬性中繼資料的下一頁。

要求主體

要求主體必須為空白。

回應主體

AttributesService.ListAttributeMetadata 回應。

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

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

object (AttributeMetadata)

可用屬性的屬性中繼資料集合。
nextPageToken

string

如果屬性數量超過要求的頁面大小，這個欄位就會填入符記，以便在後續呼叫 attributes.list 時擷取下一頁的屬性。如果沒有更多屬性，這個欄位就不會出現在回應中。

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱 OAuth 2.0 總覽。

AttributeMetadata

屬性的中繼資料。包含屬性的顯示資訊，包括本地化名稱，以及用來將相關屬性分組的標題。

JSON 表示法 
{
  "parent": string,
  "valueType": enum (AttributeValueType),
  "displayName": string,
  "groupDisplayName": string,
  "repeatable": boolean,
  "valueMetadata": [
    {
      object (AttributeValueMetadata)
    }
  ],
  "deprecated": boolean
}
欄位
parent

string

屬性的專屬 ID。
valueType

enum (AttributeValueType)

屬性的值類型。已設定及擷取的值應採用這個類型。
displayName

string

屬性的本地化顯示名稱 (如有)；否則為英文顯示名稱。
groupDisplayName

string

含有這個屬性的群組顯示名稱 (如有)；否則為英文群組名稱。相關屬性會彙整到群組中，並全部顯示在此處提供的標題下方。
repeatable

boolean

如為 true，則屬性支援多個值。如果為 false，則只能提供單一值。
valueMetadata[]

object (AttributeValueMetadata)

對於某些類型的屬性 (例如列舉)，系統會提供清單支援的值和這些值的對應顯示名稱。
deprecated

boolean

如為 true，則屬性已淘汰，因此不再使用。如果已淘汰，更新這項屬性並不會導致錯誤，但系統不會儲存更新內容。該屬性在淘汰後不久將完全移除，會變成錯誤。

AttributeValueMetadata

支援屬性值的中繼資料。

JSON 表示法 
{
  "value": value,
  "displayName": string
}
欄位
value

value (Value format)

屬性值。
displayName

string

此值的顯示名稱 (如有本地化)否則請使用英文值顯示名稱必須搭配屬性顯示名稱使用。

舉例來說，如果是「WiFi」列舉屬性，可能含有「付費」代表付費 Wi-Fi