Package google.mybusiness.businesscalls.v1

ดัชนี

• BusinessCallsService (อินเทอร์เฟซ)
• AggregateMetrics (ข้อความ)
• BusinessCallsInsights (ข้อความ)
• BusinessCallsSettings (ข้อความ)
• BusinessCallsSettings.CallsState (enum)
• ErrorCode (enum)
• GetBusinessCallsSettingsRequest (ข้อความ)
• HourlyMetrics (ข้อความ)
• ListBusinessCallsInsightsRequest (ข้อความ)
• ListBusinessCallsInsightsResponse (ข้อความ)
• MetricType (enum)
• UpdateBusinessCallsSettingsRequest (ข้อความ)
• WeekDayMetrics (ข้อความ)

BusinessCallsService

API นี้ช่วยให้ธุรกิจจัดการสายโทรทางธุรกิจและรวบรวมข้อมูลข้อมูลเชิงลึก เช่น จำนวนสายที่ไม่ได้รับมายังสถานที่ตั้งของธุรกิจได้ ดูข้อมูลเพิ่มเติมเกี่ยวกับการโทรทางธุรกิจได้ที่ https://support.google.com/business/answer/9688285?p=call_history

หาก Google Business Profile ลิงก์กับบัญชี Google Ads และเปิดใช้ประวัติการโทรไว้ การโทรที่มีระยะเวลานานกว่าเวลาที่ระบุและที่มาจากการโต้ตอบกับโฆษณาจะแสดงในบัญชี Google Ads ที่ลิงก์ในส่วน Conversion "การโทรจากโฆษณา" หากใช้ Smart Bidding และ Conversion การโทรในกลยุทธ์การเพิ่มประสิทธิภาพ ค่าโฆษณาอาจเปลี่ยนแปลงไป ดูข้อมูลเพิ่มเติมเกี่ยวกับ Smart Bidding"

หากต้องการดูและดำเนินการการโทรของสถานที่ตั้ง คุณต้องเป็น OWNER, CO_OWNER หรือ MANAGER ของสถานที่ตั้งนั้น

GetBusinessCallsSettings
rpc GetBusinessCallsSettings(GetBusinessCallsSettingsRequest) returns (BusinessCallsSettings) แสดงทรัพยากรการตั้งค่าการโทรจากธุรกิจสำหรับสถานที่ตั้งที่ระบุ ขอบเขตการให้สิทธิ์ ต้องใช้ขอบเขต OAuth ต่อไปนี้ https://www.googleapis.com/auth/business.manage ดูข้อมูลเพิ่มเติมได้ที่ภาพรวมของ OAuth 2.0

ListBusinessCallsInsights
rpc ListBusinessCallsInsights(ListBusinessCallsInsightsRequest) returns (ListBusinessCallsInsightsResponse) แสดงข้อมูลเชิงลึกสําหรับการโทรจากธุรกิจสําหรับสถานที่ตั้งหนึ่งๆ ขอบเขตการให้สิทธิ์ ต้องใช้ขอบเขต OAuth ต่อไปนี้ https://www.googleapis.com/auth/business.manage ดูข้อมูลเพิ่มเติมได้ที่ภาพรวมของ OAuth 2.0

UpdateBusinessCallsSettings
rpc UpdateBusinessCallsSettings(UpdateBusinessCallsSettingsRequest) returns (BusinessCallsSettings) อัปเดตการตั้งค่าการโทรติดต่อธุรกิจสำหรับสถานที่ตั้งที่ระบุ ขอบเขตการให้สิทธิ์ ต้องใช้ขอบเขต OAuth ต่อไปนี้ https://www.googleapis.com/auth/business.manage ดูข้อมูลเพิ่มเติมได้ที่ภาพรวมของ OAuth 2.0

AggregateMetrics

เมตริกที่รวบรวมในช่วงเวลาที่ป้อน

ช่อง
missed_calls_count	Int32Value จำนวนสายที่ไม่ได้รับทั้งหมด
answered_calls_count	Int32Value จำนวนสายที่รับทั้งหมด
hourly_metrics[]	HourlyMetrics รายการเมตริกตามชั่วโมงของวัน
weekday_metrics[]	WeekDayMetrics รายการเมตริกตามวันในสัปดาห์
start_date	Date วันที่ของเมตริกนี้ หากเป็นเมตริกรายเดือน จะใช้เพียงปีและเดือนเท่านั้น
end_date	Date วันที่สิ้นสุดของเมตริกนี้

