Method: properties.chat

यह एपीआई के ज़रिए Google Analytics के डेटा के साथ इंटरैक्ट करने के लिए, चैट इंटरफ़ेस उपलब्ध कराता है.

यह प्रॉडक्ट एआई का इस्तेमाल करता है. ऐसा हो सकता है कि इसमें आपको गलत जानकारी दिखे. आपकी चैट की गतिविधि का इस्तेमाल, प्रॉडक्ट को बेहतर बनाने के लिए किया जा सकता है. इस प्रॉडक्ट के इस्तेमाल पर, Google की सेवा की शर्तें, एआई के इस्तेमाल से जुड़ी नीति, और निजता नीति लागू होती है. properties.chat AI Privacy के बारे में ज़्यादा जानें.

एचटीटीपी अनुरोध

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

यह यूआरएल, gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.

पाथ पैरामीटर

पैरामीटर
property

string

ज़रूरी है. वह प्रॉपर्टी जिसके बारे में चैट करनी है. फ़ॉर्मैट: properties/{property}

अनुरोध का मुख्य भाग

अनुरोध के मुख्य हिस्से में, इस स्ट्रक्चर का डेटा शामिल होता है:

JSON के काेड में दिखाना 
{
  "userQuery": string,
  "returnPropertyQuota": boolean,
  "sessionId": string
}
फ़ील्ड
userQuery

string

ज़रूरी है. उपयोगकर्ता की क्वेरी.
returnPropertyQuota

boolean

ज़रूरी नहीं. अगर यह वैल्यू 'सही' पर सेट है, तो जवाब में इस 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)

properties.chat के लिए, हर दिन इस्तेमाल किए गए टोकन.
tokensPerHour

object (QuotaStatus)

properties.chat टोकन, हर घंटे इस्तेमाल किए जाते हैं.