- בקשת 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
מספר הימים שבהם הבקשה הזו יכולה לתמוך.
טיפוסים בני מנייה (enum) | |
---|---|
SEVEN |
7 ימים. זהו ערך ברירת המחדל. |
THIRTY |
30 ימים. |
NINETY |
90 ימים. |
LocationMetrics
סדרת מדדים ו-BrakdownMetrics שמשויכים למיקום לאורך טווח זמן מסוים.
ייצוג 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 |
מספר הבקשות לקבלת מסלול נסיעה מהאזור הזה. |