Method: locations.businesscallsinsights.list

اطلاعات آماری تماس‌های تجاری برای یک مکان را برمی‌گرداند.

درخواست HTTP

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

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای مسیر

پارامترها
parent

string

مورد نیاز. مکان والد برای واکشی اطلاعات آماری تماس‌ها. قالب: مکان‌ها/{locationId}

پارامترهای پرس و جو

پارامترها
pageSize

integer

اختیاری. حداکثر تعداد BusinessCallsInsights برای بازگشت. در صورت نامشخص حداکثر 20 عدد برگردانده می شود. برخی از metric_types (به عنوان مثال، AGGREGATE_COUNT) یک صفحه را برمی گرداند. برای این معیارها، اندازه صفحه نادیده گرفته می شود.

pageToken

string

اختیاری. یک نشانه صفحه، دریافت شده از تماس قبلی businesscallsinsights.list . این را برای بازیابی صفحه بعدی ارائه کنید.

هنگام صفحه بندی، تمام پارامترهای دیگر ارائه شده به businesscallsinsights.list باید با تماسی که توکن صفحه را ارائه می کند مطابقت داشته باشد. برخی از metric_types (به عنوان مثال، AGGREGATE_COUNT) یک صفحه را برمی گرداند. برای این معیارها، pake_token نادیده گرفته می شود.

filter

string

اختیاری. فیلتری که بینش تماس ها را برای بازگشت محدود می کند. پاسخ فقط شامل ورودی هایی می شود که با فیلتر مطابقت دارند.

اگر 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": 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 )

متریک برای محدوده زمانی بر اساس تاریخ شروع و تاریخ پایان.

نوع متریک

نوع متریک.

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 )

تاریخ پایان برای این سنجه.

ساعتی متریک

متریک برای یک ساعت

نمایندگی JSON 
{
  "hour": integer,
  "missedCallsCount": integer
}
فیلدها
hour

integer

ساعت از روز. مقادیر مجاز 0-23 هستند.

missedCallsCount

integer

تعداد کل تماس های از دست رفته برای این ساعت.

WeekDayMetrics

معیارهای یک روز هفته

نمایندگی JSON 
{
  "day": enum (DayOfWeek),
  "missedCallsCount": integer
}
فیلدها
day

enum ( DayOfWeek )

روز هفته. مقادیر مجاز یکشنبه تا شنبه است.

missedCallsCount

integer

تعداد کل تماس های از دست رفته برای این ساعت.

روز هفته

یک روز از هفته را نشان می دهد.

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 برای مشخص کردن یک سال به تنهایی یا یک سال و ماهی که در آن روز مهم نیست، معتبر باشد.