Package google.mybusiness.businessinformation.v1

索引

• AttributesService（界面）
• CategoriesService（界面）
• Chains（界面）
• GoogleLocations（界面）
• Locations（界面）
• AdWordsLocationExtensions（消息）
• Attribute（消息）
• AttributeMetadata（消息）
• AttributeMetadata.AttributeValueMetadata（消息）
• AttributeValueType（枚举）
• Attributes（消息）
• BatchGetCategoriesRequest（消息）
• BatchGetCategoriesResponse（消息）
• BusinessHours（消息）
• Categories（消息）
• Category（消息）
• CategoryView（枚举）
• Chain（消息）
• Chain.ChainName（消息）
• Chain.ChainUri（消息）
• CreateLocationRequest（消息）
• DeleteLocationRequest（消息）
• ErrorCode（枚举）
• GetAttributesRequest（消息）
• GetChainRequest（消息）
• GetGoogleUpdatedAttributesRequest（消息）
• GetGoogleUpdatedLocationRequest（消息）
• GetLocationRequest（消息）
• GoogleLocation（消息）
• GoogleUpdatedLocation（消息）
• Label（消息）
• ListAttributeMetadataRequest（消息）
• ListAttributeMetadataResponse（消息）
• ListCategoriesRequest（消息）
• ListCategoriesResponse（消息）
• ListLocationsRequest（消息）
• ListLocationsResponse（消息）
• Location（消息）
• Metadata（消息）
• MoreHours（消息）
• MoreHoursType（消息）
• OpenInfo（消息）
• OpenInfo.OpenForBusiness（枚举）
• PhoneNumbers（消息）
• PlaceInfo（消息）
• Places（消息）
• Profile（消息）
• RelationshipData（消息）
• RelevantLocation（消息）
• RelevantLocation.RelationType（枚举）
• RepeatedEnumAttributeValue（消息）
• SearchChainsRequest（消息）
• SearchChainsResponse（消息）
• SearchGoogleLocationsRequest（消息）
• SearchGoogleLocationsResponse（消息）
• ServiceAreaBusiness（消息）
• ServiceAreaBusiness.BusinessType（枚举）
• ServiceItem（消息）
• ServiceItem.FreeFormServiceItem（消息）
• ServiceItem.StructuredServiceItem（消息）
• ServiceType（消息）
• SpecialHourPeriod（消息）
• SpecialHours（消息）
• TimePeriod（消息）
• UpdateAttributesRequest（消息）
• UpdateLocationRequest（消息）
• UriAttributeValue（消息）

AttributesService

允许客户端查找和更新指定营业地点的属性。

GetAttributes
rpc GetAttributes(GetAttributesRequest) returns (Attributes) 查询为指定营业地点设置的所有属性。 授权范围 需要以下 OAuth 作用域： https://www.googleapis.com/auth/business.manage 有关详情，请参阅 OAuth 2.0 概览。

GetGoogleUpdatedAttributes
rpc GetGoogleUpdatedAttributes(GetGoogleUpdatedAttributesRequest) returns (Attributes) 获取指定营业地点的 Google 更新版本。 授权范围 需要以下 OAuth 作用域： https://www.googleapis.com/auth/business.manage 有关详情，请参阅 OAuth 2.0 概览。

ListAttributeMetadata
rpc ListAttributeMetadata(ListAttributeMetadataRequest) returns (ListAttributeMetadataResponse) 返回可用于指定主要类别和国家/地区的营业地点的属性列表。 授权范围 需要以下 OAuth 作用域： https://www.googleapis.com/auth/business.manage 有关详情，请参阅 OAuth 2.0 概览。

UpdateAttributes
rpc UpdateAttributes(UpdateAttributesRequest) returns (Attributes) 更新指定营业地点的属性。 授权范围 需要以下 OAuth 作用域： https://www.googleapis.com/auth/business.manage 有关详情，请参阅 OAuth 2.0 概览。

CategoriesService

此 API 可提供有关 Google 上支持的营业地点类别的信息。有关参考信息，请参阅本文的类别部分：https://support.google.com/business/answer/3038177

BatchGetCategories
rpc BatchGetCategories(BatchGetCategoriesRequest) returns (BatchGetCategoriesResponse) 返回使用指定语言和 GConcept ID 的业务类别列表。 授权范围 需要以下 OAuth 作用域： https://www.googleapis.com/auth/business.manage 有关详情，请参阅 OAuth 2.0 概览。

ListCategories
rpc ListCategories(ListCategoriesRequest) returns (ListCategoriesResponse) 返回业务类别列表。搜索时，系统会匹配类别名称，但不会匹配类别 ID。 搜索只会匹配类别名称的前面（也就是说，“食品”可能会返回“美食广场”，而不会返回“快餐店”）。 授权范围 需要以下 OAuth 作用域： https://www.googleapis.com/auth/business.manage 有关详情，请参阅 OAuth 2.0 概览。

链

用于查询连锁商家相关信息的服务。

GetChain
rpc GetChain(GetChainRequest) returns (Chain) 获取指定的链。如果该链不存在，则返回 NOT_FOUND。 授权范围 需要以下 OAuth 作用域： https://www.googleapis.com/auth/business.manage 有关详情，请参阅 OAuth 2.0 概览。

SearchChains
rpc SearchChains(SearchChainsRequest) returns (SearchChainsResponse) 根据链名称搜索链。 授权范围 需要以下 OAuth 作用域： https://www.googleapis.com/auth/business.manage 有关详情，请参阅 OAuth 2.0 概览。

GoogleLocations

此 API 允许访问和搜索 GoogleLocation。

SearchGoogleLocations
rpc SearchGoogleLocations(SearchGoogleLocationsRequest) returns (SearchGoogleLocationsResponse) 搜索与指定请求匹配的所有可能的位置。 授权范围 需要以下 OAuth 作用域： https://www.googleapis.com/auth/business.manage 有关详情，请参阅 OAuth 2.0 概览。

地点

借助此 API，您可以管理 Google 上的营业地点。

