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.conversation; 18 19import "google/protobuf/struct.proto"; 20 21option go_package = "google.golang.org/genproto/googleapis/actions/sdk/v2/conversation;conversation"; 22option java_multiple_files = true; 23option java_outer_classname = "CanvasProto"; 24option java_package = "com.google.actions.sdk.v2.conversation"; 25 26// Represents an Interactive Canvas response to be sent to the user. 27// This can be used in conjunction with the "first_simple" field in the 28// containing prompt to speak to the user in addition to displaying a 29// interactive canvas response. The maximum size of the response is 50k bytes. 30message Canvas { 31 // URL of the interactive canvas web app to load. If not set, the url from 32 // current active canvas will be reused. 33 string url = 1; 34 35 // Optional. JSON data to be passed through to the immersive experience 36 // web page as an event. 37 // If the "override" field in the containing prompt is "false" data values 38 // defined in this Canvas prompt will be added after data values defined in 39 // previous Canvas prompts. 40 repeated google.protobuf.Value data = 4; 41 42 // Optional. Default value: false. 43 bool suppress_mic = 3; 44 45 // If `true` the canvas application occupies the full screen and won't 46 // have a header at the top. A toast message will also be displayed on the 47 // loading screen that includes the Action's display name, the developer's 48 // name, and instructions for exiting the Action. Default value: `false`. 49 bool enable_full_screen = 8; 50} 51