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/api/field_behavior.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 = "StaticCollectionPromptProto";
25option java_package = "com.google.actions.sdk.v2.interactionmodel.prompt";
26
27// A card for presenting a collection of options to select from.
28message StaticCollectionPrompt {
29  // An item in the collection.
30  message CollectionItem {
31    // Required. The NLU key that matches the entry key name in the associated
32    // Type. When item tapped, this key will be posted back as a select option
33    // parameter.
34    string key = 1 [(google.api.field_behavior) = REQUIRED];
35
36    // Required. Title of the item. When tapped, this text will be
37    // posted back to the conversation verbatim as if the user had typed it.
38    // Each title must be unique among the set of items.
39    string title = 2 [(google.api.field_behavior) = REQUIRED];
40
41    // Optional. Body text of the item.
42    string description = 3 [(google.api.field_behavior) = OPTIONAL];
43
44    // Optional. Item image.
45    StaticImagePrompt image = 4 [(google.api.field_behavior) = OPTIONAL];
46  }
47
48  // Optional. Title of the collection.
49  string title = 1 [(google.api.field_behavior) = OPTIONAL];
50
51  // Optional. Subtitle of the collection.
52  string subtitle = 2 [(google.api.field_behavior) = OPTIONAL];
53
54  // Required. Collection items.
55  repeated CollectionItem items = 3 [(google.api.field_behavior) = REQUIRED];
56
57  // Optional. Type of image display option.
58  StaticImagePrompt.ImageFill image_fill = 4 [(google.api.field_behavior) = OPTIONAL];
59}
60