CreateLocation
rpc CreateLocation(CreateLocationRequest) returns (Location) 创建一个将归已登录用户所有的新营业地点。 授权范围 需要以下 OAuth 作用域： https://www.googleapis.com/auth/business.manage 有关详情，请参阅 OAuth 2.0 概览。

DeleteLocation
rpc DeleteLocation(DeleteLocationRequest) returns (Empty) 删除营业地点。 如果此营业地点无法使用 API 删除，且已在 google.mybusiness.businessinformation.v1.LocationState 中进行了标记，请使用 Google 商家资料网站。 授权范围 需要以下 OAuth 作用域： https://www.googleapis.com/auth/business.manage 有关详情，请参阅 OAuth 2.0 概览。

GetGoogleUpdatedLocation
rpc GetGoogleUpdatedLocation(GetGoogleUpdatedLocationRequest) returns (GoogleUpdatedLocation) 获取指定营业地点的 Google 更新版本。 授权范围 需要以下 OAuth 作用域： https://www.googleapis.com/auth/business.manage 有关详情，请参阅 OAuth 2.0 概览。

GetLocation
rpc GetLocation(GetLocationRequest) returns (Location) 返回指定的位置。 授权范围 需要以下 OAuth 作用域： https://www.googleapis.com/auth/business.manage 有关详情，请参阅 OAuth 2.0 概览。

ListLocations
rpc ListLocations(ListLocationsRequest) returns (ListLocationsResponse) 列出指定帐号的营业地点。 授权范围 需要以下 OAuth 作用域： https://www.googleapis.com/auth/business.manage 有关详情，请参阅 OAuth 2.0 概览。

UpdateLocation
rpc UpdateLocation(UpdateLocationRequest) returns (Location) 更新指定的营业地点。 授权范围 需要以下 OAuth 作用域： https://www.googleapis.com/auth/business.manage 有关详情，请参阅 OAuth 2.0 概览。

AdWordsLocationExtensions

AdWords 中显示的附加信息。

字段
ad_phone	string 必需。要在 AdWords 附加地址信息中显示的备用电话号码（而非营业地点的主要电话号码）。

属性

营业地点属性。属性提供有关营业地点的更多信息。可针对某个营业地点设置的属性因该营业地点的属性而异（例如类别）。可用属性由 Google 确定，并且可在不更改 API 的情况下添加和移除。

字段
name	string 必需。此属性的资源名称。
value_type	AttributeValueType 仅供输出。此属性包含的值的类型。此参数应用于确定如何解读值。
values[]	Value 此属性的值。提供的值类型必须与该属性的预期值类型一致。这是重复字段，其中可能会提供多个属性值。属性类型仅支持一个值。
repeated_enum_value	RepeatedEnumAttributeValue 当属性值类型为 REPEATED_ENUM 时，此字段包含属性值，其他值字段必须为空。
uri_values[]	UriAttributeValue 当属性值类型为“网址”时，此字段包含此属性的值，其他值字段必须为空。

AttributeMetadata

属性的元数据。包含属性的显示信息，其中包括本地化名称以及将相关属性组合在一起的标题。

字段
parent	string 属性的唯一标识符。
value_type	AttributeValueType 属性的值类型。设置和检索的值应为此类型的值。
display_name	string 属性的本地化显示名（如果有）；否则为英文显示名。
group_display_name	string 包含此属性的群组的本地化显示名（如果有）；否则，则为英语群组名称。相关属性会收集到一个组中，并且应一起显示在指定标题下。
repeatable	bool 如果为 true，此属性将支持多个值。如果为 false，应仅提供一个值。
value_metadata[]	AttributeValueMetadata 对于某些类型的属性（例如枚举），系统会提供一个列表，其中包含受支持的值以及这些值所对应的显示名。
deprecated	bool 如果为 true，说明此属性已弃用，不应再使用。如果已弃用，更新此属性不会导致错误，但系统不会保存相应更新。在弃用后的某个时刻，该属性将被完全移除，并且会导致错误。

AttributeValueMetadata

受支持的属性值的元数据。

字段
value	Value 属性值。
display_name	string 此值的显示名，应为本地化显示名（如果有）；否则，为英文显示名。值显示名称应该在与属性显示名称一起使用。 例如，对于“Wi-Fi”枚举属性，这可能包含“付费”以表示付费 Wi-Fi。

AttributeValueType

属性的值类型。

枚举
ATTRIBUTE_VALUE_TYPE_UNSPECIFIED	未指定。
BOOL	此属性的值是布尔值。
ENUM	该属性具有预定可用值列表。此属性的元数据将列出这些值。
URL	此属性的值是网址。
REPEATED_ENUM	属性值是一个包含多个可能值（可以明确设置或取消设置）的枚举。

属性

包含指定营业地点所有属性的容器。

字段
name	string 必需。此营业地点的 Google 标识符，格式为 locations/{location_id}/attributes。
attributes[]	Attribute 需要更新的属性集合。

BatchGetCategoriesRequest

BusinessCategories.BatchGetBusinessCategories 的请求消息。

字段
names[]	string 必需。必须至少设置一个名称。应返回本地化类别名称的 GConcept ID。若要返回多个类别的详情，请在请求中重复使用此参数。
language_code	string 必需。返回类别名称时应使用的 BCP 47 语言代码。
region_code	string 可选。用于推断非标准语言的 ISO 3166-1 alpha-2 国家/地区代码。
view	CategoryView 必需。指定响应中应返回的类别资源的哪些部分。

BatchGetCategoriesResponse

BusinessCategories.BatchGetBusinessCategories 的响应消息。

字段
categories[]	Category 与请求中提供的 GConcept ID 匹配的类别。它们在请求中的顺序与类别 ID 的顺序不同。

BusinessHours

表示此营业地点正常营业的时间段。保存一系列 [TimePeriod][google.mybusiness.mybusinessinformation.v1.TimePeriod] 实例。

字段
periods[]	TimePeriod 必需。此营业地点正常营业的时间段。每个时间段都表示营业地点在一周内正常营业的时段。

类别

用于描述商家的类别集合。在更新期间，必须同时设置这两个字段。客户端不得使用更新掩码单独更新主要类别或其他类别。

