Method: properties.chat

Menyediakan antarmuka chat untuk berinteraksi dengan data Google Analytics melalui API.

Produk ini menggunakan AI dan dapat menampilkan info yang tidak akurat. Aktivitas percakapan Anda mungkin akan digunakan untuk meningkatkan kualitas produk dan penggunaan Anda tunduk kepada Persyaratan, Kebijakan Penggunaan AI, dan Kebijakan Privasi Google. Pelajari lebih lanjut properti.Privasi AI Chat.

Permintaan HTTP

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

URL ini menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
property

string

Wajib. Properti yang akan dibahas dalam chat. Format: properties/{property}

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "userQuery": string,
  "returnPropertyQuota": boolean,
  "sessionId": string
}
Kolom
userQuery

string

Wajib. Kueri pengguna.
returnPropertyQuota

boolean

Opsional. Jika benar, respons akan menyertakan status kuota Properti Analytics ini saat ini. Kuota ditampilkan di PropertyChatQuota.
sessionId

string

Opsional. Berikan ID sesi ini untuk melanjutkan percakapan yang ada dan mempertahankan konteks. Jika kolom ini kosong atau tidak disetel, sesi chat baru akan dibuat. ID sesi yang tidak valid akan menghasilkan error.

Isi respons

Pesan respons untuk metode properties.chat.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "sessionId": string,
  "blocks": [
    {
      object (ResponseBlock)
    }
  ],
  "propertyQuota": {
    object (PropertyChatQuota)
  }
}
Kolom
sessionId

string

ID unik untuk sesi chat ini. Berikan ID ini dalam permintaan berikutnya untuk mempertahankan konteks percakapan.
blocks[]

object (ResponseBlock)

Blok respons yang membentuk respons chat. Hal ini dapat mencakup teks, tabel, dan daftar.
propertyQuota

object (PropertyChatQuota)

Status kuota Properti Analytics ini termasuk permintaan ini.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

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

ResponseBlock

Satu blok data terstruktur dalam respons chat.

Representasi 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.
}
Kolom
Satu blok data terstruktur. Berikut adalah daftar kolom yang bersifat eksklusif satu sama lain. Maksimal satu kolom akan ditetapkan dalam respons:
text

string

Blok teks.
table

object (DataTable)

Blok data tabel.
Akhir kolom yang saling eksklusif.

DataTable

Tabel data.

Representasi JSON 
{
  "headers": [
    {
      object (DataTableHeader)
    }
  ],
  "rows": [
    {
      object (DataTableRow)
    }
  ]
}
Kolom
headers[]

object (DataTableHeader)

Mendeskripsikan kolom dimensi. Jumlah header dan pengurutan header cocok dengan dimensi yang ada di baris.
rows[]

object (DataTableRow)

Baris kombinasi nilai dimensi dan nilai metrik dalam laporan.

DataTableHeader

Mendeskripsikan header kolom di DataTable.

Representasi JSON 
{
  "header": string,
  "dataType": string
}
Kolom
header

string

Nama header.
dataType

string

Jenis data.

DataTableRow

Baris dalam DataTable.

Representasi JSON 
{
  "columns": [
    {
      object (DataTableCell)
    }
  ]
}
Kolom
columns[]

object (DataTableCell)

Nilai sel dalam baris.

DataTableCell

Sel dalam tabel data.

Representasi JSON 
{
  "value": string
}
Kolom
value

string

Nilai sel.

PropertyChatQuota

Kuota properti untuk kolom spesifik chatbot.

Representasi JSON 
{
  "tokensPerDay": {
    object (QuotaStatus)
  },
  "tokensPerHour": {
    object (QuotaStatus)
  }
}
Kolom
tokensPerDay

object (QuotaStatus)

Token properties.chat yang digunakan per hari.
tokensPerHour

object (QuotaStatus)

Token properties.chat yang digunakan per jam.