AppRequest

AppRequest एक अनुरोध है, जो Google Assistant कार्रवाई को पूरा करने के लिए भेजता है. एपीआई वर्शन की जानकारी, एचटीटीपी हेडर में दी गई है. एपीआई वर्शन 1 के लिए, हेडर में यह शामिल है: Google-Assistant-API-Version: v1. एपीआई वर्शन 2 के लिए, हेडर में यह शामिल है: Google-actions-API-Version: 2. Google पर कार्रवाइयों में इसका इस्तेमाल कैसे किया जाता है, इसके उदाहरण देखने के लिए, https://developers.google.com/assistant/df-asdk/reference/conversation-webhook-json पर जाएं .

जेएसओएन के काेड में दिखाना
{
  "user": {
    object (User)
  },
  "device": {
    object (Device)
  },
  "surface": {
    object (Surface)
  },
  "conversation": {
    object (Conversation)
  },
  "inputs": [
    {
      object (Input)
    }
  ],
  "isInSandbox": boolean,
  "availableSurfaces": [
    {
      object (Surface)
    }
  ]
}
फ़ील्ड
user

object (User)

बातचीत शुरू करने वाले उपयोगकर्ता.

device

object (Device)

कार्रवाई से इंटरैक्ट करने के लिए, उपयोगकर्ता जिस डिवाइस का इस्तेमाल कर रहा है उसकी जानकारी.

surface

object (Surface)

उपयोगकर्ता जिस प्लैटफ़ॉर्म से इंटरैक्ट कर रहा है उसके बारे में जानकारी. जैसे, क्या उस डिवाइस में ऑडियो आउटपुट हो सकता है या स्क्रीन है.

conversation

object (Conversation)

इसमें बातचीत का आईडी और बातचीत का टोकन जैसा सेशन डेटा होता है.

inputs[]

object (Input)

कार्रवाई में बताए गए अनुमानित इनपुट के हिसाब से इनपुट की सूची. शुरुआती बातचीत को ट्रिगर करने के लिए, इनपुट में यह जानकारी शामिल होती है कि उपयोगकर्ता ने बातचीत को कैसे ट्रिगर किया है.

isInSandbox

boolean

इससे यह पता चलता है कि अनुरोध को सैंडबॉक्स मोड में हैंडल किया जाना चाहिए या नहीं.

availableSurfaces[]

object (Surface)

क्रॉस सरफ़ेस हैंडऑफ़ के लिए उपलब्ध प्लैटफ़ॉर्म.

उपयोगकर्ता

जेएसओएन के काेड में दिखाना
{
  "idToken": string,
  "profile": {
    object (UserProfile)
  },
  "accessToken": string,
  "permissions": [
    enum (Permission)
  ],
  "locale": string,
  "lastSeen": string,
  "userStorage": string,
  "packageEntitlements": [
    {
      object (PackageEntitlement)
    }
  ],
  "userVerificationStatus": enum (UserVerificationStatus)
}
फ़ील्ड
idToken

string

उपयोगकर्ता की पहचान दिखाने वाला टोकन. यह JSON वेब टोकन है, जिसमें कोड में बदली गई प्रोफ़ाइल शामिल है. इसकी परिभाषा https://developers.google.com/identity/protocols/OpenIDConnect#obtainuserinfo पर दी गई है.

profile

object (UserProfile)

असली उपयोगकर्ता के बारे में जानकारी. कुछ फ़ील्ड सिर्फ़ तब उपलब्ध होते हैं, जब उपयोगकर्ता ने कार्रवाई के लिए यह जानकारी देने की अनुमति दी हो.

accessToken

string

OAuth2 टोकन, जो आपके सिस्टम में उपयोगकर्ता की पहचान करता है. यह सिर्फ़ तब उपलब्ध होता है, जब उपयोगकर्ता अपना खाता लिंक करता है.

permissions[]

enum (Permission)

इसमें वे अनुमतियां शामिल हैं जो उपयोगकर्ता ने इस कार्रवाई के लिए दी हैं.

locale

string

अनुरोध करने वाले उपयोगकर्ता की मुख्य स्थान-भाषा सेटिंग. यह IETF BCP-47 भाषा कोड http://www.rfc-editor.org/rfc/bcp/bcp47.txt में लागू होते हैं. हालांकि, स्क्रिप्ट सबटैग शामिल नहीं किया जाता है.

lastSeen

string (Timestamp format)

इस उपयोगकर्ता के साथ आखिरी इंटरैक्शन का टाइमस्टैंप. अगर उपयोगकर्ता ने पहले कभी एजेंट से बातचीत नहीं की है, तो इस फ़ील्ड को खाली छोड़ा जाएगा.