字段
primary_category	Category 必需。最能准确描述此营业地点涉及的核心业务的类别。
additional_categories[]	Category 可选。用于描述您的业务的其他类别。类别可帮助客户针对他们感兴趣的服务找到准确具体的结果。为确保您的商家信息准确有效，请务必使用尽可能少的类别来描述您的整体核心业务。选择尽可能具体并可代表您的主要业务的类别。

Category

用于描述商家性质（而非具体介绍商家的业务）的类别。如需查看有效类别 ID 的列表以及与其简单易懂的名称的对应关系，请参阅 categories.list。

字段
name	string 必需。此类别的稳定 ID（由 Google 提供）。修改类别（创建或更新营业地点）时必须指定此值。
display_name	string 仅供输出。直观易懂的类别名称。此字段在读取营业地点时设置。修改位置时，必须设置 category_id。
service_types[]	ServiceType 仅供输出。可用于此业务类别的所有服务类型的列表。
more_hours_types[]	MoreHoursType 仅供输出。适用于此业务类别的更多营业时间类型。

CategoryView

有助于限制服务器返回的数据量的枚举。

枚举
CATEGORY_VIEW_UNSPECIFIED	未指定，等同于 CATEGORY_METADATA_ONLY。
BASIC	服务器响应将仅包含“类别”字段 display_name、category_id 和 language_code。它会省略任何与服务类型元数据相关的字段。
FULL	返回响应中的所有字段。

链式

连锁店是指您的营业地点可以关联的品牌。

字段
name	string 必需。链的资源名称，格式为 chains/{chain_id}。
chain_names[]	ChainName 连锁店的名称。
websites[]	ChainUri 连锁店的网站。
location_count	int32 此连锁店中营业地点的数量。

ChainName

显示链时使用的名称。

字段
display_name	string 此连锁店的显示名称。
language_code	string 名称的语言 BCP 47 代码。

ChainUri

显示连锁店时使用的网址。

字段
uri	string 此链的 URI。

CreateLocationRequest

Locations.CreateLocation 的请求消息。

字段
parent	string 必需。要在其中创建此营业地点的帐号的名称。
location	Location 必需。新位置元数据。
validate_only	bool 可选。如果为 true，则验证请求，而不实际创建营业地点。
request_id	string 可选。服务器用于检测重复请求的唯一请求 ID。我们建议使用 UUID。长度上限为 50 个字符。

DeleteLocationRequest

Locations.DeleteLocation 的请求消息。

字段
name	string 必需。要删除的营业地点的名称。

ErrorCode

API 返回的所有错误代码。

