@google-ads/admanager 0.3.0 → 0.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +27 -2
- package/build/protos/google/ads/admanager/v1/ad_break_messages.proto +134 -0
- package/build/protos/google/ads/admanager/v1/ad_break_service.proto +269 -0
- package/build/protos/google/ads/admanager/v1/ad_unit_enums.proto +1 -1
- package/build/protos/google/ads/admanager/v1/ad_unit_messages.proto +32 -26
- package/build/protos/google/ads/admanager/v1/ad_unit_service.proto +3 -1
- package/build/protos/google/ads/admanager/v1/admanager_error.proto +1 -1
- package/build/protos/google/ads/admanager/v1/applied_label.proto +1 -1
- package/build/protos/google/ads/admanager/v1/bandwidth_group_messages.proto +46 -0
- package/build/protos/google/ads/admanager/v1/bandwidth_group_service.proto +129 -0
- package/build/protos/google/ads/admanager/v1/company_enums.proto +123 -0
- package/build/protos/google/ads/admanager/v1/company_messages.proto +6 -7
- package/build/protos/google/ads/admanager/v1/company_service.proto +3 -1
- package/build/protos/google/ads/admanager/v1/contact_messages.proto +4 -4
- package/build/protos/google/ads/admanager/v1/custom_field_enums.proto +1 -1
- package/build/protos/google/ads/admanager/v1/custom_field_messages.proto +12 -11
- package/build/protos/google/ads/admanager/v1/custom_field_service.proto +3 -1
- package/build/protos/google/ads/admanager/v1/custom_field_value.proto +1 -2
- package/build/protos/google/ads/admanager/v1/custom_targeting_key_enums.proto +1 -1
- package/build/protos/google/ads/admanager/v1/custom_targeting_key_messages.proto +1 -1
- package/build/protos/google/ads/admanager/v1/custom_targeting_key_service.proto +3 -1
- package/build/protos/google/ads/admanager/v1/custom_targeting_value_enums.proto +1 -1
- package/build/protos/google/ads/admanager/v1/custom_targeting_value_messages.proto +14 -3
- package/build/protos/google/ads/admanager/v1/custom_targeting_value_service.proto +14 -6
- package/build/protos/google/ads/admanager/v1/deal_buyer_permission_type_enum.proto +41 -0
- package/build/protos/google/ads/admanager/v1/device_category_messages.proto +45 -0
- package/build/protos/google/ads/admanager/v1/device_category_service.proto +129 -0
- package/build/protos/google/ads/admanager/v1/early_ad_break_notification_enums.proto +47 -0
- package/build/protos/google/ads/admanager/v1/entity_signals_mapping_messages.proto +4 -4
- package/build/protos/google/ads/admanager/v1/entity_signals_mapping_service.proto +6 -4
- package/build/protos/google/ads/admanager/v1/environment_type_enum.proto +1 -1
- package/build/protos/google/ads/admanager/v1/frequency_cap.proto +1 -1
- package/build/protos/google/ads/admanager/v1/geo_target_messages.proto +70 -0
- package/build/protos/google/ads/admanager/v1/geo_target_service.proto +128 -0
- package/build/protos/google/ads/admanager/v1/label_messages.proto +1 -1
- package/build/protos/google/ads/admanager/v1/live_stream_event_messages.proto +47 -0
- package/build/protos/google/ads/admanager/v1/network_messages.proto +2 -2
- package/build/protos/google/ads/admanager/v1/network_service.proto +4 -2
- package/build/protos/google/ads/admanager/v1/operating_system_messages.proto +45 -0
- package/build/protos/google/ads/admanager/v1/operating_system_service.proto +129 -0
- package/build/protos/google/ads/admanager/v1/operating_system_version_messages.proto +52 -0
- package/build/protos/google/ads/admanager/v1/operating_system_version_service.proto +133 -0
- package/build/protos/google/ads/admanager/v1/order_enums.proto +1 -1
- package/build/protos/google/ads/admanager/v1/order_messages.proto +24 -20
- package/build/protos/google/ads/admanager/v1/order_service.proto +3 -1
- package/build/protos/google/ads/admanager/v1/placement_enums.proto +1 -1
- package/build/protos/google/ads/admanager/v1/placement_messages.proto +14 -14
- package/build/protos/google/ads/admanager/v1/placement_service.proto +3 -1
- package/build/protos/google/ads/admanager/v1/private_auction_deal_messages.proto +119 -0
- package/build/protos/google/ads/admanager/v1/private_auction_deal_service.proto +184 -0
- package/build/protos/google/ads/admanager/v1/private_auction_messages.proto +74 -0
- package/build/protos/google/ads/admanager/v1/private_auction_service.proto +180 -0
- package/build/protos/google/ads/admanager/v1/private_marketplace_enums.proto +50 -0
- package/build/protos/google/ads/admanager/v1/programmatic_buyer_messages.proto +72 -0
- package/build/protos/google/ads/admanager/v1/programmatic_buyer_service.proto +131 -0
- package/build/protos/google/ads/admanager/v1/report_messages.proto +3536 -0
- package/build/protos/google/ads/admanager/v1/report_service.proto +5 -3247
- package/build/protos/google/ads/admanager/v1/request_platform_enum.proto +49 -0
- package/build/protos/google/ads/admanager/v1/role_enums.proto +1 -1
- package/build/protos/google/ads/admanager/v1/role_messages.proto +6 -6
- package/build/protos/google/ads/admanager/v1/role_service.proto +3 -1
- package/build/protos/google/ads/admanager/v1/size.proto +7 -11
- package/build/protos/google/ads/admanager/v1/size_type_enum.proto +1 -1
- package/build/protos/google/ads/admanager/v1/targeted_video_bumper_type_enum.proto +44 -0
- package/build/protos/google/ads/admanager/v1/targeting.proto +328 -0
- package/build/protos/google/ads/admanager/v1/taxonomy_category_messages.proto +7 -6
- package/build/protos/google/ads/admanager/v1/taxonomy_category_service.proto +3 -1
- package/build/protos/google/ads/admanager/v1/taxonomy_type_enum.proto +1 -1
- package/build/protos/google/ads/admanager/v1/team_messages.proto +1 -5
- package/build/protos/google/ads/admanager/v1/time_unit_enum.proto +1 -1
- package/build/protos/google/ads/admanager/v1/user_messages.proto +10 -9
- package/build/protos/google/ads/admanager/v1/user_service.proto +3 -1
- package/build/protos/google/ads/admanager/v1/video_position_enum.proto +47 -0
- package/build/protos/protos.d.ts +15832 -7575
- package/build/protos/protos.js +57744 -36372
- package/build/protos/protos.json +5795 -2511
- package/build/src/index.d.ts +28 -1
- package/build/src/index.js +20 -17
- package/build/src/index.js.map +1 -1
- package/build/src/v1/ad_break_service_client.d.ts +1040 -0
- package/build/src/v1/ad_break_service_client.js +1483 -0
- package/build/src/v1/ad_break_service_client.js.map +1 -0
- package/build/src/v1/ad_break_service_client_config.json +46 -0
- package/build/src/v1/ad_break_service_proto_list.json +74 -0
- package/build/src/v1/ad_unit_service_client.d.ts +331 -91
- package/build/src/v1/ad_unit_service_client.js +414 -106
- package/build/src/v1/ad_unit_service_client.js.map +1 -1
- package/build/src/v1/ad_unit_service_proto_list.json +29 -3
- package/build/src/v1/bandwidth_group_service_client.d.ts +904 -0
- package/build/src/v1/bandwidth_group_service_client.js +1369 -0
- package/build/src/v1/bandwidth_group_service_client.js.map +1 -0
- package/build/src/v1/bandwidth_group_service_client_config.json +34 -0
- package/build/src/v1/bandwidth_group_service_proto_list.json +74 -0
- package/build/src/v1/company_service_client.d.ts +291 -51
- package/build/src/v1/company_service_client.js +402 -81
- package/build/src/v1/company_service_client.js.map +1 -1
- package/build/src/v1/company_service_proto_list.json +29 -3
- package/build/src/v1/custom_field_service_client.d.ts +291 -51
- package/build/src/v1/custom_field_service_client.js +403 -85
- package/build/src/v1/custom_field_service_client.js.map +1 -1
- package/build/src/v1/custom_field_service_proto_list.json +29 -3
- package/build/src/v1/custom_targeting_key_service_client.d.ts +291 -51
- package/build/src/v1/custom_targeting_key_service_client.js +404 -88
- package/build/src/v1/custom_targeting_key_service_client.js.map +1 -1
- package/build/src/v1/custom_targeting_key_service_proto_list.json +29 -3
- package/build/src/v1/custom_targeting_value_service_client.d.ts +298 -58
- package/build/src/v1/custom_targeting_value_service_client.js +406 -90
- package/build/src/v1/custom_targeting_value_service_client.js.map +1 -1
- package/build/src/v1/custom_targeting_value_service_proto_list.json +29 -3
- package/build/src/v1/device_category_service_client.d.ts +904 -0
- package/build/src/v1/device_category_service_client.js +1369 -0
- package/build/src/v1/device_category_service_client.js.map +1 -0
- package/build/src/v1/device_category_service_client_config.json +34 -0
- package/build/src/v1/device_category_service_proto_list.json +74 -0
- package/build/src/v1/entity_signals_mapping_service_client.d.ts +298 -58
- package/build/src/v1/entity_signals_mapping_service_client.js +444 -124
- package/build/src/v1/entity_signals_mapping_service_client.js.map +1 -1
- package/build/src/v1/entity_signals_mapping_service_proto_list.json +29 -3
- package/build/src/v1/gapic_metadata.json +412 -0
- package/build/src/v1/geo_target_service_client.d.ts +904 -0
- package/build/src/v1/geo_target_service_client.js +1369 -0
- package/build/src/v1/geo_target_service_client.js.map +1 -0
- package/build/src/v1/geo_target_service_client_config.json +34 -0
- package/build/src/v1/geo_target_service_proto_list.json +74 -0
- package/build/src/v1/index.d.ts +9 -0
- package/build/src/v1/index.js +19 -1
- package/build/src/v1/index.js.map +1 -1
- package/build/src/v1/network_service_client.d.ts +252 -12
- package/build/src/v1/network_service_client.js +397 -65
- package/build/src/v1/network_service_client.js.map +1 -1
- package/build/src/v1/network_service_proto_list.json +29 -3
- package/build/src/v1/operating_system_service_client.d.ts +904 -0
- package/build/src/v1/operating_system_service_client.js +1369 -0
- package/build/src/v1/operating_system_service_client.js.map +1 -0
- package/build/src/v1/operating_system_service_client_config.json +34 -0
- package/build/src/v1/operating_system_service_proto_list.json +74 -0
- package/build/src/v1/operating_system_version_service_client.d.ts +911 -0
- package/build/src/v1/operating_system_version_service_client.js +1373 -0
- package/build/src/v1/operating_system_version_service_client.js.map +1 -0
- package/build/src/v1/operating_system_version_service_client_config.json +34 -0
- package/build/src/v1/operating_system_version_service_proto_list.json +74 -0
- package/build/src/v1/order_service_client.d.ts +296 -56
- package/build/src/v1/order_service_client.js +402 -81
- package/build/src/v1/order_service_client.js.map +1 -1
- package/build/src/v1/order_service_proto_list.json +29 -3
- package/build/src/v1/placement_service_client.d.ts +291 -51
- package/build/src/v1/placement_service_client.js +402 -81
- package/build/src/v1/placement_service_client.js.map +1 -1
- package/build/src/v1/placement_service_proto_list.json +29 -3
- package/build/src/v1/private_auction_deal_service_client.d.ts +965 -0
- package/build/src/v1/private_auction_deal_service_client.js +1445 -0
- package/build/src/v1/private_auction_deal_service_client.js.map +1 -0
- package/build/src/v1/private_auction_deal_service_client_config.json +42 -0
- package/build/src/v1/private_auction_deal_service_proto_list.json +74 -0
- package/build/src/v1/private_auction_service_client.d.ts +962 -0
- package/build/src/v1/private_auction_service_client.js +1443 -0
- package/build/src/v1/private_auction_service_client.js.map +1 -0
- package/build/src/v1/private_auction_service_client_config.json +42 -0
- package/build/src/v1/private_auction_service_proto_list.json +74 -0
- package/build/src/v1/programmatic_buyer_service_client.d.ts +905 -0
- package/build/src/v1/programmatic_buyer_service_client.js +1369 -0
- package/build/src/v1/programmatic_buyer_service_client.js.map +1 -0
- package/build/src/v1/programmatic_buyer_service_client_config.json +34 -0
- package/build/src/v1/programmatic_buyer_service_proto_list.json +74 -0
- package/build/src/v1/report_service_client.d.ts +350 -110
- package/build/src/v1/report_service_client.js +471 -177
- package/build/src/v1/report_service_client.js.map +1 -1
- package/build/src/v1/report_service_proto_list.json +29 -3
- package/build/src/v1/role_service_client.d.ts +290 -50
- package/build/src/v1/role_service_client.js +402 -81
- package/build/src/v1/role_service_client.js.map +1 -1
- package/build/src/v1/role_service_proto_list.json +29 -3
- package/build/src/v1/taxonomy_category_service_client.d.ts +291 -51
- package/build/src/v1/taxonomy_category_service_client.js +404 -87
- package/build/src/v1/taxonomy_category_service_client.js.map +1 -1
- package/build/src/v1/taxonomy_category_service_proto_list.json +29 -3
- package/build/src/v1/user_service_client.d.ts +251 -11
- package/build/src/v1/user_service_client.js +388 -59
- package/build/src/v1/user_service_client.js.map +1 -1
- package/build/src/v1/user_service_proto_list.json +29 -3
- package/package.json +4 -4
- package/CHANGELOG.md +0 -40
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
// Copyright 2025 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
|
+
|
|
15
|
+
syntax = "proto3";
|
|
16
|
+
|
|
17
|
+
package google.ads.admanager.v1;
|
|
18
|
+
|
|
19
|
+
option csharp_namespace = "Google.Ads.AdManager.V1";
|
|
20
|
+
option go_package = "google.golang.org/genproto/googleapis/ads/admanager/v1;admanager";
|
|
21
|
+
option java_multiple_files = true;
|
|
22
|
+
option java_outer_classname = "RequestPlatformEnumProto";
|
|
23
|
+
option java_package = "com.google.ads.admanager.v1";
|
|
24
|
+
option php_namespace = "Google\\Ads\\AdManager\\V1";
|
|
25
|
+
option ruby_package = "Google::Ads::AdManager::V1";
|
|
26
|
+
|
|
27
|
+
// Wrapper message for [RequestPlatform].
|
|
28
|
+
//
|
|
29
|
+
// Describes the platform from which a request is made and on which the ad is
|
|
30
|
+
// rendered. In the event of multiple platforms, the platform that ultimately
|
|
31
|
+
// renders the ad is the targeted platform. For example, a video player on a
|
|
32
|
+
// website would have a request platform of `VIDEO_PLAYER`.
|
|
33
|
+
message RequestPlatformEnum {
|
|
34
|
+
// The different environments in which an ad can be shown.
|
|
35
|
+
enum RequestPlatform {
|
|
36
|
+
// No value specified
|
|
37
|
+
REQUEST_PLATFORM_UNSPECIFIED = 0;
|
|
38
|
+
|
|
39
|
+
// Represents a request made from a web browser (incl. desktop browsers,
|
|
40
|
+
// mobile browsers, webviews, etc.).
|
|
41
|
+
BROWSER = 1;
|
|
42
|
+
|
|
43
|
+
// Represents a request made from a Mobile Application.
|
|
44
|
+
MOBILE_APP = 2;
|
|
45
|
+
|
|
46
|
+
// Represents a request made from a video player.
|
|
47
|
+
VIDEO_PLAYER = 3;
|
|
48
|
+
}
|
|
49
|
+
}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// Copyright
|
|
1
|
+
// Copyright 2025 Google LLC
|
|
2
2
|
//
|
|
3
3
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
4
|
// you may not use this file except in compliance with the License.
|
|
@@ -42,18 +42,18 @@ message Role {
|
|
|
42
42
|
string name = 1 [(google.api.field_behavior) = IDENTIFIER];
|
|
43
43
|
|
|
44
44
|
// Output only. `Role` ID.
|
|
45
|
-
int64 role_id = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
|
|
45
|
+
optional int64 role_id = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
|
|
46
46
|
|
|
47
47
|
// Required. The display name of the `Role`.
|
|
48
|
-
string display_name = 3 [(google.api.field_behavior) = REQUIRED];
|
|
48
|
+
optional string display_name = 3 [(google.api.field_behavior) = REQUIRED];
|
|
49
49
|
|
|
50
50
|
// Optional. The description of the `Role`.
|
|
51
|
-
string description = 4 [(google.api.field_behavior) = OPTIONAL];
|
|
51
|
+
optional string description = 4 [(google.api.field_behavior) = OPTIONAL];
|
|
52
52
|
|
|
53
53
|
// Output only. Whether the `Role` is a built-in or custom user role.
|
|
54
|
-
bool built_in = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
|
|
54
|
+
optional bool built_in = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
|
|
55
55
|
|
|
56
56
|
// Output only. The status of the `Role`.
|
|
57
|
-
RoleStatusEnum.RoleStatus status = 6
|
|
57
|
+
optional RoleStatusEnum.RoleStatus status = 6
|
|
58
58
|
[(google.api.field_behavior) = OUTPUT_ONLY];
|
|
59
59
|
}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// Copyright
|
|
1
|
+
// Copyright 2025 Google LLC
|
|
2
2
|
//
|
|
3
3
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
4
|
// you may not use this file except in compliance with the License.
|
|
@@ -33,6 +33,8 @@ option ruby_package = "Google::Ads::AdManager::V1";
|
|
|
33
33
|
// Provides methods for handling `Role` objects.
|
|
34
34
|
service RoleService {
|
|
35
35
|
option (google.api.default_host) = "admanager.googleapis.com";
|
|
36
|
+
option (google.api.oauth_scopes) =
|
|
37
|
+
"https://www.googleapis.com/auth/admanager";
|
|
36
38
|
|
|
37
39
|
// API to retrieve a `Role` object.
|
|
38
40
|
rpc GetRole(GetRoleRequest) returns (Role) {
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// Copyright
|
|
1
|
+
// Copyright 2025 Google LLC
|
|
2
2
|
//
|
|
3
3
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
4
|
// you may not use this file except in compliance with the License.
|
|
@@ -29,19 +29,15 @@ option ruby_package = "Google::Ads::AdManager::V1";
|
|
|
29
29
|
|
|
30
30
|
// Represents the dimensions of an AdUnit, LineItem, or Creative.
|
|
31
31
|
message Size {
|
|
32
|
-
// Required. The width of the
|
|
33
|
-
// [AdUnit]
|
|
34
|
-
// [LineItem](google.ads.admanager.v1.LineItem).
|
|
32
|
+
// Required. The width of the Creative,
|
|
33
|
+
// [AdUnit][google.ads.admanager.v1.AdUnit], or LineItem.
|
|
35
34
|
int32 width = 1 [(google.api.field_behavior) = REQUIRED];
|
|
36
35
|
|
|
37
|
-
// Required. The height of the
|
|
38
|
-
// [AdUnit]
|
|
39
|
-
// [LineItem](google.ads.admanager.v1.LineItem).
|
|
36
|
+
// Required. The height of the Creative,
|
|
37
|
+
// [AdUnit][google.ads.admanager.v1.AdUnit], or LineItem.
|
|
40
38
|
int32 height = 2 [(google.api.field_behavior) = REQUIRED];
|
|
41
39
|
|
|
42
|
-
// Required. The SizeType of the
|
|
43
|
-
// [
|
|
44
|
-
// [AdUnit](google.ads.admanager.v1.AdUnit), or
|
|
45
|
-
// [LineItem](google.ads.admanager.v1.LineItem).
|
|
40
|
+
// Required. The SizeType of the Creative,
|
|
41
|
+
// [AdUnit][google.ads.admanager.v1.AdUnit], or LineItem.
|
|
46
42
|
SizeTypeEnum.SizeType size_type = 3 [(google.api.field_behavior) = REQUIRED];
|
|
47
43
|
}
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
// Copyright 2025 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
|
+
|
|
15
|
+
syntax = "proto3";
|
|
16
|
+
|
|
17
|
+
package google.ads.admanager.v1;
|
|
18
|
+
|
|
19
|
+
option csharp_namespace = "Google.Ads.AdManager.V1";
|
|
20
|
+
option go_package = "google.golang.org/genproto/googleapis/ads/admanager/v1;admanager";
|
|
21
|
+
option java_multiple_files = true;
|
|
22
|
+
option java_outer_classname = "TargetedVideoBumperTypeEnumProto";
|
|
23
|
+
option java_package = "com.google.ads.admanager.v1";
|
|
24
|
+
option php_namespace = "Google\\Ads\\AdManager\\V1";
|
|
25
|
+
option ruby_package = "Google::Ads::AdManager::V1";
|
|
26
|
+
|
|
27
|
+
// Wrapper message for
|
|
28
|
+
// [TargetedVideoBumperType][google.ads.admanager.v1.TargetedVideoBumperTypeEnum.TargetedVideoBumperType]
|
|
29
|
+
message TargetedVideoBumperTypeEnum {
|
|
30
|
+
// Represents the options for targetable bumper positions, surrounding an ad
|
|
31
|
+
// pod, within a video stream. This includes before and after the supported ad
|
|
32
|
+
// pod positions, `VideoPositionType.PREROLL`, `VideoPositionType.MIDROLL`,
|
|
33
|
+
// and `VideoPositionType.POSTROLL`.
|
|
34
|
+
enum TargetedVideoBumperType {
|
|
35
|
+
// Default value. This value is unused.
|
|
36
|
+
TARGETED_VIDEO_BUMPER_TYPE_UNSPECIFIED = 0;
|
|
37
|
+
|
|
38
|
+
// Represents the bumper position after the ad pod.
|
|
39
|
+
AFTER = 1;
|
|
40
|
+
|
|
41
|
+
// Represents the bumper position before the ad pod.
|
|
42
|
+
BEFORE = 2;
|
|
43
|
+
}
|
|
44
|
+
}
|
|
@@ -0,0 +1,328 @@
|
|
|
1
|
+
// Copyright 2025 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
|
+
|
|
15
|
+
syntax = "proto3";
|
|
16
|
+
|
|
17
|
+
package google.ads.admanager.v1;
|
|
18
|
+
|
|
19
|
+
import "google/ads/admanager/v1/request_platform_enum.proto";
|
|
20
|
+
import "google/ads/admanager/v1/targeted_video_bumper_type_enum.proto";
|
|
21
|
+
import "google/ads/admanager/v1/video_position_enum.proto";
|
|
22
|
+
import "google/api/field_behavior.proto";
|
|
23
|
+
import "google/api/resource.proto";
|
|
24
|
+
|
|
25
|
+
option csharp_namespace = "Google.Ads.AdManager.V1";
|
|
26
|
+
option go_package = "google.golang.org/genproto/googleapis/ads/admanager/v1;admanager";
|
|
27
|
+
option java_multiple_files = true;
|
|
28
|
+
option java_outer_classname = "TargetingProto";
|
|
29
|
+
option java_package = "com.google.ads.admanager.v1";
|
|
30
|
+
option php_namespace = "Google\\Ads\\AdManager\\V1";
|
|
31
|
+
option ruby_package = "Google::Ads::AdManager::V1";
|
|
32
|
+
|
|
33
|
+
// Targeting expression.
|
|
34
|
+
//
|
|
35
|
+
message Targeting {
|
|
36
|
+
// Optional. Used to target/exclude various geo targets.
|
|
37
|
+
GeoTargeting geo_targeting = 2 [(google.api.field_behavior) = OPTIONAL];
|
|
38
|
+
|
|
39
|
+
// Optional. Used to target various technology targeting dimensions.
|
|
40
|
+
TechnologyTargeting technology_targeting = 3
|
|
41
|
+
[(google.api.field_behavior) = OPTIONAL];
|
|
42
|
+
|
|
43
|
+
// Optional. Used to target/exclude various ad units and/or placements.
|
|
44
|
+
InventoryTargeting inventory_targeting = 5
|
|
45
|
+
[(google.api.field_behavior) = OPTIONAL];
|
|
46
|
+
|
|
47
|
+
// Optional. Used to target specific request platforms.
|
|
48
|
+
RequestPlatformTargeting request_platform_targeting = 6
|
|
49
|
+
[(google.api.field_behavior) = OPTIONAL];
|
|
50
|
+
|
|
51
|
+
// Optional. Used to target key/values, audience segments, and/or CMS
|
|
52
|
+
// metadata.
|
|
53
|
+
CustomTargeting custom_targeting = 7 [(google.api.field_behavior) = OPTIONAL];
|
|
54
|
+
|
|
55
|
+
// Optional. Used to target user domains.
|
|
56
|
+
UserDomainTargeting user_domain_targeting = 10
|
|
57
|
+
[(google.api.field_behavior) = OPTIONAL];
|
|
58
|
+
|
|
59
|
+
// Optional. Used to target video positions.
|
|
60
|
+
VideoPositionTargeting video_position_targeting = 12
|
|
61
|
+
[(google.api.field_behavior) = OPTIONAL];
|
|
62
|
+
|
|
63
|
+
// Optional. Used to target data segments.
|
|
64
|
+
DataSegmentTargeting data_segment_targeting = 13
|
|
65
|
+
[(google.api.field_behavior) = OPTIONAL];
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
// Represents a list of targeted and excluded geos.
|
|
69
|
+
message GeoTargeting {
|
|
70
|
+
// Optional. A list of geo resource names that should be targeted/included.
|
|
71
|
+
repeated string targeted_geos = 3 [
|
|
72
|
+
(google.api.field_behavior) = OPTIONAL,
|
|
73
|
+
(google.api.resource_reference) = {
|
|
74
|
+
type: "admanager.googleapis.com/GeoTarget"
|
|
75
|
+
}
|
|
76
|
+
];
|
|
77
|
+
|
|
78
|
+
// Optional. A list of geo resource names that should be excluded.
|
|
79
|
+
repeated string excluded_geos = 4 [
|
|
80
|
+
(google.api.field_behavior) = OPTIONAL,
|
|
81
|
+
(google.api.resource_reference) = {
|
|
82
|
+
type: "admanager.googleapis.com/GeoTarget"
|
|
83
|
+
}
|
|
84
|
+
];
|
|
85
|
+
}
|
|
86
|
+
|
|
87
|
+
// Various types of technology targeting expressed by child messages are
|
|
88
|
+
// applied with logical AND.
|
|
89
|
+
message TechnologyTargeting {
|
|
90
|
+
// Optional. Bandwidth targeting dimension.
|
|
91
|
+
BandwidthTargeting bandwidth_targeting = 3
|
|
92
|
+
[(google.api.field_behavior) = OPTIONAL];
|
|
93
|
+
|
|
94
|
+
// Optional. Device category targeting dimension.
|
|
95
|
+
DeviceCategoryTargeting device_category_targeting = 1
|
|
96
|
+
[(google.api.field_behavior) = OPTIONAL];
|
|
97
|
+
|
|
98
|
+
// Optional. Operating system targeting dimension.
|
|
99
|
+
OperatingSystemTargeting operating_system_targeting = 2
|
|
100
|
+
[(google.api.field_behavior) = OPTIONAL];
|
|
101
|
+
}
|
|
102
|
+
|
|
103
|
+
// Bandwidth Targeting.
|
|
104
|
+
//
|
|
105
|
+
// Reach users accessing the internet via various means of connection, such as
|
|
106
|
+
// cable, DSL, or dial-up. Can be useful to target campaigns using
|
|
107
|
+
// low-resolution creatives or text ads for users with low bandwidth.
|
|
108
|
+
message BandwidthTargeting {
|
|
109
|
+
// Optional. A list of resource names of the bandwidth groups that should be
|
|
110
|
+
// targeted/included.
|
|
111
|
+
repeated string targeted_bandwidth_groups = 3 [
|
|
112
|
+
(google.api.field_behavior) = OPTIONAL,
|
|
113
|
+
(google.api.resource_reference) = {
|
|
114
|
+
type: "admanager.googleapis.com/BandwidthGroup"
|
|
115
|
+
}
|
|
116
|
+
];
|
|
117
|
+
|
|
118
|
+
// Optional. A list of resource names of the bandwidth groups that should be
|
|
119
|
+
// excluded.
|
|
120
|
+
repeated string excluded_bandwidth_groups = 4 [
|
|
121
|
+
(google.api.field_behavior) = OPTIONAL,
|
|
122
|
+
(google.api.resource_reference) = {
|
|
123
|
+
type: "admanager.googleapis.com/BandwidthGroup"
|
|
124
|
+
}
|
|
125
|
+
];
|
|
126
|
+
}
|
|
127
|
+
|
|
128
|
+
// Represents a list of targeted and excluded device categories.
|
|
129
|
+
message DeviceCategoryTargeting {
|
|
130
|
+
// Optional. A list of device category resource names that should be
|
|
131
|
+
// targeted/included.
|
|
132
|
+
repeated string targeted_categories = 3 [
|
|
133
|
+
(google.api.field_behavior) = OPTIONAL,
|
|
134
|
+
(google.api.resource_reference) = {
|
|
135
|
+
type: "admanager.googleapis.com/DeviceCategory"
|
|
136
|
+
}
|
|
137
|
+
];
|
|
138
|
+
|
|
139
|
+
// Optional. A list of device category resource names that should be excluded.
|
|
140
|
+
repeated string excluded_categories = 4 [
|
|
141
|
+
(google.api.field_behavior) = OPTIONAL,
|
|
142
|
+
(google.api.resource_reference) = {
|
|
143
|
+
type: "admanager.googleapis.com/DeviceCategory"
|
|
144
|
+
}
|
|
145
|
+
];
|
|
146
|
+
}
|
|
147
|
+
|
|
148
|
+
// Operating System Targeting
|
|
149
|
+
message OperatingSystemTargeting {
|
|
150
|
+
// Optional. A list of operating system resource names that should be
|
|
151
|
+
// targeted/included.
|
|
152
|
+
repeated string targeted_operating_systems = 5 [
|
|
153
|
+
(google.api.field_behavior) = OPTIONAL,
|
|
154
|
+
(google.api.resource_reference) = {
|
|
155
|
+
type: "admanager.googleapis.com/OperatingSystem"
|
|
156
|
+
}
|
|
157
|
+
];
|
|
158
|
+
|
|
159
|
+
// Optional. A list of operating system resource names that should be
|
|
160
|
+
// excluded.
|
|
161
|
+
repeated string excluded_operating_systems = 6 [
|
|
162
|
+
(google.api.field_behavior) = OPTIONAL,
|
|
163
|
+
(google.api.resource_reference) = {
|
|
164
|
+
type: "admanager.googleapis.com/OperatingSystem"
|
|
165
|
+
}
|
|
166
|
+
];
|
|
167
|
+
|
|
168
|
+
// Optional. A list of operating system version resource names that should be
|
|
169
|
+
// targeted/included.
|
|
170
|
+
repeated string targeted_operating_system_versions = 7 [
|
|
171
|
+
(google.api.field_behavior) = OPTIONAL,
|
|
172
|
+
(google.api.resource_reference) = {
|
|
173
|
+
type: "admanager.googleapis.com/OperatingSystemVersion"
|
|
174
|
+
}
|
|
175
|
+
];
|
|
176
|
+
|
|
177
|
+
// Optional. A list of operating system version resource names that should be
|
|
178
|
+
// excluded.
|
|
179
|
+
repeated string excluded_operating_system_versions = 8 [
|
|
180
|
+
(google.api.field_behavior) = OPTIONAL,
|
|
181
|
+
(google.api.resource_reference) = {
|
|
182
|
+
type: "admanager.googleapis.com/OperatingSystemVersion"
|
|
183
|
+
}
|
|
184
|
+
];
|
|
185
|
+
}
|
|
186
|
+
|
|
187
|
+
// Targeted ad units and AU placements are applied with
|
|
188
|
+
// logical OR. Example:
|
|
189
|
+
//
|
|
190
|
+
// (au:1 OR au:2 OR au_placement:5) AND (NOT (au:3))
|
|
191
|
+
message InventoryTargeting {
|
|
192
|
+
// Optional. A list of ad units that should be targeted/included.
|
|
193
|
+
repeated AdUnitTargeting targeted_ad_units = 1
|
|
194
|
+
[(google.api.field_behavior) = OPTIONAL];
|
|
195
|
+
|
|
196
|
+
// Optional. A list of ad units that should be excluded.
|
|
197
|
+
//
|
|
198
|
+
// Excluded AUs take precedence over targeted AUs. In fact an AU can be
|
|
199
|
+
// excluded only if one of its ancestors is targeted. Subsequently child
|
|
200
|
+
// AUs of an excluded AU can not be targeted (except via a placement).
|
|
201
|
+
repeated AdUnitTargeting excluded_ad_units = 2
|
|
202
|
+
[(google.api.field_behavior) = OPTIONAL];
|
|
203
|
+
|
|
204
|
+
// Optional. The resource names of the placements that should be
|
|
205
|
+
// targeted/included.
|
|
206
|
+
repeated string targeted_placements = 5 [
|
|
207
|
+
(google.api.field_behavior) = OPTIONAL,
|
|
208
|
+
(google.api.resource_reference) = {
|
|
209
|
+
type: "admanager.googleapis.com/Placement"
|
|
210
|
+
}
|
|
211
|
+
];
|
|
212
|
+
}
|
|
213
|
+
|
|
214
|
+
// Specifies an ad unit and (optionally) its descendants.
|
|
215
|
+
message AdUnitTargeting {
|
|
216
|
+
// Whether this ad unit's children should be targeted/excluded as well.
|
|
217
|
+
optional bool include_descendants = 1;
|
|
218
|
+
|
|
219
|
+
// Optional. The resource name of this ad unit.
|
|
220
|
+
optional string ad_unit = 3 [
|
|
221
|
+
(google.api.field_behavior) = OPTIONAL,
|
|
222
|
+
(google.api.resource_reference) = {
|
|
223
|
+
type: "admanager.googleapis.com/AdUnit"
|
|
224
|
+
}
|
|
225
|
+
];
|
|
226
|
+
}
|
|
227
|
+
|
|
228
|
+
// Represents a list of targeted request platforms.
|
|
229
|
+
message RequestPlatformTargeting {
|
|
230
|
+
// Optional. The list of request platforms that should be targeted.
|
|
231
|
+
repeated RequestPlatformEnum.RequestPlatform request_platforms = 1
|
|
232
|
+
[(google.api.field_behavior) = OPTIONAL];
|
|
233
|
+
}
|
|
234
|
+
|
|
235
|
+
// Represents the top level targeting expression for custom key/values,
|
|
236
|
+
// audience segments, and/or CMS metadata.
|
|
237
|
+
message CustomTargeting {
|
|
238
|
+
// Optional. These clauses are all ORed together.
|
|
239
|
+
repeated CustomTargetingClause custom_targeting_clauses = 1
|
|
240
|
+
[(google.api.field_behavior) = OPTIONAL];
|
|
241
|
+
}
|
|
242
|
+
|
|
243
|
+
// Represents a logical AND of individual custom targeting expressions.
|
|
244
|
+
message CustomTargetingClause {
|
|
245
|
+
// Optional. Leaf targeting expressions for custom key/values.
|
|
246
|
+
repeated CustomTargetingLiteral custom_targeting_literals = 1
|
|
247
|
+
[(google.api.field_behavior) = OPTIONAL];
|
|
248
|
+
}
|
|
249
|
+
|
|
250
|
+
// Represents targeting for custom key/values. The values are ORed together.
|
|
251
|
+
message CustomTargetingLiteral {
|
|
252
|
+
// Whether this expression is negatively targeted, meaning it matches
|
|
253
|
+
// ad requests that exclude the below values.
|
|
254
|
+
optional bool negative = 1;
|
|
255
|
+
|
|
256
|
+
// Optional. The resource name of the targeted CustomKey.
|
|
257
|
+
optional string custom_targeting_key = 4 [
|
|
258
|
+
(google.api.field_behavior) = OPTIONAL,
|
|
259
|
+
(google.api.resource_reference) = {
|
|
260
|
+
type: "admanager.googleapis.com/CustomTargetingKey"
|
|
261
|
+
}
|
|
262
|
+
];
|
|
263
|
+
|
|
264
|
+
// Optional. The resource names of the targeted CustomValues.
|
|
265
|
+
repeated string custom_targeting_values = 5 [
|
|
266
|
+
(google.api.field_behavior) = OPTIONAL,
|
|
267
|
+
(google.api.resource_reference) = {
|
|
268
|
+
type: "admanager.googleapis.com/CustomTargetingValue"
|
|
269
|
+
}
|
|
270
|
+
];
|
|
271
|
+
}
|
|
272
|
+
|
|
273
|
+
// User Domain Targeting
|
|
274
|
+
message UserDomainTargeting {
|
|
275
|
+
// Optional. A list of user domains that should be targeted/included.
|
|
276
|
+
repeated string targeted_user_domains = 1
|
|
277
|
+
[(google.api.field_behavior) = OPTIONAL];
|
|
278
|
+
|
|
279
|
+
// Optional. A list of user domains that should be excluded.
|
|
280
|
+
repeated string excluded_user_domains = 2
|
|
281
|
+
[(google.api.field_behavior) = OPTIONAL];
|
|
282
|
+
}
|
|
283
|
+
|
|
284
|
+
// Video Position Targeting
|
|
285
|
+
message VideoPositionTargeting {
|
|
286
|
+
// Optional. A list of video position targeting criterion (applied with a
|
|
287
|
+
// logical AND).
|
|
288
|
+
repeated VideoPosition video_positions = 1
|
|
289
|
+
[(google.api.field_behavior) = OPTIONAL];
|
|
290
|
+
}
|
|
291
|
+
|
|
292
|
+
// Video Position Targeting Criterion
|
|
293
|
+
message VideoPosition {
|
|
294
|
+
// Optional. The index of the mid-roll to target. This field is ignored when
|
|
295
|
+
// targeting any video position (e.g. position_type) other than MIDROLL.
|
|
296
|
+
optional int64 midroll_index = 1 [(google.api.field_behavior) = OPTIONAL];
|
|
297
|
+
|
|
298
|
+
// Optional. The index from the back of the pod of the mid-roll to target.
|
|
299
|
+
// This field is ignored when targeting any video position (e.g.
|
|
300
|
+
// position_type) other than MIDROLL or if targeting a specific midroll index
|
|
301
|
+
// (e.g. midroll_index != 0).
|
|
302
|
+
optional int64 reverse_midroll_index = 2
|
|
303
|
+
[(google.api.field_behavior) = OPTIONAL];
|
|
304
|
+
|
|
305
|
+
// Optional. The video position within a pod to target. This field must be
|
|
306
|
+
// unset in order to target a specific video position (e.g. position_type),
|
|
307
|
+
// bumper type (e.g. bumper_type), or custom ad spot (e.g. custom_spot_id).
|
|
308
|
+
optional int64 pod_position = 3 [(google.api.field_behavior) = OPTIONAL];
|
|
309
|
+
|
|
310
|
+
// Optional. The position within a video to target. A video ad can target a
|
|
311
|
+
// position (pre-roll, all mid-rolls, or post-roll) or a specific mid-roll
|
|
312
|
+
// index.
|
|
313
|
+
optional VideoPositionEnum.VideoPosition position_type = 5
|
|
314
|
+
[(google.api.field_behavior) = OPTIONAL];
|
|
315
|
+
|
|
316
|
+
// Optional. The video bumper type to target. This field must be unset in
|
|
317
|
+
// order to target a specific video position (e.g. position_type), pod
|
|
318
|
+
// position (e.g. pod_position), or custom ad spot (e.g. custom_spot_id).
|
|
319
|
+
optional TargetedVideoBumperTypeEnum.TargetedVideoBumperType bumper_type = 6
|
|
320
|
+
[(google.api.field_behavior) = OPTIONAL];
|
|
321
|
+
}
|
|
322
|
+
|
|
323
|
+
// Data Segment Targeting
|
|
324
|
+
message DataSegmentTargeting {
|
|
325
|
+
// Output only. Whether any data segments are currently targeted.
|
|
326
|
+
bool has_data_segment_targeting = 2
|
|
327
|
+
[(google.api.field_behavior) = OUTPUT_ONLY];
|
|
328
|
+
}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// Copyright
|
|
1
|
+
// Copyright 2025 Google LLC
|
|
2
2
|
//
|
|
3
3
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
4
|
// you may not use this file except in compliance with the License.
|
|
@@ -42,22 +42,23 @@ message TaxonomyCategory {
|
|
|
42
42
|
string name = 1 [(google.api.field_behavior) = IDENTIFIER];
|
|
43
43
|
|
|
44
44
|
// Output only. `TaxonomyCategory` ID.
|
|
45
|
-
int64 taxonomy_category_id = 2
|
|
45
|
+
optional int64 taxonomy_category_id = 2
|
|
46
|
+
[(google.api.field_behavior) = OUTPUT_ONLY];
|
|
46
47
|
|
|
47
48
|
// Output only. Display name of the `TaxonomyCategory`.
|
|
48
|
-
string display_name = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
|
|
49
|
+
optional string display_name = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
|
|
49
50
|
|
|
50
51
|
// Output only. Whether this `TaxonomyCategory` only serves to group its
|
|
51
52
|
// children.
|
|
52
|
-
bool grouping_only = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
|
|
53
|
+
optional bool grouping_only = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
|
|
53
54
|
|
|
54
55
|
// Output only. The ID of the parent category this `TaxonomyCategory` descends
|
|
55
56
|
// from.
|
|
56
|
-
int64 parent_taxonomy_category_id = 6
|
|
57
|
+
optional int64 parent_taxonomy_category_id = 6
|
|
57
58
|
[(google.api.field_behavior) = OUTPUT_ONLY];
|
|
58
59
|
|
|
59
60
|
// Output only. The taxonomy that this `TaxonomyCategory` belongs to.
|
|
60
|
-
TaxonomyTypeEnum.TaxonomyType taxonomy_type = 9
|
|
61
|
+
optional TaxonomyTypeEnum.TaxonomyType taxonomy_type = 9
|
|
61
62
|
[(google.api.field_behavior) = OUTPUT_ONLY];
|
|
62
63
|
|
|
63
64
|
// Output only. The list of names of the ancestors of this `TaxonomyCategory`.
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// Copyright
|
|
1
|
+
// Copyright 2025 Google LLC
|
|
2
2
|
//
|
|
3
3
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
4
|
// you may not use this file except in compliance with the License.
|
|
@@ -33,6 +33,8 @@ option ruby_package = "Google::Ads::AdManager::V1";
|
|
|
33
33
|
// Provides methods for handling `TaxonomyCategory` objects.
|
|
34
34
|
service TaxonomyCategoryService {
|
|
35
35
|
option (google.api.default_host) = "admanager.googleapis.com";
|
|
36
|
+
option (google.api.oauth_scopes) =
|
|
37
|
+
"https://www.googleapis.com/auth/admanager";
|
|
36
38
|
|
|
37
39
|
// API to retrieve a `TaxonomyCategory` object.
|
|
38
40
|
rpc GetTaxonomyCategory(GetTaxonomyCategoryRequest)
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// Copyright
|
|
1
|
+
// Copyright 2025 Google LLC
|
|
2
2
|
//
|
|
3
3
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
4
|
// you may not use this file except in compliance with the License.
|
|
@@ -39,8 +39,4 @@ message Team {
|
|
|
39
39
|
// Identifier. The resource name of the `Team`.
|
|
40
40
|
// Format: `networks/{network_code}/teams/{team_id}`
|
|
41
41
|
string name = 1 [(google.api.field_behavior) = IDENTIFIER];
|
|
42
|
-
|
|
43
|
-
// Output only. The unique ID of the Team. This value is assigned by Google.
|
|
44
|
-
// Teams that are created by Google will have negative IDs.
|
|
45
|
-
int64 team_id = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
|
|
46
42
|
}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// Copyright
|
|
1
|
+
// Copyright 2025 Google LLC
|
|
2
2
|
//
|
|
3
3
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
4
|
// you may not use this file except in compliance with the License.
|
|
@@ -41,38 +41,39 @@ message User {
|
|
|
41
41
|
string name = 1 [(google.api.field_behavior) = IDENTIFIER];
|
|
42
42
|
|
|
43
43
|
// Output only. `User` ID.
|
|
44
|
-
int64 user_id = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
|
|
44
|
+
optional int64 user_id = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
|
|
45
45
|
|
|
46
46
|
// Required. The name of the User. It has a maximum length of 128 characters.
|
|
47
|
-
string display_name = 2 [(google.api.field_behavior) = REQUIRED];
|
|
47
|
+
optional string display_name = 2 [(google.api.field_behavior) = REQUIRED];
|
|
48
48
|
|
|
49
49
|
// Required. The email or login of the User. In order to create a new user,
|
|
50
50
|
// you must already have a Google Account.
|
|
51
|
-
string email = 3 [(google.api.field_behavior) = REQUIRED];
|
|
51
|
+
optional string email = 3 [(google.api.field_behavior) = REQUIRED];
|
|
52
52
|
|
|
53
53
|
// Required. The unique Role ID of the User. Roles that are created by Google
|
|
54
54
|
// will have negative IDs.
|
|
55
|
-
string role = 4 [
|
|
55
|
+
optional string role = 4 [
|
|
56
56
|
(google.api.field_behavior) = REQUIRED,
|
|
57
57
|
(google.api.resource_reference) = { type: "admanager.googleapis.com/Role" }
|
|
58
58
|
];
|
|
59
59
|
|
|
60
60
|
// Output only. Specifies whether or not the User is active. An inactive user
|
|
61
61
|
// cannot log in to the system or perform any operations.
|
|
62
|
-
bool active = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
|
|
62
|
+
optional bool active = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
|
|
63
63
|
|
|
64
64
|
// Optional. An identifier for the User that is meaningful to the publisher.
|
|
65
65
|
// This attribute has a maximum length of 255 characters.
|
|
66
|
-
string external_id = 7 [(google.api.field_behavior) = OPTIONAL];
|
|
66
|
+
optional string external_id = 7 [(google.api.field_behavior) = OPTIONAL];
|
|
67
67
|
|
|
68
68
|
// Output only. Whether the user is an OAuth2 service account user.
|
|
69
69
|
// Service account users can only be added through the UI.
|
|
70
|
-
bool service_account = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
|
|
70
|
+
optional bool service_account = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
|
|
71
71
|
|
|
72
72
|
// Optional. The IANA Time Zone Database time zone, e.g. "America/New_York",
|
|
73
73
|
// used in the orders and line items UI for this User. If not provided, the UI
|
|
74
74
|
// then defaults to using the Network's timezone. This setting only affects
|
|
75
75
|
// the UI for this user and does not affect the timezone of any dates and
|
|
76
76
|
// times returned in API responses.
|
|
77
|
-
string orders_ui_local_time_zone = 9
|
|
77
|
+
optional string orders_ui_local_time_zone = 9
|
|
78
|
+
[(google.api.field_behavior) = OPTIONAL];
|
|
78
79
|
}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// Copyright
|
|
1
|
+
// Copyright 2025 Google LLC
|
|
2
2
|
//
|
|
3
3
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
4
|
// you may not use this file except in compliance with the License.
|
|
@@ -33,6 +33,8 @@ option ruby_package = "Google::Ads::AdManager::V1";
|
|
|
33
33
|
// Provides methods for handling User objects.
|
|
34
34
|
service UserService {
|
|
35
35
|
option (google.api.default_host) = "admanager.googleapis.com";
|
|
36
|
+
option (google.api.oauth_scopes) =
|
|
37
|
+
"https://www.googleapis.com/auth/admanager";
|
|
36
38
|
|
|
37
39
|
// API to retrieve a User object.
|
|
38
40
|
//
|