Method: projects.locations.list

列出這項服務支援位置的相關資訊。

HTTP 要求

GET https://firestore.googleapis.com/v1/{name=projects/*}/locations

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

路徑參數

參數
name

string

擁有位置集合的資源 (如果適用)。

查詢參數

參數
filter

string

運用篩選器將結果範圍縮小至偏好的子集。篩選語言可接受 "displayName=tokyo" 等字串，詳情請參閱 AIP-160。
pageSize

integer

要傳回的結果數上限。如果未設定，服務會選取預設值。
pageToken

string

從回應中 nextPageToken 欄位收到的網頁權杖。傳送該網頁符記即可接收後續網頁。

要求主體

要求主體必須為空白。

回應主體

Locations.ListLocations 的回應訊息。

如果成功，回應主體會含有以下結構的資料：

JSON 表示法 
{
  "locations": [
    {
      object (Location)
    }
  ],
  "nextPageToken": string
}
欄位
locations[]

object (Location)

符合要求中指定篩選器的地點清單。
nextPageToken

string

標準清單下一頁符記。

授權範圍

需要下列其中一種 OAuth 範圍：

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

詳情請參閱驗證總覽一文。