도구: create_app
지정된 프로젝트와 위치에 새 앱을 만듭니다.
다음 샘플은 curl를 사용하여 create_app MCP 도구를 호출하는 방법을 보여줍니다.
| curl 요청 |
|---|
curl --location 'https://ces.[REGION].rep.googleapis.com/mcp' \ --header 'content-type: application/json' \ --header 'accept: application/json, text/event-stream' \ --data '{ "method": "tools/call", "params": { "name": "create_app", "arguments": { // provide these details according to the tool's MCP specification } }, "jsonrpc": "2.0", "id": 1 }' |
입력 스키마
AgentService.CreateApp에 대한 요청 메시지입니다.
CreateAppRequest
| JSON 표현 |
|---|
{
"parent": string,
"appId": string,
"app": {
object ( |
| 필드 | |
|---|---|
parent |
필수 항목입니다. 앱을 만들 위치의 리소스 이름입니다. |
appId |
선택사항입니다. 앱에 사용할 ID이며, 앱의 리소스 이름에서 마지막 구성요소가 됩니다. 제공되지 않으면 앱에 고유 ID가 자동으로 할당됩니다. |
app |
필수 항목입니다. 만들 앱입니다. |
앱
| JSON 표현 |
|---|
{ "name": string, "displayName": string, "description": string, "pinned": boolean, "rootAgent": string, "languageSettings": { object ( |
| 필드 | |
|---|---|
name |
식별자. 앱의 고유 식별자입니다. 형식: |
displayName |
필수 항목입니다. 앱의 표시 이름입니다. |
description |
선택사항입니다. 인간이 읽을 수 있는 앱 설명입니다. |
pinned |
선택사항입니다. 앱이 앱 목록에 고정되어 있는지 여부입니다. |
rootAgent |
선택사항입니다. 루트 에이전트는 앱의 진입점입니다. 형식: |
languageSettings |
선택사항입니다. 앱의 언어 설정입니다. |
timeZoneSettings |
선택사항입니다. 앱의 시간대 설정입니다. |
audioProcessingConfig |
선택사항입니다. 앱의 오디오 처리 구성입니다. |
loggingSettings |
선택사항입니다. 앱의 로깅 설정입니다. |
errorHandlingSettings |
선택사항입니다. 앱의 오류 처리 설정입니다. |
modelSettings |
선택사항입니다. 앱의 기본 LLM 모델 설정입니다. 개별 리소스 (예: 에이전트, 가드레일)는 필요에 따라 이러한 구성을 재정의할 수 있습니다. |
toolExecutionMode |
선택사항입니다. 앱의 도구 실행 모드입니다. 제공되지 않으면 기본값은 PARALLEL입니다. |
evaluationMetricsThresholds |
선택사항입니다. 앱의 평가 기준입니다. |
variableDeclarations[] |
선택사항입니다. 변수의 선언입니다. |
predefinedVariableDeclarations[] |
출력 전용입니다. 앱의 사전 정의된 변수 선언입니다. |
globalInstruction |
선택사항입니다. 앱의 모든 에이전트에 관한 안내입니다. 이 안내를 사용하여 모든 에이전트에서 안정적인 ID 또는 페르소나를 설정할 수 있습니다. |
guardrails[] |
선택사항입니다. 앱의 가이드라인 목록입니다. 형식: |
dataStoreSettings |
선택사항입니다. 앱의 데이터 스토어 설정입니다. |
defaultChannelProfile |
선택사항입니다. 앱에서 사용하는 기본 채널 프로필입니다. |
metadata |
선택사항입니다. 앱에 관한 메타데이터입니다. 이 필드는 앱의 세부정보 또는 의도된 사용과 관련된 추가 정보를 저장하는 데 사용할 수 있습니다.
|
createTime |
출력 전용입니다. 앱이 생성된 타임스탬프입니다. 생성된 출력은 항상 Z-정규화되고 소수점 이하 0, 3, 6 또는 9자리인 RFC 3339를 사용합니다. 'Z' 이외의 오프셋도 허용됩니다. 예를 들면 |
updateTime |
출력 전용입니다. 앱이 마지막으로 업데이트된 타임스탬프입니다. 생성된 출력은 항상 Z-정규화되고 소수점 이하 0, 3, 6 또는 9자리인 RFC 3339를 사용합니다. 'Z' 이외의 오프셋도 허용됩니다. 예를 들면 |
etag |
출력 전용입니다. 읽기-수정-쓰기 작업 중에 객체가 변경되지 않았는지 확인하는 데 사용되는 Etag입니다. etag가 비어 있으면 업데이트가 동시에 발생한 변경사항을 덮어씁니다. |
deploymentCount |
출력 전용입니다. 앱의 배포 수입니다. |
clientCertificateSettings |
선택사항입니다. 앱의 기본 클라이언트 인증서 설정입니다. |
locked |
선택사항입니다. 앱이 변경사항에 대해 잠겨 있는지 여부를 나타냅니다. 앱이 잠겨 있으면 앱 리소스 수정이 거부됩니다. |
LanguageSettings
| JSON 표현 |
|---|
{ "defaultLanguageCode": string, "supportedLanguageCodes": [ string ], "enableMultilingualSupport": boolean, "fallbackAction": string } |
| 필드 | |
|---|---|
defaultLanguageCode |
선택사항입니다. 앱의 기본 언어 코드입니다. |
supportedLanguageCodes[] |
선택사항입니다. |
enableMultilingualSupport |
선택사항입니다. 다국어 지원을 사용 설정합니다. true인 경우 앱의 에이전트가 사전 빌드된 안내를 사용하여 다국어 입력 처리를 개선합니다. |
fallbackAction |
선택사항입니다. 상담사가 지원되지 않는 언어로 입력을 받는 경우 수행할 작업입니다. 사전 정의된 작업 또는 맞춤 도구 호출일 수 있습니다. 유효한 값은 다음과 같습니다. - 특정 도구 실행을 트리거하는 도구의 전체 리소스 이름 - '에스컬레이션' 또는 '종료'와 같은 사전 정의된 시스템 작업으로, 대화를 종료하기 위해 해당 |
TimeZoneSettings
| JSON 표현 |
|---|
{ "timeZone": string } |
| 필드 | |
|---|---|
timeZone |
선택사항입니다. 시간대 데이터베이스의 앱 시간대입니다(예: America/Los_Angeles, Europe/Paris |
AudioProcessingConfig
| JSON 표현 |
|---|
{ "synthesizeSpeechConfigs": { string: { object ( |
| 필드 | |
|---|---|
synthesizeSpeechConfigs |
선택사항입니다. 에이전트 응답이 합성되는 방식을 구성합니다. 언어 코드에서 지정된 언어 코드의 구성이 없으면 루트 언어 코드의 구성이 사용됩니다. 예를 들어 지도에 'en-us'와 'en'이 포함되어 있고 지정된 언어 코드가 'en-gb'인 경우 'en' 구성이 사용됩니다. 참고: 언어 코드는 대소문자를 구분하지 않습니다.
|
bargeInConfig |
선택사항입니다. 사용자 끼어들기 활동의 에이전트 동작을 구성합니다. |
inactivityTimeout |
선택사항입니다. 상담사가 사용자에게 다시 참여하도록 프롬프트하기 전까지 사용자가 비활성 상태 (음성 또는 상호작용 없음)로 있는 시간입니다. 설정하지 않으면 상담사가 사용자에게 재참여를 요청하지 않습니다. 소수점 아래가 최대 9자리까지이고 ' |
ambientSoundConfig |
선택사항입니다. 합성된 에이전트 응답과 함께 재생되는 주변 소리의 구성으로, 대화의 자연스러움을 향상합니다. |
SynthesizeSpeechConfigsEntry
| JSON 표현 |
|---|
{
"key": string,
"value": {
object ( |
| 필드 | |
|---|---|
key |
|
value |
|
SynthesizeSpeechConfig
| JSON 표현 |
|---|
{ "voice": string, "speakingRate": number } |
| 필드 | |
|---|---|
voice |
선택사항. 음성 이름입니다. 설정하지 않으면 서비스는 language_code와 같은 다른 매개변수를 기반으로 음성을 선택합니다. 사용 가능한 음성 목록은 Cloud Text-to-Speech의 지원되는 음성 및 언어를 참고하세요. |
speakingRate |
선택사항입니다. 말하기 속도로 범위는 [0.25, 2.0]입니다. 1.0은 특정 음성에서 지원하는 일반적인 기본 속도입니다. 2.0은 기본 속도의 2배이며 0.5는 절반입니다. [0.25, 2.0] 범위를 벗어난 값은 오류를 반환합니다. |
BargeInConfig
| JSON 표현 |
|---|
{ "disableBargeIn": boolean, "bargeInAwareness": boolean } |
| 필드 | |
|---|---|
disableBargeIn |
선택사항입니다. 상담사가 말하는 동안 사용자의 끼어들기를 사용 중지합니다. true인 경우 에이전트 응답 재생 중 사용자 입력이 무시됩니다. 지원 중단됨: ChannelProfile에서 |
bargeInAwareness |
선택사항입니다. 사용 설정된 경우 상담사는 사용자가 이전 상담사 메시지를 완전히 듣지 않았다는 가정에 따라 다음 응답을 조정합니다. 에이전트 응답이 시각적으로 표시되는 시나리오에서는 사용하면 안 됩니다. |
기간
| JSON 표현 |
|---|
{ "seconds": string, "nanos": integer } |
| 필드 | |
|---|---|
seconds |
시간 범위의 부호가 있는 초입니다. -315,576,000,000~+315,576,000,000(포함) 사이여야 합니다. 참고: 이 범위는 60초/분 * 60분/시간 * 24시간/일 * 365.25일/년 * 10,000년에서 계산됩니다. |
nanos |
시간 범위의 나노초 단위의 부호가 있는 초수입니다. 1초 미만의 기간은 0 |
AmbientSoundConfig
| JSON 표현 |
|---|
{ "volumeGainDb": number, // Union field |
| 필드 | |
|---|---|
volumeGainDb |
선택사항입니다. 주변 소음으로 지원되는 일반 기본 볼륨의 볼륨 게인 (dB)입니다. 범위는 [-96.0, 16.0]입니다. 값을 설정하지 않거나 0.0(dB)으로 설정하면 일반적인 기본 신호 진폭에서 재생됩니다. 값이 -6.0(dB)이면 일반적인 기본 신호 진폭의 약 절반에서 재생됩니다. 값이 +6.0(dB)이면 일반적인 기본 신호 진폭의 약 두 배에서 재생됩니다. +10(dB)을 초과하는 값을 사용하지 않는 것이 좋습니다. 값이 +10을 초과하면 일반적으로 소리가 커지는 효과가 없기 때문입니다. |
통합 필드 source. 대화의 자연스러움을 높이기 위해 합성된 에이전트 응답과 함께 재생되는 주변 소음입니다. source은 다음 중 하나여야 합니다. |
|
prebuiltAmbientNoise |
선택사항입니다. 지원 중단됨: |
gcsUri |
선택사항입니다. Cloud Storage에 저장된 모노 채널, 16kHz WAV 파일 형식의 주변 소음 참고: CES 서비스 에이전트 |
prebuiltAmbientSound |
선택사항입니다. 미리 빌드된 주변 소리의 이름입니다. 유효한 값은 다음과 같습니다. - 'coffee_shop' - 'keyboard' - 'keypad' - 'hum' - 'office_1' - 'office_2' - 'office_3' - 'room_1' - 'room_2' - 'room_3' - 'room_4' - 'room_5' - 'air_conditioner' |
LoggingSettings
| JSON 표현 |
|---|
{ "redactionConfig": { object ( |
| 필드 | |
|---|---|
redactionConfig |
선택사항입니다. 민감한 정보를 수정하는 방법에 관한 구성입니다. |
audioRecordingConfig |
선택사항입니다. 오디오 상호작용을 녹음하는 방식에 관한 구성입니다. |
bigqueryExportSettings |
선택사항입니다. 앱의 BigQuery 내보내기 동작을 설명하는 설정입니다. 사용 설정된 경우 대화 데이터가 BigQuery 테이블로 내보내집니다. |
cloudLoggingSettings |
선택사항입니다. 앱의 Cloud Logging 동작을 설명하는 설정입니다. |
conversationLoggingSettings |
선택사항입니다. 앱의 대화 로깅 동작을 설명하는 설정입니다. |
evaluationAudioRecordingConfig |
선택사항입니다. 평가를 위해 오디오 상호작용을 녹음하는 방식에 관한 구성입니다. 기본적으로 평가 세션에는 오디오 녹음이 사용 설정되어 있지 않습니다. |
metricAnalysisSettings |
선택사항입니다. 앱의 LLM 분석 파이프라인의 대화 데이터 수집 동작을 설명하는 설정입니다. |
RedactionConfig
| JSON 표현 |
|---|
{ "enableRedaction": boolean, "inspectTemplate": string, "deidentifyTemplate": string } |
| 필드 | |
|---|---|
enableRedaction |
선택사항입니다. true인 경우 대화 기록, Cloud Logging, 오디오 녹음 등 다양한 로깅 시나리오에 수정이 적용됩니다. |
inspectTemplate |
선택사항입니다. 민감한 정보 유형의 감지를 구성하는 DLP 검사 템플릿 이름입니다. 형식: |
deidentifyTemplate |
선택사항입니다. 콘텐츠를 익명화하는 방법을 안내하는 DLP 익명화 템플릿 이름입니다. 형식: |
AudioRecordingConfig
| JSON 표현 |
|---|
{ "gcsBucket": string, "gcsPathPrefix": string } |
| 필드 | |
|---|---|
gcsBucket |
선택사항입니다. 세션 오디오 녹음을 저장할 Cloud Storage 버킷입니다. URI는 'gs://'로 시작해야 합니다. 데이터 상주 요구사항을 충족하는 버킷 위치를 선택하세요. 참고: Cloud Storage 버킷이 앱과 다른 프로젝트에 있는 경우 CES 서비스 에이전트 |
gcsPathPrefix |
선택사항입니다. 오디오 녹음 파일의 Cloud Storage 경로 접두사입니다. 이 접두사에는 게재 시간에 동적으로 대체되는 다음 자리표시자가 포함될 수 있습니다. - $project: 프로젝트 ID - $location: 앱 위치 - $app: 앱 ID - $date: YYYY-MM-DD 형식의 세션 날짜 - $session: 세션 ID 경로 접두사를 지정하지 않으면 기본 접두사 |
BigQueryExportSettings
| JSON 표현 |
|---|
{ "enabled": boolean, "project": string, "dataset": string } |
| 필드 | |
|---|---|
enabled |
선택사항입니다. BigQuery 내보내기가 사용 설정되어 있는지 여부를 나타냅니다. |
project |
선택사항입니다. 데이터를 내보낼 BigQuery 데이터 세트의 프로젝트 ID입니다. 참고: BigQuery 데이터 세트가 앱과 다른 프로젝트에 있는 경우 CES 서비스 에이전트 |
dataset |
선택사항입니다. 데이터를 내보낼 BigQuery 데이터 세트입니다. |
CloudLoggingSettings
| JSON 표현 |
|---|
{ "enableCloudLogging": boolean } |
| 필드 | |
|---|---|
enableCloudLogging |
선택사항입니다. 세션에 Cloud Logging을 사용 설정할지 여부입니다. |
ConversationLoggingSettings
| JSON 표현 |
|---|
{ "disableConversationLogging": boolean } |
| 필드 | |
|---|---|
disableConversationLogging |
선택사항입니다. 세션의 대화 로깅을 사용 중지할지 여부입니다. |
MetricAnalysisSettings
| JSON 표현 |
|---|
{ "llmMetricsOptedOut": boolean } |
| 필드 | |
|---|---|
llmMetricsOptedOut |
선택사항입니다. llm 분석 측정항목을 위해 대화 데이터를 수집할지 여부입니다. true인 경우 llm 분석 측정항목에 대한 대화 데이터가 수집되지 않습니다. 그렇지 않으면 대화 데이터가 수집됩니다. |
ErrorHandlingSettings
| JSON 표현 |
|---|
{
"errorHandlingStrategy": enum ( |
| 필드 | |
|---|---|
errorHandlingStrategy |
선택사항입니다. 오류 처리에 사용할 전략입니다. |
ModelSettings
| JSON 표현 |
|---|
{ "model": string, // Union field |
| 필드 | |
|---|---|
model |
선택사항입니다. 에이전트가 사용해야 하는 LLM 모델입니다. 설정하지 않으면 에이전트가 상위 에이전트의 모델을 상속합니다. |
통합 필드
|
|
temperature |
선택사항입니다. 설정된 경우 이 온도가 LLM 모델에 사용됩니다. 온도는 모델 응답의 무작위성을 제어합니다. 온도가 낮을수록 더 예측 가능한 대답이 생성됩니다. 온도가 높을수록 더 창의적인 대답이 생성됩니다. |
EvaluationMetricsThresholds
| JSON 표현 |
|---|
{ "goldenEvaluationMetricsThresholds": { object ( |
| 필드 | |
|---|---|
goldenEvaluationMetricsThresholds |
선택사항입니다. 핵심 평가 측정항목 기준입니다. |
hallucinationMetricBehavior |
선택사항입니다. 지원 중단됨: 대신 |
goldenHallucinationMetricBehavior |
선택사항입니다. 골든 평가의 허위 정보 측정항목 동작입니다. |
scenarioHallucinationMetricBehavior |
선택사항입니다. 시나리오 평가의 허위 정보 측정항목 동작입니다. |
GoldenEvaluationMetricsThresholds
| JSON 표현 |
|---|
{ "turnLevelMetricsThresholds": { object ( |
| 필드 | |
|---|---|
turnLevelMetricsThresholds |
선택사항입니다. 턴 수준 측정항목 기준점입니다. |
expectationLevelMetricsThresholds |
선택사항입니다. 기대 수준 측정항목 기준점입니다. |
toolMatchingSettings |
선택사항입니다. 도구 매칭 설정입니다. 추가 도구 호출은 실행에 있지만 골든 기대치에 있는 도구 호출과 일치하지 않는 도구 호출입니다. |
TurnLevelMetricsThresholds
| JSON 표현 |
|---|
{ "semanticSimilarityChannel": enum ( |
| 필드 | |
|---|---|
semanticSimilarityChannel |
선택사항입니다. 평가에 사용할 시맨틱 유사성 채널입니다. |
통합 필드
|
|
semanticSimilaritySuccessThreshold |
선택사항입니다. 의미론적 유사성의 성공 기준입니다. 0에서 4 사이의 정수여야 합니다. 기본값은 3 이상입니다. |
통합 필드
|
|
overallToolInvocationCorrectnessThreshold |
선택사항입니다. 전반적인 도구 호출 정확성의 성공 기준입니다. 0과 1 사이의 부동 소수점이어야 합니다. 기본값은 1.0입니다. |
ExpectationLevelMetricsThresholds
| JSON 표현 |
|---|
{ // Union field |
| 필드 | |
|---|---|
통합 필드
|
|
toolInvocationParameterCorrectnessThreshold |
선택사항입니다. 개별 도구 호출 매개변수 정확성의 성공 기준입니다. 0과 1 사이의 부동 소수점이어야 합니다. 기본값은 1.0입니다. |
ToolMatchingSettings
| JSON 표현 |
|---|
{
"extraToolCallBehavior": enum ( |
| 필드 | |
|---|---|
extraToolCallBehavior |
선택사항입니다. 추가 도구 호출의 동작입니다. 기본값은 FAIL입니다. |
VariableDeclaration
| JSON 표현 |
|---|
{
"name": string,
"description": string,
"schema": {
object ( |
| 필드 | |
|---|---|
name |
필수 항목입니다. 변수의 이름입니다. 이름은 문자 또는 밑줄로 시작해야 하며 문자, 숫자, 밑줄만 포함할 수 있습니다. |
description |
필수 항목입니다. 변수에 대한 설명입니다. |
schema |
필수 항목입니다. 변수의 스키마입니다. |
스키마
| JSON 표현 |
|---|
{ "type": enum ( |
| 필드 | |
|---|---|
type |
필수 항목입니다. 데이터 유형입니다. |
properties |
선택사항입니다. Type.OBJECT의 속성입니다.
|
required[] |
선택사항입니다. Type.OBJECT의 필수 속성입니다. |
description |
선택사항입니다. 데이터의 설명입니다. |
items |
선택사항입니다. Type.ARRAY 요소의 스키마입니다. |
nullable |
선택사항입니다. null 값을 나타냅니다. |
uniqueItems |
선택사항입니다. 배열의 항목이 고유해야 함을 나타냅니다. TYPE.ARRAY에만 적용됩니다. |
prefixItems[] |
선택사항입니다. Type.ARRAY의 초기 요소 스키마입니다. |
additionalProperties |
선택사항입니다. 불리언 또는 객체일 수 있으며 추가 속성의 존재를 제어합니다. |
anyOf[] |
선택사항입니다. 값은 목록에 있는 하위 스키마 중 하나 이상에 대해 검증되어야 합니다. |
enum[] |
선택사항입니다. enum 형식의 기본 유형 요소의 가능한 값입니다. 예: 1. 방향을 {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}로 정의할 수 있습니다. 2. 아파트 번호를 {type:INTEGER, format:enum, enum:["101", "201", "301"]}로 정의할 수 있습니다. |
default |
선택사항입니다. 데이터의 기본값입니다. |
ref |
선택사항입니다. 스키마 노드 간의 간접 참조를 허용합니다. 값은 루트 예를 들어 다음 스키마는 'Pet'이라는 스키마 노드에 대한 참조를 정의합니다. 'pet' 속성의 값은 'Pet'이라는 스키마 노드를 참조합니다. 자세한 내용은 https://json-schema.org/understanding-json-schema/structuring을 참고하세요. |
defs |
선택사항입니다.
|
title |
선택사항입니다. 스키마의 제목입니다. |
minItems |
선택사항입니다. Type.ARRAY의 최소 요소 수입니다. |
maxItems |
선택사항입니다. Type.ARRAY의 최대 요소 수입니다. |
통합 필드
|
|
minimum |
선택사항입니다. Type.INTEGER 및 Type.NUMBER의 최솟값입니다. |
통합 필드
|
|
maximum |
선택사항입니다. Type.INTEGER 및 Type.NUMBER의 최댓값입니다. |
PropertiesEntry
| JSON 표현 |
|---|
{
"key": string,
"value": {
object ( |
| 필드 | |
|---|---|
key |
|
value |
|
값
| JSON 표현 |
|---|
{ // Union field |
| 필드 | |
|---|---|
통합 필드 kind. 값의 종류입니다. kind은 다음 중 하나여야 합니다. |
|
nullValue |
null 값을 나타냅니다. |
numberValue |
double 값을 나타냅니다. |
stringValue |
문자열 값을 나타냅니다. |
boolValue |
불리언 값을 나타냅니다. |
structValue |
구조화된 값을 나타냅니다. |
listValue |
반복되는 |
구조체
| JSON 표현 |
|---|
{ "fields": { string: value, ... } } |
| 필드 | |
|---|---|
fields |
동적으로 입력된 값의 순서가 지정되지 않은 맵입니다.
|
FieldsEntry
| JSON 표현 |
|---|
{ "key": string, "value": value } |
| 필드 | |
|---|---|
key |
|
value |
|
ListValue
| JSON 표현 |
|---|
{ "values": [ value ] } |
| 필드 | |
|---|---|
values[] |
동적으로 입력된 값의 반복 필드입니다. |
DefsEntry
| JSON 표현 |
|---|
{
"key": string,
"value": {
object ( |
| 필드 | |
|---|---|
key |
|
value |
|
DataStoreSettings
| JSON 표현 |
|---|
{
"engines": [
{
object ( |
| 필드 | |
|---|---|
engines[] |
출력 전용입니다. 앱의 엔진입니다. |
엔진
| JSON 표현 |
|---|
{
"name": string,
"type": enum ( |
| 필드 | |
|---|---|
name |
출력 전용입니다. 엔진의 리소스 이름입니다. 형식: |
type |
출력 전용입니다. 엔진 유형입니다. |
ChannelProfile
| JSON 표현 |
|---|
{ "profileId": string, "channelType": enum ( |
| 필드 | |
|---|---|
profileId |
선택사항입니다. 채널 프로필의 고유 식별자입니다. |
channelType |
선택사항입니다. 채널 프로필 유형입니다. |
personaProperty |
선택사항입니다. 채널 프로필의 페르소나 속성입니다. |
disableDtmf |
선택사항입니다. DTMF (듀얼 톤 다중 주파수)를 사용 중지할지 여부입니다. |
disableBargeInControl |
선택사항입니다. 대화에서 사용자 끼어들기 제어를 사용 중지할지 여부입니다. - true: 에이전트가 말하는 동안 사용자 방해가 사용 중지됩니다. - false: 사용자가 언제 중단할 수 있는지에 대한 자동 제어가 에이전트에 유지됩니다. |
webWidgetConfig |
선택사항입니다. 웹 위젯의 구성입니다. |
noiseSuppressionLevel |
선택사항입니다. 채널 프로필의 노이즈 제거 수준입니다. 사용 가능한 값은 'low', 'moderate', 'high', 'very_high'입니다. |
PersonaProperty
| JSON 표현 |
|---|
{
"persona": enum ( |
| 필드 | |
|---|---|
persona |
선택사항입니다. 채널의 페르소나입니다. |
WebWidgetConfig
| JSON 표현 |
|---|
{ "modality": enum ( |
| 필드 | |
|---|---|
modality |
선택사항입니다. 웹 위젯의 모달리티입니다. |
theme |
선택사항입니다. 웹 위젯의 테마입니다. |
webWidgetTitle |
선택사항입니다. 웹 위젯의 제목입니다. |
securitySettings |
선택사항입니다. 웹 위젯의 보안 설정입니다. |
SecuritySettings
| JSON 표현 |
|---|
{ "enablePublicAccess": boolean, "enableOriginCheck": boolean, "allowedOrigins": [ string ], "enableRecaptcha": boolean } |
| 필드 | |
|---|---|
enablePublicAccess |
선택사항입니다. 웹 위젯에 대한 공개 액세스가 사용 설정되어 있는지 여부를 나타냅니다. |
enableOriginCheck |
선택사항입니다. 웹 위젯의 출처 확인이 사용 설정되었는지 나타냅니다. |
allowedOrigins[] |
선택사항입니다. 웹 위젯을 호스팅할 수 있는 출처입니다. 출처는 RFC 6454에 의해 정의됩니다. 비어 있으면 모든 출처가 허용됩니다. 최대 100개의 출처가 허용됩니다. 예: 'https://example.com' |
enableRecaptcha |
선택사항입니다. 웹 위젯의 reCAPTCHA 인증이 사용 설정되어 있는지 여부를 나타냅니다. |
MetadataEntry
| JSON 표현 |
|---|
{ "key": string, "value": string } |
| 필드 | |
|---|---|
key |
|
value |
|
타임스탬프
| JSON 표현 |
|---|
{ "seconds": string, "nanos": integer } |
| 필드 | |
|---|---|
seconds |
Unix epoch 1970-01-01T00:00:00Z 이후 UTC 시간의 초 단위로 표현합니다. -62135596800~253402300799 (0001-01-01T00:00:00Z~9999-12-31T23:59:59Z에 해당) 사이여야 합니다. |
nanos |
나노초 단위의 음수가 아닌 초수입니다. 이 필드는 기간의 나노초 부분이며 초의 대안이 아닙니다. 음수의 초수 값에는 시간에 반영되는 음수가 아닌 나노초 값이 있어야 합니다. 0~999,999,999(포함) 사이여야 합니다. |
ClientCertificateSettings
| JSON 표현 |
|---|
{ "tlsCertificate": string, "privateKey": string, "passphrase": string } |
| 필드 | |
|---|---|
tlsCertificate |
필수 항목입니다. PEM 형식으로 인코딩된 TLS 인증서입니다. 이 문자열에는 시작 헤더와 종료 바닥글 줄이 포함되어야 합니다. |
privateKey |
필수 항목입니다. PEM 형식으로 인코딩된 비공개 키를 저장하는 SecretManager 보안 비밀 버전 리소스의 이름입니다. 형식: |
passphrase |
선택사항입니다. 비공개 키를 복호화하는 암호를 저장하는 SecretManager 보안 비밀 버전 리소스의 이름입니다. 비공개 키가 암호화되지 않은 경우 설정되지 않은 상태로 두어야 합니다. 형식: |
출력 스키마
이 리소스는 네트워크 API 호출의 결과인 장기 실행 작업을 나타냅니다.
작업
| JSON 표현 |
|---|
{ "name": string, "metadata": { "@type": string, field1: ..., ... }, "done": boolean, // Union field |
| 필드 | |
|---|---|
name |
서버에 할당된 이름으로, 해당 이름을 최초로 반환한 서비스 내에서만 고유합니다. 기본 HTTP 매핑을 사용하는 경우 |
metadata |
작업과 관련된 서비스별 메타데이터입니다. 일반적으로 진행률 정보 및 생성 시간과 같은 일반 메타데이터가 포함됩니다. 일부 서비스는 이러한 메타데이터를 제공하지 않을 수 있습니다. 장기 실행 작업을 반환하는 메소드는 메타데이터 유형이 있는 경우 이를 문서화해야 합니다. 임의 유형의 필드를 포함하는 객체입니다. 추가 필드 |
done |
값이 |
통합 필드 result는 작업 결과로, error 또는 유효한 response일 수 있습니다. done == false이면 error와 response가 모두 설정되지 않습니다. done == true이면 error 또는 response 중 정확히 하나를 설정할 수 있습니다. 일부 서비스는 결과를 제공하지 않을 수 있습니다. result는 다음 중 하나여야 합니다. |
|
error |
실패하거나 취소된 작업의 오류 결과입니다. |
response |
정상적인 성공한 작업 응답입니다. 임의 유형의 필드를 포함하는 객체입니다. 추가 필드 |
모두
| JSON 표현 |
|---|
{ "typeUrl": string, "value": string } |
| 필드 | |
|---|---|
typeUrl |
슬래시로 끝나는 접두사와 정규화된 유형 이름으로 구성된 URI 참조를 사용하여 직렬화된 Protobuf 메시지의 유형을 식별합니다. 예: type.googleapis.com/google.protobuf.StringValue 이 문자열에는 접두사는 임의적이며 Protobuf 구현은 유형을 식별하기 위해 마지막 모든 유형 URL 문자열은 참조의 콘텐츠가 영숫자, 퍼센트 인코딩된 이스케이프, 다음 집합의 문자 (외부 백틱 제외)로만 구성되어야 한다는 추가 제한사항 (텍스트 형식의 경우)이 있는 합법적인 URI 참조여야 합니다.
|
value |
type_url로 설명된 유형의 Protobuf 직렬화를 보유합니다. base64 인코딩 문자열입니다. |
상태
| JSON 표현 |
|---|
{ "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } |
| 필드 | |
|---|---|
code |
상태 코드로, |
message |
개발자에게 정보를 제공하는 오류 메시지로, 영어로 작성되어야 합니다. 사용자에게 표시되는 모든 오류 메시지는 현지화되어 |
details[] |
오류 세부정보를 설명하는 메시지 목록입니다. API에서 사용할 일반적인 메시지 유형 집합이 있습니다. 임의 유형의 필드를 포함하는 객체입니다. 추가 필드 |
도구 주석
파괴적 힌트: ✅ | 동일한 힌트: ❌ | 읽기 전용 힌트: ❌ | 오픈 월드 힌트: ❌