- HTTP 要求
- 路徑參數
- 要求主體
- 回應主體
- 授權範圍
- DrivingDirectionMetricsRequest
- NumDays
- LocationMetrics
- LocationDrivingDirectionMetrics
- TopDirectionSources
- RegionCount
傳回報表,內含按地區列出一或多個指標的洞察資料。
HTTP 要求
POST https://mybusiness.googleapis.com/v4/{name=accounts/*}/locations:reportInsights
這個網址使用 gRPC 轉碼語法。
路徑參數
| 參數 | |
|---|---|
| name | 
 帳戶資源名稱。 | 
要求主體
要求主體的資料會採用以下結構:
| JSON 表示法 | |
|---|---|
| { "locationNames": [ string ], "basicRequest": { object ( | |
| 欄位 | |
|---|---|
| locationNames[] | 
 要擷取洞察資料的位置集合 (以名稱指定)。 | 
| basicRequest | 
 要求在報表中納入基本指標深入分析。 | 
| drivingDirectionsRequest | 
 要求將有關行車路線要求的洞察資料納入報表中。 | 
回應主體
如果成功,回應主體會含有以下結構的資料:
對「Insights.ReportLocationInsights」的回應訊息。
| JSON 表示法 | |
|---|---|
| { "locationMetrics": [ { object ( | |
| 欄位 | |
|---|---|
| locationMetrics[] | 
 按位置列出的指標值。 | 
| locationDrivingDirectionMetrics[] | 
 行車方向相關指標的集合值。 | 
授權範圍
需要下列其中一種 OAuth 範圍:
- https://www.googleapis.com/auth/plus.business.manage
- https://www.googleapis.com/auth/business.manage
詳情請參閱 OAuth 2.0 總覽。
DrivingDirectionMetricsRequest
要求取得行車路線深入分析資料。
| JSON 表示法 | |
|---|---|
| {
  "numDays": enum ( | |
| 欄位 | |
|---|---|
| numDays | 
 匯總資料的天數。系統會提供最近要求天數內的結果。有效值為 7、30 和 90。 | 
| languageCode | 
 語言的 BCP 47 代碼。如未提供語言代碼,則預設值為英文。 | 
NumDays
這項要求可提供支援的天數。
| 列舉 | |
|---|---|
| SEVEN | 7 天。這是預設值。 | 
| THIRTY | 30 天。 | 
| NINETY | 90 天。 | 
LocationMetrics
在特定時間範圍內,與地點相關聯的一系列指標和 BreakdownMetrics。
| JSON 表示法 | |
|---|---|
| {
  "locationName": string,
  "timeZone": string,
  "metricValues": [
    {
      object ( | |
| 欄位 | |
|---|---|
| locationName | 
 這些值所屬的位置資源名稱。 | 
| timeZone | 
 地點的 IANA 時區。 | 
| metricValues[] | 
 要求指標的值清單。 | 
LocationDrivingDirectionMetrics
一個位置已編入索引,而且使用者通常來自哪個區域。裝置會計算從各個地區傳送至這個位置的行車導航要求數,藉此擷取這些路線。
| JSON 表示法 | |
|---|---|
| {
  "locationName": string,
  "topDirectionSources": [
    {
      object ( | |
| 欄位 | |
|---|---|
| locationName | 
 這個指標值所屬的位置資源名稱。 | 
| topDirectionSources[] | 
 依來源區域顯示的行車路線要求。按照慣例,這兩個項目會按數量排序 (最多 10 筆結果)。 | 
| timeZone | 
 位置的時區 (IANA 時區 ID,例如「歐洲/倫敦」)。 | 
TopDirectionSources
產生行車路線要求的熱門區域。
| JSON 表示法 | |
|---|---|
| {
  "dayCount": integer,
  "regionCounts": [
    {
      object ( | |
| 欄位 | |
|---|---|
| dayCount | 
 匯總資料的天數。 | 
| regionCounts[] | 
 地區按照數量遞減排序。 | 
RegionCount
有相關要求數量的區域。
| JSON 表示法 | |
|---|---|
| {
  "latlng": {
    object ( | |
| 欄位 | |
|---|---|
| latlng | 
 區域中心。 | 
| label | 
 使用者可理解的區域標籤。 | 
| count | 
 來自這個區域的行車路線要求數量。 |