Method: properties.chat

ממשק צ'אט לאינטראקציה עם נתונים של Google Analytics דרך ה-API.

המוצר הזה מבוסס על AI ויכול להיות שיוצג בו מידע לא מדויק. יכול להיות שנשתמש בשיחות שלכם בצ'אט כדי לשפר את המוצר, והשימוש שלכם במוצר כפוף לתנאים, למדיניות בנושא שימוש אסור ב-AI ולמדיניות הפרטיות של Google. מידע נוסף על פרטיות בצ'אט עם 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, התשובה תכלול את המצב הנוכחי של המכסה של נכס Analytics הזה. המכסה מוחזרת ב-PropertyChatQuota.
sessionId

string

אופציונלי. כדי להמשיך שיחה קיימת ולשמור על ההקשר, צריך לספק את מזהה הסשן הזה. אם השדה הזה ריק או לא מוגדר, נוצרת שיחת צ'אט חדשה. מזהי סשן לא תקינים יגרמו לשגיאה.

גוף התשובה

הודעת התגובה לשיטה properties.chat.

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:

ייצוג JSON 
{
  "sessionId": string,
  "blocks": [
    {
      object (ResponseBlock)
    }
  ],
  "propertyQuota": {
    object (PropertyChatQuota)
  }
}
שדות
sessionId

string

המזהה הייחודי של סשן הצ'אט הזה. כדי לשמור על ההקשר של השיחה, צריך לציין את המזהה הזה בבקשות הבאות.
blocks[]

object (ResponseBlock)

בלוקי התשובות שמרכיבים את תשובת הצ'אט. זה יכול לכלול טקסט, טבלאות ורשימות.
propertyQuota

object (PropertyChatQuota)

מצב המכסה של נכס Analytics הזה, כולל הבקשה הזו.

היקפי הרשאות

נדרש היקף ההרשאות הבא של 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)

טוקנים של נכסים ב-Chat שנצרכו ביום.
tokensPerHour

object (QuotaStatus)

properties.chat tokens consumed per hour.