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」、値は URL となります。
URL_PROVIDER_NOT_ALLOWED	URL に許可されていないプロバイダが含まれています。許可されていないプレイス アクションの URL がメタデータで返されます。キーには文字列「url」、値は URL となります。
TOO_MANY_VALUES	場所アクション タイプに設定されている値が多すぎます。上限に達したタイプがメタデータで返されます。キーには文字列「place_action_type」、値は PlaceActionType 列挙値の文字列となります。
DELETED_LINK	リクエストされた位置情報アクション リンクは削除されています。文字列「url」がキー、URL が値として、対応する URL がメタデータで返されます。
LINK_ALREADY_EXISTS	位置情報アクション リンクを、指定した場所と同じ URI とタイプを持つ既存のリンクに変換する更新をリクエストしています。
SCALABLE_DEEP_LINK_INVALID_MULTIPLICITY	リンクに含まれているドメインはすでに使用されています。リンクは、PlaceActionType ごとにドメインごとに 1 つに制限されています。
LINK_DOES_NOT_EXIST	データベースで見つからないリンクが指定されています。

GetPlaceActionLinkRequest

PlaceActions.GetPlaceActionLink に対するリクエスト メッセージです。

フィールド
name	string 必須。取得するプレイス アクション リンクの名前です。

ListPlaceActionLinksRequest

PlaceActions.ListPlaceActionLinks に対するリクエスト メッセージです。ビジネスの位置情報アクション リンクが、順不同で表示されます。この場合、他のサーフェス（Google マイビジネスのウェブサイトなど）を通じて最近（過去 24 時間以内に）作成されたリンクが返されないことがあります。24 時間以上前に作成されたリンクは、この API を通じて表示されます。

フィールド
parent	string 必須。位置情報アクションのリンクを一覧表示するビジネスの名前です。locations/{location_id}.
filter	string （省略可）返される位置情報アクション リンクを制限するフィルタ。レスポンスには、フィルタに一致するエントリが含まれます。次のフィルタのみがサポートされています: 1. place_action_type=XYZ（XYZ は有効な PlaceActionType です）。
page_size	int32 （省略可）1 ページあたりの位置情報アクション リンクの数。デフォルトは 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 （省略可）1 ページあたりに含めるアクションの種類の数です。デフォルトは 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、位置情報アクション タイプ、地域の組み合わせごとに 1 つのみです。
place_action_type	PlaceActionType 必須。このリンクを使用して実行できる位置情報アクションのタイプです。
is_preferred	bool （省略可）このリンクが販売者に好まれるかどうか。各ビジネス拠点の位置情報アクション タイプごとに優先リンクとして指定できるリンクは 1 つのみです。今後のリクエストで、同じ位置情報アクション タイプの別のリンクが優先としてマークされた場合は、現在の優先リンク（存在する場合）の設定が失われます。
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 エラーで失敗します。