Method: properties.chat

มีอินเทอร์เฟซแชทสําหรับโต้ตอบกับข้อมูล Google Analytics ผ่าน API

ผลิตภัณฑ์นี้ใช้ AI และอาจแสดงข้อมูลที่ไม่ถูกต้อง ระบบอาจใช้กิจกรรมการแชทของคุณเพื่อปรับปรุงผลิตภัณฑ์ และการใช้งานของคุณจะอยู่ภายใต้ข้อกำหนด นโยบายการใช้งาน AI และนโยบายความเป็นส่วนตัวของ Google ดูข้อมูลเพิ่มเติมเกี่ยวกับความเป็นส่วนตัวของ AI ในแชทของพร็อพเพอร์ตี้

คำขอ HTTP

POST https://analyticsdata.googleapis.com/v1alpha/{property=properties/*}:chat

URL ใช้ไวยากรณ์การแปลงรหัส gRPC

พารามิเตอร์เส้นทาง

พารามิเตอร์
property

string

ต้องระบุ พร็อพเพอร์ตี้ที่จะแชท รูปแบบ: properties/{property}

เนื้อความของคำขอ

เนื้อหาของคำขอมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

การแสดง JSON 
{
  "userQuery": string,
  "returnPropertyQuota": boolean,
  "sessionId": string
}
ช่อง
userQuery

string

ต้องระบุ คำค้นหาของผู้ใช้
returnPropertyQuota

boolean

ไม่บังคับ หากเป็นจริง การตอบกลับจะมีสถานะปัจจุบันของโควต้าของพร็อพเพอร์ตี้ Analytics นี้ ระบบจะแสดงโควต้าใน PropertyChatQuota
sessionId

string

ไม่บังคับ ระบุรหัสเซสชันนี้เพื่อสนทนาต่อและคงบริบทเดิมไว้ หากช่องนี้ว่างเปล่าหรือไม่ได้ตั้งค่า ระบบจะสร้างเซสชันแชทใหม่ รหัสเซสชันที่ไม่ถูกต้องจะทำให้เกิดข้อผิดพลาด

เนื้อหาการตอบกลับ

ข้อความตอบกลับสำหรับเมธอด properties.chat

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

การแสดง JSON 
{
  "sessionId": string,
  "blocks": [
    {
      object (ResponseBlock)
    }
  ],
  "propertyQuota": {
    object (PropertyChatQuota)
  }
}
ช่อง
sessionId

string

ตัวระบุที่ไม่ซ้ำกันสำหรับเซสชันแชทนี้ ระบุรหัสนี้ในคำขอที่ตามมาเพื่อรักษาบริบทของการสนทนา
blocks[]

object (ResponseBlock)

บล็อกการตอบกลับที่ประกอบกันเป็นคำตอบของแชท ซึ่งอาจรวมถึงข้อความ ตาราง และรายการ
propertyQuota

object (PropertyChatQuota)

สถานะโควต้าของพร็อพเพอร์ตี้ Google Analytics นี้รวมถึงคำขอนี้

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

  • https://www.googleapis.com/auth/analytics.chatbot.read

ResponseBlock

Structured Data 1 บล็อกในการตอบกลับของแชท

การแสดง JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "text": string,
  "table": {
    object (DataTable)
  }
  // End of mutually exclusive fields.
}
ช่อง
Structured Data 1 บล็อก ต่อไปนี้คือรายการฟิลด์ที่ใช้ร่วมกันไม่ได้ ระบบจะตั้งค่าช่องใดช่องหนึ่งต่อไปนี้ในการตอบกลับ
text

string

บล็อกข้อความ
table

object (DataTable)

บล็อกข้อมูลตาราง
สิ้นสุดฟิลด์ที่แยกกัน

DataTable

ตารางข้อมูล

การแสดง JSON 
{
  "headers": [
    {
      object (DataTableHeader)
    }
  ],
  "rows": [
    {
      object (DataTableRow)
    }
  ]
}
ช่อง
headers[]

object (DataTableHeader)

อธิบายคอลัมน์มิติข้อมูล จำนวนส่วนหัวและการจัดลำดับส่วนหัวตรงกับมิติข้อมูลที่มีอยู่ในแถว
rows[]

object (DataTableRow)

แถวของชุดค่ามิติข้อมูลและค่าเมตริกในรายงาน

DataTableHeader

อธิบายส่วนหัวคอลัมน์ใน DataTable

การแสดง JSON 
{
  "header": string,
  "dataType": string
}
ช่อง
header

string

ชื่อส่วนหัว
dataType

string

ประเภทข้อมูล

DataTableRow

แถวใน DataTable

การแสดง JSON 
{
  "columns": [
    {
      object (DataTableCell)
    }
  ]
}
ช่อง
columns[]

object (DataTableCell)

ค่าของเซลล์ในแถว

DataTableCell

เซลล์ในตารางข้อมูล

การแสดง JSON 
{
  "value": string
}
ช่อง
value

string

ค่าของเซลล์

PropertyChatQuota

โควต้าพร็อพเพอร์ตี้สำหรับฟิลด์เฉพาะของแชทบอท

การแสดง JSON 
{
  "tokensPerDay": {
    object (QuotaStatus)
  },
  "tokensPerHour": {
    object (QuotaStatus)
  }
}
ช่อง
tokensPerDay

object (QuotaStatus)

โทเค็น properties.chat ที่ใช้ต่อวัน
tokensPerHour

object (QuotaStatus)

พร็อพเพอร์ตี้ โทเค็นแชทที่ใช้ต่อชั่วโมง