枚举
ERROR_CODE_UNSPECIFIED	缺少错误代码。
INVALID_ATTRIBUTE_NAME	提供的某个属性无法应用于此营业地点。只有在 ListAttributeMetadata 响应中返回的属性才能应用于此营业地点。所有有问题的属性名称都将在元数据下的 attribute_names 键中返回。
ASSOCIATE_OPERATION_ON_VERIFIED_LOCATION	当客户端尝试关联营业地点或清除状态为已验证的营业地点的营业地点关联时，系统会返回此错误。
ASSOCIATE_LOCATION_INVALID_PLACE_ID	associateLocation 请求中提供的 place_id 与营业地点不匹配或无效。确保所设置的 place_id 与 SearchGoogleLocations 响应中返回的某个 ID 匹配。
LAT_LNG_UPDATES_NOT_PERMITTED	不允许此项目更新“Location”的纬度/经度字段。您可以使用界面中的图钉放置功能更新纬度/经度，也可以向我们提供一个地址。
PO_BOX_IN_ADDRESS_NOT_ALLOWED	地址中不能使用邮政信箱。元数据键包括“field_mask”。
BLOCKED_REGION	我们必须遵守相关的国际制裁，因此无法接受该地区的商家。元数据键包括“field_maks”。
MISSING_BOTH_PHONE_AND_WEBSITE	对于 CUSTOMER_LOCATION_ONLY 商家，您需要提供电话或网站。元数据键包括“field_mask”。
MISSING_STOREFRONT_ADDRESS_OR_SAB	所有营业地点都必须至少有一个店面地址或服务区域。元数据键包括“field_mask”。
LAT_LNG_TOO_FAR_FROM_ADDRESS	纬度/经度与地址对的间隔太远。元数据键包括“field_mask”。
LAT_LNG_REQUIRED	已弃用。替换为 PIN_DROP_REQUIRED。找不到指定的地址。请提供纬度/经度。元数据键包括“field_mask”。
INVALID_CHARACTERS	发现无效字符。元数据键包括“field_mask”和“invalid_characters”。
FORBIDDEN_WORDS	发现了禁用字词。元数据键包括“field_mask”和“forbidden_words”。
INVALID_INTERCHANGE_CHARACTERS	发现无效字符。元数据键包括“field_mask”。
FIELDS_REQUIRED_FOR_CATEGORY	对于此类营业地点，需要填写其他字段。元数据键包括“field_mask”、“value”和“fields_required”。
STOREFRONT_REQUIRED_FOR_CATEGORY	对于您的业务类别，必须提供客户可以访问的店面地址。元数据键包括“field_mask”。
ADDRESS_MISSING_REGION_CODE	地址缺少必需的 region_code。元数据键包括“field_mask”。
ADDRESS_EDIT_CHANGES_COUNTRY	无法将该地址移至其他国家/地区。元数据键包括“field_mask”。
SPECIAL_HOURS_SET_WITHOUT_REGULAR_HOURS	只有当营业地点具有正常营业时间时，才能指定特殊营业时间。元数据为空。
INVALID_TIME_SCHEDULE	时间安排无效、重叠或结束时间早于开始时间。元数据键包括“field_mask”。
INVALID_HOURS_VALUE	营业时间格式或值无效。元数据键包括“field_mask”。
OVERLAPPED_SPECIAL_HOURS	Special_hours 不能重叠。元数据键包括“field_mask”。
INCOMPATIBLE_MORE_HOURS_TYPE_FOR_CATEGORY	您的商家主要类别不支持此营业时间类型。元数据键包括“field_mask”和“incompatible_hours_type”。
DUPLICATE_CHILDREN_LOCATIONS	actions_data 中含有重复的 child_locations。元数据键包括“field_mask”。
INCOMPATIBLE_SERVICE_AREA_AND_CATEGORY	上门服务商家不得拥有所选的主要类别。元数据键包括“field_mask”。
INVALID_SERVICE_AREA_PLACE_ID	service_area 中的 place_id 无效。元数据键包括“field_mask”和“place_id”。
INVALID_AREA_TYPE_FOR_SERVICE_AREA	service_area 的区域类型无效。元数据键包括“field_mask”和“place_id”。
OPENING_DATE_TOO_FAR_IN_THE_FUTURE	开业日期必须在未来一年内。元数据键包括“field_mask”。
OPENING_DATE_MISSING_YEAR_OR_MONTH	开业日期必须指定年份或月份。元数据键包括“field_mask”。
OPENING_DATE_BEFORE_1AD	开业日期不得早于 1 个公元日期。元数据键包括“field_mask”。
TOO_MANY_ENTRIES	字段条目过多。元数据键包括“field_mask”和“max_count”。
INVALID_PHONE_NUMBER	系统无法识别输入的电话号码。元数据键包括“field_mask”和“value”。
INVALID_PHONE_NUMBER_FOR_REGION	电话号码在此地区无效。元数据键包括“field_mask”和“value”。
MISSING_PRIMARY_PHONE_NUMBER	缺少主要电话号码。元数据键包括“field_mask”。
THROTTLED	目前无法更新此字段。元数据键包括“field_mask”和“value”。
UNSUPPORTED_POINT_RADIUS_SERVICE_AREA	点半径服务区域已不再受支持。元数据键包括“field_mask”。
INVALID_CATEGORY	类别 ID 无效。元数据键包括“field_mask”和“value”。
CANNOT_REOPEN	商家无法重新标记为营业。元数据键包括“field_mask”。
INVALID_BUSINESS_OPENING_DATE	商家开业日期无效。元数据键包括“field_mask”。
INVALID_LATLNG	latlng 无效。元数据键包括“field_mask”。
PROFILE_DESCRIPTION_CONTAINS_URL	商家说明不应包含网址。元数据键包括“field_mask”。
LODGING_CANNOT_EDIT_PROFILE_DESCRIPTION	无法修改住宿地点的个人资料说明。元数据键包括“field_mask”。
INVALID_URL	链接无效。元数据键包括“field_mask”。
INVALID_ADDRESS	地址无效。元数据键包括“field_mask”。
PARENT_CHAIN_CANNOT_BE_THE_LOCATION_ITSELF	ParentChain 不能是营业地点本身。元数据键包括“field_mask”和“value”。
RELATION_CANNOT_BE_THE_LOCATION_ITSELF	关系不能是位置本身。元数据键包括“field_mask”和“value”。
MISSING_ADDRESS_COMPONENTS	地址组成部分缺少值。元数据键包括“field_mask”。
READ_ONLY_ADDRESS_COMPONENTS	无法修改只读地址组成部分。元数据键包括“field_mask”。
STRING_TOO_LONG	字符串过长。元数据键包括“field_mask”和“max_length”。
STRING_TOO_SHORT	字符串过短。元数据键包括“field_mask”和“min_length”。
REQUIRED_FIELD_MISSING_VALUE	必填字段缺少值。元数据键包括“field_mask”。
ATTRIBUTE_PROVIDER_URL_NOT_ALLOWED	无法添加或修改提供方的网址。元数据键包含“attribute_name”。
ATTRIBUTE_INVALID_ENUM_VALUE	枚举属性未知的值。元数据键包含“attribute_name”。
ATTRIBUTE_NOT_AVAILABLE	可缩放属性对此位置无效。元数据键包括“attribute_name”。
ATTRIBUTE_CANNOT_BE_REPEATED	只能指定一次可扩缩属性。元数据键包含“attribute_name”。
ATTRIBUTE_TYPE_NOT_COMPATIBLE_FOR_CATEGORY	可缩放属性与为营业地点设置的类别不兼容。元数据键包含“attribute_name”。
ADDRESS_REMOVAL_NOT_ALLOWED	您的商家不允许移除地址。元数据键包括“field_mask”。
AMBIGUOUS_TITLE	无法识别语言的最佳名称。元数据键包括“field_mask”。
INVALID_CATEGORY_FOR_SAB	纯 SAB 不能包含 gcid:constructment_poi 子类型的 gcid。元数据键包括“field_mask”和“value”。
RELATION_ENDPOINTS_TOO_FAR	关系端点彼此离得太远。元数据键包括“field_mask”和“value”。
INVALID_SERVICE_ITEM	既未设置 Structured_service_item，也未设置 free_form_service_item。元数据键包括“field_mask”。
SERVICE_ITEM_LABEL_NO_DISPLAY_NAME	标签缺少显示名称。元数据键包括“field_mask”。
SERVICE_ITEM_LABEL_DUPLICATE_DISPLAY_NAME	所有价格表中所有标签的显示名都不同。元数据键包括“field_mask”。
SERVICE_ITEM_LABEL_INVALID_UTF8	标签包含无效的 UTF-8 符号。元数据键包括“field_mask”。
FREE_FORM_SERVICE_ITEM_WITH_NO_CATEGORY_ID	free_form_service_item 中缺少 category_id 字段。元数据键包括“field_mask”。
FREE_FORM_SERVICE_ITEM_WITH_NO_LABEL	free_form_service_item 中缺少标签。元数据键包括“field_mask”。
SERVICE_ITEM_WITH_NO_SERVICE_TYPE_ID	enabled_service_item 中缺少 service_type_id 字段。元数据键包括“field_mask”。
INVALID_LANGUAGE	语言代码无效。元数据键包括“field_mask”。
PRICE_CURRENCY_MISSING	缺少 ISO 4217 货币代码。元数据键包括“field_mask”。
PRICE_CURRENCY_INVALID	提供的货币代码不是有效的 ISO 4217 代码。元数据键包括“field_mask”。
SERVICE_TYPE_ID_DUPLICATE	服务类型 ID 在该营业地点中不是唯一的。元数据键包括“field_mask”。
PIN_DROP_REQUIRED	找不到指定的地址。请使用界面提供一个定位点。元数据键包括“field_mask”。
STALE_DATA	Google 最近更新了一项或多项内容。目前只有此商家的所有者可以访问 business.google.com 对“field”中的数据进行更改。元数据键包括“field_mask”。
PHONE_NUMBER_EDITS_NOT_ALLOWED	此营业地点的电话号码字段已停用，无法修改。元数据键包括“field_mask”。
MULTIPLE_ORGANIZATIONALLY_PART_OF_RELATION	有多个关系可在两个位置之间建立逻辑关系（例如，终止、工作）。元数据键包括“field_mask”和“value”。

