REST Resource: brands.agents

संसाधन: एजेंट

बातचीत वाली इकाई जो किसी ब्रैंड के बारे में बताती है.

जेएसओएन के काेड में दिखाना 
{
  "name": string,
  "displayName": string,

  // Union field detail_info can be only one of the following:
  "businessMessagesAgent": {
    object (BusinessMessagesAgent)
  }
  // End of list of possible types for union field detail_info.
}
फ़ील्ड
name

string

एजेंट का यूनीक आइडेंटिफ़ायर.

सिर्फ़ पढ़ने के लिए. प्लैटफ़ॉर्म से तय होता है.
displayName

string

ज़रूरी है. वह नाम जो एजेंट लोगों को दिखाता है. ज़्यादा से ज़्यादा 100 वर्ण.

एजेंट की पुष्टि होने के बाद, इसमें बदलाव नहीं किया जा सकता.

यूनियन फ़ील्ड detail_info. इसमें किसी खास प्रॉडक्ट के लिए ज़रूरी फ़ील्ड शामिल होते हैं.

ज़रूरी है. detail_info इनमें से सिर्फ़ एक हो सकता है:
businessMessagesAgent

object (BusinessMessagesAgent)

Business Messages के लिए एजेंट की ज़्यादा जानकारी.

BusinessMessagesAgent

Business Messages के लिए, एजेंट की खास जानकारी.

जेएसओएन के काेड में दिखाना 
{
  "logoUrl": string,
  "entryPointConfigs": [
    {
      object (BusinessMessagesEntryPointConfig)
    }
  ],
  "conversationalSettings": {
    string: {
      object (ConversationalSetting)
    },
    ...
  },
  "defaultLocale": string,
  "primaryAgentInteraction": {
    object (SupportedAgentInteraction)
  },
  "additionalAgentInteractions": [
    {
      object (SupportedAgentInteraction)
    }
  ],
  "customAgentId": string,
  "agentTestUrl": string,
  "testUrls": [
    {
      object (TestUrl)
    }
  ],
  "phone": {
    object (Phone)
  },
  "authorizationConfig": {
    object (AuthorizationConfig)
  },
  "nonLocalConfig": {
    object (NonLocalConfig)
  },
  "surveyConfig": {
    object (SurveyConfig)
  }
}
फ़ील्ड
logoUrl

string

ज़रूरी नहीं. एजेंट के लोगो का यूआरएल, जो सार्वजनिक तौर पर उपलब्ध हो. ज़्यादा से ज़्यादा 50 केबी.

एजेंट की पुष्टि होने के बाद, इसमें बदलाव नहीं किया जा सकता.
entryPointConfigs[]

object (BusinessMessagesEntryPointConfig)

ज़रूरी नहीं. एंट्री पॉइंट कॉन्फ़िगरेशन की सूची.

एजेंट की पुष्टि होने के बाद, इसमें बदलाव नहीं किया जा सकता.
conversationalSettings

map (key: string, value: object (ConversationalSetting))

ज़रूरी है. एजेंट के लिए बातचीत की सेटिंग, जिसे स्थान-भाषा के मुताबिक मैप किया गया है. स्थान-भाषा को अच्छी तरह से बनाए गए आईईटीएफ़ BCP 47 भाषा टैग से दिखाया जाता है.

एक ऑब्जेक्ट जिसमें "key": value पेयर की सूची है. उदाहरण: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
defaultLocale

string

ज़रूरी है. एजेंट की डिफ़ॉल्ट स्थान-भाषा. conversationalSettings में दी गई स्थान-भाषा से मेल खाना चाहिए.
primaryAgentInteraction

object (SupportedAgentInteraction)

ज़रूरी है. मुख्य एजेंट के इंटरैक्शन की जानकारी. इसका इस्तेमाल तब किया जाता है, जब उपयोगकर्ता बातचीत शुरू करता है.
additionalAgentInteractions[]

object (SupportedAgentInteraction)

ज़रूरी नहीं. एजेंट के इंटरैक्शन की अन्य जानकारी. इस एजेंट को एक से ज़्यादा तरह के इंटरैक्शन का इस्तेमाल करने की अनुमति मिलती है.
customAgentId

string

ज़रूरी नहीं. एजेंट के लिए पार्टनर का तय किया गया आइडेंटिफ़ायर. आइडेंटिफ़ायर को एजेंट को भेजे गए सभी मैसेज के साथ भेजा जाता है.
agentTestUrl
(deprecated)

string

सिर्फ़ आउटपुट के लिए. एजेंट से बातचीत करने के अनुभव की जांच करने के लिए यूआरएल.

प्लैटफ़ॉर्म से तय होता है.
testUrls[]

