Method: properties.chat

یک رابط چت برای تعامل با داده‌های گوگل آنالیتیکس از طریق API فراهم می‌کند.

این محصول از هوش مصنوعی استفاده می‌کند و ممکن است اطلاعات نادرستی را نمایش دهد. فعالیت چت شما ممکن است برای بهبود محصول استفاده شود و استفاده شما تابع شرایط ، سیاست استفاده از هوش مصنوعی و سیاست حفظ حریم خصوصی گوگل است. درباره حریم خصوصی هوش مصنوعی properties.chat بیشتر بدانید .

درخواست HTTP

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

این URL از سینتکس Transcoding در gRPC استفاده می‌کند.

پارامترهای مسیر

پارامترها
property

string

الزامی. ویژگی مورد نظر برای گفتگو. فرمت: properties/{property}

درخواست بدنه

بدنه درخواست شامل داده‌هایی با ساختار زیر است:

نمایش JSON 
{
  "userQuery": string,
  "returnPropertyQuota": boolean,
  "sessionId": string
}
فیلدها
userQuery

string

الزامی. درخواست کاربر.

returnPropertyQuota

boolean

اختیاری. اگر مقدار آن درست باشد، پاسخ شامل وضعیت فعلی سهمیه این ویژگی تحلیلی خواهد بود. سهمیه در PropertyChatQuota برگردانده می‌شود.

sessionId

string

اختیاری. این شناسه جلسه را برای ادامه مکالمه موجود و حفظ زمینه ارائه دهید. اگر این فیلد خالی یا تنظیم نشده باشد، یک جلسه چت جدید ایجاد می‌شود. شناسه‌های جلسه نامعتبر منجر به خطا می‌شوند.

بدنه پاسخ

پیام پاسخ برای متد properties.chat.

در صورت موفقیت، بدنه پاسخ شامل داده‌هایی با ساختار زیر است:

نمایش JSON 
{
  "sessionId": string,
  "blocks": [
    {
      object (ResponseBlock)
    }
  ],
  "propertyQuota": {
    object (PropertyChatQuota)
  }
}
فیلدها
sessionId

string

شناسه منحصر به فرد برای این جلسه چت. این شناسه را در درخواست‌های بعدی برای حفظ زمینه مکالمه ارائه دهید.

blocks[]

object ( ResponseBlock )

بلوک‌های پاسخ که پاسخ چت را تشکیل می‌دهند. این می‌تواند شامل متن، جداول و لیست‌ها باشد.

propertyQuota

object ( PropertyChatQuota )

وضعیت سهمیه این Analytics Property شامل این درخواست می‌شود.

دامنه‌های مجوز

به محدوده OAuth زیر نیاز دارد:

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

پاسخ بلاک

یک بلوک از داده‌های ساختاریافته در پاسخ چت.

نمایش 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 )

یک بلوک از داده‌های جدول.

پایان میدان‌های ناسازگار.

جدول داده

جدولی از داده‌ها.

نمایش JSON 
{
  "headers": [
    {
      object (DataTableHeader)
    }
  ],
  "rows": [
    {
      object (DataTableRow)
    }
  ]
}
فیلدها
headers[]

object ( DataTableHeader )

ستون‌های ابعاد را توصیف می‌کند. تعداد سرصفحه‌ها و ترتیب سرصفحه‌ها با ابعاد موجود در ردیف‌ها مطابقت دارد.

rows[]

object ( DataTableRow )

ردیف‌هایی از ترکیبات مقادیر بُعد و مقادیر متریک در گزارش.

هدر جدول داده

یک عنوان ستون را در یک DataTable توصیف می‌کند.

نمایش JSON 
{
  "header": string,
  "dataType": string
}
فیلدها
header

string

نام سربرگ.

dataType

string

نوع داده.

ردیف جدول داده

یک ردیف در یک DataTable.

نمایش JSON 
{
  "columns": [
    {
      object (DataTableCell)
    }
  ]
}
فیلدها
columns[]

object ( DataTableCell )

مقادیر سلول در ردیف.

سلول جدول داده

یک سلول در یک جدول داده.

نمایش JSON 
{
  "value": string
}
فیلدها
value

string

ارزش سلول.

PropertyChatQuota

سهمیه املاک برای فیلدهای خاص چت‌بات.

نمایش JSON 
{
  "tokensPerDay": {
    object (QuotaStatus)
  },
  "tokensPerHour": {
    object (QuotaStatus)
  }
}
فیلدها
tokensPerDay

object ( QuotaStatus )

توکن‌های properties.chat که در روز مصرف می‌شوند.

tokensPerHour

object ( QuotaStatus )

توکن‌های properties.chat که در هر ساعت مصرف می‌شوند.