Method: placeActionTypeMetadata.list

場所または国で利用可能なプレイス アクション タイプのリストを返します。

HTTP リクエスト

GET https://mybusinessplaceactions.googleapis.com/v1/placeActionTypeMetadata

この URL は gRPC Transcoding 構文を使用します。

クエリ パラメータ

パラメータ
languageCode

string

（省略可）表示名を取得する言語の IETF BCP-47 コード。この言語を利用できない場合は、英語で表示されます。
pageSize

integer

（省略可）1 ページあたりに含めるアクションの種類の数です。デフォルトは 10、最小値は 1 です。
pageToken

string

（省略可）指定すると、位置情報アクション タイプ メタデータの次のページが取得されます。placeActionTypeMetadata.list の呼び出しが、リクエストしたページサイズを上回る数の結果を返すと、pageToken が返されます。
filter

string

（省略可）メタデータを返す位置情報アクション タイプを制約するフィルタ。レスポンスには、フィルタに一致するエントリが含まれます。次のフィルタのみがサポートされています。1. location=XYZ。XYZ は locations/{locationId} の形式でビジネスのリソース名を示す文字列です。2. region_code=XYZ。XYZ は、使用可能なアクション タイプを検索するための Unicode CLDR リージョン コードです。

フィルタが指定されていない場合は、すべての位置情報アクション タイプが返されます。

リクエスト本文

リクエストの本文は空にする必要があります。

レスポンスの本文

PlaceActions.ListPlaceActionTypeMetadata に対するレスポンス メッセージです。

成功すると、レスポンスの本文に次の構造のデータが含まれます。

JSON 表現 
{
  "placeActionTypeMetadata": [
    {
      object (PlaceActionTypeMetadata)
    }
  ],
  "nextPageToken": string
}
フィールド
placeActionTypeMetadata[]

object (PlaceActionTypeMetadata)

利用可能な位置情報アクション タイプのメタデータのコレクション。
nextPageToken

string

アクション タイプの数がリクエストしたページサイズを超えた場合、このフィールドには、後続の placeActionTypeMetadata.list の呼び出しで次のページを取得するためのトークンが入力されます。取得する結果がそれ以上ない場合、このフィールドはレスポンスに含められません。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/business.manage

詳細については、OAuth 2.0 の概要をご覧ください。

PlaceActionTypeMetadata

サポートされている位置情報アクション タイプのメタデータ。

JSON 表現 
{
  "placeActionType": enum (PlaceActionType),
  "displayName": string
}
フィールド
placeActionType

enum (PlaceActionType)

位置情報アクションのタイプ。
displayName

string

この属性のローカライズされた表示名（利用可能な場合）。それ以外の場合は、英語の表示名。