object (TestUrl)

सिर्फ़ आउटपुट के लिए. एजेंट के बातचीत करने के अनुभव की जांच करने के लिए, यूआरएल.

प्लैटफ़ॉर्म से तय होता है.
phone

object (Phone)

ज़रूरी नहीं. एजेंट के लिए दिखाया जाने वाला फ़ोन नंबर. अगर जानकारी नहीं दी जाती है, तो एजेंट Google नॉलेज ग्राफ़ में मौजूद ब्रैंड का फ़ोन नंबर दिखाता है.
authorizationConfig

object (AuthorizationConfig)

ज़रूरी नहीं. OAuth सपोर्ट के लिए ऑथराइज़ेशन कॉन्फ़िगरेशन.
nonLocalConfig

object (NonLocalConfig)

ज़रूरी नहीं. गैर-स्थानीय एंट्री पॉइंट के लिए कॉन्फ़िगरेशन.
surveyConfig

object (SurveyConfig)

ज़रूरी नहीं. कस्टम सर्वे चालू करने के लिए कॉन्फ़िगरेशन.

BusinessMessagesEntryPointConfig

एजेंट के लिए एंट्री पॉइंट कॉन्फ़िगरेशन.

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

enum (EntryPoint)

ज़रूरी है. Google, उन प्लैटफ़ॉर्म को दिखाता है जिन पर एजेंट को दिखाने की सुविधा चालू है.

EntryPoint

Google, उन प्लैटफ़ॉर्म को दिखाता है जिन पर एजेंट को दिखाने की सुविधा चालू है.

Enums
ENTRY_POINT_UNSPECIFIED एंट्री पॉइंट की जानकारी नहीं है.
LOCATION इस एजेंट के लिए जगह की जानकारी की सुविधा चालू करें.
NON_LOCAL गैर-स्थानीय एंट्री पॉइंट के लिए, Business Messages की सुविधा चालू करें.

SupportedAgentInteraction

किसी एजेंट की ओर से समर्थित इंटरैक्शन.

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

  // Union field representative can be only one of the following:
  "botRepresentative": {
    object (BotRepresentative)
  },
  "humanRepresentative": {
    object (HumanRepresentative)
  }
  // End of list of possible types for union field representative.
}
फ़ील्ड
interactionType

enum (InteractionType)

ज़रूरी है. एजेंट किस तरह का इंटरैक्शन कर सकता है.
यूनियन फ़ील्ड representative. कॉन्फ़िगरेशन टाइप के बारे में ज़्यादा जानकारी. ज़रूरी है. representative इनमें से सिर्फ़ एक हो सकता है:
botRepresentative

object (BotRepresentative)

बॉट प्रतिनिधि की जानकारी.
humanRepresentative

object (HumanRepresentative)

मानव प्रतिनिधि की जानकारी.

InteractionType

एजेंट के लिए काम करने वाला इंटरैक्शन.

Enums
INTERACTION_TYPE_UNSPECIFIED ऐसा इंटरैक्शन जिसकी जानकारी नहीं है.
BOT बॉट इंटरैक्शन.
HUMAN मानवीय इंटरैक्शन.

BotRepresentative

बॉट प्रतिनिधि की जानकारी.

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

object (MessagingAvailability)

ज़रूरी है. बॉट मैसेज सेवा की उपलब्धता.

MessagingAvailability

हफ़्ते के हर उस दिन के घंटे जब मैसेज सेवा उपलब्ध है. एक साथ कई दिनों के लिए, कारोबार के खुले होने का समय एक साथ रखा जा सकता है. उदाहरण के लिए, * 08:00–16:00 बजे पीडीटी सोमवार से बुधवार * 10:00–14:00 बजे पीडीटी गुरुवार–शुक्रवार * 15:00–18:00 बजे पीडीटी गुरुवार से शुक्रवार * 10:00–14:00 बजे पीडीटी शनिवार–शनिवार

अगर खरीदारी के लिए उपलब्धता में कोई अंतर है, जैसे कि रविवार को कोई खास उपलब्धता नहीं बताई गई है, तो उस दौरान मैसेज सेवा उपलब्ध नहीं होगी.

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

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

object (Hours)

ज़रूरी है. मैसेज सेवा की उपलब्धता के घंटे.

आवर्स

मैसेज की सुविधा उपलब्ध रहने के घंटों की सीमा.

जेएसओएन के काेड में दिखाना 
{
  "startTime": {
    object (TimeOfDay)
  },
  "endTime": {
    object (TimeOfDay)
  },
  "timeZone": string,
  "startDay": enum (DayOfWeek),
  "endDay": enum (DayOfWeek)
}
फ़ील्ड
startTime

