Method: properties.chat

Udostępnia interfejs czatu do interakcji z danymi Google Analytics za pomocą interfejsu API.

Ta usługa korzysta z AI i może wyświetlać nieprawidłowe informacje. Twoja aktywność na czacie może służyć do ulepszania usługi. Korzystanie z niej podlega Warunkom korzystania z usługi, Zasadom korzystania z AI oraz Polityce prywatności Google. Więcej informacji o prywatności w usłudze properties.chat AI

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
property

string

Wymagane. Usługa, o której chcesz porozmawiać. Format: properties/{property}

Treść żądania

Treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "userQuery": string,
  "returnPropertyQuota": boolean,
  "sessionId": string
}
Pola
userQuery

string

Wymagane. zapytanie użytkownika,
returnPropertyQuota

boolean

Opcjonalnie. Jeśli wartość to „true”, odpowiedź będzie zawierać bieżący stan limitu tej usługi w Analytics. Limit jest zwracany w polu PropertyChatQuota.
sessionId

string

Opcjonalnie. Podaj ten identyfikator sesji, aby kontynuować rozmowę i zachować kontekst. Jeśli to pole jest puste lub nie jest skonfigurowane, tworzona jest nowa sesja czatu. Nieprawidłowe identyfikatory sesji spowodują błąd.

Treść odpowiedzi

Wiadomość odpowiedzi dla metody properties.chat.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

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

string

Unikalny identyfikator tej sesji czatu. Podaj ten identyfikator w kolejnych żądaniach, aby zachować kontekst rozmowy.
blocks[]

object (ResponseBlock)

bloki odpowiedzi, które składają się na odpowiedź na czacie; Mogą to być tekst, tabele i listy.
propertyQuota

object (PropertyChatQuota)

Stan limitu usługi w Analytics, w tym to żądanie.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

ResponseBlock

Jeden blok uporządkowanych danych w odpowiedzi na czacie.

Zapis 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.
}
Pola
Jeden blok danych strukturalnych. Poniżej znajduje się lista pól, które wykluczają się nawzajem. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
text

string

blok tekstu,
table

object (DataTable)

Blok danych tabeli.
Koniec pól wykluczających się nawzajem.

DataTable

tabelę danych,

Zapis JSON 
{
  "headers": [
    {
      object (DataTableHeader)
    }
  ],
  "rows": [
    {
      object (DataTableRow)
    }
  ]
}
Pola
headers[]

object (DataTableHeader)

Opisuje kolumny wymiarów. Liczba nagłówków i ich kolejność odpowiadają wymiarom w wierszach.
rows[]

object (DataTableRow)

Wiersze z kombinacjami wartości wymiarów i wartościami danych w raporcie.

DataTableHeader

Opisuje nagłówek kolumny w obiekcie DataTable.

Zapis JSON 
{
  "header": string,
  "dataType": string
}
Pola
header

string

Nazwa nagłówka.
dataType

string

Typ danych.

DataTableRow

Wiersz w obiekcie DataTable.

Zapis JSON 
{
  "columns": [
    {
      object (DataTableCell)
    }
  ]
}
Pola
columns[]

object (DataTableCell)

wartości komórek w wierszu,

DataTableCell

Komórka w tabeli danych.

Zapis JSON 
{
  "value": string
}
Pola
value

string

Wartość komórki.

PropertyChatQuota

Limit usługi dla pól związanych z chatbotem.

Zapis JSON 
{
  "tokensPerDay": {
    object (QuotaStatus)
  },
  "tokensPerHour": {
    object (QuotaStatus)
  }
}
Pola
tokensPerDay

object (QuotaStatus)

properties.chat wykorzystane tokeny dziennie.
tokensPerHour

object (QuotaStatus)

properties.chat wykorzystane tokeny na godzinę.