@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.
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 +414 -106
  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 +402 -81
  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 +403 -85
  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 +404 -88
  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 +406 -90
  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 +444 -124
  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 +397 -65
  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 +402 -81
  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 +402 -81
  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 +350 -110
  166. package/build/src/v1/report_service_client.js +471 -177
  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 +402 -81
  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 +404 -87
  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 +388 -59
  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 -40
@@ -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.
@@ -53,7 +53,7 @@ message AdUnit {
53
53
  // Required. Immutable. The AdUnit's parent. Every ad unit has a parent except
54
54
  // for the root ad unit, which is created by Google. Format:
55
55
  // "networks/{network_code}/adUnits/{ad_unit_id}"
56
- string parent_ad_unit = 10 [
56
+ optional string parent_ad_unit = 10 [
57
57
  (google.api.field_behavior) = REQUIRED,
58
58
  (google.api.field_behavior) = IMMUTABLE,
59
59
  (google.api.resource_reference) = {
@@ -69,28 +69,31 @@ message AdUnit {
69
69
 
70
70
  // Required. The display name of the ad unit. Its maximum length is 255
71
71
  // characters.
72
- string display_name = 9 [(google.api.field_behavior) = REQUIRED];
72
+ optional string display_name = 9 [(google.api.field_behavior) = REQUIRED];
73
73
 
74
- // Immutable. A string used to uniquely identify the ad unit for the purposes
75
- // of serving the ad. This attribute is optional and can be set during ad unit
74
+ // Optional. Immutable. A string used to uniquely identify the ad unit for the
75
+ // purposes of serving the ad. This attribute can be set during ad unit
76
76
  // creation. If it is not provided, it will be assigned by Google based on the
77
77
  // ad unit ID.
78
- string ad_unit_code = 2 [(google.api.field_behavior) = IMMUTABLE];
78
+ optional string ad_unit_code = 2 [
79
+ (google.api.field_behavior) = OPTIONAL,
80
+ (google.api.field_behavior) = IMMUTABLE
81
+ ];
79
82
 
80
83
  // Output only. The status of this ad unit. It defaults to ACTIVE.
81
- AdUnitStatusEnum.AdUnitStatus status = 13
84
+ optional AdUnitStatusEnum.AdUnitStatus status = 13
82
85
  [(google.api.field_behavior) = OUTPUT_ONLY];
83
86
 
84
87
  // Optional. The target window directly applied to this AdUnit.
85
88
  // If this field is not set, this AdUnit uses the target window specified in
86
89
  // effectiveTargetWindow.
87
- TargetWindowEnum.TargetWindow applied_target_window = 44
90
+ optional TargetWindowEnum.TargetWindow applied_target_window = 44
88
91
  [(google.api.field_behavior) = OPTIONAL];
89
92
 
90
93
  // Output only. Non-empty default. The target window of this AdUnit. This
91
94
  // value is inherited from ancestor AdUnits and defaults to TOP if no AdUnit
92
95
  // in the hierarchy specifies it.
93
- TargetWindowEnum.TargetWindow effective_target_window = 45 [
96
+ optional TargetWindowEnum.TargetWindow effective_target_window = 45 [
94
97
  (google.api.field_behavior) = NON_EMPTY_DEFAULT,
95
98
  (google.api.field_behavior) = OUTPUT_ONLY
96
99
  ];
@@ -112,19 +115,20 @@ message AdUnit {
112
115
 
113
116
  // Optional. A description of the ad unit. The maximum length is 65,535
114
117
  // characters.
115
- string description = 5 [(google.api.field_behavior) = OPTIONAL];
118
+ optional string description = 5 [(google.api.field_behavior) = OPTIONAL];
116
119
 
117
120
  // Optional. If this field is set to true, then the AdUnit will not be
118
121
  // implicitly targeted when its parent is. Traffickers must explicitly
119
122
  // target such an AdUnit or else no line items will serve to it. This
120
123
  // feature is only available for Ad Manager 360 accounts.
121
- bool explicitly_targeted = 6 [(google.api.field_behavior) = OPTIONAL];
124
+ optional bool explicitly_targeted = 6
125
+ [(google.api.field_behavior) = OPTIONAL];
122
126
 
123
127
  // Output only. This field is set to true if the ad unit has any children.
124
- bool has_children = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
128
+ optional bool has_children = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
125
129
 
126
130
  // Output only. The time this AdUnit was last modified.
127
- google.protobuf.Timestamp update_time = 8
131
+ optional google.protobuf.Timestamp update_time = 8
128
132
  [(google.api.field_behavior) = OUTPUT_ONLY];
129
133
 
130
134
  // Optional. The sizes that can be served inside this ad unit.
@@ -133,13 +137,13 @@ message AdUnit {
133
137
 
134
138
  // Optional. Determines what set top box video on demand channel this ad unit
135
139
  // corresponds to in an external set top box ad campaign system.
136
- string external_set_top_box_channel_id = 17
137
- [(google.api.field_behavior) = OPTIONAL];
140
+ optional string external_set_top_box_channel_id = 17
141
+ [deprecated = true, (google.api.field_behavior) = OPTIONAL];
138
142
 
139
143
  // Optional. The duration after which an Ad Unit will automatically refresh.
140
144
  // This is only valid for ad units in mobile apps. If not set, the ad unit
141
145
  // will not refresh.
142
- google.protobuf.Duration refresh_delay = 19
146
+ optional google.protobuf.Duration refresh_delay = 19
143
147
  [(google.api.field_behavior) = OPTIONAL];
144
148
 
145
149
  // Optional. The set of labels applied directly to this ad unit.
@@ -148,8 +152,8 @@ message AdUnit {
148
152
 
149
153
  // Output only. Contains the set of labels applied directly to the ad unit as
150
154
  // well as those inherited from the parent ad units. If a label has been
151
- // negated, only the negated label is returned. This field is readonly and is
152
- // assigned by Google.
155
+ // negated, only the negated label is returned. This attribute is assigned by
156
+ // Google.
153
157
  repeated AppliedLabel effective_applied_labels = 22
154
158
  [(google.api.field_behavior) = OUTPUT_ONLY];
155
159
 
@@ -163,14 +167,16 @@ message AdUnit {
163
167
  repeated LabelFrequencyCap effective_label_frequency_caps = 24
164
168
  [(google.api.field_behavior) = OUTPUT_ONLY];
165
169
 
166
- // Optional. The smart size mode for this ad unit. This attribute is optional
167
- // and defaults to SmartSizeMode.NONE for fixed sizes.
168
- SmartSizeModeEnum.SmartSizeMode smart_size_mode = 25
169
- [(google.api.field_behavior) = OPTIONAL];
170
+ // Optional. Non-empty default. The smart size mode for this ad unit. This
171
+ // attribute defaults to SmartSizeMode.NONE for fixed sizes.
172
+ optional SmartSizeModeEnum.SmartSizeMode smart_size_mode = 25 [
173
+ (google.api.field_behavior) = OPTIONAL,
174
+ (google.api.field_behavior) = NON_EMPTY_DEFAULT
175
+ ];
170
176
 
171
- // Optional. The value of AdSense enabled directly applied to this ad unit.
172
- // This attribute is optional and if not specified this ad unit will inherit
173
- // the value of effectiveAdsenseEnabled from its ancestors.
177
+ // Optional. The value of AdSense enabled directly applied to this ad unit. If
178
+ // not specified this ad unit will inherit the value of
179
+ // effectiveAdsenseEnabled from its ancestors.
174
180
  optional bool applied_adsense_enabled = 26
175
181
  [(google.api.field_behavior) = OPTIONAL];
176
182
 
@@ -178,7 +184,7 @@ message AdUnit {
178
184
  // from the AdSense content network. This attribute defaults to the ad unit's
179
185
  // parent or ancestor's setting if one has been set. If no ancestor of the ad
180
186
  // unit has set appliedAdsenseEnabled, the attribute is defaulted to true.
181
- bool effective_adsense_enabled = 27
187
+ optional bool effective_adsense_enabled = 27
182
188
  [(google.api.field_behavior) = OUTPUT_ONLY];
183
189
  }
184
190
 
@@ -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 AdUnit objects.
34
34
  service AdUnitService {
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 an AdUnit object.
38
40
  rpc GetAdUnit(GetAdUnitRequest) returns (AdUnit) {
@@ -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.
@@ -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.
@@ -0,0 +1,46 @@
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
+
22
+ option csharp_namespace = "Google.Ads.AdManager.V1";
23
+ option go_package = "google.golang.org/genproto/googleapis/ads/admanager/v1;admanager";
24
+ option java_multiple_files = true;
25
+ option java_outer_classname = "BandwidthGroupMessagesProto";
26
+ option java_package = "com.google.ads.admanager.v1";
27
+ option php_namespace = "Google\\Ads\\AdManager\\V1";
28
+ option ruby_package = "Google::Ads::AdManager::V1";
29
+
30
+ // Represents a group of bandwidths that are logically organized by some well
31
+ // known generic name such as 'Cable' or 'DSL'.
32
+ message BandwidthGroup {
33
+ option (google.api.resource) = {
34
+ type: "admanager.googleapis.com/BandwidthGroup"
35
+ pattern: "networks/{network_code}/bandwidthGroups/{bandwidth_group}"
36
+ plural: "bandwidthGroups"
37
+ singular: "bandwidthGroup"
38
+ };
39
+
40
+ // Identifier. The resource name of the `BandwidthGroup`.
41
+ // Format: `networks/{network_code}/bandwidthGroups/{bandwidth_group_id}`
42
+ optional string name = 1 [(google.api.field_behavior) = IDENTIFIER];
43
+
44
+ // Output only. The localized name of the bandwidth group.
45
+ optional string display_name = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
46
+ }
@@ -0,0 +1,129 @@
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/bandwidth_group_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
+
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 = "BandwidthGroupServiceProto";
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
+ // Provides methods for handling `BandwidthGroup` objects.
34
+ service BandwidthGroupService {
35
+ option (google.api.default_host) = "admanager.googleapis.com";
36
+ option (google.api.oauth_scopes) =
37
+ "https://www.googleapis.com/auth/admanager";
38
+
39
+ // API to retrieve a `BandwidthGroup` object.
40
+ rpc GetBandwidthGroup(GetBandwidthGroupRequest) returns (BandwidthGroup) {
41
+ option (google.api.http) = {
42
+ get: "/v1/{name=networks/*/bandwidthGroups/*}"
43
+ };
44
+ option (google.api.method_signature) = "name";
45
+ }
46
+
47
+ // API to retrieve a list of `BandwidthGroup` objects.
48
+ rpc ListBandwidthGroups(ListBandwidthGroupsRequest)
49
+ returns (ListBandwidthGroupsResponse) {
50
+ option (google.api.http) = {
51
+ get: "/v1/{parent=networks/*}/bandwidthGroups"
52
+ };
53
+ option (google.api.method_signature) = "parent";
54
+ }
55
+ }
56
+
57
+ // Request object for `GetBandwidthGroup` method.
58
+ message GetBandwidthGroupRequest {
59
+ // Required. The resource name of the BandwidthGroup.
60
+ // Format: `networks/{network_code}/bandwidthGroups/{bandwidth_group_id}`
61
+ string name = 1 [
62
+ (google.api.field_behavior) = REQUIRED,
63
+ (google.api.resource_reference) = {
64
+ type: "admanager.googleapis.com/BandwidthGroup"
65
+ }
66
+ ];
67
+ }
68
+
69
+ // Request object for `ListBandwidthGroups` method.
70
+ message ListBandwidthGroupsRequest {
71
+ // Required. The parent, which owns this collection of BandwidthGroups.
72
+ // Format: `networks/{network_code}`
73
+ string parent = 1 [
74
+ (google.api.field_behavior) = REQUIRED,
75
+ (google.api.resource_reference) = {
76
+ type: "admanager.googleapis.com/Network"
77
+ }
78
+ ];
79
+
80
+ // Optional. The maximum number of `BandwidthGroups` to return. The service
81
+ // may return fewer than this value. If unspecified, at most 50
82
+ // `BandwidthGroups` will be returned. The maximum value is 1000; values above
83
+ // 1000 will be coerced to 1000.
84
+ int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL];
85
+
86
+ // Optional. A page token, received from a previous `ListBandwidthGroups`
87
+ // call. Provide this to retrieve the subsequent page.
88
+ //
89
+ // When paginating, all other parameters provided to `ListBandwidthGroups`
90
+ // must match the call that provided the page token.
91
+ string page_token = 3 [(google.api.field_behavior) = OPTIONAL];
92
+
93
+ // Optional. Expression to filter the response.
94
+ // See syntax details at
95
+ // https://developers.google.com/ad-manager/api/beta/filters
96
+ string filter = 4 [(google.api.field_behavior) = OPTIONAL];
97
+
98
+ // Optional. Expression to specify sorting order.
99
+ // See syntax details at
100
+ // https://developers.google.com/ad-manager/api/beta/filters#order
101
+ string order_by = 5 [(google.api.field_behavior) = OPTIONAL];
102
+
103
+ // Optional. Number of individual resources to skip while paginating.
104
+ int32 skip = 6 [(google.api.field_behavior) = OPTIONAL];
105
+ }
106
+
107
+ // Response object for `ListBandwidthGroupsRequest` containing matching
108
+ // `BandwidthGroup` objects.
109
+ message ListBandwidthGroupsResponse {
110
+ // The `BandwidthGroup` objects from the specified network.
111
+ repeated BandwidthGroup bandwidth_groups = 1;
112
+
113
+ // A token, which can be sent as `page_token` to retrieve the next page.
114
+ // If this field is omitted, there are no subsequent pages.
115
+ string next_page_token = 2;
116
+
117
+ // Total number of `BandwidthGroup` objects.
118
+ // If a filter was included in the request, this reflects the total number
119
+ // after the filtering is applied.
120
+ //
121
+ // `total_size` will not be calculated in the response unless it has been
122
+ // included in a response field mask. The response field mask can be provided
123
+ // to the method by using the URL parameter `$fields` or `fields`, or by using
124
+ // the HTTP/gRPC header `X-Goog-FieldMask`.
125
+ //
126
+ // For more information, see
127
+ // https://developers.google.com/ad-manager/api/beta/field-masks
128
+ int32 total_size = 3;
129
+ }
@@ -0,0 +1,123 @@
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 = "CompanyEnumsProto";
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
+ // [CompanyType][google.ads.admanager.v1.CompanyTypeEnum.CompanyType]
29
+ message CompanyTypeEnum {
30
+ // The type of a company.
31
+ enum CompanyType {
32
+ // No value specified
33
+ COMPANY_TYPE_UNSPECIFIED = 0;
34
+
35
+ // A business entity that purchases ad inventory.
36
+ ADVERTISER = 1;
37
+
38
+ // A company representing the publisher's own advertiser for house ads.
39
+ HOUSE_ADVERTISER = 2;
40
+
41
+ // An organization that manages ad accounts and offers services, such as ad
42
+ // creation, placement, and management to advertisers.
43
+ AGENCY = 3;
44
+
45
+ // A company representing the publisher's own agency.
46
+ HOUSE_AGENCY = 4;
47
+
48
+ // A company representing multiple advertisers and agencies.
49
+ AD_NETWORK = 5;
50
+ }
51
+ }
52
+
53
+ // Wrapper message for
54
+ // [CompanyCreditStatus][google.ads.admanager.v1.CompanyCreditStatusEnum.CompanyCreditStatus]
55
+ message CompanyCreditStatusEnum {
56
+ // The credit status of a company.
57
+ //
58
+ // Credit statuses specify the credit-worthiness of a company and affect the
59
+ // ad serving of campaigns belonging to the company.
60
+ //
61
+ // In basic settings, only the
62
+ // [ACTIVE][google.ads.admanager.v1.CompanyCreditStatusEnum.CompanyCreditStatus.ACTIVE]
63
+ // and
64
+ // [INACTIVE][google.ads.admanager.v1.CompanyCreditStatusEnum.CompanyCreditStatus.INACTIVE]
65
+ // credit statuses are applicable. In advance settings, all credit statuses
66
+ // are applicable.
67
+ enum CompanyCreditStatus {
68
+ // No value specified
69
+ COMPANY_CREDIT_STATUS_UNSPECIFIED = 0;
70
+
71
+ // The company's credit status is active.
72
+ //
73
+ // Line items belonging to the company can serve.
74
+ //
75
+ // This credit status is the default for basic settings and is available in
76
+ // both basic and advance settings.
77
+ ACTIVE = 1;
78
+
79
+ // The company's credit status is inactive.
80
+ //
81
+ // Line items belonging to the company cannot be activated. However, line
82
+ // items that were activated before the credit status changed will remain
83
+ // active. New orders or line items belonging to the company cannot be
84
+ // created.
85
+ //
86
+ // Companies with this credit status will be hidden by default in company
87
+ // search results.
88
+ //
89
+ // This credit status is available in both basic and advance settings.
90
+ INACTIVE = 2;
91
+
92
+ // The company's credit status is on hold.
93
+ //
94
+ // Line items belonging to the company cannot be activated. However, line
95
+ // items that were activated before the credit status changed will remain
96
+ // active. New orders or line items belonging to the company can be
97
+ // created.
98
+ //
99
+ // This credit status is the default in advance settings and is only
100
+ // available in advance settings.
101
+ ON_HOLD = 3;
102
+
103
+ // The company's credit status is stopped.
104
+ //
105
+ // Line items belonging to the company cannot be activated. However, line
106
+ // items that were activated before the credit status changed will remain
107
+ // active. New orders or line items belonging to the company cannot be
108
+ // created.
109
+ //
110
+ // This credit status is only available in advance settings.
111
+ STOP = 4;
112
+
113
+ // The company's credit status is blocked.
114
+ //
115
+ // All active line items belonging to the company will stop serving with
116
+ // immediate effect. Line items belonging to the company cannot be
117
+ // activated, and new orders or line items belonging to the company cannot
118
+ // be created.
119
+ //
120
+ // This credit status is only available in advance settings.
121
+ BLOCKED = 5;
122
+ }
123
+ }
@@ -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.
@@ -17,8 +17,7 @@ syntax = "proto3";
17
17
  package google.ads.admanager.v1;
18
18
 
19
19
  import "google/ads/admanager/v1/applied_label.proto";
20
- import "google/ads/admanager/v1/company_credit_status_enum.proto";
21
- import "google/ads/admanager/v1/company_type_enum.proto";
20
+ import "google/ads/admanager/v1/company_enums.proto";
22
21
  import "google/api/field_behavior.proto";
23
22
  import "google/api/resource.proto";
24
23
  import "google/protobuf/timestamp.proto";
@@ -112,11 +111,11 @@ message Company {
112
111
  (google.api.resource_reference) = { type: "admanager.googleapis.com/Team" }
113
112
  ];
114
113
 
115
- // Output only. The time the `Company` was last modified.
116
- google.protobuf.Timestamp update_time = 15
117
- [(google.api.field_behavior) = OUTPUT_ONLY];
118
-
119
114
  // Optional. The ID of the Google-recognized canonicalized form of the
120
115
  // `Company`.
121
116
  int64 third_party_company_id = 16 [(google.api.field_behavior) = OPTIONAL];
117
+
118
+ // Output only. The time the `Company` was last modified.
119
+ google.protobuf.Timestamp update_time = 15
120
+ [(google.api.field_behavior) = OUTPUT_ONLY];
122
121
  }
@@ -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 `Company` objects.
34
34
  service CompanyService {
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 `Company` object.
38
40
  rpc GetCompany(GetCompanyRequest) returns (Company) {
@@ -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.
@@ -43,7 +43,7 @@ message Contact {
43
43
  // Format: `networks/{network_code}/contacts/{contact_id}`
44
44
  string name = 1 [(google.api.field_behavior) = IDENTIFIER];
45
45
 
46
- // Output only. The unique ID of the contact. This value is readonly and is
47
- // assigned by Google.
48
- int64 contact_id = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
46
+ // Output only. The display name of the Company.
47
+ optional string company_display_name = 19
48
+ [(google.api.field_behavior) = OUTPUT_ONLY];
49
49
  }
@@ -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.
@@ -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.
@@ -38,34 +38,35 @@ message CustomField {
38
38
  };
39
39
 
40
40
  // Identifier. The resource name of the `CustomField`.
41
- // Format: `networks/{network_code}/customFields/{custom_field_id}`
41
+ // Format: `networks/{network_code}/customFields/{custom_field}`
42
42
  string name = 1 [(google.api.field_behavior) = IDENTIFIER];
43
43
 
44
- // Output only. Unique ID of the CustomField. This value is readonly and is
45
- // assigned by Google.
46
- int64 custom_field_id = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
44
+ // Output only. Unique ID of the CustomField. This attribute is assigned by
45
+ // Google.
46
+ optional int64 custom_field_id = 2
47
+ [(google.api.field_behavior) = OUTPUT_ONLY];
47
48
 
48
49
  // Required. Name of the CustomField. The max length is 127 characters.
49
- string display_name = 3 [(google.api.field_behavior) = REQUIRED];
50
+ optional string display_name = 3 [(google.api.field_behavior) = REQUIRED];
50
51
 
51
52
  // Optional. A description of the custom field. The maximum length is 511
52
53
  // characters.
53
- string description = 4 [(google.api.field_behavior) = OPTIONAL];
54
+ optional string description = 4 [(google.api.field_behavior) = OPTIONAL];
54
55
 
55
56
  // Output only. The status of the `CustomField`.
56
- CustomFieldStatusEnum.CustomFieldStatus status = 5
57
+ optional CustomFieldStatusEnum.CustomFieldStatus status = 5
57
58
  [(google.api.field_behavior) = OUTPUT_ONLY];
58
59
 
59
60
  // Required. The type of entity the `CustomField` can be applied to.
60
- CustomFieldEntityTypeEnum.CustomFieldEntityType entity_type = 7
61
+ optional CustomFieldEntityTypeEnum.CustomFieldEntityType entity_type = 7
61
62
  [(google.api.field_behavior) = REQUIRED];
62
63
 
63
64
  // Required. The data type of the `CustomField`.
64
- CustomFieldDataTypeEnum.CustomFieldDataType data_type = 8
65
+ optional CustomFieldDataTypeEnum.CustomFieldDataType data_type = 8
65
66
  [(google.api.field_behavior) = REQUIRED];
66
67
 
67
68
  // Required. The visibility of the `CustomField`.
68
- CustomFieldVisibilityEnum.CustomFieldVisibility visibility = 9
69
+ optional CustomFieldVisibilityEnum.CustomFieldVisibility visibility = 9
69
70
  [(google.api.field_behavior) = REQUIRED];
70
71
 
71
72
  // Optional. The drop-down options for the `CustomField`.
@@ -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 `CustomField` objects.
34
34
  service CustomFieldService {
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 `CustomField` object.
38
40
  rpc GetCustomField(GetCustomFieldRequest) returns (CustomField) {
@@ -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.
@@ -30,7 +30,6 @@ option ruby_package = "Google::Ads::AdManager::V1";
30
30
  // A value for a CustomField on a resource.
31
31
  message CustomFieldValue {
32
32
  // Represent custom field value type.
33
- // Next Id: 5
34
33
  message Value {
35
34
  // The value of this field.
36
35
  oneof value {
@@ -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.
@@ -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.
@@ -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 `CustomTargetingKey` objects.
34
34
  service CustomTargetingKeyService {
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 `CustomTargetingKey` object.
38
40
  rpc GetCustomTargetingKey(GetCustomTargetingKeyRequest)
@@ -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.