MCP Tools Reference: ces.googleapis.com

ツール: 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 (App)
  }
}
フィールド
parent

string

必須。アプリを作成するビジネスのリソース名。

appId

string

省略可。アプリに使用する ID。アプリのリソース名の最終的なコンポーネントになります。指定しない場合、アプリに一意の ID が自動的に割り当てられます。

app

object (App)

必須。作成するアプリ。

アプリ

JSON 表現
{
  "name": string,
  "displayName": string,
  "description": string,
  "pinned": boolean,
  "rootAgent": string,
  "languageSettings": {
    object (LanguageSettings)
  },
  "timeZoneSettings": {
    object (TimeZoneSettings)
  },
  "audioProcessingConfig": {
    object (AudioProcessingConfig)
  },
  "loggingSettings": {
    object (LoggingSettings)
  },
  "errorHandlingSettings": {
    object (ErrorHandlingSettings)
  },
  "modelSettings": {
    object (ModelSettings)
  },
  "toolExecutionMode": enum (ToolExecutionMode),
  "evaluationMetricsThresholds": {
    object (EvaluationMetricsThresholds)
  },
  "variableDeclarations": [
    {
      object (VariableDeclaration)
    }
  ],
  "predefinedVariableDeclarations": [
    {
      object (VariableDeclaration)
    }
  ],
  "globalInstruction": string,
  "guardrails": [
    string
  ],
  "dataStoreSettings": {
    object (DataStoreSettings)
  },
  "defaultChannelProfile": {
    object (ChannelProfile)
  },
  "metadata": {
    string: string,
    ...
  },
  "createTime": string,
  "updateTime": string,
  "etag": string,
  "deploymentCount": integer,
  "clientCertificateSettings": {
    object (ClientCertificateSettings)
  },
  "locked": boolean
}
フィールド
name

string

ID。アプリの固有識別子。形式: projects/{project}/locations/{location}/apps/{app}

displayName

string

必須。アプリの表示名。

description

string

省略可。アプリの説明(人が読める形式)。

pinned

boolean

省略可。アプリがアプリリストに固定されているかどうか。

rootAgent

string

省略可。ルート エージェントはアプリのエントリ ポイントです。形式: projects/{project}/locations/{location}/apps/{app}/agents/{agent}

languageSettings

object (LanguageSettings)

省略可。アプリの言語設定。

timeZoneSettings

object (TimeZoneSettings)

省略可。アプリのタイムゾーン設定。

audioProcessingConfig

object (AudioProcessingConfig)

省略可。アプリの音声処理構成。

loggingSettings

object (LoggingSettings)

省略可。アプリのロギング設定。

errorHandlingSettings

object (ErrorHandlingSettings)

省略可。アプリの設定のエラー処理。

modelSettings

object (ModelSettings)

省略可。アプリのデフォルトの LLM モデル設定。個々のリソース(エージェント、ガードレールなど)は、必要に応じてこれらの構成をオーバーライドできます。

toolExecutionMode

enum (ToolExecutionMode)

省略可。アプリのツール実行モード。指定しない場合、デフォルトは PARALLEL になります。

evaluationMetricsThresholds

object (EvaluationMetricsThresholds)

省略可。アプリの評価のしきい値。

variableDeclarations[]

object (VariableDeclaration)

省略可。変数の宣言。

predefinedVariableDeclarations[]

object (VariableDeclaration)

出力専用。アプリの事前定義変数の宣言。

globalInstruction

string

省略可。アプリ内のすべてのエージェントに対する指示。この指示を使用して、すべてのエージェントにわたって安定した ID または人格を設定できます。

guardrails[]

string

省略可。アプリのガードレールのリスト。形式: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}

dataStoreSettings

object (DataStoreSettings)

省略可。アプリのデータストア設定。

defaultChannelProfile

object (ChannelProfile)

省略可。アプリで使用されるデフォルトのチャンネル プロファイル。

metadata

map (key: string, value: string)

省略可。アプリに関するメタデータ。このフィールドは、アプリの詳細や想定される用途に関連する追加情報を保存するために使用できます。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

createTime

string (Timestamp format)

出力専用。アプリが作成されたときのタイムスタンプ。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z""2014-10-02T15:01:23+05:30"

updateTime

string (Timestamp format)

出力専用。アプリが最後に更新されたときのタイムスタンプ。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z""2014-10-02T15:01:23+05:30"

etag

string

出力専用。読み取り、変更、書き込みオペレーション中にオブジェクトが変更されていないことを確認するために使用される ETag。etag が空の場合、更新によって同時変更が上書きされます。

deploymentCount

integer

出力専用。アプリのデプロイ数。

