- 资源:Location
- JSON 表示法
- BusinessHours
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- TimePeriod
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- DayOfWeek
- SpecialHours
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- SpecialHourPeriod
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- ServiceAreaBusiness
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- BusinessType
- PointRadius
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- LatLng
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- 地点
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- PlaceInfo
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- LocationKey
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- AdWordsLocationExtensions
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- OpenInfo
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- OpenForBusiness
- LocationState
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- 属性
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- RepeatedEnumAttributeValue
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- UrlAttributeValue
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- 元数据
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- 复制
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- 访问权限
- PriceList
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- 标签
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- 部分
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- SectionType
- 单品
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- 资金
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- 个人资料
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- RelationshipData
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- MoreHours
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- 方法
资源:Location
JSON 表示法 | |
---|---|
{ "name": string, "languageCode": string, "storeCode": string, "locationName": string, "primaryPhone": string, "additionalPhones": [ string ], "address": { object ( |
字段 | |
---|---|
name |
此营业地点的 Google 标识符,格式为: 在匹配的上下文中,此字段将不会被填充。 |
languageCode |
地理位置的语言。在创建过程中设置,不可更新。 |
storeCode |
此营业地点的外部标识符,它在指定账号中必须是唯一的。这表明可将此营业地点与您自己的记录相关联。 |
locationName |
营业地点名称应真实反映商家的实际名称,与店面、网站和文具用品上的名称一致并为客户所知。您可以在资源的其他字段中添加任何其他相关信息(例如 |
primaryPhone |
具体营业地点的电话号码,最好是直拨电话。请尽可能使用本地电话号码,而不是呼叫中心热线服务号码。 |
additionalPhones[] |
除了主要电话号码以外,最多还可以填写 2 个商家联系电话号码(仅限手机或固话号码,不得使用传真号码)。 |
address |
用于描述您的营业地点的准确无误的地址。不接受位于偏远地区的邮政信箱地址或邮箱地址。目前,您最多可以在地址中指定五个 |
primaryCategory |
最能准确描述此营业地点涉及的核心业务的类别。 |
additionalCategories[] |
用于描述您的业务的其他类别。类别可帮助客户针对他们感兴趣的服务找到准确具体的结果。为确保您的商家信息准确有效,请务必使用尽可能少的类别来描述您的整体核心业务。选择尽可能具体并可代表您的主要业务的类别。 |
websiteUrl |
此商家的网址。如果可以,请使用能代表具体营业地点的网址,而不是能代表所有营业地点或品牌的通用网站/网址。 |
regularHours |
商家的营业时间。 |
specialHours |
商家的特殊营业时间。通常包括节假日营业时间以及除正常营业时间之外的其他时间。这些设置会取代正常营业时间。 |
serviceArea |
上门服务商家在客户所在地提供服务。如果商家是上门服务商家,则此字段描述的是该商家提供服务的区域。 |
locationKey |
用于将此商家与其他 Google 产品和服务(例如 Google+ 信息页和 Google Maps Places)相关联的密钥的集合。 |
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 |
时间采用 ISO 8601 24 小时制扩展格式 (hh:mm)。有效值为 00:00-24:00,其中 24:00 表示指定日期字段结束时的午夜。 |
closeDay |
指示此时间段结束的 |
closeTime |
时间采用 ISO 8601 24 小时制扩展格式 (hh:mm)。有效值为 00:00-24:00,其中 24:00 表示指定日期字段结束时的午夜。 |
DayOfWeek
表示星期几。
枚举 | |
---|---|
DAY_OF_WEEK_UNSPECIFIED |
未指定星期几。 |
MONDAY |
星期一 |
TUESDAY |
星期二 |
WEDNESDAY |
星期三 |
THURSDAY |
星期四 |
FRIDAY |
星期五 |
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 地图上,系统会使用此营业地点的地点 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 列表:已设置的 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) 单位数。这个值必须在 -999999999(含)和 +999999999(含)之间。如果 |
个人资料
与营业地点的商家资料有关的所有信息。
JSON 表示法 | |
---|---|
{ "description": string } |
字段 | |
---|---|
description |
使用您自己的语音对地点的说明,其他任何人都无法修改。 |
RelationshipData
与此营业地点相关的所有父级营业地点和子级营业地点的信息。
JSON 表示法 | |
---|---|
{ "parentChain": string } |
字段 | |
---|---|
parentChain |
此营业地点所属连锁店的资源名称。 |
MoreHours
营业地点针对特定类型的商家营业的时间段。
JSON 表示法 | |
---|---|
{
"hoursTypeId": string,
"periods": [
{
object ( |
字段 | |
---|---|
hoursTypeId |
必需。营业时间类型。客户应调用 {#link businessCategories:BatchGet} 以获取其营业地点类别支持的营业时间类型。 |
periods[] |
必需。此营业地点正常营业的时间集合。每个时间段都表示营业地点在一周内正常营业的时段。 |
方法 |
|
---|---|
|
将营业地点与地点 ID 相关联。 |
|
获取指定账号中的所有指定营业地点。 |
|
返回所有指定营业地点的分页评价列表。 |
|
清除某个位置与其地点 ID 之间的关联。 |
|
创建归指定账号所有的新 location ,并将其返回。 |
|
删除营业地点。 |
|
报告某个营业地点使用特定语言的所有符合条件的验证选项。 |
|
查找与指定位置匹配的所有可能的位置。 |
|
获取指定的位置。 |
|
返回特定位置的食物菜单。 |
|
获取指定营业地点的 Google 更新版本。 |
|
返回特定位置的 Health 提供程序属性。 |
|
获取某个营业地点的指定服务列表。 |
|
列出指定账号的营业地点。 |
|
更新指定的营业地点。 |
|
返回按地理位置对一个或多个指标进行分析的报告。 |
(deprecated) |
将营业地点从用户拥有的账号中转移到同一用户管理的另一个账号。 |
|
更新特定营业地点的食物菜单。 |
|
更新特定位置的 Health 提供程序属性。 |
|
更新营业地点的指定服务列表。 |
|
为营业地点启动验证流程。 |