object (TimeOfDay)

ज़रूरी है. हफ़्ते के दिन की सीमा के अंदर, हर दिन का शुरू होने का समय.
endTime

object (TimeOfDay)

ज़रूरी है. हफ़्ते के दिन की सीमा के अंदर, हर दिन के लिए खत्म होने का समय.
timeZone

string

ज़रूरी है. घंटों के लिए, IANA का टाइम ज़ोन. उदाहरण के लिए, "America/Los_Angeles".
startDay

enum (DayOfWeek)

ज़रूरी है. शुरू होने का दिन.
endDay

enum (DayOfWeek)

ज़रूरी है. खत्म होने का दिन. इसमें, बताया गया दिन शामिल है.

TimeOfDay

दिन का कोई समय दिखाता है. तारीख और टाइम ज़ोन या तो अहम नहीं हैं या कहीं और बताए गए हैं. एपीआई लीप सेकंड की अनुमति दे सकता है. मिलते-जुलते टाइप google.type.Date और google.protobuf.Timestamp हैं.

जेएसओएन के काेड में दिखाना 
{
  "hours": integer,
  "minutes": integer,
  "seconds": integer,
  "nanos": integer
}
फ़ील्ड
hours

integer

24 घंटे के फ़ॉर्मैट में दिन के घंटे. यह 0 से 23 के बीच होना चाहिए. कारोबार के बंद होने के समय जैसी स्थितियों के लिए, एपीआई "24:00:00" वैल्यू की अनुमति दे सकता है.
minutes

integer

दिन के घंटे के मिनट. संख्या 0 से 59 के बीच होनी चाहिए.
seconds

integer

समय के मिनट में. आम तौर पर, यह संख्या 0 से 59 के बीच होनी चाहिए. लीप-सेकंड की अनुमति देने पर, एपीआई वैल्यू 60 की अनुमति दे सकता है.
nanos

integer

नैनोसेकंड में सेकंड के अंश. 0 से 9,99,99,999 के बीच होना चाहिए.

DayOfWeek

हफ़्ते का कोई दिन दिखाता है.

Enums
DAY_OF_WEEK_UNSPECIFIED हफ़्ते का दिन नहीं बताया गया है.
MONDAY सोमवार
TUESDAY मंगलवार
WEDNESDAY बुधवार
THURSDAY गुरुवार
FRIDAY शुक्रवार
SATURDAY शनिवार
SUNDAY रविवार

HumanRepresentative

मानव प्रतिनिधि के लिए जानकारी.

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

object (MessagingAvailability)

ज़रूरी है. लोगों को मैसेज भेजने की सुविधा की उपलब्धता.

AuthorizationConfig

Business Messages पर OAuth के साथ काम करने से जुड़े कॉन्फ़िगरेशन की जानकारी.

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

string

वह एंडपॉइंट यूआरएल जहां उपयोगकर्ता लॉग इन करता है.

NonLocalConfig

गैर-स्थानीय एंट्री पॉइंट चालू करने के लिए कॉन्फ़िगरेशन.

जेएसओएन के काेड में दिखाना 
{
  "contactOption": {
    object (ContactOption)
  },
  "enabledDomains": [
    string
  ],
  "phoneNumber": {
    object (Phone)
  },
  "callDeflectionPhoneNumbers": [
    {
      object (Phone)
    }
  ],
  "regionCodes": [
    string
  ]
}
फ़ील्ड
contactOption

object (ContactOption)

ज़रूरी है. मैसेज सेवा के बटन के साथ दिखने वाले एजेंट की संपर्क जानकारी.
enabledDomains[]

string

ज़रूरी है. साइटलिंक के एंट्री पॉइंट के लिए चालू किए जाने वाले डोमेन.
phoneNumber

object (Phone)

ज़रूरी है. एजेंट का फ़ोन नंबर. गैर-स्थानीय एंट्री पॉइंट से शुरू होने वाली बातचीत के लिए, phone फ़ील्ड को बदल देता है. इस फ़ोन नंबर का इस्तेमाल, कॉन्फ़िगर किए गए सभी क्षेत्रों के लिए किया जाएगा.
callDeflectionPhoneNumbers[]

object (Phone)

ज़रूरी है. कॉल डिफ़्लेक्शन के लिए फ़ोन नंबरों की सूची.
regionCodes[]

string

ज़रूरी है. उन देशों के लिए CLDR क्षेत्र कोड की सूची जहां एजेंट को NON_LOCAL एंट्री पॉइंट लॉन्च करने की अनुमति है. NON_LOCAL एंट्री पॉइंट के लिए ज़रूरी है.

ContactOption

