Method: properties.chat

API を介して Google アナリティクス データとやり取りするためのチャット インターフェースを提供します。

このサービスは AI を使用しており、不正確な情報が表示されることがあります。チャット アクティビティはサービスの改善に使用されることがあります。サービスのご利用には Google の利用規約、生成 AI の使用禁止に関するポリシー、プライバシー ポリシーが適用されます。properties.chat AI のプライバシーに関する詳細

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
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

チャット レスポンス内の構造化データの 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.
}
フィールド
構造化データの 1 つのブロック。以下は、相互に排他的なフィールドのリストです。レスポンスで設定されるフィールドは最大で 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

chatbot 固有のフィールドのプロパティ割り当て。

JSON 表現 
{
  "tokensPerDay": {
    object (QuotaStatus)
  },
  "tokensPerHour": {
    object (QuotaStatus)
  }
}
フィールド
tokensPerDay

object (QuotaStatus)

properties.chat トークン（1 日あたり）。
tokensPerHour

object (QuotaStatus)

properties.chat トークンが 1 時間あたりに消費された数。