列出指定帳戶的營業地點。
HTTP 要求
GET https://mybusiness.googleapis.com/v4/{parent=accounts/*}/locations
這個網址使用 gRPC 轉碼語法。
路徑參數
參數 | |
---|---|
parent |
要擷取營業地點的帳戶名稱。如果 |
查詢參數
參數 | |
---|---|
pageSize |
每頁要擷取的位置數量。預設值為 100,下限為 1,頁面大小上限為 100。 |
pageToken |
若指定,函式會擷取接下來 |
filter |
篩選器會限制要傳回的地點。回應只會包含符合篩選條件的項目。如果 如要進一步瞭解有效的欄位和使用方式範例,請參閱使用位置資料指南。 |
languageCode |
要取得顯示位置資源的 BCP 47 語言。如果 Google 助理不支援該語言,系統將以當地語言提供。如果兩者皆無法使用,將會以英文提供。 已淘汰,2020 年 8 月 15 日過後,這個欄位將不再套用。而是一律使用地點的語言。 |
orderBy |
要求的排序順序。下列 SQL 語法應以半形逗號分隔多個欄位。預設的排序順序是遞增。如要指定遞減順序,請加入後置字元「 desc」。orderBy 的有效欄位為 locationName 和 storeCode。例如:「locationName, storeCode desc」、「locationName」或「storeCode desc」 |
要求主體
要求主體必須為空白。
回應主體
如果成功,回應主體即會包含具有以下結構的資料:
Locations.ListLocations 的回應訊息。
JSON 表示法 | |
---|---|
{
"locations": [
{
object ( |
欄位 | |
---|---|
locations[] |
地點。 |
nextPageToken |
如果地點數量超過要求的頁面大小,系統會在這個欄位填入權杖,以便在後續呼叫 |
totalSize |
清單中位置的約略數量,與分頁無關。 |
授權範圍
需要下列其中一種 OAuth 範圍:
https://www.googleapis.com/auth/plus.business.manage
https://www.googleapis.com/auth/business.manage
詳情請參閱 OAuth 2.0 總覽。