Package google.mybusiness.placeactions.v1

Chỉ mục

• PlaceActions (giao diện)
• CreatePlaceActionLinkRequest (thông báo)
• DeletePlaceActionLinkRequest (thông báo)
• ErrorCode (enum)
• GetPlaceActionLinkRequest (thông báo)
• ListPlaceActionLinksRequest (thông báo)
• ListPlaceActionLinksResponse (thông báo)
• ListPlaceActionTypeMetadataRequest (thông báo)
• ListPlaceActionTypeMetadataResponse (thông báo)
• PlaceActionLink (thông báo)
• PlaceActionLink.ProviderType (enum)
• PlaceActionType (enum)
• PlaceActionTypeMetadata (thông báo)
• UpdatePlaceActionLinkRequest (thông báo)

PlaceActions

API này cho phép quản lý các liên kết PlaceAction của địa điểm doanh nghiệp.

CreatePlaceActionLink

rpc CreatePlaceActionLink(CreatePlaceActionLinkRequest) returns (PlaceActionLink) Tạo đường liên kết hành động liên quan đến địa điểm được liên kết với vị trí đã chỉ định rồi trả về địa điểm đó. Yêu cầu này bị coi là trùng lặp nếu parent, place_action_link.uri và place_action_link.place_action_type giống với một yêu cầu trước đó. Phạm vi uỷ quyền Yêu cầu phạm vi OAuth sau: https://www.googleapis.com/auth/business.manage Để biết thêm thông tin, hãy xem Tổng quan về OAuth 2.0.

DeletePlaceActionLink
rpc DeletePlaceActionLink(DeletePlaceActionLinkRequest) returns (Empty) Xoá đường liên kết đến hành động liên quan đến địa điểm khỏi vị trí được chỉ định. Phạm vi uỷ quyền Yêu cầu phạm vi OAuth sau: https://www.googleapis.com/auth/business.manage Để biết thêm thông tin, hãy xem Tổng quan về OAuth 2.0.

GetPlaceActionLink
rpc GetPlaceActionLink(GetPlaceActionLinkRequest) returns (PlaceActionLink) Lấy đường liên kết đã chỉ định cho hành động liên quan đến địa điểm. Phạm vi uỷ quyền Yêu cầu phạm vi OAuth sau: https://www.googleapis.com/auth/business.manage Để biết thêm thông tin, hãy xem Tổng quan về OAuth 2.0.

ListPlaceActionLinks
rpc ListPlaceActionLinks(ListPlaceActionLinksRequest) returns (ListPlaceActionLinksResponse) Liệt kê các đường liên kết đến hành động liên quan đến địa điểm cho vị trí đã chỉ định. Phạm vi uỷ quyền Yêu cầu phạm vi OAuth sau: https://www.googleapis.com/auth/business.manage Để biết thêm thông tin, hãy xem Tổng quan về OAuth 2.0.

ListPlaceActionTypeMetadata
rpc ListPlaceActionTypeMetadata(ListPlaceActionTypeMetadataRequest) returns (ListPlaceActionTypeMetadataResponse) Trả về danh sách các loại hành động có sẵn liên quan đến địa điểm cho một vị trí hoặc quốc gia. Phạm vi uỷ quyền Yêu cầu phạm vi OAuth sau: https://www.googleapis.com/auth/business.manage Để biết thêm thông tin, hãy xem Tổng quan về OAuth 2.0.

UpdatePlaceActionLink
rpc UpdatePlaceActionLink(UpdatePlaceActionLinkRequest) returns (PlaceActionLink) Cập nhật và trả về đường liên kết đến hành động liên quan đến địa điểm đã chỉ định. Phạm vi uỷ quyền Yêu cầu phạm vi OAuth sau: https://www.googleapis.com/auth/business.manage Để biết thêm thông tin, hãy xem Tổng quan về OAuth 2.0.

CreatePlaceActionLinkRequest

Thông báo yêu cầu cho PlaceActions.CreatePlaceActionLink.

