- 資源:位置
- JSON 表示法
- BusinessHours
- TimePeriod
- DayOfWeek
- SpecialHours
- SpecialHourPeriod
- ServiceAreaBusiness
- BusinessType
- PointRadius
- LatLng
- 地點介面集
- PlaceInfo
- LocationKey
- AdWordsLocationExtensions
- OpenInfo
- OpenForBusiness
- LocationState
- 屬性
- RepeatedEnumAttributeValue
- UrlAttributeValue
- 中繼資料
- 複製
- 存取
- PriceList
- 標籤
- 區段
- SectionType
- 商品
- 金額
- 設定檔
- RelationshipData
- MoreHours
- 方法
資源:位置
JSON 表示法 | |
---|---|
{ "name": string, "languageCode": string, "storeCode": string, "locationName": string, "primaryPhone": string, "additionalPhones": [ string ], "address": { object ( |
欄位 | |
---|---|
name |
這個營業地點的 Google 識別碼,格式為: 比對內容時,這個欄位不會填入。 |
languageCode |
地點的語言。請在建立時設定,且無法更新。 |
storeCode |
這個位置的外部 ID,在特定帳戶中不得重複。這是指將該地點與您的記錄建立關聯的方式。 |
locationName |
地點名稱應反映商家的實際名稱,與店面、網站和文具上一致,也就是消費者所熟知的商家名稱。任何相關的額外資訊 (如有) 都可以加到資源的其他欄位 (例如 |
primaryPhone |
可以盡量直接聯絡到您個別商家所在地點的電話號碼。請提供本地電話號碼,避免使用總公司/客服中心聯絡電話。 |
additionalPhones[] |
除了主要電話號碼外,您的商家最多還可以登錄兩組電話號碼 (僅限手機或市話,不接受傳真號碼)。 |
address |
清楚精確的地址來說明您的商家所在地點。我們不接受郵政信箱或位於偏遠地區的信箱地址。目前您最多可以在地址中指定五個 |
primaryCategory |
這個類別與這個地點所處的核心業務最相符。 |
additionalCategories[] |
可描述貴商家的其他類別。類別可協助客戶正確地找到感興趣的服務。為確保商家資訊正確並上線,請盡量減少用來描述整體核心業務的類別。盡可能選用足以代表您主要業務的精確類別。 |
websiteUrl |
這個商家的網址。可以的話,請使用能代表這個商家所在地點的網址,而不是代表所有營業地點或品牌的通用網站/網址。 |
regularHours |
商家的營業時間。 |
specialHours |
商家的特殊營業時間。這通常包括假日營業時間,以及非正常營業時間的其他時間。這些值會覆寫一般營業時間。 |
serviceArea |
區域服務商家提供顧客所在地的服務。如果這個商家是區域服務商家,這個欄位會說明商家提供服務的區域。 |
locationKey |
可將這個商家連結到其他 Google 資源 (例如 Google+ 專頁和 Google 地圖地點) 的一組索引鍵。 |
labels[] |
一系列任意形式的字串,讓你標記你的商家。這些標籤「不會」向使用者顯示;只有你自己看得到。每個標籤最多 255 個字元。 |
adWordsLocationExtensions |
AdWords 中顯示的額外資訊。 |
latlng |
使用者提供的經緯度。建立位置時,如果提供的地址地理編碼成功,系統就會忽略這個欄位。只有在 get 請求中,使用者提供的 |
openInfo |
標明地點目前是否營業中。 |
locationState |
僅供輸出。一組布林值,反映位置狀態。 |
attributes[] |
這個位置的屬性。 |
metadata |
僅供輸出。其他使用者無法編輯的資訊。 |
priceLists[] |
已淘汰:這個位置的價格清單資訊。 |
profile |
以自己的方式說明貴商家,並向使用者顯示貴商家和產品/服務的獨特故事。 |
relationshipData |
與這個商家相關的所有地點和連鎖店。 |
moreHours[] |
為商家的不同部門或特定客戶提供更詳細的營業時間。 |
BusinessHours
代表這個地點營業的時段。存放 TimePeriod
個例項的集合。
JSON 表示法 | |
---|---|
{
"periods": [
{
object ( |
欄位 | |
---|---|
periods[] |
這個地點的營業時間集合。每個時段都代表地點在當週營業的時段。 |
TimePeriod
代表商家在指定營業日/時間開始,以及指定打烊日/時間結束營業的時間範圍。關閉時間必須晚於開幕時間,例如在同一天或後續一天。
JSON 表示法 | |
---|---|
{ "openDay": enum ( |
欄位 | |
---|---|
openDay |
表示這個經期開始的 |
openTime |
採用 24 小時 ISO 8601 擴充格式的時間 (hh:mm)。有效值為 00:00-24:00,其中 24:00 代表指定日期欄位結尾的午夜。 |
closeDay |
表示這段期間結束的 |
closeTime |
採用 24 小時 ISO 8601 擴充格式的時間 (hh:mm)。有效值為 00:00-24:00,其中 24:00 代表指定日期欄位結尾的午夜。 |
DayOfWeek
代表星期幾。
列舉 | |
---|---|
DAY_OF_WEEK_UNSPECIFIED |
未指定星期幾。 |
MONDAY |
星期一 |
TUESDAY |
週二 |
WEDNESDAY |
週三 |
THURSDAY |
週四 |
FRIDAY |
Friday (週五) |
SATURDAY |
Saturday (週六) |
SUNDAY |
星期日 |
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 |
地點開啟時的 |
endDate |
這個特殊營業時間結束的日期。如未設定 |
closeTime |
地點關閉時, |
isClosed |
如果設為 true,系統會忽略 |
ServiceAreaBusiness
區域服務商家在顧客的地點提供服務 (例如鎖匠或水電工)。
JSON 表示法 | |
---|---|
{ "businessType": enum ( |
欄位 | ||
---|---|---|
businessType |
用於表示服務範圍商家的 |
|
聯集欄位 coverageArea 。用於指出商家提供服務的涵蓋範圍。coverageArea 只能是下列其中一項: |
||
radius |
僅供輸出。這個商家的服務區域以某個點為中心。 |
|
places |
這個商家透過一組地點定義的服務區域。 |
BusinessType
指出這個商家是否只在客戶所在位置 (例如拖車) 提供現場服務,還是同時在地址和現場提供服務 (例如設有用餐區的披薩店,但提供外送服務給顧客)。
列舉 | |
---|---|
BUSINESS_TYPE_UNSPECIFIED |
僅供輸出。不指定。 |
CUSTOMER_LOCATION_ONLY |
只在附近區域提供服務 (不適用於商家地址)。 |
CUSTOMER_AND_BUSINESS_LOCATION |
提供商家地址和周邊區域的服務。 |
PointRadius
特定點 (緯度/經度) 周圍的半徑範圍。
JSON 表示法 | |
---|---|
{
"latlng": {
object ( |
欄位 | |
---|---|
latlng |
經緯度,用來指定半徑定義的區域中心。 |
radiusKm |
點周圍區域的距離 (以公里為單位)。 |
LatLng
代表經緯度組合的物件。以一對雙精準數表示經度度數和緯度度數。除非另有指定,否則這個物件必須符合 WGS84 標準。此外,值必須在正規化範圍內。
JSON 表示法 | |
---|---|
{ "latitude": number, "longitude": number } |
欄位 | |
---|---|
latitude |
緯度度數,必須介於 [-90.0, +90.0] 的範圍之間。 |
longitude |
經度度數,必須介於 [-180.0, +180.0] 的範圍之間。 |
地點
定義由一組地點所代表的區域聯集。
JSON 表示法 | |
---|---|
{
"placeInfos": [
{
object ( |
欄位 | |
---|---|
placeInfos[] |
地點 ID 代表的區域。最多不得超過 20 個地點。 |
PlaceInfo
定義以地點 ID 表示的區域。
JSON 表示法 | |
---|---|
{ "name": string, "placeId": string } |
欄位 | |
---|---|
name |
地點的本地化名稱。例如 |
placeId |
地點的 ID。必須對應於某個區域。 |
LocationKey
位置的替代/代理鍵參照。
JSON 表示法 | |
---|---|
{ "plusPageId": string, "placeId": string, "explicitNoPlaceId": boolean, "requestId": string } |
欄位 | |
---|---|
plusPageId |
僅供輸出。如果這個地點有相關聯的 Google+ 專頁,系統會填入這個地點的 Google+ 專頁 ID。 |
placeId |
如果這個地點已經驗證且與 Google 地圖連結/出現在 Google 地圖上,系統會在這個欄位填入地點的地點 ID。這個 ID 可用於不同的 Places API。 如果這個地點未經驗證,但該地點已與 Google 地圖上顯示的地點建立關聯,則這個欄位就會填入資料。 在建立呼叫期間可以設定此欄位,但不能針對「更新」設定。 額外的 |
explicitNoPlaceId |
僅供輸出。如果值為 true,表示未設定的地點 ID 是故意設定的地點 ID,與尚未建立任何關聯不同。 |
requestId |
僅供輸出。用來建立此位置的 |
AdWordsLocationExtensions
AdWords 中顯示的額外資訊。
JSON 表示法 | |
---|---|
{ "adPhone": string } |
欄位 | |
---|---|
adPhone |
要顯示在 AdWords 地點額外資訊中的備用電話號碼,而非商家的主要電話號碼。 |
OpenInfo
與商家開業狀態相關的資訊。
JSON 表示法 | |
---|---|
{ "status": enum ( |
欄位 | |
---|---|
status |
說明地點目前是否營業中。除非更新為已停業,否則所有地點都預設為營業中。 |
canReopen |
僅供輸出。表示這個商家是否可以恢復營業。 |
openingDate |
地點初次開幕的日期。如果不知道確切日期,則只能提供月份和年份。日期必須是過去的日期,或不超過未來一年的時間。 |
OpenForBusiness
指出地點的狀態。
列舉 | |
---|---|
OPEN_FOR_BUSINESS_UNSPECIFIED |
不指定。 |
OPEN |
表示該地點營業中。 |
CLOSED_PERMANENTLY |
表示該地點已永久停業。 |
CLOSED_TEMPORARILY |
表示該地點已暫停營業。這個值只能套用至已發布的地點 (即 locationState.is_published = true)。將狀態欄位更新為這個值時,用戶端必須明確將 updateMask 設為 openInfo.status 。在這次更新通話期間,無法設定其他更新遮罩。這項限制措施不久後就會放寬。 |
LocationState
包含一組能反映位置狀態的布林值。
JSON 表示法 | |
---|---|
{ "isGoogleUpdated": boolean, "isDuplicate": boolean, "isSuspended": boolean, "canUpdate": boolean, "canDelete": boolean, "isVerified": boolean, "needsReverification": boolean, "isPendingReview": boolean, "isDisabled": boolean, "isPublished": boolean, "isDisconnected": boolean, "isLocalPostApiDisabled": boolean, "canModifyServiceList": boolean, "canHaveFoodMenus": boolean, "hasPendingEdits": boolean, "hasPendingVerification": boolean, "canOperateHealthData": boolean, "canOperateLodgingData": boolean } |
欄位 | |
---|---|
isGoogleUpdated |
僅供輸出。指出與這個地點相關聯的地點 ID 是否有更新資訊。 |
isDuplicate |
僅供輸出。指出該地點是否與其他地點重複。 |
isSuspended |
僅供輸出。說明營業地點是否遭停權。Google 產品使用者不會看到遭停權的地點。如果你認為這是誤判,請參閱這篇說明中心文章。 |
canUpdate |
僅供輸出。指出是否可以更新營業地點。 |
canDelete |
僅供輸出。指出是否可以使用 Google My Business API 刪除營業地點。 |
isVerified |
僅供輸出。表示營業地點是否已通過驗證。 |
needsReverification |
僅供輸出。指出該地點是否需要重新驗證。 |
isPendingReview |
僅供輸出。指出營業地點是否仍待審查。 |
isDisabled |
僅供輸出。用於指出地點是否已停用。 |
isPublished |
僅供輸出。說明營業地點是否已發布。 |
isDisconnected |
僅供輸出。指出該地點是否與 Google 地圖上的地點中斷連線。 |
isLocalPostApiDisabled |
僅供輸出。指出這個位置是否已停用 accounts.locations.localPosts。 |
canModifyServiceList |
僅供輸出。指出清單項目是否可以修改 ServiceList。 |
canHaveFoodMenus |
僅供輸出。指出房源是否提供餐點菜單。 |
hasPendingEdits |
僅供輸出。指出這個地點的任一房源是否處於編輯待處理狀態。 |
hasPendingVerification |
僅供輸出。表示營業地點是否有待處理的驗證要求。 |
canOperateHealthData |
僅供輸出。指出位置能否使用健康資料。 |
canOperateLodgingData |
僅供輸出。指出營業地點是否能處理住宿資料。 |
屬性
地點屬性。屬性可以提供有關地點的額外資訊。某個地點可設定的屬性可能會因該地點的屬性 (例如類別) 而異。可用的屬性是由 Google 決定,可能會在不變更 API 的情況下新增和移除。
JSON 表示法 | |
---|---|
{ "attributeId": string, "valueType": enum ( |
欄位 | |
---|---|
attributeId |
屬性的 ID。屬性 ID 是由 Google 提供。 |
valueType |
僅供輸出。此屬性包含的值類型。這個欄位可用於判斷如何解讀值。 |
values[] |
這個屬性的值。提供的值類型必須與該屬性的預期相符;請參閱「AttributeValueType」。這個重複欄位可以提供多個屬性值。屬性類型僅支援一個值。 |
repeatedEnumValue |
當屬性值類型為 REPEATED_ENUM 時,這個值會包含屬性值,其他欄位則必須留空。 |
urlValues[] |
屬性值類型為網址時,這個欄位會包含這項屬性的值,其他欄位值則為空白。 |
RepeatedEnumAttributeValue
屬性的 valueType
為 REPEATED_ENUM 的值。其中包含兩份值 ID 清單:已設定 (true) 和未設定 (false) 的 ID。系統會將缺少的值視為不明。至少須指定一個值。
JSON 表示法 | |
---|---|
{ "setValues": [ string ], "unsetValues": [ string ] } |
欄位 | |
---|---|
setValues[] |
目前設定的列舉值。 |
unsetValues[] |
未設定的列舉值。 |
UrlAttributeValue
屬性值為 valueType
的屬性值。
JSON 表示法 | |
---|---|
{ "url": string } |
欄位 | |
---|---|
url |
網址。 |
中繼資料
其他非使用者無法編輯的營業地點資訊。
JSON 表示法 | |
---|---|
{
"duplicate": {
object ( |
欄位 | |
---|---|
duplicate |
這個地點重複的相關資訊。只有在 |
mapsUrl |
Google 地圖上地點的連結。 |
newReviewUrl |
Google 搜尋上的網頁連結,客戶可以在這裡留下該地點的評論。 |
複製
這個地點重複的相關資訊。
JSON 表示法 | |
---|---|
{
"locationName": string,
"placeId": string,
"access": enum ( |
欄位 | |
---|---|
locationName |
重複位置的資源名稱。只有在已驗證使用者擁有該位置的存取權,且該位置未刪除時,系統才會填入資訊。 |
placeId |
重複地點的地點 ID。 |
access |
指出使用者是否可存取重複的位置。 |
存取
使用者針對重複地點的存取層級。這會取代擁有權,因此應改用。
列舉 | |
---|---|
ACCESS_UNSPECIFIED |
不指定。 |
ACCESS_UNKNOWN |
無法判斷使用者是否可存取重複的位置。 |
ALLOWED |
使用者可以存取重複地點。 |
INSUFFICIENT |
使用者無法存取重複的位置。 |
PriceList
已淘汰:商品價格資訊清單。價目表結構為一或多份價目表,每個清單都含有一或多個專區,內含一或多個項目。舉例來說,食物價目表可能代表早餐/午餐/晚餐菜單,以及漢堡/牛排/海鮮專區。
JSON 表示法 | |
---|---|
{ "priceListId": string, "labels": [ { object ( |
欄位 | |
---|---|
priceListId |
必要欄位。價目表 ID。在這個地區內,不能複製價格清單、版面和項目 ID。 |
labels[] |
必要欄位。價格清單的語言標記標籤。 |
sourceUrl |
價格清單擷取來源的選填來源網址。例如系統自動擷取的網頁網址,以填入菜單資訊。 |
sections[] |
必要欄位。這份價格清單的專區。每份價目表必須包含至少一個版面。 |
標籤
顯示價格清單、專區或商品時使用的標籤。
JSON 表示法 | |
---|---|
{ "displayName": string, "description": string, "languageCode": string } |
欄位 | |
---|---|
displayName |
必要欄位。價格清單、專區或商品的顯示名稱。 |
description |
選用設定。價格清單、專區或商品的說明。 |
languageCode |
選用設定。這些字串適用的 BCP-47 語言代碼。每種語言只能設定一組標籤。 |
章節
價格清單的部分,其中包含一或多個商品。
JSON 表示法 | |
---|---|
{ "sectionId": string, "labels": [ { object ( |
欄位 | |
---|---|
sectionId |
必要欄位。區段 ID。在這個地區內,不得複製價格清單、版面和項目 ID。 |
labels[] |
必要欄位。這個區塊的語言標記標籤。建議不要超過 140 個字元。至少須提供一組標籤。 |
sectionType |
選用設定。目前價格清單部分的類型。預設值為 FOOD。 |
items[] |
價格清單的這個部分包含的商品。 |
SectionType
版面類型。
列舉 | |
---|---|
SECTION_TYPE_UNSPECIFIED |
不指定。 |
FOOD |
區段包含代表食物的項目。 |
SERVICES |
區段包含代表服務的項目。 |
項目
單一清單項目。定價清單中每項商品的所有子類都應該有專屬的價格資料。
JSON 表示法 | |
---|---|
{ "itemId": string, "labels": [ { object ( |
欄位 | |
---|---|
itemId |
必要欄位。商品的 ID。在這個地區內,不得複製價格清單、版面和項目 ID。 |
labels[] |
必要欄位。項目標籤。項目名稱建議不要超過 140 個半形字元,說明則不超過 250 個半形字元。至少須提供一組標籤。 |
price |
選用設定。商品的價格。 |
金額
代表金額與其貨幣類型。
JSON 表示法 | |
---|---|
{ "currencyCode": string, "units": string, "nanos": integer } |
欄位 | |
---|---|
currencyCode |
ISO 4217 定義的貨幣代碼 (由三個字母表示)。 |
units |
金額的整數單位。舉例來說,如果 |
nanos |
金額的十億分之一 (10^-9) 單位數量。這個值必須介於 -999,999,999 和 +999,999,999 (含) 之間。如果 |
個人資料
所有與營業地點商家檔案相關的資訊。
JSON 表示法 | |
---|---|
{ "description": string } |
欄位 | |
---|---|
description |
請說出地點的說明,其他人無法編輯。 |
RelationshipData
與這個物件相關的所有上層和兒童位置資訊。
JSON 表示法 | |
---|---|
{ "parentChain": string } |
欄位 | |
---|---|
parentChain |
這個位置所屬連鎖店的資源名稱。 |
MoreHours
商家在特定類型的商家中開放營業的時段。
JSON 表示法 | |
---|---|
{
"hoursTypeId": string,
"periods": [
{
object ( |
欄位 | |
---|---|
hoursTypeId |
必要欄位。營業時間類型。客戶應呼叫 {#link businessCategories:BatchGet},取得其營業地點類別的支援時段類型。 |
periods[] |
必要欄位。這個地點的營業時間集合。每個時段都代表地點在當週營業的時段。 |
方法 |
|
---|---|
|
將地點與地點 ID 建立關聯。 |
|
取得指定帳戶中的所有指定地點。 |
|
傳回所有指定地點的分頁評論清單。 |
|
清除地點與地點 ID 之間的關聯。 |
|
建立並傳回指定帳戶擁有的新 location 。 |
|
刪除位置。 |
|
回報某地點使用特定語言的所有合格驗證選項。 |
|
尋找符合指定位置的所有可能地點。 |
|
取得指定位置。 |
|
傳回特定地點的食物菜單。 |
|
取得指定位置的 Google 更新版本。 |
|
傳回特定地點的健康提供者屬性。 |
|
取得位置的指定服務清單。 |
|
列出指定帳戶的地點。 |
|
更新指定的位置。 |
|
傳回報表,內含按地區列出一或多個指標的洞察資料。 |
(deprecated) |
將營業地點從使用者擁有的帳戶移至同一使用者管理的另一個帳戶。 |
|
更新特定地點的食物菜單。 |
|
更新特定地點的健康提供者屬性。 |
|
更新地點的指定服務清單。 |
|
開始特定地點的驗證程序。 |