Package google.mybusiness.businessinformation.v1

索引

AttributesService

可讓用戶端查詢及更新特定位置的屬性。

GetAttributes

rpc GetAttributes(GetAttributesRequest) returns (Attributes)

查詢特定地點的所有屬性。

授權範圍

需要下列 OAuth 範圍:

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

詳情請參閱 OAuth 2.0 總覽

GetGoogleUpdatedAttributes

rpc GetGoogleUpdatedAttributes(GetGoogleUpdatedAttributesRequest) returns (Attributes)

取得指定位置的 Google 更新版本。

授權範圍

需要下列 OAuth 範圍:

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

詳情請參閱 OAuth 2.0 總覽

ListAttributeMetadata

rpc ListAttributeMetadata(ListAttributeMetadataRequest) returns (ListAttributeMetadataResponse)

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

授權範圍

需要下列 OAuth 範圍:

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

詳情請參閱 OAuth 2.0 總覽

UpdateAttributes

rpc UpdateAttributes(UpdateAttributesRequest) returns (Attributes)

更新特定地點的屬性。

授權範圍

需要下列 OAuth 範圍:

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

詳情請參閱 OAuth 2.0 總覽

CategoriesService

這個 API 說明瞭 Google 上商家所在地點支援的類別。詳情請參閱本文中的「類別」一節:https://support.google.com/business/answer/3038177

BatchGetCategories

rpc BatchGetCategories(BatchGetCategoriesRequest) returns (BatchGetCategoriesResponse)

傳回指定語言和 GConcept ID 的業務類別清單。

授權範圍

需要下列 OAuth 範圍:

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

詳情請參閱 OAuth 2.0 總覽

ListCategories

rpc ListCategories(ListCategoriesRequest) returns (ListCategoriesResponse)

傳回業務類別清單。搜尋會比對類別名稱,而不是類別 ID。

搜尋只會比對類別名稱的前面 (也就是說,「food」可能會傳回「Food Court」,但不會顯示「Fast Food Restaurant」)。

授權範圍

需要下列 OAuth 範圍:

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

詳情請參閱 OAuth 2.0 總覽

鏈結

查詢連鎖店相關資訊的服務。

GetChain

rpc GetChain(GetChainRequest) returns (Chain)

取得指定的鏈結。如果鏈結不存在,則傳回 NOT_FOUND

授權範圍

需要下列 OAuth 範圍:

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

詳情請參閱 OAuth 2.0 總覽

SearchChains

rpc SearchChains(SearchChainsRequest) returns (SearchChainsResponse)

根據連鎖店名稱搜尋鏈結。

授權範圍

需要下列 OAuth 範圍:

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

詳情請參閱 OAuth 2.0 總覽

GoogleLocations

此 API 可讓您存取及搜尋 GoogleLocation。

SearchGoogleLocations

rpc SearchGoogleLocations(SearchGoogleLocationsRequest) returns (SearchGoogleLocationsResponse)

搜尋與指定要求相符的所有可能位置。

授權範圍

需要下列 OAuth 範圍:

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

詳情請參閱 OAuth 2.0 總覽

位置

這個 API 可讓你在 Google 上管理商家所在地點。

CreateLocation

rpc CreateLocation(CreateLocationRequest) returns (Location)

建立由登入使用者擁有的新位置。

授權範圍

需要下列 OAuth 範圍:

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

詳情請參閱 OAuth 2.0 總覽

DeleteLocation

rpc DeleteLocation(DeleteLocationRequest) returns (Empty)

刪除位置。

如果無法使用 API 刪除這個地點,並且在 google.mybusiness.businessinformation.v1.LocationState 中標示了這個地點,請使用 Google 商家檔案網站。

授權範圍

需要下列 OAuth 範圍:

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

詳情請參閱 OAuth 2.0 總覽

GetGoogleUpdatedLocation

rpc GetGoogleUpdatedLocation(GetGoogleUpdatedLocationRequest) returns (GoogleUpdatedLocation)

取得指定位置的 Google 更新版本。

授權範圍

需要下列 OAuth 範圍:

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

詳情請參閱 OAuth 2.0 總覽

GetLocation

rpc GetLocation(GetLocationRequest) returns (Location)

傳回指定位置。

授權範圍

需要下列 OAuth 範圍:

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

詳情請參閱 OAuth 2.0 總覽

ListLocations

rpc ListLocations(ListLocationsRequest) returns (ListLocationsResponse)

列出指定帳戶的營業地點。

授權範圍

需要下列 OAuth 範圍:

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

詳情請參閱 OAuth 2.0 總覽

UpdateLocation

rpc UpdateLocation(UpdateLocationRequest) returns (Location)

更新指定的位置。

授權範圍

需要下列 OAuth 範圍:

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

詳情請參閱 OAuth 2.0 總覽

AdWordsLocationExtensions

AdWords 中顯示的額外資訊。

欄位
ad_phone

string

必要欄位。顯示在 AdWords 地點額外資訊中的備用電話號碼,而非位置的主要電話號碼。

屬性

地點屬性。屬性可提供與位置相關的額外資訊。位置可設定的屬性可能會因該位置的屬性 (例如類別) 而有所不同。可用屬性由 Google 決定,且可能會在不變更 API 的情況下新增及移除。

欄位
name

string

必要欄位。此屬性的資源名稱。

value_type

AttributeValueType

僅供輸出。此屬性包含的值類型。這應用於決定如何解讀這個值。

values[]

Value

這項屬性的值。提供的值類型必須符合該屬性的預期。這是個重複欄位,當中可以提供多個屬性值。屬性類型僅支援一個值。

repeated_enum_value

RepeatedEnumAttributeValue

如果屬性值類型為 REPEATED_ENUM,這個類型就會包含屬性值,其他值欄位則必須留空。

uri_values[]

UriAttributeValue

如果屬性值類型為「網址」,則這個欄位會包含這項屬性的值,而其他值欄位則須留空。

AttributeMetadata

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

欄位
parent

string

屬性的專屬 ID。

value_type

AttributeValueType