Các trường
parent	string Bắt buộc. Tên tài nguyên của vị trí nơi tạo đường liên kết đến hành động liên quan đến địa điểm này. locations/{location_id}.
place_action_link	PlaceActionLink Bắt buộc. Đường liên kết đến hành động liên quan đến địa điểm sẽ được tạo.

DeletePlaceActionLinkRequest

Thông báo yêu cầu cho PlaceActions.DeletePlaceActionLink.

Các trường
name	string Bắt buộc. Tên tài nguyên của đường liên kết đến hành động liên quan đến địa điểm cần loại bỏ khỏi vị trí.

ErrorCode

Mã lỗi cho các lỗi nội bộ.

Enum
ERROR_CODE_UNSPECIFIED	Mã lỗi không xác định.
UNVERIFIED_LOCATION	Vị trí chưa được xác minh.
INVALID_LOCATION_CATEGORY	Danh mục địa điểm không đủ điều kiện cho loại hành động liên quan đến địa điểm. Loại hành động tại địa điểm gây ra lỗi sẽ được trả về trong siêu dữ liệu, với chuỗi "place_action_type" làm khoá và chuỗi giá trị enum PlaceActionType là giá trị.
INVALID_URL	URL không đúng định dạng/không hợp lệ. URL hành động liên quan đến địa điểm không hợp lệ sẽ được trả về trong siêu dữ liệu, trong đó chuỗi "url" là khoá và giá trị là URL.
URL_PROVIDER_NOT_ALLOWED	URL này có nhà cung cấp không được phép. URL hành động liên quan đến địa điểm không được phép sẽ được trả về trong siêu dữ liệu, trong đó chuỗi "url" là khoá và giá trị là URL.
TOO_MANY_VALUES	Đã đặt quá nhiều giá trị cho loại hành động liên quan đến địa điểm. Loại đã đạt đến giới hạn sẽ được trả về trong siêu dữ liệu, với chuỗi "place_action_type" là khoá và chuỗi giá trị enum PlaceActionType là giá trị.
DELETED_LINK	Đường liên kết đến hành động liên quan đến địa điểm được yêu cầu đã bị xoá. URL tương ứng sẽ được trả về trong siêu dữ liệu, với chuỗi "url" là khoá và url là giá trị.
LINK_ALREADY_EXISTS	Đang yêu cầu cập nhật để chuyển đổi đường liên kết hành động liên quan đến địa điểm thành một đường liên kết đã tồn tại, với cùng URI và loại ở vị trí đã chỉ định.
SCALABLE_DEEP_LINK_INVALID_MULTIPLICITY	Miền chứa đường liên kết đã được sử dụng, và mỗi miền chỉ có một đường liên kết tối đa cho mỗi PlaceActionType.
LINK_DOES_NOT_EXIST	Một đường liên kết đã được chỉ định nhưng không thể tìm thấy trong cơ sở dữ liệu.

GetPlaceActionLinkRequest

Thông báo yêu cầu cho PlaceActions.GetPlaceActionLink.

Các trường
name	string Bắt buộc. Tên của đường liên kết đến hành động liên quan đến địa điểm mà bạn muốn tìm nạp.

ListPlaceActionLinksRequest

Thông báo về yêu cầu cho PlaceActions.ListPlaceActionLinks. Tính năng này sẽ liệt kê các đường liên kết hành động liên quan đến địa điểm cho một vị trí, không theo thứ tự cụ thể. Thao tác này có thể không trả về các đường liên kết được tạo gần đây (trong vòng 24 giờ qua) thông qua các nền tảng khác, chẳng hạn như trang web Google Doanh nghiệp của tôi. Mọi đường liên kết được tạo cách đây hơn 24 giờ sẽ xuất hiện thông qua API này.

