- בקשת HTTP
- פרמטרים של נתיב
- פרמטרים של שאילתה
- גוף הבקשה
- גוף התשובה
- היקפי ההרשאות
- BusinessCallsInsights
- MetricType
- AggregateMetrics
- HourlyMetrics
- WeekDayMetrics
- DayOfWeek
- תאריך
מחזירה תובנות לגבי שיחות עסקיות עבור מיקום.
בקשת HTTP
GET https://mybusinessbusinesscalls.googleapis.com/v1/{parent=locations/*}/businesscallsinsights
בכתובת ה-URL נעשה שימוש בתחביר המרת gRPC.
פרמטרים של נתיב
פרמטרים | |
---|---|
parent |
חובה. המיקום הראשי שעבורו יש לאחזר תובנות לגבי שיחות. פורמט: locations/{locationId} |
פרמטרים של שאילתה
פרמטרים | |
---|---|
pageSize |
אפשרות. המספר המקסימלי של BusinessCallsInsights שניתן להחזיר. אם לא צוין, יוחזרו 20 לכל היותר. חלק מ-metric_types(למשל, AGGREGATE_COUNT) מחזירים דף אחד. מהמדדים האלה המערכת מתעלמת מה-pageSize. |
pageToken |
אפשרות. אסימון דף שהתקבל משיחה קודמת ב- במהלך החלוקה לדפים, כל הפרמטרים האחרים שסיפקתם ל- |
filter |
אפשרות. מסנן שמגביל את החזרה של התובנות לגבי שיחות. התשובה תכלול רק ערכים שתואמים למסנן. אם לא הוזן 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 |
אסימון שניתן לשלוח בתור |
היקפי הרשאות
נדרש היקף OAuth הבא:
https://www.googleapis.com/auth/business.manage
למידע נוסף, עיין בסקירה הכללית על OAuth 2.0.
BusinessCallsInsights
תובנות לגבי שיחות שבוצעו למיקום.
ייצוג JSON |
---|
{ "name": string, "metricType": enum ( |
שדות | |
---|---|
name |
חובה. שם המשאב של התובנות לגבי השיחות. פורמט: מיקומים/{location}/businesscallsinsights |
metricType |
המדד שעליו חל הערך. |
aggregateMetrics |
מדד לטווח הזמן שמבוסס על startDate ו-endDate. |
MetricType
סוג המדד.
טיפוסים בני מנייה (enums) | |
---|---|
METRIC_TYPE_UNSPECIFIED |
לא צוין סוג המדד. |
AGGREGATE_COUNT |
המדדים שצוינו הם ספירות נצברים לאורך זמן_טווח הקלט. |
AggregateMetrics
מדדים נצברים לאורך טווח הזמן של הקלט.
ייצוג JSON |
---|
{ "missedCallsCount": integer, "answeredCallsCount": integer, "hourlyMetrics": [ { object ( |
שדות | |
---|---|
missedCallsCount |
מספר כולל של שיחות שלא נענו. |
answeredCallsCount |
המספר הכולל של שיחות שנענו. |
hourlyMetrics[] |
רשימת מדדים לפי השעה ביום. |
weekdayMetrics[] |
רשימת מדדים לפי יום בשבוע. |
startDate |
התאריך של המדד הזה. אם המדד הוא חודשי, המערכת תשתמש רק בשנה ובחודש. |
endDate |
תאריך הסיום של המדד הזה. |
HourlyMetrics
מדדים לשעה.
ייצוג JSON |
---|
{ "hour": integer, "missedCallsCount": integer } |
שדות | |
---|---|
hour |
שעה ביום. הערכים המותרים הם 0-23. |
missedCallsCount |
סך כל השיחות שלא נענו בשעה הזו. |
WeekDayMetrics
מדדים ליום בשבוע.
ייצוג JSON |
---|
{
"day": enum ( |
שדות | |
---|---|
day |
היום בשבוע. הערכים המותרים הם ראשון עד שבת. |
missedCallsCount |
סך כל השיחות שלא נענו בשעה הזו. |
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 |
שנת התאריך. חייב להיות בין 1 ל-9999, או 0 כדי לציין תאריך ללא שנה. |
month |
החודש בשנה. צריך להיות בין 1 ל-12, או 0 כדי לציין שנה בלי חודש ויום. |
day |
היום בחודש. הערך צריך להיות בין 1 ל-31 והוא תקף לשנה ולחודש, או 0 כדי לציין שנה בלבד או שנה וחודש שבהם היום לא משמעותי. |