clientCertificateSettings

object (ClientCertificateSettings)

省略可。アプリのデフォルトのクライアント証明書設定。

locked

boolean

省略可。アプリが変更のためにロックされているかどうかを示します。アプリがロックされている場合、アプリリソースの変更は拒否されます。

LanguageSettings

JSON 表現
{
  "defaultLanguageCode": string,
  "supportedLanguageCodes": [
    string
  ],
  "enableMultilingualSupport": boolean,
  "fallbackAction": string
}
フィールド
defaultLanguageCode

string

省略可。アプリのデフォルトの言語コード。

supportedLanguageCodes[]

string

省略可。default_language_code に加えてアプリでサポートされている言語コードのリスト。

enableMultilingualSupport

boolean

省略可。多言語サポートを有効にします。true の場合、アプリ内のエージェントは、多言語入力の処理を改善するために、事前構築済みの手順を使用します。

fallbackAction

string

省略可。エージェントがサポートされていない言語で入力を受け取ったときに行うアクション。

これは、事前定義されたアクションまたはカスタムのツール呼び出しにできます。有効な値は次のとおりです。- 特定のツールの実行をトリガーするツールの完全なリソース名。- 「エスカレーション」や「終了」などの事前定義されたシステム アクション。対応する metadata を含む EndSession シグナルをトリガーして、会話を終了します。

TimeZoneSettings

JSON 表現
{
  "timeZone": string
}
フィールド
timeZone

string

省略可。タイムゾーン データベースにあるアプリのタイムゾーン(例: America/Los_Angeles、Europe/Paris。

AudioProcessingConfig

JSON 表現
{
  "synthesizeSpeechConfigs": {
    string: {
      object (SynthesizeSpeechConfig)
    },
    ...
  },
  "bargeInConfig": {
    object (BargeInConfig)
  },
  "inactivityTimeout": string,
  "ambientSoundConfig": {
    object (AmbientSoundConfig)
  }
}
フィールド
synthesizeSpeechConfigs

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

省略可。エージェントのレスポンスを合成する方法の構成。言語コードから SynthesizeSpeechConfig へのマッピング。

指定された言語コードの構成が見つからない場合は、ルート言語コードの構成が使用されます。たとえば、マップに「en-us」と「en」が含まれていて、指定された言語コードが「en-gb」の場合、「en」構成が使用されます。

注: 言語コードでは大文字と小文字が区別されません。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

bargeInConfig

object (BargeInConfig)

省略可。ユーザーの割り込みアクティビティに対するエージェントの動作を構成します。

inactivityTimeout

string (Duration format)

省略可。エージェントがユーザーに再エンゲージメントを促すまでの、ユーザーの無操作(発話や操作がない)の継続時間。設定されていない場合、エージェントはユーザーに再エンゲージメントを促しません。

s で終わる小数 9 桁までの秒単位の期間。例: "3.5s"

ambientSoundConfig

object (AmbientSoundConfig)

省略可。会話の自然さを高めるために、合成されたエージェントの回答とともに再生されるアンビエント サウンドの構成。

SynthesizeSpeechConfigsEntry

JSON 表現
{
  "key": string,
  "value": {
    object (SynthesizeSpeechConfig)
  }
}
フィールド
key

string

value

object (SynthesizeSpeechConfig)

SynthesizeSpeechConfig

JSON 表現
{
  "voice": string,
  "speakingRate": number
}
フィールド
voice

string

省略可。声の名前。設定しない場合、言語コードなどの他のパラメータに基づいて音声が選択されます。

利用可能な音声の一覧については、Cloud Text-to-Speech のサポートされている音声と言語を参照してください。

speakingRate

number

省略可。発声速度。0.25 ~ 2.0 の範囲で指定します。1.0 は、特定の声でサポートされているネイティブの通常の発声速度を表します。2.0 はその 2 倍の速さで、0.5 は半分の速さです。範囲 [0.25, 2.0] 外の値を指定すると、エラーが返されます。

BargeInConfig

JSON 表現
{
  "disableBargeIn": boolean,
  "bargeInAwareness": boolean
}
フィールド
disableBargeIn
(deprecated)

boolean

省略可。エージェントが話している間、ユーザーの割り込みを無効にします。true の場合、エージェントの応答の再生中のユーザー入力は無視されます。

非推奨: ChannelProfile で disable_barge_in が非推奨となり、disable_barge_in_control に置き換えられました。

bargeInAwareness

boolean

省略可。有効にすると、エージェントは、ユーザーが直前のエージェント メッセージをすべて聞いていないという前提に基づいて、次のレスポンスを調整します。エージェントの回答が視覚的に表示されるシナリオでは使用しないでください。

所要時間

JSON 表現
{
  "seconds": string,
  "nanos": integer
}
フィールド
seconds

string (int64 format)

期間の符号付き秒数。-315,576,000,000 ~+315,576,000,000 の範囲(両端を含む)にする必要があります。注: これらの境界は、60 秒/分 * 60 分/時間 * 24 時間/日 * 365.25 日/年 * 10,000 年から計算されます。

nanos

integer

期間のナノ秒分解能による、秒の符号付き小数以下部分。1 秒未満の期間は、0 の seconds フィールドと正または負の nanos フィールドで表されます。1 秒以上の期間の場合、nanos フィールドのゼロ以外の値は、seconds フィールドと同じ符号である必要があります。-999,999,999~+999,999,999 の範囲内(境界含む)である必要があります。

AmbientSoundConfig

JSON 表現
{
  "volumeGainDb": number,

  // Union field source can be only one of the following:
  "prebuiltAmbientNoise": enum (PrebuiltAmbientNoise),
  "gcsUri": string,
  "prebuiltAmbientSound": string
  // End of list of possible types for union field source.
}
フィールド
volumeGainDb

number

省略可。周囲のノイズによってサポートされるネイティブの通常の音量の音量ゲイン(dB 単位)。範囲は [-96.0, 16.0] です。未設定にするか、0.0(dB)に設定すると、ネイティブの通常の信号振幅で再生されます。-6.0(dB)に設定すると、ネイティブの通常の信号振幅の約半分の振幅で再生されます。+6.0(dB)に設定すると、ネイティブの通常の信号振幅の約 2 倍の振幅で再生されます。+10(dB)より大きい値を指定しないことを強くおすすめします。通常は、そのような大きい値を指定しても音量は効果的に増加しません。

共用体フィールド source。会話の自然さを高めるために、合成されたエージェントのレスポンスとともに再生される周囲のノイズ。source は次のいずれかになります。
prebuiltAmbientNoise
(deprecated)

enum (PrebuiltAmbientNoise)

省略可。非推奨: prebuilt_ambient_noise は非推奨となり、prebuilt_ambient_sound に置き換えられました。

gcsUri

string

省略可。Cloud Storage に保存されているモノラル チャンネルの 16 kHz WAV ファイルとしての周囲の雑音。

注: CES サービス エージェント service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com に Cloud Storage オブジェクトに対する storage.objects.get 権限があることを確認してください。

prebuiltAmbientSound

string

省略可。プリビルドのアンビエント サウンドの名前。有効な値は、- "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": {
    object (AudioRecordingConfig)
  },
  "bigqueryExportSettings": {
    object (BigQueryExportSettings)
  },
  "cloudLoggingSettings": {
    object (CloudLoggingSettings)
  },
  "conversationLoggingSettings": {
    object (ConversationLoggingSettings)
  },
  "evaluationAudioRecordingConfig": {
    object (AudioRecordingConfig)
  },
  "metricAnalysisSettings": {
    object (MetricAnalysisSettings)
  }
}
フィールド
redactionConfig