BusinessCallsInsights

ข้อมูลเชิงลึกสำหรับการโทรไปยังสถานที่

ช่อง
name	string ต้องระบุ ชื่อทรัพยากรของข้อมูลเชิงลึกเกี่ยวกับการโทร รูปแบบ: สถานที่/{location}/businesscallsinsights
metric_type	MetricType เมตริกที่ใช้ค่านี้
aggregate_metrics	AggregateMetrics เมตริกสำหรับช่วงเวลาตาม start_date และ end_date

BusinessCallsSettings

การตั้งค่าการโทรจากธุรกิจสำหรับสถานที่

ช่อง
name	string ต้องระบุ ชื่อทรัพยากรของการตั้งค่าการโทร รูปแบบ: สถานที่ตั้ง/{location}/businesscallssettings
calls_state	CallsState ต้องระบุ สถานะการลงทะเบียนการโทรของธุรกิจของสถานที่นี้
consent_time	Timestamp อินพุตเท่านั้น เวลาที่ผู้ใช้ปลายทางให้ความยินยอมแก่ผู้ใช้ API เพื่อเปิดใช้การโทรหาธุรกิจ

CallsState

สถานะที่เป็นไปได้ของสถานที่ตั้งในการโทรทางธุรกิจ สถานะอาจได้รับการอัปเดตเป็น "เปิดใช้" หรือ "ปิดใช้" เท่านั้น หากมีสิ่งอื่นๆ จะส่งกลับข้อผิดพลาด PRECONDITION_FAILED

Enum
CALLS_STATE_UNSPECIFIED	ไม่ระบุ
ENABLED	เปิดใช้การโทรทางธุรกิจสำหรับสถานที่นั้น
DISABLED	มีการปิดใช้การโทรทางธุรกิจสำหรับสถานที่นั้น

ErrorCode

รหัสข้อผิดพลาดสำหรับความล้มเหลวภายใน

Enum
ERROR_CODE_UNSPECIFIED	รหัสข้อผิดพลาดที่ไม่ได้ระบุ
ERROR_CODE_UNVERIFIED_LOCATION	สถานที่ไม่ได้รับการยืนยัน
ERROR_CODE_CALLS_NOT_ENABLED	สถานะการโทรทางธุรกิจสำหรับสถานที่ตั้งไม่ได้เปิดใช้งาน
ERROR_CODE_NOT_ELIGIBLE_LOCATION	สถานที่นี้ไม่มีสิทธิ์สำหรับการโทรติดต่อธุรกิจ

GetBusinessCallsSettingsRequest

ข้อความคำขอสำหรับ GetBusinessCallsSettings

ช่อง
name	string ต้องระบุ BusinessCallsSettings ที่จะรับ ช่อง name ใช้เพื่อระบุการตั้งค่าการโทรจากธุรกิจที่ต้องการรับ รูปแบบ: locations/{location_id}/businesscallssettings

HourlyMetrics

เมตริกของชั่วโมง

ช่อง
hour	Int32Value ชั่วโมงของวัน ค่าที่ใช้ได้คือ 0-23
missed_calls_count	Int32Value จำนวนสายที่ไม่ได้รับทั้งหมดในชั่วโมงนี้

ListBusinessCallsInsightsRequest

ข้อความคำขอสำหรับ ListBusinessCallsInsights

