xref: /aosp_15_r20/external/googleapis/google/ads/admanager/v1/creative_placeholder.proto (revision d5c09012810ac0c9f33fe448fb6da8260d444cc9)
1// Copyright 2023 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.ads.admanager.v1;
18
19import "google/ads/admanager/v1/applied_label.proto";
20import "google/ads/admanager/v1/size.proto";
21import "google/api/field_behavior.proto";
22
23option csharp_namespace = "Google.Ads.AdManager.V1";
24option go_package = "google.golang.org/genproto/googleapis/ads/admanager/v1;admanager";
25option java_multiple_files = true;
26option java_outer_classname = "CreativePlaceholderProto";
27option java_package = "com.google.ads.admanager.v1";
28option objc_class_prefix = "GAA";
29option php_namespace = "Google\\Ads\\AdManager\\V1";
30
31// Describes a slot that a creative is expected to fill. This is used in
32// forecasting and to validate that the correct creatives are associated with
33// the line item.
34message CreativePlaceholder {
35  // Required. The size that the creative is expected to have.
36  Size size = 1 [(google.api.field_behavior) = REQUIRED];
37
38  // The companions that the creative is expected to have. This attribute can
39  // only be set if the line item it belongs to has an
40  // [EnvironmentType][google.ads.admanager.v1.EnvironmentTypeEnum.EnvironmentType]
41  // of VIDEO_PLAYER or [roadblocking_type][LineItem.roadblocking_type] of
42  // CREATIVE_SET.
43  repeated Size companion_sizes = 2;
44
45  // Expected number of creatives that will be uploaded corresponding to this
46  // creative placeholder.  This estimate is used to improve the accuracy of
47  // forecasting; for example, if label frequency capping limits the number of
48  // times a creative may be served.
49  int32 expected_creative_count = 3;
50
51  // Set of labels applied directly to this CreativePlaceholder.
52  repeated AppliedLabel applied_labels = 4;
53
54  // Indicates if the expected creative of this placeholder has an AMP only
55  // variant. This is used to improve the accuracy of forecasting and has no
56  // effect on serving.
57  bool amp_only = 5;
58
59  // The display name of the creative targeting that this CreativePlaceholder
60  // represents.
61  string creative_targeting_display_name = 6;
62}
63