आरएफ़सी3339 यूटीसी के "Zulu" फ़ॉर्मैट में एक टाइमस्टैंप, नैनोसेकंड तक सटीक होता है. उदाहरण: "2014-10-02T15:01:23.045123456Z".

userStorage

string

ऐप्लिकेशन से मिलने वाला ओपेक टोकन, जो किसी खास उपयोगकर्ता की बातचीत में बना रहता है. स्ट्रिंग का साइज़ ज़्यादा से ज़्यादा 10 हज़ार वर्ण हो सकता है.

packageEntitlements[]

object (PackageEntitlement)

अगर कार्रवाई पैकेज में कोई पैकेज का नाम मौजूद है, तो हर पैकेज के नाम के लिए उपयोगकर्ता के एनटाइटलमेंट की सूची.

userVerificationStatus

enum (UserVerificationStatus)

उपयोगकर्ता की पुष्टि की स्थिति को दिखाता है.

UserProfile

इसमें उपयोगकर्ता की निजी जानकारी शामिल होती है. फ़ील्ड सिर्फ़ तब भरे जाते हैं, जब उपयोगकर्ता किसी खास फ़ील्ड के लिए कार्रवाई की अनुमति देता है.

जेएसओएन के काेड में दिखाना
{
  "displayName": string,
  "givenName": string,
  "familyName": string
}
फ़ील्ड
displayName

string

उपयोगकर्ता का पूरा नाम, जैसा कि उसके Google खाते में बताया गया है. NAME की अनुमति ज़रूरी है.

givenName

string

उपयोगकर्ता का Google खाते में बताया गया नाम. NAME की अनुमति ज़रूरी है.

familyName

string

उपयोगकर्ता का Google खाते में बताया गया उपनाम. ध्यान दें कि यह फ़ील्ड खाली हो सकता है. NAME की अनुमति ज़रूरी है.

PackageEntitlement

पैकेज के नाम से जुड़े एनटाइटलमेंट की सूची

जेएसओएन के काेड में दिखाना
{
  "packageName": string,
  "entitlements": [
    {
      object (Entitlement)
    }
  ]
}
फ़ील्ड
packageName

string

सेट की गई कार्रवाई के पैकेज में मौजूद पैकेज के नाम से मेल खाना चाहिए

entitlements[]

object (Entitlement)

किसी ऐप्लिकेशन के एनटाइटलमेंट की सूची

पात्रता

उपयोगकर्ता के डिजिटल एनटाइटलमेंट के बारे में जानकारी देता है. संभावित एनटाइटलमेंट के टाइप: पैसे चुकाकर डाउनलोड किए जाने वाले ऐप्लिकेशन,इन-ऐप्लिकेशन खरीदारी, इन-ऐप्लिकेशन सदस्यताएं.

जेएसओएन के काेड में दिखाना
{
  "sku": string,
  "skuType": enum (SkuType),
  "inAppDetails": {
    object (SignedData)
  }
}
फ़ील्ड
sku

string

प्रॉडक्ट sku. पैसे चुकाकर डाउनलोड किए जाने वाले ऐप्लिकेशन के पैकेज का नाम, इन-ऐप्लिकेशन खरीदारी और इन-ऐप्लिकेशन सदस्यता के लिए Finsky DoCID का सफ़िक्स. Play InApp Billing API में getSku() मैच करें.

skuType

enum (SkuType)

inAppDetails

object (SignedData)

यह ऑफ़र सिर्फ़ इन-ऐप्लिकेशन खरीदारी और इन-ऐप्लिकेशन सदस्यों के लिए उपलब्ध है.

SignedData

जेएसओएन के काेड में दिखाना
{
  "inAppPurchaseData": {
    object
  },
  "inAppDataSignature": string
}
फ़ील्ड
inAppPurchaseData

object (Struct format)

getPurchases() तरीके से, INAPP_PURCHASE_DATA का मिलान करें. इसमें JSON फ़ॉर्मैट में, इन-ऐप्लिकेशन खरीदारी का सारा डेटा शामिल है. इसकी जानकारी https://developer.android.com/google/play/billing/billing_reference.html की छठी टेबल में देखें.

inAppDataSignature

string

यह Play InApp Billing API में getPurchases() तरीके से, IN_APP_DATA_SIGNATURE से मेल खाता है.

डिवाइस

कार्रवाई से इंटरैक्ट करने के लिए, उपयोगकर्ता जिस डिवाइस का इस्तेमाल कर रहा है उसकी जानकारी.

जेएसओएन के काेड में दिखाना
{
  "location": {
    object (Location)
  }
}
फ़ील्ड
location

object (Location)

