xref: /aosp_15_r20/external/googleapis/google/actions/sdk/v2/localized_settings.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
19import "google/actions/sdk/v2/theme_customization.proto";
20import "google/api/field_behavior.proto";
21
22option go_package = "google.golang.org/genproto/googleapis/actions/sdk/v2;sdk";
23option java_multiple_files = true;
24option java_outer_classname = "LocalizedSettingsProto";
25option java_package = "com.google.actions.sdk.v2";
26
27// Represents settings of an Actions project that are specific to a user locale.
28// In this instance, user means the end user who invokes your Actions.
29// **This message is localizable.**
30message LocalizedSettings {
31  // Required. The default display name for this Actions project (if there is no
32  // translation available)
33  string display_name = 1 [(google.api.field_behavior) = REQUIRED];
34
35  // Required. The pronunciation of the display name to invoke it within a voice
36  // (spoken) context.
37  string pronunciation = 2 [(google.api.field_behavior) = REQUIRED];
38
39  // Required. The default short description for the Actions project (if there is no
40  // translation available). 80 character limit.
41  string short_description = 3 [(google.api.field_behavior) = REQUIRED];
42
43  // Required. The default long description for the Actions project (if there is no
44  // translation available). 4000 character limit.
45  string full_description = 4 [(google.api.field_behavior) = REQUIRED];
46
47  // Required. Small square image, 192 x 192 px.
48  // This should be specified as a reference to the corresponding image in the
49  // `resources/images/` directory. For example, `$resources.images.foo` (without the
50  // extension) for image in `resources/images/foo.jpg`
51  // When working on a project pulled from Console, the Google-managed URL
52  // pulled could be used. URLs from external sources are not allowed.
53  string small_logo_image = 5 [(google.api.field_behavior) = REQUIRED];
54
55  // Optional. Large landscape image, 1920 x 1080 px.
56  // This should be specified as a reference to the corresponding image in the
57  // `resources/images/` directory. For example, `$resources.images.foo` (without the
58  // extension) for image in `resources/images/foo.jpg`
59  // When working on a project pulled from Console, the Google-managed URL
60  // pulled could be used. URLs from external sources are not allowed.
61  string large_banner_image = 6 [(google.api.field_behavior) = OPTIONAL];
62
63  // Required. The name of the developer to be displayed to users.
64  string developer_name = 7 [(google.api.field_behavior) = REQUIRED];
65
66  // Required. The contact email address for the developer.
67  string developer_email = 8 [(google.api.field_behavior) = REQUIRED];
68
69  // Optional. The terms of service URL.
70  string terms_of_service_url = 9 [(google.api.field_behavior) = OPTIONAL];
71
72  // Required. The Google Assistant voice type that users hear when they interact with
73  // your Actions. The supported values are "male_1", "male_2", "female_1", and
74  // "female_2".
75  string voice = 10 [(google.api.field_behavior) = REQUIRED];
76
77  // Optional. The locale for the specified voice. If not specified, this resolves
78  // to the user's Assistant locale. If specified, the voice locale must have
79  // the same root language as the locale specified in LocalizedSettings.
80  string voice_locale = 14 [(google.api.field_behavior) = OPTIONAL];
81
82  // Required. The privacy policy URL.
83  string privacy_policy_url = 11 [(google.api.field_behavior) = REQUIRED];
84
85  // Optional. Sample invocation phrases displayed as part of your Actions project's
86  // description in the Assistant directory. This will help users learn how to
87  // use it.
88  repeated string sample_invocations = 12 [(google.api.field_behavior) = OPTIONAL];
89
90  // Optional. Theme customizations for visual components of your Actions.
91  ThemeCustomization theme_customization = 13 [(google.api.field_behavior) = OPTIONAL];
92}
93