列出指定帳戶的營業地點。
HTTP 要求
GET https://mybusinessbusinessinformation.googleapis.com/v1/{parent=accounts/*}/locations
這個網址使用 gRPC 轉碼語法。
路徑參數
參數 | |
---|---|
parent |
必要欄位。要擷取營業地點的帳戶名稱。如果上層 [帳戶] [google.mybusiness.accountmanagement.v1.Account] 為 [AccountType] [google.mybusiness.accountmanagement.v1.Account.AccountType] PERSONAL,系統就只會傳回帳戶直接擁有的地點,否則會傳回帳戶中的所有無障礙位置,無論是直接或間接傳回。 |
查詢參數
參數 | |
---|---|
pageSize |
選用設定。每頁要擷取的位置數量。如未設定,則預設值為 10。最少 1 個,頁面大小上限為 100 個。 |
pageToken |
選用設定。若指定,函式會擷取接下來 |
filter |
選用設定。篩選器會限制要傳回的地點。回應只會包含符合篩選條件的項目。如果 如要進一步瞭解有效的欄位和使用方式範例,請參閱使用位置資料指南。 |
orderBy |
選用設定。要求的排序順序。下列 SQL 語法應以半形逗號分隔多個欄位。預設的排序順序是遞增。如要指定遞減順序,請加入後置字元「 desc」。orderBy 的有效欄位為 title 和 storeCode。例如:「title, storeCode desc」、「title」或「storeCode desc」 |
readMask |
必要欄位。讀取遮罩,以指定要在回應中傳回哪些欄位。 此為以半形逗號分隔的完整欄位名稱清單。範例: |
要求主體
要求主體必須為空白。
回應主體
Locations.ListLocations 的回應訊息。
如果成功,回應主體即會包含具有以下結構的資料:
JSON 表示法 |
---|
{
"locations": [
{
object ( |
欄位 | |
---|---|
locations[] |
地點。 |
nextPageToken |
如果地點數量超過要求的頁面大小,系統會在這個欄位填入權杖,以便在後續呼叫 |
totalSize |
清單中位置的約略數量,與分頁無關。只有在使用 |
授權範圍
需要下列 OAuth 範圍:
https://www.googleapis.com/auth/business.manage
詳情請參閱 OAuth 2.0 總覽。