GetAttributesRequest

请求 AttributesService.GetAttributes。

字段
name	string 必需。此营业地点的 Google 标识符，格式为 locations/{location_id}/attributes。

GetChainRequest

Locations.GetChain 的请求消息。

字段
name	string 必需。链的资源名称，格式为 chains/{chain_place_id}。

GetGoogleUpdatedAttributesRequest

对 AttributesService.GetGoogleUpdatedAttributes 的请求。

字段
name	string 必需。此营业地点的 Google 标识符，格式为 locations/{location_id}/attributes。

GetGoogleUpdatedLocationRequest

Locations.GetGoogleUpdatedLocation 的请求消息。

字段
name	string 必需。要获取的营业地点的名称。
read_mask	FieldMask 必需。读取掩码以指定将在响应中返回的字段。

GetLocationRequest

Locations.GetLocation 的请求消息。

字段
name	string 必需。要获取的营业地点的名称。
read_mask	FieldMask 必需。读取掩码以指定将在响应中返回的字段。

GoogleLocation

表示 Google 上显示的 Location。此营业地点可能已被用户或其他人声明了所有权，也可能没有声明。

字段
name	string 此 GoogleLocation 的资源名称，格式为 googleLocations/{googleLocationId}。
location	Location 稀疏填充的 Location 信息。如果用户当前未声明此字段，则可在 CreateLocation 中重复使用该字段。
request_admin_rights_uri	string 用于将用户重定向到请求管理员权限界面的网址。仅当任何用户（包括当前用户）已声明营业地点的所有权时，此字段才会显示。

GoogleUpdatedLocation

表示由 Google 修改的营业地点。

字段
location	Location 此营业地点的 Google 更新版本。
diff_mask	FieldMask Google 更新的字段。
pending_mask	FieldMask 包含尚未推送到 Google 地图和 Google 搜索的待审核修改项的字段。

标签

显示价格列表、部分或商品时使用的标签。

字段
display_name	string 必需。价格列表、部分或商品的显示名。
description	string 可选。价格列表、部分或商品的说明。
language_code	string 可选。这些字符串所适用的 BCP-47 语言代码。只能为每种语言设置一组标签。

ListAttributeMetadataRequest

对 AttributesService.ListAttributeMetadata 的请求。

字段
parent	string 用于查找可用特性的营业地点的资源名称。如果已设置此字段，则 category_name、region_code、language_code 和 show_all 不是必需的，并且不得设置。
category_name	string 主要类别的稳定 ID，可用于查找可用属性。必须采用“categories/{category_id}”格式。
region_code	string ISO 3166-1 alpha-2 国家/地区代码，可用于查找可用属性。
language_code	string 用于获取属性显示名称的 BCP 47 语言代码。如果没有此语言，将以英语提供。
show_all	bool 当此字段设为 true 时，会返回所有可用属性的元数据，而不考虑父级字段和 category_name 字段。当 show_all 设为 true 时，必须提供 language_code 和 region_code。
page_size	int32 每页应包含的属性数量。默认值为 200，最小值为 1。
page_token	string 如果指定，则检索下一页属性元数据。

ListAttributeMetadataResponse

对 AttributesService.ListAttributeMetadata 的响应。

字段
attribute_metadata[]	AttributeMetadata 一组可用属性的属性元数据。
next_page_token	string 如果属性数量超过所请求的页面大小，系统会使用令牌填充此字段，以在后续调用 attributes.list 时获取下一页属性。如果没有其他属性，此字段将不会在响应中显示。

ListCategoriesRequest

BusinessCategories.ListCategories 的请求消息。

字段
region_code	string 必需。ISO 3166-1 alpha-2 国家/地区代码。
language_code	string 必需。BCP 47 语言代码。
filter	string 可选。过滤用户的字符串。唯一支持的字段是 displayName。例如：filter=displayName=foo。
page_size	int32 可选。每页可提取的类别数量。默认值为 100，最小值为 1，页面大小上限为 100。
page_token	string 可选。如果指定，则将获取下一页类别。
view	CategoryView 必需。指定响应中应返回的类别资源的哪些部分。

ListCategoriesResponse

BusinessCategories.ListCategories 的响应消息。

字段
categories[]	Category 基于所请求参数的匹配类别。
next_page_token	string 如果类别数量超过所请求的页面大小，系统会使用令牌填充此字段，以在后续调用 ListCategories 时获取下一页类别。

ListLocationsRequest

Locations.ListLocations 的请求消息。

字段
parent	string 必需。要从中提取营业地点的帐号的名称。如果父级 [帐号] [google.mybusiness.accountmanagement.v1.Account] 的类型为 [帐号类型] [google.mybusiness.accountmanagement.v1.Account.AccountType]，系统只会返回该帐号直接拥有的营业地点，否则将返回帐号中的所有可访问的营业地点（无论直接还是间接）。
page_size	int32 可选。每页可提取的营业地点数量。如果未设置，默认值为 10。最小值为 1，页面大小上限为 100。
page_token	string 可选。如果已指定，则会获取下一个 page 营业地点。当位置数量超出所请求的页面大小可容纳的数量时，之前对 ListLocations 的调用会返回页面令牌。
filter	string 可选。用于限制要返回的位置的过滤条件。响应仅包含与过滤条件匹配的条目。如果 filter 为空，系统会应用限制条件，并针对所请求帐号检索所有营业地点（分页）。 如需详细了解有效字段和用法示例，请参阅使用位置数据指南。
order_by	string 可选。请求的排序顺序。多个字段应以英文逗号分隔，并遵循 SQL 语法。默认排序顺序是升序。若要指定降序，应添加后缀“desc”。order_by 的有效字段是 title 和 store_code。例如：“title, store_code desc”或“title”或“store_code desc”
read_mask	FieldMask 必需。读取掩码以指定将在响应中返回的字段。

