google-ads-nodejs-client/build/src/v22/batch_job_service_client.d.ts

Googleads 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';
/**
 *  Service to manage batch jobs.
 * @class
 * @memberof v22
 */
export declare class BatchJobServiceClient {
    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;
    batchJobServiceStub?: Promise<{
        [name: string]: Function;
    }>;
    /**
     * Construct an instance of BatchJobServiceClient.
     *
     * @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 BatchJobServiceClient({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;
    /**
     * Mutates a batch job.
     *
     * List of thrown errors:
     *   [AuthenticationError]()
     *   [AuthorizationError]()
     *   [HeaderError]()
     *   [InternalError]()
     *   [QuotaError]()
     *   [RequestError]()
     *   [ResourceCountLimitExceededError]()
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.customerId
     *   Required. The ID of the customer for which to create a batch job.
     * @param {google.ads.googleads.v22.services.BatchJobOperation} request.operation
     *   Required. The operation to perform on an individual batch job.
     * @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.googleads.v22.services.MutateBatchJobResponse|MutateBatchJobResponse}.
     *   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/v22/batch_job_service.mutate_batch_job.js</caption>
     * region_tag:googleads_v22_generated_BatchJobService_MutateBatchJob_async
     */
    mutateBatchJob(request?: protos.google.ads.googleads.v22.services.IMutateBatchJobRequest, options?: CallOptions): Promise<[
        protos.google.ads.googleads.v22.services.IMutateBatchJobResponse,
        protos.google.ads.googleads.v22.services.IMutateBatchJobRequest | undefined,
        {} | undefined
    ]>;
    mutateBatchJob(request: protos.google.ads.googleads.v22.services.IMutateBatchJobRequest, options: CallOptions, callback: Callback<protos.google.ads.googleads.v22.services.IMutateBatchJobResponse, protos.google.ads.googleads.v22.services.IMutateBatchJobRequest | null | undefined, {} | null | undefined>): void;
    mutateBatchJob(request: protos.google.ads.googleads.v22.services.IMutateBatchJobRequest, callback: Callback<protos.google.ads.googleads.v22.services.IMutateBatchJobResponse, protos.google.ads.googleads.v22.services.IMutateBatchJobRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Add operations to the batch job.
     *
     * List of thrown errors:
     *   [AuthenticationError]()
     *   [AuthorizationError]()
     *   [BatchJobError]()
     *   [HeaderError]()
     *   [InternalError]()
     *   [QuotaError]()
     *   [RequestError]()
     *   [ResourceCountLimitExceededError]()
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.resourceName
     *   Required. The resource name of the batch job.
     * @param {string} request.sequenceToken
     *   A token used to enforce sequencing.
     *
     *   The first AddBatchJobOperations request for a batch job should not set
     *   sequence_token. Subsequent requests must set sequence_token to the value of
     *   next_sequence_token received in the previous AddBatchJobOperations
     *   response.
     * @param {number[]} request.mutateOperations
     *   Required. The list of mutates being added.
     *
     *   Operations can use negative integers as temp ids to signify dependencies
     *   between entities created in this batch job. For example, a customer with
     *   id = 1234 can create a campaign and an ad group in that same campaign by
     *   creating a campaign in the first operation with the resource name
     *   explicitly set to "customers/1234/campaigns/-1", and creating an ad group
     *   in the second operation with the campaign field also set to
     *   "customers/1234/campaigns/-1".
     * @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.googleads.v22.services.AddBatchJobOperationsResponse|AddBatchJobOperationsResponse}.
     *   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/v22/batch_job_service.add_batch_job_operations.js</caption>
     * region_tag:googleads_v22_generated_BatchJobService_AddBatchJobOperations_async
     */
    addBatchJobOperations(request?: protos.google.ads.googleads.v22.services.IAddBatchJobOperationsRequest, options?: CallOptions): Promise<[
        protos.google.ads.googleads.v22.services.IAddBatchJobOperationsResponse,
        protos.google.ads.googleads.v22.services.IAddBatchJobOperationsRequest | undefined,
        {} | undefined
    ]>;
    addBatchJobOperations(request: protos.google.ads.googleads.v22.services.IAddBatchJobOperationsRequest, options: CallOptions, callback: Callback<protos.google.ads.googleads.v22.services.IAddBatchJobOperationsResponse, protos.google.ads.googleads.v22.services.IAddBatchJobOperationsRequest | null | undefined, {} | null | undefined>): void;
    addBatchJobOperations(request: protos.google.ads.googleads.v22.services.IAddBatchJobOperationsRequest, callback: Callback<protos.google.ads.googleads.v22.services.IAddBatchJobOperationsResponse, protos.google.ads.googleads.v22.services.IAddBatchJobOperationsRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Runs the batch job.
     *
     * The Operation.metadata field type is BatchJobMetadata. When finished, the
     * long running operation will not contain errors or a response. Instead, use
     * ListBatchJobResults to get the results of the job.
     *
     * List of thrown errors:
     *   [AuthenticationError]()
     *   [AuthorizationError]()
     *   [BatchJobError]()
     *   [HeaderError]()
     *   [InternalError]()
     *   [QuotaError]()
     *   [RequestError]()
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.resourceName
     *   Required. The resource name of the BatchJob to run.
     * @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/v22/batch_job_service.run_batch_job.js</caption>
     * region_tag:googleads_v22_generated_BatchJobService_RunBatchJob_async
     */
    runBatchJob(request?: protos.google.ads.googleads.v22.services.IRunBatchJobRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.protobuf.IEmpty, protos.google.ads.googleads.v22.resources.BatchJob.IBatchJobMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
    runBatchJob(request: protos.google.ads.googleads.v22.services.IRunBatchJobRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.ads.googleads.v22.resources.BatchJob.IBatchJobMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    runBatchJob(request: protos.google.ads.googleads.v22.services.IRunBatchJobRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.ads.googleads.v22.resources.BatchJob.IBatchJobMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    /**
     * Check the status of the long running operation returned by `runBatchJob()`.
     * @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/v22/batch_job_service.run_batch_job.js</caption>
     * region_tag:googleads_v22_generated_BatchJobService_RunBatchJob_async
     */
    checkRunBatchJobProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.ads.googleads.v22.resources.BatchJob.BatchJobMetadata>>;
    /**
    * Returns the results of the batch job. The job must be done.
    * Supports standard list paging.
    *
    * List of thrown errors:
    *   [AuthenticationError]()
    *   [AuthorizationError]()
    *   [BatchJobError]()
    *   [HeaderError]()
    *   [InternalError]()
    *   [QuotaError]()
    *   [RequestError]()
    *
    * @param {Object} request
    *   The request object that will be sent.
    * @param {string} request.resourceName
    *   Required. The resource name of the batch job whose results are being
    *   listed.
    * @param {string} request.pageToken
    *   Token of the page to retrieve. If not specified, the first
    *   page of results will be returned. Use the value obtained from
    *   `next_page_token` in the previous response in order to request
    *   the next page of results.
    * @param {number} request.pageSize
    *   Number of elements to retrieve in a single page.
    *   The default and the page_size limit is 1000.
    *   A value of 0 or an unset page size will be defaulted to 1000.
    *   A page size less than 0 or greater than 1000 will result in an
    *   INVALID_PAGE_SIZE error.
    * @param {google.ads.googleads.v22.enums.ResponseContentTypeEnum.ResponseContentType} request.responseContentType
    *   The response content type setting. Determines whether the mutable resource
    *   or just the resource name should be returned.
    * @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.googleads.v22.services.BatchJobResult|BatchJobResult}.
    *   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 `listBatchJobResultsAsync()`
    *   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.
    */
    listBatchJobResults(request?: protos.google.ads.googleads.v22.services.IListBatchJobResultsRequest, options?: CallOptions): Promise<[
        protos.google.ads.googleads.v22.services.IBatchJobResult[],
        protos.google.ads.googleads.v22.services.IListBatchJobResultsRequest | null,
        protos.google.ads.googleads.v22.services.IListBatchJobResultsResponse
    ]>;
    listBatchJobResults(request: protos.google.ads.googleads.v22.services.IListBatchJobResultsRequest, options: CallOptions, callback: PaginationCallback<protos.google.ads.googleads.v22.services.IListBatchJobResultsRequest, protos.google.ads.googleads.v22.services.IListBatchJobResultsResponse | null | undefined, protos.google.ads.googleads.v22.services.IBatchJobResult>): void;
    listBatchJobResults(request: protos.google.ads.googleads.v22.services.IListBatchJobResultsRequest, callback: PaginationCallback<protos.google.ads.googleads.v22.services.IListBatchJobResultsRequest, protos.google.ads.googleads.v22.services.IListBatchJobResultsResponse | null | undefined, protos.google.ads.googleads.v22.services.IBatchJobResult>): void;
    /**
     * Equivalent to `listBatchJobResults`, but returns a NodeJS Stream object.
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.resourceName
     *   Required. The resource name of the batch job whose results are being
     *   listed.
     * @param {string} request.pageToken
     *   Token of the page to retrieve. If not specified, the first
     *   page of results will be returned. Use the value obtained from
     *   `next_page_token` in the previous response in order to request
     *   the next page of results.
     * @param {number} request.pageSize
     *   Number of elements to retrieve in a single page.
     *   The default and the page_size limit is 1000.
     *   A value of 0 or an unset page size will be defaulted to 1000.
     *   A page size less than 0 or greater than 1000 will result in an
     *   INVALID_PAGE_SIZE error.
     * @param {google.ads.googleads.v22.enums.ResponseContentTypeEnum.ResponseContentType} request.responseContentType
     *   The response content type setting. Determines whether the mutable resource
     *   or just the resource name should be returned.
     * @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.googleads.v22.services.BatchJobResult|BatchJobResult} 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 `listBatchJobResultsAsync()`
     *   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.
     */
    listBatchJobResultsStream(request?: protos.google.ads.googleads.v22.services.IListBatchJobResultsRequest, options?: CallOptions): Transform;
    /**
     * Equivalent to `listBatchJobResults`, 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.resourceName
     *   Required. The resource name of the batch job whose results are being
     *   listed.
     * @param {string} request.pageToken
     *   Token of the page to retrieve. If not specified, the first
     *   page of results will be returned. Use the value obtained from
     *   `next_page_token` in the previous response in order to request
     *   the next page of results.
     * @param {number} request.pageSize
     *   Number of elements to retrieve in a single page.
     *   The default and the page_size limit is 1000.
     *   A value of 0 or an unset page size will be defaulted to 1000.
     *   A page size less than 0 or greater than 1000 will result in an
     *   INVALID_PAGE_SIZE error.
     * @param {google.ads.googleads.v22.enums.ResponseContentTypeEnum.ResponseContentType} request.responseContentType
     *   The response content type setting. Determines whether the mutable resource
     *   or just the resource name should be returned.
     * @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.googleads.v22.services.BatchJobResult|BatchJobResult}. 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/v22/batch_job_service.list_batch_job_results.js</caption>
     * region_tag:googleads_v22_generated_BatchJobService_ListBatchJobResults_async
     */
    listBatchJobResultsAsync(request?: protos.google.ads.googleads.v22.services.IListBatchJobResultsRequest, options?: CallOptions): AsyncIterable<protos.google.ads.googleads.v22.services.IBatchJobResult>;
    /**
     * Return a fully-qualified accessibleBiddingStrategy resource name string.
     *
     * @param {string} customer_id
     * @param {string} bidding_strategy_id
     * @returns {string} Resource name string.
     */
    accessibleBiddingStrategyPath(customerId: string, biddingStrategyId: string): string;
    /**
     * Parse the customer_id from AccessibleBiddingStrategy resource.
     *
     * @param {string} accessibleBiddingStrategyName
     *   A fully-qualified path representing AccessibleBiddingStrategy resource.
     * @returns {string} A string representing the customer_id.
     */
    matchCustomerIdFromAccessibleBiddingStrategyName(accessibleBiddingStrategyName: string): string | number;
    /**
     * Parse the bidding_strategy_id from AccessibleBiddingStrategy resource.
     *
     * @param {string} accessibleBiddingStrategyName
     *   A fully-qualified path representing AccessibleBiddingStrategy resource.
     * @returns {string} A string representing the bidding_strategy_id.
     */
    matchBiddingStrategyIdFromAccessibleBiddingStrategyName(accessibleBiddingStrategyName: string): string | number;
    /**
     * Return a fully-qualified accountBudget resource name string.
     *
     * @param {string} customer_id
     * @param {string} account_budget_id
     * @returns {string} Resource name string.
     */
    accountBudgetPath(customerId: string, accountBudgetId: string): string;
    /**
     * Parse the customer_id from AccountBudget resource.
     *
     * @param {string} accountBudgetName
     *   A fully-qualified path representing AccountBudget resource.
     * @returns {string} A string representing the customer_id.
     */
    matchCustomerIdFromAccountBudgetName(accountBudgetName: string): string | number;
    /**
     * Parse the account_budget_id from AccountBudget resource.
     *
     * @param {string} accountBudgetName
     *   A fully-qualified path representing AccountBudget resource.
     * @returns {string} A string representing the account_budget_id.
     */
    matchAccountBudgetIdFromAccountBudgetName(accountBudgetName: string): string | number;
    /**
     * Return a fully-qualified accountBudgetProposal resource name string.
     *
     * @param {string} customer_id
     * @param {string} account_budget_proposal_id
     * @returns {string} Resource name string.
     */
    accountBudgetProposalPath(customerId: string, accountBudgetProposalId: string): string;
    /**
     * Parse the customer_id from AccountBudgetProposal resource.
     *
     * @param {string} accountBudgetProposalName
     *   A fully-qualified path representing AccountBudgetProposal resource.
     * @returns {string} A string representing the customer_id.
     */
    matchCustomerIdFromAccountBudgetProposalName(accountBudgetProposalName: string): string | number;
    /**
     * Parse the account_budget_proposal_id from AccountBudgetProposal resource.
     *
     * @param {string} accountBudgetProposalName
     *   A fully-qualified path representing AccountBudgetProposal resource.
     * @returns {string} A string representing the account_budget_proposal_id.
     */
    matchAccountBudgetProposalIdFromAccountBudgetProposalName(accountBudgetProposalName: string): string | number;
    /**
     * Return a fully-qualified accountLink resource name string.
     *
     * @param {string} customer_id
     * @param {string} account_link_id
     * @returns {string} Resource name string.
     */
    accountLinkPath(customerId: string, accountLinkId: string): string;
    /**
     * Parse the customer_id from AccountLink resource.
     *
     * @param {string} accountLinkName
     *   A fully-qualified path representing AccountLink resource.
     * @returns {string} A string representing the customer_id.
     */
    matchCustomerIdFromAccountLinkName(accountLinkName: string): string | number;
    /**
     * Parse the account_link_id from AccountLink resource.
     *
     * @param {string} accountLinkName
     *   A fully-qualified path representing AccountLink resource.
     * @returns {string} A string representing the account_link_id.
     */
    matchAccountLinkIdFromAccountLinkName(accountLinkName: string): string | number;
    /**
     * Return a fully-qualified ad resource name string.
     *
     * @param {string} customer_id
     * @param {string} ad_id
     * @returns {string} Resource name string.
     */
    adPath(customerId: string, adId: string): string;
    /**
     * Parse the customer_id from Ad resource.
     *
     * @param {string} adName
     *   A fully-qualified path representing Ad resource.
     * @returns {string} A string representing the customer_id.
     */
    matchCustomerIdFromAdName(adName: string): string | number;
    /**
     * Parse the ad_id from Ad resource.
     *
     * @param {string} adName
     *   A fully-qualified path representing Ad resource.
     * @returns {string} A string representing the ad_id.
     */
    matchAdIdFromAdName(adName: string): string | number;
    /**
     * Return a fully-qualified adGroup resource name string.
     *
     * @param {string} customer_id
     * @param {string} ad_group_id
     * @returns {string} Resource name string.
     */
    adGroupPath(customerId: string, adGroupId: string): string;
    /**
     * Parse the customer_id from AdGroup resource.
     *
     * @param {string} adGroupName
     *   A fully-qualified path representing AdGroup resource.
     * @returns {string} A string representing the customer_id.
     */
    matchCustomerIdFromAdGroupName(adGroupName: string): string | number;
    /**
     * Parse the ad_group_id from AdGroup resource.
     *
     * @param {string} adGroupName
     *   A fully-qualified path representing AdGroup resource.
     * @returns {string} A string representing the ad_group_id.
     */
    matchAdGroupIdFromAdGroupName(adGroupName: string): string | number;
    /**
     * Return a fully-qualified adGroupAd resource name string.
     *
     * @param {string} customer_id
     * @param {string} ad_group_id
     * @param {string} ad_id
     * @returns {string} Resource name string.
     */
    adGroupAdPath(customerId: string, adGroupId: string, adId: string): string;
    /**
     * Parse the customer_id from AdGroupAd resource.
     *
     * @param {string} adGroupAdName
     *   A fully-qualified path representing AdGroupAd resource.
     * @returns {string} A string representing the customer_id.
     */
    matchCustomerIdFromAdGroupAdName(adGroupAdName: string): string | number;
    /**
     * Parse the ad_group_id from AdGroupAd resource.
     *
     * @param {string} adGroupAdName
     *   A fully-qualified path representing AdGroupAd resource.
     * @returns {string} A string representing the ad_group_id.
     */
    matchAdGroupIdFromAdGroupAdName(adGroupAdName: string): string | number;
    /**
     * Parse the ad_id from AdGroupAd resource.
     *
     * @param {string} adGroupAdName
     *   A fully-qualified path representing AdGroupAd resource.
     * @returns {string} A string representing the ad_id.
     */
    matchAdIdFromAdGroupAdName(adGroupAdName: string): string | number;
    /**
     * Return a fully-qualified adGroupAdAssetCombinationView resource name string.
     *
     * @param {string} customer_id
     * @param {string} ad_group_id
     * @param {string} ad_id
     * @param {string} asset_combination_id_low
     * @param {string} asset_combination_id_high
     * @returns {string} Resource name string.
     */
    adGroupAdAssetCombinationViewPath(customerId: string, adGroupId: string, adId: string, assetCombinationIdLow: string, assetCombinationIdHigh: string): string;
    /**
     * Parse the customer_id from AdGroupAdAssetCombinationView resource.
     *
     * @param {string} adGroupAdAssetCombinationViewName
     *   A fully-qualified path representing AdGroupAdAssetCombinationView resource.
     * @returns {string} A string representing the customer_id.
     */
    matchCustomerIdFromAdGroupAdAssetCombinationViewName(adGroupAdAssetCombinationViewName: string): string | number;
    /**
     * Parse the ad_group_id from AdGroupAdAssetCombinationView resource.
     *
     * @param {string} adGroupAdAssetCombinationViewName
     *   A fully-qualified path representing AdGroupAdAssetCombinationView resource.
     * @returns {string} A string representing the ad_group_id.
     */
    matchAdGroupIdFromAdGroupAdAssetCombinationViewName(adGroupAdAssetCombinationViewName: string): string | number;
    /**
     * Parse the ad_id from AdGroupAdAssetCombinationView resource.
     *
     * @param {string} adGroupAdAssetCombinationViewName
     *   A fully-qualified path representing AdGroupAdAssetCombinationView resource.
     * @returns {string} A string representing the ad_id.
     */
    matchAdIdFromAdGroupAdAssetCombinationViewName(adGroupAdAssetCombinationViewName: string): string | number;
    /**
     * Parse the asset_combination_id_low from AdGroupAdAssetCombinationView resource.
     *
     * @param {string} adGroupAdAssetCombinationViewName
     *   A fully-qualified path representing AdGroupAdAssetCombinationView resource.
     * @returns {string} A string representing the asset_combination_id_low.
     */
    matchAssetCombinationIdLowFromAdGroupAdAssetCombinationViewName(adGroupAdAssetCombinationViewName: string): string | number;
    /**
     * Parse the asset_combination_id_high from AdGroupAdAssetCombinationView resource.
     *
     * @param {string} adGroupAdAssetCombinationViewName
     *   A fully-qualified path representing AdGroupAdAssetCombinationView resource.
     * @returns {string} A string representing the asset_combination_id_high.
     */
    matchAssetCombinationIdHighFromAdGroupAdAssetCombinationViewName(adGroupAdAssetCombinationViewName: string): string | number;
    /**
     * Return a fully-qualified adGroupAdAssetView resource name string.
     *
     * @param {string} customer_id
     * @param {string} ad_group_id
     * @param {string} ad_id
     * @param {string} asset_id
     * @param {string} field_type
     * @returns {string} Resource name string.
     */
    adGroupAdAssetViewPath(customerId: string, adGroupId: string, adId: string, assetId: string, fieldType: string): string;
    /**
     * Parse the customer_id from AdGroupAdAssetView resource.
     *
     * @param {string} adGroupAdAssetViewName
     *   A fully-qualified path representing AdGroupAdAssetView resource.
     * @returns {string} A string representing the customer_id.
     */
    matchCustomerIdFromAdGroupAdAssetViewName(adGroupAdAssetViewName: string): string | number;
    /**
     * Parse the ad_group_id from AdGroupAdAssetView resource.
     *
     * @param {string} adGroupAdAssetViewName
     *   A fully-qualified path representing AdGroupAdAssetView resource.
     * @returns {string} A string representing the ad_group_id.
     */
    matchAdGroupIdFromAdGroupAdAssetViewName(adGroupAdAssetViewName: string): string | number;
    /**
     * Parse the ad_id from AdGroupAdAssetView resource.
     *
     * @param {string} adGroupAdAssetViewName
     *   A fully-qualified path representing AdGroupAdAssetView resource.
     * @returns {string} A string representing the ad_id.
     */
    matchAdIdFromAdGroupAdAssetViewName(adGroupAdAssetViewName: string): string | number;
    /**
     * Parse the asset_id from AdGroupAdAssetView resource.
     *
     * @param {string} adGroupAdAssetViewName
     *   A fully-qualified path representing AdGroupAdAssetView resource.
     * @returns {string} A string representing the asset_id.
     */
    matchAssetIdFromAdGroupAdAssetViewName(adGroupAdAssetViewName: string): string | number;
    /**
     * Parse the field_type from AdGroupAdAssetView resource.
     *
     * @param {string} adGroupAdAssetViewName
     *   A fully-qualified path representing AdGroupAdAssetView resource.
     * @returns {string} A string representing the field_type.
     */
    matchFieldTypeFromAdGroupAdAssetViewName(adGroupAdAssetViewName: string): string | number;
    /**
     * Return a fully-qualified adGroupAdLabel resource name string.
     *
     * @param {string} customer_id
     * @param {string} ad_group_id
     * @param {string} ad_id
     * @param {string} label_id
     * @returns {string} Resource name string.
     */
    adGroupAdLabelPath(customerId: string, adGroupId: string, adId: string, labelId: string): string;
    /**
     * Parse the customer_id from AdGroupAdLabel resource.
     *
     * @param {string} adGroupAdLabelName
     *   A fully-qualified path representing AdGroupAdLabel resource.
     * @returns {string} A string representing the customer_id.
     */
    matchCustomerIdFromAdGroupAdLabelName(adGroupAdLabelName: string): string | number;
    /**
     * Parse the ad_group_id from AdGroupAdLabel resource.
     *
     * @param {string} adGroupAdLabelName
     *   A fully-qualified path representing AdGroupAdLabel resource.
     * @returns {string} A string representing the ad_group_id.
     */
    matchAdGroupIdFromAdGroupAdLabelName(adGroupAdLabelName: string): string | number;
    /**
     * Parse the ad_id from AdGroupAdLabel resource.
     *
     * @param {string} adGroupAdLabelName
     *   A fully-qualified path representing AdGroupAdLabel resource.
     * @returns {string} A string representing the ad_id.
     */
    matchAdIdFromAdGroupAdLabelName(adGroupAdLabelName: string): string | number;
    /**
     * Parse the label_id from AdGroupAdLabel resource.
     *
     * @param {string} adGroupAdLabelName
     *   A fully-qualified path representing AdGroupAdLabel resource.
     * @returns {string} A string representing the label_id.
     */
    matchLabelIdFromAdGroupAdLabelName(adGroupAdLabelName: string): string | number;
    /**
     * Return a fully-qualified adGroupAsset resource name string.
     *
     * @param {string} customer_id
     * @param {string} ad_group_id
     * @param {string} asset_id
     * @param {string} field_type
     * @returns {string} Resource name string.
     */
    adGroupAssetPath(customerId: string, adGroupId: string, assetId: string, fieldType: string): string;
    /**
     * Parse the customer_id from AdGroupAsset resource.
     *
     * @param {string} adGroupAssetName
     *   A fully-qualified path representing AdGroupAsset resource.
     * @returns {string} A string representing the customer_id.
     */
    matchCustomerIdFromAdGroupAssetName(adGroupAssetName: string): string | number;
    /**
     * Parse the ad_group_id from AdGroupAsset resource.
     *
     * @param {string} adGroupAssetName
     *   A fully-qualified path representing AdGroupAsset resource.
     * @returns {string} A string representing the ad_group_id.
     */
    matchAdGroupIdFromAdGroupAssetName(adGroupAssetName: string): string | number;
    /**
     * Parse the asset_id from AdGroupAsset resource.
     *
     * @param {string} adGroupAssetName
     *   A fully-qualified path representing AdGroupAsset resource.
     * @returns {string} A string representing the asset_id.
     */
    matchAssetIdFromAdGroupAssetName(adGroupAssetName: string): string | number;
    /**
     * Parse the field_type from AdGroupAsset resource.
     *
     * @param {string} adGroupAssetName
     *   A fully-qualified path representing AdGroupAsset resource.
     * @returns {string} A string representing the field_type.
     */
    matchFieldTypeFromAdGroupAssetName(adGroupAssetName: string): string | number;
    /**
     * Return a fully-qualified adGroupAssetSet resource name string.
     *
     * @param {string} customer_id
     * @param {string} ad_group_id
     * @param {string} asset_set_id
     * @returns {string} Resource name string.
     */
    adGroupAssetSetPath(customerId: string, adGroupId: string, assetSetId: string): string;
    /**
     * Parse the customer_id from AdGroupAssetSet resource.
     *
     * @param {string} adGroupAssetSetName
     *   A fully-qualified path representing AdGroupAssetSet resource.
     * @returns {string} A string representing the customer_id.
     */
    matchCustomerIdFromAdGroupAssetSetName(adGroupAssetSetName: string): string | number;
    /**
     * Parse the ad_group_id from AdGroupAssetSet resource.
     *
     * @param {string} adGroupAssetSetName
     *   A fully-qualified path representing AdGroupAssetSet resource.
     * @returns {string} A string representing the ad_group_id.
     */
    matchAdGroupIdFromAdGroupAssetSetName(adGroupAssetSetName: string): string | number;
    /**
     * Parse the asset_set_id from AdGroupAssetSet resource.
     *
     * @param {string} adGroupAssetSetName
     *   A fully-qualified path representing AdGroupAssetSet resource.
     * @returns {string} A string representing the asset_set_id.
     */
    matchAssetSetIdFromAdGroupAssetSetName(adGroupAssetSetName: string): string | number;
    /**
     * Return a fully-qualified adGroupAudienceView resource name string.
     *
     * @param {string} customer_id
     * @param {string} ad_group_id
     * @param {string} criterion_id
     * @returns {string} Resource name string.
     */
    adGroupAudienceViewPath(customerId: string, adGroupId: string, criterionId: string): string;
    /**
     * Parse the customer_id from AdGroupAudienceView resource.
     *
     * @param {string} adGroupAudienceViewName
     *   A fully-qualified path representing AdGroupAudienceView resource.
     * @returns {string} A string representing the customer_id.
     */
    matchCustomerIdFromAdGroupAudienceViewName(adGroupAudienceViewName: string): string | number;
    /**
     * Parse the ad_group_id from AdGroupAudienceView resource.
     *
     * @param {string} adGroupAudienceViewName
     *   A fully-qualified path representing AdGroupAudienceView resource.
     * @returns {string} A string representing the ad_group_id.
     */
    matchAdGroupIdFromAdGroupAudienceViewName(adGroupAudienceViewName: string): string | number;
    /**
     * Parse the criterion_id from AdGroupAudienceView resource.
     *
     * @param {string} adGroupAudienceViewName
     *   A fully-qualified path representing AdGroupAudienceView resource.
     * @returns {string} A string representing the criterion_id.
     */
    matchCriterionIdFromAdGroupAudienceViewName(adGroupAudienceViewName: string): string | number;
    /**
     * Return a fully-qualified adGroupBidModifier resource name string.
     *
     * @param {string} customer_id
     * @param {string} ad_group_id
     * @param {string} criterion_id
     * @returns {string} Resource name string.
     */
    adGroupBidModifierPath(customerId: string, adGroupId: string, criterionId: string): string;
    /**
     * Parse the customer_id from AdGroupBidModifier resource.
     *
     * @param {string} adGroupBidModifierName
     *   A fully-qualified path representing AdGroupBidModifier resource.
     * @returns {string} A string representing the customer_id.
     */
    matchCustomerIdFromAdGroupBidModifierName(adGroupBidModifierName: string): string | number;
    /**
     * Parse the ad_group_id from AdGroupBidModifier resource.
     *
     * @param {string} adGroupBidModifierName
     *   A fully-qualified path representing AdGroupBidModifier resource.
     * @returns {string} A string representing the ad_group_id.
     */
    matchAdGroupIdFromAdGroupBidModifierName(adGroupBidModifierName: string): string | number;
    /**
     * Parse the criterion_id from AdGroupBidModifier resource.
     *
     * @param {string} adGroupBidModifierName
     *   A fully-qualified path representing AdGroupBidModifier resource.
     * @returns {string} A string representing the criterion_id.
     */
    matchCriterionIdFromAdGroupBidModifierName(adGroupBidModifierName: string): string | number;
    /**
     * Return a fully-qualified adGroupCriterion resource name string.
     *
     * @param {string} customer_id
     * @param {string} ad_group_id
     * @param {string} criterion_id
     * @returns {string} Resource name string.
     */
    adGroupCriterionPath(customerId: string, adGroupId: string, criterionId: string): string;
    /**
     * Parse the customer_id from AdGroupCriterion resource.
     *
     * @param {string} adGroupCriterionName
     *   A fully-qualified path representing AdGroupCriterion resource.
     * @returns {string} A string representing the customer_id.
     */
    matchCustomerIdFromAdGroupCriterionName(adGroupCriterionName: string): string | number;
    /**
     * Parse the ad_group_id from AdGroupCriterion resource.
     *
     * @param {string} adGroupCriterionName
     *   A fully-qualified path representing AdGroupCriterion resource.
     * @returns {string} A string representing the ad_group_id.
     */
    matchAdGroupIdFromAdGroupCriterionName(adGroupCriterionName: string): string | number;
    /**
     * Parse the criterion_id from AdGroupCriterion resource.
     *
     * @param {string} adGroupCriterionName
     *   A fully-qualified path representing AdGroupCriterion resource.
     * @returns {string} A string representing the criterion_id.
     */
    matchCriterionIdFromAdGroupCriterionName(adGroupCriterionName: string): string | number;
    /**
     * Return a fully-qualified adGroupCriterionCustomizer resource name string.
     *
     * @param {string} customer_id
     * @param {string} ad_group_id
     * @param {string} criterion_id
     * @param {string} customizer_attribute_id
     * @returns {string} Resource name string.
     */
    adGroupCriterionCustomizerPath(customerId: string, adGroupId: string, criterionId: string, customizerAttributeId: string): string;
    /**
     * Parse the customer_id from AdGroupCriterionCustomizer resource.
     *
     * @param {string} adGroupCriterionCustomizerName
     *   A fully-qualified path representing AdGroupCriterionCustomizer resource.
     * @returns {string} A string representing the customer_id.
     */
    matchCustomerIdFromAdGroupCriterionCustomizerName(adGroupCriterionCustomizerName: string): string | number;
    /**
     * Parse the ad_group_id from AdGroupCriterionCustomizer resource.
     *
     * @param {string} adGroupCriterionCustomizerName
     *   A fully-qualified path representing AdGroupCriterionCustomizer resource.
     * @returns {string} A string representing the ad_group_id.
     */
    matchAdGroupIdFromAdGroupCriterionCustomizerName(adGroupCriterionCustomizerName: string): string | number;
    /**
     * Parse the criterion_id from AdGroupCriterionCustomizer resource.
     *
     * @param {string} adGroupCriterionCustomizerName
     *   A fully-qualified path representing AdGroupCriterionCustomizer resource.
     * @returns {string} A string representing the criterion_id.
     */
    matchCriterionIdFromAdGroupCriterionCustomizerName(adGroupCriterionCustomizerName: string): string | number;
    /**
     * Parse the customizer_attribute_id from AdGroupCriterionCustomizer resource.
     *
     * @param {string} adGroupCriterionCustomizerName
     *   A fully-qualified path representing AdGroupCriterionCustomizer resource.
     * @returns {string} A string representing the customizer_attribute_id.
     */
    matchCustomizerAttributeIdFromAdGroupCriterionCustomizerName(adGroupCriterionCustomizerName: string): string | number;
    /**
     * Return a fully-qualified adGroupCriterionLabel resource name string.
     *
     * @param {string} customer_id
     * @param {string} ad_group_id
     * @param {string} criterion_id
     * @param {string} label_id
     * @returns {string} Resource name string.
     */
    adGroupCriterionLabelPath(customerId: string, adGroupId: string, criterionId: string, labelId: string): string;
    /**
     * Parse the customer_id from AdGroupCriterionLabel resource.
     *
     * @param {string} adGroupCriterionLabelName
     *   A fully-qualified path representing AdGroupCriterionLabel resource.
     * @returns {string} A string representing the customer_id.
     */
    matchCustomerIdFromAdGroupCriterionLabelName(adGroupCriterionLabelName: string): string | number;
    /**
     * Parse the ad_group_id from AdGroupCriterionLabel resource.
     *
     * @param {string} adGroupCriterionLabelName
     *   A fully-qualified path representing AdGroupCriterionLabel resource.
     * @returns {string} A string representing the ad_group_id.
     */
    matchAdGroupIdFromAdGroupCriterionLabelName(adGroupCriterionLabelName: string): string | number;
    /**
     * Parse the criterion_id from AdGroupCriterionLabel resource.
     *
     * @param {string} adGroupCriterionLabelName
     *   A fully-qualified path representing AdGroupCriterionLabel resource.
     * @returns {string} A string representing the criterion_id.
     */
    matchCriterionIdFromAdGroupCriterionLabelName(adGroupCriterionLabelName: string): string | number;
    /**
     * Parse the label_id from AdGroupCriterionLabel resource.
     *
     * @param {string} adGroupCriterionLabelName
     *   A fully-qualified path representing AdGroupCriterionLabel resource.
     * @returns {string} A string representing the label_id.
     */
    matchLabelIdFromAdGroupCriterionLabelName(adGroupCriterionLabelName: string): string | number;
    /**
     * Return a fully-qualified adGroupCriterionSimulation resource name string.
     *
     * @param {string} customer_id
     * @param {string} ad_group_id
     * @param {string} criterion_id
     * @param {string} type
     * @param {string} modification_method
     * @param {string} start_date
     * @param {string} end_date
     * @returns {string} Resource name string.
     */
    adGroupCriterionSimulationPath(customerId: string, adGroupId: string, criterionId: string, type: string, modificationMethod: string, startDate: string, endDate: string): string;
    /**
     * Parse the customer_id from AdGroupCriterionSimulation resource.
     *
     * @param {string} adGroupCriterionSimulationName
     *   A fully-qualified path representing AdGroupCriterionSimulation resource.
     * @returns {string} A string representing the customer_id.
     */
    matchCustomerIdFromAdGroupCriterionSimulationName(adGroupCriterionSimulationName: string): string | number;
    /**
     * Parse the ad_group_id from AdGroupCriterionSimulation resource.
     *
     * @param {string} adGroupCriterionSimulationName
     *   A fully-qualified path representing AdGroupCriterionSimulation resource.
     * @returns {string} A string representing the ad_group_id.
     */
    matchAdGroupIdFromAdGroupCriterionSimulationName(adGroupCriterionSimulationName: string): string | number;
    /**
     * Parse the criterion_id from AdGroupCriterionSimulation resource.
     *
     * @param {string} adGroupCriterionSimulationName
     *   A fully-qualified path representing AdGroupCriterionSimulation resource.
     * @returns {string} A string representing the criterion_id.
     */
    matchCriterionIdFromAdGroupCriterionSimulationName(adGroupCriterionSimulationName: string): string | number;
    /**
     * Parse the type from AdGroupCriterionSimulation resource.
     *
     * @param {string} adGroupCriterionSimulationName
     *   A fully-qualified path representing AdGroupCriterionSimulation resource.
     * @returns {string} A string representing the type.
     */
    matchTypeFromAdGroupCriterionSimulationName(adGroupCriterionSimulationName: string): string | number;
    /**
     * Parse the modification_method from AdGroupCriterionSimulation resource.
     *
     * @param {string} adGroupCriterionSimulationName
     *   A fully-qu