- 資源:位置
- 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 ID,格式為: 比對內容時,這個欄位不會填入。 |
languageCode |
地點使用的語言。請在建立期間設定,且無法更新。 |
storeCode |
這個位置的外部 ID,在單一帳戶中不得重複。藉此將該地點與您自己的記錄建立關聯。 |
locationName |
位置名稱必須如實反映商家的實際名稱,且與店面、網站和文具一致,客戶所知的名稱必須一致。您可將相關資訊加入資源的其他欄位 (例如 |
primaryPhone |
盡量直接與個別商家地點聯絡的電話號碼。請提供本地電話號碼,避免使用客服中心的客服專線號碼。 |
additionalPhones[] |
除了主要電話號碼外,貴商家最多還可以登錄兩組電話號碼 (僅限手機或市話,不接受傳真)。 |
address |
請提供精確、精確的地址,用來說明您的商家所在地點。我們不接受位於偏遠地區的郵政信箱或信箱。目前,您最多可以在地址中指定五個 |
primaryCategory |
與這個地點所屬核心商家最相符的類別。 |
additionalCategories[] |
其他用來描述您商家的類別。類別可協助客戶準確找到感興趣的服務。為確保商家資訊正確且上線,請盡量減少描述整體核心業務的類別。盡可能選用足以代表您主要業務的精確類別。 |
websiteUrl |
此商家的網址。如果可以,請使用能代表這個個別商家所在地點的網址,而非代表所有地點或品牌的一般網站/網址。 |
regularHours |
商家的營業時間。 |
specialHours |
商家的特殊營業時間。通常包括假日營業時間及一般營業時間以外的其他時間。會覆寫一般營業時間。 |
serviceArea |
服務範圍商家在客戶的所在地提供服務。如果這個商家是區域服務商家,這個欄位會說明商家提供的區域。 |
locationKey |
可將這個商家連結到其他 Google 資源 (例如 Google+ 專頁和 Google 地圖地點) 的一組金鑰。 |
labels[] |
一組任意形式的字串,讓您可以標記商家。這些標籤「不會」向使用者顯示,只有您自己看得到。每個標籤的長度不得超過 255 個字元。 |
adWordsLocationExtensions |
AdWords 中顯示的額外資訊。 |
latlng |
使用者提供的經緯度。建立位置時,如果提供的地址地理編碼成功,系統就會忽略這個欄位。只有在建立期間接受使用者提供 |
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 |
星期五 |
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。必須與 region 對應。 |
LocationKey
位置的替代/代理鍵參照。
JSON 表示法 | |
---|---|
{ "plusPageId": string, "placeId": string, "explicitNoPlaceId": boolean, "requestId": string } |
欄位 | |
---|---|
plusPageId |
僅供輸出。如果這個地點有相關聯的 Google+ 專頁,系統就會填入這個地點的 Google+ 專頁 ID。 |
placeId |
如果這個地點已經通過驗證,且該位置已連結至 Google 地圖上/出現在 Google 地圖上,這個欄位就會填入該位置的地點 ID。這個 ID 可用於多種 Places API。 如果這個地點未經驗證,如果地點已與 Google 地圖上顯示的地點相關聯,這個欄位就會填入資料。 您可以在 Create 呼叫期間設定此欄位,但無法在 Update 中設定。 額外的 |
explicitNoPlaceId |
僅供輸出。如果值為 true,代表這是刻意設定的地點 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) 的值。缺少的值會視為不明。至少須指定一個值。
JSON 表示法 | |
---|---|
{ "setValues": [ string ], "unsetValues": [ string ] } |
欄位 | |
---|---|
setValues[] |
設定的列舉值。 |
unsetValues[] |
未設定的列舉值。 |
UrlAttributeValue
網址 valueType
的屬性值。
JSON 表示法 | |
---|---|
{ "url": string } |
欄位 | |
---|---|
url |
網址。 |
Metadata
地點的其他 (無法編輯)。
JSON 表示法 | |
---|---|
{
"duplicate": {
object ( |
欄位 | |
---|---|
duplicate |
與這個地點重複的地點相關資訊。只有在 |
mapsUrl |
地點在 Google 地圖上的連結。 |
newReviewUrl |
消費者在 Google 搜尋上對該地點留下評論的網頁連結。 |
Duplicate
與這個地點重複的地點相關資訊。
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) |
這類營業地點會從使用者擁有的帳戶中移動到同一個使用者管理的其他帳戶。 |
|
更新特定地點的菜單。 |
|
更新特定地點的健康提供者屬性。 |
|
更新地點的指定服務清單。 |
|
開始地點驗證程序。 |