object (RedactionConfig)

省略可。機密データを編集する方法の構成。

audioRecordingConfig

object (AudioRecordingConfig)

省略可。音声インタラクションの記録方法の構成。

bigqueryExportSettings

object (BigQueryExportSettings)

省略可。アプリの BigQuery エクスポートの動作を記述する設定。有効になっている場合、会話データは BigQuery テーブルにエクスポートされます。

cloudLoggingSettings

object (CloudLoggingSettings)

省略可。アプリの Cloud Logging の動作を記述する設定。

conversationLoggingSettings

object (ConversationLoggingSettings)

省略可。アプリの会話ログ記録の動作を記述する設定。

evaluationAudioRecordingConfig

object (AudioRecordingConfig)

省略可。評価のために音声インタラクションを記録する方法の構成。デフォルトでは、評価セッションで音声録音は有効になっていません。

metricAnalysisSettings

object (MetricAnalysisSettings)

省略可。アプリの LLM 分析パイプラインの会話データ収集の動作を記述する設定。

RedactionConfig

JSON 表現
{
  "enableRedaction": boolean,
  "inspectTemplate": string,
  "deidentifyTemplate": string
}
フィールド
enableRedaction

boolean

省略可。true の場合、会話履歴、Cloud Logging、音声録音など、さまざまなロギング シナリオで秘匿化が適用されます。

inspectTemplate

string

省略可。機密データの種類の検出を構成する DLP 検査テンプレート名。

形式: projects/{project}/locations/{location}/inspectTemplates/{inspect_template}

deidentifyTemplate

string