屬性的值類型。設定和擷取的值應該屬於此類型。

display_name

string

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

group_display_name

string

包含這個屬性的群組的本地化顯示名稱 (如有),否則請使用英文群組名稱。相關屬性會彙整成群組,並顯示於這裡指定的標題下方。

repeatable

bool

如果為 true,則屬性支援多個值。如果設為 false,則只能提供一個值。

value_metadata[]

AttributeValueMetadata

系統會針對部分類型的屬性 (例如列舉),列出支援的值清單和這些值的對應顯示名稱。

deprecated

bool

如果為 true,則屬性已淘汰,不應再使用。如果已淘汰,更新這個屬性不會導致錯誤,但系統不會儲存更新內容。在遭到淘汰的某個時間點,這個屬性會徹底移除,並導致錯誤發生。

AttributeValueMetadata

支援屬性值的中繼資料。

欄位
value

Value

屬性值。

display_name

string

這個值的顯示名稱 (如有本地化版本),否則為英文。這個值的顯示名稱必須搭配屬性顯示名稱使用。

舉例來說,「Wi-Fi」列舉屬性可能包含「付費」一詞,代表付費 Wi-Fi。

AttributeValueType

屬性的值類型。

列舉
ATTRIBUTE_VALUE_TYPE_UNSPECIFIED 未指定。
BOOL 這項屬性的值是布林值。
ENUM 屬性包含預先定義的可用值清單。此屬性的中繼資料會列出這些值。
URL 這項屬性的值是網址。
REPEATED_ENUM 屬性值是一個列舉,其中含有多個可明確設定或取消的可能值。

屬性

特定位置所有屬性的容器。

欄位
name

string

必要欄位。這個地點的 Google ID,格式為 locations/{location_id}/attributes

attributes[]

Attribute

一組需要更新的屬性。

BatchGetCategoriesRequest

要求 BusinessCategories.BatchGetBusinessCategories 要求訊息。

欄位
names[]

string

必要欄位。至少須設定一個名稱。應傳回本地化類別名稱的 GConcept ID。如要傳回多個類別的詳細資料,請在要求中重複使用這個參數。

language_code

string

必要欄位。應傳回類別名稱的 BCP 47 語言代碼。

region_code

string

選用設定。用來推斷非標準語言的 ISO 3166-1 alpha-2 國家/地區代碼。

view

CategoryView

必要欄位。指定要在回應中傳回 Category 資源的哪些部分。

BatchGetCategoriesResponse

BusinessCategories.BatchGetBusinessCategories 的回應訊息。

欄位
categories[]

Category

與要求中提供的 GConcept ID 相符的類別。順序與要求中的類別 ID 順序不同。

BusinessHours

代表這個地點營業的時間範圍。保存一組 [TimePeriod][google.mybusiness.mybusinessinformation.v1.TimePeriod] 執行個體。

欄位
periods[]

TimePeriod

必要欄位。這個地點營業的一系列次數。每個時段代表地點在一週中營業的時段。

類別

描述商家的一組類別。在更新期間,您必須同時設定這兩個欄位。用戶端不得使用更新遮罩個別更新主要或其他類別。

欄位
primary_category

Category

必要欄位。與這個地點所屬核心商家最相符的類別。

additional_categories[]

Category

選用設定。其他用來描述您商家的類別。類別可協助客戶準確找到感興趣的服務。為確保商家資訊正確且上線,請盡量減少描述整體核心業務的類別。盡可能選用足以代表您主要業務的精確類別。

類別

說明商家性質 (而非業務內容) 的類別。如需有效類別 ID 清單,以及這些 ID 對應至使用者可理解的名稱,請參閱 categories.list

欄位
name

string

必要欄位。這個類別的固定 ID (由 Google 提供)。修改類別時 (建立或更新位置時),必須指定值。

display_name

string

僅供輸出。使用者可理解的類別名稱。系統會在讀取位置時設定這個字串。修改位置時,必須設定 category_id

service_types[]

ServiceType

僅供輸出。此業務類別適用所有服務類型的清單。

more_hours_types[]

MoreHoursType

僅供輸出。這個業務類別可用的更多營業時間類型。

CategoryView

用於限制伺服器傳回的資料量。

列舉
CATEGORY_VIEW_UNSPECIFIED 未指定,等同於 CATEGORY_METADATA_ONLY。
BASIC 伺服器回應只會包含「Category」欄位「display_name」、「category_id」和「language_code」。其中會省略任何服務類型中繼資料相關欄位。
FULL 傳回回應中的所有欄位。

吊鍊

連鎖店是指您的商家所在地點可與品牌建立關聯的品牌。

欄位
name

string

必要欄位。鏈結的資源名稱,格式為 chains/{chain_id}

chain_names[]

ChainName

鏈結的名稱。

websites[]

ChainUri

連鎖店的網站。

location_count

int32

屬於這個連鎖店的地點數量。

ChainName

顯示鏈結時使用的名稱。

欄位
display_name

string

這個鏈結的顯示名稱。

language_code

string

名稱語言的 BCP 47 代碼。

ChainUri

顯示鏈結時使用的網址。

欄位
uri

string

這個鏈結的 URI。

CreateLocationRequest

Locations.CreateLocation 的要求訊息。

欄位
parent

string

必要欄位。要建立這個地點的帳戶名稱。

location

Location

必要欄位。新的位置中繼資料。

validate_only

bool

選用設定。如果為 true,表示要求已通過驗證,而且不會實際建立位置。

request_id

string

選用設定。伺服器用於偵測重複要求的專屬要求 ID。建議您使用 UUID。長度上限為 50 個半形字元。

DeleteLocationRequest

Locations.DeleteLocation 的要求訊息。

欄位
name

string

必要欄位。要刪除的位置名稱。

ErrorCode

API 傳回的所有錯誤代碼。

