@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
@@ -96,19 +96,11 @@ class UserServiceClient {
96
96
  constructor(opts, gaxInstance) {
97
97
  // Ensure that options include all the required fields.
98
98
  const staticMembers = this.constructor;
99
- if (opts?.universe_domain &&
100
- opts?.universeDomain &&
101
- opts?.universe_domain !== opts?.universeDomain) {
99
+ if (opts?.universe_domain && opts?.universeDomain && opts?.universe_domain !== opts?.universeDomain) {
102
100
  throw new Error('Please set either universe_domain or universeDomain, but not both.');
103
101
  }
104
- const universeDomainEnvVar = typeof process === 'object' && typeof process.env === 'object'
105
- ? process.env['GOOGLE_CLOUD_UNIVERSE_DOMAIN']
106
- : undefined;
107
- this._universeDomain =
108
- opts?.universeDomain ??
109
- opts?.universe_domain ??
110
- universeDomainEnvVar ??
111
- 'googleapis.com';
102
+ const universeDomainEnvVar = (typeof process === 'object' && typeof process.env === 'object') ? process.env['GOOGLE_CLOUD_UNIVERSE_DOMAIN'] : undefined;
103
+ this._universeDomain = opts?.universeDomain ?? opts?.universe_domain ?? universeDomainEnvVar ?? 'googleapis.com';
112
104
  this._servicePath = 'admanager.' + this._universeDomain;
113
105
  const servicePath = opts?.servicePath || opts?.apiEndpoint || this._servicePath;
114
106
  this._providedCustomServicePath = !!(opts?.servicePath || opts?.apiEndpoint);
@@ -121,8 +113,7 @@ class UserServiceClient {
121
113
  else {
122
114
  opts.fallback = opts.fallback ?? true;
123
115
  }
124
- const fallback = opts?.fallback ??
125
- (typeof window !== 'undefined' && typeof window?.fetch === 'function');
116
+ const fallback = opts?.fallback ?? (typeof window !== 'undefined' && typeof window?.fetch === 'function');
126
117
  opts = Object.assign({ servicePath, port, clientConfig, fallback }, opts);
127
118
  // Request numeric enum values if REST transport is used.
128
119
  opts.numericEnums = true;
@@ -151,7 +142,10 @@ class UserServiceClient {
151
142
  this.auth.defaultScopes = staticMembers.scopes;
152
143
  }
153
144
  // Determine the client header string.
154
- const clientHeader = [`gax/${this._gaxModule.version}`, `gapic/${version}`];
145
+ const clientHeader = [
146
+ `gax/${this._gaxModule.version}`,
147
+ `gapic/${version}`,
148
+ ];
155
149
  if (typeof process === 'object' && 'versions' in process) {
156
150
  clientHeader.push(`gl-node/${process.versions.node}`);
157
151
  }
@@ -173,17 +167,27 @@ class UserServiceClient {
173
167
  // identifiers to uniquely identify resources within the API.
174
168
  // Create useful helper objects for these.
175
169
  this.pathTemplates = {
170
+ adBreakPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/liveStreamEventsByAssetKey/{asset_key}/adBreaks/{ad_break}'),
176
171
  adUnitPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/adUnits/{ad_unit}'),
172
+ bandwidthGroupPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/bandwidthGroups/{bandwidth_group}'),
177
173
  companyPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/companies/{company}'),
178
174
  contactPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/contacts/{contact}'),
179
175
  customFieldPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/customFields/{custom_field}'),
180
176
  customTargetingKeyPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/customTargetingKeys/{custom_targeting_key}'),
181
- customTargetingValuePathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/customTargetingKeys/{custom_targeting_key}/customTargetingValues/{custom_targeting_value}'),
177
+ customTargetingValuePathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/customTargetingValues/{custom_targeting_value}'),
178
+ deviceCategoryPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/deviceCategories/{device_category}'),
182
179
  entitySignalsMappingPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/entitySignalsMappings/{entity_signals_mapping}'),
180
+ geoTargetPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/geoTargets/{geo_target}'),
183
181
  labelPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/labels/{label}'),
182
+ liveStreamEventPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/liveStreamEvents/{live_stream_event}'),
184
183
  networkPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}'),
184
+ operatingSystemPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/operatingSystems/{operating_system}'),
185
+ operatingSystemVersionPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/operatingSystemVersions/{operating_system_version}'),
185
186
  orderPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/orders/{order}'),
186
187
  placementPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/placements/{placement}'),
188
+ privateAuctionPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/privateAuctions/{private_auction}'),
189
+ privateAuctionDealPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/privateAuctionDeals/{private_auction_deal}'),
190
+ programmaticBuyerPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/programmaticBuyers/{programmatic_buyer}'),
187
191
  reportPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/reports/{report}'),
188
192
  rolePathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/roles/{role}'),
189
193
  taxonomyCategoryPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/taxonomyCategories/{taxonomy_category}'),
@@ -217,10 +221,10 @@ class UserServiceClient {
217
221
  }
218
222
  // Put together the "service stub" for
219
223
  // google.ads.admanager.v1.UserService.
220
- this.userServiceStub = this._gaxGrpc.createStub(this._opts.fallback
221
- ? this._protos.lookupService('google.ads.admanager.v1.UserService')
222
- : // eslint-disable-next-line @typescript-eslint/no-explicit-any
223
- this._protos.google.ads.admanager.v1.UserService, this._opts, this._providedCustomServicePath);
224
+ this.userServiceStub = this._gaxGrpc.createStub(this._opts.fallback ?
225
+ this._protos.lookupService('google.ads.admanager.v1.UserService') :
226
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
227
+ this._protos.google.ads.admanager.v1.UserService, this._opts, this._providedCustomServicePath);
224
228
  // Iterate over each of the methods that the service provides
225
229
  // and create an API call method for each.
226
230
  const userServiceStubMethods = ['getUser'];
@@ -246,8 +250,7 @@ class UserServiceClient {
246
250
  * @returns {string} The DNS address for this service.
247
251
  */
248
252
  static get servicePath() {
249
- if (typeof process === 'object' &&
250
- typeof process.emitWarning === 'function') {
253
+ if (typeof process === 'object' && typeof process.emitWarning === 'function') {
251
254
  process.emitWarning('Static servicePath is deprecated, please use the instance method instead.', 'DeprecationWarning');
252
255
  }
253
256
  return 'admanager.googleapis.com';
@@ -258,8 +261,7 @@ class UserServiceClient {
258
261
  * @returns {string} The DNS address for this service.
259
262
  */
260
263
  static get apiEndpoint() {
261
- if (typeof process === 'object' &&
262
- typeof process.emitWarning === 'function') {
264
+ if (typeof process === 'object' && typeof process.emitWarning === 'function') {
263
265
  process.emitWarning('Static apiEndpoint is deprecated, please use the instance method instead.', 'DeprecationWarning');
264
266
  }
265
267
  return 'admanager.googleapis.com';
@@ -287,7 +289,9 @@ class UserServiceClient {
287
289
  * @returns {string[]} List of default scopes.
288
290
  */
289
291
  static get scopes() {
290
- return [];
292
+ return [
293
+ 'https://www.googleapis.com/auth/admanager'
294
+ ];
291
295
  }
292
296
  /**
293
297
  * Return the project ID used by this class.
@@ -313,13 +317,10 @@ class UserServiceClient {
313
317
  options = options || {};
314
318
  options.otherArgs = options.otherArgs || {};
315
319
  options.otherArgs.headers = options.otherArgs.headers || {};
316
- options.otherArgs.headers['x-goog-request-params'] =
317
- this._gaxModule.routingHeader.fromParams({
318
- name: request.name ?? '',
319
- });
320
- this.initialize().catch(err => {
321
- throw err;
320
+ options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
321
+ 'name': request.name ?? '',
322
322
  });
323
+ this.initialize().catch(err => { throw err; });
323
324
  this._log.info('getUser request %j', request);
324
325
  const wrappedCallback = callback
325
326
  ? (error, response, options, rawResponse) => {
@@ -327,16 +328,66 @@ class UserServiceClient {
327
328
  callback(error, response, options, rawResponse); // We verified callback above.
328
329
  }
329
330
  : undefined;
330
- return this.innerApiCalls
331
- .getUser(request, options, wrappedCallback)
331
+ return this.innerApiCalls.getUser(request, options, wrappedCallback)
332
332
  ?.then(([response, options, rawResponse]) => {
333
333
  this._log.info('getUser response %j', response);
334
334
  return [response, options, rawResponse];
335
+ }).catch((error) => {
336
+ if (error && 'statusDetails' in error && error.statusDetails instanceof Array) {
337
+ const protos = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
338
+ error.statusDetails = (0, google_gax_1.decodeAnyProtosInArray)(error.statusDetails, protos);
339
+ }
340
+ throw error;
335
341
  });
336
342
  }
337
343
  // --------------------
338
344
  // -- Path templates --
339
345
  // --------------------
346
+ /**
347
+ * Return a fully-qualified adBreak resource name string.
348
+ *
349
+ * @param {string} network_code
350
+ * @param {string} asset_key
351
+ * @param {string} ad_break
352
+ * @returns {string} Resource name string.
353
+ */
354
+ adBreakPath(networkCode, assetKey, adBreak) {
355
+ return this.pathTemplates.adBreakPathTemplate.render({
356
+ network_code: networkCode,
357
+ asset_key: assetKey,
358
+ ad_break: adBreak,
359
+ });
360
+ }
361
+ /**
362
+ * Parse the network_code from AdBreak resource.
363
+ *
364
+ * @param {string} adBreakName
365
+ * A fully-qualified path representing AdBreak resource.
366
+ * @returns {string} A string representing the network_code.
367
+ */
368
+ matchNetworkCodeFromAdBreakName(adBreakName) {
369
+ return this.pathTemplates.adBreakPathTemplate.match(adBreakName).network_code;
370
+ }
371
+ /**
372
+ * Parse the asset_key from AdBreak resource.
373
+ *
374
+ * @param {string} adBreakName
375
+ * A fully-qualified path representing AdBreak resource.
376
+ * @returns {string} A string representing the asset_key.
377
+ */
378
+ matchAssetKeyFromAdBreakName(adBreakName) {
379
+ return this.pathTemplates.adBreakPathTemplate.match(adBreakName).asset_key;
380
+ }
381
+ /**
382
+ * Parse the ad_break from AdBreak resource.
383
+ *
384
+ * @param {string} adBreakName
385
+ * A fully-qualified path representing AdBreak resource.
386
+ * @returns {string} A string representing the ad_break.
387
+ */
388
+ matchAdBreakFromAdBreakName(adBreakName) {
389
+ return this.pathTemplates.adBreakPathTemplate.match(adBreakName).ad_break;
390
+ }
340
391
  /**
341
392
  * Return a fully-qualified adUnit resource name string.
342
393
  *
@@ -370,6 +421,39 @@ class UserServiceClient {
370
421
  matchAdUnitFromAdUnitName(adUnitName) {
371
422
  return this.pathTemplates.adUnitPathTemplate.match(adUnitName).ad_unit;
372
423
  }
424
+ /**
425
+ * Return a fully-qualified bandwidthGroup resource name string.
426
+ *
427
+ * @param {string} network_code
428
+ * @param {string} bandwidth_group
429
+ * @returns {string} Resource name string.
430
+ */
431
+ bandwidthGroupPath(networkCode, bandwidthGroup) {
432
+ return this.pathTemplates.bandwidthGroupPathTemplate.render({
433
+ network_code: networkCode,
434
+ bandwidth_group: bandwidthGroup,
435
+ });
436
+ }
437
+ /**
438
+ * Parse the network_code from BandwidthGroup resource.
439
+ *
440
+ * @param {string} bandwidthGroupName
441
+ * A fully-qualified path representing BandwidthGroup resource.
442
+ * @returns {string} A string representing the network_code.
443
+ */
444
+ matchNetworkCodeFromBandwidthGroupName(bandwidthGroupName) {
445
+ return this.pathTemplates.bandwidthGroupPathTemplate.match(bandwidthGroupName).network_code;
446
+ }
447
+ /**
448
+ * Parse the bandwidth_group from BandwidthGroup resource.
449
+ *
450
+ * @param {string} bandwidthGroupName
451
+ * A fully-qualified path representing BandwidthGroup resource.
452
+ * @returns {string} A string representing the bandwidth_group.
453
+ */
454
+ matchBandwidthGroupFromBandwidthGroupName(bandwidthGroupName) {
455
+ return this.pathTemplates.bandwidthGroupPathTemplate.match(bandwidthGroupName).bandwidth_group;
456
+ }
373
457
  /**
374
458
  * Return a fully-qualified company resource name string.
375
459
  *
@@ -391,8 +475,7 @@ class UserServiceClient {
391
475
  * @returns {string} A string representing the network_code.
392
476
  */
393
477
  matchNetworkCodeFromCompanyName(companyName) {
394
- return this.pathTemplates.companyPathTemplate.match(companyName)
395
- .network_code;
478
+ return this.pathTemplates.companyPathTemplate.match(companyName).network_code;
396
479
  }
397
480
  /**
398
481
  * Parse the company from Company resource.
@@ -425,8 +508,7 @@ class UserServiceClient {
425
508
  * @returns {string} A string representing the network_code.
426
509
  */
427
510
  matchNetworkCodeFromContactName(contactName) {
428
- return this.pathTemplates.contactPathTemplate.match(contactName)
429
- .network_code;
511
+ return this.pathTemplates.contactPathTemplate.match(contactName).network_code;
430
512
  }
431
513
  /**
432
514
  * Parse the contact from Contact resource.
@@ -459,8 +541,7 @@ class UserServiceClient {
459
541
  * @returns {string} A string representing the network_code.
460
542
  */
461
543
  matchNetworkCodeFromCustomFieldName(customFieldName) {
462
- return this.pathTemplates.customFieldPathTemplate.match(customFieldName)
463
- .network_code;
544
+ return this.pathTemplates.customFieldPathTemplate.match(customFieldName).network_code;
464
545
  }
465
546
  /**
466
547
  * Parse the custom_field from CustomField resource.
@@ -470,8 +551,7 @@ class UserServiceClient {
470
551
  * @returns {string} A string representing the custom_field.
471
552
  */
472
553
  matchCustomFieldFromCustomFieldName(customFieldName) {
473
- return this.pathTemplates.customFieldPathTemplate.match(customFieldName)
474
- .custom_field;
554
+ return this.pathTemplates.customFieldPathTemplate.match(customFieldName).custom_field;
475
555
  }
476
556
  /**
477
557
  * Return a fully-qualified customTargetingKey resource name string.
@@ -510,14 +590,12 @@ class UserServiceClient {
510
590
  * Return a fully-qualified customTargetingValue resource name string.
511
591
  *
512
592
  * @param {string} network_code
513
- * @param {string} custom_targeting_key
514
593
  * @param {string} custom_targeting_value
515
594
  * @returns {string} Resource name string.
516
595
  */
517
- customTargetingValuePath(networkCode, customTargetingKey, customTargetingValue) {
596
+ customTargetingValuePath(networkCode, customTargetingValue) {
518
597
  return this.pathTemplates.customTargetingValuePathTemplate.render({
519
598
  network_code: networkCode,
520
- custom_targeting_key: customTargetingKey,
521
599
  custom_targeting_value: customTargetingValue,
522
600
  });
523
601
  }
@@ -531,16 +609,6 @@ class UserServiceClient {
531
609
  matchNetworkCodeFromCustomTargetingValueName(customTargetingValueName) {
532
610
  return this.pathTemplates.customTargetingValuePathTemplate.match(customTargetingValueName).network_code;
533
611
  }
534
- /**
535
- * Parse the custom_targeting_key from CustomTargetingValue resource.
536
- *
537
- * @param {string} customTargetingValueName
538
- * A fully-qualified path representing CustomTargetingValue resource.
539
- * @returns {string} A string representing the custom_targeting_key.
540
- */
541
- matchCustomTargetingKeyFromCustomTargetingValueName(customTargetingValueName) {
542
- return this.pathTemplates.customTargetingValuePathTemplate.match(customTargetingValueName).custom_targeting_key;
543
- }
544
612
  /**
545
613
  * Parse the custom_targeting_value from CustomTargetingValue resource.
546
614
  *
@@ -551,6 +619,39 @@ class UserServiceClient {
551
619
  matchCustomTargetingValueFromCustomTargetingValueName(customTargetingValueName) {
552
620
  return this.pathTemplates.customTargetingValuePathTemplate.match(customTargetingValueName).custom_targeting_value;
553
621
  }
622
+ /**
623
+ * Return a fully-qualified deviceCategory resource name string.
624
+ *
625
+ * @param {string} network_code
626
+ * @param {string} device_category
627
+ * @returns {string} Resource name string.
628
+ */
629
+ deviceCategoryPath(networkCode, deviceCategory) {
630
+ return this.pathTemplates.deviceCategoryPathTemplate.render({
631
+ network_code: networkCode,
632
+ device_category: deviceCategory,
633
+ });
634
+ }
635
+ /**
636
+ * Parse the network_code from DeviceCategory resource.
637
+ *
638
+ * @param {string} deviceCategoryName
639
+ * A fully-qualified path representing DeviceCategory resource.
640
+ * @returns {string} A string representing the network_code.
641
+ */
642
+ matchNetworkCodeFromDeviceCategoryName(deviceCategoryName) {
643
+ return this.pathTemplates.deviceCategoryPathTemplate.match(deviceCategoryName).network_code;
644
+ }
645
+ /**
646
+ * Parse the device_category from DeviceCategory resource.
647
+ *
648
+ * @param {string} deviceCategoryName
649
+ * A fully-qualified path representing DeviceCategory resource.
650
+ * @returns {string} A string representing the device_category.
651
+ */
652
+ matchDeviceCategoryFromDeviceCategoryName(deviceCategoryName) {
653
+ return this.pathTemplates.deviceCategoryPathTemplate.match(deviceCategoryName).device_category;
654
+ }
554
655
  /**
555
656
  * Return a fully-qualified entitySignalsMapping resource name string.
556
657
  *
@@ -584,6 +685,39 @@ class UserServiceClient {
584
685
  matchEntitySignalsMappingFromEntitySignalsMappingName(entitySignalsMappingName) {
585
686
  return this.pathTemplates.entitySignalsMappingPathTemplate.match(entitySignalsMappingName).entity_signals_mapping;
586
687
  }
688
+ /**
689
+ * Return a fully-qualified geoTarget resource name string.
690
+ *
691
+ * @param {string} network_code
692
+ * @param {string} geo_target
693
+ * @returns {string} Resource name string.
694
+ */
695
+ geoTargetPath(networkCode, geoTarget) {
696
+ return this.pathTemplates.geoTargetPathTemplate.render({
697
+ network_code: networkCode,
698
+ geo_target: geoTarget,
699
+ });
700
+ }
701
+ /**
702
+ * Parse the network_code from GeoTarget resource.
703
+ *
704
+ * @param {string} geoTargetName
705
+ * A fully-qualified path representing GeoTarget resource.
706
+ * @returns {string} A string representing the network_code.
707
+ */
708
+ matchNetworkCodeFromGeoTargetName(geoTargetName) {
709
+ return this.pathTemplates.geoTargetPathTemplate.match(geoTargetName).network_code;
710
+ }
711
+ /**
712
+ * Parse the geo_target from GeoTarget resource.
713
+ *
714
+ * @param {string} geoTargetName
715
+ * A fully-qualified path representing GeoTarget resource.
716
+ * @returns {string} A string representing the geo_target.
717
+ */
718
+ matchGeoTargetFromGeoTargetName(geoTargetName) {
719
+ return this.pathTemplates.geoTargetPathTemplate.match(geoTargetName).geo_target;
720
+ }
587
721
  /**
588
722
  * Return a fully-qualified label resource name string.
589
723
  *
@@ -617,6 +751,39 @@ class UserServiceClient {
617
751
  matchLabelFromLabelName(labelName) {
618
752
  return this.pathTemplates.labelPathTemplate.match(labelName).label;
619
753
  }
754
+ /**
755
+ * Return a fully-qualified liveStreamEvent resource name string.
756
+ *
757
+ * @param {string} network_code
758
+ * @param {string} live_stream_event
759
+ * @returns {string} Resource name string.
760
+ */
761
+ liveStreamEventPath(networkCode, liveStreamEvent) {
762
+ return this.pathTemplates.liveStreamEventPathTemplate.render({
763
+ network_code: networkCode,
764
+ live_stream_event: liveStreamEvent,
765
+ });
766
+ }
767
+ /**
768
+ * Parse the network_code from LiveStreamEvent resource.
769
+ *
770
+ * @param {string} liveStreamEventName
771
+ * A fully-qualified path representing LiveStreamEvent resource.
772
+ * @returns {string} A string representing the network_code.
773
+ */
774
+ matchNetworkCodeFromLiveStreamEventName(liveStreamEventName) {
775
+ return this.pathTemplates.liveStreamEventPathTemplate.match(liveStreamEventName).network_code;
776
+ }
777
+ /**
778
+ * Parse the live_stream_event from LiveStreamEvent resource.
779
+ *
780
+ * @param {string} liveStreamEventName
781
+ * A fully-qualified path representing LiveStreamEvent resource.
782
+ * @returns {string} A string representing the live_stream_event.
783
+ */
784
+ matchLiveStreamEventFromLiveStreamEventName(liveStreamEventName) {
785
+ return this.pathTemplates.liveStreamEventPathTemplate.match(liveStreamEventName).live_stream_event;
786
+ }
620
787
  /**
621
788
  * Return a fully-qualified network resource name string.
622
789
  *
@@ -636,8 +803,73 @@ class UserServiceClient {
636
803
  * @returns {string} A string representing the network_code.
637
804
  */
638
805
  matchNetworkCodeFromNetworkName(networkName) {
639
- return this.pathTemplates.networkPathTemplate.match(networkName)
640
- .network_code;
806
+ return this.pathTemplates.networkPathTemplate.match(networkName).network_code;
807
+ }
808
+ /**
809
+ * Return a fully-qualified operatingSystem resource name string.
810
+ *
811
+ * @param {string} network_code
812
+ * @param {string} operating_system
813
+ * @returns {string} Resource name string.
814
+ */
815
+ operatingSystemPath(networkCode, operatingSystem) {
816
+ return this.pathTemplates.operatingSystemPathTemplate.render({
817
+ network_code: networkCode,
818
+ operating_system: operatingSystem,
819
+ });
820
+ }
821
+ /**
822
+ * Parse the network_code from OperatingSystem resource.
823
+ *
824
+ * @param {string} operatingSystemName
825
+ * A fully-qualified path representing OperatingSystem resource.
826
+ * @returns {string} A string representing the network_code.
827
+ */
828
+ matchNetworkCodeFromOperatingSystemName(operatingSystemName) {
829
+ return this.pathTemplates.operatingSystemPathTemplate.match(operatingSystemName).network_code;
830
+ }
831
+ /**
832
+ * Parse the operating_system from OperatingSystem resource.
833
+ *
834
+ * @param {string} operatingSystemName
835
+ * A fully-qualified path representing OperatingSystem resource.
836
+ * @returns {string} A string representing the operating_system.
837
+ */
838
+ matchOperatingSystemFromOperatingSystemName(operatingSystemName) {
839
+ return this.pathTemplates.operatingSystemPathTemplate.match(operatingSystemName).operating_system;
840
+ }
841
+ /**
842
+ * Return a fully-qualified operatingSystemVersion resource name string.
843
+ *
844
+ * @param {string} network_code
845
+ * @param {string} operating_system_version
846
+ * @returns {string} Resource name string.
847
+ */
848
+ operatingSystemVersionPath(networkCode, operatingSystemVersion) {
849
+ return this.pathTemplates.operatingSystemVersionPathTemplate.render({
850
+ network_code: networkCode,
851
+ operating_system_version: operatingSystemVersion,
852
+ });
853
+ }
854
+ /**
855
+ * Parse the network_code from OperatingSystemVersion resource.
856
+ *
857
+ * @param {string} operatingSystemVersionName
858
+ * A fully-qualified path representing OperatingSystemVersion resource.
859
+ * @returns {string} A string representing the network_code.
860
+ */
861
+ matchNetworkCodeFromOperatingSystemVersionName(operatingSystemVersionName) {
862
+ return this.pathTemplates.operatingSystemVersionPathTemplate.match(operatingSystemVersionName).network_code;
863
+ }
864
+ /**
865
+ * Parse the operating_system_version from OperatingSystemVersion resource.
866
+ *
867
+ * @param {string} operatingSystemVersionName
868
+ * A fully-qualified path representing OperatingSystemVersion resource.
869
+ * @returns {string} A string representing the operating_system_version.
870
+ */
871
+ matchOperatingSystemVersionFromOperatingSystemVersionName(operatingSystemVersionName) {
872
+ return this.pathTemplates.operatingSystemVersionPathTemplate.match(operatingSystemVersionName).operating_system_version;
641
873
  }
642
874
  /**
643
875
  * Return a fully-qualified order resource name string.
@@ -693,8 +925,7 @@ class UserServiceClient {
693
925
  * @returns {string} A string representing the network_code.
694
926
  */
695
927
  matchNetworkCodeFromPlacementName(placementName) {
696
- return this.pathTemplates.placementPathTemplate.match(placementName)
697
- .network_code;
928
+ return this.pathTemplates.placementPathTemplate.match(placementName).network_code;
698
929
  }
699
930
  /**
700
931
  * Parse the placement from Placement resource.
@@ -704,8 +935,106 @@ class UserServiceClient {
704
935
  * @returns {string} A string representing the placement.
705
936
  */
706
937
  matchPlacementFromPlacementName(placementName) {
707
- return this.pathTemplates.placementPathTemplate.match(placementName)
708
- .placement;
938
+ return this.pathTemplates.placementPathTemplate.match(placementName).placement;
939
+ }
940
+ /**
941
+ * Return a fully-qualified privateAuction resource name string.
942
+ *
943
+ * @param {string} network_code
944
+ * @param {string} private_auction
945
+ * @returns {string} Resource name string.
946
+ */
947
+ privateAuctionPath(networkCode, privateAuction) {
948
+ return this.pathTemplates.privateAuctionPathTemplate.render({
949
+ network_code: networkCode,
950
+ private_auction: privateAuction,
951
+ });
952
+ }
953
+ /**
954
+ * Parse the network_code from PrivateAuction resource.
955
+ *
956
+ * @param {string} privateAuctionName
957
+ * A fully-qualified path representing PrivateAuction resource.
958
+ * @returns {string} A string representing the network_code.
959
+ */
960
+ matchNetworkCodeFromPrivateAuctionName(privateAuctionName) {
961
+ return this.pathTemplates.privateAuctionPathTemplate.match(privateAuctionName).network_code;
962
+ }
963
+ /**
964
+ * Parse the private_auction from PrivateAuction resource.
965
+ *
966
+ * @param {string} privateAuctionName
967
+ * A fully-qualified path representing PrivateAuction resource.
968
+ * @returns {string} A string representing the private_auction.
969
+ */
970
+ matchPrivateAuctionFromPrivateAuctionName(privateAuctionName) {
971
+ return this.pathTemplates.privateAuctionPathTemplate.match(privateAuctionName).private_auction;
972
+ }
973
+ /**
974
+ * Return a fully-qualified privateAuctionDeal resource name string.
975
+ *
976
+ * @param {string} network_code
977
+ * @param {string} private_auction_deal
978
+ * @returns {string} Resource name string.
979
+ */
980
+ privateAuctionDealPath(networkCode, privateAuctionDeal) {
981
+ return this.pathTemplates.privateAuctionDealPathTemplate.render({
982
+ network_code: networkCode,
983
+ private_auction_deal: privateAuctionDeal,
984
+ });
985
+ }
986
+ /**
987
+ * Parse the network_code from PrivateAuctionDeal resource.
988
+ *
989
+ * @param {string} privateAuctionDealName
990
+ * A fully-qualified path representing PrivateAuctionDeal resource.
991
+ * @returns {string} A string representing the network_code.
992
+ */
993
+ matchNetworkCodeFromPrivateAuctionDealName(privateAuctionDealName) {
994
+ return this.pathTemplates.privateAuctionDealPathTemplate.match(privateAuctionDealName).network_code;
995
+ }
996
+ /**
997
+ * Parse the private_auction_deal from PrivateAuctionDeal resource.
998
+ *
999
+ * @param {string} privateAuctionDealName
1000
+ * A fully-qualified path representing PrivateAuctionDeal resource.
1001
+ * @returns {string} A string representing the private_auction_deal.
1002
+ */
1003
+ matchPrivateAuctionDealFromPrivateAuctionDealName(privateAuctionDealName) {
1004
+ return this.pathTemplates.privateAuctionDealPathTemplate.match(privateAuctionDealName).private_auction_deal;
1005
+ }
1006
+ /**
1007
+ * Return a fully-qualified programmaticBuyer resource name string.
1008
+ *
1009
+ * @param {string} network_code
1010
+ * @param {string} programmatic_buyer
1011
+ * @returns {string} Resource name string.
1012
+ */
1013
+ programmaticBuyerPath(networkCode, programmaticBuyer) {
1014
+ return this.pathTemplates.programmaticBuyerPathTemplate.render({
1015
+ network_code: networkCode,
1016
+ programmatic_buyer: programmaticBuyer,
1017
+ });
1018
+ }
1019
+ /**
1020
+ * Parse the network_code from ProgrammaticBuyer resource.
1021
+ *
1022
+ * @param {string} programmaticBuyerName
1023
+ * A fully-qualified path representing ProgrammaticBuyer resource.
1024
+ * @returns {string} A string representing the network_code.
1025
+ */
1026
+ matchNetworkCodeFromProgrammaticBuyerName(programmaticBuyerName) {
1027
+ return this.pathTemplates.programmaticBuyerPathTemplate.match(programmaticBuyerName).network_code;
1028
+ }
1029
+ /**
1030
+ * Parse the programmatic_buyer from ProgrammaticBuyer resource.
1031
+ *
1032
+ * @param {string} programmaticBuyerName
1033
+ * A fully-qualified path representing ProgrammaticBuyer resource.
1034
+ * @returns {string} A string representing the programmatic_buyer.
1035
+ */
1036
+ matchProgrammaticBuyerFromProgrammaticBuyerName(programmaticBuyerName) {
1037
+ return this.pathTemplates.programmaticBuyerPathTemplate.match(programmaticBuyerName).programmatic_buyer;
709
1038
  }
710
1039
  /**
711
1040
  * Return a fully-qualified report resource name string.