- คำขอ HTTP
- พารามิเตอร์เส้นทาง
- พารามิเตอร์การค้นหา
- เนื้อความของคำขอ
- เนื้อหาการตอบกลับ
- ขอบเขตการให้สิทธิ์
- BusinessCallsInsights
- MetricType
- AggregateMetrics
- HourlyMetrics
- WeekDayMetrics
- DayOfWeek
- วันที่
แสดงผลข้อมูลเชิงลึกสำหรับการโทรของธุรกิจสำหรับสถานที่ตั้ง
คำขอ HTTP
GET https://mybusinessbusinesscalls.googleapis.com/v1/{parent=locations/*}/businesscallsinsights
URL ใช้ไวยากรณ์การแปลง gRPC
พารามิเตอร์เส้นทาง
พารามิเตอร์ | |
---|---|
parent |
ต้องระบุ ตำแหน่งระดับบนสุดที่จะดึงข้อมูลข้อมูลเชิงลึกเกี่ยวกับการโทร รูปแบบ: สถานที่ตั้ง/{locationId} |
พารามิเตอร์การค้นหา
พารามิเตอร์ | |
---|---|
pageSize |
ไม่บังคับ จำนวน BusinessCallsInsights สูงสุดที่จะแสดง หากไม่ระบุ ระบบจะแสดงผลไม่เกิน 20 รายการ ประเภทเมตริก(เช่น AGGREGATE_COUNT) บางรายการแสดงหน้าเว็บเดียว ระบบจะไม่สนใจ pageSize สำหรับเมตริกเหล่านี้ |
pageToken |
ไม่บังคับ โทเค็นของหน้าเว็บที่ได้รับจากการโทร เมื่อใส่เลขหน้า พารามิเตอร์อื่นๆ ทั้งหมดที่ให้กับ |
filter |
ไม่บังคับ ตัวกรองที่จะจำกัดข้อมูลเชิงลึกเกี่ยวกับการโทรที่จะแสดง การตอบกลับมีเฉพาะรายการที่ตรงกับตัวกรอง หากไม่ระบุ MetricType ระบบจะแสดงผล AGGREGATE_COUNT หากไม่ได้ระบุ endDate ระบบจะใช้วันสุดท้ายที่มีข้อมูล หากไม่ได้ระบุ startDate เราจะใช้ค่าเริ่มต้นเป็นวันที่แรกที่มีข้อมูล ซึ่งปัจจุบันคือ 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 และ endDate=2021-08-10 ANDmetricType=AGGREGATE_COUNT" AGGREGATE_COUNTmetricType จะไม่สนใจส่วน 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
ประเภทของเมตริก
Enum | |
---|---|
METRIC_TYPE_UNSPECIFIED |
ไม่ได้ระบุประเภทของเมตริก |
AGGREGATE_COUNT |
เมตริกที่ระบุจะนับรวมกันตลอดช่วงเวลาของอินพุต |
AggregateMetrics
เมตริกที่รวบรวมในช่วงเวลาที่ป้อน
การแสดง JSON |
---|
{ "missedCallsCount": integer, "answeredCallsCount": integer, "hourlyMetrics": [ { object ( |
ช่อง | |
---|---|
missedCallsCount |
จำนวนสายที่ไม่ได้รับทั้งหมด |
answeredCallsCount |
จำนวนสายที่รับทั้งหมด |
hourlyMetrics[] |
รายการเมตริกตามชั่วโมงของวัน |
weekdayMetrics[] |
รายการเมตริกตามวันในสัปดาห์ |
startDate |
วันที่ของเมตริกนี้ หากเป็นเมตริกรายเดือน ระบบจะใช้เฉพาะปีและเดือน |
endDate |
วันที่สิ้นสุดของเมตริกนี้ |
HourlyMetrics
เมตริกของ 1 ชั่วโมง
การแสดง JSON |
---|
{ "hour": integer, "missedCallsCount": integer } |
ช่อง | |
---|---|
hour |
ชั่วโมงของวัน ค่าที่ใช้ได้คือ 0-23 |
missedCallsCount |
จำนวนสายที่ไม่ได้รับทั้งหมดในชั่วโมงนี้ |
WeekDayMetrics
เมตริกของวันในสัปดาห์
การแสดง JSON |
---|
{
"day": enum ( |
ช่อง | |
---|---|
day |
วันของสัปดาห์ ค่าที่ใช้ได้คือวันอาทิตย์ - วันเสาร์ |
missedCallsCount |
จำนวนสายที่ไม่ได้รับทั้งหมดในชั่วโมงนี้ |
วันของสัปดาห์
แสดงวันของสัปดาห์
Enum | |
---|---|
DAY_OF_WEEK_UNSPECIFIED |
ไม่ระบุวันของสัปดาห์ |
MONDAY |
วันจันทร์ |
TUESDAY |
อังคาร |
WEDNESDAY |
พุธ |
THURSDAY |
พฤหัสบดี |
FRIDAY |
ศุกร์ |
SATURDAY |
เสาร์ |
SUNDAY |
วันอาทิตย์ |
วันที่
แสดงวันที่ในปฏิทินบางส่วนหรือทั้งหมด เช่น วันเกิด มีการระบุเวลาของวันและเขตเวลาไว้ที่อื่นหรือไม่มีนัยสำคัญ วันที่จะสัมพันธ์กับปฏิทินเกรกอเรียน ซึ่งอาจเป็นอย่างใดอย่างหนึ่งต่อไปนี้
- วันที่แบบเต็มที่มีค่าปี เดือน และวันที่ไม่ใช่ 0
- 1 เดือนและวัน โดย 0 ปี (เช่น วันครบรอบ)
- 1 ปีในตัวเอง โดยมี 0 เดือนและ 0 วัน
- 1 ปีและเดือน โดยมี 0 วัน (เช่น วันที่หมดอายุของบัตรเครดิต)
ประเภทที่เกี่ยวข้อง: * 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 เพื่อระบุปีเพียงอย่างเดียว หรือ 1 ปีและเดือนที่วันไม่มีนัยสำคัญ |