省略可。コンテンツの匿名化方法を指定する DLP 匿名化テンプレート名。

形式: projects/{project}/locations/{location}/deidentifyTemplates/{deidentify_template}

AudioRecordingConfig

JSON 表現
{
  "gcsBucket": string,
  "gcsPathPrefix": string
}
フィールド
gcsBucket

string

省略可。セッションの音声録音を保存する Cloud Storage バケット。URI は「gs://」で始まる必要があります。

データ所在地に関する要件を満たすバケットのロケーションを選択してください。

注: Cloud Storage バケットがアプリとは異なるプロジェクトにある場合は、CES サービス エージェント service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.comstorage.objects.create 権限を付与する必要があります。

gcsPathPrefix

string

省略可。音声録音の Cloud Storage パスの接頭辞。

この接頭辞には、次のプレースホルダを含めることができます。これらのプレースホルダは、配信時に動的に置き換えられます。- $project: プロジェクト ID - $location: アプリの場所 - $app: アプリ ID - $date: YYYY-MM-DD 形式のセッションの日付 - $session: セッション ID

パス接頭辞が指定されていない場合は、デフォルトの接頭辞 $project/$location/$app/$date/$session/ が使用されます。

BigQueryExportSettings

JSON 表現
{
  "enabled": boolean,
  "project": string,
  "dataset": string
}
フィールド
enabled

boolean

省略可。BigQuery エクスポートが有効かどうかを示します。

project

string

省略可。データのエクスポート先の BigQuery データセットのプロジェクト ID。

注: BigQuery データセットがアプリとは異なるプロジェクトにある場合は、CES サービス エージェント service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.comroles/bigquery.admin ロールを付与する必要があります。

dataset

string

省略可。データをエクスポートする BigQuery データセット。

CloudLoggingSettings

JSON 表現
{
  "enableCloudLogging": boolean
}
フィールド
enableCloudLogging

boolean

省略可。セッションで Cloud Logging を有効にするかどうか。

ConversationLoggingSettings

JSON 表現
{
  "disableConversationLogging": boolean
}
フィールド
disableConversationLogging

boolean

省略可。セッションの会話ロギングを無効にするかどうか。

MetricAnalysisSettings

JSON 表現
{
  "llmMetricsOptedOut": boolean
}
フィールド
llmMetricsOptedOut

boolean

省略可。llm 分析指標の会話データを収集するかどうか。true の場合、llm 分析指標の会話データは収集されません。それ以外の場合、会話データは収集されます。

ErrorHandlingSettings

JSON 表現
{
  "errorHandlingStrategy": enum (ErrorHandlingStrategy)
}
フィールド
errorHandlingStrategy

enum (ErrorHandlingStrategy)

省略可。エラー処理に使用する戦略。

ModelSettings

JSON 表現
{
  "model": string,

  // Union field _temperature can be only one of the following:
  "temperature": number
  // End of list of possible types for union field _temperature.
}
フィールド
model

string

省略可。エージェントが使用する LLM モデル。設定されていない場合、エージェントは親エージェントからモデルを継承します。

共用体フィールド _temperature

_temperature は次のいずれかになります。

temperature

number

省略可。設定すると、この温度が LLM モデルに使用されます。温度は、モデルのレスポンスのランダム性を制御します。温度が低いほど、予測しやすい回答が生成されます。温度が高いほど、より創造的なレスポンスが生成されます。

EvaluationMetricsThresholds

JSON 表現
{
  "goldenEvaluationMetricsThresholds": {
    object (GoldenEvaluationMetricsThresholds)
  },
  "hallucinationMetricBehavior": enum (HallucinationMetricBehavior),
  "goldenHallucinationMetricBehavior": enum (HallucinationMetricBehavior),
  "scenarioHallucinationMetricBehavior": enum (HallucinationMetricBehavior)
}
フィールド
goldenEvaluationMetricsThresholds

object (GoldenEvaluationMetricsThresholds)

省略可。ゴールデン評価指標のしきい値。

hallucinationMetricBehavior
(deprecated)

enum (HallucinationMetricBehavior)

省略可。非推奨: 代わりに、golden_hallucination_metric_behavior を使用してください。現在、ハルシネーション指標の動作はゴールデン評価に使用されています。

goldenHallucinationMetricBehavior

enum (HallucinationMetricBehavior)

省略可。ゴールデン評価のハルシネーション指標の動作。

scenarioHallucinationMetricBehavior

enum (HallucinationMetricBehavior)

省略可。シナリオ評価のハルシネーション指標の動作。

GoldenEvaluationMetricsThresholds

