- בקשת HTTP
- פרמטרים של נתיב
- גוף הבקשה
- גוף התגובה
- היקפי הרשאות
- DrivingDirectionMetricsRequest
- NumDays
- LocationMetrics
- LocationDrivingDirectionMetrics
- TopDirectionSources
- RegionCount
הפונקציה מחזירה דוח שמכיל תובנות לגבי מדד אחד או יותר לפי מיקום.
בקשת HTTP
POST https://mybusiness.googleapis.com/v4/{name=accounts/*}/locations:reportInsights
כתובת ה-URL משתמשת בתחביר של Transcoding של 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
מספר הימים שבהם הבקשה הזו יכולה לתמוך.
טיפוסים בני מנייה (enum) | |
---|---|
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, לדוגמה, 'Europe/London') של המיקום. |
TopDirectionSources
האזורים המובילים שמהם הגיעו בקשות לקבלת מסלול נסיעה.
ייצוג ב-JSON | |
---|---|
{
"dayCount": integer,
"regionCounts": [
{
object ( |
שדות | |
---|---|
dayCount |
מספר הימים שבהם הנתונים נצברים. |
regionCounts[] |
אזורים שממוינים בסדר יורד לפי מספר. |
RegionCount
אזור עם מספר הבקשות המשויך אליו.
ייצוג JSON | |
---|---|
{
"latlng": {
object ( |
שדות | |
---|---|
latlng |
מרכז האזור. |
label |
תווית של האזור שקריאה לאנשים. |
count |
מספר הבקשות לקבלת מסלול נסיעה מהאזור הזה. |