針對具有指定主要類別和國家/地區的地點,傳回可用的屬性清單。
HTTP 要求
GET https://mybusinessbusinessinformation.googleapis.com/v1/attributes
這個網址使用 gRPC 轉碼語法。
查詢參數
參數 | |
---|---|
parent |
用來查詢可用屬性的位置資源名稱。如果設定了這個欄位,className、regionCode、languageCode 和 showAll 就不是必要欄位,而且不可以設定。 |
categoryName |
主要類別固定 ID 來尋找可用的屬性。必須採用類別格式/{category_id}。 |
regionCode |
使用 ISO 3166-1 alpha-2 國家/地區代碼來尋找可用屬性。 |
languageCode |
要取得屬性顯示名稱的 BCP 47 語言代碼。如果沒有這個語言,系統將以英文提供。 |
showAll |
這個欄位設為 true 時,系統就會傳回所有可用屬性的中繼資料,而忽略父項和 categoryName 欄位。如果 showAll 設為 true,則代表 languageCode 和 regionCode 為必要項目。 |
pageSize |
每頁應包含的屬性數量。預設值為 200,最小值為 1。 |
pageToken |
指定時,系統會擷取屬性中繼資料的下一頁。 |
要求主體
要求主體必須為空白。
回應主體
AttributesService.ListAttributeMetadata 的回應。
如果成功,回應主體即會包含具有以下結構的資料:
JSON 表示法 |
---|
{
"attributeMetadata": [
{
object ( |
欄位 | |
---|---|
attributeMetadata[] |
可用屬性的一組屬性中繼資料。 |
nextPageToken |
如果屬性數量超過要求的頁面大小,系統會在這個欄位填入一個符記,以便在後續呼叫 |
授權範圍
需要下列 OAuth 範圍:
https://www.googleapis.com/auth/business.manage
詳情請參閱 OAuth 2.0 總覽。
AttributeMetadata
屬性的中繼資料,包含屬性的顯示資訊,包括本地化名稱,以及將相關屬性分組的標題。
JSON 表示法 |
---|
{ "parent": string, "valueType": enum ( |
欄位 | |
---|---|
parent |
屬性的專屬 ID。 |
valueType |
屬性的值類型。設定和擷取的值應該屬於此類型。 |
displayName |
屬性的本地化顯示名稱 (如有);否則為英文顯示名稱。 |
groupDisplayName |
包含這個屬性的群組的本地化顯示名稱 (如有),否則請使用英文群組名稱。相關屬性會彙整成群組,並顯示於這裡指定的標題下方。 |
repeatable |
如果為 true,則屬性支援多個值。如果設為 false,則只能提供一個值。 |
valueMetadata[] |
系統會針對部分類型的屬性 (例如列舉),列出支援的值清單和這些值的對應顯示名稱。 |
deprecated |
如果為 true,則屬性已淘汰,不應再使用。如果已淘汰,更新這個屬性不會導致錯誤,但系統不會儲存更新內容。在遭到淘汰的某個時間點,這個屬性會徹底移除,並導致錯誤發生。 |
AttributeValueMetadata
支援屬性值的中繼資料。
JSON 表示法 |
---|
{ "value": value, "displayName": string } |
欄位 | |
---|---|
value |
屬性值。 |
displayName |
這個值的顯示名稱 (如有本地化版本),否則為英文。這個值的顯示名稱必須搭配屬性顯示名稱使用。 舉例來說,「Wi-Fi」列舉屬性可能包含「付費」一詞,代表付費 Wi-Fi。 |