JSON 表現
{
  "turnLevelMetricsThresholds": {
    object (TurnLevelMetricsThresholds)
  },
  "expectationLevelMetricsThresholds": {
    object (ExpectationLevelMetricsThresholds)
  },
  "toolMatchingSettings": {
    object (ToolMatchingSettings)
  }
}
フィールド
turnLevelMetricsThresholds

object (TurnLevelMetricsThresholds)

省略可。ターンレベルの指標のしきい値。

expectationLevelMetricsThresholds

object (ExpectationLevelMetricsThresholds)

省略可。期待レベルの指標のしきい値。

toolMatchingSettings

object (ToolMatchingSettings)

省略可。ツール マッチングの設定。余分なツール呼び出しとは、実行には存在するものの、ゴールデン エクスペクテーションのツール呼び出しと一致しないツール呼び出しのことです。

TurnLevelMetricsThresholds

JSON 表現
{
  "semanticSimilarityChannel": enum (SemanticSimilarityChannel),

  // Union field _semantic_similarity_success_threshold can be only one of the
  // following:
  "semanticSimilaritySuccessThreshold": integer
  // End of list of possible types for union field
  // _semantic_similarity_success_threshold.

  // Union field _overall_tool_invocation_correctness_threshold can be only one
  // of the following:
  "overallToolInvocationCorrectnessThreshold": number
  // End of list of possible types for union field
  // _overall_tool_invocation_correctness_threshold.
}
フィールド
semanticSimilarityChannel

enum (SemanticSimilarityChannel)

省略可。評価に使用する意味的類似性チャネル。

共用体フィールド _semantic_similarity_success_threshold

_semantic_similarity_success_threshold は次のいずれかになります。

semanticSimilaritySuccessThreshold

integer

省略可。意味的類似性の成功しきい値。0 ~ 4 の整数を指定してください。デフォルトは 3 以上です。

共用体フィールド _overall_tool_invocation_correctness_threshold

_overall_tool_invocation_correctness_threshold は次のいずれかになります。

overallToolInvocationCorrectnessThreshold

number

省略可。ツール呼び出しの全体的な正しさの成功しきい値。0 ~ 1 の浮動小数点数にする必要があります。デフォルトは 1.0 です。

ExpectationLevelMetricsThresholds

JSON 表現
{

  // Union field _tool_invocation_parameter_correctness_threshold can be only one
  // of the following:
  "toolInvocationParameterCorrectnessThreshold": number
  // End of list of possible types for union field
  // _tool_invocation_parameter_correctness_threshold.
}
フィールド

共用体フィールド _tool_invocation_parameter_correctness_threshold

_tool_invocation_parameter_correctness_threshold は次のいずれかになります。

toolInvocationParameterCorrectnessThreshold

number

省略可。個々のツール呼び出しパラメータの正しさの成功しきい値。0 ~ 1 の浮動小数点数にする必要があります。デフォルトは 1.0 です。

ToolMatchingSettings

JSON 表現
{
  "extraToolCallBehavior": enum (ExtraToolCallBehavior)
}
フィールド
extraToolCallBehavior

enum (ExtraToolCallBehavior)

省略可。追加のツール呼び出しの動作。デフォルトは FAIL です。

VariableDeclaration

JSON 表現
{
  "name": string,
  "description": string,
  "schema": {
    object (Schema)
  }
}
フィールド
name

string

必須。変数の名前。名前の先頭は英字またはアンダースコアにする必要があります。使用できる文字は、英字、数字、アンダースコアのみです。

description

string

必須。変数の説明。

schema

object (Schema)

必須。変数のスキーマ。

スキーマ

JSON 表現
{
  "type": enum (Type),
  "properties": {
    string: {
      object (Schema)
    },
    ...
  },
  "required": [
    string
  ],
  "description": string,
  "items": {
    object (Schema)
  },
  "nullable": boolean,
  "uniqueItems": boolean,
  "prefixItems": [
    {
      object (Schema)
    }
  ],
  "additionalProperties": {
    object (Schema)
  },
  "anyOf": [
    {
      object (Schema)
    }
  ],
  "enum": [
    string
  ],
  "default": value,
  "ref": string,
  "defs": {
    string: {
      object (Schema)
    },
    ...
  },
  "title": string,
  "minItems": string,
  "maxItems": string,

  // Union field _minimum can be only one of the following:
  "minimum": number
  // End of list of possible types for union field _minimum.

  // Union field _maximum can be only one of the following:
  "maximum": number
  // End of list of possible types for union field _maximum.
}
フィールド
type

enum (Type)

必須。データの型。

properties

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

省略可。Type.OBJECT のプロパティ。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

required[]

string

省略可。Type.OBJECT の必須プロパティ。

description

string

省略可。データの説明。