列舉
ERROR_CODE_UNSPECIFIED 缺少錯誤代碼。
INVALID_ATTRIBUTE_NAME 您提供的其中一個屬性無法套用至這個位置。只有 ListAttributeMetadata 回應中傳回的屬性可以套用至這個位置。所有有問題的屬性名稱都會透過中繼資料下的 attribute_names 鍵傳回。
ASSOCIATE_OPERATION_ON_VERIFIED_LOCATION 用戶端嘗試將特定地點建立關聯,或是清除已驗證狀態的地點關聯時,系統就會傳回這個錯誤。
ASSOCIATE_LOCATION_INVALID_PLACE_ID associateLocation 要求中提供的 place_id 與該地點不符或無效。確認所設定的 place_idSearchGoogleLocations 回應中傳回的其中一個 ID 相符。
LAT_LNG_UPDATES_NOT_PERMITTED 這項專案不允許更新「位置」上的經緯度欄位。您可以使用 UI 中的圖釘放置功能更新經緯度,或向我們提供地址。
PO_BOX_IN_ADDRESS_NOT_ALLOWED 郵政信箱不能用於地址。中繼資料鍵包含「field_mask」。
BLOCKED_REGION 我們必須遵守國際制裁相關規定,因此無法支援這個區域的商家。中繼資料鍵包括「field_maks」。
MISSING_BOTH_PHONE_AND_WEBSITE CUSTOMER_LOCATION_ONLY 的商家必須有電話或網站。中繼資料鍵包含「field_mask」。
MISSING_STOREFRONT_ADDRESS_OR_SAB 所有地點都必須至少設定店面地址或服務範圍。中繼資料鍵包含「field_mask」。
LAT_LNG_TOO_FAR_FROM_ADDRESS 經緯度和地址組合相距太遠。中繼資料鍵包含「field_mask」。
LAT_LNG_REQUIRED 已淘汰。已由 PIN_DROP_REQUIRED 取代。找不到指定的地址。請提供經緯度。中繼資料鍵包含「field_mask」。
INVALID_CHARACTERS 發現無效字元。中繼資料鍵包括「field_mask」和「invalid_characters」。
FORBIDDEN_WORDS 找到禁用的字詞。中繼資料鍵包括「field_mask」和「forbidden_words」。
INVALID_INTERCHANGE_CHARACTERS 發現無效字元。中繼資料鍵包含「field_mask」。
FIELDS_REQUIRED_FOR_CATEGORY 您必須為此地區類別填寫其他欄位。中繼資料鍵包括「field_mask」、「value」和「fields_required」。
STOREFRONT_REQUIRED_FOR_CATEGORY 您的業務類別必須有可供消費者造訪的店面地點。中繼資料鍵包含「field_mask」。
ADDRESS_MISSING_REGION_CODE 地址缺少必要的區域代碼。中繼資料鍵包含「field_mask」。
ADDRESS_EDIT_CHANGES_COUNTRY 地址無法移至其他國家/地區。中繼資料鍵包含「field_mask」。
SPECIAL_HOURS_SET_WITHOUT_REGULAR_HOURS 只有在地點正常營業時間的情況下,才能指定特殊營業時間。中繼資料空白。
INVALID_TIME_SCHEDULE 時段無效,重疊或結束時間早於開始時間。中繼資料鍵包含「field_mask」。
INVALID_HOURS_VALUE 營業時間格式或值無效。中繼資料鍵包含「field_mask」。
OVERLAPPED_SPECIAL_HOURS Special_hours 不得重疊。中繼資料鍵包含「field_mask」。
INCOMPATIBLE_MORE_HOURS_TYPE_FOR_CATEGORY 你的商家主要類別不支援這個營業時間類型。中繼資料鍵包括「field_mask」和「incompatible_hours_type」。
DUPLICATE_CHILDREN_LOCATIONS Relationship_data 含有重複的 children_locations。中繼資料鍵包含「field_mask」。
INCOMPATIBLE_SERVICE_AREA_AND_CATEGORY 服務範圍商家不能選取主要類別。中繼資料鍵包含「field_mask」。
INVALID_SERVICE_AREA_PLACE_ID service_area 中的 place_id 無效。中繼資料鍵包括「field_mask」和「place_id」。
INVALID_AREA_TYPE_FOR_SERVICE_AREA service_area 的區域類型無效。中繼資料鍵包括「field_mask」和「place_id」。
OPENING_DATE_TOO_FAR_IN_THE_FUTURE 輸入的開幕日期必須在一年內。中繼資料鍵包含「field_mask」。
OPENING_DATE_MISSING_YEAR_OR_MONTH 開幕日期必須指定年份或月份。中繼資料鍵包含「field_mask」。
OPENING_DATE_BEFORE_1AD 開幕日期不得早於西元西元年。中繼資料鍵包含「field_mask」。
TOO_MANY_ENTRIES 欄位項目過多。中繼資料鍵包括「field_mask」和「max_count」。
INVALID_PHONE_NUMBER 系統無法辨識輸入的電話號碼。中繼資料鍵包括「field_mask」和「value」。
INVALID_PHONE_NUMBER_FOR_REGION 電話號碼不適用於此區域。中繼資料鍵包括「field_mask」和「value」。
MISSING_PRIMARY_PHONE_NUMBER 缺少主要電話號碼。中繼資料鍵包含「field_mask」。
THROTTLED 目前無法更新這個欄位。中繼資料鍵包括「field_mask」和「value」。
UNSUPPORTED_POINT_RADIUS_SERVICE_AREA 系統已不再支援點半徑服務範圍。中繼資料鍵包含「field_mask」。
INVALID_CATEGORY 類別 ID 無效。中繼資料鍵包括「field_mask」和「value」。
CANNOT_REOPEN 商家無法將商家恢復營業。中繼資料鍵包含「field_mask」。
INVALID_BUSINESS_OPENING_DATE 商家開幕日期無效。中繼資料鍵包含「field_mask」。
INVALID_LATLNG 經緯度無效。中繼資料鍵包含「field_mask」。
PROFILE_DESCRIPTION_CONTAINS_URL 商家說明不得包含網址。中繼資料鍵包含「field_mask」。
LODGING_CANNOT_EDIT_PROFILE_DESCRIPTION 無法修改住宿地點的個人資料說明。中繼資料鍵包含「field_mask」。
INVALID_URL 連結無效。中繼資料鍵包含「field_mask」。
INVALID_ADDRESS 位址無效。中繼資料鍵包含「field_mask」。
PARENT_CHAIN_CANNOT_BE_THE_LOCATION_ITSELF ParentChain 不得位於位置本身。中繼資料鍵包括「field_mask」和「value」。
RELATION_CANNOT_BE_THE_LOCATION_ITSELF 關聯性不得為地點本身。中繼資料鍵包括「field_mask」和「value」。
MISSING_ADDRESS_COMPONENTS 地址元件值缺少值。中繼資料鍵包含「field_mask」。
READ_ONLY_ADDRESS_COMPONENTS 無法編輯唯讀地址元件。中繼資料鍵包含「field_mask」。
STRING_TOO_LONG 字串過長。中繼資料鍵包括「field_mask」和「max_length」。
STRING_TOO_SHORT 字串過短。中繼資料鍵包括「field_mask」和「min_length」。
REQUIRED_FIELD_MISSING_VALUE 必填欄位缺少值。中繼資料鍵包含「field_mask」。
ATTRIBUTE_PROVIDER_URL_NOT_ALLOWED 無法新增或編輯供應商的網址。中繼資料鍵包括「attribute_name」。
ATTRIBUTE_INVALID_ENUM_VALUE 列舉屬性不明。中繼資料鍵包括「attribute_name」。
ATTRIBUTE_NOT_AVAILABLE 可擴充的屬性不適用於這個位置。中繼資料鍵包括「attribute_name」。
ATTRIBUTE_CANNOT_BE_REPEATED 可擴充的屬性只能指定一次。中繼資料鍵包括「attribute_name」。
ATTRIBUTE_TYPE_NOT_COMPATIBLE_FOR_CATEGORY 可擴充屬性與地點中設定的類別不相容。中繼資料鍵包括「attribute_name」。
ADDRESS_REMOVAL_NOT_ALLOWED 你的商家不允許移除地址。中繼資料鍵包含「field_mask」。
AMBIGUOUS_TITLE 語言設定不明確。中繼資料鍵包含「field_mask」。
INVALID_CATEGORY_FOR_SAB 純 SAB 不得包含為 gcid:builtment_poi 子類型的 gcids。中繼資料鍵包括「field_mask」和「value」。
RELATION_ENDPOINTS_TOO_FAR 關係端點彼此相距太遠。中繼資料鍵包括「field_mask」和「value」。
INVALID_SERVICE_ITEM 尚未設定 Structured_service_item 和 free_form_service_item。中繼資料鍵包含「field_mask」。
SERVICE_ITEM_LABEL_NO_DISPLAY_NAME 標籤缺少顯示名稱。中繼資料鍵包含「field_mask」。
SERVICE_ITEM_LABEL_DUPLICATE_DISPLAY_NAME 顯示名稱在所有價目表中,並非專屬於所有標籤。中繼資料鍵包含「field_mask」。
SERVICE_ITEM_LABEL_INVALID_UTF8 標籤含有無效的 UTF-8 符號。中繼資料鍵包含「field_mask」。
FREE_FORM_SERVICE_ITEM_WITH_NO_CATEGORY_ID Free_form_service_item 缺少 category_id 欄位。中繼資料鍵包含「field_mask」。
FREE_FORM_SERVICE_ITEM_WITH_NO_LABEL free_form_service_item 缺少標籤。中繼資料鍵包含「field_mask」。
SERVICE_ITEM_WITH_NO_SERVICE_TYPE_ID 缺少 Structured_service_item 中的 service_type_id 欄位。中繼資料鍵包含「field_mask」。
INVALID_LANGUAGE 語言代碼無效。中繼資料鍵包含「field_mask」。
PRICE_CURRENCY_MISSING 缺少 ISO 4217 貨幣代碼。中繼資料鍵包含「field_mask」。
PRICE_CURRENCY_INVALID 提供的貨幣代碼不是有效的 ISO 4217。中繼資料鍵包含「field_mask」。
SERVICE_TYPE_ID_DUPLICATE 地點中的服務類型 ID 不得重複。中繼資料鍵包含「field_mask」。
PIN_DROP_REQUIRED 找不到指定的地址。請在 UI 中提供圖釘。中繼資料鍵包含「field_mask」。
STALE_DATA Google 最近更新了一或多個商品。目前只有這個商家的擁有者可以前往 business.google.com 變更「欄位」資料。中繼資料鍵包括「field_mask」。
PHONE_NUMBER_EDITS_NOT_ALLOWED 這個地點的電話號碼欄位已停用,且不允許編輯。中繼資料鍵包含「field_mask」。
MULTIPLE_ORGANIZATIONALLY_PART_OF_RELATION 有多個關係可用來模擬兩個位置的邏輯關係 (例如:基元)。中繼資料鍵包括「field_mask」和「value」。

