@google-ads/admanager 0.3.0 → 0.4.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +86 -150
- package/build/protos/google/ads/admanager/v1/ad_break_messages.proto +134 -0
- package/build/protos/google/ads/admanager/v1/ad_break_service.proto +269 -0
- package/build/protos/google/ads/admanager/v1/ad_unit_enums.proto +1 -1
- package/build/protos/google/ads/admanager/v1/ad_unit_messages.proto +32 -26
- package/build/protos/google/ads/admanager/v1/ad_unit_service.proto +3 -1
- package/build/protos/google/ads/admanager/v1/admanager_error.proto +1 -1
- package/build/protos/google/ads/admanager/v1/applied_label.proto +1 -1
- package/build/protos/google/ads/admanager/v1/bandwidth_group_messages.proto +46 -0
- package/build/protos/google/ads/admanager/v1/bandwidth_group_service.proto +129 -0
- package/build/protos/google/ads/admanager/v1/company_enums.proto +123 -0
- package/build/protos/google/ads/admanager/v1/company_messages.proto +6 -7
- package/build/protos/google/ads/admanager/v1/company_service.proto +3 -1
- package/build/protos/google/ads/admanager/v1/contact_messages.proto +4 -4
- package/build/protos/google/ads/admanager/v1/custom_field_enums.proto +1 -1
- package/build/protos/google/ads/admanager/v1/custom_field_messages.proto +12 -11
- package/build/protos/google/ads/admanager/v1/custom_field_service.proto +3 -1
- package/build/protos/google/ads/admanager/v1/custom_field_value.proto +1 -2
- package/build/protos/google/ads/admanager/v1/custom_targeting_key_enums.proto +1 -1
- package/build/protos/google/ads/admanager/v1/custom_targeting_key_messages.proto +1 -1
- package/build/protos/google/ads/admanager/v1/custom_targeting_key_service.proto +3 -1
- package/build/protos/google/ads/admanager/v1/custom_targeting_value_enums.proto +1 -1
- package/build/protos/google/ads/admanager/v1/custom_targeting_value_messages.proto +14 -3
- package/build/protos/google/ads/admanager/v1/custom_targeting_value_service.proto +14 -6
- package/build/protos/google/ads/admanager/v1/deal_buyer_permission_type_enum.proto +41 -0
- package/build/protos/google/ads/admanager/v1/device_category_messages.proto +45 -0
- package/build/protos/google/ads/admanager/v1/device_category_service.proto +129 -0
- package/build/protos/google/ads/admanager/v1/early_ad_break_notification_enums.proto +47 -0
- package/build/protos/google/ads/admanager/v1/entity_signals_mapping_messages.proto +4 -4
- package/build/protos/google/ads/admanager/v1/entity_signals_mapping_service.proto +6 -4
- package/build/protos/google/ads/admanager/v1/environment_type_enum.proto +1 -1
- package/build/protos/google/ads/admanager/v1/frequency_cap.proto +1 -1
- package/build/protos/google/ads/admanager/v1/geo_target_messages.proto +70 -0
- package/build/protos/google/ads/admanager/v1/geo_target_service.proto +128 -0
- package/build/protos/google/ads/admanager/v1/label_messages.proto +1 -1
- package/build/protos/google/ads/admanager/v1/live_stream_event_messages.proto +47 -0
- package/build/protos/google/ads/admanager/v1/network_messages.proto +2 -2
- package/build/protos/google/ads/admanager/v1/network_service.proto +4 -2
- package/build/protos/google/ads/admanager/v1/operating_system_messages.proto +45 -0
- package/build/protos/google/ads/admanager/v1/operating_system_service.proto +129 -0
- package/build/protos/google/ads/admanager/v1/operating_system_version_messages.proto +52 -0
- package/build/protos/google/ads/admanager/v1/operating_system_version_service.proto +133 -0
- package/build/protos/google/ads/admanager/v1/order_enums.proto +1 -1
- package/build/protos/google/ads/admanager/v1/order_messages.proto +24 -20
- package/build/protos/google/ads/admanager/v1/order_service.proto +3 -1
- package/build/protos/google/ads/admanager/v1/placement_enums.proto +1 -1
- package/build/protos/google/ads/admanager/v1/placement_messages.proto +14 -14
- package/build/protos/google/ads/admanager/v1/placement_service.proto +3 -1
- package/build/protos/google/ads/admanager/v1/private_auction_deal_messages.proto +119 -0
- package/build/protos/google/ads/admanager/v1/private_auction_deal_service.proto +184 -0
- package/build/protos/google/ads/admanager/v1/private_auction_messages.proto +74 -0
- package/build/protos/google/ads/admanager/v1/private_auction_service.proto +180 -0
- package/build/protos/google/ads/admanager/v1/private_marketplace_enums.proto +50 -0
- package/build/protos/google/ads/admanager/v1/programmatic_buyer_messages.proto +72 -0
- package/build/protos/google/ads/admanager/v1/programmatic_buyer_service.proto +131 -0
- package/build/protos/google/ads/admanager/v1/report_messages.proto +3536 -0
- package/build/protos/google/ads/admanager/v1/report_service.proto +5 -3247
- package/build/protos/google/ads/admanager/v1/request_platform_enum.proto +49 -0
- package/build/protos/google/ads/admanager/v1/role_enums.proto +1 -1
- package/build/protos/google/ads/admanager/v1/role_messages.proto +6 -6
- package/build/protos/google/ads/admanager/v1/role_service.proto +3 -1
- package/build/protos/google/ads/admanager/v1/size.proto +7 -11
- package/build/protos/google/ads/admanager/v1/size_type_enum.proto +1 -1
- package/build/protos/google/ads/admanager/v1/targeted_video_bumper_type_enum.proto +44 -0
- package/build/protos/google/ads/admanager/v1/targeting.proto +328 -0
- package/build/protos/google/ads/admanager/v1/taxonomy_category_messages.proto +7 -6
- package/build/protos/google/ads/admanager/v1/taxonomy_category_service.proto +3 -1
- package/build/protos/google/ads/admanager/v1/taxonomy_type_enum.proto +1 -1
- package/build/protos/google/ads/admanager/v1/team_messages.proto +1 -5
- package/build/protos/google/ads/admanager/v1/time_unit_enum.proto +1 -1
- package/build/protos/google/ads/admanager/v1/user_messages.proto +10 -9
- package/build/protos/google/ads/admanager/v1/user_service.proto +3 -1
- package/build/protos/google/ads/admanager/v1/video_position_enum.proto +47 -0
- package/build/protos/protos.d.ts +15832 -7575
- package/build/protos/protos.js +57744 -36372
- package/build/protos/protos.json +5795 -2511
- package/build/src/index.d.ts +28 -1
- package/build/src/index.js +20 -17
- package/build/src/index.js.map +1 -1
- package/build/src/v1/ad_break_service_client.d.ts +1040 -0
- package/build/src/v1/ad_break_service_client.js +1483 -0
- package/build/src/v1/ad_break_service_client.js.map +1 -0
- package/build/src/v1/ad_break_service_client_config.json +46 -0
- package/build/src/v1/ad_break_service_proto_list.json +74 -0
- package/build/src/v1/ad_unit_service_client.d.ts +331 -91
- package/build/src/v1/ad_unit_service_client.js +414 -106
- package/build/src/v1/ad_unit_service_client.js.map +1 -1
- package/build/src/v1/ad_unit_service_proto_list.json +29 -3
- package/build/src/v1/bandwidth_group_service_client.d.ts +904 -0
- package/build/src/v1/bandwidth_group_service_client.js +1369 -0
- package/build/src/v1/bandwidth_group_service_client.js.map +1 -0
- package/build/src/v1/bandwidth_group_service_client_config.json +34 -0
- package/build/src/v1/bandwidth_group_service_proto_list.json +74 -0
- package/build/src/v1/company_service_client.d.ts +291 -51
- package/build/src/v1/company_service_client.js +402 -81
- package/build/src/v1/company_service_client.js.map +1 -1
- package/build/src/v1/company_service_proto_list.json +29 -3
- package/build/src/v1/custom_field_service_client.d.ts +291 -51
- package/build/src/v1/custom_field_service_client.js +403 -85
- package/build/src/v1/custom_field_service_client.js.map +1 -1
- package/build/src/v1/custom_field_service_proto_list.json +29 -3
- package/build/src/v1/custom_targeting_key_service_client.d.ts +291 -51
- package/build/src/v1/custom_targeting_key_service_client.js +404 -88
- package/build/src/v1/custom_targeting_key_service_client.js.map +1 -1
- package/build/src/v1/custom_targeting_key_service_proto_list.json +29 -3
- package/build/src/v1/custom_targeting_value_service_client.d.ts +298 -58
- package/build/src/v1/custom_targeting_value_service_client.js +406 -90
- package/build/src/v1/custom_targeting_value_service_client.js.map +1 -1
- package/build/src/v1/custom_targeting_value_service_proto_list.json +29 -3
- package/build/src/v1/device_category_service_client.d.ts +904 -0
- package/build/src/v1/device_category_service_client.js +1369 -0
- package/build/src/v1/device_category_service_client.js.map +1 -0
- package/build/src/v1/device_category_service_client_config.json +34 -0
- package/build/src/v1/device_category_service_proto_list.json +74 -0
- package/build/src/v1/entity_signals_mapping_service_client.d.ts +298 -58
- package/build/src/v1/entity_signals_mapping_service_client.js +444 -124
- package/build/src/v1/entity_signals_mapping_service_client.js.map +1 -1
- package/build/src/v1/entity_signals_mapping_service_proto_list.json +29 -3
- package/build/src/v1/gapic_metadata.json +412 -0
- package/build/src/v1/geo_target_service_client.d.ts +904 -0
- package/build/src/v1/geo_target_service_client.js +1369 -0
- package/build/src/v1/geo_target_service_client.js.map +1 -0
- package/build/src/v1/geo_target_service_client_config.json +34 -0
- package/build/src/v1/geo_target_service_proto_list.json +74 -0
- package/build/src/v1/index.d.ts +9 -0
- package/build/src/v1/index.js +19 -1
- package/build/src/v1/index.js.map +1 -1
- package/build/src/v1/network_service_client.d.ts +252 -12
- package/build/src/v1/network_service_client.js +397 -65
- package/build/src/v1/network_service_client.js.map +1 -1
- package/build/src/v1/network_service_proto_list.json +29 -3
- package/build/src/v1/operating_system_service_client.d.ts +904 -0
- package/build/src/v1/operating_system_service_client.js +1369 -0
- package/build/src/v1/operating_system_service_client.js.map +1 -0
- package/build/src/v1/operating_system_service_client_config.json +34 -0
- package/build/src/v1/operating_system_service_proto_list.json +74 -0
- package/build/src/v1/operating_system_version_service_client.d.ts +911 -0
- package/build/src/v1/operating_system_version_service_client.js +1373 -0
- package/build/src/v1/operating_system_version_service_client.js.map +1 -0
- package/build/src/v1/operating_system_version_service_client_config.json +34 -0
- package/build/src/v1/operating_system_version_service_proto_list.json +74 -0
- package/build/src/v1/order_service_client.d.ts +296 -56
- package/build/src/v1/order_service_client.js +402 -81
- package/build/src/v1/order_service_client.js.map +1 -1
- package/build/src/v1/order_service_proto_list.json +29 -3
- package/build/src/v1/placement_service_client.d.ts +291 -51
- package/build/src/v1/placement_service_client.js +402 -81
- package/build/src/v1/placement_service_client.js.map +1 -1
- package/build/src/v1/placement_service_proto_list.json +29 -3
- package/build/src/v1/private_auction_deal_service_client.d.ts +965 -0
- package/build/src/v1/private_auction_deal_service_client.js +1445 -0
- package/build/src/v1/private_auction_deal_service_client.js.map +1 -0
- package/build/src/v1/private_auction_deal_service_client_config.json +42 -0
- package/build/src/v1/private_auction_deal_service_proto_list.json +74 -0
- package/build/src/v1/private_auction_service_client.d.ts +962 -0
- package/build/src/v1/private_auction_service_client.js +1443 -0
- package/build/src/v1/private_auction_service_client.js.map +1 -0
- package/build/src/v1/private_auction_service_client_config.json +42 -0
- package/build/src/v1/private_auction_service_proto_list.json +74 -0
- package/build/src/v1/programmatic_buyer_service_client.d.ts +905 -0
- package/build/src/v1/programmatic_buyer_service_client.js +1369 -0
- package/build/src/v1/programmatic_buyer_service_client.js.map +1 -0
- package/build/src/v1/programmatic_buyer_service_client_config.json +34 -0
- package/build/src/v1/programmatic_buyer_service_proto_list.json +74 -0
- package/build/src/v1/report_service_client.d.ts +350 -110
- package/build/src/v1/report_service_client.js +471 -177
- package/build/src/v1/report_service_client.js.map +1 -1
- package/build/src/v1/report_service_proto_list.json +29 -3
- package/build/src/v1/role_service_client.d.ts +290 -50
- package/build/src/v1/role_service_client.js +402 -81
- package/build/src/v1/role_service_client.js.map +1 -1
- package/build/src/v1/role_service_proto_list.json +29 -3
- package/build/src/v1/taxonomy_category_service_client.d.ts +291 -51
- package/build/src/v1/taxonomy_category_service_client.js +404 -87
- package/build/src/v1/taxonomy_category_service_client.js.map +1 -1
- package/build/src/v1/taxonomy_category_service_proto_list.json +29 -3
- package/build/src/v1/user_service_client.d.ts +251 -11
- package/build/src/v1/user_service_client.js +388 -59
- package/build/src/v1/user_service_client.js.map +1 -1
- package/build/src/v1/user_service_proto_list.json +29 -3
- package/package.json +4 -4
- package/CHANGELOG.md +0 -40
|
@@ -0,0 +1,911 @@
|
|
|
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 `OperatingSystemVersion` objects.
|
|
7
|
+
* @class
|
|
8
|
+
* @memberof v1
|
|
9
|
+
*/
|
|
10
|
+
export declare class OperatingSystemVersionServiceClient {
|
|
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
|
+
operatingSystemVersionServiceStub?: Promise<{
|
|
31
|
+
[name: string]: Function;
|
|
32
|
+
}>;
|
|
33
|
+
/**
|
|
34
|
+
* Construct an instance of OperatingSystemVersionServiceClient.
|
|
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 OperatingSystemVersionServiceClient({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 `OperatingSystemVersion` 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 OperatingSystemVersion.
|
|
125
|
+
* Format:
|
|
126
|
+
* `networks/{network_code}/operatingSystemVersions/{operating_system_version_id}`
|
|
127
|
+
* @param {object} [options]
|
|
128
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
129
|
+
* @returns {Promise} - The promise which resolves to an array.
|
|
130
|
+
* The first element of the array is an object representing {@link protos.google.ads.admanager.v1.OperatingSystemVersion|OperatingSystemVersion}.
|
|
131
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
|
132
|
+
* for more details and examples.
|
|
133
|
+
* @example <caption>include:samples/generated/v1/operating_system_version_service.get_operating_system_version.js</caption>
|
|
134
|
+
* region_tag:admanager_v1_generated_OperatingSystemVersionService_GetOperatingSystemVersion_async
|
|
135
|
+
*/
|
|
136
|
+
getOperatingSystemVersion(request?: protos.google.ads.admanager.v1.IGetOperatingSystemVersionRequest, options?: CallOptions): Promise<[
|
|
137
|
+
protos.google.ads.admanager.v1.IOperatingSystemVersion,
|
|
138
|
+
protos.google.ads.admanager.v1.IGetOperatingSystemVersionRequest | undefined,
|
|
139
|
+
{} | undefined
|
|
140
|
+
]>;
|
|
141
|
+
getOperatingSystemVersion(request: protos.google.ads.admanager.v1.IGetOperatingSystemVersionRequest, options: CallOptions, callback: Callback<protos.google.ads.admanager.v1.IOperatingSystemVersion, protos.google.ads.admanager.v1.IGetOperatingSystemVersionRequest | null | undefined, {} | null | undefined>): void;
|
|
142
|
+
getOperatingSystemVersion(request: protos.google.ads.admanager.v1.IGetOperatingSystemVersionRequest, callback: Callback<protos.google.ads.admanager.v1.IOperatingSystemVersion, protos.google.ads.admanager.v1.IGetOperatingSystemVersionRequest | null | undefined, {} | null | undefined>): void;
|
|
143
|
+
/**
|
|
144
|
+
* API to retrieve a list of `OperatingSystemVersion` objects.
|
|
145
|
+
*
|
|
146
|
+
* @param {Object} request
|
|
147
|
+
* The request object that will be sent.
|
|
148
|
+
* @param {string} request.parent
|
|
149
|
+
* Required. The parent, which owns this collection of
|
|
150
|
+
* OperatingSystemVersions. Format: `networks/{network_code}`
|
|
151
|
+
* @param {number} [request.pageSize]
|
|
152
|
+
* Optional. The maximum number of `OperatingSystemVersions` to return. The
|
|
153
|
+
* service may return fewer than this value. If unspecified, at most 50
|
|
154
|
+
* `OperatingSystemVersions` will be returned. The maximum value is 1000;
|
|
155
|
+
* values above 1000 will be coerced to 1000.
|
|
156
|
+
* @param {string} [request.pageToken]
|
|
157
|
+
* Optional. A page token, received from a previous
|
|
158
|
+
* `ListOperatingSystemVersions` call. Provide this to retrieve the subsequent
|
|
159
|
+
* page.
|
|
160
|
+
*
|
|
161
|
+
* When paginating, all other parameters provided to
|
|
162
|
+
* `ListOperatingSystemVersions` must match the call that provided the page
|
|
163
|
+
* token.
|
|
164
|
+
* @param {string} [request.filter]
|
|
165
|
+
* Optional. Expression to filter the response.
|
|
166
|
+
* See syntax details at
|
|
167
|
+
* https://developers.google.com/ad-manager/api/beta/filters
|
|
168
|
+
* @param {string} [request.orderBy]
|
|
169
|
+
* Optional. Expression to specify sorting order.
|
|
170
|
+
* See syntax details at
|
|
171
|
+
* https://developers.google.com/ad-manager/api/beta/filters#order
|
|
172
|
+
* @param {number} [request.skip]
|
|
173
|
+
* Optional. Number of individual resources to skip while paginating.
|
|
174
|
+
* @param {object} [options]
|
|
175
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
176
|
+
* @returns {Promise} - The promise which resolves to an array.
|
|
177
|
+
* The first element of the array is Array of {@link protos.google.ads.admanager.v1.OperatingSystemVersion|OperatingSystemVersion}.
|
|
178
|
+
* The client library will perform auto-pagination by default: it will call the API as many
|
|
179
|
+
* times as needed and will merge results from all the pages into this array.
|
|
180
|
+
* Note that it can affect your quota.
|
|
181
|
+
* We recommend using `listOperatingSystemVersionsAsync()`
|
|
182
|
+
* method described below for async iteration which you can stop as needed.
|
|
183
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
|
184
|
+
* for more details and examples.
|
|
185
|
+
*/
|
|
186
|
+
listOperatingSystemVersions(request?: protos.google.ads.admanager.v1.IListOperatingSystemVersionsRequest, options?: CallOptions): Promise<[
|
|
187
|
+
protos.google.ads.admanager.v1.IOperatingSystemVersion[],
|
|
188
|
+
protos.google.ads.admanager.v1.IListOperatingSystemVersionsRequest | null,
|
|
189
|
+
protos.google.ads.admanager.v1.IListOperatingSystemVersionsResponse
|
|
190
|
+
]>;
|
|
191
|
+
listOperatingSystemVersions(request: protos.google.ads.admanager.v1.IListOperatingSystemVersionsRequest, options: CallOptions, callback: PaginationCallback<protos.google.ads.admanager.v1.IListOperatingSystemVersionsRequest, protos.google.ads.admanager.v1.IListOperatingSystemVersionsResponse | null | undefined, protos.google.ads.admanager.v1.IOperatingSystemVersion>): void;
|
|
192
|
+
listOperatingSystemVersions(request: protos.google.ads.admanager.v1.IListOperatingSystemVersionsRequest, callback: PaginationCallback<protos.google.ads.admanager.v1.IListOperatingSystemVersionsRequest, protos.google.ads.admanager.v1.IListOperatingSystemVersionsResponse | null | undefined, protos.google.ads.admanager.v1.IOperatingSystemVersion>): void;
|
|
193
|
+
/**
|
|
194
|
+
* Equivalent to `listOperatingSystemVersions`, but returns a NodeJS Stream object.
|
|
195
|
+
* @param {Object} request
|
|
196
|
+
* The request object that will be sent.
|
|
197
|
+
* @param {string} request.parent
|
|
198
|
+
* Required. The parent, which owns this collection of
|
|
199
|
+
* OperatingSystemVersions. Format: `networks/{network_code}`
|
|
200
|
+
* @param {number} [request.pageSize]
|
|
201
|
+
* Optional. The maximum number of `OperatingSystemVersions` to return. The
|
|
202
|
+
* service may return fewer than this value. If unspecified, at most 50
|
|
203
|
+
* `OperatingSystemVersions` will be returned. The maximum value is 1000;
|
|
204
|
+
* values above 1000 will be coerced to 1000.
|
|
205
|
+
* @param {string} [request.pageToken]
|
|
206
|
+
* Optional. A page token, received from a previous
|
|
207
|
+
* `ListOperatingSystemVersions` call. Provide this to retrieve the subsequent
|
|
208
|
+
* page.
|
|
209
|
+
*
|
|
210
|
+
* When paginating, all other parameters provided to
|
|
211
|
+
* `ListOperatingSystemVersions` must match the call that provided the page
|
|
212
|
+
* token.
|
|
213
|
+
* @param {string} [request.filter]
|
|
214
|
+
* Optional. Expression to filter the response.
|
|
215
|
+
* See syntax details at
|
|
216
|
+
* https://developers.google.com/ad-manager/api/beta/filters
|
|
217
|
+
* @param {string} [request.orderBy]
|
|
218
|
+
* Optional. Expression to specify sorting order.
|
|
219
|
+
* See syntax details at
|
|
220
|
+
* https://developers.google.com/ad-manager/api/beta/filters#order
|
|
221
|
+
* @param {number} [request.skip]
|
|
222
|
+
* Optional. Number of individual resources to skip while paginating.
|
|
223
|
+
* @param {object} [options]
|
|
224
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
225
|
+
* @returns {Stream}
|
|
226
|
+
* An object stream which emits an object representing {@link protos.google.ads.admanager.v1.OperatingSystemVersion|OperatingSystemVersion} on 'data' event.
|
|
227
|
+
* The client library will perform auto-pagination by default: it will call the API as many
|
|
228
|
+
* times as needed. Note that it can affect your quota.
|
|
229
|
+
* We recommend using `listOperatingSystemVersionsAsync()`
|
|
230
|
+
* method described below for async iteration which you can stop as needed.
|
|
231
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
|
232
|
+
* for more details and examples.
|
|
233
|
+
*/
|
|
234
|
+
listOperatingSystemVersionsStream(request?: protos.google.ads.admanager.v1.IListOperatingSystemVersionsRequest, options?: CallOptions): Transform;
|
|
235
|
+
/**
|
|
236
|
+
* Equivalent to `listOperatingSystemVersions`, but returns an iterable object.
|
|
237
|
+
*
|
|
238
|
+
* `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
|
|
239
|
+
* @param {Object} request
|
|
240
|
+
* The request object that will be sent.
|
|
241
|
+
* @param {string} request.parent
|
|
242
|
+
* Required. The parent, which owns this collection of
|
|
243
|
+
* OperatingSystemVersions. Format: `networks/{network_code}`
|
|
244
|
+
* @param {number} [request.pageSize]
|
|
245
|
+
* Optional. The maximum number of `OperatingSystemVersions` to return. The
|
|
246
|
+
* service may return fewer than this value. If unspecified, at most 50
|
|
247
|
+
* `OperatingSystemVersions` will be returned. The maximum value is 1000;
|
|
248
|
+
* values above 1000 will be coerced to 1000.
|
|
249
|
+
* @param {string} [request.pageToken]
|
|
250
|
+
* Optional. A page token, received from a previous
|
|
251
|
+
* `ListOperatingSystemVersions` call. Provide this to retrieve the subsequent
|
|
252
|
+
* page.
|
|
253
|
+
*
|
|
254
|
+
* When paginating, all other parameters provided to
|
|
255
|
+
* `ListOperatingSystemVersions` must match the call that provided the page
|
|
256
|
+
* token.
|
|
257
|
+
* @param {string} [request.filter]
|
|
258
|
+
* Optional. Expression to filter the response.
|
|
259
|
+
* See syntax details at
|
|
260
|
+
* https://developers.google.com/ad-manager/api/beta/filters
|
|
261
|
+
* @param {string} [request.orderBy]
|
|
262
|
+
* Optional. Expression to specify sorting order.
|
|
263
|
+
* See syntax details at
|
|
264
|
+
* https://developers.google.com/ad-manager/api/beta/filters#order
|
|
265
|
+
* @param {number} [request.skip]
|
|
266
|
+
* Optional. Number of individual resources to skip while paginating.
|
|
267
|
+
* @param {object} [options]
|
|
268
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
269
|
+
* @returns {Object}
|
|
270
|
+
* An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
|
|
271
|
+
* When you iterate the returned iterable, each element will be an object representing
|
|
272
|
+
* {@link protos.google.ads.admanager.v1.OperatingSystemVersion|OperatingSystemVersion}. The API will be called under the hood as needed, once per the page,
|
|
273
|
+
* so you can stop the iteration when you don't need more results.
|
|
274
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
|
275
|
+
* for more details and examples.
|
|
276
|
+
* @example <caption>include:samples/generated/v1/operating_system_version_service.list_operating_system_versions.js</caption>
|
|
277
|
+
* region_tag:admanager_v1_generated_OperatingSystemVersionService_ListOperatingSystemVersions_async
|
|
278
|
+
*/
|
|
279
|
+
listOperatingSystemVersionsAsync(request?: protos.google.ads.admanager.v1.IListOperatingSystemVersionsRequest, options?: CallOptions): AsyncIterable<protos.google.ads.admanager.v1.IOperatingSystemVersion>;
|
|
280
|
+
/**
|
|
281
|
+
* Return a fully-qualified adBreak resource name string.
|
|
282
|
+
*
|
|
283
|
+
* @param {string} network_code
|
|
284
|
+
* @param {string} asset_key
|
|
285
|
+
* @param {string} ad_break
|
|
286
|
+
* @returns {string} Resource name string.
|
|
287
|
+
*/
|
|
288
|
+
adBreakPath(networkCode: string, assetKey: string, adBreak: string): string;
|
|
289
|
+
/**
|
|
290
|
+
* Parse the network_code from AdBreak resource.
|
|
291
|
+
*
|
|
292
|
+
* @param {string} adBreakName
|
|
293
|
+
* A fully-qualified path representing AdBreak resource.
|
|
294
|
+
* @returns {string} A string representing the network_code.
|
|
295
|
+
*/
|
|
296
|
+
matchNetworkCodeFromAdBreakName(adBreakName: string): string | number;
|
|
297
|
+
/**
|
|
298
|
+
* Parse the asset_key from AdBreak resource.
|
|
299
|
+
*
|
|
300
|
+
* @param {string} adBreakName
|
|
301
|
+
* A fully-qualified path representing AdBreak resource.
|
|
302
|
+
* @returns {string} A string representing the asset_key.
|
|
303
|
+
*/
|
|
304
|
+
matchAssetKeyFromAdBreakName(adBreakName: string): string | number;
|
|
305
|
+
/**
|
|
306
|
+
* Parse the ad_break from AdBreak resource.
|
|
307
|
+
*
|
|
308
|
+
* @param {string} adBreakName
|
|
309
|
+
* A fully-qualified path representing AdBreak resource.
|
|
310
|
+
* @returns {string} A string representing the ad_break.
|
|
311
|
+
*/
|
|
312
|
+
matchAdBreakFromAdBreakName(adBreakName: string): string | number;
|
|
313
|
+
/**
|
|
314
|
+
* Return a fully-qualified adUnit resource name string.
|
|
315
|
+
*
|
|
316
|
+
* @param {string} network_code
|
|
317
|
+
* @param {string} ad_unit
|
|
318
|
+
* @returns {string} Resource name string.
|
|
319
|
+
*/
|
|
320
|
+
adUnitPath(networkCode: string, adUnit: string): string;
|
|
321
|
+
/**
|
|
322
|
+
* Parse the network_code from AdUnit resource.
|
|
323
|
+
*
|
|
324
|
+
* @param {string} adUnitName
|
|
325
|
+
* A fully-qualified path representing AdUnit resource.
|
|
326
|
+
* @returns {string} A string representing the network_code.
|
|
327
|
+
*/
|
|
328
|
+
matchNetworkCodeFromAdUnitName(adUnitName: string): string | number;
|
|
329
|
+
/**
|
|
330
|
+
* Parse the ad_unit from AdUnit resource.
|
|
331
|
+
*
|
|
332
|
+
* @param {string} adUnitName
|
|
333
|
+
* A fully-qualified path representing AdUnit resource.
|
|
334
|
+
* @returns {string} A string representing the ad_unit.
|
|
335
|
+
*/
|
|
336
|
+
matchAdUnitFromAdUnitName(adUnitName: string): string | number;
|
|
337
|
+
/**
|
|
338
|
+
* Return a fully-qualified bandwidthGroup resource name string.
|
|
339
|
+
*
|
|
340
|
+
* @param {string} network_code
|
|
341
|
+
* @param {string} bandwidth_group
|
|
342
|
+
* @returns {string} Resource name string.
|
|
343
|
+
*/
|
|
344
|
+
bandwidthGroupPath(networkCode: string, bandwidthGroup: string): string;
|
|
345
|
+
/**
|
|
346
|
+
* Parse the network_code from BandwidthGroup resource.
|
|
347
|
+
*
|
|
348
|
+
* @param {string} bandwidthGroupName
|
|
349
|
+
* A fully-qualified path representing BandwidthGroup resource.
|
|
350
|
+
* @returns {string} A string representing the network_code.
|
|
351
|
+
*/
|
|
352
|
+
matchNetworkCodeFromBandwidthGroupName(bandwidthGroupName: string): string | number;
|
|
353
|
+
/**
|
|
354
|
+
* Parse the bandwidth_group from BandwidthGroup resource.
|
|
355
|
+
*
|
|
356
|
+
* @param {string} bandwidthGroupName
|
|
357
|
+
* A fully-qualified path representing BandwidthGroup resource.
|
|
358
|
+
* @returns {string} A string representing the bandwidth_group.
|
|
359
|
+
*/
|
|
360
|
+
matchBandwidthGroupFromBandwidthGroupName(bandwidthGroupName: string): string | number;
|
|
361
|
+
/**
|
|
362
|
+
* Return a fully-qualified company resource name string.
|
|
363
|
+
*
|
|
364
|
+
* @param {string} network_code
|
|
365
|
+
* @param {string} company
|
|
366
|
+
* @returns {string} Resource name string.
|
|
367
|
+
*/
|
|
368
|
+
companyPath(networkCode: string, company: string): string;
|
|
369
|
+
/**
|
|
370
|
+
* Parse the network_code from Company resource.
|
|
371
|
+
*
|
|
372
|
+
* @param {string} companyName
|
|
373
|
+
* A fully-qualified path representing Company resource.
|
|
374
|
+
* @returns {string} A string representing the network_code.
|
|
375
|
+
*/
|
|
376
|
+
matchNetworkCodeFromCompanyName(companyName: string): string | number;
|
|
377
|
+
/**
|
|
378
|
+
* Parse the company from Company resource.
|
|
379
|
+
*
|
|
380
|
+
* @param {string} companyName
|
|
381
|
+
* A fully-qualified path representing Company resource.
|
|
382
|
+
* @returns {string} A string representing the company.
|
|
383
|
+
*/
|
|
384
|
+
matchCompanyFromCompanyName(companyName: string): string | number;
|
|
385
|
+
/**
|
|
386
|
+
* Return a fully-qualified contact resource name string.
|
|
387
|
+
*
|
|
388
|
+
* @param {string} network_code
|
|
389
|
+
* @param {string} contact
|
|
390
|
+
* @returns {string} Resource name string.
|
|
391
|
+
*/
|
|
392
|
+
contactPath(networkCode: string, contact: string): string;
|
|
393
|
+
/**
|
|
394
|
+
* Parse the network_code from Contact resource.
|
|
395
|
+
*
|
|
396
|
+
* @param {string} contactName
|
|
397
|
+
* A fully-qualified path representing Contact resource.
|
|
398
|
+
* @returns {string} A string representing the network_code.
|
|
399
|
+
*/
|
|
400
|
+
matchNetworkCodeFromContactName(contactName: string): string | number;
|
|
401
|
+
/**
|
|
402
|
+
* Parse the contact from Contact resource.
|
|
403
|
+
*
|
|
404
|
+
* @param {string} contactName
|
|
405
|
+
* A fully-qualified path representing Contact resource.
|
|
406
|
+
* @returns {string} A string representing the contact.
|
|
407
|
+
*/
|
|
408
|
+
matchContactFromContactName(contactName: string): string | number;
|
|
409
|
+
/**
|
|
410
|
+
* Return a fully-qualified customField resource name string.
|
|
411
|
+
*
|
|
412
|
+
* @param {string} network_code
|
|
413
|
+
* @param {string} custom_field
|
|
414
|
+
* @returns {string} Resource name string.
|
|
415
|
+
*/
|
|
416
|
+
customFieldPath(networkCode: string, customField: string): string;
|
|
417
|
+
/**
|
|
418
|
+
* Parse the network_code from CustomField resource.
|
|
419
|
+
*
|
|
420
|
+
* @param {string} customFieldName
|
|
421
|
+
* A fully-qualified path representing CustomField resource.
|
|
422
|
+
* @returns {string} A string representing the network_code.
|
|
423
|
+
*/
|
|
424
|
+
matchNetworkCodeFromCustomFieldName(customFieldName: string): string | number;
|
|
425
|
+
/**
|
|
426
|
+
* Parse the custom_field from CustomField resource.
|
|
427
|
+
*
|
|
428
|
+
* @param {string} customFieldName
|
|
429
|
+
* A fully-qualified path representing CustomField resource.
|
|
430
|
+
* @returns {string} A string representing the custom_field.
|
|
431
|
+
*/
|
|
432
|
+
matchCustomFieldFromCustomFieldName(customFieldName: string): string | number;
|
|
433
|
+
/**
|
|
434
|
+
* Return a fully-qualified customTargetingKey resource name string.
|
|
435
|
+
*
|
|
436
|
+
* @param {string} network_code
|
|
437
|
+
* @param {string} custom_targeting_key
|
|
438
|
+
* @returns {string} Resource name string.
|
|
439
|
+
*/
|
|
440
|
+
customTargetingKeyPath(networkCode: string, customTargetingKey: string): string;
|
|
441
|
+
/**
|
|
442
|
+
* Parse the network_code from CustomTargetingKey resource.
|
|
443
|
+
*
|
|
444
|
+
* @param {string} customTargetingKeyName
|
|
445
|
+
* A fully-qualified path representing CustomTargetingKey resource.
|
|
446
|
+
* @returns {string} A string representing the network_code.
|
|
447
|
+
*/
|
|
448
|
+
matchNetworkCodeFromCustomTargetingKeyName(customTargetingKeyName: string): string | number;
|
|
449
|
+
/**
|
|
450
|
+
* Parse the custom_targeting_key from CustomTargetingKey resource.
|
|
451
|
+
*
|
|
452
|
+
* @param {string} customTargetingKeyName
|
|
453
|
+
* A fully-qualified path representing CustomTargetingKey resource.
|
|
454
|
+
* @returns {string} A string representing the custom_targeting_key.
|
|
455
|
+
*/
|
|
456
|
+
matchCustomTargetingKeyFromCustomTargetingKeyName(customTargetingKeyName: string): string | number;
|
|
457
|
+
/**
|
|
458
|
+
* Return a fully-qualified customTargetingValue resource name string.
|
|
459
|
+
*
|
|
460
|
+
* @param {string} network_code
|
|
461
|
+
* @param {string} custom_targeting_value
|
|
462
|
+
* @returns {string} Resource name string.
|
|
463
|
+
*/
|
|
464
|
+
customTargetingValuePath(networkCode: string, customTargetingValue: string): string;
|
|
465
|
+
/**
|
|
466
|
+
* Parse the network_code from CustomTargetingValue resource.
|
|
467
|
+
*
|
|
468
|
+
* @param {string} customTargetingValueName
|
|
469
|
+
* A fully-qualified path representing CustomTargetingValue resource.
|
|
470
|
+
* @returns {string} A string representing the network_code.
|
|
471
|
+
*/
|
|
472
|
+
matchNetworkCodeFromCustomTargetingValueName(customTargetingValueName: string): string | number;
|
|
473
|
+
/**
|
|
474
|
+
* Parse the custom_targeting_value from CustomTargetingValue resource.
|
|
475
|
+
*
|
|
476
|
+
* @param {string} customTargetingValueName
|
|
477
|
+
* A fully-qualified path representing CustomTargetingValue resource.
|
|
478
|
+
* @returns {string} A string representing the custom_targeting_value.
|
|
479
|
+
*/
|
|
480
|
+
matchCustomTargetingValueFromCustomTargetingValueName(customTargetingValueName: string): string | number;
|
|
481
|
+
/**
|
|
482
|
+
* Return a fully-qualified deviceCategory resource name string.
|
|
483
|
+
*
|
|
484
|
+
* @param {string} network_code
|
|
485
|
+
* @param {string} device_category
|
|
486
|
+
* @returns {string} Resource name string.
|
|
487
|
+
*/
|
|
488
|
+
deviceCategoryPath(networkCode: string, deviceCategory: string): string;
|
|
489
|
+
/**
|
|
490
|
+
* Parse the network_code from DeviceCategory resource.
|
|
491
|
+
*
|
|
492
|
+
* @param {string} deviceCategoryName
|
|
493
|
+
* A fully-qualified path representing DeviceCategory resource.
|
|
494
|
+
* @returns {string} A string representing the network_code.
|
|
495
|
+
*/
|
|
496
|
+
matchNetworkCodeFromDeviceCategoryName(deviceCategoryName: string): string | number;
|
|
497
|
+
/**
|
|
498
|
+
* Parse the device_category from DeviceCategory resource.
|
|
499
|
+
*
|
|
500
|
+
* @param {string} deviceCategoryName
|
|
501
|
+
* A fully-qualified path representing DeviceCategory resource.
|
|
502
|
+
* @returns {string} A string representing the device_category.
|
|
503
|
+
*/
|
|
504
|
+
matchDeviceCategoryFromDeviceCategoryName(deviceCategoryName: string): string | number;
|
|
505
|
+
/**
|
|
506
|
+
* Return a fully-qualified entitySignalsMapping resource name string.
|
|
507
|
+
*
|
|
508
|
+
* @param {string} network_code
|
|
509
|
+
* @param {string} entity_signals_mapping
|
|
510
|
+
* @returns {string} Resource name string.
|
|
511
|
+
*/
|
|
512
|
+
entitySignalsMappingPath(networkCode: string, entitySignalsMapping: string): string;
|
|
513
|
+
/**
|
|
514
|
+
* Parse the network_code from EntitySignalsMapping resource.
|
|
515
|
+
*
|
|
516
|
+
* @param {string} entitySignalsMappingName
|
|
517
|
+
* A fully-qualified path representing EntitySignalsMapping resource.
|
|
518
|
+
* @returns {string} A string representing the network_code.
|
|
519
|
+
*/
|
|
520
|
+
matchNetworkCodeFromEntitySignalsMappingName(entitySignalsMappingName: string): string | number;
|
|
521
|
+
/**
|
|
522
|
+
* Parse the entity_signals_mapping from EntitySignalsMapping resource.
|
|
523
|
+
*
|
|
524
|
+
* @param {string} entitySignalsMappingName
|
|
525
|
+
* A fully-qualified path representing EntitySignalsMapping resource.
|
|
526
|
+
* @returns {string} A string representing the entity_signals_mapping.
|
|
527
|
+
*/
|
|
528
|
+
matchEntitySignalsMappingFromEntitySignalsMappingName(entitySignalsMappingName: string): string | number;
|
|
529
|
+
/**
|
|
530
|
+
* Return a fully-qualified geoTarget resource name string.
|
|
531
|
+
*
|
|
532
|
+
* @param {string} network_code
|
|
533
|
+
* @param {string} geo_target
|
|
534
|
+
* @returns {string} Resource name string.
|
|
535
|
+
*/
|
|
536
|
+
geoTargetPath(networkCode: string, geoTarget: string): string;
|
|
537
|
+
/**
|
|
538
|
+
* Parse the network_code from GeoTarget resource.
|
|
539
|
+
*
|
|
540
|
+
* @param {string} geoTargetName
|
|
541
|
+
* A fully-qualified path representing GeoTarget resource.
|
|
542
|
+
* @returns {string} A string representing the network_code.
|
|
543
|
+
*/
|
|
544
|
+
matchNetworkCodeFromGeoTargetName(geoTargetName: string): string | number;
|
|
545
|
+
/**
|
|
546
|
+
* Parse the geo_target from GeoTarget resource.
|
|
547
|
+
*
|
|
548
|
+
* @param {string} geoTargetName
|
|
549
|
+
* A fully-qualified path representing GeoTarget resource.
|
|
550
|
+
* @returns {string} A string representing the geo_target.
|
|
551
|
+
*/
|
|
552
|
+
matchGeoTargetFromGeoTargetName(geoTargetName: string): string | number;
|
|
553
|
+
/**
|
|
554
|
+
* Return a fully-qualified label resource name string.
|
|
555
|
+
*
|
|
556
|
+
* @param {string} network_code
|
|
557
|
+
* @param {string} label
|
|
558
|
+
* @returns {string} Resource name string.
|
|
559
|
+
*/
|
|
560
|
+
labelPath(networkCode: string, label: string): string;
|
|
561
|
+
/**
|
|
562
|
+
* Parse the network_code from Label resource.
|
|
563
|
+
*
|
|
564
|
+
* @param {string} labelName
|
|
565
|
+
* A fully-qualified path representing Label resource.
|
|
566
|
+
* @returns {string} A string representing the network_code.
|
|
567
|
+
*/
|
|
568
|
+
matchNetworkCodeFromLabelName(labelName: string): string | number;
|
|
569
|
+
/**
|
|
570
|
+
* Parse the label from Label resource.
|
|
571
|
+
*
|
|
572
|
+
* @param {string} labelName
|
|
573
|
+
* A fully-qualified path representing Label resource.
|
|
574
|
+
* @returns {string} A string representing the label.
|
|
575
|
+
*/
|
|
576
|
+
matchLabelFromLabelName(labelName: string): string | number;
|
|
577
|
+
/**
|
|
578
|
+
* Return a fully-qualified liveStreamEvent resource name string.
|
|
579
|
+
*
|
|
580
|
+
* @param {string} network_code
|
|
581
|
+
* @param {string} live_stream_event
|
|
582
|
+
* @returns {string} Resource name string.
|
|
583
|
+
*/
|
|
584
|
+
liveStreamEventPath(networkCode: string, liveStreamEvent: string): string;
|
|
585
|
+
/**
|
|
586
|
+
* Parse the network_code from LiveStreamEvent resource.
|
|
587
|
+
*
|
|
588
|
+
* @param {string} liveStreamEventName
|
|
589
|
+
* A fully-qualified path representing LiveStreamEvent resource.
|
|
590
|
+
* @returns {string} A string representing the network_code.
|
|
591
|
+
*/
|
|
592
|
+
matchNetworkCodeFromLiveStreamEventName(liveStreamEventName: string): string | number;
|
|
593
|
+
/**
|
|
594
|
+
* Parse the live_stream_event from LiveStreamEvent resource.
|
|
595
|
+
*
|
|
596
|
+
* @param {string} liveStreamEventName
|
|
597
|
+
* A fully-qualified path representing LiveStreamEvent resource.
|
|
598
|
+
* @returns {string} A string representing the live_stream_event.
|
|
599
|
+
*/
|
|
600
|
+
matchLiveStreamEventFromLiveStreamEventName(liveStreamEventName: string): string | number;
|
|
601
|
+
/**
|
|
602
|
+
* Return a fully-qualified network resource name string.
|
|
603
|
+
*
|
|
604
|
+
* @param {string} network_code
|
|
605
|
+
* @returns {string} Resource name string.
|
|
606
|
+
*/
|
|
607
|
+
networkPath(networkCode: string): string;
|
|
608
|
+
/**
|
|
609
|
+
* Parse the network_code from Network resource.
|
|
610
|
+
*
|
|
611
|
+
* @param {string} networkName
|
|
612
|
+
* A fully-qualified path representing Network resource.
|
|
613
|
+
* @returns {string} A string representing the network_code.
|
|
614
|
+
*/
|
|
615
|
+
matchNetworkCodeFromNetworkName(networkName: string): string | number;
|
|
616
|
+
/**
|
|
617
|
+
* Return a fully-qualified operatingSystem resource name string.
|
|
618
|
+
*
|
|
619
|
+
* @param {string} network_code
|
|
620
|
+
* @param {string} operating_system
|
|
621
|
+
* @returns {string} Resource name string.
|
|
622
|
+
*/
|
|
623
|
+
operatingSystemPath(networkCode: string, operatingSystem: string): string;
|
|
624
|
+
/**
|
|
625
|
+
* Parse the network_code from OperatingSystem resource.
|
|
626
|
+
*
|
|
627
|
+
* @param {string} operatingSystemName
|
|
628
|
+
* A fully-qualified path representing OperatingSystem resource.
|
|
629
|
+
* @returns {string} A string representing the network_code.
|
|
630
|
+
*/
|
|
631
|
+
matchNetworkCodeFromOperatingSystemName(operatingSystemName: string): string | number;
|
|
632
|
+
/**
|
|
633
|
+
* Parse the operating_system from OperatingSystem resource.
|
|
634
|
+
*
|
|
635
|
+
* @param {string} operatingSystemName
|
|
636
|
+
* A fully-qualified path representing OperatingSystem resource.
|
|
637
|
+
* @returns {string} A string representing the operating_system.
|
|
638
|
+
*/
|
|
639
|
+
matchOperatingSystemFromOperatingSystemName(operatingSystemName: string): string | number;
|
|
640
|
+
/**
|
|
641
|
+
* Return a fully-qualified operatingSystemVersion resource name string.
|
|
642
|
+
*
|
|
643
|
+
* @param {string} network_code
|
|
644
|
+
* @param {string} operating_system_version
|
|
645
|
+
* @returns {string} Resource name string.
|
|
646
|
+
*/
|
|
647
|
+
operatingSystemVersionPath(networkCode: string, operatingSystemVersion: string): string;
|
|
648
|
+
/**
|
|
649
|
+
* Parse the network_code from OperatingSystemVersion resource.
|
|
650
|
+
*
|
|
651
|
+
* @param {string} operatingSystemVersionName
|
|
652
|
+
* A fully-qualified path representing OperatingSystemVersion resource.
|
|
653
|
+
* @returns {string} A string representing the network_code.
|
|
654
|
+
*/
|
|
655
|
+
matchNetworkCodeFromOperatingSystemVersionName(operatingSystemVersionName: string): string | number;
|
|
656
|
+
/**
|
|
657
|
+
* Parse the operating_system_version from OperatingSystemVersion resource.
|
|
658
|
+
*
|
|
659
|
+
* @param {string} operatingSystemVersionName
|
|
660
|
+
* A fully-qualified path representing OperatingSystemVersion resource.
|
|
661
|
+
* @returns {string} A string representing the operating_system_version.
|
|
662
|
+
*/
|
|
663
|
+
matchOperatingSystemVersionFromOperatingSystemVersionName(operatingSystemVersionName: string): string | number;
|
|
664
|
+
/**
|
|
665
|
+
* Return a fully-qualified order resource name string.
|
|
666
|
+
*
|
|
667
|
+
* @param {string} network_code
|
|
668
|
+
* @param {string} order
|
|
669
|
+
* @returns {string} Resource name string.
|
|
670
|
+
*/
|
|
671
|
+
orderPath(networkCode: string, order: string): string;
|
|
672
|
+
/**
|
|
673
|
+
* Parse the network_code from Order resource.
|
|
674
|
+
*
|
|
675
|
+
* @param {string} orderName
|
|
676
|
+
* A fully-qualified path representing Order resource.
|
|
677
|
+
* @returns {string} A string representing the network_code.
|
|
678
|
+
*/
|
|
679
|
+
matchNetworkCodeFromOrderName(orderName: string): string | number;
|
|
680
|
+
/**
|
|
681
|
+
* Parse the order from Order resource.
|
|
682
|
+
*
|
|
683
|
+
* @param {string} orderName
|
|
684
|
+
* A fully-qualified path representing Order resource.
|
|
685
|
+
* @returns {string} A string representing the order.
|
|
686
|
+
*/
|
|
687
|
+
matchOrderFromOrderName(orderName: string): string | number;
|
|
688
|
+
/**
|
|
689
|
+
* Return a fully-qualified placement resource name string.
|
|
690
|
+
*
|
|
691
|
+
* @param {string} network_code
|
|
692
|
+
* @param {string} placement
|
|
693
|
+
* @returns {string} Resource name string.
|
|
694
|
+
*/
|
|
695
|
+
placementPath(networkCode: string, placement: string): string;
|
|
696
|
+
/**
|
|
697
|
+
* Parse the network_code from Placement resource.
|
|
698
|
+
*
|
|
699
|
+
* @param {string} placementName
|
|
700
|
+
* A fully-qualified path representing Placement resource.
|
|
701
|
+
* @returns {string} A string representing the network_code.
|
|
702
|
+
*/
|
|
703
|
+
matchNetworkCodeFromPlacementName(placementName: string): string | number;
|
|
704
|
+
/**
|
|
705
|
+
* Parse the placement from Placement resource.
|
|
706
|
+
*
|
|
707
|
+
* @param {string} placementName
|
|
708
|
+
* A fully-qualified path representing Placement resource.
|
|
709
|
+
* @returns {string} A string representing the placement.
|
|
710
|
+
*/
|
|
711
|
+
matchPlacementFromPlacementName(placementName: string): string | number;
|
|
712
|
+
/**
|
|
713
|
+
* Return a fully-qualified privateAuction resource name string.
|
|
714
|
+
*
|
|
715
|
+
* @param {string} network_code
|
|
716
|
+
* @param {string} private_auction
|
|
717
|
+
* @returns {string} Resource name string.
|
|
718
|
+
*/
|
|
719
|
+
privateAuctionPath(networkCode: string, privateAuction: string): string;
|
|
720
|
+
/**
|
|
721
|
+
* Parse the network_code from PrivateAuction resource.
|
|
722
|
+
*
|
|
723
|
+
* @param {string} privateAuctionName
|
|
724
|
+
* A fully-qualified path representing PrivateAuction resource.
|
|
725
|
+
* @returns {string} A string representing the network_code.
|
|
726
|
+
*/
|
|
727
|
+
matchNetworkCodeFromPrivateAuctionName(privateAuctionName: string): string | number;
|
|
728
|
+
/**
|
|
729
|
+
* Parse the private_auction from PrivateAuction resource.
|
|
730
|
+
*
|
|
731
|
+
* @param {string} privateAuctionName
|
|
732
|
+
* A fully-qualified path representing PrivateAuction resource.
|
|
733
|
+
* @returns {string} A string representing the private_auction.
|
|
734
|
+
*/
|
|
735
|
+
matchPrivateAuctionFromPrivateAuctionName(privateAuctionName: string): string | number;
|
|
736
|
+
/**
|
|
737
|
+
* Return a fully-qualified privateAuctionDeal resource name string.
|
|
738
|
+
*
|
|
739
|
+
* @param {string} network_code
|
|
740
|
+
* @param {string} private_auction_deal
|
|
741
|
+
* @returns {string} Resource name string.
|
|
742
|
+
*/
|
|
743
|
+
privateAuctionDealPath(networkCode: string, privateAuctionDeal: string): string;
|
|
744
|
+
/**
|
|
745
|
+
* Parse the network_code from PrivateAuctionDeal resource.
|
|
746
|
+
*
|
|
747
|
+
* @param {string} privateAuctionDealName
|
|
748
|
+
* A fully-qualified path representing PrivateAuctionDeal resource.
|
|
749
|
+
* @returns {string} A string representing the network_code.
|
|
750
|
+
*/
|
|
751
|
+
matchNetworkCodeFromPrivateAuctionDealName(privateAuctionDealName: string): string | number;
|
|
752
|
+
/**
|
|
753
|
+
* Parse the private_auction_deal from PrivateAuctionDeal resource.
|
|
754
|
+
*
|
|
755
|
+
* @param {string} privateAuctionDealName
|
|
756
|
+
* A fully-qualified path representing PrivateAuctionDeal resource.
|
|
757
|
+
* @returns {string} A string representing the private_auction_deal.
|
|
758
|
+
*/
|
|
759
|
+
matchPrivateAuctionDealFromPrivateAuctionDealName(privateAuctionDealName: string): string | number;
|
|
760
|
+
/**
|
|
761
|
+
* Return a fully-qualified programmaticBuyer resource name string.
|
|
762
|
+
*
|
|
763
|
+
* @param {string} network_code
|
|
764
|
+
* @param {string} programmatic_buyer
|
|
765
|
+
* @returns {string} Resource name string.
|
|
766
|
+
*/
|
|
767
|
+
programmaticBuyerPath(networkCode: string, programmaticBuyer: string): string;
|
|
768
|
+
/**
|
|
769
|
+
* Parse the network_code from ProgrammaticBuyer resource.
|
|
770
|
+
*
|
|
771
|
+
* @param {string} programmaticBuyerName
|
|
772
|
+
* A fully-qualified path representing ProgrammaticBuyer resource.
|
|
773
|
+
* @returns {string} A string representing the network_code.
|
|
774
|
+
*/
|
|
775
|
+
matchNetworkCodeFromProgrammaticBuyerName(programmaticBuyerName: string): string | number;
|
|
776
|
+
/**
|
|
777
|
+
* Parse the programmatic_buyer from ProgrammaticBuyer resource.
|
|
778
|
+
*
|
|
779
|
+
* @param {string} programmaticBuyerName
|
|
780
|
+
* A fully-qualified path representing ProgrammaticBuyer resource.
|
|
781
|
+
* @returns {string} A string representing the programmatic_buyer.
|
|
782
|
+
*/
|
|
783
|
+
matchProgrammaticBuyerFromProgrammaticBuyerName(programmaticBuyerName: string): string | number;
|
|
784
|
+
/**
|
|
785
|
+
* Return a fully-qualified report resource name string.
|
|
786
|
+
*
|
|
787
|
+
* @param {string} network_code
|
|
788
|
+
* @param {string} report
|
|
789
|
+
* @returns {string} Resource name string.
|
|
790
|
+
*/
|
|
791
|
+
reportPath(networkCode: string, report: string): string;
|
|
792
|
+
/**
|
|
793
|
+
* Parse the network_code from Report resource.
|
|
794
|
+
*
|
|
795
|
+
* @param {string} reportName
|
|
796
|
+
* A fully-qualified path representing Report resource.
|
|
797
|
+
* @returns {string} A string representing the network_code.
|
|
798
|
+
*/
|
|
799
|
+
matchNetworkCodeFromReportName(reportName: string): string | number;
|
|
800
|
+
/**
|
|
801
|
+
* Parse the report from Report resource.
|
|
802
|
+
*
|
|
803
|
+
* @param {string} reportName
|
|
804
|
+
* A fully-qualified path representing Report resource.
|
|
805
|
+
* @returns {string} A string representing the report.
|
|
806
|
+
*/
|
|
807
|
+
matchReportFromReportName(reportName: string): string | number;
|
|
808
|
+
/**
|
|
809
|
+
* Return a fully-qualified role resource name string.
|
|
810
|
+
*
|
|
811
|
+
* @param {string} network_code
|
|
812
|
+
* @param {string} role
|
|
813
|
+
* @returns {string} Resource name string.
|
|
814
|
+
*/
|
|
815
|
+
rolePath(networkCode: string, role: string): string;
|
|
816
|
+
/**
|
|
817
|
+
* Parse the network_code from Role resource.
|
|
818
|
+
*
|
|
819
|
+
* @param {string} roleName
|
|
820
|
+
* A fully-qualified path representing Role resource.
|
|
821
|
+
* @returns {string} A string representing the network_code.
|
|
822
|
+
*/
|
|
823
|
+
matchNetworkCodeFromRoleName(roleName: string): string | number;
|
|
824
|
+
/**
|
|
825
|
+
* Parse the role from Role resource.
|
|
826
|
+
*
|
|
827
|
+
* @param {string} roleName
|
|
828
|
+
* A fully-qualified path representing Role resource.
|
|
829
|
+
* @returns {string} A string representing the role.
|
|
830
|
+
*/
|
|
831
|
+
matchRoleFromRoleName(roleName: string): string | number;
|
|
832
|
+
/**
|
|
833
|
+
* Return a fully-qualified taxonomyCategory resource name string.
|
|
834
|
+
*
|
|
835
|
+
* @param {string} network_code
|
|
836
|
+
* @param {string} taxonomy_category
|
|
837
|
+
* @returns {string} Resource name string.
|
|
838
|
+
*/
|
|
839
|
+
taxonomyCategoryPath(networkCode: string, taxonomyCategory: string): string;
|
|
840
|
+
/**
|
|
841
|
+
* Parse the network_code from TaxonomyCategory resource.
|
|
842
|
+
*
|
|
843
|
+
* @param {string} taxonomyCategoryName
|
|
844
|
+
* A fully-qualified path representing TaxonomyCategory resource.
|
|
845
|
+
* @returns {string} A string representing the network_code.
|
|
846
|
+
*/
|
|
847
|
+
matchNetworkCodeFromTaxonomyCategoryName(taxonomyCategoryName: string): string | number;
|
|
848
|
+
/**
|
|
849
|
+
* Parse the taxonomy_category from TaxonomyCategory resource.
|
|
850
|
+
*
|
|
851
|
+
* @param {string} taxonomyCategoryName
|
|
852
|
+
* A fully-qualified path representing TaxonomyCategory resource.
|
|
853
|
+
* @returns {string} A string representing the taxonomy_category.
|
|
854
|
+
*/
|
|
855
|
+
matchTaxonomyCategoryFromTaxonomyCategoryName(taxonomyCategoryName: string): string | number;
|
|
856
|
+
/**
|
|
857
|
+
* Return a fully-qualified team resource name string.
|
|
858
|
+
*
|
|
859
|
+
* @param {string} network_code
|
|
860
|
+
* @param {string} team
|
|
861
|
+
* @returns {string} Resource name string.
|
|
862
|
+
*/
|
|
863
|
+
teamPath(networkCode: string, team: string): string;
|
|
864
|
+
/**
|
|
865
|
+
* Parse the network_code from Team resource.
|
|
866
|
+
*
|
|
867
|
+
* @param {string} teamName
|
|
868
|
+
* A fully-qualified path representing Team resource.
|
|
869
|
+
* @returns {string} A string representing the network_code.
|
|
870
|
+
*/
|
|
871
|
+
matchNetworkCodeFromTeamName(teamName: string): string | number;
|
|
872
|
+
/**
|
|
873
|
+
* Parse the team from Team resource.
|
|
874
|
+
*
|
|
875
|
+
* @param {string} teamName
|
|
876
|
+
* A fully-qualified path representing Team resource.
|
|
877
|
+
* @returns {string} A string representing the team.
|
|
878
|
+
*/
|
|
879
|
+
matchTeamFromTeamName(teamName: string): string | number;
|
|
880
|
+
/**
|
|
881
|
+
* Return a fully-qualified user resource name string.
|
|
882
|
+
*
|
|
883
|
+
* @param {string} network_code
|
|
884
|
+
* @param {string} user
|
|
885
|
+
* @returns {string} Resource name string.
|
|
886
|
+
*/
|
|
887
|
+
userPath(networkCode: string, user: string): string;
|
|
888
|
+
/**
|
|
889
|
+
* Parse the network_code from User resource.
|
|
890
|
+
*
|
|
891
|
+
* @param {string} userName
|
|
892
|
+
* A fully-qualified path representing User resource.
|
|
893
|
+
* @returns {string} A string representing the network_code.
|
|
894
|
+
*/
|
|
895
|
+
matchNetworkCodeFromUserName(userName: string): string | number;
|
|
896
|
+
/**
|
|
897
|
+
* Parse the user from User resource.
|
|
898
|
+
*
|
|
899
|
+
* @param {string} userName
|
|
900
|
+
* A fully-qualified path representing User resource.
|
|
901
|
+
* @returns {string} A string representing the user.
|
|
902
|
+
*/
|
|
903
|
+
matchUserFromUserName(userName: string): string | number;
|
|
904
|
+
/**
|
|
905
|
+
* Terminate the gRPC channel and close the client.
|
|
906
|
+
*
|
|
907
|
+
* The client will no longer be usable and all future behavior is undefined.
|
|
908
|
+
* @returns {Promise} A promise that resolves when the client is closed.
|
|
909
|
+
*/
|
|
910
|
+
close(): Promise<void>;
|
|
911
|
+
}
|