items

object (Schema)

省略可。Type.ARRAY の要素のスキーマ。

nullable

boolean

省略可。値が null の可能性があるかどうかを示します。

uniqueItems

boolean

省略可。配列内の項目が一意である必要があることを示します。TYPE.ARRAY にのみ適用されます。

prefixItems[]

object (Schema)

省略可。Type.ARRAY の初期要素のスキーマ。

additionalProperties

object (Schema)

省略可。ブール値またはオブジェクトのいずれか。追加のプロパティの存在を制御します。

anyOf[]

object (Schema)

省略可。値は、リスト内のサブスキーマのいずれか(1 つ以上)に対して検証される必要があります。

enum[]

string

省略可。プリミティブ型の要素の可能な値(列挙型形式)。例: 1. 方向は {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. アパートの部屋番号は {type:INTEGER, format:enum, enum:["101", "201", "301"]} と定義できます。

default

value (Value format)

省略可。データのデフォルト値。

ref

string

省略可。スキーマノード間の間接参照を許可します。値は、ルート defs の子への有効な参照である必要があります。

たとえば、次のスキーマは、「Pet」という名前のスキーマノードへの参照を定義します。

type: object
properties:
  pet:
    ref: #/defs/Pet
defs:
  Pet:
    type: object
    properties:
      name:
        type: string

「pet」プロパティの値は、「Pet」という名前のスキーマノードへの参照です。詳しくは、https://json-schema.org/understanding-json-schema/structuring をご覧ください。

defs

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

省略可。ref で使用する定義のマップ。スキーマのルートでのみ許可されます。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

title

string

省略可。スキーマのタイトル。

minItems

string (int64 format)

省略可。Type.ARRAY の要素の最小数。

maxItems

string (int64 format)

省略可。Type.ARRAY の要素の最大数。

共用体フィールド _minimum

_minimum は次のいずれかになります。

minimum

number

省略可。Type.INTEGER と Type.NUMBER の最小値。

共用体フィールド _maximum

_maximum は次のいずれかになります。

maximum

number

省略可。Type.INTEGER と Type.NUMBER の最大値。

PropertiesEntry

JSON 表現
{
  "key": string,
  "value": {
    object (Schema)
  }
}
フィールド
key

string

value

object (Schema)

JSON 表現
{

  // Union field kind can be only one of the following:
  "nullValue": null,
  "numberValue": number,
  "stringValue": string,
  "boolValue": boolean,
  "structValue": {
    object
  },
  "listValue": array
  // End of list of possible types for union field kind.
}
フィールド
共用体フィールド kind。値の種類。kind は次のいずれかになります。
nullValue

null

null 値を表します。

numberValue

number

double 値を表します。

stringValue

string

文字列値を表します。

boolValue

boolean

ブール値を表します。

structValue

object (Struct format)

構造化された値を表します。

listValue

array (ListValue format)

Value の繰り返しを表します。

構造体

JSON 表現
{
  "fields": {
    string: value,
    ...
  }
}
フィールド
fields

map (key: string, value: value (Value format))

動的に型指定される値の順序なしのマップ。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

FieldsEntry

JSON 表現
{
  "key": string,
  "value": value
}
フィールド
key

string

value

value (Value format)

ListValue

JSON 表現
{
  "values": [
    value
  ]
}
フィールド
values[]

value (Value format)

動的に型指定される値の繰り返しフィールド。

DefsEntry

JSON 表現
{
  "key": string,
  "value": {
    object (Schema)
  }
}
フィールド
key

string

value

object (Schema)

DataStoreSettings

JSON 表現
{
  "engines": [
    {
      object (Engine)
    }
  ]
}
フィールド
engines[]

object (Engine)

出力専用。アプリのエンジン。

エンジン

JSON 表現
{
  "name": string,
  "type": enum (Type)
}
フィールド
name

string

出力専用。エンジンのリソース名。形式: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}

type

enum (Type)

出力専用。エンジンの種類。

ChannelProfile

JSON 表現
{
  "profileId": string,
  "channelType": enum (ChannelType),
  "personaProperty": {
    object (PersonaProperty)
  },
  "disableDtmf": boolean,
  "disableBargeInControl": boolean,
  "webWidgetConfig": {
    object (WebWidgetConfig)
  },
  "noiseSuppressionLevel": string
}
フィールド
profileId

string

省略可。チャネル プロファイルの一意の識別子。

channelType

enum (ChannelType)

省略可。チャンネル プロファイルのタイプ。

personaProperty

object (PersonaProperty)

省略可。チャンネル プロファイルのペルソナ プロパティ。

disableDtmf

boolean