GetAttributesRequest

AttributesService.GetAttributes 要求。

欄位
name

string

必要欄位。這個地點的 Google ID,格式為 locations/{location_id}/attributes

GetChainRequest

Locations.GetChain 要求訊息。

欄位
name

string

必要欄位。鏈結的資源名稱,格式為 chains/{chain_place_id}

GetGoogleUpdatedAttributesRequest

針對 AttributesService.GetGoogleUpdatedAttributes 的要求。

欄位
name

string

必要欄位。這個地點的 Google ID,格式為 locations/{location_id}/attributes

GetGoogleUpdatedLocationRequest

Locations.GetGoogleUpdatedLocation 的要求訊息。

欄位
name

string

必要欄位。要擷取的位置名稱。

read_mask

FieldMask

必要欄位。讀取遮罩,以指定要在回應中傳回哪些欄位。

GetLocationRequest

Locations.GetLocation 的要求訊息。

欄位
name

string

必要欄位。要擷取的位置名稱。

read_mask

FieldMask

必要欄位。讀取遮罩,以指定要在回應中傳回哪些欄位。

GoogleLocation

代表 Google 上顯示的 Location。例如使用者、其他人已聲明擁有權,或是未聲明擁有權的地點。

欄位
name

string

這個 GoogleLocation 的資源名稱,格式為 googleLocations/{googleLocationId}

