@google-ads/admanager 0.5.0 → 0.6.0

package/build/src/v1/label_service_client.d.ts

@@ -0,0 +1,1631 @@
+import type * as gax from 'google-gax';
+import type { Callback, CallOptions, Descriptors, ClientOptions, PaginationCallback } from 'google-gax';
+import { Transform } from 'stream';
+import * as protos from '../../protos/protos';
+/**
+ *  Provides methods for handling `Label` objects.
+ * @class
+ * @memberof v1
+ */
+export declare class LabelServiceClient {
+    private _terminated;
+    private _opts;
+    private _providedCustomServicePath;
+    private _gaxModule;
+    private _gaxGrpc;
+    private _protos;
+    private _defaults;
+    private _universeDomain;
+    private _servicePath;
+    private _log;
+    auth: gax.GoogleAuth;
+    descriptors: Descriptors;
+    warn: (code: string, message: string, warnType?: string) => void;
+    innerApiCalls: {
+        [name: string]: Function;
+    };
+    pathTemplates: {
+        [name: string]: gax.PathTemplate;
+    };
+    labelServiceStub?: Promise<{
+        [name: string]: Function;
+    }>;
+    /**
+     * Construct an instance of LabelServiceClient.
+     *
+     * @param {object} [options] - The configuration object.
+     * The options accepted by the constructor are described in detail
+     * in [this document](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#creating-the-client-instance).
+     * The common options are:
+     * @param {object} [options.credentials] - Credentials object.
+     * @param {string} [options.credentials.client_email]
+     * @param {string} [options.credentials.private_key]
+     * @param {string} [options.email] - Account email address. Required when
+     *     using a .pem or .p12 keyFilename.
+     * @param {string} [options.keyFilename] - Full path to the a .json, .pem, or
+     *     .p12 key downloaded from the Google Developers Console. If you provide
+     *     a path to a JSON file, the projectId option below is not necessary.
+     *     NOTE: .pem and .p12 require you to specify options.email as well.
+     * @param {number} [options.port] - The port on which to connect to
+     *     the remote host.
+     * @param {string} [options.projectId] - The project ID from the Google
+     *     Developer's Console, e.g. 'grape-spaceship-123'. We will also check
+     *     the environment variable GCLOUD_PROJECT for your project ID. If your
+     *     app is running in an environment which supports
+     *     {@link https://cloud.google.com/docs/authentication/application-default-credentials Application Default Credentials},
+     *     your project ID will be detected automatically.
+     * @param {string} [options.apiEndpoint] - The domain name of the
+     *     API remote host.
+     * @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
+     *     Follows the structure of {@link gapicConfig}.
+     * @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
+     *     For more information, please check the
+     *     {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
+     * @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
+     *     need to avoid loading the default gRPC version and want to use the fallback
+     *     HTTP implementation. Load only fallback version and pass it to the constructor:
+     *     ```
+     *     const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
+     *     const client = new LabelServiceClient({fallback: true}, gax);
+     *     ```
+     */
+    constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
+    /**
+     * Initialize the client.
+     * Performs asynchronous operations (such as authentication) and prepares the client.
+     * This function will be called automatically when any class method is called for the
+     * first time, but if you need to initialize it before calling an actual method,
+     * feel free to call initialize() directly.
+     *
+     * You can await on this method if you want to make sure the client is initialized.
+     *
+     * @returns {Promise} A promise that resolves to an authenticated service stub.
+     */
+    initialize(): Promise<{
+        [name: string]: Function;
+    }>;
+    /**
+     * The DNS address for this API service.
+     * @deprecated Use the apiEndpoint method of the client instance.
+     * @returns {string} The DNS address for this service.
+     */
+    static get servicePath(): string;
+    /**
+     * The DNS address for this API service - same as servicePath.
+     * @deprecated Use the apiEndpoint method of the client instance.
+     * @returns {string} The DNS address for this service.
+     */
+    static get apiEndpoint(): string;
+    /**
+     * The DNS address for this API service.
+     * @returns {string} The DNS address for this service.
+     */
+    get apiEndpoint(): string;
+    get universeDomain(): string;
+    /**
+     * The port for this API service.
+     * @returns {number} The default port for this service.
+     */
+    static get port(): number;
+    /**
+     * The scopes needed to make gRPC calls for every method defined
+     * in this service.
+     * @returns {string[]} List of default scopes.
+     */
+    static get scopes(): string[];
+    getProjectId(): Promise<string>;
+    getProjectId(callback: Callback<string, undefined, undefined>): void;
+    /**
+     * API to retrieve a `Label` object.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.name
+     *   Required. The resource name of the Label.
+     *   Format: `networks/{network_code}/labels/{label_id}`
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Promise} - The promise which resolves to an array.
+     *   The first element of the array is an object representing {@link protos.google.ads.admanager.v1.Label|Label}.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/label_service.get_label.js</caption>
+     * region_tag:admanager_v1_generated_LabelService_GetLabel_async
+     */
+    getLabel(request?: protos.google.ads.admanager.v1.IGetLabelRequest, options?: CallOptions): Promise<[
+        protos.google.ads.admanager.v1.ILabel,
+        protos.google.ads.admanager.v1.IGetLabelRequest | undefined,
+        {} | undefined
+    ]>;
+    getLabel(request: protos.google.ads.admanager.v1.IGetLabelRequest, options: CallOptions, callback: Callback<protos.google.ads.admanager.v1.ILabel, protos.google.ads.admanager.v1.IGetLabelRequest | null | undefined, {} | null | undefined>): void;
+    getLabel(request: protos.google.ads.admanager.v1.IGetLabelRequest, callback: Callback<protos.google.ads.admanager.v1.ILabel, protos.google.ads.admanager.v1.IGetLabelRequest | null | undefined, {} | null | undefined>): void;
+    /**
+     * API to create a `Label` object.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.parent
+     *   Required. The parent resource where this `Label` will be created.
+     *   Format: `networks/{network_code}`
+     * @param {google.ads.admanager.v1.Label} request.label
+     *   Required. The `Label` to create.
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Promise} - The promise which resolves to an array.
+     *   The first element of the array is an object representing {@link protos.google.ads.admanager.v1.Label|Label}.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/label_service.create_label.js</caption>
+     * region_tag:admanager_v1_generated_LabelService_CreateLabel_async
+     */
+    createLabel(request?: protos.google.ads.admanager.v1.ICreateLabelRequest, options?: CallOptions): Promise<[
+        protos.google.ads.admanager.v1.ILabel,
+        protos.google.ads.admanager.v1.ICreateLabelRequest | undefined,
+        {} | undefined
+    ]>;
+    createLabel(request: protos.google.ads.admanager.v1.ICreateLabelRequest, options: CallOptions, callback: Callback<protos.google.ads.admanager.v1.ILabel, protos.google.ads.admanager.v1.ICreateLabelRequest | null | undefined, {} | null | undefined>): void;
+    createLabel(request: protos.google.ads.admanager.v1.ICreateLabelRequest, callback: Callback<protos.google.ads.admanager.v1.ILabel, protos.google.ads.admanager.v1.ICreateLabelRequest | null | undefined, {} | null | undefined>): void;
+    /**
+     * API to batch create `Label` objects.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.parent
+     *   Required. The parent resource where `Labels` will be created.
+     *   Format: `networks/{network_code}`
+     *   The parent field in the CreateLabelRequest must match this
+     *   field.
+     * @param {number[]} request.requests
+     *   Required. The `Label` objects to create.
+     *   A maximum of 100 objects can be created in a batch.
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Promise} - The promise which resolves to an array.
+     *   The first element of the array is an object representing {@link protos.google.ads.admanager.v1.BatchCreateLabelsResponse|BatchCreateLabelsResponse}.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/label_service.batch_create_labels.js</caption>
+     * region_tag:admanager_v1_generated_LabelService_BatchCreateLabels_async
+     */
+    batchCreateLabels(request?: protos.google.ads.admanager.v1.IBatchCreateLabelsRequest, options?: CallOptions): Promise<[
+        protos.google.ads.admanager.v1.IBatchCreateLabelsResponse,
+        protos.google.ads.admanager.v1.IBatchCreateLabelsRequest | undefined,
+        {} | undefined
+    ]>;
+    batchCreateLabels(request: protos.google.ads.admanager.v1.IBatchCreateLabelsRequest, options: CallOptions, callback: Callback<protos.google.ads.admanager.v1.IBatchCreateLabelsResponse, protos.google.ads.admanager.v1.IBatchCreateLabelsRequest | null | undefined, {} | null | undefined>): void;
+    batchCreateLabels(request: protos.google.ads.admanager.v1.IBatchCreateLabelsRequest, callback: Callback<protos.google.ads.admanager.v1.IBatchCreateLabelsResponse, protos.google.ads.admanager.v1.IBatchCreateLabelsRequest | null | undefined, {} | null | undefined>): void;
+    /**
+     * API to update a `Label` object.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {google.ads.admanager.v1.Label} request.label
+     *   Required. The `Label` to update.
+     *
+     *   The `Label`'s `name` is used to identify the `Label` to update.
+     * @param {google.protobuf.FieldMask} [request.updateMask]
+     *   Optional. The list of fields to update.
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Promise} - The promise which resolves to an array.
+     *   The first element of the array is an object representing {@link protos.google.ads.admanager.v1.Label|Label}.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/label_service.update_label.js</caption>
+     * region_tag:admanager_v1_generated_LabelService_UpdateLabel_async
+     */
+    updateLabel(request?: protos.google.ads.admanager.v1.IUpdateLabelRequest, options?: CallOptions): Promise<[
+        protos.google.ads.admanager.v1.ILabel,
+        protos.google.ads.admanager.v1.IUpdateLabelRequest | undefined,
+        {} | undefined
+    ]>;
+    updateLabel(request: protos.google.ads.admanager.v1.IUpdateLabelRequest, options: CallOptions, callback: Callback<protos.google.ads.admanager.v1.ILabel, protos.google.ads.admanager.v1.IUpdateLabelRequest | null | undefined, {} | null | undefined>): void;
+    updateLabel(request: protos.google.ads.admanager.v1.IUpdateLabelRequest, callback: Callback<protos.google.ads.admanager.v1.ILabel, protos.google.ads.admanager.v1.IUpdateLabelRequest | null | undefined, {} | null | undefined>): void;
+    /**
+     * API to batch update `Label` objects.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.parent
+     *   Required. The parent resource where `Labels` will be updated.
+     *   Format: `networks/{network_code}`
+     *   The parent field in the UpdateLabelRequest must match this
+     *   field.
+     * @param {number[]} request.requests
+     *   Required. The `Label` objects to update.
+     *   A maximum of 100 objects can be updated in a batch.
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Promise} - The promise which resolves to an array.
+     *   The first element of the array is an object representing {@link protos.google.ads.admanager.v1.BatchUpdateLabelsResponse|BatchUpdateLabelsResponse}.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/label_service.batch_update_labels.js</caption>
+     * region_tag:admanager_v1_generated_LabelService_BatchUpdateLabels_async
+     */
+    batchUpdateLabels(request?: protos.google.ads.admanager.v1.IBatchUpdateLabelsRequest, options?: CallOptions): Promise<[
+        protos.google.ads.admanager.v1.IBatchUpdateLabelsResponse,
+        protos.google.ads.admanager.v1.IBatchUpdateLabelsRequest | undefined,
+        {} | undefined
+    ]>;
+    batchUpdateLabels(request: protos.google.ads.admanager.v1.IBatchUpdateLabelsRequest, options: CallOptions, callback: Callback<protos.google.ads.admanager.v1.IBatchUpdateLabelsResponse, protos.google.ads.admanager.v1.IBatchUpdateLabelsRequest | null | undefined, {} | null | undefined>): void;
+    batchUpdateLabels(request: protos.google.ads.admanager.v1.IBatchUpdateLabelsRequest, callback: Callback<protos.google.ads.admanager.v1.IBatchUpdateLabelsResponse, protos.google.ads.admanager.v1.IBatchUpdateLabelsRequest | null | undefined, {} | null | undefined>): void;
+    /**
+     * API to activate `Label` objects.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.parent
+     *   Required. Format: `networks/{network_code}`
+     * @param {string[]} request.names
+     *   Required. Resource names for the Label.
+     *   Format: `networks/{network_code}/labels/{label_id}`
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Promise} - The promise which resolves to an array.
+     *   The first element of the array is an object representing {@link protos.google.ads.admanager.v1.BatchActivateLabelsResponse|BatchActivateLabelsResponse}.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/label_service.batch_activate_labels.js</caption>
+     * region_tag:admanager_v1_generated_LabelService_BatchActivateLabels_async
+     */
+    batchActivateLabels(request?: protos.google.ads.admanager.v1.IBatchActivateLabelsRequest, options?: CallOptions): Promise<[
+        protos.google.ads.admanager.v1.IBatchActivateLabelsResponse,
+        protos.google.ads.admanager.v1.IBatchActivateLabelsRequest | undefined,
+        {} | undefined
+    ]>;
+    batchActivateLabels(request: protos.google.ads.admanager.v1.IBatchActivateLabelsRequest, options: CallOptions, callback: Callback<protos.google.ads.admanager.v1.IBatchActivateLabelsResponse, protos.google.ads.admanager.v1.IBatchActivateLabelsRequest | null | undefined, {} | null | undefined>): void;
+    batchActivateLabels(request: protos.google.ads.admanager.v1.IBatchActivateLabelsRequest, callback: Callback<protos.google.ads.admanager.v1.IBatchActivateLabelsResponse, protos.google.ads.admanager.v1.IBatchActivateLabelsRequest | null | undefined, {} | null | undefined>): void;
+    /**
+     * API to deactivate `Label` objects.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.parent
+     *   Required. Format: `networks/{network_code}`
+     * @param {string[]} request.names
+     *   Required. Resource names for the Label.
+     *   Format: `networks/{network_code}/labels/{label_id}`
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Promise} - The promise which resolves to an array.
+     *   The first element of the array is an object representing {@link protos.google.ads.admanager.v1.BatchDeactivateLabelsResponse|BatchDeactivateLabelsResponse}.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/label_service.batch_deactivate_labels.js</caption>
+     * region_tag:admanager_v1_generated_LabelService_BatchDeactivateLabels_async
+     */
+    batchDeactivateLabels(request?: protos.google.ads.admanager.v1.IBatchDeactivateLabelsRequest, options?: CallOptions): Promise<[
+        protos.google.ads.admanager.v1.IBatchDeactivateLabelsResponse,
+        protos.google.ads.admanager.v1.IBatchDeactivateLabelsRequest | undefined,
+        {} | undefined
+    ]>;
+    batchDeactivateLabels(request: protos.google.ads.admanager.v1.IBatchDeactivateLabelsRequest, options: CallOptions, callback: Callback<protos.google.ads.admanager.v1.IBatchDeactivateLabelsResponse, protos.google.ads.admanager.v1.IBatchDeactivateLabelsRequest | null | undefined, {} | null | undefined>): void;
+    batchDeactivateLabels(request: protos.google.ads.admanager.v1.IBatchDeactivateLabelsRequest, callback: Callback<protos.google.ads.admanager.v1.IBatchDeactivateLabelsResponse, protos.google.ads.admanager.v1.IBatchDeactivateLabelsRequest | null | undefined, {} | null | undefined>): void;
+    /**
+     * API to retrieve a list of `Label` objects.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.parent
+     *   Required. The parent, which owns this collection of Labels.
+     *   Format: `networks/{network_code}`
+     * @param {number} [request.pageSize]
+     *   Optional. The maximum number of `Labels` to return. The service may return
+     *   fewer than this value. If unspecified, at most 50 `Labels` will be
+     *   returned. The maximum value is 1000; values greater than 1000 will be
+     *   coerced to 1000.
+     * @param {string} [request.pageToken]
+     *   Optional. A page token, received from a previous `ListLabels` call.
+     *   Provide this to retrieve the subsequent page.
+     *
+     *   When paginating, all other parameters provided to `ListLabels` must match
+     *   the call that provided the page token.
+     * @param {string} [request.filter]
+     *   Optional. Expression to filter the response.
+     *    See syntax details at
+     *    https://developers.google.com/ad-manager/api/beta/filters
+     *
+     *   <b>Filterable fields:</b>
+     *   <ul style="list-style-type:none">
+     *     <li><code>active</code></li>
+     *     <li><code>description</code></li>
+     *     <li><code>displayName</code></li>
+     *     <li><code>name</code></li>
+     *     <li><code>types</code></li>
+     *   </ul>
+     * @param {string} [request.orderBy]
+     *   Optional. Expression to specify sorting order.
+     *   See syntax details at
+     *   https://developers.google.com/ad-manager/api/beta/filters#order
+     * @param {number} [request.skip]
+     *   Optional. Number of individual resources to skip while paginating.
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Promise} - The promise which resolves to an array.
+     *   The first element of the array is Array of {@link protos.google.ads.admanager.v1.Label|Label}.
+     *   The client library will perform auto-pagination by default: it will call the API as many
+     *   times as needed and will merge results from all the pages into this array.
+     *   Note that it can affect your quota.
+     *   We recommend using `listLabelsAsync()`
+     *   method described below for async iteration which you can stop as needed.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
+     *   for more details and examples.
+     */
+    listLabels(request?: protos.google.ads.admanager.v1.IListLabelsRequest, options?: CallOptions): Promise<[
+        protos.google.ads.admanager.v1.ILabel[],
+        protos.google.ads.admanager.v1.IListLabelsRequest | null,
+        protos.google.ads.admanager.v1.IListLabelsResponse
+    ]>;
+    listLabels(request: protos.google.ads.admanager.v1.IListLabelsRequest, options: CallOptions, callback: PaginationCallback<protos.google.ads.admanager.v1.IListLabelsRequest, protos.google.ads.admanager.v1.IListLabelsResponse | null | undefined, protos.google.ads.admanager.v1.ILabel>): void;
+    listLabels(request: protos.google.ads.admanager.v1.IListLabelsRequest, callback: PaginationCallback<protos.google.ads.admanager.v1.IListLabelsRequest, protos.google.ads.admanager.v1.IListLabelsResponse | null | undefined, protos.google.ads.admanager.v1.ILabel>): void;
+    /**
+     * Equivalent to `listLabels`, but returns a NodeJS Stream object.
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.parent
+     *   Required. The parent, which owns this collection of Labels.
+     *   Format: `networks/{network_code}`
+     * @param {number} [request.pageSize]
+     *   Optional. The maximum number of `Labels` to return. The service may return
+     *   fewer than this value. If unspecified, at most 50 `Labels` will be
+     *   returned. The maximum value is 1000; values greater than 1000 will be
+     *   coerced to 1000.
+     * @param {string} [request.pageToken]
+     *   Optional. A page token, received from a previous `ListLabels` call.
+     *   Provide this to retrieve the subsequent page.
+     *
+     *   When paginating, all other parameters provided to `ListLabels` must match
+     *   the call that provided the page token.
+     * @param {string} [request.filter]
+     *   Optional. Expression to filter the response.
+     *    See syntax details at
+     *    https://developers.google.com/ad-manager/api/beta/filters
+     *
+     *   <b>Filterable fields:</b>
+     *   <ul style="list-style-type:none">
+     *     <li><code>active</code></li>
+     *     <li><code>description</code></li>
+     *     <li><code>displayName</code></li>
+     *     <li><code>name</code></li>
+     *     <li><code>types</code></li>
+     *   </ul>
+     * @param {string} [request.orderBy]
+     *   Optional. Expression to specify sorting order.
+     *   See syntax details at
+     *   https://developers.google.com/ad-manager/api/beta/filters#order
+     * @param {number} [request.skip]
+     *   Optional. Number of individual resources to skip while paginating.
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Stream}
+     *   An object stream which emits an object representing {@link protos.google.ads.admanager.v1.Label|Label} on 'data' event.
+     *   The client library will perform auto-pagination by default: it will call the API as many
+     *   times as needed. Note that it can affect your quota.
+     *   We recommend using `listLabelsAsync()`
+     *   method described below for async iteration which you can stop as needed.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
+     *   for more details and examples.
+     */
+    listLabelsStream(request?: protos.google.ads.admanager.v1.IListLabelsRequest, options?: CallOptions): Transform;
+    /**
+     * Equivalent to `listLabels`, but returns an iterable object.
+     *
+     * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.parent
+     *   Required. The parent, which owns this collection of Labels.
+     *   Format: `networks/{network_code}`
+     * @param {number} [request.pageSize]
+     *   Optional. The maximum number of `Labels` to return. The service may return
+     *   fewer than this value. If unspecified, at most 50 `Labels` will be
+     *   returned. The maximum value is 1000; values greater than 1000 will be
+     *   coerced to 1000.
+     * @param {string} [request.pageToken]
+     *   Optional. A page token, received from a previous `ListLabels` call.
+     *   Provide this to retrieve the subsequent page.
+     *
+     *   When paginating, all other parameters provided to `ListLabels` must match
+     *   the call that provided the page token.
+     * @param {string} [request.filter]
+     *   Optional. Expression to filter the response.
+     *    See syntax details at
+     *    https://developers.google.com/ad-manager/api/beta/filters
+     *
+     *   <b>Filterable fields:</b>
+     *   <ul style="list-style-type:none">
+     *     <li><code>active</code></li>
+     *     <li><code>description</code></li>
+     *     <li><code>displayName</code></li>
+     *     <li><code>name</code></li>
+     *     <li><code>types</code></li>
+     *   </ul>
+     * @param {string} [request.orderBy]
+     *   Optional. Expression to specify sorting order.
+     *   See syntax details at
+     *   https://developers.google.com/ad-manager/api/beta/filters#order
+     * @param {number} [request.skip]
+     *   Optional. Number of individual resources to skip while paginating.
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Object}
+     *   An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
+     *   When you iterate the returned iterable, each element will be an object representing
+     *   {@link protos.google.ads.admanager.v1.Label|Label}. The API will be called under the hood as needed, once per the page,
+     *   so you can stop the iteration when you don't need more results.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/label_service.list_labels.js</caption>
+     * region_tag:admanager_v1_generated_LabelService_ListLabels_async
+     */
+    listLabelsAsync(request?: protos.google.ads.admanager.v1.IListLabelsRequest, options?: CallOptions): AsyncIterable<protos.google.ads.admanager.v1.ILabel>;
+    /**
+     * Return a fully-qualified adBreak resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} asset_key
+     * @param {string} ad_break
+     * @returns {string} Resource name string.
+     */
+    adBreakPath(networkCode: string, assetKey: string, adBreak: string): string;
+    /**
+     * Parse the network_code from AdBreak resource.
+     *
+     * @param {string} adBreakName
+     *   A fully-qualified path representing AdBreak resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromAdBreakName(adBreakName: string): string | number;
+    /**
+     * Parse the asset_key from AdBreak resource.
+     *
+     * @param {string} adBreakName
+     *   A fully-qualified path representing AdBreak resource.
+     * @returns {string} A string representing the asset_key.
+     */
+    matchAssetKeyFromAdBreakName(adBreakName: string): string | number;
+    /**
+     * Parse the ad_break from AdBreak resource.
+     *
+     * @param {string} adBreakName
+     *   A fully-qualified path representing AdBreak resource.
+     * @returns {string} A string representing the ad_break.
+     */
+    matchAdBreakFromAdBreakName(adBreakName: string): string | number;
+    /**
+     * Return a fully-qualified adReviewCenterAd resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} web_property_code
+     * @param {string} ad_review_center_ad
+     * @returns {string} Resource name string.
+     */
+    adReviewCenterAdPath(networkCode: string, webPropertyCode: string, adReviewCenterAd: string): string;
+    /**
+     * Parse the network_code from AdReviewCenterAd resource.
+     *
+     * @param {string} adReviewCenterAdName
+     *   A fully-qualified path representing AdReviewCenterAd resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromAdReviewCenterAdName(adReviewCenterAdName: string): string | number;
+    /**
+     * Parse the web_property_code from AdReviewCenterAd resource.
+     *
+     * @param {string} adReviewCenterAdName
+     *   A fully-qualified path representing AdReviewCenterAd resource.
+     * @returns {string} A string representing the web_property_code.
+     */
+    matchWebPropertyCodeFromAdReviewCenterAdName(adReviewCenterAdName: string): string | number;
+    /**
+     * Parse the ad_review_center_ad from AdReviewCenterAd resource.
+     *
+     * @param {string} adReviewCenterAdName
+     *   A fully-qualified path representing AdReviewCenterAd resource.
+     * @returns {string} A string representing the ad_review_center_ad.
+     */
+    matchAdReviewCenterAdFromAdReviewCenterAdName(adReviewCenterAdName: string): string | number;
+    /**
+     * Return a fully-qualified adUnit resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} ad_unit
+     * @returns {string} Resource name string.
+     */
+    adUnitPath(networkCode: string, adUnit: string): string;
+    /**
+     * Parse the network_code from AdUnit resource.
+     *
+     * @param {string} adUnitName
+     *   A fully-qualified path representing AdUnit resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromAdUnitName(adUnitName: string): string | number;
+    /**
+     * Parse the ad_unit from AdUnit resource.
+     *
+     * @param {string} adUnitName
+     *   A fully-qualified path representing AdUnit resource.
+     * @returns {string} A string representing the ad_unit.
+     */
+    matchAdUnitFromAdUnitName(adUnitName: string): string | number;
+    /**
+     * Return a fully-qualified application resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} application
+     * @returns {string} Resource name string.
+     */
+    applicationPath(networkCode: string, application: string): string;
+    /**
+     * Parse the network_code from Application resource.
+     *
+     * @param {string} applicationName
+     *   A fully-qualified path representing Application resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromApplicationName(applicationName: string): string | number;
+    /**
+     * Parse the application from Application resource.
+     *
+     * @param {string} applicationName
+     *   A fully-qualified path representing Application resource.
+     * @returns {string} A string representing the application.
+     */
+    matchApplicationFromApplicationName(applicationName: string): string | number;
+    /**
+     * Return a fully-qualified audienceSegment resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} audience_segment
+     * @returns {string} Resource name string.
+     */
+    audienceSegmentPath(networkCode: string, audienceSegment: string): string;
+    /**
+     * Parse the network_code from AudienceSegment resource.
+     *
+     * @param {string} audienceSegmentName
+     *   A fully-qualified path representing AudienceSegment resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromAudienceSegmentName(audienceSegmentName: string): string | number;
+    /**
+     * Parse the audience_segment from AudienceSegment resource.
+     *
+     * @param {string} audienceSegmentName
+     *   A fully-qualified path representing AudienceSegment resource.
+     * @returns {string} A string representing the audience_segment.
+     */
+    matchAudienceSegmentFromAudienceSegmentName(audienceSegmentName: string): string | number;
+    /**
+     * Return a fully-qualified bandwidthGroup resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} bandwidth_group
+     * @returns {string} Resource name string.
+     */
+    bandwidthGroupPath(networkCode: string, bandwidthGroup: string): string;
+    /**
+     * Parse the network_code from BandwidthGroup resource.
+     *
+     * @param {string} bandwidthGroupName
+     *   A fully-qualified path representing BandwidthGroup resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromBandwidthGroupName(bandwidthGroupName: string): string | number;
+    /**
+     * Parse the bandwidth_group from BandwidthGroup resource.
+     *
+     * @param {string} bandwidthGroupName
+     *   A fully-qualified path representing BandwidthGroup resource.
+     * @returns {string} A string representing the bandwidth_group.
+     */
+    matchBandwidthGroupFromBandwidthGroupName(bandwidthGroupName: string): string | number;
+    /**
+     * Return a fully-qualified browser resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} browser
+     * @returns {string} Resource name string.
+     */
+    browserPath(networkCode: string, browser: string): string;
+    /**
+     * Parse the network_code from Browser resource.
+     *
+     * @param {string} browserName
+     *   A fully-qualified path representing Browser resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromBrowserName(browserName: string): string | number;
+    /**
+     * Parse the browser from Browser resource.
+     *
+     * @param {string} browserName
+     *   A fully-qualified path representing Browser resource.
+     * @returns {string} A string representing the browser.
+     */
+    matchBrowserFromBrowserName(browserName: string): string | number;
+    /**
+     * Return a fully-qualified browserLanguage resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} browser_language
+     * @returns {string} Resource name string.
+     */
+    browserLanguagePath(networkCode: string, browserLanguage: string): string;
+    /**
+     * Parse the network_code from BrowserLanguage resource.
+     *
+     * @param {string} browserLanguageName
+     *   A fully-qualified path representing BrowserLanguage resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromBrowserLanguageName(browserLanguageName: string): string | number;
+    /**
+     * Parse the browser_language from BrowserLanguage resource.
+     *
+     * @param {string} browserLanguageName
+     *   A fully-qualified path representing BrowserLanguage resource.
+     * @returns {string} A string representing the browser_language.
+     */
+    matchBrowserLanguageFromBrowserLanguageName(browserLanguageName: string): string | number;
+    /**
+     * Return a fully-qualified childPublisher resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} child_publisher
+     * @returns {string} Resource name string.
+     */
+    childPublisherPath(networkCode: string, childPublisher: string): string;
+    /**
+     * Parse the network_code from ChildPublisher resource.
+     *
+     * @param {string} childPublisherName
+     *   A fully-qualified path representing ChildPublisher resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromChildPublisherName(childPublisherName: string): string | number;
+    /**
+     * Parse the child_publisher from ChildPublisher resource.
+     *
+     * @param {string} childPublisherName
+     *   A fully-qualified path representing ChildPublisher resource.
+     * @returns {string} A string representing the child_publisher.
+     */
+    matchChildPublisherFromChildPublisherName(childPublisherName: string): string | number;
+    /**
+     * Return a fully-qualified cmsMetadataKey resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} cms_metadata_key
+     * @returns {string} Resource name string.
+     */
+    cmsMetadataKeyPath(networkCode: string, cmsMetadataKey: string): string;
+    /**
+     * Parse the network_code from CmsMetadataKey resource.
+     *
+     * @param {string} cmsMetadataKeyName
+     *   A fully-qualified path representing CmsMetadataKey resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromCmsMetadataKeyName(cmsMetadataKeyName: string): string | number;
+    /**
+     * Parse the cms_metadata_key from CmsMetadataKey resource.
+     *
+     * @param {string} cmsMetadataKeyName
+     *   A fully-qualified path representing CmsMetadataKey resource.
+     * @returns {string} A string representing the cms_metadata_key.
+     */
+    matchCmsMetadataKeyFromCmsMetadataKeyName(cmsMetadataKeyName: string): string | number;
+    /**
+     * Return a fully-qualified cmsMetadataValue resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} cms_metadata_value
+     * @returns {string} Resource name string.
+     */
+    cmsMetadataValuePath(networkCode: string, cmsMetadataValue: string): string;
+    /**
+     * Parse the network_code from CmsMetadataValue resource.
+     *
+     * @param {string} cmsMetadataValueName
+     *   A fully-qualified path representing CmsMetadataValue resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromCmsMetadataValueName(cmsMetadataValueName: string): string | number;
+    /**
+     * Parse the cms_metadata_value from CmsMetadataValue resource.
+     *
+     * @param {string} cmsMetadataValueName
+     *   A fully-qualified path representing CmsMetadataValue resource.
+     * @returns {string} A string representing the cms_metadata_value.
+     */
+    matchCmsMetadataValueFromCmsMetadataValueName(cmsMetadataValueName: string): string | number;
+    /**
+     * Return a fully-qualified company resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} company
+     * @returns {string} Resource name string.
+     */
+    companyPath(networkCode: string, company: string): string;
+    /**
+     * Parse the network_code from Company resource.
+     *
+     * @param {string} companyName
+     *   A fully-qualified path representing Company resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromCompanyName(companyName: string): string | number;
+    /**
+     * Parse the company from Company resource.
+     *
+     * @param {string} companyName
+     *   A fully-qualified path representing Company resource.
+     * @returns {string} A string representing the company.
+     */
+    matchCompanyFromCompanyName(companyName: string): string | number;
+    /**
+     * Return a fully-qualified contact resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} contact
+     * @returns {string} Resource name string.
+     */
+    contactPath(networkCode: string, contact: string): string;
+    /**
+     * Parse the network_code from Contact resource.
+     *
+     * @param {string} contactName
+     *   A fully-qualified path representing Contact resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromContactName(contactName: string): string | number;
+    /**
+     * Parse the contact from Contact resource.
+     *
+     * @param {string} contactName
+     *   A fully-qualified path representing Contact resource.
+     * @returns {string} A string representing the contact.
+     */
+    matchContactFromContactName(contactName: string): string | number;
+    /**
+     * Return a fully-qualified content resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} content
+     * @returns {string} Resource name string.
+     */
+    contentPath(networkCode: string, content: string): string;
+    /**
+     * Parse the network_code from Content resource.
+     *
+     * @param {string} contentName
+     *   A fully-qualified path representing Content resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromContentName(contentName: string): string | number;
+    /**
+     * Parse the content from Content resource.
+     *
+     * @param {string} contentName
+     *   A fully-qualified path representing Content resource.
+     * @returns {string} A string representing the content.
+     */
+    matchContentFromContentName(contentName: string): string | number;
+    /**
+     * Return a fully-qualified contentBundle resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} content_bundle
+     * @returns {string} Resource name string.
+     */
+    contentBundlePath(networkCode: string, contentBundle: string): string;
+    /**
+     * Parse the network_code from ContentBundle resource.
+     *
+     * @param {string} contentBundleName
+     *   A fully-qualified path representing ContentBundle resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromContentBundleName(contentBundleName: string): string | number;
+    /**
+     * Parse the content_bundle from ContentBundle resource.
+     *
+     * @param {string} contentBundleName
+     *   A fully-qualified path representing ContentBundle resource.
+     * @returns {string} A string representing the content_bundle.
+     */
+    matchContentBundleFromContentBundleName(contentBundleName: string): string | number;
+    /**
+     * Return a fully-qualified contentLabel resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} content_label
+     * @returns {string} Resource name string.
+     */
+    contentLabelPath(networkCode: string, contentLabel: string): string;
+    /**
+     * Parse the network_code from ContentLabel resource.
+     *
+     * @param {string} contentLabelName
+     *   A fully-qualified path representing ContentLabel resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromContentLabelName(contentLabelName: string): string | number;
+    /**
+     * Parse the content_label from ContentLabel resource.
+     *
+     * @param {string} contentLabelName
+     *   A fully-qualified path representing ContentLabel resource.
+     * @returns {string} A string representing the content_label.
+     */
+    matchContentLabelFromContentLabelName(contentLabelName: string): string | number;
+    /**
+     * Return a fully-qualified creativeTemplate resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} creative_template
+     * @returns {string} Resource name string.
+     */
+    creativeTemplatePath(networkCode: string, creativeTemplate: string): string;
+    /**
+     * Parse the network_code from CreativeTemplate resource.
+     *
+     * @param {string} creativeTemplateName
+     *   A fully-qualified path representing CreativeTemplate resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromCreativeTemplateName(creativeTemplateName: string): string | number;
+    /**
+     * Parse the creative_template from CreativeTemplate resource.
+     *
+     * @param {string} creativeTemplateName
+     *   A fully-qualified path representing CreativeTemplate resource.
+     * @returns {string} A string representing the creative_template.
+     */
+    matchCreativeTemplateFromCreativeTemplateName(creativeTemplateName: string): string | number;
+    /**
+     * Return a fully-qualified customField resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} custom_field
+     * @returns {string} Resource name string.
+     */
+    customFieldPath(networkCode: string, customField: string): string;
+    /**
+     * Parse the network_code from CustomField resource.
+     *
+     * @param {string} customFieldName
+     *   A fully-qualified path representing CustomField resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromCustomFieldName(customFieldName: string): string | number;
+    /**
+     * Parse the custom_field from CustomField resource.
+     *
+     * @param {string} customFieldName
+     *   A fully-qualified path representing CustomField resource.
+     * @returns {string} A string representing the custom_field.
+     */
+    matchCustomFieldFromCustomFieldName(customFieldName: string): string | number;
+    /**
+     * Return a fully-qualified customTargetingKey resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} custom_targeting_key
+     * @returns {string} Resource name string.
+     */
+    customTargetingKeyPath(networkCode: string, customTargetingKey: string): string;
+    /**
+     * Parse the network_code from CustomTargetingKey resource.
+     *
+     * @param {string} customTargetingKeyName
+     *   A fully-qualified path representing CustomTargetingKey resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromCustomTargetingKeyName(customTargetingKeyName: string): string | number;
+    /**
+     * Parse the custom_targeting_key from CustomTargetingKey resource.
+     *
+     * @param {string} customTargetingKeyName
+     *   A fully-qualified path representing CustomTargetingKey resource.
+     * @returns {string} A string representing the custom_targeting_key.
+     */
+    matchCustomTargetingKeyFromCustomTargetingKeyName(customTargetingKeyName: string): string | number;
+    /**
+     * Return a fully-qualified customTargetingValue resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} custom_targeting_value
+     * @returns {string} Resource name string.
+     */
+    customTargetingValuePath(networkCode: string, customTargetingValue: string): string;
+    /**
+     * Parse the network_code from CustomTargetingValue resource.
+     *
+     * @param {string} customTargetingValueName
+     *   A fully-qualified path representing CustomTargetingValue resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromCustomTargetingValueName(customTargetingValueName: string): string | number;
+    /**
+     * Parse the custom_targeting_value from CustomTargetingValue resource.
+     *
+     * @param {string} customTargetingValueName
+     *   A fully-qualified path representing CustomTargetingValue resource.
+     * @returns {string} A string representing the custom_targeting_value.
+     */
+    matchCustomTargetingValueFromCustomTargetingValueName(customTargetingValueName: string): string | number;
+    /**
+     * Return a fully-qualified deviceCapability resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} device_capability
+     * @returns {string} Resource name string.
+     */
+    deviceCapabilityPath(networkCode: string, deviceCapability: string): string;
+    /**
+     * Parse the network_code from DeviceCapability resource.
+     *
+     * @param {string} deviceCapabilityName
+     *   A fully-qualified path representing DeviceCapability resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromDeviceCapabilityName(deviceCapabilityName: string): string | number;
+    /**
+     * Parse the device_capability from DeviceCapability resource.
+     *
+     * @param {string} deviceCapabilityName
+     *   A fully-qualified path representing DeviceCapability resource.
+     * @returns {string} A string representing the device_capability.
+     */
+    matchDeviceCapabilityFromDeviceCapabilityName(deviceCapabilityName: string): string | number;
+    /**
+     * Return a fully-qualified deviceCategory resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} device_category
+     * @returns {string} Resource name string.
+     */
+    deviceCategoryPath(networkCode: string, deviceCategory: string): string;
+    /**
+     * Parse the network_code from DeviceCategory resource.
+     *
+     * @param {string} deviceCategoryName
+     *   A fully-qualified path representing DeviceCategory resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromDeviceCategoryName(deviceCategoryName: string): string | number;
+    /**
+     * Parse the device_category from DeviceCategory resource.
+     *
+     * @param {string} deviceCategoryName
+     *   A fully-qualified path representing DeviceCategory resource.
+     * @returns {string} A string representing the device_category.
+     */
+    matchDeviceCategoryFromDeviceCategoryName(deviceCategoryName: string): string | number;
+    /**
+     * Return a fully-qualified deviceManufacturer resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} device_manufacturer
+     * @returns {string} Resource name string.
+     */
+    deviceManufacturerPath(networkCode: string, deviceManufacturer: string): string;
+    /**
+     * Parse the network_code from DeviceManufacturer resource.
+     *
+     * @param {string} deviceManufacturerName
+     *   A fully-qualified path representing DeviceManufacturer resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromDeviceManufacturerName(deviceManufacturerName: string): string | number;
+    /**
+     * Parse the device_manufacturer from DeviceManufacturer resource.
+     *
+     * @param {string} deviceManufacturerName
+     *   A fully-qualified path representing DeviceManufacturer resource.
+     * @returns {string} A string representing the device_manufacturer.
+     */
+    matchDeviceManufacturerFromDeviceManufacturerName(deviceManufacturerName: string): string | number;
+    /**
+     * Return a fully-qualified entitySignalsMapping resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} entity_signals_mapping
+     * @returns {string} Resource name string.
+     */
+    entitySignalsMappingPath(networkCode: string, entitySignalsMapping: string): string;
+    /**
+     * Parse the network_code from EntitySignalsMapping resource.
+     *
+     * @param {string} entitySignalsMappingName
+     *   A fully-qualified path representing EntitySignalsMapping resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromEntitySignalsMappingName(entitySignalsMappingName: string): string | number;
+    /**
+     * Parse the entity_signals_mapping from EntitySignalsMapping resource.
+     *
+     * @param {string} entitySignalsMappingName
+     *   A fully-qualified path representing EntitySignalsMapping resource.
+     * @returns {string} A string representing the entity_signals_mapping.
+     */
+    matchEntitySignalsMappingFromEntitySignalsMappingName(entitySignalsMappingName: string): string | number;
+    /**
+     * Return a fully-qualified geoTarget resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} geo_target
+     * @returns {string} Resource name string.
+     */
+    geoTargetPath(networkCode: string, geoTarget: string): string;
+    /**
+     * Parse the network_code from GeoTarget resource.
+     *
+     * @param {string} geoTargetName
+     *   A fully-qualified path representing GeoTarget resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromGeoTargetName(geoTargetName: string): string | number;
+    /**
+     * Parse the geo_target from GeoTarget resource.
+     *
+     * @param {string} geoTargetName
+     *   A fully-qualified path representing GeoTarget resource.
+     * @returns {string} A string representing the geo_target.
+     */
+    matchGeoTargetFromGeoTargetName(geoTargetName: string): string | number;
+    /**
+     * Return a fully-qualified label resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} label
+     * @returns {string} Resource name string.
+     */
+    labelPath(networkCode: string, label: string): string;
+    /**
+     * Parse the network_code from Label resource.
+     *
+     * @param {string} labelName
+     *   A fully-qualified path representing Label resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromLabelName(labelName: string): string | number;
+    /**
+     * Parse the label from Label resource.
+     *
+     * @param {string} labelName
+     *   A fully-qualified path representing Label resource.
+     * @returns {string} A string representing the label.
+     */
+    matchLabelFromLabelName(labelName: string): string | number;
+    /**
+     * Return a fully-qualified lineItem resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} line_item
+     * @returns {string} Resource name string.
+     */
+    lineItemPath(networkCode: string, lineItem: string): string;
+    /**
+     * Parse the network_code from LineItem resource.
+     *
+     * @param {string} lineItemName
+     *   A fully-qualified path representing LineItem resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromLineItemName(lineItemName: string): string | number;
+    /**
+     * Parse the line_item from LineItem resource.
+     *
+     * @param {string} lineItemName
+     *   A fully-qualified path representing LineItem resource.
+     * @returns {string} A string representing the line_item.
+     */
+    matchLineItemFromLineItemName(lineItemName: string): string | number;
+    /**
+     * Return a fully-qualified linkedDevice resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} linked_device
+     * @returns {string} Resource name string.
+     */
+    linkedDevicePath(networkCode: string, linkedDevice: string): string;
+    /**
+     * Parse the network_code from LinkedDevice resource.
+     *
+     * @param {string} linkedDeviceName
+     *   A fully-qualified path representing LinkedDevice resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromLinkedDeviceName(linkedDeviceName: string): string | number;
+    /**
+     * Parse the linked_device from LinkedDevice resource.
+     *
+     * @param {string} linkedDeviceName
+     *   A fully-qualified path representing LinkedDevice resource.
+     * @returns {string} A string representing the linked_device.
+     */
+    matchLinkedDeviceFromLinkedDeviceName(linkedDeviceName: string): string | number;
+    /**
+     * Return a fully-qualified liveStreamEvent resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} live_stream_event
+     * @returns {string} Resource name string.
+     */
+    liveStreamEventPath(networkCode: string, liveStreamEvent: string): string;
+    /**
+     * Parse the network_code from LiveStreamEvent resource.
+     *
+     * @param {string} liveStreamEventName
+     *   A fully-qualified path representing LiveStreamEvent resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromLiveStreamEventName(liveStreamEventName: string): string | number;
+    /**
+     * Parse the live_stream_event from LiveStreamEvent resource.
+     *
+     * @param {string} liveStreamEventName
+     *   A fully-qualified path representing LiveStreamEvent resource.
+     * @returns {string} A string representing the live_stream_event.
+     */
+    matchLiveStreamEventFromLiveStreamEventName(liveStreamEventName: string): string | number;
+    /**
+     * Return a fully-qualified mobileCarrier resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} mobile_carrier
+     * @returns {string} Resource name string.
+     */
+    mobileCarrierPath(networkCode: string, mobileCarrier: string): string;
+    /**
+     * Parse the network_code from MobileCarrier resource.
+     *
+     * @param {string} mobileCarrierName
+     *   A fully-qualified path representing MobileCarrier resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromMobileCarrierName(mobileCarrierName: string): string | number;
+    /**
+     * Parse the mobile_carrier from MobileCarrier resource.
+     *
+     * @param {string} mobileCarrierName
+     *   A fully-qualified path representing MobileCarrier resource.
+     * @returns {string} A string representing the mobile_carrier.
+     */
+    matchMobileCarrierFromMobileCarrierName(mobileCarrierName: string): string | number;
+    /**
+     * Return a fully-qualified mobileDevice resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} mobile_device
+     * @returns {string} Resource name string.
+     */
+    mobileDevicePath(networkCode: string, mobileDevice: string): string;
+    /**
+     * Parse the network_code from MobileDevice resource.
+     *
+     * @param {string} mobileDeviceName
+     *   A fully-qualified path representing MobileDevice resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromMobileDeviceName(mobileDeviceName: string): string | number;
+    /**
+     * Parse the mobile_device from MobileDevice resource.
+     *
+     * @param {string} mobileDeviceName
+     *   A fully-qualified path representing MobileDevice resource.
+     * @returns {string} A string representing the mobile_device.
+     */
+    matchMobileDeviceFromMobileDeviceName(mobileDeviceName: string): string | number;
+    /**
+     * Return a fully-qualified mobileDeviceSubmodel resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} mobile_device_submodel
+     * @returns {string} Resource name string.
+     */
+    mobileDeviceSubmodelPath(networkCode: string, mobileDeviceSubmodel: string): string;
+    /**
+     * Parse the network_code from MobileDeviceSubmodel resource.
+     *
+     * @param {string} mobileDeviceSubmodelName
+     *   A fully-qualified path representing MobileDeviceSubmodel resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromMobileDeviceSubmodelName(mobileDeviceSubmodelName: string): string | number;
+    /**
+     * Parse the mobile_device_submodel from MobileDeviceSubmodel resource.
+     *
+     * @param {string} mobileDeviceSubmodelName
+     *   A fully-qualified path representing MobileDeviceSubmodel resource.
+     * @returns {string} A string representing the mobile_device_submodel.
+     */
+    matchMobileDeviceSubmodelFromMobileDeviceSubmodelName(mobileDeviceSubmodelName: string): string | number;
+    /**
+     * Return a fully-qualified network resource name string.
+     *
+     * @param {string} network_code
+     * @returns {string} Resource name string.
+     */
+    networkPath(networkCode: string): string;
+    /**
+     * Parse the network_code from Network resource.
+     *
+     * @param {string} networkName
+     *   A fully-qualified path representing Network resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromNetworkName(networkName: string): string | number;
+    /**
+     * Return a fully-qualified operatingSystem resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} operating_system
+     * @returns {string} Resource name string.
+     */
+    operatingSystemPath(networkCode: string, operatingSystem: string): string;
+    /**
+     * Parse the network_code from OperatingSystem resource.
+     *
+     * @param {string} operatingSystemName
+     *   A fully-qualified path representing OperatingSystem resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromOperatingSystemName(operatingSystemName: string): string | number;
+    /**
+     * Parse the operating_system from OperatingSystem resource.
+     *
+     * @param {string} operatingSystemName
+     *   A fully-qualified path representing OperatingSystem resource.
+     * @returns {string} A string representing the operating_system.
+     */
+    matchOperatingSystemFromOperatingSystemName(operatingSystemName: string): string | number;
+    /**
+     * Return a fully-qualified operatingSystemVersion resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} operating_system_version
+     * @returns {string} Resource name string.
+     */
+    operatingSystemVersionPath(networkCode: string, operatingSystemVersion: string): string;
+    /**
+     * Parse the network_code from OperatingSystemVersion resource.
+     *
+     * @param {string} operatingSystemVersionName
+     *   A fully-qualified path representing OperatingSystemVersion resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromOperatingSystemVersionName(operatingSystemVersionName: string): string | number;
+    /**
+     * Parse the operating_system_version from OperatingSystemVersion resource.
+     *
+     * @param {string} operatingSystemVersionName
+     *   A fully-qualified path representing OperatingSystemVersion resource.
+     * @returns {string} A string representing the operating_system_version.
+     */
+    matchOperatingSystemVersionFromOperatingSystemVersionName(operatingSystemVersionName: string): string | number;
+    /**
+     * Return a fully-qualified order resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} order
+     * @returns {string} Resource name string.
+     */
+    orderPath(networkCode: string, order: string): string;
+    /**
+     * Parse the network_code from Order resource.
+     *
+     * @param {string} orderName
+     *   A fully-qualified path representing Order resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromOrderName(orderName: string): string | number;
+    /**
+     * Parse the order from Order resource.
+     *
+     * @param {string} orderName
+     *   A fully-qualified path representing Order resource.
+     * @returns {string} A string representing the order.
+     */
+    matchOrderFromOrderName(orderName: string): string | number;
+    /**
+     * Return a fully-qualified placement resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} placement
+     * @returns {string} Resource name string.
+     */
+    placementPath(networkCode: string, placement: string): string;
+    /**
+     * Parse the network_code from Placement resource.
+     *
+     * @param {string} placementName
+     *   A fully-qualified path representing Placement resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromPlacementName(placementName: string): string | number;
+    /**
+     * Parse the placement from Placement resource.
+     *
+     * @param {string} placementName
+     *   A fully-qualified path representing Placement resource.
+     * @returns {string} A string representing the placement.
+     */
+    matchPlacementFromPlacementName(placementName: string): string | number;
+    /**
+     * Return a fully-qualified privateAuction resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} private_auction
+     * @returns {string} Resource name string.
+     */
+    privateAuctionPath(networkCode: string, privateAuction: string): string;
+    /**
+     * Parse the network_code from PrivateAuction resource.
+     *
+     * @param {string} privateAuctionName
+     *   A fully-qualified path representing PrivateAuction resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromPrivateAuctionName(privateAuctionName: string): string | number;
+    /**
+     * Parse the private_auction from PrivateAuction resource.
+     *
+     * @param {string} privateAuctionName
+     *   A fully-qualified path representing PrivateAuction resource.
+     * @returns {string} A string representing the private_auction.
+     */
+    matchPrivateAuctionFromPrivateAuctionName(privateAuctionName: string): string | number;
+    /**
+     * Return a fully-qualified privateAuctionDeal resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} private_auction_deal
+     * @returns {string} Resource name string.
+     */
+    privateAuctionDealPath(networkCode: string, privateAuctionDeal: string): string;
+    /**
+     * Parse the network_code from PrivateAuctionDeal resource.
+     *
+     * @param {string} privateAuctionDealName
+     *   A fully-qualified path representing PrivateAuctionDeal resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromPrivateAuctionDealName(privateAuctionDealName: string): string | number;
+    /**
+     * Parse the private_auction_deal from PrivateAuctionDeal resource.
+     *
+     * @param {string} privateAuctionDealName
+     *   A fully-qualified path representing PrivateAuctionDeal resource.
+     * @returns {string} A string representing the private_auction_deal.
+     */
+    matchPrivateAuctionDealFromPrivateAuctionDealName(privateAuctionDealName: string): string | number;
+    /**
+     * Return a fully-qualified programmaticBuyer resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} programmatic_buyer
+     * @returns {string} Resource name string.
+     */
+    programmaticBuyerPath(networkCode: string, programmaticBuyer: string): string;
+    /**
+     * Parse the network_code from ProgrammaticBuyer resource.
+     *
+     * @param {string} programmaticBuyerName
+     *   A fully-qualified path representing ProgrammaticBuyer resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromProgrammaticBuyerName(programmaticBuyerName: string): string | number;
+    /**
+     * Parse the programmatic_buyer from ProgrammaticBuyer resource.
+     *
+     * @param {string} programmaticBuyerName
+     *   A fully-qualified path representing ProgrammaticBuyer resource.
+     * @returns {string} A string representing the programmatic_buyer.
+     */
+    matchProgrammaticBuyerFromProgrammaticBuyerName(programmaticBuyerName: string): string | number;
+    /**
+     * Return a fully-qualified report resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} report
+     * @returns {string} Resource name string.
+     */
+    reportPath(networkCode: string, report: string): string;
+    /**
+     * Parse the network_code from Report resource.
+     *
+     * @param {string} reportName
+     *   A fully-qualified path representing Report resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromReportName(reportName: string): string | number;
+    /**
+     * Parse the report from Report resource.
+     *
+     * @param {string} reportName
+     *   A fully-qualified path representing Report resource.
+     * @returns {string} A string representing the report.
+     */
+    matchReportFromReportName(reportName: string): string | number;
+    /**
+     * Return a fully-qualified richMediaAdsCompany resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} rich_media_ads_company
+     * @returns {string} Resource name string.
+     */
+    richMediaAdsCompanyPath(networkCode: string, richMediaAdsCompany: string): string;
+    /**
+     * Parse the network_code from RichMediaAdsCompany resource.
+     *
+     * @param {string} richMediaAdsCompanyName
+     *   A fully-qualified path representing RichMediaAdsCompany resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromRichMediaAdsCompanyName(richMediaAdsCompanyName: string): string | number;
+    /**
+     * Parse the rich_media_ads_company from RichMediaAdsCompany resource.
+     *
+     * @param {string} richMediaAdsCompanyName
+     *   A fully-qualified path representing RichMediaAdsCompany resource.
+     * @returns {string} A string representing the rich_media_ads_company.
+     */
+    matchRichMediaAdsCompanyFromRichMediaAdsCompanyName(richMediaAdsCompanyName: string): string | number;
+    /**
+     * Return a fully-qualified role resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} role
+     * @returns {string} Resource name string.
+     */
+    rolePath(networkCode: string, role: string): string;
+    /**
+     * Parse the network_code from Role resource.
+     *
+     * @param {string} roleName
+     *   A fully-qualified path representing Role resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromRoleName(roleName: string): string | number;
+    /**
+     * Parse the role from Role resource.
+     *
+     * @param {string} roleName
+     *   A fully-qualified path representing Role resource.
+     * @returns {string} A string representing the role.
+     */
+    matchRoleFromRoleName(roleName: string): string | number;
+    /**
+     * Return a fully-qualified site resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} site
+     * @returns {string} Resource name string.
+     */
+    sitePath(networkCode: string, site: string): string;
+    /**
+     * Parse the network_code from Site resource.
+     *
+     * @param {string} siteName
+     *   A fully-qualified path representing Site resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromSiteName(siteName: string): string | number;
+    /**
+     * Parse the site from Site resource.
+     *
+     * @param {string} siteName
+     *   A fully-qualified path representing Site resource.
+     * @returns {string} A string representing the site.
+     */
+    matchSiteFromSiteName(siteName: string): string | number;
+    /**
+     * Return a fully-qualified taxonomyCategory resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} taxonomy_category
+     * @returns {string} Resource name string.
+     */
+    taxonomyCategoryPath(networkCode: string, taxonomyCategory: string): string;
+    /**
+     * Parse the network_code from TaxonomyCategory resource.
+     *
+     * @param {string} taxonomyCategoryName
+     *   A fully-qualified path representing TaxonomyCategory resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromTaxonomyCategoryName(taxonomyCategoryName: string): string | number;
+    /**
+     * Parse the taxonomy_category from TaxonomyCategory resource.
+     *
+     * @param {string} taxonomyCategoryName
+     *   A fully-qualified path representing TaxonomyCategory resource.
+     * @returns {string} A string representing the taxonomy_category.
+     */
+    matchTaxonomyCategoryFromTaxonomyCategoryName(taxonomyCategoryName: string): string | number;
+    /**
+     * Return a fully-qualified team resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} team
+     * @returns {string} Resource name string.
+     */
+    teamPath(networkCode: string, team: string): string;
+    /**
+     * Parse the network_code from Team resource.
+     *
+     * @param {string} teamName
+     *   A fully-qualified path representing Team resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromTeamName(teamName: string): string | number;
+    /**
+     * Parse the team from Team resource.
+     *
+     * @param {string} teamName
+     *   A fully-qualified path representing Team resource.
+     * @returns {string} A string representing the team.
+     */
+    matchTeamFromTeamName(teamName: string): string | number;
+    /**
+     * Return a fully-qualified user resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} user
+     * @returns {string} Resource name string.
+     */
+    userPath(networkCode: string, user: string): string;
+    /**
+     * Parse the network_code from User resource.
+     *
+     * @param {string} userName
+     *   A fully-qualified path representing User resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromUserName(userName: string): string | number;
+    /**
+     * Parse the user from User resource.
+     *
+     * @param {string} userName
+     *   A fully-qualified path representing User resource.
+     * @returns {string} A string representing the user.
+     */
+    matchUserFromUserName(userName: string): string | number;
+    /**
+     * Return a fully-qualified webProperty resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} web_property
+     * @returns {string} Resource name string.
+     */
+    webPropertyPath(networkCode: string, webProperty: string): string;
+    /**
+     * Parse the network_code from WebProperty resource.
+     *
+     * @param {string} webPropertyName
+     *   A fully-qualified path representing WebProperty resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromWebPropertyName(webPropertyName: string): string | number;
+    /**
+     * Parse the web_property from WebProperty resource.
+     *
+     * @param {string} webPropertyName
+     *   A fully-qualified path representing WebProperty resource.
+     * @returns {string} A string representing the web_property.
+     */
+    matchWebPropertyFromWebPropertyName(webPropertyName: string): string | number;
+    /**
+     * Terminate the gRPC channel and close the client.
+     *
+     * The client will no longer be usable and all future behavior is undefined.
+     * @returns {Promise} A promise that resolves when the client is closed.
+     */
+    close(): Promise<void>;
+}