google-ads-nodejs-client
Version:
Googleads client for Node.js
1,028 lines • 257 kB
TypeScript
import type * as gax from 'google-gax';
import type { Callback, CallOptions, Descriptors, ClientOptions } from 'google-gax';
import * as protos from '../../protos/protos';
/**
* Service to manage recommendations.
* @class
* @memberof v22
*/
export declare class RecommendationServiceClient {
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;
};
recommendationServiceStub?: Promise<{
[name: string]: Function;
}>;
/**
* Construct an instance of RecommendationServiceClient.
*
* @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 RecommendationServiceClient({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;
/**
* Applies given recommendations with corresponding apply parameters.
*
* List of thrown errors:
* [AuthenticationError]()
* [AuthorizationError]()
* [DatabaseError]()
* [FieldError]()
* [HeaderError]()
* [InternalError]()
* [MutateError]()
* [QuotaError]()
* [RecommendationError]()
* [RequestError]()
* [UrlFieldError]()
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.customerId
* Required. The ID of the customer with the recommendation.
* @param {number[]} request.operations
* Required. The list of operations to apply recommendations.
* If partial_failure=false all recommendations should be of the same type
* There is a limit of 100 operations per request.
* @param {boolean} request.partialFailure
* If true, successful operations will be carried out and invalid
* operations will return errors. If false, operations will be carried
* out as a transaction if and only if they are all valid.
* Default is false.
* @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.ApplyRecommendationResponse|ApplyRecommendationResponse}.
* 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/recommendation_service.apply_recommendation.js</caption>
* region_tag:googleads_v22_generated_RecommendationService_ApplyRecommendation_async
*/
applyRecommendation(request?: protos.google.ads.googleads.v22.services.IApplyRecommendationRequest, options?: CallOptions): Promise<[
protos.google.ads.googleads.v22.services.IApplyRecommendationResponse,
protos.google.ads.googleads.v22.services.IApplyRecommendationRequest | undefined,
{} | undefined
]>;
applyRecommendation(request: protos.google.ads.googleads.v22.services.IApplyRecommendationRequest, options: CallOptions, callback: Callback<protos.google.ads.googleads.v22.services.IApplyRecommendationResponse, protos.google.ads.googleads.v22.services.IApplyRecommendationRequest | null | undefined, {} | null | undefined>): void;
applyRecommendation(request: protos.google.ads.googleads.v22.services.IApplyRecommendationRequest, callback: Callback<protos.google.ads.googleads.v22.services.IApplyRecommendationResponse, protos.google.ads.googleads.v22.services.IApplyRecommendationRequest | null | undefined, {} | null | undefined>): void;
/**
* Dismisses given recommendations.
*
* List of thrown errors:
* [AuthenticationError]()
* [AuthorizationError]()
* [HeaderError]()
* [InternalError]()
* [QuotaError]()
* [RecommendationError]()
* [RequestError]()
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.customerId
* Required. The ID of the customer with the recommendation.
* @param {number[]} request.operations
* Required. The list of operations to dismiss recommendations.
* If partial_failure=false all recommendations should be of the same type
* There is a limit of 100 operations per request.
* @param {boolean} request.partialFailure
* If true, successful operations will be carried out and invalid
* operations will return errors. If false, operations will be carried in a
* single transaction if and only if they are all valid.
* Default is false.
* @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.DismissRecommendationResponse|DismissRecommendationResponse}.
* 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/recommendation_service.dismiss_recommendation.js</caption>
* region_tag:googleads_v22_generated_RecommendationService_DismissRecommendation_async
*/
dismissRecommendation(request?: protos.google.ads.googleads.v22.services.IDismissRecommendationRequest, options?: CallOptions): Promise<[
protos.google.ads.googleads.v22.services.IDismissRecommendationResponse,
protos.google.ads.googleads.v22.services.IDismissRecommendationRequest | undefined,
{} | undefined
]>;
dismissRecommendation(request: protos.google.ads.googleads.v22.services.IDismissRecommendationRequest, options: CallOptions, callback: Callback<protos.google.ads.googleads.v22.services.IDismissRecommendationResponse, protos.google.ads.googleads.v22.services.IDismissRecommendationRequest | null | undefined, {} | null | undefined>): void;
dismissRecommendation(request: protos.google.ads.googleads.v22.services.IDismissRecommendationRequest, callback: Callback<protos.google.ads.googleads.v22.services.IDismissRecommendationResponse, protos.google.ads.googleads.v22.services.IDismissRecommendationRequest | null | undefined, {} | null | undefined>): void;
/**
* Generates Recommendations based off the requested recommendation_types.
*
* List of thrown errors:
* [AuthenticationError]()
* [AuthorizationError]()
* [HeaderError]()
* [InternalError]()
* [QuotaError]()
* [RecommendationError]()
* [RequestError]()
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.customerId
* Required. The ID of the customer generating recommendations.
* @param {number[]} request.recommendationTypes
* Required. List of eligible recommendation_types to generate. If the
* uploaded criteria isn't sufficient to make a recommendation, or the
* campaign is already in the recommended state, no recommendation will be
* returned for that type. Generally, a recommendation is returned if all
* required fields for that recommendation_type are uploaded, but there are
* cases where this is still not sufficient.
*
* The following recommendation_types are supported for recommendation
* generation:
* CAMPAIGN_BUDGET, KEYWORD, MAXIMIZE_CLICKS_OPT_IN,
* MAXIMIZE_CONVERSIONS_OPT_IN, MAXIMIZE_CONVERSION_VALUE_OPT_IN,
* SET_TARGET_CPA, SET_TARGET_ROAS, SITELINK_ASSET, TARGET_CPA_OPT_IN,
* TARGET_ROAS_OPT_IN
* @param {google.ads.googleads.v22.enums.AdvertisingChannelTypeEnum.AdvertisingChannelType} request.advertisingChannelType
* Required. Advertising channel type of the campaign.
* The following advertising_channel_types are supported for recommendation
* generation:
* PERFORMANCE_MAX and SEARCH
* @param {number} [request.campaignSitelinkCount]
* Optional. Number of sitelinks on the campaign.
* This field is necessary for the following recommendation_types:
* SITELINK_ASSET
* @param {google.ads.googleads.v22.enums.ConversionTrackingStatusEnum.ConversionTrackingStatus} [request.conversionTrackingStatus]
* Optional. Current conversion tracking status.
* This field is necessary for the following recommendation_types:
* MAXIMIZE_CLICKS_OPT_IN, MAXIMIZE_CONVERSIONS_OPT_IN,
* MAXIMIZE_CONVERSION_VALUE_OPT_IN, SET_TARGET_CPA, SET_TARGET_ROAS,
* TARGET_CPA_OPT_IN, TARGET_ROAS_OPT_IN
* @param {google.ads.googleads.v22.services.GenerateRecommendationsRequest.BiddingInfo} [request.biddingInfo]
* Optional. Current bidding information of the campaign.
* This field is necessary for the following recommendation_types:
* CAMPAIGN_BUDGET, MAXIMIZE_CLICKS_OPT_IN, MAXIMIZE_CONVERSIONS_OPT_IN,
* MAXIMIZE_CONVERSION_VALUE_OPT_IN, SET_TARGET_CPA, SET_TARGET_ROAS,
* TARGET_CPA_OPT_IN, TARGET_ROAS_OPT_IN
* @param {number[]} [request.adGroupInfo]
* Optional. Current AdGroup Information.
* Supports information from a single AdGroup.
* This field is optional for the following recommendation_types:
* KEYWORD
* This field is required for the following recommendation_types:
* CAMPAIGN_BUDGET if AdvertisingChannelType is SEARCH
* @param {google.ads.googleads.v22.services.GenerateRecommendationsRequest.SeedInfo} [request.seedInfo]
* Optional. Seed information for Keywords.
* This field is necessary for the following recommendation_types:
* KEYWORD
* @param {google.ads.googleads.v22.services.GenerateRecommendationsRequest.BudgetInfo} [request.budgetInfo]
* Optional. Current budget information.
* This field is optional for the following recommendation_types:
* CAMPAIGN_BUDGET
* @param {number} [request.campaignImageAssetCount]
* Optional. Current campaign image asset count.
* This field is optional for the following recommendation_types:
* CAMPAIGN_BUDGET
* @param {number} [request.campaignCallAssetCount]
* Optional. Current campaign call asset count.
* This field is optional for the following recommendation_types:
* CAMPAIGN_BUDGET
* @param {string[]} [request.countryCodes]
* Optional. Current campaign country codes.
* This field is required for the following recommendation_types:
* CAMPAIGN_BUDGET if AdvertisingChannelType is SEARCH
* @param {string[]} [request.languageCodes]
* Optional. Current campaign language codes.
* This field is required for the following recommendation_types:
* CAMPAIGN_BUDGET if AdvertisingChannelType is SEARCH
* @param {number[]} [request.positiveLocationsIds]
* Optional. Current campaign positive location ids.
* One of this field OR negative_location_ids is required for the following
* recommendation_types: CAMPAIGN_BUDGET if AdvertisingChannelType is SEARCH
* @param {number[]} [request.negativeLocationsIds]
* Optional. Current campaign negative location ids.
* One of this field OR positive_location_ids is required for the following
* recommendation_types: CAMPAIGN_BUDGET if AdvertisingChannelType is SEARCH
* @param {number[]} [request.assetGroupInfo]
* Optional. Current AssetGroup Information.
* This field is required for the following recommendation_types:
* CAMPAIGN_BUDGET
* @param {boolean} [request.targetPartnerSearchNetwork]
* Optional. If true, the campaign is opted into serving ads on the Google
* Partner Network. This field is optional for the following
* recommendation_types: CAMPAIGN_BUDGET
* @param {boolean} [request.targetContentNetwork]
* Optional. If true, the campaign is opted into serving ads on specified
* placements in the Google Display Network. This field is optional for the
* following recommendation_types: CAMPAIGN_BUDGET
* @param {number} [request.merchantCenterAccountId]
* Optional. Merchant Center account ID.
* This field should only be set when advertising_channel_type is
* PERFORMANCE_MAX. Setting this field causes RecommendationService
* to generate recommendations for Performance Max for retail
* instead of standard Performance Max.
* This field is optional for the following recommendation_types:
* CAMPAIGN_BUDGET
* @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.GenerateRecommendationsResponse|GenerateRecommendationsResponse}.
* 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/recommendation_service.generate_recommendations.js</caption>
* region_tag:googleads_v22_generated_RecommendationService_GenerateRecommendations_async
*/
generateRecommendations(request?: protos.google.ads.googleads.v22.services.IGenerateRecommendationsRequest, options?: CallOptions): Promise<[
protos.google.ads.googleads.v22.services.IGenerateRecommendationsResponse,
protos.google.ads.googleads.v22.services.IGenerateRecommendationsRequest | undefined,
{} | undefined
]>;
generateRecommendations(request: protos.google.ads.googleads.v22.services.IGenerateRecommendationsRequest, options: CallOptions, callback: Callback<protos.google.ads.googleads.v22.services.IGenerateRecommendationsResponse, protos.google.ads.googleads.v22.services.IGenerateRecommendationsRequest | null | undefined, {} | null | undefined>): void;
generateRecommendations(request: protos.google.ads.googleads.v22.services.IGenerateRecommendationsRequest, callback: Callback<protos.google.ads.googleads.v22.services.IGenerateRecommendationsResponse, protos.google.ads.googleads.v22.services.IGenerateRecommendationsRequest | 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 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-qualified path representing AdGroupCriterionSimulation resource.
* @returns {string} A string representing the modification_method.
*/
matchModificationMethodFromAdGroupCriterionSimulationName(adGroupCriterionSimulationName: string): string | number;
/**
* Parse the start_date from AdGroupCriterionSimulation resource.
*
* @param {string} adGroupCriterionSimulationName
* A fully-qualified path representing AdGroupCriterionSimulation resource.
* @returns {string} A string representing the start_date.
*/
matchStartDateFromAdGroupCriterionSimulationName(adGroupCriterionSimulationName: string): string | number;
/**
* Parse the end_date from AdGroupCriterionSimulation resource.
*
* @param {string} adGroupCriterionSimulationName
* A fully-qualified path representing AdGroupCriterionSimulation resource.
* @returns {string} A string representing the end_date.
*/
matchEndDateFromAdGroupCriterionSimulationName(adGroupCriterionSimulationName: string): string | number;
/**
* Return a fully-qualified adGroupCustomizer resource name string.
*
* @param {string} customer_id
* @param {string} ad_group_id
* @param {string} customizer_attribute_id
* @returns {string} Resource name string.
*/
adGroupCustomizerPath(customerId: string, adGroupId: string, customizerAttributeId: string): string;
/**
* Parse the customer_id from AdGroupCustomizer resource.
*
* @param {string} adGroupCustomizerName
* A fully-qualified path representing AdGroupCustomizer resource.
* @returns {string} A string representing the customer_id.
*/
matchCustomerIdFromAdGroupCustomizerName(adGroupCustomizerName: string): string | number;
/**
* Parse the ad_group_id from AdGroupCustomizer resource.
*
* @param {string} adGroupCustomizerName
* A fully-qualified path representing AdGroupCustomizer resource.
* @returns {string} A string representing the ad_group_id.
*/
matchAdGroupIdFromAdGroupCustomizerName(adGroupCustomizerName: string): string | number;
/**
* Parse the customizer_attribute_id from AdGroupCustomizer resource.
*
* @param {string} adGroupCustomizerName
* A fully-qualified path representing AdGroupCustomizer resource.
* @returns {string} A string representing the customizer_attribute_id.
*/
matchCustomizerAttributeIdFromAdGroupCustomizerName(adGroupCustomizerName: string): string | number;
/**
* Return a fully-qualified adGroupLabel resource name string.
*
* @param {string} customer_id
* @param {string} ad_group_id
* @param {string} label_id
* @returns {string} Resource name string.
*/
adGroupLabelPath(customerId: string, adGroupId: string, labelId: string): string;
/**
* Parse the customer_id from AdGroupLabel resource.
*
* @param {string} adGroupLabelName
* A fully-qualified path representing AdGroupLabel resource.
* @returns {string} A string representing the customer_id.
*/
matchCustomerIdFromAdGroupLabelName(adGroupLabelName: string): string | number;
/**
* Parse t