मैसेज सेवा बटन के साथ-साथ, संपर्क की जानकारी भी दिखाई जाती है.

जेएसओएन के काेड में दिखाना 
{
  "url": string,
  "options": [
    enum (Option)
  ]
}
फ़ील्ड
url

string

ज़रूरी है. वह यूआरएल जिसके लिए संपर्क के विकल्प उपलब्ध हैं.
options[]

enum (Option)

ज़रूरी है. दिए गए यूआरएल के लिए उपलब्ध संपर्क विकल्पों की सूची.

विकल्प

संपर्क करने के विकल्प.

Enums
OPTION_UNSPECIFIED सेट नहीं है
WEB_CHAT वेब चैट का विकल्प.
PHONE फ़ोन का विकल्प.
EMAIL ईमेल का विकल्प.
FAQS अक्सर पूछे जाने वाले सवालों का विकल्प.
TWITTER Twitter का विकल्प.
WHATSAPP WhatsApp का विकल्प.

SurveyConfig

पसंद के मुताबिक बनाए गए सर्वे के सवालों के लिए कॉन्फ़िगरेशन की जानकारी.

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

string

सर्वे में शामिल किए गए टेंप्लेट से जुड़े सवालों के आईडी की सूची.
customSurveys

map (key: string, value: object (CustomSurveyConfig))

एजेंट के लिए, पसंद के मुताबिक सर्वे के सवाल, जो स्थान-भाषा के हिसाब से मैप किए गए हों. स्थान-भाषा को अच्छी तरह से बनाए गए आईईटीएफ़ BCP 47 भाषा टैग से दिखाया जाता है.

एक ऑब्जेक्ट जिसमें "key": value पेयर की सूची है. उदाहरण: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

CustomSurveyConfig

एजेंट के लिए कस्टम सर्वे कॉन्फ़िगरेशन.

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

object (SurveyQuestion)

पसंद के मुताबिक सवालों की सूची.

SurveyQuestion

सर्वे के हर सवाल का पूरा कॉन्टेंट.

जेएसओएन के काेड में दिखाना 
{
  "name": string,
  "questionType": enum (Type),
  "questionContent": string,
  "responseOptions": [
    {
      object (SurveyResponse)
    }
  ]
}
फ़ील्ड
name

string

ज़रूरी है. सवाल का यूनीक आइडेंटिफ़ायर.
questionType

enum (Type)

सिर्फ़ आउटपुट के लिए. सवाल किस तरह का है.
questionContent

string

ज़रूरी है. सवाल का कॉन्टेंट. पसंद के मुताबिक सवालों के जवाब में, ज़्यादा से ज़्यादा 200 वर्ण हो सकते हैं.
responseOptions[]

object (SurveyResponse)

ज़रूरी है. सवाल के साथ दिखाए गए जवाबों की सूची. ज़्यादा से ज़्यादा 12.

Type

सर्वे के सवाल का टाइप.

Enums
TYPE_UNSPECIFIED सर्वे के सवाल का टाइप अज्ञात है.
GOOGLE_STANDARD_QUESTION Google मानक सर्वे के सवाल.
GOOGLE_TEMPLATE_QUESTION Google की ओर से दिया गया टेंप्लेट सर्वे का सवाल.
PARTNER_CUSTOM_QUESTION पार्टनर के हिसाब से बनाए गए सर्वे के सवाल.

SurveyResponse

सर्वे के सवाल के जवाब के लिए कॉन्टेंट.

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

string

ज़रूरी है. सर्वे में दिखने वाला टेक्स्ट और जब उपयोगकर्ता उस पर टैप करता है, तब उसे एजेंट को वापस भेज दिया जाता है. ज़्यादा से ज़्यादा 35 वर्ण.
postbackData

string

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

तरीके

create

 किसी ब्रैंड का प्रतिनिधित्व करने के लिए एक नया एजेंट बनाता है.

delete

 एजेंट को मिटाता है.

get

 एजेंट के बारे में जानकारी पाएं.

getLaunch

 एजेंट के लॉन्च की जानकारी देता है.

getVerification

 एजेंट की पुष्टि के लिए जानकारी देता है.

list

 किसी ब्रैंड से जुड़े सभी एजेंट की सूची बनाता है.

patch

 एजेंट के बारे में जानकारी अपडेट करता है.

requestLaunch

 एजेंट को लॉन्च करने की प्रोसेस शुरू करता है.

requestVerification

 एजेंट के लिए कारोबार की जानकारी की पुष्टि शुरू करता है.

updateLaunch

 एजेंट के लिए लॉन्च की जानकारी अपडेट करता है.

updateVerification

 एजेंट के लिए, पुष्टि की स्थिति को अपडेट करता है.