Method: locations.businesscallsinsights.list

מחזירה תובנות לגבי שיחות עסקיות עבור מיקום.

בקשת HTTP

GET https://mybusinessbusinesscalls.googleapis.com/v1/{parent=locations/*}/businesscallsinsights

בכתובת ה-URL נעשה שימוש בתחביר המרת gRPC.

פרמטרים של נתיב

פרמטרים
parent

string

חובה. המיקום הראשי שעבורו יש לאחזר תובנות לגבי שיחות. פורמט: locations/{locationId}

פרמטרים של שאילתה

פרמטרים
pageSize

integer

אפשרות. המספר המקסימלי של BusinessCallsInsights שניתן להחזיר. אם לא צוין, יוחזרו 20 לכל היותר. חלק מ-metric_types(למשל, AGGREGATE_COUNT) מחזירים דף אחד. מהמדדים האלה המערכת מתעלמת מה-pageSize.
pageToken

string

אפשרות. אסימון דף שהתקבל משיחה קודמת ב-businesscallsinsights.list. צריך לספק אותו כדי לאחזר את הדף הבא.

במהלך החלוקה לדפים, כל הפרמטרים האחרים שסיפקתם ל-businesscallsinsights.list חייבים להתאים לקריאה שסיפקה את אסימון הדף. חלק מ-metric_types (למשל AGGREGATE_COUNT) מחזירים דף אחד. מבחינת המדדים האלה, המערכת מתעלמת מ-pake_token.
filter

string

אפשרות. מסנן שמגביל את החזרה של התובנות לגבי שיחות. התשובה תכלול רק ערכים שתואמים למסנן.

אם לא הוזן MetricType, יוחזר AGGREGATE_COUNT. אם לא יסופק תאריך סיום, המערכת תשתמש בתאריך האחרון שלגביו יש נתונים זמינים. אם לא תספקו תאריך התחלה, ברירת המחדל תהיה התאריך הראשון שבו הנתונים זמינים (התאריך הנוכחי הוא 6 חודשים). אם תאריך ההתחלה חל לפני התאריך שבו הנתונים זמינים, הנתונים מוחזרים החל מהתאריך שבו הם זמינים.

בשלב זה אנחנו תומכים במסננים הבאים. 1. startDate="DATE" כאשר התאריך הוא בפורמט YYYY-MM-DD. 2. endDate="DATE" כאשר התאריך הוא בפורמט YYYY-MM-DD. 3. metricType=XYZ כאשר XYZ הוא MetricType חוקי. 4. חיבורים(AND) של כל התנאים שלמעלה. למשל, "startDate=2021-08-01 AND endDate=2021-08-10 AND metricType=AGGREGATE_COUNT" ה-AGGREGATE_COUNT metricType מתעלם מהחלק DD של התאריך.

גוף הבקשה

גוף הבקשה חייב להיות ריק.

גוף התגובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכלול נתונים במבנה הבא:

הודעת תגובה ל-businesscallsinsights.list.

ייצוג JSON 
{
  "businessCallsInsights": [
    {
      object (BusinessCallsInsights)
    }
  ],
  "nextPageToken": string
}
שדות
businessCallsInsights[]

object (BusinessCallsInsights)

אוסף של תובנות לגבי שיחות עסקיות עבור המיקום.
nextPageToken

string

אסימון שניתן לשלוח בתור pageToken לאחזור הדף הבא. אם השדה הזה יושמט, לא יופיעו דפים נוספים. חלק מ-metric_types (למשל AGGREGATE_COUNT) מחזירים דף אחד. במדדים האלה, ה-nextPageToken יהיה ריק.

היקפי הרשאות

נדרש היקף OAuth הבא:

  • https://www.googleapis.com/auth/business.manage

למידע נוסף, עיין בסקירה הכללית על OAuth 2.0.

BusinessCallsInsights

תובנות לגבי שיחות שבוצעו למיקום.

ייצוג JSON 
{
  "name": string,
  "metricType": enum (MetricType),
  "aggregateMetrics": {
    object (AggregateMetrics)
  }
}
שדות
name