ListLocationsResponse

Locations.ListLocations 的响应消息。

字段
locations[]	Location 营业地点。
next_page_token	string 如果营业地点数量超过所请求的页面大小，系统会使用令牌填充此字段，以在后续调用 ListLocations 时获取下一页营业地点。如果没有其他营业地点，此字段不会出现在响应中。
total_size	int32 列表中营业地点的大致数量（与分页无关）。只有在将 filter 用作查询参数时，才会返回此字段。

位置

营业地点。如需详细了解这些字段，请参阅帮助中心文章；如需查看有效业务类别的列表，请参阅类别端点。

字段
name	string 此营业地点的 Google 标识符，格式为：locations/{location_id}。
language_code	string 不可变。营业地点的语言。在创建期间设置，且不可更新。
store_code	string 可选。此营业地点的外部标识符，它在指定帐号中必须是唯一的。这表明可将此营业地点与您自己的记录相关联。
title	string 必需。营业地点名称应真实反映商家的实际名称，与店面、网站和文具用品上的名称一致，为客户所知。您可以在资源的其他字段中添加任何其他相关信息（例如，Address、Categories）。请勿在名称中添加不必要的信息（例如，首选“Google”，而非“Google Inc. - Mountain View Corporate Headquarters”）。请勿添加营销宣传口号、商店代码、特殊字符、营业时间或已停业/营业状态、电话号码、网站网址、服务/产品信息、位置/地址或路线，或包含信息（例如“杜安里德大通银行的 ATM”）。
phone_numbers	PhoneNumbers 可选。供客户用来与商家联系的不同电话号码。
categories	Categories 可选。用于描述商家的不同类别。
storefront_address	PostalAddress 可选。用于描述您的营业地点的准确无误的地址。不接受位于偏远地区的邮政信箱地址或邮箱地址。目前，您最多可在地址中指定 5 个 address_lines 值。只能为拥有店面的商家设置此字段。不应为 CUSTOMER_LOCATION_ONLY 类型的地理位置设置此字段，但如果设置了此字段，系统将舍弃提供的所有值。
website_uri	string 可选。此商家的网址。如果可以，请使用能代表具体营业地点的网址，而不是能代表所有营业地点或品牌的通用网站/网址。
regular_hours	BusinessHours 可选。商家的营业时间。
special_hours	SpecialHours 可选。商家的特殊营业时间。通常包括节假日营业时间以及除正常营业时间之外的其他时间。这些时间会覆盖正常营业时间。如果没有正常营业时间，则无法设置此字段。
service_area	ServiceAreaBusiness 可选。上门服务商家在客户所在地提供服务。如果商家是上门服务商家，则此字段描述的是该商家提供服务的区域。
labels[]	string 可选。一组自由格式的字符串，可让您为自己的商家添加代码。这些标签不会面向用户，只有您自己可以看到。每个标签的长度必须介于 1 到 255 个字符之间。
ad_words_location_extensions	AdWordsLocationExtensions 可选。AdWords 中显示的附加信息。
latlng	LatLng 可选。用户提供的纬度和经度。创建营业地点时，如果成功对提供的地址进行地理编码，系统会忽略此字段。只有在创建期间接受了用户提供的 latlng 值，或通过 Google 商家资料网站更新了 latlng 值，系统才会针对 get 请求返回此字段。只有获得批准的客户才能更新此字段。
open_info	OpenInfo 可选。一个标记，指明营业地点当前是否正常营业。
metadata	Metadata 仅供输出。用户不可修改的其他信息。
profile	Profile 可选。利用极具个性色彩的语言描述您的商家，并与用户分享您的商家和服务的独特故事。 对于除住宿类别（如酒店、汽车旅馆、旅社）之外的所有类别，此字段均为必填字段。
relationship_data	RelationshipData 可选。与此商家相关的所有营业地点和连锁店。
more_hours[]	MoreHours 可选。为商家的不同部门或特定客户提供更多营业时间。
service_items[]	ServiceItem 可选。商家支持的服务列表。服务包括理发、安装热水器等。系统会自动移除重复的服务内容。

元数据

与营业地点相关且用户不可修改的其他信息。

字段
has_google_updated	bool 仅供输出。指明与此营业地点相关联的地点 ID 是否有需要更新或由客户端拒绝的更新。如果已设置此布尔值，您应调用 getGoogleUpdated 方法来查找需要验证的信息。
has_pending_edits	bool 仅供输出。指明此营业地点是否有任何属性处于“修改内容正在等待审核”状态。
can_delete	bool 仅供输出。指明是否可以使用 API 删除营业地点。
can_operate_local_post	bool 仅供输出。指明商家信息是否可以管理本地帖子。
can_modify_service_list	bool 仅供输出。指明商家信息是否可以修改服务列表。
can_have_food_menus	bool 仅供输出。指明商家信息是否可以显示食品菜单。
can_operate_health_data	bool 仅供输出。指明营业地点是否可以对健康数据执行操作。
can_operate_lodging_data	bool 仅供输出。指明营业地点是否可以根据住宿数据进行操作。
place_id	string 仅供输出。如果此营业地点显示在 Google 地图上，系统会使用此营业地点的地点 ID 填充此字段。此 ID 可用于各种 Places API。 该字段可在调用 Create 期间设置，但不能在调用 Update 期间设置。
duplicate_location	string 仅供输出。此营业地点重复的营业地点资源。
maps_uri	string 仅供输出。指向 Google 地图上营业地点的链接。
new_review_uri	string 仅供输出。指向 Google 搜索上可供客户对营业地点发表评价的页面的链接。
can_have_business_calls	bool 仅供输出。指明商家信息是否符合商家致电的条件。
has_voice_of_merchant	bool 仅供输出。指明商家信息是否包含商家意见。如果此布尔值为 false，您应该调用 locations.getVoiceOfMerchantState API 来详细了解为何他们没有商家语音信息。