省略可。DTMF(デュアルトーン マルチ周波数)を無効にするかどうか。

disableBargeInControl

boolean

省略可。会話でユーザーの割り込み制御を無効にするかどうか。- true: エージェントが話している間、ユーザーによる割り込みが無効になります。- false: エージェントは、ユーザーが割り込みできるタイミングを自動的に制御します。

webWidgetConfig

object (WebWidgetConfig)

省略可。ウェブ ウィジェットの構成。

noiseSuppressionLevel

string

省略可。チャンネル プロファイルのノイズ抑制レベル。使用可能な値は、「low」、「moderate」、「high」、「very_high」です。

PersonaProperty

JSON 表現
{
  "persona": enum (Persona)
}
フィールド
persona

enum (Persona)

省略可。チャンネルのペルソナ。

WebWidgetConfig

JSON 表現
{
  "modality": enum (Modality),
  "theme": enum (Theme),
  "webWidgetTitle": string,
  "securitySettings": {
    object (SecuritySettings)
  }
}
フィールド
modality

enum (Modality)

省略可。ウェブ ウィジェットのモダリティ。

theme

enum (Theme)

省略可。ウェブ ウィジェットのテーマ。

webWidgetTitle

string

省略可。ウェブ ウィジェットのタイトル。

securitySettings

object (SecuritySettings)

省略可。ウェブ ウィジェットのセキュリティ設定。

SecuritySettings

JSON 表現
{
  "enablePublicAccess": boolean,
  "enableOriginCheck": boolean,
  "allowedOrigins": [
    string
  ],
  "enableRecaptcha": boolean
}
フィールド
enablePublicAccess

boolean

省略可。ウェブ ウィジェットへの一般公開アクセスが有効かどうかを示します。true の場合、ウェブ ウィジェットは一般公開されます。false の場合、ウェブ ウィジェットは、CES エージェントにアクセスするための有効な認証情報を返すために、独自の認証システムおよび認可システムと統合する必要があります。

enableOriginCheck

boolean

省略可。ウェブ ウィジェットのオリジン チェックが有効かどうかを示します。true の場合、ウェブ ウィジェットは、ウェブ ウィジェットを読み込むウェブサイトのオリジンを確認し、同じオリジンまたは許可されたオリジンのいずれかでのみ読み込みを許可します。

allowedOrigins[]

string

省略可。ウェブ ウィジェットのホストを許可されているオリジン。オリジンは RFC 6454 で定義されています。空の場合、すべてのオリジンが許可されます。最大 100 個のオリジンを指定できます。例: "https://example.com"

enableRecaptcha

boolean

省略可。ウェブ ウィジェットの reCAPTCHA 検証が有効かどうかを示します。

MetadataEntry

JSON 表現
{
  "key": string,
  "value": string
}
フィールド
key

string

value

string

タイムスタンプ

JSON 表現
{
  "seconds": string,
  "nanos": integer
}
フィールド
seconds

string (int64 format)

UNIX エポック 1970-01-01T00:00:00Z からの UTC 時刻の秒数を表します。-62135596800~253402300799 の範囲(両端を含む)にする必要があります(これは 0001-01-01T00:00:00Z~9999-12-31T23:59:59Z に対応します)。

nanos

integer

ナノ秒分解能による、秒の負ではない小数以下部分。このフィールドは、秒の代替ではなく、期間のナノ秒部分です。小数以下を含む負の秒の値は、時間を前方にカウントする負ではない nanos 値を持つ必要があります。0~999,999,999 にする必要があります(両端を含む)。

ClientCertificateSettings

JSON 表現
{
  "tlsCertificate": string,
  "privateKey": string,
  "passphrase": string
}
フィールド
tlsCertificate

string

必須。PEM 形式でエンコードされた TLS 証明書。この文字列には、ヘッダーの開始行とフッターの終了行を含める必要があります。

privateKey

string

必須。PEM 形式でエンコードされた秘密鍵を保存する SecretManager シークレット バージョン リソースの名前。形式: projects/{project}/secrets/{secret}/versions/{version}

passphrase

string

省略可。秘密鍵を復号するためのパスフレーズを保存する SecretManager シークレット バージョン リソースの名前。秘密鍵が暗号化されていない場合は、設定しないでください。形式: projects/{project}/secrets/{secret}/versions/{version}

出力スキーマ

このリソースは、ネットワーク API 呼び出しの結果である長時間実行オペレーションを表します。

オペレーション

JSON 表現
{
  "name": string,
  "metadata": {
    "@type": string,
    field1: ...,
    ...
  },
  "done": boolean,

  // Union field result can be only one of the following:
  "error": {
    object (Status)
  },
  "response": {
    "@type": string,
    field1: ...,
    ...
  }
  // End of list of possible types for union field result.
}
フィールド
name

