xref: /aosp_15_r20/external/googleapis/google/actions/sdk/v2/theme_customization.proto (revision d5c09012810ac0c9f33fe448fb6da8260d444cc9)
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;
18
19option go_package = "google.golang.org/genproto/googleapis/actions/sdk/v2;sdk";
20option java_multiple_files = true;
21option java_outer_classname = "ThemeCustomizationProto";
22option java_package = "com.google.actions.sdk.v2";
23
24// Styles applied to cards that are presented to users
25message ThemeCustomization {
26  // Describes how the borders of images should be rendered.
27  enum ImageCornerStyle {
28    // Undefined / Unspecified.
29    IMAGE_CORNER_STYLE_UNSPECIFIED = 0;
30
31    // Round corner for image.
32    CURVED = 1;
33
34    // Rectangular corner for image.
35    ANGLED = 2;
36  }
37
38  // Background color of cards. Acts as a fallback if `background_image` is
39  // not provided by developers or `background_image` doesn't fit for certain
40  // surfaces.
41  // Example usage: #FAFAFA
42  string background_color = 1;
43
44  // Primary theme color of the Action will be used to set text color of title,
45  // action item background color for Actions on Google cards.
46  // Example usage: #FAFAFA
47  string primary_color = 2;
48
49  // The font family that will be used for title of cards.
50  // Supported fonts:
51  // - Sans Serif
52  // - Sans Serif Medium
53  // - Sans Serif Bold
54  // - Sans Serif Black
55  // - Sans Serif Condensed
56  // - Sans Serif Condensed Medium
57  // - Serif
58  // - Serif Bold
59  // - Monospace
60  // - Cursive
61  // - Sans Serif Smallcaps
62  string font_family = 3;
63
64  // Border style of foreground image of cards. For example, can be applied on
65  // the foreground image of a basic card or carousel card.
66  ImageCornerStyle image_corner_style = 4;
67
68  // Landscape mode (minimum 1920x1200 pixels).
69  // This should be specified as a reference to the corresponding image in the
70  // `resources/images/` directory. Eg: `$resources.images.foo` (without the
71  // extension) for image in `resources/images/foo.jpg`
72  // When working on a project pulled from Console the Google managed url pulled
73  // could be used.
74  string landscape_background_image = 5;
75
76  // Portrait mode (minimum 1200x1920 pixels).
77  // This should be specified as a reference to the corresponding image in the
78  // `resources/images/` directory. Eg: `$resources.images.foo` (without the
79  // extension) for image in `resources/images/foo.jpg`
80  // When working on a project pulled from Console the Google managed url pulled
81  // could be used.
82  string portrait_background_image = 6;
83}
84