REST Resource: brands.agents

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

बातचीत वाली ऐसी इकाई जो किसी ब्रैंड का प्रतिनिधित्व करती हो.

JSON के काेड में दिखाना 
{
  "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 के एजेंट की खास जानकारी.

JSON के काेड में दिखाना 
{
  "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))

ज़रूरी है. एजेंट के लिए बातचीत की सेटिंग, जिसे स्थान-भाषा के हिसाब से मैप किया गया हो. स्थान-भाषा को सही तरीके से बनाए गए IETF 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

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

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

enum (EntryPoint)

ज़रूरी है. Google वह प्लैटफ़ॉर्म दिखाता है जिस पर एजेंट दिखता है.

EntryPoint

Google वह प्लैटफ़ॉर्म दिखाता है जिस पर एजेंट दिखता है.

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

SupportedAgentInteraction

ऐसी बातचीत जो किसी एजेंट की मदद से काम करती है.

JSON के काेड में दिखाना 
{
  "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

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

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

object (MessagingAvailability)

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

MessagingAvailability

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

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

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

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

object (Hours)

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

आवर्स

इस अवधि के दौरान मैसेज सेवा उपलब्ध रहती है.

JSON के काेड में दिखाना 
{
  "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 हैं.

JSON के काेड में दिखाना 
{
  "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,99,999 के बीच होना चाहिए.

DayOfWeek

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

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

HumanRepresentative

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

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

object (MessagingAvailability)

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

AuthorizationConfig

Business Messages पर OAuth की सुविधा के साथ काम करने के लिए, कॉन्फ़िगरेशन की जानकारी.

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

string

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

NonLocalConfig

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

JSON के काेड में दिखाना 
{
  "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

मैसेज सेवा बटन के साथ दिखने वाली संपर्क जानकारी.

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

string

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

enum (Option)

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

विकल्प

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

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

SurveyConfig

कस्टमाइज़ किए गए सर्वे के सवालों से जुड़ी सहायता के लिए, कॉन्फ़िगरेशन की जानकारी.

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

string

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

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

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

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

CustomSurveyConfig

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

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

object (SurveyQuestion)

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

SurveyQuestion

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

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

string

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

enum (Type)

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

string

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

object (SurveyResponse)

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

टाइप

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

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

SurveyResponse

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

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

string

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

string

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

तरीके

create

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

delete

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

get

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

getLaunch

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

getVerification

 किसी एजेंट की पुष्टि की जानकारी फ़ेच करता है.

list

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

patch

 इससे किसी एजेंट की जानकारी अपडेट होती है.

requestLaunch

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

requestVerification

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

updateLaunch

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

updateVerification

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