Các trường
parent	string Bắt buộc. Tên của địa điểm có các đường liên kết đến hành động liên quan đến địa điểm sẽ được liệt kê. locations/{location_id}.
filter	string Không bắt buộc. Bộ lọc ràng buộc trả về các đường liên kết hành động liên quan đến địa điểm. Phản hồi bao gồm các mục khớp với bộ lọc. Chúng tôi chỉ hỗ trợ bộ lọc sau: 1. place_action_type=XYZ trong đó XYZ là PlaceActionType hợp lệ.
page_size	int32 Không bắt buộc. Số đường liên kết đến hành động liên quan đến địa điểm mà bạn muốn trả lại trên mỗi trang. Giá trị mặc định là 10. Tối thiểu là 1.
page_token	string Không bắt buộc. Nếu được chỉ định, trả về trang tiếp theo của các đường liên kết hành động liên quan đến địa điểm.

ListPlaceActionLinksResponse

Thông báo phản hồi cho PlaceActions.ListPlaceActionLinks.

Các trường
place_action_links[]	PlaceActionLink Danh sách trả về các đường liên kết đến hành động liên quan đến địa điểm.
next_page_token	string Nếu có nhiều đường liên kết hành động liên quan đến địa điểm hơn kích thước trang được yêu cầu, thì trường này sẽ được điền sẵn mã thông báo để tìm nạp trang kết quả tiếp theo.

ListPlaceActionTypeMetadataRequest

Thông báo về yêu cầu cho PlaceActions.ListPlaceActionTypeMetadata. Kết quả sẽ được trả về không theo thứ tự cụ thể.

Các trường
language_code	string Không bắt buộc. Mã ngôn ngữ BCP-47 của IETF để lấy tên hiển thị. Nếu không có ngôn ngữ này, họ sẽ được cung cấp bằng tiếng Anh.
page_size	int32 Không bắt buộc. Số loại hành động cần đưa vào trên mỗi trang. Giá trị mặc định là 10, tối thiểu là 1.
page_token	string Không bắt buộc. Nếu được chỉ định, trang tiếp theo của siêu dữ liệu loại hành động liên quan đến địa điểm sẽ được truy xuất. pageToken được trả về khi lệnh gọi đến placeActionTypeMetadata.list trả về nhiều kết quả hơn số lượng kết quả vừa với kích thước trang được yêu cầu.
filter	string Không bắt buộc. Bộ lọc ràng buộc các loại hành động liên quan đến địa điểm trả về siêu dữ liệu. Phản hồi bao gồm các mục khớp với bộ lọc. Chúng tôi chỉ hỗ trợ các bộ lọc sau: 1. location=XYZ trong đó XYZ là một chuỗi cho biết tên tài nguyên của một vị trí, ở định dạng locations/{location_id}. 2. Region_code=XYZ trong đó XYZ là mã vùng Unicode CLDR để tìm các loại hành động có sẵn. Nếu không có bộ lọc nào được cung cấp, tất cả các loại hành động liên quan đến địa điểm sẽ được trả về.

ListPlaceActionTypeMetadataResponse

Thông báo phản hồi cho PlaceActions.ListPlaceActionTypeMetadata.

Các trường
place_action_type_metadata[]	PlaceActionTypeMetadata Tập hợp siêu dữ liệu cho các loại hành động liên quan đến địa điểm có sẵn.
next_page_token	string Nếu số loại thao tác vượt quá kích thước trang được yêu cầu, thì trường này sẽ được điền sẵn mã thông báo để tìm nạp trang tiếp theo trong lệnh gọi đến placeActionTypeMetadata.list tiếp theo. Nếu không có kết quả nào khác, trường này sẽ không xuất hiện trong phản hồi.

PlaceActionLink

Đại diện cho một đường liên kết đến hành động liên quan đến địa điểm và các thuộc tính của đường liên kết đó.

