- בקשת HTTP
- פרמטרים של נתיב
- פרמטרים של שאילתה
- גוף הבקשה
- גוף התשובה
- היקפי הרשאות
- BusinessCallsInsights
- MetricType
- AggregateMetrics
- HourlyMetrics
- WeekDayMetrics
- DayOfWeek
- Date (תאריך)
מחזירה תובנות לגבי שיחות עסקיות למיקום מסוים.
בקשת HTTP
GET https://mybusinessbusinesscalls.googleapis.com/v1/{parent=locations/*}/businesscallsinsights
בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.
פרמטרים של נתיב
פרמטרים | |
---|---|
parent |
חובה. מיקום ההורה שלגביו רוצים לאחזר תובנות על שיחות. פורמט: locations/{locationId} |
פרמטרים של שאילתה
פרמטרים | |
---|---|
pageSize |
זה שינוי אופציונלי. המספר המקסימלי של BusinessCallsInsights שצריך להחזיר. אם לא צוין, יוחזרו 20 לכל היותר. חלק מה- metric_types(למשל, AGGREGATE_COUNT) מחזיר דף יחיד. במדדים האלה המערכת מתעלמת מגודל הדף. |
pageToken |
זה שינוי אופציונלי. אסימון דף, שהתקבל מקריאה קודמת ב- במהלך החלוקה לדפים, כל שאר הפרמטרים שסופקו ל- |
filter |
זה שינוי אופציונלי. מסנן שמגביל את התובנות על השיחות. התשובה כוללת רק רשומות שתואמות למסנן. אם לא צוין MetricType, מוחזר AGGREGATE_COUNT. אם לא תציינו תאריך סיום, ייעשה שימוש בתאריך האחרון שלגביו יש נתונים זמינים. אם לא תספקו תאריך התחלה, ברירת המחדל תהיה התאריך הראשון שלגביו יש נתונים זמינים, שהוא כרגע 6 חודשים. אם startDate הוא לפני התאריך שבו הנתונים זמינים, הנתונים מוחזרים החל מהתאריך שבו הם זמינים. בשלב זה אנחנו תומכים במסננים הבאים. 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 |
חובה. שם המשאב של התובנות לגבי שיחות. פורמט: locations/{location}/businesscallsinsights |
metricType |
המדד שעליו חל הערך. |
aggregateMetrics |
מדד בטווח הזמן שמבוסס על startDate ו-endDate. |
MetricType
סוג המדד.
טיפוסים בני מנייה (enum) | |
---|---|
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
מייצג יום בשבוע.
טיפוסים בני מנייה (enum) | |
---|---|
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 כדי לציין שנה בלבד או שנה וחודש שבהם אין חשיבות לציון יום מסוים. |