- 資源:Location
- JSON 表示法
- PhoneNumbers
- 類別
- 類別
- ServiceType
- MoreHoursType
- BusinessHours
- TimePeriod
- SpecialHours
- SpecialHourPeriod
- ServiceAreaBusiness
- BusinessType
- Places
- PlaceInfo
- AdWordsLocationExtensions
- OpenInfo
- OpenForBusiness
- 中繼資料
- 個人資料
- RelationshipData
- RelevantLocation
- RelationType
- MoreHours
- ServiceItem
- StructuredServiceItem
- FreeFormServiceItem
- 標籤
- 方法
資源:Location
| JSON 表示法 |
|---|
{ "name": string, "languageCode": string, "storeCode": string, "title": string, "phoneNumbers": { object ( |
| 欄位 | |
|---|---|
name |
ID。這個地點的 Google ID,格式為: |
languageCode |
不可變動。地點的語言。在建立時設定,無法更新。 |
storeCode |
(選用步驟) 這個地點的外部 ID,在指定帳戶中不得重複。這是將地點與您自己的記錄建立關聯的方式。 |
title |
必填。地點名稱應反映商家的實際名稱,與店面、網站和文具上使用的名稱一致,且為顧客所熟知。如有其他相關資訊,可加入資源的其他欄位 (例如 |
phoneNumbers |
(選用步驟) 顧客可與商家聯絡的不同電話號碼。 |
categories |
(選用步驟) 描述商家的不同類別。 |
storefrontAddress |
(選用步驟) 精確明白的地址,說明商家所在地點。我們不接受郵政信箱或位在偏遠地區的信箱地址。目前,您最多可以在地址中指定五個 |
websiteUri |
(選用步驟) 這個商家的網址。如果可以,請使用代表這個個別商家地點的網址,而非代表所有地點或品牌的通用網站/網址。 |
regularHours |
(選用步驟) 商家的營業時間。 |
specialHours |
(選用步驟) 商家的特殊營業時間。通常包括節慶營業時間,以及其他非正常營業時間。這些時間會覆寫正常營業時間。必須先設定一般營業時間,才能設定這個欄位。 |
serviceArea |
(選用步驟) 無店面區域商家會在顧客所在地提供服務。如果這個商家是無店面區域商家,這個欄位會說明商家的服務範圍。 |
labels[] |
(選用步驟) 一組任意形式的字串,可用來標記商家。這些標籤不會向使用者顯示,只有您看得到。每個標籤的長度必須介於 1 到 255 個字元之間。 |
adWordsLocationExtensions |
(選用步驟) AdWords 中顯示的其他資訊。 |
latlng |
(選用步驟) 使用者提供的經緯度。建立地點時,如果提供的地址成功進行地理編碼,系統會忽略這個欄位。只有在建立期間接受使用者提供的 |
openInfo |
(選用步驟) 指出地點目前是否營業中的標記。 |
metadata |
僅供輸出。其他使用者無法編輯的資訊。 |
profile |
(選用步驟) 用自己的話描述商家,並與使用者分享商家和產品/服務的獨特故事。 除了住宿類別 (例如飯店、汽車旅館、旅館) 以外,所有類別都必須填寫這個欄位。 |
relationshipData |
(選用步驟) 與這個地點相關的所有地點和連鎖店。 |
moreHours[] |
(選用步驟) 商家不同部門或特定顧客的詳細營業時間。 |
serviceItems[] |
(選用步驟) 商家支援的服務清單。服務可以是剪髮、安裝熱水器等。重複的服務項目會自動移除。 |
PhoneNumbers
商家電話號碼集合。更新時,必須設定這兩個欄位。用戶端不得使用更新遮罩,只更新主要或額外電話號碼。建議使用國際電話號碼格式,例如「+1 415 555 0132」,詳情請參閱 https://developers.google.com/style/phone-numbers#international-phone-numbers)。
| JSON 表示法 |
|---|
{ "primaryPhone": string, "additionalPhones": [ string ] } |
| 欄位 | |
|---|---|
primaryPhone |
必填。可直接聯絡個別商家地點的電話號碼。盡可能提供商家所在地點的當地電話號碼,而不是客服中心代表號。 |
additionalPhones[] |
(選用步驟) 除了主要電話號碼,最多可提供兩組商家電話號碼 (手機或市話,不得為傳真)。 |
類別
描述商家的類別集合。更新時,必須設定這兩個欄位。用戶端不得使用更新遮罩,個別更新主要或額外類別。
| JSON 表示法 |
|---|
{ "primaryCategory": { object ( |
| 欄位 | |
|---|---|
primaryCategory |
必填。最能描述這個地點核心業務的類別。 |
additionalCategories[] |
(選用步驟) 用來描述商家的其他類別。類別可協助顧客找到準確、具體的服務搜尋結果。為確保商家資訊正確且符合現況,請盡量使用最少的類別來說明整體核心業務。選擇類別時,請盡可能具體明確,但要能代表主要業務。 |
類別
描述商家性質 (而非業務內容) 的類別。如需有效類別 ID 清單,以及與人類可讀名稱的對應關係,請參閱 categories.list。
| JSON 表示法 |
|---|
{ "name": string, "displayName": string, "serviceTypes": [ { object ( |
| 欄位 | |
|---|---|
name |
必填。這個類別的穩定 ID (由 Google 提供)。修改類別 (建立或更新地點) 時,必須指定這個值。 |
displayName |
僅供輸出。人類可讀的類別名稱。讀取位置時會設定這個值。修改位置時,必須設定 |
serviceTypes[] |
僅供輸出。這個業務類別可用的所有服務類型清單。 |
moreHoursTypes[] |
僅供輸出。這個業務類別可用的其他營業時間類型。 |
ServiceType
說明商家提供的服務類型。
| JSON 表示法 |
|---|
{ "serviceTypeId": string, "displayName": string } |
| 欄位 | |
|---|---|
serviceTypeId |
僅供輸出。這個服務類型的穩定 ID (由 Google 提供)。 |
displayName |
僅供輸出。服務類型的顯示名稱,人類可讀。 |
MoreHoursType
商家除了常規營業時間外,還可提供更多營業時間類型。
| JSON 表示法 |
|---|
{ "hoursTypeId": string, "displayName": string, "localizedDisplayName": string } |
| 欄位 | |
|---|---|
hoursTypeId |
僅供輸出。Google 為這個營業時間類型提供的穩定 ID。 |
displayName |
僅供輸出。營業時間類型的英文顯示名稱,人類可讀。 |
localizedDisplayName |
僅供輸出。營業時間類型的在地化顯示名稱,人類可讀。 |
BusinessHours
代表這個地點的營業時間。包含 [TimePeriod][google.mybusiness.mybusinessinformation.v1.TimePeriod] 執行個體的集合。
| JSON 表示法 |
|---|
{
"periods": [
{
object ( |
| 欄位 | |
|---|---|
periods[] |
必填。這個地點的營業時間。每個時段代表一週內營業地點的營業時間範圍。 |
TimePeriod
代表商家營業時間範圍,從指定的營業日期/時間開始,到指定的營業日期/時間結束。結束時間必須晚於開始時間,例如當天稍晚或隔天。
| JSON 表示法 |
|---|
{ "openDay": enum ( |
| 欄位 | |
|---|---|
openDay |
必填。表示這個期間的開始 |
openTime |
必填。有效值為 00:00-24:00,其中 24:00 代表指定日期欄位結束時的午夜。注意:在 Proto3 JSON 對應中,系統會省略預設的零值 (00:00),並為 openTime 產生 |
closeDay |
必填。表示這個期間結束的 |
closeTime |
必填。有效值為 00:00-24:00,其中 24:00 代表指定日期欄位結束時的午夜。注意:在 Proto3 JSON 對應中,系統會省略預設零值 (00:00),並為 closeTime 產生 |
SpecialHours
代表一組時間範圍,此時地點的營業時間與正常營業時間不同。
| JSON 表示法 |
|---|
{
"specialHourPeriods": [
{
object ( |
| 欄位 | |
|---|---|
specialHourPeriods[] |
必填。商家正常營業時間的例外狀況清單。 |
SpecialHourPeriod
代表地點營業時間與正常營業時間不同的單一時間範圍。特殊營業時間範圍不得超過 24 小時。openTime 和 startDate 必須早於 closeTime 和 endDate。closeTime和endDate可延長至指定startDate隔天的上午 11:59。舉例來說,下列輸入內容有效:
startDate=2015-11-23, openTime=08:00, closeTime=18:00
startDate=2015-11-23, endDate=2015-11-23, openTime=08:00,
closeTime=18:00 startDate=2015-11-23, endDate=2015-11-24,
openTime=13:00, closeTime=11:59
下列輸入內容無效:
startDate=2015-11-23, openTime=13:00, closeTime=11:59
startDate=2015-11-23, endDate=2015-11-24, openTime=13:00,
closeTime=12:00 startDate=2015-11-23, endDate=2015-11-25,
openTime=08:00, closeTime=18:00
| JSON 表示法 |
|---|
{ "startDate": { object ( |
| 欄位 | |
|---|---|
startDate |
必填。特殊營業時間的開始日期。 |
openTime |
(選用步驟) 有效值為 00:00 至 24:00,其中 24:00 代表指定日期欄位結束時的午夜。如果 |
endDate |
(選用步驟) 特殊營業時間結束的日期。如未設定 |
closeTime |
(選用步驟) 有效值為 00:00-24:00,其中 24:00 代表指定日期欄位結束時的午夜。如果 |
closed |
(選用步驟) 如果設為 true,系統會忽略 |
ServiceAreaBusiness
無店面區域商家會在顧客所在地點提供服務 (例如鎖匠或水電工)。
| JSON 表示法 |
|---|
{ "businessType": enum ( |
| 欄位 | |
|---|---|
businessType |
必填。表示區域服務商家的 [類型] [google.mybusiness.businessinfo.v1.ServiceAreaBusiness.BusinessType]。 |
places |
(選用步驟) 這個商家服務的區域,由一組地點定義。 |
regionCode |
不可變動。這個區域服務商家所在國家/地區的 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,則位置更新必須包含欄位遮罩 storefrontAddress,並將欄位設為空白。 |
CUSTOMER_AND_BUSINESS_LOCATION |
在公司地址和周邊地區提供服務。 |
地點
定義一組地點所代表的區域聯集。
| JSON 表示法 |
|---|
{
"placeInfos": [
{
object ( |
| 欄位 | |
|---|---|
placeInfos[] |
(選用步驟) 地點 ID 代表的區域。最多 20 個地點。 |
PlaceInfo
定義地點 ID 代表的區域。
| JSON 表示法 |
|---|
{ "placeName": string, "placeId": string } |
| 欄位 | |
|---|---|
placeName |
必填。地點的本地化名稱。例如 |
placeId |
必填。地點 ID。必須對應至區域。(https://developers.google.com/places/web-service/supported_types#table3) |
AdWordsLocationExtensions
AdWords 中顯示的其他資訊。
| JSON 表示法 |
|---|
{ "adPhone": string } |
| 欄位 | |
|---|---|
adPhone |
必填。在 AdWords 地點額外資訊中顯示的備用電話號碼,而非地點的主要電話號碼。 |
OpenInfo
與商家營業狀態相關的資訊。
| JSON 表示法 |
|---|
{ "status": enum ( |
| 欄位 | |
|---|---|
status |
必填。指出地點目前是否營業中。根據預設,所有地點都會顯示為營業中,除非你將狀態更新為「已停業」。 |
canReopen |
僅供輸出。指出這個商家是否符合重新營業的資格。 |
openingDate |
(選用步驟) 地點首次營業的日期。如果不知道確切日期,可以只提供月份和年份。日期必須是過去或未來一年內。 |
OpenForBusiness
指出地點的狀態。
| 列舉 | |
|---|---|
OPEN_FOR_BUSINESS_UNSPECIFIED |
不指定。 |
OPEN |
表示營業地點營業中。 |
CLOSED_PERMANENTLY |
表示地點已永久歇業。 |
CLOSED_TEMPORARILY |
表示地點已暫停營業。 |
中繼資料
地點的其他資訊,使用者無法編輯。
| JSON 表示法 |
|---|
{ "hasGoogleUpdated": boolean, "hasPendingEdits": boolean, "canDelete": boolean, "canOperateLocalPost": boolean, "canModifyServiceList": boolean, "canHaveFoodMenus": boolean, "canOperateHealthData": boolean, "canOperateLodgingData": boolean, "placeId": string, "duplicateLocation": string, "mapsUri": string, "newReviewUri": string, "canHaveBusinessCalls": boolean, "hasVoiceOfMerchant": boolean, "isParticularlyPersonalPlace": boolean } |
| 欄位 | |
|---|---|
hasGoogleUpdated |
僅供輸出。指出與這個地點相關聯的地點 ID 是否有更新,需要由用戶端更新或拒絕。如果設定這個布林值,請呼叫 |
hasPendingEdits |
僅供輸出。指出這個地點是否有任何屬性處於待編輯狀態。 |
canDelete |
僅供輸出。指出是否可以使用 API 刪除位置。 |
canOperateLocalPost |
僅供輸出。已淘汰:這個欄位不會再填入資料,並將在日後推出的版本中移除。 |
canModifyServiceList |
僅供輸出。表示商家資訊是否可修改服務清單。 |
canHaveFoodMenus |
僅供輸出。指出商家資訊是否符合菜單資格。 |
canOperateHealthData |
僅供輸出。指出該位置是否可處理健康資料。 |
canOperateLodgingData |
僅供輸出。指出該地點是否可操作住宿資料。 |
placeId |
僅供輸出。如果這個地點顯示在 Google 地圖上,這個欄位會填入該地點的地點 ID。這個 ID 可用於多種 Places API。 這個欄位可在建立呼叫時設定,但無法在更新時設定。 |
duplicateLocation |
僅供輸出。與這個地點重複的地點資源。 |
mapsUri |
僅供輸出。Google 地圖上的地點連結。 |
newReviewUri |
僅供輸出。Google 搜尋頁面的連結,顧客可在該頁面為地點撰寫評論。 |
canHaveBusinessCalls |
僅供輸出。指出商家資訊是否符合商家通話資格。 |
hasVoiceOfMerchant |
僅供輸出。指出商家資訊是否包含「商家心聲」。如果這個布林值為 false,請呼叫 locations.getVoiceOfMerchantState API,瞭解商家沒有 Voice of Merchant 的原因。 |
isParticularlyPersonalPlace |
僅供輸出。指出地點是否歸類為隱私保密地點。這表示定位記錄功能會受到限制。如果認為這項處置有誤,請參閱說明中心文章。 |
個人資料
與地點設定檔相關的所有資訊。
| JSON 表示法 |
|---|
{ "description": string } |
| 欄位 | |
|---|---|
description |
必填。你對地點的描述,其他人無法編輯。 |
RelationshipData
與這個地點相關的所有上層和下層地點資訊。
| JSON 表示法 |
|---|
{ "parentLocation": { object ( |
| 欄位 | |
|---|---|
parentLocation |
(選用步驟) 與這個位置相關聯的上層位置。 |
childrenLocations[] |
(選用步驟) 與這個地點相關聯的子地點清單。 |
parentChain |
(選用步驟) 這個地點所屬連鎖店的資源名稱。[如何找出連鎖店 ID] [Locations.SearchChains] |
RelevantLocation
與目前地點相關的其他地點資訊。關係可以是 DEPARTMENT_OF 或 INDEPENDENT_ESTABLISHMENT_OF,這裡指定的位置可以是位置的任一端 (父項/子項)。
| JSON 表示法 |
|---|
{
"placeId": string,
"relationType": enum ( |
| 欄位 | |
|---|---|
placeId |
必填。使用地點 ID 指定關係另一端的地點。 |
relationType |
必填。關係類型。 |
RelationType
要指定的類型關係。
| 列舉 | |
|---|---|
RELATION_TYPE_UNSPECIFIED |
未指定類型。 |
DEPARTMENT_OF |
這代表 2 個地點之間的關係,這 2 個地點共用一個實體區域、相同品牌/高階管理/組織,但具有不同的重要屬性,例如營業時間或電話號碼。舉例來說,Costco Pharmacy 是 Costco Wholesale 的部門。 |
INDEPENDENT_ESTABLISHMENT_IN |
這代表 2 個地點位於同一實體位置,但屬於不同公司 (例如 Safeway 內的星巴克、購物中心內的商店)。 |
MoreHours
營業地點提供特定類型服務的時間範圍。
| JSON 表示法 |
|---|
{
"hoursTypeId": string,
"periods": [
{
object ( |
| 欄位 | |
|---|---|
hoursTypeId |
必填。營業時間類型。用戶端應呼叫 {#link businessCategories:BatchGet},取得營業地點類別支援的營業時間類型。 |
periods[] |
必填。這個地點的營業時間集合。每個時段代表一週內營業地點的營業時間範圍。 |
ServiceItem
描述單一服務項目的訊息。用於說明商家提供的服務類型。舉例來說,剪髮可以是一項服務。
| JSON 表示法 |
|---|
{ "price": { object ( |
| 欄位 | |
|---|---|
price |
(選用步驟) 代表服務項目的貨幣價格。建議您在加入價格時設定 currencyCode 和 units。這會視為服務項目的固定價格。 |
| 請務必設定下列其中一個欄位。以下是互斥欄位清單。回應中最多會設定下列其中一個欄位: | |
structuredServiceItem |
(選用步驟) 這個欄位會設定結構化服務資料。 |
freeFormServiceItem |
(選用步驟) 如果服務資料為任意形式,系統會設定這個欄位。 |
| 互斥欄位結束。 | |
StructuredServiceItem
代表商家提供的結構化服務。例如:toilet_installation。
| JSON 表示法 |
|---|
{ "serviceTypeId": string, "description": string } |
| 欄位 | |
|---|---|
serviceTypeId |
必填。 |
description |
(選用步驟) 結構化服務項目的說明。字元限制為 300 個。 |
FreeFormServiceItem
代表商家提供的任意形式服務。這些服務不會在結構化服務資料中公開。商家會使用 Geomerchant 介面,手動輸入這類服務的名稱。
| JSON 表示法 |
|---|
{
"category": string,
"label": {
object ( |
| 欄位 | |
|---|---|
category |
必填。這個欄位代表類別名稱 (即類別的固定 ID)。 |
label |
必填。項目的語言標記標籤。建議項目名稱不超過 140 個半形字元,說明不超過 250 個半形字元。只有在輸入內容為自訂服務項目時,才應設定這個欄位。請使用 serviceTypeId 更新標準化服務類型。 |
標籤
顯示價目表、部分或項目時使用的標籤。
| JSON 表示法 |
|---|
{ "displayName": string, "description": string, "languageCode": string } |
| 欄位 | |
|---|---|
displayName |
必填。價目表、專區或品項的顯示名稱。 |
description |
(選用步驟) 價目表、部分或項目的說明。 |
languageCode |
(選用步驟) 這些字串適用的 BCP-47 語言代碼。每種語言只能設定一組標籤。 |
方法 |
|
|---|---|
|
建立新的位置,由登入的使用者擁有。 |
|
列出指定帳戶的地點。 |