- Yêu cầu HTTP
- Tham số đường dẫn
- Tham số truy vấn
- Nội dung yêu cầu
- Nội dung phản hồi
- Phạm vi cấp phép
- BusinessCallsInsights
- MetricType
- AggregateMetrics
- HourlyMetrics
- WeekDayMetrics
- DayOfWeek
- Ngày
Trả về thông tin chi tiết của các cuộc gọi đến doanh nghiệp cho một vị trí.
Yêu cầu HTTP
GET https://mybusinessbusinesscalls.googleapis.com/v1/{parent=locations/*}/businesscallsinsights
URL sử dụng cú pháp Chuyển mã gRPC.
Tham số đường dẫn
Tham số | |
---|---|
parent |
Bắt buộc. Vị trí gốc để tìm nạp thông tin chi tiết về cuộc gọi. Định dạng: vị trí/{locationId} |
Tham số truy vấn
Tham số | |
---|---|
pageSize |
Không bắt buộc. Số lượng BusinessCallInsights tối đa cần trả về. Nếu bạn không chỉ định, hệ thống sẽ trả về tối đa 20 chuỗi dữ liệu. Một số loại metric(ví dụ: AGGREGATE_COUNT) sẽ trả về một trang duy nhất. Đối với những chỉ số này, pageSize bị bỏ qua. |
pageToken |
Không bắt buộc. Mã thông báo trang, nhận được từ lệnh gọi Khi phân trang, tất cả các tham số khác được cung cấp cho |
filter |
Không bắt buộc. Bộ lọc ràng buộc thông tin chi tiết về cuộc gọi trả về. Phản hồi chỉ bao gồm các mục khớp với bộ lọc. Nếu metricType không được cung cấp, hàm AGGREGATE_COUNT sẽ được trả về. Nếu không có endDate nào được cung cấp, thì ngày cuối cùng có dữ liệu sẽ được sử dụng. Nếu bạn không cung cấp startDate, chúng tôi sẽ mặc định chọn ngày đầu tiên có dữ liệu, hiện tại là 6 tháng. Nếu startDate trước ngày dữ liệu có sẵn, thì dữ liệu sẽ được trả về bắt đầu từ ngày có dữ liệu. Tại thời điểm này, chúng tôi hỗ trợ các bộ lọc sau. 1. startDate="DATE" trong đó ngày ở định dạng YYYY-MM-DD. 2. endDate="DATE" trong đó ngày ở định dạng YYYY-MM-DD. 3. metricType=XYZ trong đó XYZ là một chỉ số hợp lệ. 4. Liên từ(AND) của tất cả những câu trên. ví dụ: "startDate=2021-08-01 AND endDate=2021-08-10 AND metricType=AGGREGATE_COUNT" AGGREGATE_COUNT metricType bỏ qua phần DD của ngày. |
Nội dung yêu cầu
Nội dung yêu cầu phải trống.
Nội dung phản hồi
Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:
Thông báo phản hồi cho businesscallinsights.list.
Biểu diễn dưới dạng JSON |
---|
{
"businessCallsInsights": [
{
object ( |
Trường | |
---|---|
businessCallsInsights[] |
Tập hợp thông tin chi tiết về cuộc gọi của doanh nghiệp cho vị trí này. |
nextPageToken |
Mã thông báo có thể được gửi dưới dạng |
Phạm vi cấp phép
Yêu cầu phạm vi OAuth sau:
https://www.googleapis.com/auth/business.manage
Để biết thêm thông tin, hãy xem bài viết Tổng quan về OAuth 2.0.
BusinessCallsInsights
Thông tin chi tiết về cuộc gọi đến một địa điểm.
Biểu diễn dưới dạng JSON |
---|
{ "name": string, "metricType": enum ( |
Trường | |
---|---|
name |
Bắt buộc. Tên tài nguyên của thông tin chi tiết về cuộc gọi. Định dạng: vị trí/{location}/business callsinsights |
metricType |
Chỉ số mà giá trị được áp dụng. |
aggregateMetrics |
Chỉ số cho phạm vi thời gian dựa trên startDate và endDate. |
MetricType
Loại chỉ số.
Enum | |
---|---|
METRIC_TYPE_UNSPECIFIED |
Loại chỉ số chưa được xác định. |
AGGREGATE_COUNT |
Các chỉ số được cung cấp được số lượng tổng hợp trong phạm vi thời gian đầu vào. |
AggregateMetrics
Các chỉ số được tổng hợp trong phạm vi thời gian nhập.
Biểu diễn dưới dạng JSON |
---|
{ "missedCallsCount": integer, "answeredCallsCount": integer, "hourlyMetrics": [ { object ( |
Trường | |
---|---|
missedCallsCount |
Tổng số cuộc gọi nhỡ. |
answeredCallsCount |
Tổng số cuộc gọi đã trả lời. |
hourlyMetrics[] |
Danh sách chỉ số theo giờ trong ngày. |
weekdayMetrics[] |
Danh sách chỉ số theo ngày trong tuần. |
startDate |
Ngày cho chỉ số này. Nếu chỉ số là hằng tháng thì chỉ năm và tháng được sử dụng. |
endDate |
Ngày kết thúc cho chỉ số này. |
HourlyMetrics
Chỉ số trong một giờ.
Biểu diễn dưới dạng JSON |
---|
{ "hour": integer, "missedCallsCount": integer } |
Trường | |
---|---|
hour |
Giờ trong ngày. Chỉ cho phép các giá trị trong khoảng 0-23. |
missedCallsCount |
Tổng số cuộc gọi nhỡ trong giờ này. |
WeekDayMetrics
Chỉ số cho một ngày trong tuần.
Biểu diễn dưới dạng JSON |
---|
{
"day": enum ( |
Trường | |
---|---|
day |
Ngày trong tuần. Giá trị được phép là Chủ Nhật – Thứ Bảy. |
missedCallsCount |
Tổng số cuộc gọi nhỡ trong giờ này. |
DayOfWeek
Đại diện cho một ngày trong tuần.
Enum | |
---|---|
DAY_OF_WEEK_UNSPECIFIED |
Ngày trong tuần không được chỉ định. |
MONDAY |
Thứ Hai |
TUESDAY |
Tuesday (thứ Ba) |
WEDNESDAY |
Wednesday (thứ Tư) |
THURSDAY |
Thursday (thứ Năm) |
FRIDAY |
Friday (thứ Sáu) |
SATURDAY |
Saturday (thứ Bảy) |
SUNDAY |
Chủ Nhật |
Ngày
Đại diện cho toàn bộ hoặc một phần ngày theo lịch, chẳng hạn như ngày sinh nhật. Thời gian trong ngày và múi giờ được chỉ định ở nơi khác hoặc không đáng kể. Ngày này có liên quan đến Lịch Gregory. Thông tin này có thể là một trong những trường hợp sau:
- Ngày đầy đủ, với các giá trị năm, tháng và ngày khác 0
- Tháng và ngày, giá trị 0 năm (ví dụ: ngày kỷ niệm)
- Một năm riêng biệt, tháng 0 và ngày 0
- Năm và tháng, với giá trị 0 (ví dụ: ngày hết hạn thẻ tín dụng)
Các loại liên quan: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp
Biểu diễn dưới dạng JSON |
---|
{ "year": integer, "month": integer, "day": integer } |
Trường | |
---|---|
year |
Năm của ngày. Giá trị phải từ 1 đến 9999 hoặc bằng 0 để chỉ định ngày không có năm. |
month |
Tháng trong năm. Giá trị phải từ 1 đến 12 hoặc bằng 0 để chỉ định một năm không có tháng và ngày. |
day |
Ngày trong tháng. Phải có giá trị từ 1 đến 31 và có giá trị hợp lệ trong năm và tháng, hoặc bằng 0 để chỉ định một năm độc lập hoặc là một năm và tháng mà ngày không quan trọng. |