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/actions/sdk/v2/interactionmodel/prompt/content/static_image_prompt.proto";
20import "google/actions/sdk/v2/interactionmodel/prompt/content/static_link_prompt.proto";
21import "google/api/field_behavior.proto";
22
23option go_package = "google.golang.org/genproto/googleapis/actions/sdk/v2/interactionmodel/prompt;prompt";
24option java_multiple_files = true;
25option java_outer_classname = "StaticCollectionBrowsePromptProto";
26option java_package = "com.google.actions.sdk.v2.interactionmodel.prompt";
27
28// Presents a set of web documents as a collection of large-tile items. Items
29// may be selected to launch their associated web document in a web viewer.
30message StaticCollectionBrowsePrompt {
31  // Item in the collection.
32  message CollectionBrowseItem {
33    // Required. Title of the collection item.
34    string title = 1 [(google.api.field_behavior) = REQUIRED];
35
36    // Description of the collection item.
37    string description = 2;
38
39    // Footer text for the collection item, displayed below the description.
40    // Single line of text, truncated with an ellipsis.
41    string footer = 3;
42
43    // Image for the collection item.
44    StaticImagePrompt image = 4;
45
46    // Required. URI to open if the item selected.
47    OpenUrl open_uri_action = 5 [(google.api.field_behavior) = REQUIRED];
48  }
49
50  // Items in the browse collection. The list size should be in the range [2,
51  // 10].
52  repeated CollectionBrowseItem items = 1;
53
54  // Image display option for images in the collection.
55  StaticImagePrompt.ImageFill image_fill = 2;
56}
57