Package google.mybusiness.placeactions.v1

索引

• PlaceActions（接口）
• CreatePlaceActionLinkRequest（消息）
• DeletePlaceActionLinkRequest（消息）
• ErrorCode（枚举）
• GetPlaceActionLinkRequest（消息）
• ListPlaceActionLinksRequest（消息）
• ListPlaceActionLinksResponse（消息）
• ListPlaceActionTypeMetadataRequest（消息）
• ListPlaceActionTypeMetadataResponse（消息）
• PlaceActionLink（消息）
• PlaceActionLink.ProviderType（枚举）
• PlaceActionType（枚举）
• PlaceActionTypeMetadata（消息）
• UpdatePlaceActionLinkRequest（消息）

PlaceActions

借助此 API，您可以管理营业地点的 PlaceAction 链接。

CreatePlaceActionLink
rpc CreatePlaceActionLink(CreatePlaceActionLinkRequest) returns (PlaceActionLink) 创建与指定营业地点相关联的地点操作链接，并将其返回。如果 parent、place_action_link.uri 和 place_action_link.place_action_type 与之前的请求相同，则该请求会被视为重复请求。 授权范围 需要以下 OAuth 作用域： https://www.googleapis.com/auth/business.manage 有关详情，请参阅 OAuth 2.0 概览。

DeletePlaceActionLink
rpc DeletePlaceActionLink(DeletePlaceActionLinkRequest) returns (Empty) 从指定位置删除地点操作链接。 授权范围 需要以下 OAuth 作用域： https://www.googleapis.com/auth/business.manage 有关详情，请参阅 OAuth 2.0 概览。

GetPlaceActionLink
rpc GetPlaceActionLink(GetPlaceActionLinkRequest) returns (PlaceActionLink) 获取指定的地点操作链接。 授权范围 需要以下 OAuth 作用域： https://www.googleapis.com/auth/business.manage 有关详情，请参阅 OAuth 2.0 概览。

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

ListPlaceActionTypeMetadata
rpc ListPlaceActionTypeMetadata(ListPlaceActionTypeMetadataRequest) returns (ListPlaceActionTypeMetadataResponse) 返回某个位置或国家/地区可用的地点操作类型的列表。 授权范围 需要以下 OAuth 作用域： https://www.googleapis.com/auth/business.manage 有关详情，请参阅 OAuth 2.0 概览。

UpdatePlaceActionLink
rpc UpdatePlaceActionLink(UpdatePlaceActionLinkRequest) returns (PlaceActionLink) 更新指定的地点操作链接，并将其返回。 授权范围 需要以下 OAuth 作用域： https://www.googleapis.com/auth/business.manage 有关详情，请参阅 OAuth 2.0 概览。

CreatePlaceActionLinkRequest

PlaceActions.CreatePlaceActionLink 的请求消息。

字段
parent	string 必需。要在其中创建此地点操作链接的营业地点的资源名称。locations/{location_id}.
place_action_link	PlaceActionLink 必需。要创建的地点操作链接。

DeletePlaceActionLinkRequest

PlaceActions.DeletePlaceActionLink 的请求消息。

字段
name	string 必需。要从营业地点中移除的地点操作链接的资源名称。

ErrorCode

内部故障的错误代码。

枚举
ERROR_CODE_UNSPECIFIED	未指定的错误代码。
UNVERIFIED_LOCATION	此营业地点未通过验证。
INVALID_LOCATION_CATEGORY	营业地点类别不符合地点操作类型的条件。系统将在元数据中返回导致错误的地点操作类型，其中字符串“place_action_type”作为键，“PlaceActionType”枚举值字符串作为值。
INVALID_URL	网址格式错误/无效。系统将在元数据中返回无效的地点操作网址，其中字符串“url”作为键，“url”作为值。
URL_PROVIDER_NOT_ALLOWED	网址包含不允许使用的提供方。系统将在元数据中返回禁止的地点操作网址，其中字符串“url”作为键，“url”作为值。
TOO_MANY_VALUES	为地点操作类型设置的值过多。达到限制的类型将在元数据中返回，其中字符串“place_action_type”作为键，“PlaceActionType”枚举值字符串作为值。
DELETED_LINK	请求的地点操作链接已删除。相应网址将在元数据中返回，其中字符串“url”作为键，“url”作为值。
LINK_ALREADY_EXISTS	正在请求更新，以将地点操作链接转换为在指定位置具有相同 URI 和类型的地点操作链接。
SCALABLE_DEEP_LINK_INVALID_MULTIPLICITY	链接中包含的网域已被使用，对于每个 PlaceActionType，每个网域只能有一个链接。
LINK_DOES_NOT_EXIST	指定一个链接，但在数据库中找不到该链接。

GetPlaceActionLinkRequest

PlaceActions.GetPlaceActionLink 的请求消息。

字段
name	string 必需。要获取的地点操作链接的名称。

ListPlaceActionLinksRequest

PlaceActions.ListPlaceActionLinks 的请求消息。此列表将列出某个营业地点的地点操作链接，没有特定顺序。可能无法返回最近（过去 24 小时内）通过其他平台（例如“Google 我的商家”网站）创建的链接。24 小时之前创建的任何链接都将通过此 API 显示。

