Method: attributes.list

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

HTTP 要求

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

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

查詢參數

參數
parent

string

(選用步驟) 要查詢可用屬性的位置資源名稱。如果設定這個欄位，則不需設定 categoryName、regionCode、languageCode 和 showAll，且不得設定。

格式：locations/{locationId} (例如 locations/1234567890)。
categoryName

string

(選用步驟) 主要類別的穩定 ID，用於尋找可用屬性。格式必須為 categories/{category_id} (例如 categories/gcid:restaurant)。如果未設定 parent，且 showAll 為 false，則必須提供這個值。
regionCode

string

(選用步驟) ISO 3166-1 alpha-2 國家/地區代碼，用於尋找可用的屬性。如未設定 parent，則為必要。
languageCode

string

(選用步驟) 要取得屬性顯示名稱的語言 BCP 47 代碼。如果沒有，則會以英文顯示。
showAll

boolean

(選用步驟) 如果設為 true，系統會傳回所有可用屬性的中繼資料，並忽略 parent 和 categoryName 欄位。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 Overview。

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」列舉屬性，則可包含「Paid」來代表付費 Wi-Fi。