Method: placeActionTypeMetadata.list

傳回某地區或國家/地區的可用地點動作類型清單。

HTTP 要求

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

這個網址使用 gRPC 轉碼語法。

查詢參數

參數
languageCode

string

選用設定。用來取得顯示名稱的 IETF BCP-47 語言代碼。如果無法使用這個語言,系統將以英文提供相關內容。

pageSize

integer

選用設定。每頁可加入的動作類型數量。預設值為 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

屬性的本地化顯示名稱 (如有);否則為英文顯示名稱。