string

サーバーによって割り当てられる名前。最初にその名前を返すサービスと同じサービス内でのみ一意になります。デフォルトの HTTP マッピングを使用している場合は、nameoperations/{unique_id} で終わるリソース名にします。

metadata

object

オペレーションに関連付けられているサービス固有のメタデータ。通常は進捗情報や、作成日時などの共通メタデータが含まれます。一部のサービスでは、このようなメタデータが提供されないこともあります。メタデータがある場合、長時間実行オペレーションを返すメソッドでは、メタデータの型をドキュメント化しておく必要があります。

任意の型のフィールドを含むオブジェクト。型を識別する URI を含むフィールド "@type" を追加できます。例: { "id": 1234, "@type": "types.example.com/standard/id" }

done

boolean

値が false の場合は、オペレーションが進行中であることを意味します。true の場合、オペレーションは完了しており、error または response が利用可能です。

共用体フィールド result。オペレーションの結果。error または有効な response になります。done == false の場合、errorresponse も設定されません。done == true の場合、error または response のどちらか 1 つだけが設定されます。一部のサービスでは結果が返されない場合があります。result は次のいずれかになります。
error

object (Status)

失敗またはキャンセルされた場合のオペレーションのエラー結果。

response

object

オペレーションの通常の成功レスポンス。元のメソッドで成功時にデータが返されない場合(Delete など)、レスポンスは google.protobuf.Empty になります。元のメソッドが標準の Get/Create/Update である場合、レスポンスはリソースになります。他のメソッドについては、レスポンスの型が XxxResponseXxx は元のメソッド名)になります。たとえば、元のメソッド名が TakeSnapshot() であれば、レスポンスの型は TakeSnapshotResponse になると推測できます。

任意の型のフィールドを含むオブジェクト。型を識別する URI を含むフィールド "@type" を追加できます。例: { "id": 1234, "@type": "types.example.com/standard/id" }

すべて

JSON 表現
{
  "typeUrl": string,
  "value": string
}
フィールド
typeUrl

string

スラッシュで終わる接頭辞と完全修飾型名で構成される URI 参照を使用して、シリアル化された Protobuf メッセージの型を識別します。

例: type.googleapis.com/google.protobuf.StringValue

この文字列には / 文字を 1 つ以上含める必要があります。最後の / の後のコンテンツは、先頭のドットのない正規形式の型の完全修飾名である必要があります。クライアントが連絡を試みないように、これらの URI 参照にスキームを記述しないでください。

接頭辞は任意であり、Protobuf 実装では、最後の / までをすべて削除して型を識別することが想定されています。type.googleapis.com/ は、一部のレガシー実装で必要な一般的なデフォルトの接頭辞です。この接頭辞は型のオリジンを示すものではなく、これを含む URI はリクエストに応答しないことが想定されています。

すべてのタイプ URL 文字列は、有効な URI 参照である必要があります。また、テキスト形式の場合、参照の内容は英数字、パーセント エンコードされたエスケープ、および次のセットの文字(外側のバッククォートを除く)/-.~_!$&()*+,;= のみで構成されている必要があります。パーセント エンコードは許可されていますが、既存のパーサーとの混同を避けるため、実装ではエスケープ解除しないでください。たとえば、type.googleapis.com%2FFoo は拒否される必要があります。

Any の元の設計では、これらの型 URL で型解決サービスを起動する可能性が検討されましたが、Protobuf は実装していません。また、これらの URL へのアクセスは問題があり、セキュリティ上の問題を引き起こす可能性があると見なされています。連絡先タイプの URL にアクセスしないでください。

value

string (bytes format)

type_url で記述された型の Protobuf シリアル化を保持します。

Base64 でエンコードされた文字列。

ステータス

JSON 表現
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
フィールド
code

integer

ステータス コード。google.rpc.Code の列挙値である必要があります。

message

string

デベロッパー向けのエラー メッセージ。英語で記述します。ユーザー向けのエラー メッセージは、ローカライズして google.rpc.Status.details フィールドで送信するか、クライアントでローカライズする必要があります。

details[]

object

エラーの詳細を保持するメッセージのリスト。API が使用する共通のメッセージ タイプのセットがあります。

任意のデータ型のフィールドを含むオブジェクトであり、型を識別する URI を含むフィールド "@type" を追加できます。例: { "id": 1234, "@type": "types.example.com/standard/id" }

ツールのアノテーション

破壊的ヒント: ✅ | べき等ヒント: ❌ | 読み取り専用ヒント: ❌ | オープン ワールド ヒント: ❌