Các trường
name	string Không bắt buộc. Tên tài nguyên, ở định dạng locations/{location_id}/placeActionLinks/{place_action_link_id}. Trường tên sẽ chỉ được xem xét trong các yêu cầu Cập nhật và xoá đường liên kết tương ứng của UpdatePlaceActionLink và DeletePlaceActionLink. Tuy nhiên, yêu cầu này sẽ bị bỏ qua trong yêu cầu CreatePlaceActionLink, trong đó place_action_link_id sẽ được máy chủ chỉ định khi tạo thành công đường liên kết mới và được trả về như một phần của phản hồi.
provider_type	ProviderType Chỉ có đầu ra. Chỉ định loại nhà cung cấp.
is_editable	bool Chỉ có đầu ra. Cho biết liệu khách có thể chỉnh sửa đường liên kết này hay không.
uri	string Bắt buộc. URI đường liên kết. Bạn có thể sử dụng lại cùng một URI cho nhiều loại hành động trên nhiều vị trí. Tuy nhiên, mỗi tổ hợp riêng biệt gồm (uri, loại hành động liên quan đến địa điểm, vị trí) chỉ được phép có một đường liên kết đến hành động liên quan đến địa điểm.
place_action_type	PlaceActionType Bắt buộc. Loại hành động liên quan đến địa điểm có thể thực hiện bằng đường liên kết này.
is_preferred	bool Không bắt buộc. Liệu đường liên kết này có được người bán ưu tiên hay không. Bạn chỉ có thể đánh dấu một đường liên kết là ưu tiên cho mỗi loại hành động liên quan đến địa điểm tại một vị trí. Nếu một yêu cầu trong tương lai đánh dấu một đường liên kết khác là được ưu tiên cho cùng loại hành động liên quan đến địa điểm, thì đường liên kết ưu tiên hiện tại (nếu có) sẽ mất lựa chọn ưu tiên.
create_time	Timestamp Chỉ có đầu ra. Thời điểm đường liên kết đến hành động liên quan đến địa điểm được tạo.
update_time	Timestamp Chỉ có đầu ra. Thời gian sửa đổi lần gần đây nhất đường liên kết đến hành động liên quan đến địa điểm.

ProviderType

Bạn chỉ có thể đọc loại nhà cung cấp đường liên kết.

Enum
PROVIDER_TYPE_UNSPECIFIED	Chưa xác định.
MERCHANT	Nhà cung cấp bên thứ nhất, chẳng hạn như người bán hoặc một công ty quảng cáo thay mặt cho người bán.
AGGREGATOR_3P	Đơn vị tập hợp của bên thứ ba, chẳng hạn như đối tác Reserve with Google.

PlaceActionType

Loại hành động liên quan đến địa điểm có thể thực hiện bằng cách sử dụng đường liên kết.

Enum
PLACE_ACTION_TYPE_UNSPECIFIED	Chưa xác định.
APPOINTMENT	Loại hành động là đặt cuộc hẹn.
ONLINE_APPOINTMENT	Loại hành động là đặt lịch hẹn trực tuyến.
DINING_RESERVATION	Loại hành động là đặt chỗ ăn uống.
FOOD_ORDERING	Loại hành động là đặt đồ ăn để giao hàng và/hoặc mua mang đi.
FOOD_DELIVERY	Loại hành động là đặt đồ ăn để giao hàng.
FOOD_TAKEOUT	Loại hành động là đặt đồ ăn mang đi.
SHOP_ONLINE	Loại hành động là mua sắm, có thể là giao hàng và/hoặc đến lấy hàng.

PlaceActionTypeMetadata

Siêu dữ liệu cho các loại hành động liên quan đến địa điểm được hỗ trợ.

Các trường
place_action_type	PlaceActionType Loại hành động liên quan đến địa điểm.
display_name	string Tên hiển thị đã bản địa hoá cho thuộc tính (nếu có); nếu không thì tên hiển thị bằng tiếng Anh.

UpdatePlaceActionLinkRequest

Thông báo yêu cầu cho PlaceActions.UpdatePlaceActionLink.

Các trường
place_action_link	PlaceActionLink Bắt buộc. Đường liên kết đã cập nhật cho hành động liên quan đến địa điểm.
update_mask	FieldMask Bắt buộc. Các trường cụ thể cần cập nhật. Các trường duy nhất có thể chỉnh sửa là uri, place_action_type và is_preferred. Nếu đường liên kết đã cập nhật đã tồn tại ở cùng một vị trí có cùng place_action_type và uri, thì lỗi ALREADY_EXISTS sẽ không thành công.