@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
@@ -0,0 +1,904 @@
1
+ import type * as gax from 'google-gax';
2
+ import type { Callback, CallOptions, Descriptors, ClientOptions, PaginationCallback } from 'google-gax';
3
+ import { Transform } from 'stream';
4
+ import * as protos from '../../protos/protos';
5
+ /**
6
+ * Provides methods for handling `BandwidthGroup` objects.
7
+ * @class
8
+ * @memberof v1
9
+ */
10
+ export declare class BandwidthGroupServiceClient {
11
+ private _terminated;
12
+ private _opts;
13
+ private _providedCustomServicePath;
14
+ private _gaxModule;
15
+ private _gaxGrpc;
16
+ private _protos;
17
+ private _defaults;
18
+ private _universeDomain;
19
+ private _servicePath;
20
+ private _log;
21
+ auth: gax.GoogleAuth;
22
+ descriptors: Descriptors;
23
+ warn: (code: string, message: string, warnType?: string) => void;
24
+ innerApiCalls: {
25
+ [name: string]: Function;
26
+ };
27
+ pathTemplates: {
28
+ [name: string]: gax.PathTemplate;
29
+ };
30
+ bandwidthGroupServiceStub?: Promise<{
31
+ [name: string]: Function;
32
+ }>;
33
+ /**
34
+ * Construct an instance of BandwidthGroupServiceClient.
35
+ *
36
+ * @param {object} [options] - The configuration object.
37
+ * The options accepted by the constructor are described in detail
38
+ * in [this document](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#creating-the-client-instance).
39
+ * The common options are:
40
+ * @param {object} [options.credentials] - Credentials object.
41
+ * @param {string} [options.credentials.client_email]
42
+ * @param {string} [options.credentials.private_key]
43
+ * @param {string} [options.email] - Account email address. Required when
44
+ * using a .pem or .p12 keyFilename.
45
+ * @param {string} [options.keyFilename] - Full path to the a .json, .pem, or
46
+ * .p12 key downloaded from the Google Developers Console. If you provide
47
+ * a path to a JSON file, the projectId option below is not necessary.
48
+ * NOTE: .pem and .p12 require you to specify options.email as well.
49
+ * @param {number} [options.port] - The port on which to connect to
50
+ * the remote host.
51
+ * @param {string} [options.projectId] - The project ID from the Google
52
+ * Developer's Console, e.g. 'grape-spaceship-123'. We will also check
53
+ * the environment variable GCLOUD_PROJECT for your project ID. If your
54
+ * app is running in an environment which supports
55
+ * {@link https://cloud.google.com/docs/authentication/application-default-credentials Application Default Credentials},
56
+ * your project ID will be detected automatically.
57
+ * @param {string} [options.apiEndpoint] - The domain name of the
58
+ * API remote host.
59
+ * @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
60
+ * Follows the structure of {@link gapicConfig}.
61
+ * @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
62
+ * For more information, please check the
63
+ * {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
64
+ * @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
65
+ * need to avoid loading the default gRPC version and want to use the fallback
66
+ * HTTP implementation. Load only fallback version and pass it to the constructor:
67
+ * ```
68
+ * const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
69
+ * const client = new BandwidthGroupServiceClient({fallback: true}, gax);
70
+ * ```
71
+ */
72
+ constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
73
+ /**
74
+ * Initialize the client.
75
+ * Performs asynchronous operations (such as authentication) and prepares the client.
76
+ * This function will be called automatically when any class method is called for the
77
+ * first time, but if you need to initialize it before calling an actual method,
78
+ * feel free to call initialize() directly.
79
+ *
80
+ * You can await on this method if you want to make sure the client is initialized.
81
+ *
82
+ * @returns {Promise} A promise that resolves to an authenticated service stub.
83
+ */
84
+ initialize(): Promise<{
85
+ [name: string]: Function;
86
+ }>;
87
+ /**
88
+ * The DNS address for this API service.
89
+ * @deprecated Use the apiEndpoint method of the client instance.
90
+ * @returns {string} The DNS address for this service.
91
+ */
92
+ static get servicePath(): string;
93
+ /**
94
+ * The DNS address for this API service - same as servicePath.
95
+ * @deprecated Use the apiEndpoint method of the client instance.
96
+ * @returns {string} The DNS address for this service.
97
+ */
98
+ static get apiEndpoint(): string;
99
+ /**
100
+ * The DNS address for this API service.
101
+ * @returns {string} The DNS address for this service.
102
+ */
103
+ get apiEndpoint(): string;
104
+ get universeDomain(): string;
105
+ /**
106
+ * The port for this API service.
107
+ * @returns {number} The default port for this service.
108
+ */
109
+ static get port(): number;
110
+ /**
111
+ * The scopes needed to make gRPC calls for every method defined
112
+ * in this service.
113
+ * @returns {string[]} List of default scopes.
114
+ */
115
+ static get scopes(): string[];
116
+ getProjectId(): Promise<string>;
117
+ getProjectId(callback: Callback<string, undefined, undefined>): void;
118
+ /**
119
+ * API to retrieve a `BandwidthGroup` object.
120
+ *
121
+ * @param {Object} request
122
+ * The request object that will be sent.
123
+ * @param {string} request.name
124
+ * Required. The resource name of the BandwidthGroup.
125
+ * Format: `networks/{network_code}/bandwidthGroups/{bandwidth_group_id}`
126
+ * @param {object} [options]
127
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
128
+ * @returns {Promise} - The promise which resolves to an array.
129
+ * The first element of the array is an object representing {@link protos.google.ads.admanager.v1.BandwidthGroup|BandwidthGroup}.
130
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
131
+ * for more details and examples.
132
+ * @example <caption>include:samples/generated/v1/bandwidth_group_service.get_bandwidth_group.js</caption>
133
+ * region_tag:admanager_v1_generated_BandwidthGroupService_GetBandwidthGroup_async
134
+ */
135
+ getBandwidthGroup(request?: protos.google.ads.admanager.v1.IGetBandwidthGroupRequest, options?: CallOptions): Promise<[
136
+ protos.google.ads.admanager.v1.IBandwidthGroup,
137
+ protos.google.ads.admanager.v1.IGetBandwidthGroupRequest | undefined,
138
+ {} | undefined
139
+ ]>;
140
+ getBandwidthGroup(request: protos.google.ads.admanager.v1.IGetBandwidthGroupRequest, options: CallOptions, callback: Callback<protos.google.ads.admanager.v1.IBandwidthGroup, protos.google.ads.admanager.v1.IGetBandwidthGroupRequest | null | undefined, {} | null | undefined>): void;
141
+ getBandwidthGroup(request: protos.google.ads.admanager.v1.IGetBandwidthGroupRequest, callback: Callback<protos.google.ads.admanager.v1.IBandwidthGroup, protos.google.ads.admanager.v1.IGetBandwidthGroupRequest | null | undefined, {} | null | undefined>): void;
142
+ /**
143
+ * API to retrieve a list of `BandwidthGroup` objects.
144
+ *
145
+ * @param {Object} request
146
+ * The request object that will be sent.
147
+ * @param {string} request.parent
148
+ * Required. The parent, which owns this collection of BandwidthGroups.
149
+ * Format: `networks/{network_code}`
150
+ * @param {number} [request.pageSize]
151
+ * Optional. The maximum number of `BandwidthGroups` to return. The service
152
+ * may return fewer than this value. If unspecified, at most 50
153
+ * `BandwidthGroups` will be returned. The maximum value is 1000; values above
154
+ * 1000 will be coerced to 1000.
155
+ * @param {string} [request.pageToken]
156
+ * Optional. A page token, received from a previous `ListBandwidthGroups`
157
+ * call. Provide this to retrieve the subsequent page.
158
+ *
159
+ * When paginating, all other parameters provided to `ListBandwidthGroups`
160
+ * must match the call that provided the page token.
161
+ * @param {string} [request.filter]
162
+ * Optional. Expression to filter the response.
163
+ * See syntax details at
164
+ * https://developers.google.com/ad-manager/api/beta/filters
165
+ * @param {string} [request.orderBy]
166
+ * Optional. Expression to specify sorting order.
167
+ * See syntax details at
168
+ * https://developers.google.com/ad-manager/api/beta/filters#order
169
+ * @param {number} [request.skip]
170
+ * Optional. Number of individual resources to skip while paginating.
171
+ * @param {object} [options]
172
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
173
+ * @returns {Promise} - The promise which resolves to an array.
174
+ * The first element of the array is Array of {@link protos.google.ads.admanager.v1.BandwidthGroup|BandwidthGroup}.
175
+ * The client library will perform auto-pagination by default: it will call the API as many
176
+ * times as needed and will merge results from all the pages into this array.
177
+ * Note that it can affect your quota.
178
+ * We recommend using `listBandwidthGroupsAsync()`
179
+ * method described below for async iteration which you can stop as needed.
180
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
181
+ * for more details and examples.
182
+ */
183
+ listBandwidthGroups(request?: protos.google.ads.admanager.v1.IListBandwidthGroupsRequest, options?: CallOptions): Promise<[
184
+ protos.google.ads.admanager.v1.IBandwidthGroup[],
185
+ protos.google.ads.admanager.v1.IListBandwidthGroupsRequest | null,
186
+ protos.google.ads.admanager.v1.IListBandwidthGroupsResponse
187
+ ]>;
188
+ listBandwidthGroups(request: protos.google.ads.admanager.v1.IListBandwidthGroupsRequest, options: CallOptions, callback: PaginationCallback<protos.google.ads.admanager.v1.IListBandwidthGroupsRequest, protos.google.ads.admanager.v1.IListBandwidthGroupsResponse | null | undefined, protos.google.ads.admanager.v1.IBandwidthGroup>): void;
189
+ listBandwidthGroups(request: protos.google.ads.admanager.v1.IListBandwidthGroupsRequest, callback: PaginationCallback<protos.google.ads.admanager.v1.IListBandwidthGroupsRequest, protos.google.ads.admanager.v1.IListBandwidthGroupsResponse | null | undefined, protos.google.ads.admanager.v1.IBandwidthGroup>): void;
190
+ /**
191
+ * Equivalent to `listBandwidthGroups`, but returns a NodeJS Stream object.
192
+ * @param {Object} request
193
+ * The request object that will be sent.
194
+ * @param {string} request.parent
195
+ * Required. The parent, which owns this collection of BandwidthGroups.
196
+ * Format: `networks/{network_code}`
197
+ * @param {number} [request.pageSize]
198
+ * Optional. The maximum number of `BandwidthGroups` to return. The service
199
+ * may return fewer than this value. If unspecified, at most 50
200
+ * `BandwidthGroups` will be returned. The maximum value is 1000; values above
201
+ * 1000 will be coerced to 1000.
202
+ * @param {string} [request.pageToken]
203
+ * Optional. A page token, received from a previous `ListBandwidthGroups`
204
+ * call. Provide this to retrieve the subsequent page.
205
+ *
206
+ * When paginating, all other parameters provided to `ListBandwidthGroups`
207
+ * must match the call that provided the page token.
208
+ * @param {string} [request.filter]
209
+ * Optional. Expression to filter the response.
210
+ * See syntax details at
211
+ * https://developers.google.com/ad-manager/api/beta/filters
212
+ * @param {string} [request.orderBy]
213
+ * Optional. Expression to specify sorting order.
214
+ * See syntax details at
215
+ * https://developers.google.com/ad-manager/api/beta/filters#order
216
+ * @param {number} [request.skip]
217
+ * Optional. Number of individual resources to skip while paginating.
218
+ * @param {object} [options]
219
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
220
+ * @returns {Stream}
221
+ * An object stream which emits an object representing {@link protos.google.ads.admanager.v1.BandwidthGroup|BandwidthGroup} on 'data' event.
222
+ * The client library will perform auto-pagination by default: it will call the API as many
223
+ * times as needed. Note that it can affect your quota.
224
+ * We recommend using `listBandwidthGroupsAsync()`
225
+ * method described below for async iteration which you can stop as needed.
226
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
227
+ * for more details and examples.
228
+ */
229
+ listBandwidthGroupsStream(request?: protos.google.ads.admanager.v1.IListBandwidthGroupsRequest, options?: CallOptions): Transform;
230
+ /**
231
+ * Equivalent to `listBandwidthGroups`, but returns an iterable object.
232
+ *
233
+ * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
234
+ * @param {Object} request
235
+ * The request object that will be sent.
236
+ * @param {string} request.parent
237
+ * Required. The parent, which owns this collection of BandwidthGroups.
238
+ * Format: `networks/{network_code}`
239
+ * @param {number} [request.pageSize]
240
+ * Optional. The maximum number of `BandwidthGroups` to return. The service
241
+ * may return fewer than this value. If unspecified, at most 50
242
+ * `BandwidthGroups` will be returned. The maximum value is 1000; values above
243
+ * 1000 will be coerced to 1000.
244
+ * @param {string} [request.pageToken]
245
+ * Optional. A page token, received from a previous `ListBandwidthGroups`
246
+ * call. Provide this to retrieve the subsequent page.
247
+ *
248
+ * When paginating, all other parameters provided to `ListBandwidthGroups`
249
+ * must match the call that provided the page token.
250
+ * @param {string} [request.filter]
251
+ * Optional. Expression to filter the response.
252
+ * See syntax details at
253
+ * https://developers.google.com/ad-manager/api/beta/filters
254
+ * @param {string} [request.orderBy]
255
+ * Optional. Expression to specify sorting order.
256
+ * See syntax details at
257
+ * https://developers.google.com/ad-manager/api/beta/filters#order
258
+ * @param {number} [request.skip]
259
+ * Optional. Number of individual resources to skip while paginating.
260
+ * @param {object} [options]
261
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
262
+ * @returns {Object}
263
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
264
+ * When you iterate the returned iterable, each element will be an object representing
265
+ * {@link protos.google.ads.admanager.v1.BandwidthGroup|BandwidthGroup}. The API will be called under the hood as needed, once per the page,
266
+ * so you can stop the iteration when you don't need more results.
267
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
268
+ * for more details and examples.
269
+ * @example <caption>include:samples/generated/v1/bandwidth_group_service.list_bandwidth_groups.js</caption>
270
+ * region_tag:admanager_v1_generated_BandwidthGroupService_ListBandwidthGroups_async
271
+ */
272
+ listBandwidthGroupsAsync(request?: protos.google.ads.admanager.v1.IListBandwidthGroupsRequest, options?: CallOptions): AsyncIterable<protos.google.ads.admanager.v1.IBandwidthGroup>;
273
+ /**
274
+ * Return a fully-qualified adBreak resource name string.
275
+ *
276
+ * @param {string} network_code
277
+ * @param {string} asset_key
278
+ * @param {string} ad_break
279
+ * @returns {string} Resource name string.
280
+ */
281
+ adBreakPath(networkCode: string, assetKey: string, adBreak: string): string;
282
+ /**
283
+ * Parse the network_code from AdBreak resource.
284
+ *
285
+ * @param {string} adBreakName
286
+ * A fully-qualified path representing AdBreak resource.
287
+ * @returns {string} A string representing the network_code.
288
+ */
289
+ matchNetworkCodeFromAdBreakName(adBreakName: string): string | number;
290
+ /**
291
+ * Parse the asset_key from AdBreak resource.
292
+ *
293
+ * @param {string} adBreakName
294
+ * A fully-qualified path representing AdBreak resource.
295
+ * @returns {string} A string representing the asset_key.
296
+ */
297
+ matchAssetKeyFromAdBreakName(adBreakName: string): string | number;
298
+ /**
299
+ * Parse the ad_break from AdBreak resource.
300
+ *
301
+ * @param {string} adBreakName
302
+ * A fully-qualified path representing AdBreak resource.
303
+ * @returns {string} A string representing the ad_break.
304
+ */
305
+ matchAdBreakFromAdBreakName(adBreakName: string): string | number;
306
+ /**
307
+ * Return a fully-qualified adUnit resource name string.
308
+ *
309
+ * @param {string} network_code
310
+ * @param {string} ad_unit
311
+ * @returns {string} Resource name string.
312
+ */
313
+ adUnitPath(networkCode: string, adUnit: string): string;
314
+ /**
315
+ * Parse the network_code from AdUnit resource.
316
+ *
317
+ * @param {string} adUnitName
318
+ * A fully-qualified path representing AdUnit resource.
319
+ * @returns {string} A string representing the network_code.
320
+ */
321
+ matchNetworkCodeFromAdUnitName(adUnitName: string): string | number;
322
+ /**
323
+ * Parse the ad_unit from AdUnit resource.
324
+ *
325
+ * @param {string} adUnitName
326
+ * A fully-qualified path representing AdUnit resource.
327
+ * @returns {string} A string representing the ad_unit.
328
+ */
329
+ matchAdUnitFromAdUnitName(adUnitName: string): string | number;
330
+ /**
331
+ * Return a fully-qualified bandwidthGroup resource name string.
332
+ *
333
+ * @param {string} network_code
334
+ * @param {string} bandwidth_group
335
+ * @returns {string} Resource name string.
336
+ */
337
+ bandwidthGroupPath(networkCode: string, bandwidthGroup: string): string;
338
+ /**
339
+ * Parse the network_code from BandwidthGroup resource.
340
+ *
341
+ * @param {string} bandwidthGroupName
342
+ * A fully-qualified path representing BandwidthGroup resource.
343
+ * @returns {string} A string representing the network_code.
344
+ */
345
+ matchNetworkCodeFromBandwidthGroupName(bandwidthGroupName: string): string | number;
346
+ /**
347
+ * Parse the bandwidth_group from BandwidthGroup resource.
348
+ *
349
+ * @param {string} bandwidthGroupName
350
+ * A fully-qualified path representing BandwidthGroup resource.
351
+ * @returns {string} A string representing the bandwidth_group.
352
+ */
353
+ matchBandwidthGroupFromBandwidthGroupName(bandwidthGroupName: string): string | number;
354
+ /**
355
+ * Return a fully-qualified company resource name string.
356
+ *
357
+ * @param {string} network_code
358
+ * @param {string} company
359
+ * @returns {string} Resource name string.
360
+ */
361
+ companyPath(networkCode: string, company: string): string;
362
+ /**
363
+ * Parse the network_code from Company resource.
364
+ *
365
+ * @param {string} companyName
366
+ * A fully-qualified path representing Company resource.
367
+ * @returns {string} A string representing the network_code.
368
+ */
369
+ matchNetworkCodeFromCompanyName(companyName: string): string | number;
370
+ /**
371
+ * Parse the company from Company resource.
372
+ *
373
+ * @param {string} companyName
374
+ * A fully-qualified path representing Company resource.
375
+ * @returns {string} A string representing the company.
376
+ */
377
+ matchCompanyFromCompanyName(companyName: string): string | number;
378
+ /**
379
+ * Return a fully-qualified contact resource name string.
380
+ *
381
+ * @param {string} network_code
382
+ * @param {string} contact
383
+ * @returns {string} Resource name string.
384
+ */
385
+ contactPath(networkCode: string, contact: string): string;
386
+ /**
387
+ * Parse the network_code from Contact resource.
388
+ *
389
+ * @param {string} contactName
390
+ * A fully-qualified path representing Contact resource.
391
+ * @returns {string} A string representing the network_code.
392
+ */
393
+ matchNetworkCodeFromContactName(contactName: string): string | number;
394
+ /**
395
+ * Parse the contact from Contact resource.
396
+ *
397
+ * @param {string} contactName
398
+ * A fully-qualified path representing Contact resource.
399
+ * @returns {string} A string representing the contact.
400
+ */
401
+ matchContactFromContactName(contactName: string): string | number;
402
+ /**
403
+ * Return a fully-qualified customField resource name string.
404
+ *
405
+ * @param {string} network_code
406
+ * @param {string} custom_field
407
+ * @returns {string} Resource name string.
408
+ */
409
+ customFieldPath(networkCode: string, customField: string): string;
410
+ /**
411
+ * Parse the network_code from CustomField resource.
412
+ *
413
+ * @param {string} customFieldName
414
+ * A fully-qualified path representing CustomField resource.
415
+ * @returns {string} A string representing the network_code.
416
+ */
417
+ matchNetworkCodeFromCustomFieldName(customFieldName: string): string | number;
418
+ /**
419
+ * Parse the custom_field from CustomField resource.
420
+ *
421
+ * @param {string} customFieldName
422
+ * A fully-qualified path representing CustomField resource.
423
+ * @returns {string} A string representing the custom_field.
424
+ */
425
+ matchCustomFieldFromCustomFieldName(customFieldName: string): string | number;
426
+ /**
427
+ * Return a fully-qualified customTargetingKey resource name string.
428
+ *
429
+ * @param {string} network_code
430
+ * @param {string} custom_targeting_key
431
+ * @returns {string} Resource name string.
432
+ */
433
+ customTargetingKeyPath(networkCode: string, customTargetingKey: string): string;
434
+ /**
435
+ * Parse the network_code from CustomTargetingKey resource.
436
+ *
437
+ * @param {string} customTargetingKeyName
438
+ * A fully-qualified path representing CustomTargetingKey resource.
439
+ * @returns {string} A string representing the network_code.
440
+ */
441
+ matchNetworkCodeFromCustomTargetingKeyName(customTargetingKeyName: string): string | number;
442
+ /**
443
+ * Parse the custom_targeting_key from CustomTargetingKey resource.
444
+ *
445
+ * @param {string} customTargetingKeyName
446
+ * A fully-qualified path representing CustomTargetingKey resource.
447
+ * @returns {string} A string representing the custom_targeting_key.
448
+ */
449
+ matchCustomTargetingKeyFromCustomTargetingKeyName(customTargetingKeyName: string): string | number;
450
+ /**
451
+ * Return a fully-qualified customTargetingValue resource name string.
452
+ *
453
+ * @param {string} network_code
454
+ * @param {string} custom_targeting_value
455
+ * @returns {string} Resource name string.
456
+ */
457
+ customTargetingValuePath(networkCode: string, customTargetingValue: string): string;
458
+ /**
459
+ * Parse the network_code from CustomTargetingValue resource.
460
+ *
461
+ * @param {string} customTargetingValueName
462
+ * A fully-qualified path representing CustomTargetingValue resource.
463
+ * @returns {string} A string representing the network_code.
464
+ */
465
+ matchNetworkCodeFromCustomTargetingValueName(customTargetingValueName: string): string | number;
466
+ /**
467
+ * Parse the custom_targeting_value from CustomTargetingValue resource.
468
+ *
469
+ * @param {string} customTargetingValueName
470
+ * A fully-qualified path representing CustomTargetingValue resource.
471
+ * @returns {string} A string representing the custom_targeting_value.
472
+ */
473
+ matchCustomTargetingValueFromCustomTargetingValueName(customTargetingValueName: string): string | number;
474
+ /**
475
+ * Return a fully-qualified deviceCategory resource name string.
476
+ *
477
+ * @param {string} network_code
478
+ * @param {string} device_category
479
+ * @returns {string} Resource name string.
480
+ */
481
+ deviceCategoryPath(networkCode: string, deviceCategory: string): string;
482
+ /**
483
+ * Parse the network_code from DeviceCategory resource.
484
+ *
485
+ * @param {string} deviceCategoryName
486
+ * A fully-qualified path representing DeviceCategory resource.
487
+ * @returns {string} A string representing the network_code.
488
+ */
489
+ matchNetworkCodeFromDeviceCategoryName(deviceCategoryName: string): string | number;
490
+ /**
491
+ * Parse the device_category from DeviceCategory resource.
492
+ *
493
+ * @param {string} deviceCategoryName
494
+ * A fully-qualified path representing DeviceCategory resource.
495
+ * @returns {string} A string representing the device_category.
496
+ */
497
+ matchDeviceCategoryFromDeviceCategoryName(deviceCategoryName: string): string | number;
498
+ /**
499
+ * Return a fully-qualified entitySignalsMapping resource name string.
500
+ *
501
+ * @param {string} network_code
502
+ * @param {string} entity_signals_mapping
503
+ * @returns {string} Resource name string.
504
+ */
505
+ entitySignalsMappingPath(networkCode: string, entitySignalsMapping: string): string;
506
+ /**
507
+ * Parse the network_code from EntitySignalsMapping resource.
508
+ *
509
+ * @param {string} entitySignalsMappingName
510
+ * A fully-qualified path representing EntitySignalsMapping resource.
511
+ * @returns {string} A string representing the network_code.
512
+ */
513
+ matchNetworkCodeFromEntitySignalsMappingName(entitySignalsMappingName: string): string | number;
514
+ /**
515
+ * Parse the entity_signals_mapping from EntitySignalsMapping resource.
516
+ *
517
+ * @param {string} entitySignalsMappingName
518
+ * A fully-qualified path representing EntitySignalsMapping resource.
519
+ * @returns {string} A string representing the entity_signals_mapping.
520
+ */
521
+ matchEntitySignalsMappingFromEntitySignalsMappingName(entitySignalsMappingName: string): string | number;
522
+ /**
523
+ * Return a fully-qualified geoTarget resource name string.
524
+ *
525
+ * @param {string} network_code
526
+ * @param {string} geo_target
527
+ * @returns {string} Resource name string.
528
+ */
529
+ geoTargetPath(networkCode: string, geoTarget: string): string;
530
+ /**
531
+ * Parse the network_code from GeoTarget resource.
532
+ *
533
+ * @param {string} geoTargetName
534
+ * A fully-qualified path representing GeoTarget resource.
535
+ * @returns {string} A string representing the network_code.
536
+ */
537
+ matchNetworkCodeFromGeoTargetName(geoTargetName: string): string | number;
538
+ /**
539
+ * Parse the geo_target from GeoTarget resource.
540
+ *
541
+ * @param {string} geoTargetName
542
+ * A fully-qualified path representing GeoTarget resource.
543
+ * @returns {string} A string representing the geo_target.
544
+ */
545
+ matchGeoTargetFromGeoTargetName(geoTargetName: string): string | number;
546
+ /**
547
+ * Return a fully-qualified label resource name string.
548
+ *
549
+ * @param {string} network_code
550
+ * @param {string} label
551
+ * @returns {string} Resource name string.
552
+ */
553
+ labelPath(networkCode: string, label: string): string;
554
+ /**
555
+ * Parse the network_code from Label resource.
556
+ *
557
+ * @param {string} labelName
558
+ * A fully-qualified path representing Label resource.
559
+ * @returns {string} A string representing the network_code.
560
+ */
561
+ matchNetworkCodeFromLabelName(labelName: string): string | number;
562
+ /**
563
+ * Parse the label from Label resource.
564
+ *
565
+ * @param {string} labelName
566
+ * A fully-qualified path representing Label resource.
567
+ * @returns {string} A string representing the label.
568
+ */
569
+ matchLabelFromLabelName(labelName: string): string | number;
570
+ /**
571
+ * Return a fully-qualified liveStreamEvent resource name string.
572
+ *
573
+ * @param {string} network_code
574
+ * @param {string} live_stream_event
575
+ * @returns {string} Resource name string.
576
+ */
577
+ liveStreamEventPath(networkCode: string, liveStreamEvent: string): string;
578
+ /**
579
+ * Parse the network_code from LiveStreamEvent resource.
580
+ *
581
+ * @param {string} liveStreamEventName
582
+ * A fully-qualified path representing LiveStreamEvent resource.
583
+ * @returns {string} A string representing the network_code.
584
+ */
585
+ matchNetworkCodeFromLiveStreamEventName(liveStreamEventName: string): string | number;
586
+ /**
587
+ * Parse the live_stream_event from LiveStreamEvent resource.
588
+ *
589
+ * @param {string} liveStreamEventName
590
+ * A fully-qualified path representing LiveStreamEvent resource.
591
+ * @returns {string} A string representing the live_stream_event.
592
+ */
593
+ matchLiveStreamEventFromLiveStreamEventName(liveStreamEventName: string): string | number;
594
+ /**
595
+ * Return a fully-qualified network resource name string.
596
+ *
597
+ * @param {string} network_code
598
+ * @returns {string} Resource name string.
599
+ */
600
+ networkPath(networkCode: string): string;
601
+ /**
602
+ * Parse the network_code from Network resource.
603
+ *
604
+ * @param {string} networkName
605
+ * A fully-qualified path representing Network resource.
606
+ * @returns {string} A string representing the network_code.
607
+ */
608
+ matchNetworkCodeFromNetworkName(networkName: string): string | number;
609
+ /**
610
+ * Return a fully-qualified operatingSystem resource name string.
611
+ *
612
+ * @param {string} network_code
613
+ * @param {string} operating_system
614
+ * @returns {string} Resource name string.
615
+ */
616
+ operatingSystemPath(networkCode: string, operatingSystem: string): string;
617
+ /**
618
+ * Parse the network_code from OperatingSystem resource.
619
+ *
620
+ * @param {string} operatingSystemName
621
+ * A fully-qualified path representing OperatingSystem resource.
622
+ * @returns {string} A string representing the network_code.
623
+ */
624
+ matchNetworkCodeFromOperatingSystemName(operatingSystemName: string): string | number;
625
+ /**
626
+ * Parse the operating_system from OperatingSystem resource.
627
+ *
628
+ * @param {string} operatingSystemName
629
+ * A fully-qualified path representing OperatingSystem resource.
630
+ * @returns {string} A string representing the operating_system.
631
+ */
632
+ matchOperatingSystemFromOperatingSystemName(operatingSystemName: string): string | number;
633
+ /**
634
+ * Return a fully-qualified operatingSystemVersion resource name string.
635
+ *
636
+ * @param {string} network_code
637
+ * @param {string} operating_system_version
638
+ * @returns {string} Resource name string.
639
+ */
640
+ operatingSystemVersionPath(networkCode: string, operatingSystemVersion: string): string;
641
+ /**
642
+ * Parse the network_code from OperatingSystemVersion resource.
643
+ *
644
+ * @param {string} operatingSystemVersionName
645
+ * A fully-qualified path representing OperatingSystemVersion resource.
646
+ * @returns {string} A string representing the network_code.
647
+ */
648
+ matchNetworkCodeFromOperatingSystemVersionName(operatingSystemVersionName: string): string | number;
649
+ /**
650
+ * Parse the operating_system_version from OperatingSystemVersion resource.
651
+ *
652
+ * @param {string} operatingSystemVersionName
653
+ * A fully-qualified path representing OperatingSystemVersion resource.
654
+ * @returns {string} A string representing the operating_system_version.
655
+ */
656
+ matchOperatingSystemVersionFromOperatingSystemVersionName(operatingSystemVersionName: string): string | number;
657
+ /**
658
+ * Return a fully-qualified order resource name string.
659
+ *
660
+ * @param {string} network_code
661
+ * @param {string} order
662
+ * @returns {string} Resource name string.
663
+ */
664
+ orderPath(networkCode: string, order: string): string;
665
+ /**
666
+ * Parse the network_code from Order resource.
667
+ *
668
+ * @param {string} orderName
669
+ * A fully-qualified path representing Order resource.
670
+ * @returns {string} A string representing the network_code.
671
+ */
672
+ matchNetworkCodeFromOrderName(orderName: string): string | number;
673
+ /**
674
+ * Parse the order from Order resource.
675
+ *
676
+ * @param {string} orderName
677
+ * A fully-qualified path representing Order resource.
678
+ * @returns {string} A string representing the order.
679
+ */
680
+ matchOrderFromOrderName(orderName: string): string | number;
681
+ /**
682
+ * Return a fully-qualified placement resource name string.
683
+ *
684
+ * @param {string} network_code
685
+ * @param {string} placement
686
+ * @returns {string} Resource name string.
687
+ */
688
+ placementPath(networkCode: string, placement: string): string;
689
+ /**
690
+ * Parse the network_code from Placement resource.
691
+ *
692
+ * @param {string} placementName
693
+ * A fully-qualified path representing Placement resource.
694
+ * @returns {string} A string representing the network_code.
695
+ */
696
+ matchNetworkCodeFromPlacementName(placementName: string): string | number;
697
+ /**
698
+ * Parse the placement from Placement resource.
699
+ *
700
+ * @param {string} placementName
701
+ * A fully-qualified path representing Placement resource.
702
+ * @returns {string} A string representing the placement.
703
+ */
704
+ matchPlacementFromPlacementName(placementName: string): string | number;
705
+ /**
706
+ * Return a fully-qualified privateAuction resource name string.
707
+ *
708
+ * @param {string} network_code
709
+ * @param {string} private_auction
710
+ * @returns {string} Resource name string.
711
+ */
712
+ privateAuctionPath(networkCode: string, privateAuction: string): string;
713
+ /**
714
+ * Parse the network_code from PrivateAuction resource.
715
+ *
716
+ * @param {string} privateAuctionName
717
+ * A fully-qualified path representing PrivateAuction resource.
718
+ * @returns {string} A string representing the network_code.
719
+ */
720
+ matchNetworkCodeFromPrivateAuctionName(privateAuctionName: string): string | number;
721
+ /**
722
+ * Parse the private_auction from PrivateAuction resource.
723
+ *
724
+ * @param {string} privateAuctionName
725
+ * A fully-qualified path representing PrivateAuction resource.
726
+ * @returns {string} A string representing the private_auction.
727
+ */
728
+ matchPrivateAuctionFromPrivateAuctionName(privateAuctionName: string): string | number;
729
+ /**
730
+ * Return a fully-qualified privateAuctionDeal resource name string.
731
+ *
732
+ * @param {string} network_code
733
+ * @param {string} private_auction_deal
734
+ * @returns {string} Resource name string.
735
+ */
736
+ privateAuctionDealPath(networkCode: string, privateAuctionDeal: string): string;
737
+ /**
738
+ * Parse the network_code from PrivateAuctionDeal resource.
739
+ *
740
+ * @param {string} privateAuctionDealName
741
+ * A fully-qualified path representing PrivateAuctionDeal resource.
742
+ * @returns {string} A string representing the network_code.
743
+ */
744
+ matchNetworkCodeFromPrivateAuctionDealName(privateAuctionDealName: string): string | number;
745
+ /**
746
+ * Parse the private_auction_deal from PrivateAuctionDeal resource.
747
+ *
748
+ * @param {string} privateAuctionDealName
749
+ * A fully-qualified path representing PrivateAuctionDeal resource.
750
+ * @returns {string} A string representing the private_auction_deal.
751
+ */
752
+ matchPrivateAuctionDealFromPrivateAuctionDealName(privateAuctionDealName: string): string | number;
753
+ /**
754
+ * Return a fully-qualified programmaticBuyer resource name string.
755
+ *
756
+ * @param {string} network_code
757
+ * @param {string} programmatic_buyer
758
+ * @returns {string} Resource name string.
759
+ */
760
+ programmaticBuyerPath(networkCode: string, programmaticBuyer: string): string;
761
+ /**
762
+ * Parse the network_code from ProgrammaticBuyer resource.
763
+ *
764
+ * @param {string} programmaticBuyerName
765
+ * A fully-qualified path representing ProgrammaticBuyer resource.
766
+ * @returns {string} A string representing the network_code.
767
+ */
768
+ matchNetworkCodeFromProgrammaticBuyerName(programmaticBuyerName: string): string | number;
769
+ /**
770
+ * Parse the programmatic_buyer from ProgrammaticBuyer resource.
771
+ *
772
+ * @param {string} programmaticBuyerName
773
+ * A fully-qualified path representing ProgrammaticBuyer resource.
774
+ * @returns {string} A string representing the programmatic_buyer.
775
+ */
776
+ matchProgrammaticBuyerFromProgrammaticBuyerName(programmaticBuyerName: string): string | number;
777
+ /**
778
+ * Return a fully-qualified report resource name string.
779
+ *
780
+ * @param {string} network_code
781
+ * @param {string} report
782
+ * @returns {string} Resource name string.
783
+ */
784
+ reportPath(networkCode: string, report: string): string;
785
+ /**
786
+ * Parse the network_code from Report resource.
787
+ *
788
+ * @param {string} reportName
789
+ * A fully-qualified path representing Report resource.
790
+ * @returns {string} A string representing the network_code.
791
+ */
792
+ matchNetworkCodeFromReportName(reportName: string): string | number;
793
+ /**
794
+ * Parse the report from Report resource.
795
+ *
796
+ * @param {string} reportName
797
+ * A fully-qualified path representing Report resource.
798
+ * @returns {string} A string representing the report.
799
+ */
800
+ matchReportFromReportName(reportName: string): string | number;
801
+ /**
802
+ * Return a fully-qualified role resource name string.
803
+ *
804
+ * @param {string} network_code
805
+ * @param {string} role
806
+ * @returns {string} Resource name string.
807
+ */
808
+ rolePath(networkCode: string, role: string): string;
809
+ /**
810
+ * Parse the network_code from Role resource.
811
+ *
812
+ * @param {string} roleName
813
+ * A fully-qualified path representing Role resource.
814
+ * @returns {string} A string representing the network_code.
815
+ */
816
+ matchNetworkCodeFromRoleName(roleName: string): string | number;
817
+ /**
818
+ * Parse the role from Role resource.
819
+ *
820
+ * @param {string} roleName
821
+ * A fully-qualified path representing Role resource.
822
+ * @returns {string} A string representing the role.
823
+ */
824
+ matchRoleFromRoleName(roleName: string): string | number;
825
+ /**
826
+ * Return a fully-qualified taxonomyCategory resource name string.
827
+ *
828
+ * @param {string} network_code
829
+ * @param {string} taxonomy_category
830
+ * @returns {string} Resource name string.
831
+ */
832
+ taxonomyCategoryPath(networkCode: string, taxonomyCategory: string): string;
833
+ /**
834
+ * Parse the network_code from TaxonomyCategory resource.
835
+ *
836
+ * @param {string} taxonomyCategoryName
837
+ * A fully-qualified path representing TaxonomyCategory resource.
838
+ * @returns {string} A string representing the network_code.
839
+ */
840
+ matchNetworkCodeFromTaxonomyCategoryName(taxonomyCategoryName: string): string | number;
841
+ /**
842
+ * Parse the taxonomy_category from TaxonomyCategory resource.
843
+ *
844
+ * @param {string} taxonomyCategoryName
845
+ * A fully-qualified path representing TaxonomyCategory resource.
846
+ * @returns {string} A string representing the taxonomy_category.
847
+ */
848
+ matchTaxonomyCategoryFromTaxonomyCategoryName(taxonomyCategoryName: string): string | number;
849
+ /**
850
+ * Return a fully-qualified team resource name string.
851
+ *
852
+ * @param {string} network_code
853
+ * @param {string} team
854
+ * @returns {string} Resource name string.
855
+ */
856
+ teamPath(networkCode: string, team: string): string;
857
+ /**
858
+ * Parse the network_code from Team resource.
859
+ *
860
+ * @param {string} teamName
861
+ * A fully-qualified path representing Team resource.
862
+ * @returns {string} A string representing the network_code.
863
+ */
864
+ matchNetworkCodeFromTeamName(teamName: string): string | number;
865
+ /**
866
+ * Parse the team from Team resource.
867
+ *
868
+ * @param {string} teamName
869
+ * A fully-qualified path representing Team resource.
870
+ * @returns {string} A string representing the team.
871
+ */
872
+ matchTeamFromTeamName(teamName: string): string | number;
873
+ /**
874
+ * Return a fully-qualified user resource name string.
875
+ *
876
+ * @param {string} network_code
877
+ * @param {string} user
878
+ * @returns {string} Resource name string.
879
+ */
880
+ userPath(networkCode: string, user: string): string;
881
+ /**
882
+ * Parse the network_code from User resource.
883
+ *
884
+ * @param {string} userName
885
+ * A fully-qualified path representing User resource.
886
+ * @returns {string} A string representing the network_code.
887
+ */
888
+ matchNetworkCodeFromUserName(userName: string): string | number;
889
+ /**
890
+ * Parse the user from User resource.
891
+ *
892
+ * @param {string} userName
893
+ * A fully-qualified path representing User resource.
894
+ * @returns {string} A string representing the user.
895
+ */
896
+ matchUserFromUserName(userName: string): string | number;
897
+ /**
898
+ * Terminate the gRPC channel and close the client.
899
+ *
900
+ * The client will no longer be usable and all future behavior is undefined.
901
+ * @returns {Promise} A promise that resolves when the client is closed.
902
+ */
903
+ close(): Promise<void>;
904
+ }