字段
parent	string 必需。将列出其地点操作链接的营业地点的名称。locations/{location_id}.
filter	string 可选。用于限制要返回的地点操作链接的过滤条件。响应包含与过滤条件匹配的条目。我们仅支持以下过滤器：1. place_action_type=XYZ，其中 XYZ 是有效的 PlaceActionType。
page_size	int32 可选。每页返回的地点操作链接数量。默认值为 10。最小值为 1。
page_token	string 可选。如果指定，则返回下一页地点操作链接。

ListPlaceActionLinksResponse

PlaceActions.ListPlaceActionLinks 的响应消息。

字段
place_action_links[]	PlaceActionLink 返回的地点操作链接列表。
next_page_token	string 如果地点操作链接数量超过所请求的页面大小，系统会使用令牌填充此字段，以获取下一页结果。

ListPlaceActionTypeMetadataRequest

PlaceActions.ListPlaceActionTypeMetadata 的请求消息。返回的结果没有特定顺序。

字段
language_code	string 可选。要在其中获取显示名称的 IETF BCP-47 语言代码。如果没有此语言，将以英语提供。
page_size	int32 可选。每页包含的操作类型数量。默认值为 10，最小值为 1。
page_token	string 可选。如果指定，则检索下一页地点操作类型元数据。调用 placeActionTypeMetadata.list 返回的结果数超过所请求的页面大小可以容纳的数量时，系统会返回 pageToken。
filter	string 可选。用于限制要返回其元数据的地点操作类型的过滤条件。响应包含与过滤条件匹配的条目。我们仅支持以下过滤条件：1. location=XYZ，其中 XYZ 是一个字符串，表示营业地点的资源名称，格式为 locations/{location_id}。2. region_code=XYZ，其中 XYZ 是查找可用操作类型的 Unicode CLDR 区域代码。 如果未提供过滤条件，则返回所有地点操作类型。

ListPlaceActionTypeMetadataResponse

PlaceActions.ListPlaceActionTypeMetadata 的响应消息。

字段
place_action_type_metadata[]	PlaceActionTypeMetadata 可用地点操作类型的元数据集合。
next_page_token	string 如果操作类型的数量超过所请求的页面大小，系统会使用令牌填充此字段，以在后续调用 placeActionTypeMetadata.list 时获取下一页。如果没有更多结果，此字段将不会在响应中显示。

PlaceActionLink

表示地点操作链接及其属性。

字段
name	string 可选。资源名称，格式为 locations/{location_id}/placeActionLinks/{place_action_link_id}。 name 字段只会分别应用于更新和删除链接的 UpdatePlaceActionLink 和 DeletePlaceActionLink 请求。不过，它在 CreatePlaceActionLink 请求中会被忽略，其中 place_action_link_id 将在成功创建新链接后由服务器分配，并作为响应的一部分返回。
provider_type	ProviderType 仅供输出。指定提供程序类型。
is_editable	bool 仅供输出。指明客户是否可以修改此链接。
uri	string 必需。链接 URI。同一 URI 可重复用于不同位置的不同操作类型。但是，每个唯一的（uri、地点操作类型、位置）组合只能使用一个地点操作链接。
place_action_type	PlaceActionType 必需。可使用该链接执行的地点操作的类型。
is_preferred	bool 可选。商家是否首选此链接。在一个营业地点中，对于每种地点操作类型，只能将一个链接标记为首选链接。如果将来的请求将另一个链接标记为针对同一地点操作类型的首选链接，则当前首选链接（如果存在）将失去其偏好设置。
create_time	Timestamp 仅供输出。创建地点操作链接的时间。
update_time	Timestamp 仅供输出。上次修改地点操作链接的时间。

ProviderType

链接提供程序的类型，只能读取。

枚举
PROVIDER_TYPE_UNSPECIFIED	未指定。
MERCHANT	第一方提供商（例如商家）或代表商家的代理机构。
AGGREGATOR_3P	第三方集合商家，例如 Reserve with Google 合作伙伴。

PlaceActionType

可使用该链接执行的地点操作的类型。

枚举
PLACE_ACTION_TYPE_UNSPECIFIED	未指定。
APPOINTMENT	操作类型为预约。
ONLINE_APPOINTMENT	操作类型是预约在线预约。
DINING_RESERVATION	操作类型是预订餐厅。
FOOD_ORDERING	操作类型为订餐，可选择送餐上门和/或提供外卖。
FOOD_DELIVERY	操作类型为下送餐订单。
FOOD_TAKEOUT	操作类型为下外带订单。
SHOP_ONLINE	操作类型为购物，可以是送货和/或自提。

PlaceActionTypeMetadata

支持的地点操作类型的元数据。

字段
place_action_type	PlaceActionType 地点操作类型。
display_name	string 属性的本地化显示名（如果有）；否则为英文显示名。

UpdatePlaceActionLinkRequest

PlaceActions.UpdatePlaceActionLink 的请求消息。

字段
place_action_link	PlaceActionLink 必需。更新后的地点操作链接。
update_mask	FieldMask 必需。要更新的特定字段。仅有的可修改字段为 uri、place_action_type 和 is_preferred。如果更新后的关联已存在且具有相同 place_action_type 和 uri 的关联，则会失败并显示 ALREADY_EXISTS 错误。