location

Location

預先填入的 Location 資訊。如果使用者目前沒有聲明這個欄位,則可在 CreateLocation 中重複使用這個欄位。

request_admin_rights_uri

string

這個網址會將使用者重新導向至要求管理員權限使用者介面的網址。只有在任何使用者 (包括目前的使用者) 已聲明這個地點的擁有權時,系統才會顯示這個欄位。

GoogleUpdatedLocation

代表 Google 修改的位置。

欄位
location

Location

這個位置的 Google 更新版本。

diff_mask

FieldMask

Google 更新的欄位。

pending_mask

FieldMask

待審核的編輯內容尚未推送至 Google 地圖和搜尋的欄位。

標籤

顯示價格清單、專區或商品時使用的標籤。

欄位
display_name

string

必要欄位。價格清單、專區或商品的顯示名稱。

description

string

選用設定。價格清單、專區或商品的說明。

language_code

string

選用設定。這些字串適用的 BCP-47 語言代碼。每種語言只能設定一組標籤。

ListAttributeMetadataRequest

AttributesService.ListAttributeMetadata 的要求。

欄位
parent

string

用來查詢可用屬性的位置資源名稱。如果設定了這個欄位,則「category_name」、「region_code」、「language_code」和「show_all」並非必填欄位,而且必須不得設定。

category_name

string

主要類別固定 ID 來尋找可用的屬性。必須採用類別格式/{category_id}。

region_code

string

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

language_code

string

要取得屬性顯示名稱的 BCP 47 語言代碼。如果沒有這個語言,系統將以英文提供。

show_all

bool

這個欄位設為 true 時,系統就會傳回所有可用屬性的中繼資料,而忽略父項和 category_name 欄位。如果 show_all 設為 true,就必須是 language_code 和 region_code。

page_size

int32

每頁應包含的屬性數量。預設值為 200,最小值為 1。

page_token

string

指定時,系統會擷取屬性中繼資料的下一頁。

ListAttributeMetadataResponse

AttributesService.ListAttributeMetadata 的回應。

欄位
attribute_metadata[]

AttributeMetadata

可用屬性的一組屬性中繼資料。

next_page_token

string

如果屬性數量超過要求的頁面大小,系統會在這個欄位填入一個符記,以便在後續呼叫 attributes.list 時擷取下一頁的屬性。如果沒有其他屬性,回應中就不會顯示這個欄位。

ListCategoriesRequest

要求 BusinessCategories.ListCategories 要求訊息。

欄位
region_code

string

必要欄位。ISO 3166-1 alpha-2 國家/地區代碼。

language_code

string

必要欄位。BCP 47 語言代碼。

filter

string

選用設定。篩選使用者的字串。唯一支援的欄位是 displayName。例如:filter=displayName=foo

page_size

int32

選用設定。每頁要擷取的類別數量。預設值為 100,下限為 1,頁面大小上限為 100。

page_token

string

選用設定。如果有指定,系統會擷取下一頁的類別。

view

CategoryView

必要欄位。指定要在回應中傳回 Category 資源的哪些部分。

ListCategoriesResponse

BusinessCategories.ListCategories 的回應訊息。

欄位
categories[]

Category

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

next_page_token

string

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

ListLocationsRequest

Locations.ListLocations 的要求訊息。

欄位
parent

string

必要欄位。要擷取營業地點的帳戶名稱。如果上層 [帳戶] [google.mybusiness.accountmanagement.v1.Account] 為 [AccountType] [google.mybusiness.accountmanagement.v1.Account.AccountType] PERSONAL,系統就只會傳回帳戶直接擁有的地點,否則會傳回帳戶中的所有無障礙位置,無論是直接或間接傳回。

page_size

int32

選用設定。每頁要擷取的位置數量。如未設定,則預設值為 10。最少 1 個,頁面大小上限為 100 個。

page_token

string

選用設定。若指定,函式會擷取接下來 page 的位置。當位置超過要求的頁面大小時,呼叫 ListLocations 會傳回網頁權杖。

filter

string

選用設定。篩選器會限制要傳回的地點。回應只會包含符合篩選條件的項目。如果 filter 空白,系統會套用限制條件,為要求的帳戶擷取所有位置 (分頁)。

如要進一步瞭解有效的欄位和使用方式範例,請參閱使用位置資料指南

order_by

string

選用設定。要求的排序順序。下列 SQL 語法應以半形逗號分隔多個欄位。預設的排序順序是遞增。如要指定遞減順序,請加入後置字元「 desc」。Order_by 的有效欄位為 title 和 store_code。例如:「名稱、store_code desc」、「title」或「store_code desc」

read_mask

FieldMask

必要欄位。讀取遮罩,以指定要在回應中傳回哪些欄位。

ListLocationsResponse

Locations.ListLocations 的回應訊息。

欄位
locations[]

Location

地點。

next_page_token

string

如果地點數量超過要求的頁面大小,系統會在這個欄位填入權杖,以便在後續呼叫 ListLocations 時擷取下一頁的位置。如果沒有其他地點,回應中就不會顯示這個欄位。

total_size

int32

清單中位置的約略數量,與分頁無關。只有在使用 filter 做為查詢參數時,系統才會傳回這個欄位。

位置

地點。如需這些欄位的詳細說明,請參閱說明中心文章;如需有效業務類別清單,請參閱類別端點

欄位
name

string

這個地點的 Google ID,格式為:locations/{location_id}

language_code

string

無法變更。地點使用的語言。請在建立期間設定,且無法更新。

store_code

string

選用設定。這個位置的外部 ID,在某帳戶內不得重複。藉此將該地點與您自己的記錄建立關聯。

title

string

必要欄位。位置名稱必須如實反映商家的實際名稱,且與店面、網站和文具一致,客戶所知的名稱必須一致。您可將相關資訊加入資源的其他欄位 (例如 AddressCategories)。請勿在名稱中加入不必要的資訊,例如使用「Google」而非「Google Inc. - 山景城公司總部」。請勿加入行銷標語、商店代碼、特殊字元、營業時間或營業中/營業中狀態、電話號碼、網站網址、服務/產品資訊、地點/地址或路線,或是防裝資訊 (例如「杜恩大安森林公園」)。

