Method: accounts.locations.list

列出指定帳戶的地點。

HTTP 要求

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

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

路徑參數

參數
parent

string

必填。要擷取地點的帳戶名稱。

  • 特定帳戶 ID：如果帳戶類型為 AccountType.PERSONAL，回應只會傳回該帳戶直接擁有的地點。如果是所有其他類型 (例如 AccountType.LOCATION_GROUP)，則會傳回所有可存取的位置。

  • 萬用字元 (-)：使用 accounts/- 可識別已驗證的使用者。這個範圍預設為 AccountType.PERSONAL，但包含直接和間接擁有的位置 (例如可透過成員群組存取的位置)。

查詢參數

參數
pageSize

integer

(選用步驟) 每頁要擷取的地點數量。如未設定，預設值為 10。最小值為 1，最大頁面大小為 100。
pageToken

string

(選用步驟) 如果指定，則會擷取下一組 page 個位置。如果地點數量超過要求的頁面大小，先前對 locations.list 的呼叫會傳回頁面權杖。
filter

string

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

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

string

(選用步驟) 要求的排列順序。如有多個欄位，請按照 SQL 語法以半形逗號分隔。預設排列順序為遞增。如要指定遞減排序，請加上「desc」後置字串。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 Overview。