MoreHours

针对特定类型的商家营业的时间段。

字段
hours_type_id	string 必需。营业时间类型。客户应调用 {#link businessCategories:BatchGet} 以获取其营业地点类别支持的营业时间类型。
periods[]	TimePeriod 必需。此营业地点正常营业的时间段。每个时间段都表示营业地点在一周内正常营业的时段。

MoreHoursType

除了正常营业时间之外，商家还可以提供的更多营业时间类型。

字段
hours_type_id	string 仅供输出。Google 针对该营业时间类型提供的稳定 ID。
display_name	string 仅供输出。时间类型的人类可读英文显示名。
localized_display_name	string 仅供输出。时间类型的直观易懂的本地化显示名。

OpenInfo

与商家营业状态相关的信息。

字段
status	OpenForBusiness 必需。指明营业地点目前是否正常营业。默认情况下，所有营业地点均正常营业，除非已更新为停业。
can_reopen	bool 仅供输出。指明此商家是否符合重新标记为营业的条件。
opening_date	Date 可选。营业地点初次营业的日期。如果不知道确切日期，可仅提供月份和年份。日期必须是过去的日期，或者是未来一年内的日期。

OpenForBusiness

指明营业地点的状态。

枚举
OPEN_FOR_BUSINESS_UNSPECIFIED	未指定。
OPEN	指明营业地点正常营业。
CLOSED_PERMANENTLY	指明营业地点已永久停业。
CLOSED_TEMPORARILY	指明营业地点已暂停营业。

PhoneNumbers

商家的电话号码集合。在更新期间，必须同时设置这两个字段。客户端不得使用更新掩码只更新主要电话号码或其他电话号码。最好使用国际电话号码格式（例如“[phone]”），如需了解详情，请参阅 (https://developers.google.com/style/phone-numbers#international-phone-numbers)。

字段
primary_phone	string 必需。具体营业地点的电话号码，最好是直拨电话。请尽可能使用本地电话号码，而不是呼叫中心热线服务热线号码。
additional_phones[]	string 可选。除了主要电话号码以外，最多还可以填写 2 个商家联系电话号码（仅限手机或固话号码，不得使用传真号码）。

PlaceInfo

定义由地点 ID 表示的区域。

字段
place_name	string 必需。地点的本地化名称。例如 Scottsdale, AZ。
place_id	string 必需。地点的 ID。必须对应一个区域。(https://developers.google.com/places/web-service/supported_types#table3)

地点

定义由一组地点表示的区域集合。

字段
place_infos[]	PlaceInfo 由地点 ID 表示的区域。最多可输入 20 个地点。

配置文件

与营业地点的商家资料有关的所有信息。

字段
description	string 必需。用您自己的声音描述的地点说明，其他人无法修改。

RelationshipData

与此营业地点相关的所有父级和子级营业地点的信息。

字段
parent_location	RelevantLocation 此营业地点与其存在关联的父级营业地点。
children_locations[]	RelevantLocation 与此位置相关联的子位置的列表。
parent_chain	string 此营业地点所属的连锁店的资源名称。[如何查找连锁店 ID] [Locations.SearchChains]

RelevantLocation

与当前营业地点相关的其他营业地点的信息。关系可以是 DEPARTMENT_OF 或 INDEPENDENT_ESTABLISHMENT_OF 中的任意一个，且此处指定的位置可以位于该位置的任意一侧（父/子）。

字段
place_id	string 必需。根据 placeID 指定位于关系另一侧的位置。
relation_type	RelationType 必需。关系的类型。

RelationType

要指定的类型关系。

枚举
RELATION_TYPE_UNSPECIFIED	未指定类型。
DEPARTMENT_OF	这表示两个营业地点之间的关系，这两个营业地点共用一个实体区域，品牌/高层管理人员/组织相同，但关键属性（例如营业时间或电话号码）不同。例如，“好市多药房”是“好市批发公司”的一个部门。
INDEPENDENT_ESTABLISHMENT_IN	这表明两个营业地点位于同一实际地点，但来自不同的公司（例如，位于安全威的星巴克，在购物中心内）。

RepeatedEnumAttributeValue

value_type 为 REPEATED_ENUM 的属性的值。包括两个值 ID 列表：已设置 (true) 和未设置 (false) 的值 ID。不存在的值会被视为未知。必须至少指定一个值。

字段
set_values[]	string 已设置的枚举值。
unset_values[]	string 未设置的枚举值。

SearchChainsRequest

Locations.SearchChains 的请求消息。

字段
chain_name	string 必需。按名称搜索连锁店。支持精确/部分/模糊/相关查询。示例："沃尔玛"、"沃尔玛"、"沃尔玛"、"沃尔玛"
page_size	int32 要从此查询返回的匹配链数上限。默认值为 10。可能的最大值为 500。

SearchChainsResponse

Locations.SearchChains 的响应消息。

字段
chains[]	Chain 与 SearchChainsRequest 中查询的 chain_display_name 匹配的链。如果没有匹配项，此字段将为空。结果按相关性顺序列出。

SearchGoogleLocationsRequest

GoogleLocations.SearchGoogleLocations 的请求消息。

字段
page_size	int32 要返回的匹配项数量。默认值为 3，最大值为 10。请注意，如果请求更多，延迟时间可能会增加。系统不支持分页。
联合字段 search_query。搜索查询。这可以作为 location 对象或字符串查询提供。search_query 只能是下列其中一项：
location	Location 要搜索的位置。如果提供，将查找与所提供的位置详情匹配的营业地点。
query	string 要搜索的文本查询。与提供确切位置相比，通过查询字符串提供的搜索结果准确性较低，但能够提供的不精确匹配。

SearchGoogleLocationsResponse

GoogleLocations.SearchGoogleLocations 的响应消息。

字段
google_locations[]	GoogleLocation 可能与指定请求匹配的 GoogleLocation 集合，按照准确率从高到低的顺序列出。

ServiceAreaBusiness

上门服务商家在客户所在地提供服务（例如锁匠或管道工）。

字段
business_type	BusinessType 必需。表示上门服务商家的 [类型] [google.mybusiness.businessinfo.v1.ServiceAreaBusiness.BusinessType]。
places	Places 此商家提供服务的区域由一组地点定义。
region_code	string 不可变。此服务区域商家所在国家/地区的 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，则营业地点更新必须包含字段掩码 storefront_address，并将该字段设置为空。
CUSTOMER_AND_BUSINESS_LOCATION	在商家地址和周边地区提供服务。

ServiceItem

描述单个服务项的消息。用于描述商家提供的服务类型。例如，理发可以是一项服务。

字段
price	Money 可选。表示服务项目的货币价格。我们建议您在添加价格时设置 currency_code 和 units。这将被视为相应服务项目的固定价格。
联合字段 service_item_info。请务必设置以下字段之一。service_item_info 只能是下列其中一项：
structured_service_item	StructuredServiceItem 可选。此字段将设置为结构化服务数据的大小写。
free_form_service_item	FreeFormServiceItem 可选。此字段将设置为自由格式服务数据的情形。

FreeFormServiceItem

表示商家提供的自由格式服务。这些服务不会作为我们的结构服务数据的一部分公开。商家可以通过地理商家界面手动输入此类服务的名称。

字段
category	string 必需。此字段表示类别名称（即类别的稳定 ID）。category 和 service_type_id 应与 Category 消息中提供的可能组合相匹配。
label	Label 必需。项的带语言标记的标签。我们建议商品名称不超过 140 个字符，说明不超过 250 个字符。仅当输入内容是自定义服务项目时，才应设置此字段。应通过 service_type_id 更新标准化服务类型。

StructuredServiceItem

表示商家提供的结构化服务。例如：toilet_installation。

字段
service_type_id	string 必需。service_type_id 字段是 Google 提供的唯一 ID，可在 ServiceType 中找到。此信息由 BatchGetCategories rpc 服务提供。
description	string 可选。结构化服务项的说明。字符数不能超过 300 个。

ServiceType

描述商家提供的服务类型的消息。

字段
service_type_id	string 仅供输出。此服务类型的稳定 ID（由 Google 提供）。
display_name	string 仅供输出。服务类型的直观易懂的显示名称。

SpecialHourPeriod

表示营业地点的营业时间与其正常营业时间不同的一个时间段。采用特殊营业时间的时长不得超过 24 小时。open_time 和 start_date 必须早于 close_time 和 end_date。close_time 和 end_date 可以推迟到指定 start_date 次日的上午 11:59。例如，以下输入有效：

start_date=2015-11-23, open_time=08:00, close_time=18:00
start_date=2015-11-23, end_date=2015-11-23, open_time=08:00,
close_time=18:00 start_date=2015-11-23, end_date=2015-11-24,
open_time=13:00, close_time=11:59

以下输入无效：

start_date=2015-11-23, open_time=13:00, close_time=11:59
start_date=2015-11-23, end_date=2015-11-24, open_time=13:00,
close_time=12:00 start_date=2015-11-23, end_date=2015-11-25,
open_time=08:00, close_time=18:00

字段
start_date	Date 必需。此特殊营业时间的日历日期。
open_time	TimeOfDay 可选。有效值为 00:00-24:00，其中 24:00 表示指定日期字段结束时的午夜。如果 closed 为 false，则必须指定。
end_date	Date 可选。此特殊营业时间结束的日历日期。如果未设置 end_date 字段，则默认为 start_date 中指定的日期。如果设置，此字段必须等于或最多为 start_date 之后 1 天。
close_time	TimeOfDay 可选。有效值为 00:00-24:00，其中 24:00 表示指定日期字段结束时的午夜。如果 closed 为 false，则必须指定。
closed	bool 可选。如果为 true，则忽略 end_date、open_time 和 close_time，并将 start_date 中指定的日期视为营业地点全天停业。

SpecialHours

表示营业地点的营业时间与其正常营业时间不同的一组时间段。

字段
special_hour_periods[]	SpecialHourPeriod 必需。商家正常营业时间的例外情况列表。

TimePeriod

表示商家正常营业的时间范围，从指定的开始营业日期/时间开始，到指定的结束营业日期/时间结束。结束营业时间必须在开始营业时间之后，例如当天晚些时候或次日。

字段
open_day	DayOfWeek 必需。表明此时间段开始时的 day of the week。
open_time	TimeOfDay 必需。有效值为 00:00-24:00，其中 24:00 表示指定日期字段结束时的午夜。
close_day	DayOfWeek 必需。表明此时间段结束时的 day of the week。
close_time	TimeOfDay 必需。有效值为 00:00-24:00，其中 24:00 表示指定日期字段结束时的午夜。

UpdateAttributesRequest

对 AttributesService.UpdateAttributes 的请求。

字段
attributes	Attributes 需要更新的属性集合。
attribute_mask	FieldMask 必需。您要更新的属性的属性名称。由 attributes/{attribute} 表示。 更新：您要更新的属性字段中提供的所有属性都必须在 attribute_mask 中设置。在上述列表中设置但未在 attribute_mask 中设置的属性将被忽略。 删除：如果您要删除某些属性，则必须在 attribute_mask 中指定这些属性，并且在属性列表中没有匹配的条目。如果您想要删除为某个营业地点设置的所有属性，则应查找该营业地点的所有适用属性，然后将这些属性添加到 attribute_mask，并将属性留空。

UpdateLocationRequest

Locations.UpdateLocation 的请求消息。

字段
location	Location 必需。更新后的营业地点信息。
update_mask	FieldMask 必需。要更新的特定字段。
validate_only	bool 可选。如果为 true，则验证请求，而不实际更新营业地点。设置此字段后，我们将仅返回验证错误（如果有）。如果未发现错误，响应将为空。

UriAttributeValue

value_type 为网址的属性的值。

字段
uri	string 必需。此属性的建议 URI 值。