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_PROVIDER_NOT_ALLOWED	網址含有系統不允許的供應商。系統會在中繼資料中傳回不允許的地點動作網址，並以「url」字串做為鍵，並將網址設為值。
TOO_MANY_VALUES	地點動作類型的值過多。系統會在中繼資料中傳回達到限制的類型，並以「place_action_type」字串做為鍵，並以 PlaceActionType 列舉值字串做為值。
DELETED_LINK	要求的地點動作連結已刪除。系統會在中繼資料中傳回對應的網址，並以「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}。 只有在 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 錯誤。