@google-ads/admanager 0.2.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.
Files changed (182) hide show
  1. package/README.md +27 -2
  2. package/build/protos/google/ads/admanager/v1/ad_break_messages.proto +134 -0
  3. package/build/protos/google/ads/admanager/v1/ad_break_service.proto +269 -0
  4. package/build/protos/google/ads/admanager/v1/ad_unit_enums.proto +1 -1
  5. package/build/protos/google/ads/admanager/v1/ad_unit_messages.proto +32 -26
  6. package/build/protos/google/ads/admanager/v1/ad_unit_service.proto +3 -1
  7. package/build/protos/google/ads/admanager/v1/admanager_error.proto +1 -1
  8. package/build/protos/google/ads/admanager/v1/applied_label.proto +1 -1
  9. package/build/protos/google/ads/admanager/v1/bandwidth_group_messages.proto +46 -0
  10. package/build/protos/google/ads/admanager/v1/bandwidth_group_service.proto +129 -0
  11. package/build/protos/google/ads/admanager/v1/company_enums.proto +123 -0
  12. package/build/protos/google/ads/admanager/v1/company_messages.proto +6 -7
  13. package/build/protos/google/ads/admanager/v1/company_service.proto +3 -1
  14. package/build/protos/google/ads/admanager/v1/contact_messages.proto +4 -4
  15. package/build/protos/google/ads/admanager/v1/custom_field_enums.proto +1 -1
  16. package/build/protos/google/ads/admanager/v1/custom_field_messages.proto +12 -11
  17. package/build/protos/google/ads/admanager/v1/custom_field_service.proto +3 -1
  18. package/build/protos/google/ads/admanager/v1/custom_field_value.proto +1 -2
  19. package/build/protos/google/ads/admanager/v1/custom_targeting_key_enums.proto +1 -1
  20. package/build/protos/google/ads/admanager/v1/custom_targeting_key_messages.proto +1 -1
  21. package/build/protos/google/ads/admanager/v1/custom_targeting_key_service.proto +3 -1
  22. package/build/protos/google/ads/admanager/v1/custom_targeting_value_enums.proto +1 -1
  23. package/build/protos/google/ads/admanager/v1/custom_targeting_value_messages.proto +14 -3
  24. package/build/protos/google/ads/admanager/v1/custom_targeting_value_service.proto +14 -6
  25. package/build/protos/google/ads/admanager/v1/deal_buyer_permission_type_enum.proto +41 -0
  26. package/build/protos/google/ads/admanager/v1/device_category_messages.proto +45 -0
  27. package/build/protos/google/ads/admanager/v1/device_category_service.proto +129 -0
  28. package/build/protos/google/ads/admanager/v1/early_ad_break_notification_enums.proto +47 -0
  29. package/build/protos/google/ads/admanager/v1/entity_signals_mapping_messages.proto +4 -4
  30. package/build/protos/google/ads/admanager/v1/entity_signals_mapping_service.proto +6 -4
  31. package/build/protos/google/ads/admanager/v1/environment_type_enum.proto +1 -1
  32. package/build/protos/google/ads/admanager/v1/frequency_cap.proto +1 -1
  33. package/build/protos/google/ads/admanager/v1/geo_target_messages.proto +70 -0
  34. package/build/protos/google/ads/admanager/v1/geo_target_service.proto +128 -0
  35. package/build/protos/google/ads/admanager/v1/label_messages.proto +1 -1
  36. package/build/protos/google/ads/admanager/v1/live_stream_event_messages.proto +47 -0
  37. package/build/protos/google/ads/admanager/v1/network_messages.proto +2 -2
  38. package/build/protos/google/ads/admanager/v1/network_service.proto +4 -2
  39. package/build/protos/google/ads/admanager/v1/operating_system_messages.proto +45 -0
  40. package/build/protos/google/ads/admanager/v1/operating_system_service.proto +129 -0
  41. package/build/protos/google/ads/admanager/v1/operating_system_version_messages.proto +52 -0
  42. package/build/protos/google/ads/admanager/v1/operating_system_version_service.proto +133 -0
  43. package/build/protos/google/ads/admanager/v1/order_enums.proto +1 -1
  44. package/build/protos/google/ads/admanager/v1/order_messages.proto +24 -20
  45. package/build/protos/google/ads/admanager/v1/order_service.proto +3 -1
  46. package/build/protos/google/ads/admanager/v1/placement_enums.proto +1 -1
  47. package/build/protos/google/ads/admanager/v1/placement_messages.proto +14 -14
  48. package/build/protos/google/ads/admanager/v1/placement_service.proto +3 -1
  49. package/build/protos/google/ads/admanager/v1/private_auction_deal_messages.proto +119 -0
  50. package/build/protos/google/ads/admanager/v1/private_auction_deal_service.proto +184 -0
  51. package/build/protos/google/ads/admanager/v1/private_auction_messages.proto +74 -0
  52. package/build/protos/google/ads/admanager/v1/private_auction_service.proto +180 -0
  53. package/build/protos/google/ads/admanager/v1/private_marketplace_enums.proto +50 -0
  54. package/build/protos/google/ads/admanager/v1/programmatic_buyer_messages.proto +72 -0
  55. package/build/protos/google/ads/admanager/v1/programmatic_buyer_service.proto +131 -0
  56. package/build/protos/google/ads/admanager/v1/report_messages.proto +3536 -0
  57. package/build/protos/google/ads/admanager/v1/report_service.proto +5 -3247
  58. package/build/protos/google/ads/admanager/v1/request_platform_enum.proto +49 -0
  59. package/build/protos/google/ads/admanager/v1/role_enums.proto +1 -1
  60. package/build/protos/google/ads/admanager/v1/role_messages.proto +6 -6
  61. package/build/protos/google/ads/admanager/v1/role_service.proto +3 -1
  62. package/build/protos/google/ads/admanager/v1/size.proto +7 -11
  63. package/build/protos/google/ads/admanager/v1/size_type_enum.proto +1 -1
  64. package/build/protos/google/ads/admanager/v1/targeted_video_bumper_type_enum.proto +44 -0
  65. package/build/protos/google/ads/admanager/v1/targeting.proto +328 -0
  66. package/build/protos/google/ads/admanager/v1/taxonomy_category_messages.proto +7 -6
  67. package/build/protos/google/ads/admanager/v1/taxonomy_category_service.proto +3 -1
  68. package/build/protos/google/ads/admanager/v1/taxonomy_type_enum.proto +1 -1
  69. package/build/protos/google/ads/admanager/v1/team_messages.proto +1 -5
  70. package/build/protos/google/ads/admanager/v1/time_unit_enum.proto +1 -1
  71. package/build/protos/google/ads/admanager/v1/user_messages.proto +10 -9
  72. package/build/protos/google/ads/admanager/v1/user_service.proto +3 -1
  73. package/build/protos/google/ads/admanager/v1/video_position_enum.proto +47 -0
  74. package/build/protos/protos.d.ts +15832 -7575
  75. package/build/protos/protos.js +57744 -36372
  76. package/build/protos/protos.json +5795 -2511
  77. package/build/src/index.d.ts +28 -1
  78. package/build/src/index.js +20 -17
  79. package/build/src/index.js.map +1 -1
  80. package/build/src/v1/ad_break_service_client.d.ts +1040 -0
  81. package/build/src/v1/ad_break_service_client.js +1483 -0
  82. package/build/src/v1/ad_break_service_client.js.map +1 -0
  83. package/build/src/v1/ad_break_service_client_config.json +46 -0
  84. package/build/src/v1/ad_break_service_proto_list.json +74 -0
  85. package/build/src/v1/ad_unit_service_client.d.ts +331 -91
  86. package/build/src/v1/ad_unit_service_client.js +417 -95
  87. package/build/src/v1/ad_unit_service_client.js.map +1 -1
  88. package/build/src/v1/ad_unit_service_proto_list.json +29 -3
  89. package/build/src/v1/bandwidth_group_service_client.d.ts +904 -0
  90. package/build/src/v1/bandwidth_group_service_client.js +1369 -0
  91. package/build/src/v1/bandwidth_group_service_client.js.map +1 -0
  92. package/build/src/v1/bandwidth_group_service_client_config.json +34 -0
  93. package/build/src/v1/bandwidth_group_service_proto_list.json +74 -0
  94. package/build/src/v1/company_service_client.d.ts +291 -51
  95. package/build/src/v1/company_service_client.js +404 -75
  96. package/build/src/v1/company_service_client.js.map +1 -1
  97. package/build/src/v1/company_service_proto_list.json +29 -3
  98. package/build/src/v1/custom_field_service_client.d.ts +291 -51
  99. package/build/src/v1/custom_field_service_client.js +405 -79
  100. package/build/src/v1/custom_field_service_client.js.map +1 -1
  101. package/build/src/v1/custom_field_service_proto_list.json +29 -3
  102. package/build/src/v1/custom_targeting_key_service_client.d.ts +291 -51
  103. package/build/src/v1/custom_targeting_key_service_client.js +406 -82
  104. package/build/src/v1/custom_targeting_key_service_client.js.map +1 -1
  105. package/build/src/v1/custom_targeting_key_service_proto_list.json +29 -3
  106. package/build/src/v1/custom_targeting_value_service_client.d.ts +298 -58
  107. package/build/src/v1/custom_targeting_value_service_client.js +408 -84
  108. package/build/src/v1/custom_targeting_value_service_client.js.map +1 -1
  109. package/build/src/v1/custom_targeting_value_service_proto_list.json +29 -3
  110. package/build/src/v1/device_category_service_client.d.ts +904 -0
  111. package/build/src/v1/device_category_service_client.js +1369 -0
  112. package/build/src/v1/device_category_service_client.js.map +1 -0
  113. package/build/src/v1/device_category_service_client_config.json +34 -0
  114. package/build/src/v1/device_category_service_proto_list.json +74 -0
  115. package/build/src/v1/entity_signals_mapping_service_client.d.ts +298 -58
  116. package/build/src/v1/entity_signals_mapping_service_client.js +450 -114
  117. package/build/src/v1/entity_signals_mapping_service_client.js.map +1 -1
  118. package/build/src/v1/entity_signals_mapping_service_proto_list.json +29 -3
  119. package/build/src/v1/gapic_metadata.json +412 -0
  120. package/build/src/v1/geo_target_service_client.d.ts +904 -0
  121. package/build/src/v1/geo_target_service_client.js +1369 -0
  122. package/build/src/v1/geo_target_service_client.js.map +1 -0
  123. package/build/src/v1/geo_target_service_client_config.json +34 -0
  124. package/build/src/v1/geo_target_service_proto_list.json +74 -0
  125. package/build/src/v1/index.d.ts +9 -0
  126. package/build/src/v1/index.js +19 -1
  127. package/build/src/v1/index.js.map +1 -1
  128. package/build/src/v1/network_service_client.d.ts +252 -12
  129. package/build/src/v1/network_service_client.js +398 -62
  130. package/build/src/v1/network_service_client.js.map +1 -1
  131. package/build/src/v1/network_service_proto_list.json +29 -3
  132. package/build/src/v1/operating_system_service_client.d.ts +904 -0
  133. package/build/src/v1/operating_system_service_client.js +1369 -0
  134. package/build/src/v1/operating_system_service_client.js.map +1 -0
  135. package/build/src/v1/operating_system_service_client_config.json +34 -0
  136. package/build/src/v1/operating_system_service_proto_list.json +74 -0
  137. package/build/src/v1/operating_system_version_service_client.d.ts +911 -0
  138. package/build/src/v1/operating_system_version_service_client.js +1373 -0
  139. package/build/src/v1/operating_system_version_service_client.js.map +1 -0
  140. package/build/src/v1/operating_system_version_service_client_config.json +34 -0
  141. package/build/src/v1/operating_system_version_service_proto_list.json +74 -0
  142. package/build/src/v1/order_service_client.d.ts +296 -56
  143. package/build/src/v1/order_service_client.js +404 -75
  144. package/build/src/v1/order_service_client.js.map +1 -1
  145. package/build/src/v1/order_service_proto_list.json +29 -3
  146. package/build/src/v1/placement_service_client.d.ts +291 -51
  147. package/build/src/v1/placement_service_client.js +404 -75
  148. package/build/src/v1/placement_service_client.js.map +1 -1
  149. package/build/src/v1/placement_service_proto_list.json +29 -3
  150. package/build/src/v1/private_auction_deal_service_client.d.ts +965 -0
  151. package/build/src/v1/private_auction_deal_service_client.js +1445 -0
  152. package/build/src/v1/private_auction_deal_service_client.js.map +1 -0
  153. package/build/src/v1/private_auction_deal_service_client_config.json +42 -0
  154. package/build/src/v1/private_auction_deal_service_proto_list.json +74 -0
  155. package/build/src/v1/private_auction_service_client.d.ts +962 -0
  156. package/build/src/v1/private_auction_service_client.js +1443 -0
  157. package/build/src/v1/private_auction_service_client.js.map +1 -0
  158. package/build/src/v1/private_auction_service_client_config.json +42 -0
  159. package/build/src/v1/private_auction_service_proto_list.json +74 -0
  160. package/build/src/v1/programmatic_buyer_service_client.d.ts +905 -0
  161. package/build/src/v1/programmatic_buyer_service_client.js +1369 -0
  162. package/build/src/v1/programmatic_buyer_service_client.js.map +1 -0
  163. package/build/src/v1/programmatic_buyer_service_client_config.json +34 -0
  164. package/build/src/v1/programmatic_buyer_service_proto_list.json +74 -0
  165. package/build/src/v1/report_service_client.d.ts +351 -111
  166. package/build/src/v1/report_service_client.js +477 -163
  167. package/build/src/v1/report_service_client.js.map +1 -1
  168. package/build/src/v1/report_service_proto_list.json +29 -3
  169. package/build/src/v1/role_service_client.d.ts +290 -50
  170. package/build/src/v1/role_service_client.js +404 -75
  171. package/build/src/v1/role_service_client.js.map +1 -1
  172. package/build/src/v1/role_service_proto_list.json +29 -3
  173. package/build/src/v1/taxonomy_category_service_client.d.ts +291 -51
  174. package/build/src/v1/taxonomy_category_service_client.js +406 -81
  175. package/build/src/v1/taxonomy_category_service_client.js.map +1 -1
  176. package/build/src/v1/taxonomy_category_service_proto_list.json +29 -3
  177. package/build/src/v1/user_service_client.d.ts +251 -11
  178. package/build/src/v1/user_service_client.js +389 -58
  179. package/build/src/v1/user_service_client.js.map +1 -1
  180. package/build/src/v1/user_service_proto_list.json +29 -3
  181. package/package.json +4 -4
  182. package/CHANGELOG.md +0 -33