string

חובה. שם המשאב של התובנות לגבי השיחות. פורמט: מיקומים/{location}/businesscallsinsights
metricType

enum (MetricType)

המדד שעליו חל הערך.
aggregateMetrics

object (AggregateMetrics)

מדד לטווח הזמן שמבוסס על startDate ו-endDate.

MetricType

סוג המדד.

טיפוסים בני מנייה (enums)
METRIC_TYPE_UNSPECIFIED לא צוין סוג המדד.
AGGREGATE_COUNT המדדים שצוינו הם ספירות נצברים לאורך זמן_טווח הקלט.

AggregateMetrics

מדדים נצברים לאורך טווח הזמן של הקלט.

ייצוג JSON 
{
  "missedCallsCount": integer,
  "answeredCallsCount": integer,
  "hourlyMetrics": [
    {
      object (HourlyMetrics)
    }
  ],
  "weekdayMetrics": [
    {
      object (WeekDayMetrics)
    }
  ],
  "startDate": {
    object (Date)
  },
  "endDate": {
    object (Date)
  }
}
שדות
missedCallsCount

integer

מספר כולל של שיחות שלא נענו.
answeredCallsCount

integer

המספר הכולל של שיחות שנענו.
hourlyMetrics[]

object (HourlyMetrics)

רשימת מדדים לפי השעה ביום.
weekdayMetrics[]

object (WeekDayMetrics)

רשימת מדדים לפי יום בשבוע.
startDate

object (Date)

התאריך של המדד הזה. אם המדד הוא חודשי, המערכת תשתמש רק בשנה ובחודש.
endDate

object (Date)

תאריך הסיום של המדד הזה.

HourlyMetrics

מדדים לשעה.

ייצוג JSON 
{
  "hour": integer,
  "missedCallsCount": integer
}
שדות
hour

integer

שעה ביום. הערכים המותרים הם 0-23.
missedCallsCount

integer

סך כל השיחות שלא נענו בשעה הזו.

WeekDayMetrics

מדדים ליום בשבוע.

ייצוג JSON 
{
  "day": enum (DayOfWeek),
  "missedCallsCount": integer
}
שדות
day

enum (DayOfWeek)

היום בשבוע. הערכים המותרים הם ראשון עד שבת.
missedCallsCount

integer

סך כל השיחות שלא נענו בשעה הזו.

DayOfWeek

מייצג את היום בשבוע.

טיפוסים בני מנייה (enums)
DAY_OF_WEEK_UNSPECIFIED היום בשבוע לא צוין.
MONDAY יום שני
TUESDAY שלישי
WEDNESDAY רביעי
THURSDAY יום חמישי
FRIDAY שישי
SATURDAY שבת
SUNDAY ראשון

תאריך

מייצג תאריך קלנדרי מלא או חלקי, כמו יום הולדת. השעה ביום ואזור הזמן מצוינים במקום אחר או שאינם משמעותיים. התאריך הזה יחסי ללוח השנה הגרגוריאני. הנתון הזה יכול לייצג אחת מהאפשרויות הבאות:

  • תאריך מלא, עם ערכים שונים של שנה, חודש ויום
  • חודש ויום, עם שנת אפס (למשל יום נישואין)
  • שנה בפני עצמה, עם חודש של אפס ואפס יום
  • שנה וחודש, עם אפס יום (למשל, תאריך תפוגה של כרטיס אשראי)

סוגים קשורים: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp

ייצוג JSON 
{
  "year": integer,
  "month": integer,
  "day": integer
}
שדות
year

integer

שנת התאריך. חייב להיות בין 1 ל-9999, או 0 כדי לציין תאריך ללא שנה.
month

integer

החודש בשנה. צריך להיות בין 1 ל-12, או 0 כדי לציין שנה בלי חודש ויום.
day

integer

היום בחודש. הערך צריך להיות בין 1 ל-31 והוא תקף לשנה ולחודש, או 0 כדי לציין שנה בלבד או שנה וחודש שבהם היום לא משמעותי.