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

Googleads client for Node.js

import type * as gax from 'google-gax';
import type { Callback, CallOptions, Descriptors, ClientOptions } from 'google-gax';
import * as protos from '../../protos/protos';
/**
 *  Reach Plan Service gives users information about audience size that can
 *  be reached through advertisement on YouTube. In particular,
 *  GenerateReachForecast provides estimated number of people of specified
 *  demographics that can be reached by an ad in a given market by a campaign of
 *  certain duration with a defined budget.
 * @class
 * @memberof v22
 */
export declare class ReachPlanServiceClient {
    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;
    };
    reachPlanServiceStub?: Promise<{
        [name: string]: Function;
    }>;
    /**
     * Construct an instance of ReachPlanServiceClient.
     *
     * @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 ReachPlanServiceClient({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;
    /**
     * Returns a collection of conversion rate suggestions for supported plannable
     * products.
     *
     * List of thrown errors:
     *   [AuthenticationError]()
     *   [AuthorizationError]()
     *   [HeaderError]()
     *   [InternalError]()
     *   [QuotaError]()
     *   [RequestError]()
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.customerId
     *   Required. The ID of the customer. A conversion rate based on the historical
     *   data of this customer may be suggested.
     * @param {string} request.customerReachGroup
     *   The name of the customer being planned for. This is a user-defined value.
     * @param {google.ads.googleads.v22.common.AdditionalApplicationInfo} [request.reachApplicationInfo]
     *   Optional. Additional information on the application issuing the request.
     * @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.GenerateConversionRatesResponse|GenerateConversionRatesResponse}.
     *   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/reach_plan_service.generate_conversion_rates.js</caption>
     * region_tag:googleads_v22_generated_ReachPlanService_GenerateConversionRates_async
     */
    generateConversionRates(request?: protos.google.ads.googleads.v22.services.IGenerateConversionRatesRequest, options?: CallOptions): Promise<[
        protos.google.ads.googleads.v22.services.IGenerateConversionRatesResponse,
        protos.google.ads.googleads.v22.services.IGenerateConversionRatesRequest | undefined,
        {} | undefined
    ]>;
    generateConversionRates(request: protos.google.ads.googleads.v22.services.IGenerateConversionRatesRequest, options: CallOptions, callback: Callback<protos.google.ads.googleads.v22.services.IGenerateConversionRatesResponse, protos.google.ads.googleads.v22.services.IGenerateConversionRatesRequest | null | undefined, {} | null | undefined>): void;
    generateConversionRates(request: protos.google.ads.googleads.v22.services.IGenerateConversionRatesRequest, callback: Callback<protos.google.ads.googleads.v22.services.IGenerateConversionRatesResponse, protos.google.ads.googleads.v22.services.IGenerateConversionRatesRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Returns the list of plannable locations (for example, countries).
     *
     * List of thrown errors:
     *   [AuthenticationError]()
     *   [AuthorizationError]()
     *   [HeaderError]()
     *   [InternalError]()
     *   [QuotaError]()
     *   [RequestError]()
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {google.ads.googleads.v22.common.AdditionalApplicationInfo} [request.reachApplicationInfo]
     *   Optional. Additional information on the application issuing the request.
     * @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.ListPlannableLocationsResponse|ListPlannableLocationsResponse}.
     *   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/reach_plan_service.list_plannable_locations.js</caption>
     * region_tag:googleads_v22_generated_ReachPlanService_ListPlannableLocations_async
     */
    listPlannableLocations(request?: protos.google.ads.googleads.v22.services.IListPlannableLocationsRequest, options?: CallOptions): Promise<[
        protos.google.ads.googleads.v22.services.IListPlannableLocationsResponse,
        protos.google.ads.googleads.v22.services.IListPlannableLocationsRequest | undefined,
        {} | undefined
    ]>;
    listPlannableLocations(request: protos.google.ads.googleads.v22.services.IListPlannableLocationsRequest, options: CallOptions, callback: Callback<protos.google.ads.googleads.v22.services.IListPlannableLocationsResponse, protos.google.ads.googleads.v22.services.IListPlannableLocationsRequest | null | undefined, {} | null | undefined>): void;
    listPlannableLocations(request: protos.google.ads.googleads.v22.services.IListPlannableLocationsRequest, callback: Callback<protos.google.ads.googleads.v22.services.IListPlannableLocationsResponse, protos.google.ads.googleads.v22.services.IListPlannableLocationsRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Returns the list of per-location plannable YouTube ad formats with allowed
     * targeting.
     *
     * List of thrown errors:
     *   [AuthenticationError]()
     *   [AuthorizationError]()
     *   [HeaderError]()
     *   [InternalError]()
     *   [QuotaError]()
     *   [RequestError]()
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.plannableLocationId
     *   Required. The ID of the selected location for planning. To list the
     *   available plannable location IDs use
     *   {@link protos.google.ads.googleads.v22.services.ReachPlanService.ListPlannableLocations|ReachPlanService.ListPlannableLocations}.
     * @param {google.ads.googleads.v22.common.AdditionalApplicationInfo} [request.reachApplicationInfo]
     *   Optional. Additional information on the application issuing the request.
     * @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.ListPlannableProductsResponse|ListPlannableProductsResponse}.
     *   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/reach_plan_service.list_plannable_products.js</caption>
     * region_tag:googleads_v22_generated_ReachPlanService_ListPlannableProducts_async
     */
    listPlannableProducts(request?: protos.google.ads.googleads.v22.services.IListPlannableProductsRequest, options?: CallOptions): Promise<[
        protos.google.ads.googleads.v22.services.IListPlannableProductsResponse,
        protos.google.ads.googleads.v22.services.IListPlannableProductsRequest | undefined,
        {} | undefined
    ]>;
    listPlannableProducts(request: protos.google.ads.googleads.v22.services.IListPlannableProductsRequest, options: CallOptions, callback: Callback<protos.google.ads.googleads.v22.services.IListPlannableProductsResponse, protos.google.ads.googleads.v22.services.IListPlannableProductsRequest | null | undefined, {} | null | undefined>): void;
    listPlannableProducts(request: protos.google.ads.googleads.v22.services.IListPlannableProductsRequest, callback: Callback<protos.google.ads.googleads.v22.services.IListPlannableProductsResponse, protos.google.ads.googleads.v22.services.IListPlannableProductsRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Generates a reach forecast for a given targeting / product mix.
     *
     * List of thrown errors:
     *   [AuthenticationError]()
     *   [AuthorizationError]()
     *   [FieldError]()
     *   [HeaderError]()
     *   [InternalError]()
     *   [QuotaError]()
     *   [RangeError]()
     *   [ReachPlanError]()
     *   [RequestError]()
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.customerId
     *   Required. The ID of the customer.
     * @param {string} request.currencyCode
     *   The currency code.
     *   Three-character ISO 4217 currency code.
     * @param {google.ads.googleads.v22.services.CampaignDuration} request.campaignDuration
     *   Required. Campaign duration.
     * @param {number} request.cookieFrequencyCap
     *   Chosen cookie frequency cap to be applied to each planned product.
     *   This is equivalent to the frequency cap exposed in Google Ads when creating
     *   a campaign, it represents the maximum number of times an ad can be shown to
     *   the same user.
     *   If not specified, no cap is applied.
     *
     *   This field is deprecated in v4 and will eventually be removed.
     *   Use cookie_frequency_cap_setting instead.
     * @param {google.ads.googleads.v22.services.FrequencyCap} request.cookieFrequencyCapSetting
     *   Chosen cookie frequency cap to be applied to each planned product.
     *   This is equivalent to the frequency cap exposed in Google Ads when creating
     *   a campaign, it represents the maximum number of times an ad can be shown to
     *   the same user during a specified time interval.
     *   If not specified, a default of 0 (no cap) is applied.
     *
     *   This field replaces the deprecated cookie_frequency_cap field.
     * @param {number} request.minEffectiveFrequency
     *   Chosen minimum effective frequency (the number of times a person was
     *   exposed to the ad) for the reported reach metrics [1-10].
     *   This won't affect the targeting, but just the reporting.
     *   If not specified, a default of 1 is applied.
     *
     *   This field cannot be combined with the effective_frequency_limit field.
     * @param {google.ads.googleads.v22.services.EffectiveFrequencyLimit} request.effectiveFrequencyLimit
     *   The highest minimum effective frequency (the number of times a person was
     *   exposed to the ad) value [1-10] to include in
     *   Forecast.effective_frequency_breakdowns.
     *   If not specified, Forecast.effective_frequency_breakdowns will not be
     *   provided.
     *
     *   The effective frequency value provided here will also be used as the
     *   minimum effective frequency for the reported reach metrics.
     *
     *   This field cannot be combined with the min_effective_frequency field.
     * @param {google.ads.googleads.v22.services.Targeting} request.targeting
     *   The targeting to be applied to all products selected in the product mix.
     *
     *   This is planned targeting: execution details might vary based on the
     *   advertising product, consult an implementation specialist.
     *
     *   See specific metrics for details on how targeting affects them.
     * @param {number[]} request.plannedProducts
     *   Required. The products to be forecast.
     *   The max number of allowed planned products is 15.
     * @param {google.ads.googleads.v22.services.ForecastMetricOptions} request.forecastMetricOptions
     *   Controls the forecast metrics returned in the response.
     * @param {string} request.customerReachGroup
     *   The name of the customer being planned for. This is a user-defined value.
     * @param {google.ads.googleads.v22.common.AdditionalApplicationInfo} [request.reachApplicationInfo]
     *   Optional. Additional information on the application issuing the request.
     * @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.GenerateReachForecastResponse|GenerateReachForecastResponse}.
     *   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/reach_plan_service.generate_reach_forecast.js</caption>
     * region_tag:googleads_v22_generated_ReachPlanService_GenerateReachForecast_async
     */
    generateReachForecast(request?: protos.google.ads.googleads.v22.services.IGenerateReachForecastRequest, options?: CallOptions): Promise<[
        protos.google.ads.googleads.v22.services.IGenerateReachForecastResponse,
        protos.google.ads.googleads.v22.services.IGenerateReachForecastRequest | undefined,
        {} | undefined
    ]>;
    generateReachForecast(request: protos.google.ads.googleads.v22.services.IGenerateReachForecastRequest, options: CallOptions, callback: Callback<protos.google.ads.googleads.v22.services.IGenerateReachForecastResponse, protos.google.ads.googleads.v22.services.IGenerateReachForecastRequest | null | undefined, {} | null | undefined>): void;
    generateReachForecast(request: protos.google.ads.googleads.v22.services.IGenerateReachForecastRequest, callback: Callback<protos.google.ads.googleads.v22.services.IGenerateReachForecastResponse, protos.google.ads.googleads.v22.services.IGenerateReachForecastRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Returns the list of plannable user lists with their plannable status.
     * User lists may not be plannable for a number of reasons, including:
     * - They are less than 10 days old.
     * - They have a membership lifespan that is less than 30 days
     * - They have less than 10,000 or more than 700,000 users.
     *
     * List of thrown errors:
     *   [AuthenticationError]()
     *   [AuthorizationError]()
     *   [FieldError]()
     *   [HeaderError]()
     *   [InternalError]()
     *   [QuotaError]()
     *   [RangeError]()
     *   [ReachPlanError]()
     *   [RequestError]()
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.customerId
     *   Required. The ID of the customer.
     * @param {string} request.customerReachGroup
     *   The name of the customer being planned for. This is a user-defined value.
     * @param {google.ads.googleads.v22.common.AdditionalApplicationInfo} [request.reachApplicationInfo]
     *   Optional. Additional information on the application issuing the request.
     * @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.ListPlannableUserListsResponse|ListPlannableUserListsResponse}.
     *   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/reach_plan_service.list_plannable_user_lists.js</caption>
     * region_tag:googleads_v22_generated_ReachPlanService_ListPlannableUserLists_async
     */
    listPlannableUserLists(request?: protos.google.ads.googleads.v22.services.IListPlannableUserListsRequest, options?: CallOptions): Promise<[
        protos.google.ads.googleads.v22.services.IListPlannableUserListsResponse,
        protos.google.ads.googleads.v22.services.IListPlannableUserListsRequest | undefined,
        {} | undefined
    ]>;
    listPlannableUserLists(request: protos.google.ads.googleads.v22.services.IListPlannableUserListsRequest, options: CallOptions, callback: Callback<protos.google.ads.googleads.v22.services.IListPlannableUserListsResponse, protos.google.ads.googleads.v22.services.IListPlannableUserListsRequest | null | undefined, {} | null | undefined>): void;
    listPlannableUserLists(request: protos.google.ads.googleads.v22.services.IListPlannableUserListsRequest, callback: Callback<protos.google.ads.googleads.v22.services.IListPlannableUserListsResponse, protos.google.ads.googleads.v22.services.IListPlannableUserListsRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Returns the list of plannable user interests.
     * A plannable user interest is one that can be targeted in a reach forecast
     * using
     * {@link protos.google.ads.googleads.v22.services.ReachPlanService.GenerateReachForecast|ReachPlanService.GenerateReachForecast}.
     *
     * List of thrown errors:
     *   [AuthenticationError]()
     *   [AuthorizationError]()
     *   [FieldError]()
     *   [HeaderError]()
     *   [InternalError]()
     *   [ListOperationError]()
     *   [QuotaError]()
     *   [RequestError]()
     *   [StringLengthError]()
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.customerId
     *   Required. The ID of the customer.
     * @param {number[]} [request.userInterestTaxonomyTypes]
     *   Optional. A filter by user interest type. If set, only user interests with
     *   a type listed in the filter will be returned. If not set, user interests of
     *   all supported types will be returned. Supported user interest types are
     *   AFFINITY and IN_MARKET. Each type must be specified at most once.
     * @param {string} request.nameQuery
     *   A filter by user interest name. If set, only user interests with a name
     *   containing the literal string (case insensitive) in the filter will be
     *   returned. Maximum length is 200 characters.
     * @param {string} request.pathQuery
     *   A filter by user interest path. If set, only user interests with a path
     *   containing the literal string (case insensitive) in the filter will be
     *   returned. Maximum length is 200 characters.
     * @param {google.ads.googleads.v22.common.AdditionalApplicationInfo} [request.reachApplicationInfo]
     *   Optional. Additional information on the application issuing the request.
     * @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.ListPlannableUserInterestsResponse|ListPlannableUserInterestsResponse}.
     *   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/reach_plan_service.list_plannable_user_interests.js</caption>
     * region_tag:googleads_v22_generated_ReachPlanService_ListPlannableUserInterests_async
     */
    listPlannableUserInterests(request?: protos.google.ads.googleads.v22.services.IListPlannableUserInterestsRequest, options?: CallOptions): Promise<[
        protos.google.ads.googleads.v22.services.IListPlannableUserInterestsResponse,
        protos.google.ads.googleads.v22.services.IListPlannableUserInterestsRequest | undefined,
        {} | undefined
    ]>;
    listPlannableUserInterests(request: protos.google.ads.googleads.v22.services.IListPlannableUserInterestsRequest, options: CallOptions, callback: Callback<protos.google.ads.googleads.v22.services.IListPlannableUserInterestsResponse, protos.google.ads.googleads.v22.services.IListPlannableUserInterestsRequest | null | undefined, {} | null | undefined>): void;
    listPlannableUserInterests(request: protos.google.ads.googleads.v22.services.IListPlannableUserInterestsRequest, callback: Callback<protos.google.ads.googleads.v22.services.IListPlannableUserInterestsResponse, protos.google.ads.googleads.v22.services.IListPlannableUserInterestsRequest | null | undefined, {} | null | undefined>): void;
    /**
     * 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 AdGroupC