Method: accounts.locations.list

列出指定帳戶的地點。

HTTP 要求

GET https://mybusinessbusinessinformation.googleapis.com/v1/{parent=accounts/*}/locations

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

路徑參數

參數
parent

string

必要欄位。要擷取位置的帳戶名稱。如果家長 [Account] [google.mybusiness.accountmanagement.v1.Account] 為 [AccountType] [google.mybusiness.accountmanagement.v1.Account.AccountType] (個人)，系統只會傳回「帳戶」直接擁有的位置，否則會傳回「帳戶」中所有的可存取位置 (直接或間接)。

查詢參數

參數
pageSize

integer

選用設定。每頁要擷取的位置數量。如未設定，則預設值為 10。數量下限為 1，頁面大小上限為 100。
pageToken

string

選用設定。如有指定，它會擷取下一個 page 位置。如果位置超過可要求的網頁大小，則先前對 locations.list 的呼叫會傳回網頁權杖。
filter

string

選用設定。篩選器會限制要傳回的地點。回應只會包含與篩選條件相符的項目。如果 filter 空白，系統會套用限制，並擷取要求帳戶的所有地點 (已分頁)。

如要進一步瞭解有效欄位和使用範例，請參閱使用位置資料指南。
orderBy

string

選用設定。要求的排序順序。如有多個欄位，應遵循 SQL 語法，並以半形逗號分隔。預設的排序順序是遞增。如要指定遞減順序，請在後方加上「說明。orderBy 的有效欄位為 title 和 storeCode。例如：「title, storeCode desc」或「title」或「storeCode desc」
readMask

string (FieldMask format)

必要欄位。讀取遮罩以指定要在回應中傳回的欄位。

這是以半形逗號分隔的完整欄位名稱清單。範例："user.displayName,photo"。

要求主體

要求主體必須為空白。

回應主體

Locations.ListLocations 的回應訊息。

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

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

object (Location)

營業地點。
nextPageToken

string

如果地點數量超過要求的頁面大小，這個欄位就會填入符記，以便在之後呼叫 locations.list 時擷取下一頁的地點。如果沒有更多地點，系統就不會在回應中顯示這個欄位。
totalSize

integer

清單中的約略位置數量 (無論分頁為何)。只有在 filter 做為查詢參數使用時，才會傳回此欄位。

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱 OAuth 2.0 總覽。