feat: add support for defining custom actions in code. See https://cloud.google.com/dialogflow/cx/docs/concept/playbook/code-block for more information

Google APIs · copybara-github · commit ba80e9b5251c · 2025-11-10T13:42:43.000-08:00
feat: Service Account Auth in Tools and Webhooks

PiperOrigin-RevId: 830582229
diff --git a/google/cloud/dialogflow/cx/v3beta1/BUILD.bazel b/google/cloud/dialogflow/cx/v3beta1/BUILD.bazel
@@ -29,6 +29,7 @@ proto_library(
         "audio_config.proto",
         "bigquery_export.proto",
         "changelog.proto",
+        "code_block.proto",
         "conversation_history.proto",
         "data_store_connection.proto",
         "deployment.proto",
diff --git a/google/cloud/dialogflow/cx/v3beta1/code_block.proto b/google/cloud/dialogflow/cx/v3beta1/code_block.proto
@@ -0,0 +1,32 @@
+// Copyright 2025 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+syntax = "proto3";
+
+package google.cloud.dialogflow.cx.v3beta1;
+
+import "google/api/field_behavior.proto";
+
+option csharp_namespace = "Google.Cloud.Dialogflow.Cx.V3Beta1";
+option go_package = "cloud.google.com/go/dialogflow/cx/apiv3beta1/cxpb;cxpb";
+option java_multiple_files = true;
+option java_outer_classname = "CodeBlockProto";
+option java_package = "com.google.cloud.dialogflow.cx.v3beta1";
+option objc_class_prefix = "DF";
+
+// Represents a code block.
+message CodeBlock {
+  // Optional. Source code of the block in Python.
+  string code = 1 [(google.api.field_behavior) = OPTIONAL];
+}
diff --git a/google/cloud/dialogflow/cx/v3beta1/playbook.proto b/google/cloud/dialogflow/cx/v3beta1/playbook.proto
@@ -21,6 +21,7 @@ import "google/api/client.proto";
 import "google/api/field_behavior.proto";
 import "google/api/resource.proto";
 import "google/cloud/dialogflow/cx/v3beta1/advanced_settings.proto";
+import "google/cloud/dialogflow/cx/v3beta1/code_block.proto";
 import "google/cloud/dialogflow/cx/v3beta1/example.proto";
 import "google/cloud/dialogflow/cx/v3beta1/fulfillment.proto";
 import "google/cloud/dialogflow/cx/v3beta1/generative_settings.proto";
@@ -363,6 +364,19 @@ message Playbook {
     (google.api.resource_reference) = { type: "dialogflow.googleapis.com/Tool" }
   ];
 
+  // Optional. Output only. Names of inline actions scoped to this playbook.
+  // These actions are in addition to those belonging to referenced tools, child
+  // playbooks, and flows, e.g. actions that are defined in the playbook's code
+  // block.
+  repeated string inline_actions = 22 [
+    (google.api.field_behavior) = OPTIONAL,
+    (google.api.field_behavior) = OUTPUT_ONLY
+  ];
+
+  // Optional. The playbook's scoped code block, which may implement handlers
+  // and actions.
+  CodeBlock code_block = 21 [(google.api.field_behavior) = OPTIONAL];
+
   // Optional. Llm model settings for the playbook.
   LlmModelSettings llm_model_settings = 14
       [(google.api.field_behavior) = OPTIONAL];
diff --git a/google/cloud/dialogflow/cx/v3beta1/tool.proto b/google/cloud/dialogflow/cx/v3beta1/tool.proto
@@ -591,6 +591,20 @@ message Tool {
       ];
     }
 
+    // Configuration for authentication using a service account.
+    message ServiceAccountAuthConfig {
+      // Required. The email address of the service account used to authenticate
+      // the tool call. Dialogflow uses this service account to exchange an
+      // access token and the access token is then sent in the `Authorization`
+      // header of the tool request.
+      //
+      // The service account must have the
+      // `roles/iam.serviceAccountTokenCreator` role granted to the
+      // [Dialogflow service
+      // agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
+      string service_account = 1 [(google.api.field_behavior) = REQUIRED];
+    }
+
     // The auth configuration.
     oneof auth_config {
       // Config for API key auth.
@@ -606,6 +620,9 @@ message Tool {
 
       // Config for bearer token auth.
       BearerTokenConfig bearer_token_config = 4;
+
+      // Configuration for service account authentication.
+      ServiceAccountAuthConfig service_account_auth_config = 5;
     }
   }
 
diff --git a/google/cloud/dialogflow/cx/v3beta1/webhook.proto b/google/cloud/dialogflow/cx/v3beta1/webhook.proto
@@ -165,6 +165,20 @@ message Webhook {
       ACCESS_TOKEN = 3;
     }
 
+    // Configuration for authentication using a service account.
+    message ServiceAccountAuthConfig {
+      // Required. The email address of the service account used to authenticate
+      // the webhook call. Dialogflow uses this service account to exchange an
+      // access token and the access token is then sent in the `Authorization`
+      // header of the webhook request.
+      //
+      // The service account must have the
+      // `roles/iam.serviceAccountTokenCreator` role granted to the
+      // [Dialogflow service
+      // agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
+      string service_account = 1 [(google.api.field_behavior) = REQUIRED];
+    }
+
     // Represents the type of webhook configuration.
     enum WebhookType {
       // Default value. This value is unused.
@@ -263,6 +277,10 @@ message Webhook {
     ServiceAgentAuth service_agent_auth = 12
         [(google.api.field_behavior) = OPTIONAL];
 
+    // Optional. Configuration for service account authentication.
+    ServiceAccountAuthConfig service_account_auth_config = 18
+        [(google.api.field_behavior) = OPTIONAL];
+
     // Optional. Type of the webhook.
     WebhookType webhook_type = 6 [(google.api.field_behavior) = OPTIONAL];
 
