REST Resource: brands.agents

리소스: 에이전트

브랜드를 나타내는 대화체입니다.

JSON 표현 
{
  "name": string,
  "displayName": string,

  // Union field detail_info can be only one of the following:
  "businessMessagesAgent": {
    object (BusinessMessagesAgent)
  },
  "rcsBusinessMessagingAgent": {
    object (RcsBusinessMessagingAgent)
  }
  // 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의 자세한 에이전트 정보입니다.
rcsBusinessMessagingAgent

object (RcsBusinessMessagingAgent)

RCS Business Messaging에 관한 자세한 상담사 정보입니다.

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

선택사항입니다. 공개적으로 사용 가능한 에이전트 로고의 URL입니다. 최대 50KB

상담사 확인 후에는 수정할 수 없습니다.
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

출력 전용. 에이전트의 대화 환경을 테스트하기 위한 URL입니다.

플랫폼에 의해 정의됩니다.
testUrls[]

object (TestUrl)

출력 전용. 에이전트의 대화 환경을 테스트하기 위한 URL입니다.

플랫폼에 의해 정의됩니다.
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 표시 경로

열거형
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

에이전트에 지원되는 상호작용 유형입니다.

열거형
INTERACTION_TYPE_UNSPECIFIED 상호작용이 지정되지 않았습니다.
BOT 봇 상호작용
HUMAN 사람의 개입.

BotRepresentative

봇 담당자를 위한 세부정보입니다.

JSON 표현 
{
  "botMessagingAvailability": {
    object (MessagingAvailability)
  }
}
입력란
botMessagingAvailability

object (MessagingAvailability)

필수 항목입니다. 봇 메시지 사용 가능 여부

MessagingAvailability

메시지를 사용할 수 있는 각 요일의 시간입니다. 여러 요일의 영업시간을 그룹화할 수 있습니다. 예: * 월~수요일~목요일~금요일 10시~14시(PDT) * 목요일~금요일 15시~18시(PDT) * 토요일~금요일 10시~14시(PDT)

참석 여부에 공백이 있는 경우(예: 일요일에 참석 가능 여부를 지정하지 않으면) 해당 공백 기간에는 메시지를 사용할 수 없습니다.

봇 시간은 사용 가능 여부에 영향을 주지 않습니다. 봇 전용 상담사는 항상 환영 메시지를 표시하는 반면, 인간 및 봇 담당자 설정이 모두 있는 상담사는 상담 가능 여부를 정의할 때 실제 담당자만 고려합니다.

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

하루 중 특정 시간을 나타냅니다. 날짜와 시간대가 중요하지 않거나 아무 곳으로 지정됩니다. API는 윤초를 허용하도록 선택할 수 있습니다. 관련된 유형은 google.type.Date 및 google.protobuf.Timestamp입니다.

JSON 표현 
{
  "hours": integer,
  "minutes": integer,
  "seconds": integer,
  "nanos": integer
}
입력란
hours

integer

24시간 형식의 시간입니다. 0~23 사이의 값이어야 합니다. API는 비즈니스 종료 시간과 같은 시나리오에서 '24:00:00' 값을 허용하도록 선택할 수 있습니다.
minutes

integer

특정 시간의 분입니다. 0~59 사이의 값이어야 합니다.
seconds

integer

특정 분의 초입니다. 일반적으로 0~59 사이의 값이어야 합니다. API가 윤초를 허용하는 경우 값에 60을 사용할 수 있습니다.
nanos

integer

나노초 단위의 초수입니다. 0~999,999,999 사이의 값이어야 합니다.

DayOfWeek

요일을 나타냅니다.

열거형
DAY_OF_WEEK_UNSPECIFIED 요일이 지정되지 않습니다.
MONDAY 월요일
TUESDAY 화요일
WEDNESDAY 수요일
THURSDAY 목요일
FRIDAY 금요일
SATURDAY 토요일
SUNDAY 일요일

HumanRepresentative

담당자를 위한 세부정보입니다.

JSON 표현 
{
  "humanMessagingAvailability": {
    object (MessagingAvailability)
  }
}
입력란
humanMessagingAvailability

object (MessagingAvailability)

필수 항목입니다. 수동 메시지 사용 가능 여부

AuthorizationConfig

Business Messages에서 OAuth를 지원하기 위한 구성 세부정보입니다.

JSON 표현 
{
  "endpointUrl": string
}
입력란
endpointUrl

string

사용자가 로그인하는 엔드포인트 URL입니다.

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

필수 항목입니다. 에이전트가 NON_LOCAL 진입점을 실행할 수 있는 국가의 CLDR 지역 코드 목록입니다. 진입점 NON_LOCAL개에 필요합니다.

ContactOption

메시지 버튼 외에 연락처 세부정보가 표시됩니다.

JSON 표현 
{
  "url": string,
  "options": [
    enum (Option)
  ]
}
입력란
url

string

필수 항목입니다. 연락처 옵션을 사용할 수 있는 URL입니다.
options[]

enum (Option)

필수 항목입니다. 지정된 URL에 사용할 수 있는 연락처 옵션의 목록입니다.

옵션

문의 옵션

열거형
OPTION_UNSPECIFIED 미지정
WEB_CHAT 웹 채팅 옵션
PHONE 전화 옵션입니다.
EMAIL 이메일 옵션을 선택합니다.
FAQS FAQ 옵션
TWITTER Twitter 옵션
WHATSAPP WhatsApp 옵션

SurveyConfig

맞춤설정된 설문조사 질문을 지원하기 위한 구성 세부정보입니다.

JSON 표현 
{
  "templateQuestionIds": [
    string
  ],
  "customSurveys": {
    string: {
      object (CustomSurveyConfig)
    },
    ...
  }
}
입력란
templateQuestionIds[]

string

설문조사에 포함된 템플릿 질문의 템플릿 질문 ID 목록입니다.
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자(영문 기준)

유형

설문조사 질문의 유형입니다.

열거형
TYPE_UNSPECIFIED 알 수 없는 설문조사 질문 유형입니다.
GOOGLE_STANDARD_QUESTION Google 표준 설문조사 질문
GOOGLE_TEMPLATE_QUESTION Google에서 제공한 템플릿 설문조사 질문입니다.
PARTNER_CUSTOM_QUESTION 파트너 맞춤 설문조사 질문

SurveyResponse

설문조사 질문 응답의 콘텐츠입니다.

JSON 표현 
{
  "content": string,
  "postbackData": string
}
입력란
content

string

필수 항목입니다. 설문조사에 표시되고 사용자가 탭하면 상담사에게 다시 전송되는 텍스트입니다. 최대 35자(영문 기준)가 허용됩니다.
postbackData

string

사용자가 질문 응답을 탭할 때 에이전트가 수신하는 문자열입니다.

RcsBusinessMessagingAgent

RCS Business Messaging과 구체적으로 관련된 에이전트 정보입니다.

JSON 표현 
{
  "description": string,
  "logoUri": string,
  "heroUri": string,
  "phoneNumbers": [
    {
      object (PhoneEntry)
    }
  ],
  "emails": [
    {
      object (EmailEntry)
    }
  ],
  "websites": [
    {
      object (WebEntry)
    }
  ],
  "privacy": {
    object (WebEntry)
  },
  "termsConditions": {
    object (WebEntry)
  },
  "color": string,
  "billingConfig": {
    object (RcsBusinessMessagingAgentBillingConfig)
  },
  "agentUseCase": enum (AgentUseCase),
  "hostingRegion": enum (HostingRegion)
}
입력란
description

string

필수 항목입니다. 사용자에게 표시되는 에이전트의 설명입니다. 최대 100자(영문 기준)까지 허용됩니다.
logoUri

string

필수 항목입니다. 공개적으로 사용 가능한 에이전트 로고의 URL입니다. 최대 50KB

상담사 확인 후에는 수정할 수 없습니다.
heroUri

string

필수 항목입니다. 에이전트의 공개적으로 사용 가능한 히어로 이미지 URL입니다. 최대 200KB

상담사 확인 후에는 수정할 수 없습니다.
phoneNumbers[]

object (PhoneEntry)

필수 항목입니다. 상담사와 연결된 전화번호입니다.
emails[]

object (EmailEntry)

선택사항입니다. 에이전트와 연결된 이메일 주소입니다.
websites[]

object (WebEntry)

선택사항입니다. 에이전트와 연결된 웹사이트입니다. 최대 3개입니다.
privacy

object (WebEntry)

필수 항목입니다. 에이전트와 관련된 개인정보처리방침입니다.
termsConditions

object (WebEntry)

필수 항목입니다. 상담사와 연결된 이용약관입니다.
color

string

필수 항목입니다. 16진수 형식으로 사용자에게 표시되는 에이전트의 테마 색상입니다. #FF6347).
billingConfig

object (RcsBusinessMessagingAgentBillingConfig)

필수 항목입니다. 에이전트의 결제 구성입니다.
agentUseCase

enum (AgentUseCase)

선택사항입니다. 봇 사용 사례
hostingRegion

enum (HostingRegion)

필수 항목입니다. 에이전트의 호스팅 리전입니다.

PhoneEntry

에이전트와 연결된 전화번호입니다.

JSON 표현 
{
  "phoneNumber": {
    object (Phone)
  },
  "label": string
}
입력란
phoneNumber

object (Phone)

필수 항목입니다. E.164 형식의 전화번호입니다. 예를 들면 다음과 같습니다. +12223334444
label

string

필수 항목입니다. 전화번호 라벨

EmailEntry

상담사와 연결된 이메일입니다.

JSON 표현 
{
  "address": string,
  "label": string
}
입력란
address

string

필수 항목입니다. 이메일 주소.
label

string

필수 항목입니다. 이메일 주소 라벨입니다.

WebEntry

에이전트와 연결된 웹 기반 리소스입니다.

JSON 표현 
{
  "uri": string,
  "label": string
}
입력란
uri

string

필수 항목입니다. 에이전트와 연결되어 있고 공개적으로 액세스할 수 있는 URI입니다. HTTP 또는 HTTPS 프로토콜을 사용해야 합니다.
label

string

선택사항입니다. URI 라벨입니다.

RcsBusinessMessagingAgentBillingConfig

에이전트의 결제 구성입니다.

JSON 표현 
{
  "billingCategory": enum (BillingCategory)
}
입력란
billingCategory

enum (BillingCategory)

에이전트의 결제 카테고리입니다.

BillingCategory

지원되는 결제 카테고리입니다.

열거형
BILLING_CATEGORY_UNSPECIFIED 카테고리가 지정되지 않았습니다.
CONVERSATIONAL_LEGACY 기존 상담사의 결제 구성을 지원하는 기존 카테고리입니다.
CONVERSATIONAL 사용자와 브랜드가 일련의 메시지를 교환하는 더 길고 복잡한 세션을 위해 설계되었습니다.
SINGLE_MESSAGE SMS를 더 풍부한 메시지 환경으로 대체합니다. CONVERSATIONAL로 청구되지 않습니다.
BASIC_MESSAGE 청구 모델은 SMS와 유사합니다. CONVERSATIONAL로 청구되지 않습니다.

AgentUseCase

스토리지에 사용되는 에이전트 사용 사례 유형입니다.

열거형
AGENT_USE_CASE_UNSPECIFIED 사용 사례가 지정되지 않았습니다.
TRANSACTIONAL 필수적이고 필수적이며 시급한 메시지만 전송하는 상담사
PROMOTIONAL 영업, 마케팅, 프로모션 메일을 보내는 상담사 기본 유형입니다.
OTP 일회용 비밀번호만 전송하는 에이전트
MULTI_USE 에이전트에는 여러 사용 사례가 있습니다.

HostingRegion

P2A 메시지를 리전화된 서버로 올바르게 라우팅하는 데 사용되는 에이전트의 가능한 호스팅 리전입니다.

열거형
HOSTING_REGION_UNSPECIFIED 호스팅 지역이 지정되지 않았습니다.
NORTH_AMERICA 북미
EUROPE 유럽
ASIA_PACIFIC 아시아 태평양

방법

create

 브랜드를 나타낼 새 에이전트를 만듭니다.

delete
(deprecated)

 지원 중단됨: 에이전트 삭제는 지원 중단되었습니다.

get

 에이전트에 관한 정보를 확인합니다.

getLaunch

 에이전트의 시작 정보를 가져옵니다.

getVerification

 에이전트의 확인 정보를 가져옵니다.

list

 브랜드와 연결된 모든 에이전트를 나열합니다.

patch

 에이전트에 대한 정보를 업데이트합니다.

requestLaunch

 에이전트의 출시 프로세스를 시작합니다.

requestVerification

 상담사의 비즈니스 정보 인증을 시작합니다.

updateLaunch

 에이전트의 출시 정보를 업데이트합니다.

updateVerification

 상담사의 확인 상태를 업데이트합니다.