- 资源:Location
- JSON 表示法
- PhoneNumbers
- 类别
- 类别
- ServiceType
- MoreHoursType
- BusinessHours
- TimePeriod
- SpecialHours
- SpecialHourPeriod
- ServiceAreaBusiness
- BusinessType
- 地点
- PlaceInfo
- AdWordsLocationExtensions
- OpenInfo
- OpenForBusiness
- 元数据
- 商家资料
- RelationshipData
- RelevantLocation
- RelationType
- MoreHours
- ServiceItem
- StructuredServiceItem
- FreeFormServiceItem
- Label
- 方法
资源:Location
| JSON 表示法 |
|---|
{ "name": string, "languageCode": string, "storeCode": string, "title": string, "phoneNumbers": { object ( |
| 字段 | |
|---|---|
name |
标识符。此营业地点的 Google 标识符,格式为: |
languageCode |
不可变。营业地点所用的语言。在创建期间设置,无法更新。 |
storeCode |
可选。此营业地点的外部标识符,它在指定账号中必须是唯一的。这表明可将此营业地点与您自己的记录相关联。 |
title |
必需。营业地点名称应反映商家的实际名称,与实体店、网站和办公用品上使用的名称一致,并且是客户所熟知的名称。任何其他信息(如果相关)都可以包含在资源的其他字段中(例如 |
phoneNumbers |
可选。客户可用于与商家联系的不同电话号码。 |
categories |
可选。描述商家的不同类别。 |
storefrontAddress |
可选。用于描述您的营业地点的准确无误的地址。不接受位于偏远地区的邮政信箱地址或邮箱地址。目前,您最多可在地址中指定 5 个 |
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[] |
可选。除了主要电话号码以外,最多还可以填写 2 个商家联系电话号码(仅限手机或固话号码,不得使用传真号码)。 |
类别
描述商家的类别集合。在更新期间,必须同时设置这两个字段。禁止客户端使用更新掩码单独更新主要类别或附加类别。
| 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 |
必需。要在 Google Ads 附加地址信息中显示的备用电话号码(而非营业地点的主要电话号码)。 |
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。 该字段可在调用 Create 期间设置,但不能在调用 Update 期间设置。 |
duplicateLocation |
仅限输出。此营业地点重复的营业地点资源。 |
mapsUri |
仅限输出。指向 Google 地图上营业地点的链接。 |
newReviewUri |
仅限输出。指向 Google 搜索页面的链接,客户可以在该页面上为营业地点留下评价。 |
canHaveBusinessCalls |
仅限输出。指明商家信息是否符合商家来电条件。 |
hasVoiceOfMerchant |
仅限输出。指明商家信息是否具有商家发言权。如果此布尔值为 false,您应调用 locations.getVoiceOfMerchantState API,以获取有关他们没有商家发言权的原因的详细信息。 |
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 |
这表示两个营业地点之间的关系,它们共用一个实体区域、属于同一品牌/上级管理层/组织,但具有不同的关键属性,例如营业时间或电话号码。例如,Costco 药房是 Costco Wholesale 的一个部门。 |
INDEPENDENT_ESTABLISHMENT_IN |
这表示两个地点位于同一实际位置,但属于不同的公司(例如,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 语言代码。只能为每种语言设置一组标签。 |
方法 |
|
|---|---|
|
创建将由登录用户拥有的新营业地点。 |
|
列出指定账号的营业地点。 |