phone_numbers

PhoneNumbers

選用設定。可供客戶與商家聯絡的不同電話號碼。

categories

Categories

選用設定。描述商家的不同類別。

storefront_address

PostalAddress

選用設定。請提供精確、精確的地址,用來說明您的商家所在地點。我們不接受位於偏遠地區的郵政信箱或信箱。目前,您最多可以在地址中指定五個 address_lines 值。請注意,這個欄位只適用於有店面的商家。請勿為 CUSTOMER_LOCATION_ONLY 類型的地點設定這個欄位,但如果有設定,系統將捨棄任何提供的值。

website_uri

string

選用設定。此商家的網址。如果可以,請使用能代表這個個別商家所在地點的網址,而非代表所有地點或品牌的一般網站/網址。

regular_hours

BusinessHours

選用設定。商家的營業時間。

special_hours

SpecialHours

選用設定。商家的特殊營業時間。通常包括假日營業時間及一般營業時間以外的其他時間。會覆寫一般營業時間。這個欄位必須不含一般營業時間,才能設定。

service_area

ServiceAreaBusiness

選用設定。服務範圍商家在客戶的所在地提供服務。如果這個商家是區域服務商家,這個欄位會說明商家提供的區域。

labels[]

string

選用設定。一組任意形式的字串,讓您可以標記商家。這些標籤「不會」向使用者顯示,只有您自己看得到。每個標籤的長度必須介於 1 至 255 個字元之間。

ad_words_location_extensions

AdWordsLocationExtensions

選用設定。AdWords 中顯示的額外資訊。

latlng

LatLng

選用設定。使用者提供的經緯度。建立位置時,如果提供的地址地理編碼成功,系統就會忽略這個欄位。只有在建立期間接受使用者提供的 latlng 值,或透過 Google 商家檔案網站更新 latlng 值時,get 要求才會傳回這個欄位。這個欄位只能由已核准的客戶更新。

open_info

OpenInfo

選用設定。表示地點目前是否營業中的標記。

metadata

Metadata

僅供輸出。其他不開放使用者編輯的資訊。

profile

Profile

選用設定。用自己的方式介紹商家,並向使用者介紹商家和產品的獨特故事。

除了住宿類別 (例如飯店、汽車旅館、旅舍) 外,所有類別都必須提供這個欄位。

relationship_data

RelationshipData

選用設定。與這個地點相關的所有地點和連鎖店。

more_hours[]

MoreHours

選用設定。其他部門或特定客戶的詳細營業時間。

service_items[]

ServiceItem

選用設定。商家支援的服務清單。任何服務都可以剪髮、安裝熱水器等。系統會自動移除重複的服務項目。

Metadata

地點的其他 (無法編輯)。

欄位
has_google_updated

bool

僅供輸出。指出與這個地點相關聯的地點 ID,是否含有需要由用戶端更新或拒絕的更新。如果設定了布林值,應呼叫 getGoogleUpdated 方法來查詢需要驗證的資訊。

has_pending_edits

bool

僅供輸出。指出這個地點的任何房源是否處於編輯待處理狀態。

can_delete

bool

僅供輸出。指出是否可以使用 API 刪除地點。

can_operate_local_post

bool

僅供輸出。指出該商家資訊是否可管理當地貼文。

can_modify_service_list

bool

僅供輸出。指出商家資訊是否可以修改服務清單。

can_have_food_menus

bool

僅供輸出。說明商家資訊是否適用於食物選單。

can_operate_health_data

bool

僅供輸出。指出該位置是否能對健康資料執行操作。

can_operate_lodging_data

bool

僅供輸出。指出地點是否能在住宿資料上運作。

place_id

string

僅供輸出。如果這個地點出現在 Google 地圖上,這個欄位會填入該位置的地點 ID。這個 ID 可用於多種 Places API。

您可以在 Create 呼叫期間設定此欄位,但無法在 Update 中設定。

duplicate_location

string

僅供輸出。這個地點重複的位置資源。

maps_uri

string

僅供輸出。地點在 Google 地圖上的連結。

new_review_uri

string

僅供輸出。消費者在 Google 搜尋上對該地點留下評論的網頁連結。

can_have_business_calls

bool

僅供輸出。說明商家資訊是否可撥打商家電話。

has_voice_of_merchant

bool

僅供輸出。表示商家資訊是否包含商家的 Voice。如果布林值為 false,則應呼叫 locations.getVoiceOfMerchantState API,瞭解為何這些地區未提供商家 Voice。

MoreHours

地點在特定類型的商家營業的期間。

欄位
hours_type_id

string

