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