@google-ads/admanager/build/src/v1/site_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, PaginationCallback } from 'google-gax';
import { Transform } from 'stream';
import * as protos from '../../protos/protos';
/**
 *  Provides methods for handling `Site` objects.
 * @class
 * @memberof v1
 */
export declare class SiteServiceClient {
    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;
    };
    siteServiceStub?: Promise<{
        [name: string]: Function;
    }>;
    /**
     * Construct an instance of SiteServiceClient.
     *
     * @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 SiteServiceClient({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 `Site` object.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. The resource name of the Site.
     *   Format: `networks/{network_code}/sites/{site_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.Site|Site}.
     *   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/site_service.get_site.js</caption>
     * region_tag:admanager_v1_generated_SiteService_GetSite_async
     */
    getSite(request?: protos.google.ads.admanager.v1.IGetSiteRequest, options?: CallOptions): Promise<[
        protos.google.ads.admanager.v1.ISite,
        protos.google.ads.admanager.v1.IGetSiteRequest | undefined,
        {} | undefined
    ]>;
    getSite(request: protos.google.ads.admanager.v1.IGetSiteRequest, options: CallOptions, callback: Callback<protos.google.ads.admanager.v1.ISite, protos.google.ads.admanager.v1.IGetSiteRequest | null | undefined, {} | null | undefined>): void;
    getSite(request: protos.google.ads.admanager.v1.IGetSiteRequest, callback: Callback<protos.google.ads.admanager.v1.ISite, protos.google.ads.admanager.v1.IGetSiteRequest | null | undefined, {} | null | undefined>): void;
    /**
     * API to create a `Site` object.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.parent
     *   Required. The parent resource where this `Site` will be created.
     *   Format: `networks/{network_code}`
     * @param {google.ads.admanager.v1.Site} request.site
     *   Required. The `Site` 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.Site|Site}.
     *   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/site_service.create_site.js</caption>
     * region_tag:admanager_v1_generated_SiteService_CreateSite_async
     */
    createSite(request?: protos.google.ads.admanager.v1.ICreateSiteRequest, options?: CallOptions): Promise<[
        protos.google.ads.admanager.v1.ISite,
        protos.google.ads.admanager.v1.ICreateSiteRequest | undefined,
        {} | undefined
    ]>;
    createSite(request: protos.google.ads.admanager.v1.ICreateSiteRequest, options: CallOptions, callback: Callback<protos.google.ads.admanager.v1.ISite, protos.google.ads.admanager.v1.ICreateSiteRequest | null | undefined, {} | null | undefined>): void;
    createSite(request: protos.google.ads.admanager.v1.ICreateSiteRequest, callback: Callback<protos.google.ads.admanager.v1.ISite, protos.google.ads.admanager.v1.ICreateSiteRequest | null | undefined, {} | null | undefined>): void;
    /**
     * API to batch create `Site` objects.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.parent
     *   Required. The parent resource where `Sites` will be created.
     *   Format: `networks/{network_code}`
     *   The parent field in the CreateSiteRequest must match this
     *   field.
     * @param {number[]} request.requests
     *   Required. The `Site` 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.BatchCreateSitesResponse|BatchCreateSitesResponse}.
     *   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/site_service.batch_create_sites.js</caption>
     * region_tag:admanager_v1_generated_SiteService_BatchCreateSites_async
     */
    batchCreateSites(request?: protos.google.ads.admanager.v1.IBatchCreateSitesRequest, options?: CallOptions): Promise<[
        protos.google.ads.admanager.v1.IBatchCreateSitesResponse,
        protos.google.ads.admanager.v1.IBatchCreateSitesRequest | undefined,
        {} | undefined
    ]>;
    batchCreateSites(request: protos.google.ads.admanager.v1.IBatchCreateSitesRequest, options: CallOptions, callback: Callback<protos.google.ads.admanager.v1.IBatchCreateSitesResponse, protos.google.ads.admanager.v1.IBatchCreateSitesRequest | null | undefined, {} | null | undefined>): void;
    batchCreateSites(request: protos.google.ads.admanager.v1.IBatchCreateSitesRequest, callback: Callback<protos.google.ads.admanager.v1.IBatchCreateSitesResponse, protos.google.ads.admanager.v1.IBatchCreateSitesRequest | null | undefined, {} | null | undefined>): void;
    /**
     * API to update a `Site` object.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {google.ads.admanager.v1.Site} request.site
     *   Required. The `Site` to update.
     *
     *   The `Site`'s `name` is used to identify the `Site` to update.
     * @param {google.protobuf.FieldMask} request.updateMask
     *   Required. 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.Site|Site}.
     *   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/site_service.update_site.js</caption>
     * region_tag:admanager_v1_generated_SiteService_UpdateSite_async
     */
    updateSite(request?: protos.google.ads.admanager.v1.IUpdateSiteRequest, options?: CallOptions): Promise<[
        protos.google.ads.admanager.v1.ISite,
        protos.google.ads.admanager.v1.IUpdateSiteRequest | undefined,
        {} | undefined
    ]>;
    updateSite(request: protos.google.ads.admanager.v1.IUpdateSiteRequest, options: CallOptions, callback: Callback<protos.google.ads.admanager.v1.ISite, protos.google.ads.admanager.v1.IUpdateSiteRequest | null | undefined, {} | null | undefined>): void;
    updateSite(request: protos.google.ads.admanager.v1.IUpdateSiteRequest, callback: Callback<protos.google.ads.admanager.v1.ISite, protos.google.ads.admanager.v1.IUpdateSiteRequest | null | undefined, {} | null | undefined>): void;
    /**
     * API to batch update `Site` objects.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.parent
     *   Required. The parent resource where `Sites` will be updated.
     *   Format: `networks/{network_code}`
     *   The parent field in the UpdateSiteRequest must match this
     *   field.
     * @param {number[]} request.requests
     *   Required. The `Site` 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.BatchUpdateSitesResponse|BatchUpdateSitesResponse}.
     *   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/site_service.batch_update_sites.js</caption>
     * region_tag:admanager_v1_generated_SiteService_BatchUpdateSites_async
     */
    batchUpdateSites(request?: protos.google.ads.admanager.v1.IBatchUpdateSitesRequest, options?: CallOptions): Promise<[
        protos.google.ads.admanager.v1.IBatchUpdateSitesResponse,
        protos.google.ads.admanager.v1.IBatchUpdateSitesRequest | undefined,
        {} | undefined
    ]>;
    batchUpdateSites(request: protos.google.ads.admanager.v1.IBatchUpdateSitesRequest, options: CallOptions, callback: Callback<protos.google.ads.admanager.v1.IBatchUpdateSitesResponse, protos.google.ads.admanager.v1.IBatchUpdateSitesRequest | null | undefined, {} | null | undefined>): void;
    batchUpdateSites(request: protos.google.ads.admanager.v1.IBatchUpdateSitesRequest, callback: Callback<protos.google.ads.admanager.v1.IBatchUpdateSitesResponse, protos.google.ads.admanager.v1.IBatchUpdateSitesRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Deactivates a list of `Site` 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. The resource names of the `Site` objects to deactivate.
     * @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.BatchDeactivateSitesResponse|BatchDeactivateSitesResponse}.
     *   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/site_service.batch_deactivate_sites.js</caption>
     * region_tag:admanager_v1_generated_SiteService_BatchDeactivateSites_async
     */
    batchDeactivateSites(request?: protos.google.ads.admanager.v1.IBatchDeactivateSitesRequest, options?: CallOptions): Promise<[
        protos.google.ads.admanager.v1.IBatchDeactivateSitesResponse,
        protos.google.ads.admanager.v1.IBatchDeactivateSitesRequest | undefined,
        {} | undefined
    ]>;
    batchDeactivateSites(request: protos.google.ads.admanager.v1.IBatchDeactivateSitesRequest, options: CallOptions, callback: Callback<protos.google.ads.admanager.v1.IBatchDeactivateSitesResponse, protos.google.ads.admanager.v1.IBatchDeactivateSitesRequest | null | undefined, {} | null | undefined>): void;
    batchDeactivateSites(request: protos.google.ads.admanager.v1.IBatchDeactivateSitesRequest, callback: Callback<protos.google.ads.admanager.v1.IBatchDeactivateSitesResponse, protos.google.ads.admanager.v1.IBatchDeactivateSitesRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Submits a list of `Site` objects for approval.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.parent
     *   Required. Format: `networks/{network_code}`
     * @param {string[]} request.names
     *   Required. The resource names of the `Site` objects to submit for approval.
     * @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.BatchSubmitSitesForApprovalResponse|BatchSubmitSitesForApprovalResponse}.
     *   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/site_service.batch_submit_sites_for_approval.js</caption>
     * region_tag:admanager_v1_generated_SiteService_BatchSubmitSitesForApproval_async
     */
    batchSubmitSitesForApproval(request?: protos.google.ads.admanager.v1.IBatchSubmitSitesForApprovalRequest, options?: CallOptions): Promise<[
        protos.google.ads.admanager.v1.IBatchSubmitSitesForApprovalResponse,
        protos.google.ads.admanager.v1.IBatchSubmitSitesForApprovalRequest | undefined,
        {} | undefined
    ]>;
    batchSubmitSitesForApproval(request: protos.google.ads.admanager.v1.IBatchSubmitSitesForApprovalRequest, options: CallOptions, callback: Callback<protos.google.ads.admanager.v1.IBatchSubmitSitesForApprovalResponse, protos.google.ads.admanager.v1.IBatchSubmitSitesForApprovalRequest | null | undefined, {} | null | undefined>): void;
    batchSubmitSitesForApproval(request: protos.google.ads.admanager.v1.IBatchSubmitSitesForApprovalRequest, callback: Callback<protos.google.ads.admanager.v1.IBatchSubmitSitesForApprovalResponse, protos.google.ads.admanager.v1.IBatchSubmitSitesForApprovalRequest | null | undefined, {} | null | undefined>): void;
    /**
    * API to retrieve a list of `Site` objects.
    *
    * @param {Object} request
    *   The request object that will be sent.
    * @param {string} request.parent
    *   Required. The parent, which owns this collection of Sites.
    *   Format: `networks/{network_code}`
    * @param {number} [request.pageSize]
    *   Optional. The maximum number of `Sites` to return. The service may return
    *   fewer than this value. If unspecified, at most 50 `Sites` 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 `ListSites` call.
    *   Provide this to retrieve the subsequent page.
    *
    *   When paginating, all other parameters provided to `ListSites` 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
    * @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.Site|Site}.
    *   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 `listSitesAsync()`
    *   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.
    */
    listSites(request?: protos.google.ads.admanager.v1.IListSitesRequest, options?: CallOptions): Promise<[
        protos.google.ads.admanager.v1.ISite[],
        protos.google.ads.admanager.v1.IListSitesRequest | null,
        protos.google.ads.admanager.v1.IListSitesResponse
    ]>;
    listSites(request: protos.google.ads.admanager.v1.IListSitesRequest, options: CallOptions, callback: PaginationCallback<protos.google.ads.admanager.v1.IListSitesRequest, protos.google.ads.admanager.v1.IListSitesResponse | null | undefined, protos.google.ads.admanager.v1.ISite>): void;
    listSites(request: protos.google.ads.admanager.v1.IListSitesRequest, callback: PaginationCallback<protos.google.ads.admanager.v1.IListSitesRequest, protos.google.ads.admanager.v1.IListSitesResponse | null | undefined, protos.google.ads.admanager.v1.ISite>): void;
    /**
     * Equivalent to `listSites`, 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 Sites.
     *   Format: `networks/{network_code}`
     * @param {number} [request.pageSize]
     *   Optional. The maximum number of `Sites` to return. The service may return
     *   fewer than this value. If unspecified, at most 50 `Sites` 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 `ListSites` call.
     *   Provide this to retrieve the subsequent page.
     *
     *   When paginating, all other parameters provided to `ListSites` 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
     * @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.Site|Site} 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 `listSitesAsync()`
     *   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.
     */
    listSitesStream(request?: protos.google.ads.admanager.v1.IListSitesRequest, options?: CallOptions): Transform;
    /**
     * Equivalent to `listSites`, 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 Sites.
     *   Format: `networks/{network_code}`
     * @param {number} [request.pageSize]
     *   Optional. The maximum number of `Sites` to return. The service may return
     *   fewer than this value. If unspecified, at most 50 `Sites` 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 `ListSites` call.
     *   Provide this to retrieve the subsequent page.
     *
     *   When paginating, all other parameters provided to `ListSites` 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
     * @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.Site|Site}. 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/site_service.list_sites.js</caption>
     * region_tag:admanager_v1_generated_SiteService_ListSites_async
     */
    listSitesAsync(request?: protos.google.ads.admanager.v1.IListSitesRequest, options?: CallOptions): AsyncIterable<protos.google.ads.admanager.v1.ISite>;
    /**
     * 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 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
     *