1// Copyright 2020 Google LLC
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15syntax = "proto3";
16
17package google.actions.sdk.v2.interactionmodel.prompt;
18
19import "google/api/field_behavior.proto";
20import "google/protobuf/struct.proto";
21
22option go_package = "google.golang.org/genproto/googleapis/actions/sdk/v2/interactionmodel/prompt;prompt";
23option java_multiple_files = true;
24option java_outer_classname = "StaticCanvasPromptProto";
25option java_package = "com.google.actions.sdk.v2.interactionmodel.prompt";
26
27// Represents a Interactive Canvas response to be sent to the user.
28// This can be used in conjunction with the `first_simple` field in the
29// containing prompt to speak to the user in addition to displaying a
30// interactive canvas response.
31message StaticCanvasPrompt {
32  // Required. URL of the web view to load.
33  string url = 1 [(google.api.field_behavior) = REQUIRED];
34
35  // Optional. JSON data to be passed through to the immersive experience web page as an
36  // event. If the `override` field in the containing prompt is `false` data
37  // values defined in this Canvas prompt will be added after data values
38  // defined in previous Canvas prompts.
39  repeated google.protobuf.Value data = 2 [(google.api.field_behavior) = OPTIONAL];
40
41  // Optional. A true value means that the mic won't be opened for capturing input after
42  // this immersive response is presented to the user.
43  bool suppress_mic = 3 [(google.api.field_behavior) = OPTIONAL];
44
45  // Optional. If `true`, conversation related metadata is included and send back to the
46  // canvas application.
47  bool send_state_data_to_canvas_app = 5 [(google.api.field_behavior) = OPTIONAL];
48
49  // Optional. If `true` the canvas application occupies the full screen and won't
50  // have a header at the top. A toast message will also be displayed on the
51  // loading screen that includes the Action's display name, the developer's
52  // name, and instructions for exiting the Action. Default value: `false`.
53  bool enable_full_screen = 6 [(google.api.field_behavior) = OPTIONAL];
54}
55