डिवाइस की असल जगह की जानकारी दिखाता है. जैसे, अक्षांश, देशांतर, और फ़ॉर्मैट किया गया पता. DEVICE_COARSE_LOCATION या DEVICE_PRECISE_LOCATION की अनुमति ज़रूरी है.

प्लैटफ़ॉर्म

उस Google Assistant क्लाइंट की खास जानकारी जिससे उपयोगकर्ता इंटरैक्ट कर रहा है. Surface को डिवाइस से इस तरह अलग किया जाता है कि एक ही डिवाइस पर, Assistant के एक से ज़्यादा प्लैटफ़ॉर्म लाइव हो सकते हैं.

जेएसओएन के काेड में दिखाना
{
  "capabilities": [
    {
      object (Capability)
    }
  ]
}
फ़ील्ड
capabilities[]

object (Capability)

अनुरोध करते समय, प्लैटफ़ॉर्म पर जिन सुविधाओं का इस्तेमाल किया जा सकता है उनकी सूची. उदाहरण के लिए, actions.capability.AUDIO_OUTPUT

अनुमति

फ़ंक्शन की उस इकाई के बारे में बताता है जो प्लैटफ़ॉर्म पर काम करता है.

जेएसओएन के काेड में दिखाना
{
  "name": string
}
फ़ील्ड
name

string

क्षमता का नाम, जैसे कि actions.capability.AUDIO_OUTPUT

दर्शकों से बातचीत करें

जेएसओएन के काेड में दिखाना
{
  "conversationId": string,
  "type": enum (ConversationType),
  "conversationToken": string
}
फ़ील्ड
conversationId

string

कई मोड़ होने वाली बातचीत के लिए यूनीक आईडी. इसे पहले मोड़ के लिए असाइन किया गया है. इसके बाद, यह बातचीत तब तक नहीं बदलती, जब तक बातचीत खत्म नहीं हो जाती.

type

enum (ConversationType)

टाइप, बातचीत की लाइफ़साइकल में उसकी स्थिति के बारे में बताता है.

conversationToken

string

बातचीत की आखिरी बारी में, सेट की गई कार्रवाई में ओपेक टोकन मौजूद है. किसी कार्रवाई में, बातचीत को ट्रैक करने या बातचीत का डेटा सेव करने के लिए, इसका इस्तेमाल किया जा सकता है.

इनपुट

जेएसओएन के काेड में दिखाना
{
  "rawInputs": [
    {
      object (RawInput)
    }
  ],
  "intent": string,
  "arguments": [
    {
      object (Argument)
    }
  ]
}
फ़ील्ड
rawInputs[]

object (RawInput)

बातचीत के हर मोड़ से जुड़ा रॉ इनपुट ट्रांसक्रिप्शन. कार्रवाई के लिए कुछ इनपुट देने के लिए, Google पर होने वाली कार्रवाइयों के लिए बातचीत के एक से ज़्यादा टर्न की ज़रूरत हो सकती है.

intent

string

उपयोगकर्ता का मकसद दिखाता है. बातचीत की पहली बारी में, कार्रवाई के लिए इंटेंट को ट्रिगर किया जाएगा. बाद में होने वाली बातचीत के लिए, इंटेंट, Google इंटेंट पर सामान्य कार्रवाइयां होंगी (जो 'actions.' से शुरू होती है). उदाहरण के लिए, अगर अनुमानित इनपुट actions.intent.OPTION है, तो यहां बताया गया इंटेंट actions.intent.OPTION होगा, अगर Google Assistant उस इंटेंट को पूरा कर लेती है. अगर उपयोगकर्ता ने अन्य जानकारी दी है, तो actions.intent.TEXT होगा. https://developers.google.com/assistant/df-asdk/reference/intents देखें.

arguments[]

object (Argument)

कार्रवाई के ज़रिए अनुरोध किए गए इनपुट के लिए दी गई आर्ग्युमेंट वैल्यू की सूची.

RawInput

जेएसओएन के काेड में दिखाना
{
  "inputType": enum (InputType),

  // Union field input can be only one of the following:
  "query": string,
  "url": string
  // End of list of possible types for union field input.
}
फ़ील्ड
inputType

enum (InputType)

इससे पता चलता है कि उपयोगकर्ता ने यह इनपुट कैसे दिया: टाइप किया गया जवाब, बोलकर दिया जाने वाला जवाब, जानकारी नहीं दी गई वगैरह.

यूनियन फ़ील्ड input. असल इनपुट वैल्यू input इनमें से सिर्फ़ एक हो सकती है:
query

string

असली उपयोगकर्ता की ओर से टाइप किया गया या बोला गया इनपुट.

url

string

ट्रिगर करने वाला यूआरएल.