@google-ads/admanager/build/src/v1/ad_review_center_ad_service_client.d.ts

Google Ad Manager API client for Node.js

import type * as gax from 'google-gax';
import type { Callback, CallOptions, Descriptors, ClientOptions, LROperation, PaginationCallback } from 'google-gax';
import { Transform } from 'stream';
import * as protos from '../../protos/protos';
/**
 *  Provides methods for handling AdReviewCenterAd objects.
 * @class
 * @memberof v1
 */
export declare class AdReviewCenterAdServiceClient {
    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;
    };
    operationsClient: gax.OperationsClient;
    adReviewCenterAdServiceStub?: Promise<{
        [name: string]: Function;
    }>;
    /**
     * Construct an instance of AdReviewCenterAdServiceClient.
     *
     * @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 AdReviewCenterAdServiceClient({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 batch allow AdReviewCenterAds.
     * This method supports partial success. Some operations may succeed while
     * others fail. Callers should check the failedRequests field in the response
     * to determine which operations failed.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.parent
     *   Required. The parent, which owns this collection of AdReviewCenterAds.
     *   Format: networks/{network_code}/webProperties/{web_property_code}
     *
     *   Since a network can only have a single web property of each
     *   `ExchangeSyndicationProduct`, you can use the
     *   `ExchangeSyndicationProduct` as an alias for the web property code:
     *
     *   `networks/{network_code}/webProperties/display`
     *
     *   `networks/{network_code}/webProperties/videoAndAudio`
     *
     *   `networks/{network_code}/webProperties/mobileApp`
     *
     *   `networks/{network_code}/webProperties/games`
     * @param {string[]} request.names
     *   Required. The resource names of the `AdReviewCenterAd`s to allow.
     *   Format:
     *   `networks/{network_code}/webProperties/{web_property_code}/adReviewCenterAds/{ad_review_center_ad_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
     *   a long running operation. Its `promise()` method returns a promise
     *   you can `await` for.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v1/ad_review_center_ad_service.batch_allow_ad_review_center_ads.js</caption>
     * region_tag:admanager_v1_generated_AdReviewCenterAdService_BatchAllowAdReviewCenterAds_async
     */
    batchAllowAdReviewCenterAds(request?: protos.google.ads.admanager.v1.IBatchAllowAdReviewCenterAdsRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.ads.admanager.v1.IBatchAllowAdReviewCenterAdsResponse, protos.google.ads.admanager.v1.IBatchAdReviewCenterAdsOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
    batchAllowAdReviewCenterAds(request: protos.google.ads.admanager.v1.IBatchAllowAdReviewCenterAdsRequest, options: CallOptions, callback: Callback<LROperation<protos.google.ads.admanager.v1.IBatchAllowAdReviewCenterAdsResponse, protos.google.ads.admanager.v1.IBatchAdReviewCenterAdsOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    batchAllowAdReviewCenterAds(request: protos.google.ads.admanager.v1.IBatchAllowAdReviewCenterAdsRequest, callback: Callback<LROperation<protos.google.ads.admanager.v1.IBatchAllowAdReviewCenterAdsResponse, protos.google.ads.admanager.v1.IBatchAdReviewCenterAdsOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    /**
     * Check the status of the long running operation returned by `batchAllowAdReviewCenterAds()`.
     * @param {String} name
     *   The operation name that will be passed.
     * @returns {Promise} - The promise which resolves to an object.
     *   The decoded operation object has result and metadata field to get information from.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v1/ad_review_center_ad_service.batch_allow_ad_review_center_ads.js</caption>
     * region_tag:admanager_v1_generated_AdReviewCenterAdService_BatchAllowAdReviewCenterAds_async
     */
    checkBatchAllowAdReviewCenterAdsProgress(name: string): Promise<LROperation<protos.google.ads.admanager.v1.BatchAllowAdReviewCenterAdsResponse, protos.google.ads.admanager.v1.BatchAdReviewCenterAdsOperationMetadata>>;
    /**
     * API to batch block AdReviewCenterAds.
     * This method supports partial success. Some operations may succeed while
     * others fail. Callers should check the failedRequests field in the response
     * to determine which operations failed.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.parent
     *   Required. The parent, which owns this collection of AdReviewCenterAds.
     *   Format: networks/{network_code}/webProperties/{web_property_code}
     *
     *   Since a network can only have a single web property of each
     *   `ExchangeSyndicationProduct`, you can use the
     *   `ExchangeSyndicationProduct` as an alias for the web property code:
     *
     *   `networks/{network_code}/webProperties/display`
     *
     *   `networks/{network_code}/webProperties/videoAndAudio`
     *
     *   `networks/{network_code}/webProperties/mobileApp`
     *
     *   `networks/{network_code}/webProperties/games`
     * @param {string[]} request.names
     *   Required. The resource names of the `AdReviewCenterAd`s to block.
     *   Format:
     *   `networks/{network_code}/webProperties/{web_property_code}/adReviewCenterAds/{ad_review_center_ad_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
     *   a long running operation. Its `promise()` method returns a promise
     *   you can `await` for.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v1/ad_review_center_ad_service.batch_block_ad_review_center_ads.js</caption>
     * region_tag:admanager_v1_generated_AdReviewCenterAdService_BatchBlockAdReviewCenterAds_async
     */
    batchBlockAdReviewCenterAds(request?: protos.google.ads.admanager.v1.IBatchBlockAdReviewCenterAdsRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.ads.admanager.v1.IBatchBlockAdReviewCenterAdsResponse, protos.google.ads.admanager.v1.IBatchAdReviewCenterAdsOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
    batchBlockAdReviewCenterAds(request: protos.google.ads.admanager.v1.IBatchBlockAdReviewCenterAdsRequest, options: CallOptions, callback: Callback<LROperation<protos.google.ads.admanager.v1.IBatchBlockAdReviewCenterAdsResponse, protos.google.ads.admanager.v1.IBatchAdReviewCenterAdsOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    batchBlockAdReviewCenterAds(request: protos.google.ads.admanager.v1.IBatchBlockAdReviewCenterAdsRequest, callback: Callback<LROperation<protos.google.ads.admanager.v1.IBatchBlockAdReviewCenterAdsResponse, protos.google.ads.admanager.v1.IBatchAdReviewCenterAdsOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    /**
     * Check the status of the long running operation returned by `batchBlockAdReviewCenterAds()`.
     * @param {String} name
     *   The operation name that will be passed.
     * @returns {Promise} - The promise which resolves to an object.
     *   The decoded operation object has result and metadata field to get information from.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v1/ad_review_center_ad_service.batch_block_ad_review_center_ads.js</caption>
     * region_tag:admanager_v1_generated_AdReviewCenterAdService_BatchBlockAdReviewCenterAds_async
     */
    checkBatchBlockAdReviewCenterAdsProgress(name: string): Promise<LROperation<protos.google.ads.admanager.v1.BatchBlockAdReviewCenterAdsResponse, protos.google.ads.admanager.v1.BatchAdReviewCenterAdsOperationMetadata>>;
    /**
    * API to search for AdReviewCenterAds.
    *
    * @param {Object} request
    *   The request object that will be sent.
    * @param {string} request.parent
    *   Required. The parent, which owns this collection of AdReviewCenterAds.
    *   Format: networks/{network_code}/webProperties/{web_property_code}
    *
    *   Since a network can only have a single web property of each
    *   `ExchangeSyndicationProduct`, you can use the
    *   `ExchangeSyndicationProduct` as an alias for the web property code:
    *
    *   `networks/{network_code}/webProperties/display`
    *
    *   `networks/{network_code}/webProperties/videoAndAudio`
    *
    *   `networks/{network_code}/webProperties/mobileApp`
    *
    *   `networks/{network_code}/webProperties/games`
    * @param {number} [request.pageSize]
    *   Optional. The maximum number of AdReviewCenterAds to return. The service
    *   may return fewer than this value. If unspecified, at most 50
    *   AdReviewCenterAds will be returned. The maximum value is 1000; values
    *   greater than 1000 will be coerced to 1000.
    * @param {string} [request.pageToken]
    *   Optional. The page token to fetch the next page of AdReviewCenterAds. This
    *   is the value returned from a previous Search request, or empty.
    * @param {google.ads.admanager.v1.AdReviewCenterAdStatusEnum.AdReviewCenterAdStatus} [request.status]
    *   Optional. Only return ads with the given status.
    * @param {string[]} [request.adReviewCenterAdId]
    *   Optional. Only return ads with the given AdReviewCenterAd IDs. If provided,
    *   no other filter can be set (other than page size and page token).
    * @param {google.type.Interval} [request.dateTimeRange]
    *   Optional. If provided, only return ads that served within the given date
    *   range (inclusive). The  date range must be within the last 30 days. If not
    *   provided, the date range will be the last 30 days.
    * @param {string[]} [request.searchText]
    *   Optional. If provided, restrict the search to AdReviewCenterAds associated
    *   with the text (including any text on the ad or in the destination URL). If
    *   more than one value is provided, the search will combine them in a logical
    *   AND. For example, ['car', 'blue'] will match ads that contain both "car"
    *   and "blue", but not an ad that only contains "car".
    * @param {number[]} [request.buyerAccountId]
    *   Optional. If provided, restrict the search to creatives belonging to one of
    *   the given Adx buyer account IDs. Only applicable to RTB creatives. Adx
    *   buyer account IDs can be found via the ProgrammaticBuyerService.
    * @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.AdReviewCenterAd|AdReviewCenterAd}.
    *   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 `searchAdReviewCenterAdsAsync()`
    *   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.
    */
    searchAdReviewCenterAds(request?: protos.google.ads.admanager.v1.ISearchAdReviewCenterAdsRequest, options?: CallOptions): Promise<[
        protos.google.ads.admanager.v1.IAdReviewCenterAd[],
        protos.google.ads.admanager.v1.ISearchAdReviewCenterAdsRequest | null,
        protos.google.ads.admanager.v1.ISearchAdReviewCenterAdsResponse
    ]>;
    searchAdReviewCenterAds(request: protos.google.ads.admanager.v1.ISearchAdReviewCenterAdsRequest, options: CallOptions, callback: PaginationCallback<protos.google.ads.admanager.v1.ISearchAdReviewCenterAdsRequest, protos.google.ads.admanager.v1.ISearchAdReviewCenterAdsResponse | null | undefined, protos.google.ads.admanager.v1.IAdReviewCenterAd>): void;
    searchAdReviewCenterAds(request: protos.google.ads.admanager.v1.ISearchAdReviewCenterAdsRequest, callback: PaginationCallback<protos.google.ads.admanager.v1.ISearchAdReviewCenterAdsRequest, protos.google.ads.admanager.v1.ISearchAdReviewCenterAdsResponse | null | undefined, protos.google.ads.admanager.v1.IAdReviewCenterAd>): void;
    /**
     * Equivalent to `searchAdReviewCenterAds`, 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 AdReviewCenterAds.
     *   Format: networks/{network_code}/webProperties/{web_property_code}
     *
     *   Since a network can only have a single web property of each
     *   `ExchangeSyndicationProduct`, you can use the
     *   `ExchangeSyndicationProduct` as an alias for the web property code:
     *
     *   `networks/{network_code}/webProperties/display`
     *
     *   `networks/{network_code}/webProperties/videoAndAudio`
     *
     *   `networks/{network_code}/webProperties/mobileApp`
     *
     *   `networks/{network_code}/webProperties/games`
     * @param {number} [request.pageSize]
     *   Optional. The maximum number of AdReviewCenterAds to return. The service
     *   may return fewer than this value. If unspecified, at most 50
     *   AdReviewCenterAds will be returned. The maximum value is 1000; values
     *   greater than 1000 will be coerced to 1000.
     * @param {string} [request.pageToken]
     *   Optional. The page token to fetch the next page of AdReviewCenterAds. This
     *   is the value returned from a previous Search request, or empty.
     * @param {google.ads.admanager.v1.AdReviewCenterAdStatusEnum.AdReviewCenterAdStatus} [request.status]
     *   Optional. Only return ads with the given status.
     * @param {string[]} [request.adReviewCenterAdId]
     *   Optional. Only return ads with the given AdReviewCenterAd IDs. If provided,
     *   no other filter can be set (other than page size and page token).
     * @param {google.type.Interval} [request.dateTimeRange]
     *   Optional. If provided, only return ads that served within the given date
     *   range (inclusive). The  date range must be within the last 30 days. If not
     *   provided, the date range will be the last 30 days.
     * @param {string[]} [request.searchText]
     *   Optional. If provided, restrict the search to AdReviewCenterAds associated
     *   with the text (including any text on the ad or in the destination URL). If
     *   more than one value is provided, the search will combine them in a logical
     *   AND. For example, ['car', 'blue'] will match ads that contain both "car"
     *   and "blue", but not an ad that only contains "car".
     * @param {number[]} [request.buyerAccountId]
     *   Optional. If provided, restrict the search to creatives belonging to one of
     *   the given Adx buyer account IDs. Only applicable to RTB creatives. Adx
     *   buyer account IDs can be found via the ProgrammaticBuyerService.
     * @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.AdReviewCenterAd|AdReviewCenterAd} 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 `searchAdReviewCenterAdsAsync()`
     *   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.
     */
    searchAdReviewCenterAdsStream(request?: protos.google.ads.admanager.v1.ISearchAdReviewCenterAdsRequest, options?: CallOptions): Transform;
    /**
     * Equivalent to `searchAdReviewCenterAds`, 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 AdReviewCenterAds.
     *   Format: networks/{network_code}/webProperties/{web_property_code}
     *
     *   Since a network can only have a single web property of each
     *   `ExchangeSyndicationProduct`, you can use the
     *   `ExchangeSyndicationProduct` as an alias for the web property code:
     *
     *   `networks/{network_code}/webProperties/display`
     *
     *   `networks/{network_code}/webProperties/videoAndAudio`
     *
     *   `networks/{network_code}/webProperties/mobileApp`
     *
     *   `networks/{network_code}/webProperties/games`
     * @param {number} [request.pageSize]
     *   Optional. The maximum number of AdReviewCenterAds to return. The service
     *   may return fewer than this value. If unspecified, at most 50
     *   AdReviewCenterAds will be returned. The maximum value is 1000; values
     *   greater than 1000 will be coerced to 1000.
     * @param {string} [request.pageToken]
     *   Optional. The page token to fetch the next page of AdReviewCenterAds. This
     *   is the value returned from a previous Search request, or empty.
     * @param {google.ads.admanager.v1.AdReviewCenterAdStatusEnum.AdReviewCenterAdStatus} [request.status]
     *   Optional. Only return ads with the given status.
     * @param {string[]} [request.adReviewCenterAdId]
     *   Optional. Only return ads with the given AdReviewCenterAd IDs. If provided,
     *   no other filter can be set (other than page size and page token).
     * @param {google.type.Interval} [request.dateTimeRange]
     *   Optional. If provided, only return ads that served within the given date
     *   range (inclusive). The  date range must be within the last 30 days. If not
     *   provided, the date range will be the last 30 days.
     * @param {string[]} [request.searchText]
     *   Optional. If provided, restrict the search to AdReviewCenterAds associated
     *   with the text (including any text on the ad or in the destination URL). If
     *   more than one value is provided, the search will combine them in a logical
     *   AND. For example, ['car', 'blue'] will match ads that contain both "car"
     *   and "blue", but not an ad that only contains "car".
     * @param {number[]} [request.buyerAccountId]
     *   Optional. If provided, restrict the search to creatives belonging to one of
     *   the given Adx buyer account IDs. Only applicable to RTB creatives. Adx
     *   buyer account IDs can be found via the ProgrammaticBuyerService.
     * @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.AdReviewCenterAd|AdReviewCenterAd}. 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/ad_review_center_ad_service.search_ad_review_center_ads.js</caption>
     * region_tag:admanager_v1_generated_AdReviewCenterAdService_SearchAdReviewCenterAds_async
     */
    searchAdReviewCenterAdsAsync(request?: protos.google.ads.admanager.v1.ISearchAdReviewCenterAdsRequest, options?: CallOptions): AsyncIterable<protos.google.ads.admanager.v1.IAdReviewCenterAd>;
    /**
       * Gets the latest state of a long-running operation.  Clients can use this
       * method to poll the operation result at intervals as recommended by the API
       * service.
       *
       * @param {Object} request - The request object that will be sent.
       * @param {string} request.name - The name of the operation resource.
       * @param {Object=} options
       *   Optional parameters. You can override the default settings for this call,
       *   e.g, timeout, retries, paginations, etc. See {@link
       *   https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
       *   for the details.
       * @param {function(?Error, ?Object)=} callback
       *   The function which will be called with the result of the API call.
       *
       *   The second parameter to the callback is an object representing
       *   {@link google.longrunning.Operation | google.longrunning.Operation}.
       * @return {Promise} - The promise which resolves to an array.
       *   The first element of the array is an object representing
       * {@link google.longrunning.Operation | google.longrunning.Operation}.
       * The promise has a method named "cancel" which cancels the ongoing API call.
       *
       * @example
       * ```
       * const client = longrunning.operationsClient();
       * const name = '';
       * const [response] = await client.getOperation({name});
       * // doThingsWith(response)
       * ```
       */
    getOperation(request: protos.google.longrunning.GetOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>): Promise<[protos.google.longrunning.Operation]>;
    /**
     * Lists operations that match the specified filter in the request. If the
     * server doesn't support this method, it returns `UNIMPLEMENTED`. Returns an iterable object.
     *
     * For-await-of syntax is used with the iterable to recursively get response element on-demand.
     *
     * @param {Object} request - The request object that will be sent.
     * @param {string} request.name - The name of the operation collection.
     * @param {string} request.filter - The standard list filter.
     * @param {number=} request.pageSize -
     *   The maximum number of resources contained in the underlying API
     *   response. If page streaming is performed per-resource, this
     *   parameter does not affect the return value. If page streaming is
     *   performed per-page, this determines the maximum number of
     *   resources in a page.
     * @param {Object=} options
     *   Optional parameters. You can override the default settings for this call,
     *   e.g, timeout, retries, paginations, etc. See {@link
     *   https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} for the
     *   details.
     * @returns {Object}
     *   An iterable Object that conforms to {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | iteration protocols}.
     *
     * @example
     * ```
     * const client = longrunning.operationsClient();
     * for await (const response of client.listOperationsAsync(request));
     * // doThingsWith(response)
     * ```
     */
    listOperationsAsync(request: protos.google.longrunning.ListOperationsRequest, options?: gax.CallOptions): AsyncIterable<protos.google.longrunning.IOperation>;
    /**
     * Starts asynchronous cancellation on a long-running operation.  The server
     * makes a best effort to cancel the operation, but success is not
     * guaranteed.  If the server doesn't support this method, it returns
     * `google.rpc.Code.UNIMPLEMENTED`.  Clients can use
     * {@link Operations.GetOperation} or
     * other methods to check whether the cancellation succeeded or whether the
     * operation completed despite cancellation. On successful cancellation,
     * the operation is not deleted; instead, it becomes an operation with
     * an {@link Operation.error} value with a {@link google.rpc.Status.code} of
     * 1, corresponding to `Code.CANCELLED`.
     *
     * @param {Object} request - The request object that will be sent.
     * @param {string} request.name - The name of the operation resource to be cancelled.
     * @param {Object=} options
     *   Optional parameters. You can override the default settings for this call,
     * e.g, timeout, retries, paginations, etc. See {@link
     * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} for the
     * details.
     * @param {function(?Error)=} callback
     *   The function which will be called with the result of the API call.
     * @return {Promise} - The promise which resolves when API call finishes.
     *   The promise has a method named "cancel" which cancels the ongoing API
     * call.
     *
     * @example
     * ```
     * const client = longrunning.operationsClient();
     * await client.cancelOperation({name: ''});
     * ```
     */
    cancelOperation(request: protos.google.longrunning.CancelOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>, callback?: Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>): Promise<protos.google.protobuf.Empty>;
    /**
     * Deletes a long-running operation. This method indicates that the client is
     * no longer interested in the operation result. It does not cancel the
     * operation. If the server doesn't support this method, it returns
     * `google.rpc.Code.UNIMPLEMENTED`.
     *
     * @param {Object} request - The request object that will be sent.
     * @param {string} request.name - The name of the operation resource to be deleted.
     * @param {Object=} options
     *   Optional parameters. You can override the default settings for this call,
     * e.g, timeout, retries, paginations, etc. See {@link
     * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
     * for the details.
     * @param {function(?Error)=} callback
     *   The function which will be called with the result of the API call.
     * @return {Promise} - The promise which resolves when API call finishes.
     *   The promise has a method named "cancel" which cancels the ongoing API
     * call.
     *
     * @example
     * ```
     * const client = longrunning.operationsClient();
     * await client.deleteOperation({name: ''});
     * ```
     */
    deleteOperation(request: protos.google.longrunning.DeleteOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>): Promise<protos.google.protobuf.Empty>;
    /**
     * 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 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 ful