Method: properties.chat

Cung cấp giao diện trò chuyện để tương tác với dữ liệu Google Analytics thông qua API.

Sản phẩm này sử dụng AI và có thể hiển thị thông tin không chính xác. Hoạt động trò chuyện của bạn có thể được dùng để cải thiện sản phẩm và việc bạn sử dụng phải tuân thủ Điều khoản, Chính sách sử dụng AIChính sách quyền riêng tư của Google. Tìm hiểu thêm về quyền riêng tư khi sử dụng AI trò chuyện của các tài sản.

Yêu cầu HTTP

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

URL sử dụng cú pháp Chuyển mã gRPC.

Tham số đường dẫn

Tham số
property

string

Bắt buộc. Tài sản mà bạn muốn trò chuyện. Định dạng: properties/{property}

Nội dung yêu cầu

Nội dung yêu cầu chứa dữ liệu với cấu trúc sau:

Biểu diễn dưới dạng JSON
{
  "userQuery": string,
  "returnPropertyQuota": boolean,
  "sessionId": string
}
Trường
userQuery

string

Bắt buộc. Cụm từ tìm kiếm của người dùng.

returnPropertyQuota

boolean

Không bắt buộc. Nếu đúng, phản hồi sẽ bao gồm trạng thái hiện tại của hạn mức Tài sản Analytics này. Hạn mức được trả về trong PropertyChatQuota.

sessionId

string

Không bắt buộc. Cung cấp mã phiên này để tiếp tục một cuộc trò chuyện hiện có và duy trì ngữ cảnh. Nếu trường này trống hoặc chưa được đặt, thì một phiên trò chuyện mới sẽ được tạo. Mã phiên không hợp lệ sẽ dẫn đến lỗi.

Nội dung phản hồi

Thông báo phản hồi cho phương thức properties.chat.

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:

Biểu diễn dưới dạng JSON
{
  "sessionId": string,
  "blocks": [
    {
      object (ResponseBlock)
    }
  ],
  "propertyQuota": {
    object (PropertyChatQuota)
  }
}
Trường
sessionId

string

Giá trị nhận dạng duy nhất cho phiên trò chuyện này. Cung cấp mã nhận dạng này trong các yêu cầu tiếp theo để duy trì bối cảnh trò chuyện.

blocks[]

object (ResponseBlock)

Các khối phản hồi tạo nên câu trả lời trong cuộc trò chuyện. Trong đó có thể có văn bản, bảng và danh sách.

propertyQuota

object (PropertyChatQuota)

Trạng thái hạn mức của Tài sản Analytics này, bao gồm cả yêu cầu này.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

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

ResponseBlock

Một khối dữ liệu có cấu trúc trong câu trả lời của cuộc trò chuyện.

Biểu diễn dưới dạng 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.
}
Trường
Một khối dữ liệu có cấu trúc. Sau đây là danh sách các trường loại trừ lẫn nhau. Tối đa một trong các trường sẽ được đặt trong phản hồi:
text

string

Một khối văn bản.

table

object (DataTable)

Một khối dữ liệu trong bảng.

Kết thúc các trường xung khắc.

DataTable

Bảng dữ liệu.

Biểu diễn dưới dạng JSON
{
  "headers": [
    {
      object (DataTableHeader)
    }
  ],
  "rows": [
    {
      object (DataTableRow)
    }
  ]
}
Trường
headers[]

object (DataTableHeader)

Mô tả các cột phương diện. Số lượng tiêu đề và thứ tự của tiêu đề khớp với các phương diện có trong hàng.

rows[]

object (DataTableRow)

Các hàng gồm tổ hợp giá trị thứ nguyên và giá trị chỉ số trong báo cáo.

DataTableHeader

Mô tả tiêu đề cột trong DataTable.

Biểu diễn dưới dạng JSON
{
  "header": string,
  "dataType": string
}
Trường
header

string

Tên tiêu đề.

dataType

string

Loại dữ liệu.

DataTableRow

Một hàng trong DataTable.

Biểu diễn dưới dạng JSON
{
  "columns": [
    {
      object (DataTableCell)
    }
  ]
}
Trường
columns[]

object (DataTableCell)

Giá trị ô trong hàng.

DataTableCell

Một ô trong bảng dữ liệu.

Biểu diễn dưới dạng JSON
{
  "value": string
}
Trường
value

string

Giá trị của ô.

PropertyChatQuota

Hạn mức tài sản cho các trường cụ thể của chatbot.

Biểu diễn dưới dạng JSON
{
  "tokensPerDay": {
    object (QuotaStatus)
  },
  "tokensPerHour": {
    object (QuotaStatus)
  }
}
Trường
tokensPerDay

object (QuotaStatus)

Số lượng mã thông báo properties.chat đã sử dụng mỗi ngày.

tokensPerHour

object (QuotaStatus)

Số lượng mã thông báo properties.chat được sử dụng mỗi giờ.