必要欄位。營業時間類型。客戶應致電 {#link businessCategories:BatchGet},取得各地點類別支援的營業時間類型。

periods[]

TimePeriod

必要欄位。這個地點的營業次數集合。每個時段代表地點在一週中營業的時段。

MoreHoursType

商家除了一般營業時間外,還有更多營業時間類型。

欄位
hours_type_id

string

僅供輸出。Google 針對這個營業時間類型提供的固定 ID。

display_name

string

僅供輸出。使用者容易理解的營業時間類型英文顯示名稱。

localized_display_name

string

僅供輸出。營業時間類型的本地化顯示名稱。

OpenInfo

商家營業狀態的相關資訊。

欄位
status

OpenForBusiness

必要欄位。指出該地點目前是否營業中。根據預設,所有地點都是營業中 (除非更新為已停業)。

can_reopen

bool

僅供輸出。表示這個商家是否有資格恢復營業。

opening_date

Date

選用設定。地點初次開啟的日期。如果不知道確切日期,則只能提供月份和年份。日期必須是過去的日期,或在未來一年內。

OpenForBusiness

表示地點的狀態。

列舉
OPEN_FOR_BUSINESS_UNSPECIFIED 未指定。
OPEN 表示地點營業中。
CLOSED_PERMANENTLY 表示該地點已永久停業。
CLOSED_TEMPORARILY 表示該地點已暫停營業。

PhoneNumbers

一組商家的電話號碼。在更新期間,您必須同時設定這兩個欄位。用戶端不得只使用更新遮罩更新主要或額外的電話號碼。建議使用國際電話號碼格式,例如「+1 415 555 0132」,詳情請參閱 https://developers.google.com/style/phone-numbers#international-phone-numbers)

欄位
primary_phone

string

必要欄位。盡量直接與個別商家地點聯絡的電話號碼。請提供本地電話號碼,避免使用客服中心的客服專線號碼。

additional_phones[]

string

選用設定。除了主要電話號碼外,貴商家最多還可以登錄兩組電話號碼 (僅限手機或市話,不接受傳真)。

PlaceInfo

定義以地點 ID 表示的區域。

欄位
place_name

string

必要欄位。地點的本地化名稱。例如 Scottsdale, AZ

place_id

string

必要欄位。地點的 ID。必須對應一個區域。(https://developers.google.com/places/web-service/supported_types#table3)

地點介面集

用於定義由一組地點代表的區域聯集。

欄位
place_infos[]

PlaceInfo

以地點 ID 表示的區域。地點數量上限為 20 個地點。

設定檔

與地點設定檔相關的所有資訊。

欄位
description

string

必要欄位。請說出地點說明,任何人都無法編輯。

RelationshipData

與此地點相關的所有家長和兒童地點資訊。

欄位
parent_location

RelevantLocation

與這個地點相關的上層位置。

children_locations[]

RelevantLocation

與這個地點相關的兒童地點清單。

parent_chain

string

這個位置所屬鏈結的資源名稱。[如何尋找連鎖店 ID] [Locations.SearchChains]

RelevantLocation

與目前位置相關的其他地點相關資訊。關係可以是 DEPARTMENT_OF 或 INDEPENDENT_ESTABLISHMENT_OF,而此處指定的位置可位於位置的任一側 (父項/子項)。

欄位
place_id

string

必要欄位。使用 placeID 指定關係另一側的位置。

relation_type

RelationType

必要欄位。關係的類型。

RelationType

要指定的類型關係。

列舉
RELATION_TYPE_UNSPECIFIED 未指定類型。
DEPARTMENT_OF 這代表 2 個地點之間的關係,屬於同一實體區域、相同的品牌/上層管理機構/機構,但具有不同的重要屬性 (例如營業時間或電話號碼)。舉例來說,「Costco Pharmacy」是「Costco 批發商」的部門,
INDEPENDENT_ESTABLISHMENT_IN 這是指兩個營業地點共同分在同一處,但分別屬於不同公司的情況 (例如,位於捷運地下街的星巴克、購物中心內的商店)。

RepeatedEnumAttributeValue

value_type 為 REPEATED_ENUM 的屬性值。當中包含兩份值 ID 清單,分別設為 (true) 和未設定 (false) 的值。缺少的值會視為不明。至少須指定一個值。

欄位
set_values[]

string

設定的列舉值。

unset_values[]

string

未設定的列舉值。

SearchChainsRequest

Locations.SearchChains 的要求訊息。

欄位
chain_name

string

必要欄位。使用鏈結名稱搜尋鏈結。支援完全/部分/模糊/相關查詢。範例:"walmart、"wal-mart"、"walmmmart"、"聃"

page_size

int32

這項查詢傳回的相符鏈結數量上限。預設值為 10。可能的值上限為 500。

SearchChainsResponse

Locations.SearchChains 的回應訊息。

欄位
chains[]

Chain

與 SearchChainsRequest 中查詢的 ChaininC_display_name 相符的鏈結。如果沒有相符項目,這個欄位會留空。結果會依關聯性排序。

SearchGoogleLocationsRequest

要求 GoogleLocations.SearchGoogleLocations 的訊息。

欄位
page_size

int32

要傳回的相符項目數量。預設值為 3,最多 10。請注意,如果要求更多,延遲時間可能會增加。沒有分頁。

聯集欄位 search_query。搜尋查詢。能以位置物件或字串查詢的形式提供。search_query 只能是下列其中一項:
location

Location

要搜尋的位置。如有提供,系統會找出與提供的地點詳細資料相符的地點。

query

string

要搜尋的文字查詢。查詢字串的搜尋結果會比提供確切位置來得準確,但可提供較不精確的符合項目。

SearchGoogleLocationsResponse

GoogleLocations.SearchGoogleLocations 的回應訊息。

欄位
google_locations[]

GoogleLocation

可能與指定要求相符的 GoogleLocation 集合,按精確度由高至低列出。

ServiceAreaBusiness

服務範圍商家在顧客的營業地點提供服務 (例如鎖匠或水電工)。

欄位
business_type

BusinessType

必要欄位。表示服務範圍商家的 [類型] [google.mybusiness.businessinfo.v1.ServiceAreaBusiness.BusinessType]。

places

Places

此商家透過一組地點指定的服務範圍。

region_code

string

無法變更。這個服務範圍商家所在國家/地區的 CLDR 區碼。詳情請參閱 http://cldr.unicode.org/http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html。例如:瑞士的地區代碼為「CH」。

這是 CUSTOMER_LOCATION_ONLY 商家的必填欄位,否則系統會忽略這個欄位。

此處指定的區域可能與此商家服務區域的區域不同 (例如在其所在地以外的區域提供服務的服務範圍商家)。

如果這個地點在建立後需要驗證,提供用於驗證的地址必須位於這個區域內,且業主或其授權代表必須能夠透過您提供的驗證地址接收郵寄郵件。

BusinessType

指出此商家是否只在消費者的所在地點 (例如拖車車) 提供現場服務,或者同時在地址和現場提供服務 (例如設有用餐區的披薩店,以及代客送貨服務)。

列舉
BUSINESS_TYPE_UNSPECIFIED 僅供輸出。未指定。
CUSTOMER_LOCATION_ONLY 只在周邊地區提供服務 (不在商家地址附近)。如果商家要從 CUSTOMER_AND_BUSINESS_LOCATION 更新為 CUSTOMER_LOCATION_ONLY,位置更新通知就必須包含 storefront_address 欄位遮罩,並將這個欄位設為空白。
CUSTOMER_AND_BUSINESS_LOCATION 在商家地址和周邊區域提供服務。

ServiceItem

描述單一服務項目的訊息。用來說明商家提供的服務類型。例如理髮並非服務。

欄位
price

Money

選用設定。代表服務項目的貨幣價格。加入價格時,建議您設定 currency_code 和 unit。這會視為服務項目的固定價格。

聯集欄位 service_item_info。請一律設定下列其中一個欄位。service_item_info 只能是下列其中一項:
structured_service_item

StructuredServiceItem

選用設定。這個欄位會設定結構化資料的大小寫。

free_form_service_item

FreeFormServiceItem

選用設定。這個欄位會設為任意形式服務資料的值。

FreeFormServiceItem

代表商家提供的任意形式服務。這些服務並未包含在 Google 的結構服務資料中。商家透過 Geomerchant 途徑手動輸入此類服務的名稱。

欄位
category

string

必要欄位。此欄位代表類別名稱 (即類別的固定 ID)。categoryservice_type_id 應與 Category 訊息中提供的可能組合相符。

label

Label

必要欄位。項目的語言標記標籤。項目名稱的建議長度上限為 140 個半形字元,說明的長度則不超過 250 個半形字元。只有在輸入內容為自訂服務項目時,才需要設定這個欄位。標準化服務類型應透過 service_type_id 更新。

StructuredServiceItem

代表商家提供的結構化服務。例如:ilet_installation。

欄位
service_type_id

string

必要欄位。service_type_id 欄位是 Google 提供的專屬 ID,您可以在 ServiceType 中找到。這項資訊是由「BatchGetCategories」安全單次點擊出價服務提供。

description

string

選用設定。結構化服務項目的說明。長度上限為 300 個半形字元。

ServiceType

商家所提供服務類型的訊息。

欄位
service_type_id

string

僅供輸出。這個服務類型的固定 ID (由 Google 提供)。

display_name

string

僅供輸出。使用者容易理解的服務類型的顯示名稱。

SpecialHourPeriod

代表某個地點的營業時間與正常營業時間不同的時間範圍。特殊時段必須代表小於 24 小時的範圍。open_timestart_date 必須早於 close_timeend_dateclose_timeend_date 可以延長至指定 start_date 之後的當天凌晨 11:59。舉例來說,以下為有效的輸入內容:

start_date=2015-11-23, open_time=08:00, close_time=18:00
start_date=2015-11-23, end_date=2015-11-23, open_time=08:00,
close_time=18:00 start_date=2015-11-23, end_date=2015-11-24,
open_time=13:00, close_time=11:59

下列輸入內容無效:

start_date=2015-11-23, open_time=13:00, close_time=11:59
start_date=2015-11-23, end_date=2015-11-24, open_time=13:00,
close_time=12:00 start_date=2015-11-23, end_date=2015-11-25,
open_time=08:00, close_time=18:00
欄位
start_date

Date

必要欄位。這個特殊時段的起始日期。

open_time

TimeOfDay

選用設定。有效值為 00:00-24:00,其中 24:00 代表指定日期欄位結束的午夜。如果 closed 為 false,則必須指定。

end_date

Date

選用設定。這個特殊時段的結束日期。如未設定 end_date 欄位,請預設為 start_date 中指定的日期。如已設定,這個欄位必須等於或最多晚於 start_date後 1 天。

close_time

TimeOfDay

選用設定。有效值為 00:00-24:00,其中 24:00 代表指定日期欄位結束的午夜。如果 closed 為 false,則必須指定。

closed

bool

選用設定。如果設為 True,系統會忽略 end_dateopen_timeclose_time,且會將 start_date 中指定的日期視為整天沒有停業。

SpecialHours

代表一個地點的營業時間與正常營業時間不同的時間範圍。

欄位
special_hour_periods[]

SpecialHourPeriod

必要欄位。商家一般營業時間的例外狀況清單。

TimePeriod

代表商家營業的時間範圍,從指定的營業時間開始,到指定結束日/時間結束為止。打烊時間必須晚於開幕時間,例如當天稍晚或隨後幾天。

欄位
open_day

DayOfWeek

必要欄位。表示這個期間從開始當天起算的day of the week

open_time

TimeOfDay

必要欄位。有效值為 00:00-24:00,其中 24:00 代表指定日期欄位結束的午夜。

close_day

DayOfWeek

必要欄位。表示這個週期結束的day of the week

close_time

TimeOfDay

必要欄位。有效值為 00:00-24:00,其中 24:00 代表指定日期欄位結束的午夜。

UpdateAttributesRequest

AttributesService.UpdateAttributes 的要求。

欄位
attributes

Attributes

一組需要更新的屬性。

attribute_mask

FieldMask

必要欄位。您想更新的屬性屬性名稱。代表:attributes/{attribute}

更新:在屬性欄位中提供要更新的所有屬性,都必須在 attribute_mask 中設定。系統會忽略上方清單中設定但未在 attribute_mask 中設定的屬性。

刪除:如果您想刪除特定屬性,就必須在 attribute_mask 中指定這些屬性,但屬性清單中不會有相符的項目。如要刪除某地點設定的所有屬性,請務必查詢該地點的所有適用屬性,然後將這些屬性加入 attribute_mask 的空白屬性欄位。

UpdateLocationRequest

Locations.UpdateLocation 的要求訊息。

欄位
location

Location

必要欄位。更新的位置資訊。

update_mask

FieldMask

必要欄位。要更新的特定欄位。

validate_only

bool

選用設定。如果為 true,表示要求已在驗證,而不會實際更新位置。設定這個欄位後,我們只會傳回驗證錯誤 (如有)。如果找不到任何錯誤,回應中就不會有任何錯誤。

UriAttributeValue

網址 value_type 的屬性值。

欄位
uri

string

必要欄位。這項屬性的建議 URI 值。