ช่อง
parent	string ต้องระบุ ตำแหน่งหลักที่จะดึงข้อมูลเชิงลึกเกี่ยวกับการโทร รูปแบบ: สถานที่ตั้ง/{location_id}
page_size	int32 ไม่บังคับ จำนวนสูงสุดของ BusinessCallsInsights ที่จะแสดงผล หากไม่ระบุ ระบบจะส่งคืนสูงสุด 20 รายการ บางเมตริก_ประเภท(เช่น AGGREGATE_COUNT) แสดงผลหน้าเว็บเดียว สำหรับเมตริกเหล่านี้ ระบบจะไม่สนใจ page_size
page_token	string ไม่บังคับ โทเค็นหน้าเว็บที่ได้รับจากการโทร ListBusinessCallsInsights ครั้งก่อน ระบุสิ่งนี้เพื่อเรียกหน้าถัดไป ขณะใส่เลขหน้า พารามิเตอร์อื่นๆ ทั้งหมดที่ระบุให้ ListBusinessCallsInsights ต้องตรงกับการเรียกที่ระบุโทเค็นของหน้า ประเภทเมตริกบางรายการ (เช่น AGGREGATE_COUNT) แสดงผลหน้าเว็บเดียว สำหรับเมตริกเหล่านี้ ระบบจะไม่สนใจ pake_token
filter	string ไม่บังคับ ตัวกรองที่จํากัดข้อมูลเชิงลึกเกี่ยวกับการโทรที่จะแสดง การตอบกลับจะมีเฉพาะรายการที่ตรงกับตัวกรอง หากไม่ได้ระบุ MetricType ระบบจะแสดงผล AGGREGATE_COUNT หากไม่ได้ระบุ end_date ไว้ จะเป็นวันที่สุดท้ายที่ใช้ข้อมูลได้ หากไม่ได้ระบุ start_date เราจะใช้ค่าเริ่มต้นเป็นวันที่แรกที่มีข้อมูล ซึ่งปัจจุบันคือ 6 เดือน หาก start_date อยู่ก่อนวันที่ข้อมูลพร้อมใช้งาน ระบบจะแสดงข้อมูลโดยเริ่มนับจากวันที่มีข้อมูล ปัจจุบันเรารองรับตัวกรองต่อไปนี้ 1. start_date="DATE" โดยที่วันที่อยู่ในรูปแบบ YYYY-MM-DD 2. end_date="DATE" โดยที่วันที่อยู่ในรูปแบบ YYYY-MM-DD 3.Metric_type=XYZ โดยที่ XYZ เป็น MetricType ที่ถูกต้อง 4. คำสันธาน(AND) ของทุกข้อข้างต้น เช่น "start_date=2021-08-01 AND end_date=2021-08-10 ANDMetric_type=AGGREGATE_COUNT" และ AGGREGATE_COUNTMetric_type จะไม่สนใจส่วน DD ของวันที่ดังกล่าว

ListBusinessCallsInsightsResponse

ข้อความตอบกลับสำหรับ ListBusinessCallsInsights

ช่อง
business_calls_insights[]	BusinessCallsInsights คอลเล็กชันข้อมูลเชิงลึกเกี่ยวกับการโทรจากธุรกิจในสถานที่ตั้งนั้นๆ
next_page_token	string โทเค็นที่ส่งเป็น page_token เพื่อเรียกดูหน้าถัดไป หากเว้นช่องนี้ไว้ จะไม่มีหน้าต่อมา ประเภทเมตริกบางรายการ (เช่น AGGREGATE_COUNT) แสดงผลหน้าเว็บเดียว สำหรับเมตริกเหล่านี้ next_page_token จะว่างเปล่า

MetricType

ประเภทของเมตริก

Enum
METRIC_TYPE_UNSPECIFIED	ไม่ได้ระบุประเภทของเมตริก
AGGREGATE_COUNT	เมตริกที่ระบุเป็นจำนวนรวมในช่วงเวลาของอินพุต

UpdateBusinessCallsSettingsRequest

ข้อความคำขอสำหรับ UpdateBusinessCallsSettings

ช่อง
business_calls_settings	BusinessCallsSettings ต้องระบุ BusinessCallsSettings ที่จะอัปเดต ช่อง name ใช้เพื่อระบุการตั้งค่าการโทรติดต่อธุรกิจที่จะอัปเดต รูปแบบ: สถานที่ตั้ง/{location_id}/businesscallssettings
update_mask	FieldMask ต้องระบุ รายการช่องที่จะอัปเดต

WeekDayMetrics

เมตริกสำหรับวันธรรมดา

ช่อง
day	DayOfWeek วันของสัปดาห์ ค่าที่ใช้ได้คือวันอาทิตย์ - วันเสาร์
missed_calls_count	Int32Value จำนวนสายที่ไม่ได้รับทั้งหมดในชั่วโมงนี้