@@ -1,4 +1,4 @@
1
- // Copyright 2024 Google LLC
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 `Placement` objects.
34
34
  service PlacementService {
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 `Placement` object.
38
40
  rpc GetPlacement(GetPlacementRequest) returns (Placement) {
@@ -0,0 +1,119 @@
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/deal_buyer_permission_type_enum.proto";
20
+ import "google/ads/admanager/v1/private_marketplace_enums.proto";
21
+ import "google/ads/admanager/v1/size.proto";
22
+ import "google/ads/admanager/v1/targeting.proto";
23
+ import "google/api/field_behavior.proto";
24
+ import "google/api/resource.proto";
25
+ import "google/protobuf/timestamp.proto";
26
+ import "google/type/money.proto";
27
+
28
+ option csharp_namespace = "Google.Ads.AdManager.V1";
29
+ option go_package = "google.golang.org/genproto/googleapis/ads/admanager/v1;admanager";
30
+ option java_multiple_files = true;
31
+ option java_outer_classname = "PrivateAuctionDealMessagesProto";
32
+ option java_package = "com.google.ads.admanager.v1";
33
+ option php_namespace = "Google\\Ads\\AdManager\\V1";
34
+ option ruby_package = "Google::Ads::AdManager::V1";
35
+
36
+ // The `PrivateAuctionDeal` resource.
37
+ message PrivateAuctionDeal {
38
+ option (google.api.resource) = {
39
+ type: "admanager.googleapis.com/PrivateAuctionDeal"
40
+ pattern: "networks/{network_code}/privateAuctionDeals/{private_auction_deal}"
41
+ plural: "privateAuctionDeals"
42
+ singular: "privateAuctionDeal"
43
+ };
44
+
45
+ // Contains buyer data. This data is required by the Marketplace API.
46
+ message BuyerData {
47
+ // Optional. The email contacts of the buyer of the `PrivateAuctionDeal`.
48
+ repeated string buyer_emails = 1 [(google.api.field_behavior) = OPTIONAL];
49
+ }
50
+
51
+ // Identifier. The resource name of the `PrivateAuctionDeal`.
52
+ // Format:
53
+ // `networks/{network_code}/privateAuctionDeals/{private_auction_deal_id}`
54
+ string name = 1 [(google.api.field_behavior) = IDENTIFIER];
55
+
56
+ // Output only. `PrivateAuctionDeal` ID.
57
+ optional int64 private_auction_deal_id = 2
58
+ [(google.api.field_behavior) = OUTPUT_ONLY];
59
+
60
+ // Immutable. The ID of the
61
+ // [PrivateAuction](google.ads.admanager.v1.PrivateAuction).
62
+ optional int64 private_auction_id = 3
63
+ [(google.api.field_behavior) = IMMUTABLE];
64
+
65
+ // Output only. The display name of the
66
+ // [PrivateAuction](google.ads.admanager.v1.PrivateAuction).
67
+ optional string private_auction_display_name = 20
68
+ [(google.api.field_behavior) = OUTPUT_ONLY];
69
+
70
+ // Immutable. The account ID of the buyer of the `PrivateAuctionDeal`.
71
+ optional int64 buyer_account_id = 4 [(google.api.field_behavior) = IMMUTABLE];
72
+
73
+ // Output only. The external ID of the `PrivateAuctionDeal`.
74
+ optional int64 external_deal_id = 5
75
+ [(google.api.field_behavior) = OUTPUT_ONLY];
76
+
77
+ // Optional. The targeting of the `PrivateAuctionDeal`.
78
+ optional Targeting targeting = 6 [(google.api.field_behavior) = OPTIONAL];
79
+
80
+ // Optional. The end time of the `PrivateAuctionDeal`.
81
+ optional google.protobuf.Timestamp end_time = 8
82
+ [(google.api.field_behavior) = OPTIONAL];
83
+
84
+ // Required. The floor price of the `PrivateAuctionDeal`.
85
+ optional google.type.Money floor_price = 9
86
+ [(google.api.field_behavior) = REQUIRED];
87
+
88
+ // Optional. The expected creative sizes of the `PrivateAuctionDeal`.
89
+ repeated Size creative_sizes = 18 [(google.api.field_behavior) = OPTIONAL];
90
+
91
+ // Output only. The status of the `PrivateAuctionDeal`.
92
+ optional PrivateMarketplaceDealStatusEnum.PrivateMarketplaceDealStatus
93
+ status = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
94
+
95
+ // Optional. Whether the deal is enabled with priority over open auction.
96
+ optional bool auction_priority_enabled = 11
97
+ [(google.api.field_behavior) = OPTIONAL];
98
+
99
+ // Optional. Whether the deal has block override enabled.
100
+ optional bool block_override_enabled = 12
101
+ [(google.api.field_behavior) = OPTIONAL];
102
+
103
+ // Optional. The buyer permission model defining how the deal would transact
104
+ // among all buyers under the same bidder.
105
+ optional DealBuyerPermissionTypeEnum.DealBuyerPermissionType
106
+ buyer_permission_type = 13 [(google.api.field_behavior) = OPTIONAL];
107
+
108
+ // Optional. The buyer data required by the Marketplace API.
109
+ optional BuyerData buyer_data = 14 [(google.api.field_behavior) = OPTIONAL];
110
+
111
+ // Output only. The instant at which the `PrivateAuctionDeal` was created.
112
+ optional google.protobuf.Timestamp create_time = 15
113
+ [(google.api.field_behavior) = OUTPUT_ONLY];
114
+
115
+ // Output only. The instant at which the `PrivateAuctionDeal` was last
116
+ // updated.
117
+ optional google.protobuf.Timestamp update_time = 16
118
+ [(google.api.field_behavior) = OUTPUT_ONLY];
119
+ }
@@ -0,0 +1,184 @@
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/private_auction_deal_messages.proto";
20
+ import "google/api/annotations.proto";
21
+ import "google/api/client.proto";
22
+ import "google/api/field_behavior.proto";
23
+ import "google/api/resource.proto";
24
+ import "google/protobuf/field_mask.proto";
25
+
26
+ option csharp_namespace = "Google.Ads.AdManager.V1";
27
+ option go_package = "google.golang.org/genproto/googleapis/ads/admanager/v1;admanager";
28
+ option java_multiple_files = true;
29
+ option java_outer_classname = "PrivateAuctionDealServiceProto";
30
+ option java_package = "com.google.ads.admanager.v1";
31
+ option php_namespace = "Google\\Ads\\AdManager\\V1";
32
+ option ruby_package = "Google::Ads::AdManager::V1";
33
+
34
+ // Provides methods for handling `PrivateAuctionDeal` objects.
35
+ service PrivateAuctionDealService {
36
+ option (google.api.default_host) = "admanager.googleapis.com";
37
+ option (google.api.oauth_scopes) =
38
+ "https://www.googleapis.com/auth/admanager";
39
+
40
+ // API to retrieve a `PrivateAuctionDeal` object.
41
+ rpc GetPrivateAuctionDeal(GetPrivateAuctionDealRequest)
42
+ returns (PrivateAuctionDeal) {
43
+ option (google.api.http) = {
44
+ get: "/v1/{name=networks/*/privateAuctionDeals/*}"
45
+ };
46
+ option (google.api.method_signature) = "name";
47
+ }
48
+
49
+ // API to retrieve a list of `PrivateAuctionDeal` objects.
50
+ rpc ListPrivateAuctionDeals(ListPrivateAuctionDealsRequest)
51
+ returns (ListPrivateAuctionDealsResponse) {
52
+ option (google.api.http) = {
53
+ get: "/v1/{parent=networks/*}/privateAuctionDeals"
54
+ };
55
+ option (google.api.method_signature) = "parent";
56
+ }
57
+
58
+ // API to create a `PrivateAuctionDeal` object.
59
+ rpc CreatePrivateAuctionDeal(CreatePrivateAuctionDealRequest)
60
+ returns (PrivateAuctionDeal) {
61
+ option (google.api.http) = {
62
+ post: "/v1/{parent=networks/*}/privateAuctionDeals"
63
+ body: "private_auction_deal"
64
+ };
65
+ option (google.api.method_signature) = "parent,private_auction_deal";
66
+ }
67
+
68
+ // API to update a `PrivateAuctionDeal` object.
69
+ rpc UpdatePrivateAuctionDeal(UpdatePrivateAuctionDealRequest)
70
+ returns (PrivateAuctionDeal) {
71
+ option (google.api.http) = {
72
+ patch: "/v1/{private_auction_deal.name=networks/*/privateAuctionDeals/*}"
73
+ body: "private_auction_deal"
74
+ };
75
+ option (google.api.method_signature) = "private_auction_deal,update_mask";
76
+ }
77
+ }
78
+
79
+ // Request object for `GetPrivateAuctionDeal` method.
80
+ message GetPrivateAuctionDealRequest {
81
+ // Required. The resource name of the PrivateAuctionDeal.
82
+ // Format:
83
+ // `networks/{network_code}/privateAuctionDeals/{private_auction_deal_id}`
84
+ string name = 1 [
85
+ (google.api.field_behavior) = REQUIRED,
86
+ (google.api.resource_reference) = {
87
+ type: "admanager.googleapis.com/PrivateAuctionDeal"
88
+ }
89
+ ];
90
+ }
91
+
92
+ // Request object for `ListPrivateAuctionDeals` method.
93
+ message ListPrivateAuctionDealsRequest {
94
+ // Required. The parent, which owns this collection of PrivateAuctionDeals.
95
+ // Format:
96
+ // `networks/{network_code}`
97
+ string parent = 1 [
98
+ (google.api.field_behavior) = REQUIRED,
99
+ (google.api.resource_reference) = {
100
+ type: "admanager.googleapis.com/Network"
101
+ }
102
+ ];
103
+
104
+ // Optional. The maximum number of `PrivateAuctionDeals` to return. The
105
+ // service may return fewer than this value. If unspecified, at most 50
106
+ // `PrivateAuctionDeals` will be returned. The maximum value is 1000;
107
+ // values above 1000 will be coerced to 1000.
108
+ int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL];
109
+
110
+ // Optional. A page token, received from a previous `ListPrivateAuctionDeals`
111
+ // call. Provide this to retrieve the subsequent page.
112
+ //
113
+ // When paginating, all other parameters provided to
114
+ // `ListPrivateAuctionDeals` must match the call that provided the page
115
+ // token.
116
+ string page_token = 3 [(google.api.field_behavior) = OPTIONAL];
117
+
118
+ // Optional. Expression to filter the response.
119
+ // See syntax details at
120
+ // https://developers.google.com/ad-manager/api/beta/filters
121
+ string filter = 4 [(google.api.field_behavior) = OPTIONAL];
122
+
123
+ // Optional. Expression to specify sorting order.
124
+ // See syntax details at
125
+ // https://developers.google.com/ad-manager/api/beta/filters#order
126
+ string order_by = 5 [(google.api.field_behavior) = OPTIONAL];
127
+
128
+ // Optional. Number of individual resources to skip while paginating.
129
+ int32 skip = 6 [(google.api.field_behavior) = OPTIONAL];
130
+ }
131
+
132
+ // Response object for `ListPrivateAuctionDealsRequest` containing matching
133
+ // `PrivateAuctionDeal` objects.
134
+ message ListPrivateAuctionDealsResponse {
135
+ // The `PrivateAuctionDeal` objects from the specified network.
136
+ repeated PrivateAuctionDeal private_auction_deals = 1;
137
+
138
+ // A token, which can be sent as `page_token` to retrieve the next page.
139
+ // If this field is omitted, there are no subsequent pages.
140
+ string next_page_token = 2;
141
+
142
+ // Total number of `PrivateAuctionDeal` objects.
143
+ // If a filter was included in the request, this reflects the total number
144
+ // after the filtering is applied.
145
+ //
146
+ // `total_size` will not be calculated in the response unless it has been
147
+ // included in a response field mask. The response field mask can be provided
148
+ // to the method by using the URL parameter `$fields` or `fields`, or by using
149
+ // the HTTP/gRPC header `X-Goog-FieldMask`.
150
+ //
151
+ // For more information, see
152
+ // https://developers.google.com/ad-manager/api/beta/field-masks
153
+ int32 total_size = 3;
154
+ }
155
+
156
+ // Request object for `CreatePrivateAuctionDeal` method.
157
+ message CreatePrivateAuctionDealRequest {
158
+ // Required. The parent resource where this `PrivateAuctionDeal` will be
159
+ // created. Format: `networks/{network_code}`
160
+ string parent = 1 [
161
+ (google.api.field_behavior) = REQUIRED,
162
+ (google.api.resource_reference) = {
163
+ type: "admanager.googleapis.com/Network"
164
+ }
165
+ ];
166
+
167
+ // Required. The `PrivateAuctionDeal` to create.
168
+ PrivateAuctionDeal private_auction_deal = 2
169
+ [(google.api.field_behavior) = REQUIRED];
170
+ }
171
+
172
+ // Request object for `UpdatePrivateAuctionDeal` method.
173
+ message UpdatePrivateAuctionDealRequest {
174
+ // Required. The `PrivateAuctionDeal` to update.
175
+ //
176
+ // The `PrivateAuctionDeal`'s `name` is used to identify the
177
+ // `PrivateAuctionDeal` to update.
178
+ PrivateAuctionDeal private_auction_deal = 1
179
+ [(google.api.field_behavior) = REQUIRED];
180
+
181
+ // Required. The list of fields to update.
182
+ google.protobuf.FieldMask update_mask = 2
183
+ [(google.api.field_behavior) = REQUIRED];
184
+ }
@@ -0,0 +1,74 @@
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/api/field_behavior.proto";
20
+ import "google/api/resource.proto";
21
+ import "google/protobuf/timestamp.proto";
22
+
23
+ option csharp_namespace = "Google.Ads.AdManager.V1";
24
+ option go_package = "google.golang.org/genproto/googleapis/ads/admanager/v1;admanager";
25
+ option java_multiple_files = true;
26
+ option java_outer_classname = "PrivateAuctionMessagesProto";
27
+ option java_package = "com.google.ads.admanager.v1";
28
+ option php_namespace = "Google\\Ads\\AdManager\\V1";
29
+ option ruby_package = "Google::Ads::AdManager::V1";
30
+
31
+ // The `PrivateAuction` resource.
32
+ message PrivateAuction {
33
+ option (google.api.resource) = {
34
+ type: "admanager.googleapis.com/PrivateAuction"
35
+ pattern: "networks/{network_code}/privateAuctions/{private_auction}"
36
+ plural: "privateAuctions"
37
+ singular: "privateAuction"
38
+ };
39
+
40
+ // Identifier. The resource name of the `PrivateAuction`.
41
+ // Format:
42
+ // `networks/{network_code}/privateAuctions/{private_auction_id}`
43
+ string name = 1 [(google.api.field_behavior) = IDENTIFIER];
44
+
45
+ // Output only. `PrivateAuction` ID.
46
+ optional int64 private_auction_id = 2
47
+ [(google.api.field_behavior) = OUTPUT_ONLY];
48
+
49
+ // Required. Display name of the `PrivateAuction`. This attribute has a
50
+ // maximum length of 255 bytes.
51
+ optional string display_name = 3 [(google.api.field_behavior) = REQUIRED];
52
+
53
+ // Optional. Description of the `PrivateAuction`. This attribute has a
54
+ // maximum length of 4096 bytes.
55
+ optional string description = 4 [(google.api.field_behavior) = OPTIONAL];
56
+
57
+ // Optional. The resource names of the seller contact users associated with
58
+ // this `PrivateAuction`. Format: `networks/{network_code}/users/{user_id}`
59
+ repeated string seller_contact_users = 9 [
60
+ (google.api.field_behavior) = OPTIONAL,
61
+ (google.api.resource_reference) = { type: "admanager.googleapis.com/User" }
62
+ ];
63
+
64
+ // Output only. Whether the `PrivateAuction` is archived.
65
+ optional bool archived = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
66
+
67
+ // Output only. The instant at which the PrivateAuction was created.
68
+ optional google.protobuf.Timestamp create_time = 7
69
+ [(google.api.field_behavior) = OUTPUT_ONLY];
70
+
71
+ // Output only. The instant at which the PrivateAuction was last updated.
72
+ optional google.protobuf.Timestamp update_time = 8
73
+ [(google.api.field_behavior) = OUTPUT_ONLY];
74
+ }
@@ -0,0 +1,180 @@
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/private_auction_messages.proto";
20
+ import "google/api/annotations.proto";
21
+ import "google/api/client.proto";
22
+ import "google/api/field_behavior.proto";
23
+ import "google/api/resource.proto";
24
+ import "google/protobuf/field_mask.proto";
25
+
26
+ option csharp_namespace = "Google.Ads.AdManager.V1";
27
+ option go_package = "google.golang.org/genproto/googleapis/ads/admanager/v1;admanager";
28
+ option java_multiple_files = true;
29
+ option java_outer_classname = "PrivateAuctionServiceProto";
30
+ option java_package = "com.google.ads.admanager.v1";
31
+ option php_namespace = "Google\\Ads\\AdManager\\V1";
32
+ option ruby_package = "Google::Ads::AdManager::V1";
33
+
34
+ // Provides methods for handling `PrivateAuction` objects.
35
+ service PrivateAuctionService {
36
+ option (google.api.default_host) = "admanager.googleapis.com";
37
+ option (google.api.oauth_scopes) =
38
+ "https://www.googleapis.com/auth/admanager";
39
+
40
+ // API to retrieve a `PrivateAuction` object.
41
+ rpc GetPrivateAuction(GetPrivateAuctionRequest) returns (PrivateAuction) {
42
+ option (google.api.http) = {
43
+ get: "/v1/{name=networks/*/privateAuctions/*}"
44
+ };
45
+ option (google.api.method_signature) = "name";
46
+ }
47
+
48
+ // API to retrieve a list of `PrivateAuction` objects.
49
+ rpc ListPrivateAuctions(ListPrivateAuctionsRequest)
50
+ returns (ListPrivateAuctionsResponse) {
51
+ option (google.api.http) = {
52
+ get: "/v1/{parent=networks/*}/privateAuctions"
53
+ };
54
+ option (google.api.method_signature) = "parent";
55
+ }
56
+
57
+ // API to create a `PrivateAuction` object.
58
+ rpc CreatePrivateAuction(CreatePrivateAuctionRequest)
59
+ returns (PrivateAuction) {
60
+ option (google.api.http) = {
61
+ post: "/v1/{parent=networks/*}/privateAuctions"
62
+ body: "private_auction"
63
+ };
64
+ option (google.api.method_signature) = "parent,private_auction";
65
+ }
66
+
67
+ // API to update a `PrivateAuction` object.
68
+ rpc UpdatePrivateAuction(UpdatePrivateAuctionRequest)
69
+ returns (PrivateAuction) {
70
+ option (google.api.http) = {
71
+ patch: "/v1/{private_auction.name=networks/*/privateAuctions/*}"
72
+ body: "private_auction"
73
+ };
74
+ option (google.api.method_signature) = "private_auction,update_mask";
75
+ }
76
+ }
77
+
78
+ // Request object for `GetPrivateAuction` method.
79
+ message GetPrivateAuctionRequest {
80
+ // Required. The resource name of the PrivateAuction.
81
+ // Format:
82
+ // `networks/{network_code}/privateAuctions/{private_auction_id}`
83
+ string name = 1 [
84
+ (google.api.field_behavior) = REQUIRED,
85
+ (google.api.resource_reference) = {
86
+ type: "admanager.googleapis.com/PrivateAuction"
87
+ }
88
+ ];
89
+ }
90
+
91
+ // Request object for `ListPrivateAuctions` method.
92
+ message ListPrivateAuctionsRequest {
93
+ // Required. The parent, which owns this collection of PrivateAuctions.
94
+ // Format: `networks/{network_code}`
95
+ string parent = 1 [
96
+ (google.api.field_behavior) = REQUIRED,
97
+ (google.api.resource_reference) = {
98
+ type: "admanager.googleapis.com/Network"
99
+ }
100
+ ];
101
+
102
+ // Optional. The maximum number of `PrivateAuctions` to return. The service
103
+ // may return fewer than this value. If unspecified, at most 50
104
+ // `PrivateAuctions` will be returned. The maximum value is 1000;
105
+ // values above 1000 will be coerced to 1000.
106
+ int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL];
107
+
108
+ // Optional. A page token, received from a previous `ListPrivateAuctions`
109
+ // call. Provide this to retrieve the subsequent page.
110
+ //
111
+ // When paginating, all other parameters provided to
112
+ // `ListPrivateAuctions` must match the call that provided the
113
+ // page token.
114
+ string page_token = 3 [(google.api.field_behavior) = OPTIONAL];
115
+
116
+ // Optional. Expression to filter the response.
117
+ // See syntax details at
118
+ // https://developers.google.com/ad-manager/api/beta/filters
119
+ string filter = 4 [(google.api.field_behavior) = OPTIONAL];
120
+
121
+ // Optional. Expression to specify sorting order.
122
+ // See syntax details at
123
+ // https://developers.google.com/ad-manager/api/beta/filters#order
124
+ string order_by = 5 [(google.api.field_behavior) = OPTIONAL];
125
+
126
+ // Optional. Number of individual resources to skip while paginating.
127
+ int32 skip = 6 [(google.api.field_behavior) = OPTIONAL];
128
+ }
129
+
130
+ // Response object for `ListPrivateAuctionsRequest` containing
131
+ // matching `PrivateAuction` objects.
132
+ message ListPrivateAuctionsResponse {
133
+ // The `PrivateAuction` objects from the specified network.
134
+ repeated PrivateAuction private_auctions = 1;
135
+
136
+ // A token, which can be sent as `page_token` to retrieve the next page.
137
+ // If this field is omitted, there are no subsequent pages.
138
+ string next_page_token = 2;
139
+
140
+ // Total number of `PrivateAuction` objects.
141
+ // If a filter was included in the request, this reflects the total number
142
+ // after the filtering is applied.
143
+ //
144
+ // `total_size` will not be calculated in the response unless it has been
145
+ // included in a response field mask. The response field mask can be provided
146
+ // to the method by using the URL parameter `$fields` or `fields`, or by using
147
+ // the HTTP/gRPC header `X-Goog-FieldMask`.
148
+ //
149
+ // For more information, see
150
+ // https://developers.google.com/ad-manager/api/beta/field-masks
151
+ int32 total_size = 3;
152
+ }
153
+
154
+ // Request object for `CreatePrivateAuction` method.
155
+ message CreatePrivateAuctionRequest {
156
+ // Required. The parent resource where this `PrivateAuction` will be
157
+ // created. Format: `networks/{network_code}`
158
+ string parent = 1 [
159
+ (google.api.field_behavior) = REQUIRED,
160
+ (google.api.resource_reference) = {
161
+ type: "admanager.googleapis.com/Network"
162
+ }
163
+ ];
164
+
165
+ // Required. The `PrivateAuction` to create.
166
+ PrivateAuction private_auction = 2 [(google.api.field_behavior) = REQUIRED];
167
+ }
168
+
169
+ // Request object for `UpdatePrivateAuction` method.
170
+ message UpdatePrivateAuctionRequest {
171
+ // Required. The `PrivateAuction` to update.
172
+ //
173
+ // The `PrivateAuction`'s `name` is used to identify the
174
+ // `PrivateAuction` to update.
175
+ PrivateAuction private_auction = 1 [(google.api.field_behavior) = REQUIRED];
176
+
177
+ // Required. The list of fields to update.
178
+ google.protobuf.FieldMask update_mask = 2
179
+ [(google.api.field_behavior) = REQUIRED];
180
+ }
@@ -0,0 +1,50 @@
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 = "PrivateMarketplaceEnumsProto";
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
+ // [PrivateMarketplaceDealStatus][google.ads.admanager.v1.PrivateMarketplaceDealStatusEnum.PrivateMarketplaceDealStatus].
29
+ message PrivateMarketplaceDealStatusEnum {
30
+ // Describes the status of a private marketplace deal.
31
+ enum PrivateMarketplaceDealStatus {
32
+ // No value specified.
33
+ PRIVATE_MARKETPLACE_DEAL_STATUS_UNSPECIFIED = 0;
34
+
35
+ // The deal is pending.
36
+ PENDING = 1;
37
+
38
+ // The deal is active.
39
+ ACTIVE = 2;
40
+
41
+ // The deal is canceled.
42
+ CANCELED = 3;
43
+
44
+ // The deal is paused by the seller.
45
+ SELLER_PAUSED = 4;
46
+
47
+ // The deal is paused by the buyer.
48
+ BUYER_PAUSED = 5;
49
+ }
50
+ }