Method: properties.chat

API를 통해 Google 애널리틱스 데이터와 상호작용하기 위한 채팅 인터페이스를 제공합니다.

이 제품은 AI를 사용하며 부정확한 정보가 표시될 수 있습니다. 채팅 활동은 제품 개선에 사용될 수 있으며, 사용 시 Google 약관, AI 사용 정책, 개인정보처리방침이 적용됩니다. properties.chat 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

선택사항입니다. true인 경우 응답에 이 애널리틱스 속성의 현재 할당량이 포함됩니다. 할당량은 PropertyChatQuota에 반환됩니다.

sessionId

string

선택사항입니다. 기존 대화를 계속하고 컨텍스트를 유지하려면 이 세션 ID를 제공하세요. 이 필드가 비어 있거나 설정되지 않은 경우 새 채팅 세션이 생성됩니다. 세션 ID가 잘못되면 오류가 발생합니다.

응답 본문

properties.chat 메서드에 대한 응답 메시지입니다.

성공한 경우 응답 본문은 다음과 같은 구조의 데이터를 포함합니다.

JSON 표현
{
  "sessionId": string,
  "blocks": [
    {
      object (ResponseBlock)
    }
  ],
  "propertyQuota": {
    object (PropertyChatQuota)
  }
}
필드
sessionId

string

이 채팅 세션의 고유 식별자입니다. 대화 컨텍스트를 유지하려면 후속 요청에서 이 ID를 제공하세요.

blocks[]

object (ResponseBlock)

채팅 응답을 구성하는 응답 블록입니다. 여기에는 텍스트, 표, 목록이 포함될 수 있습니다.

propertyQuota

object (PropertyChatQuota)

이 요청을 포함한 애널리틱스 속성의 할당량 상태입니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

ResponseBlock

채팅 응답의 구조화된 데이터 블록 하나입니다.

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.
}
필드
구조화된 데이터의 한 블록입니다. 다음은 상호 배타적인 필드 목록입니다. 응답에는 다음 필드 중 최대 하나가 설정됩니다.
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)

시간당 사용된 properties.chat 토큰입니다.