google-ads-node
Version:
Google Ads API client library
1,075 lines (1,074 loc) • 169 kB
TypeScript
/// <reference types="node" />
import * as gax from 'google-gax';
import { Callback, CallOptions, Descriptors, ClientOptions, LROperation, PaginationCallback } from 'google-gax';
import { Transform } from 'stream';
import * as protos from '../../protos/protos';
/**
* Service to manage campaign drafts.
* @class
* @memberof v7
*/
export declare class CampaignDraftServiceClient {
private _terminated;
private _opts;
private _gaxModule;
private _gaxGrpc;
private _protos;
private _defaults;
auth: gax.GoogleAuth;
descriptors: Descriptors;
innerApiCalls: {
[name: string]: Function;
};
pathTemplates: {
[name: string]: gax.PathTemplate;
};
operationsClient: gax.OperationsClient;
campaignDraftServiceStub?: Promise<{
[name: string]: Function;
}>;
/**
* Construct an instance of CampaignDraftServiceClient.
*
* @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/master/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://developers.google.com/identity/protocols/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 fallback mode.
* In fallback mode, a special browser-compatible transport implementation is used
* instead of gRPC transport. In browser context (if the `window` object is defined)
* the fallback mode is enabled automatically; set `options.fallback` to `false`
* if you need to override this behavior.
*/
constructor(opts?: ClientOptions);
/**
* 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.
* @returns {string} The DNS address for this service.
*/
static get servicePath(): string;
/**
* The DNS address for this API service - same as servicePath(),
* exists for compatibility reasons.
* @returns {string} The DNS address for this service.
*/
static get apiEndpoint(): 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;
getCampaignDraft(request: protos.google.ads.googleads.v7.services.IGetCampaignDraftRequest, options?: CallOptions): Promise<[
protos.google.ads.googleads.v7.resources.ICampaignDraft,
protos.google.ads.googleads.v7.services.IGetCampaignDraftRequest | undefined,
{} | undefined
]>;
getCampaignDraft(request: protos.google.ads.googleads.v7.services.IGetCampaignDraftRequest, options: CallOptions, callback: Callback<protos.google.ads.googleads.v7.resources.ICampaignDraft, protos.google.ads.googleads.v7.services.IGetCampaignDraftRequest | null | undefined, {} | null | undefined>): void;
getCampaignDraft(request: protos.google.ads.googleads.v7.services.IGetCampaignDraftRequest, callback: Callback<protos.google.ads.googleads.v7.resources.ICampaignDraft, protos.google.ads.googleads.v7.services.IGetCampaignDraftRequest | null | undefined, {} | null | undefined>): void;
mutateCampaignDrafts(request: protos.google.ads.googleads.v7.services.IMutateCampaignDraftsRequest, options?: CallOptions): Promise<[
protos.google.ads.googleads.v7.services.IMutateCampaignDraftsResponse,
protos.google.ads.googleads.v7.services.IMutateCampaignDraftsRequest | undefined,
{} | undefined
]>;
mutateCampaignDrafts(request: protos.google.ads.googleads.v7.services.IMutateCampaignDraftsRequest, options: CallOptions, callback: Callback<protos.google.ads.googleads.v7.services.IMutateCampaignDraftsResponse, protos.google.ads.googleads.v7.services.IMutateCampaignDraftsRequest | null | undefined, {} | null | undefined>): void;
mutateCampaignDrafts(request: protos.google.ads.googleads.v7.services.IMutateCampaignDraftsRequest, callback: Callback<protos.google.ads.googleads.v7.services.IMutateCampaignDraftsResponse, protos.google.ads.googleads.v7.services.IMutateCampaignDraftsRequest | null | undefined, {} | null | undefined>): void;
promoteCampaignDraft(request: protos.google.ads.googleads.v7.services.IPromoteCampaignDraftRequest, options?: CallOptions): Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.protobuf.IEmpty>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
promoteCampaignDraft(request: protos.google.ads.googleads.v7.services.IPromoteCampaignDraftRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.protobuf.IEmpty>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
promoteCampaignDraft(request: protos.google.ads.googleads.v7.services.IPromoteCampaignDraftRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.protobuf.IEmpty>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
/**
* Check the status of the long running operation returned by `promoteCampaignDraft()`.
* @param {String} name
* The operation name that will be passed.
* @returns {Promise} - The promise which resolves to an object.
* The decoded operation object has result and metadata field to get information from.
* Please see the
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
* for more details and examples.
* @example
* const decodedOperation = await checkPromoteCampaignDraftProgress(name);
* console.log(decodedOperation.result);
* console.log(decodedOperation.done);
* console.log(decodedOperation.metadata);
*/
checkPromoteCampaignDraftProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.protobuf.Empty>>;
listCampaignDraftAsyncErrors(request: protos.google.ads.googleads.v7.services.IListCampaignDraftAsyncErrorsRequest, options?: CallOptions): Promise<[
protos.google.rpc.IStatus[],
protos.google.ads.googleads.v7.services.IListCampaignDraftAsyncErrorsRequest | null,
protos.google.ads.googleads.v7.services.IListCampaignDraftAsyncErrorsResponse
]>;
listCampaignDraftAsyncErrors(request: protos.google.ads.googleads.v7.services.IListCampaignDraftAsyncErrorsRequest, options: CallOptions, callback: PaginationCallback<protos.google.ads.googleads.v7.services.IListCampaignDraftAsyncErrorsRequest, protos.google.ads.googleads.v7.services.IListCampaignDraftAsyncErrorsResponse | null | undefined, protos.google.rpc.IStatus>): void;
listCampaignDraftAsyncErrors(request: protos.google.ads.googleads.v7.services.IListCampaignDraftAsyncErrorsRequest, callback: PaginationCallback<protos.google.ads.googleads.v7.services.IListCampaignDraftAsyncErrorsRequest, protos.google.ads.googleads.v7.services.IListCampaignDraftAsyncErrorsResponse | null | undefined, protos.google.rpc.IStatus>): void;
/**
* Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object.
* @param {Object} request
* The request object that will be sent.
* @param {string} request.resource_name
* Required. The name of the campaign draft from which to retrieve the async errors.
* @param {string} request.pageToken
* Token of the page to retrieve. If not specified, the first
* page of results will be returned. Use the value obtained from
* `next_page_token` in the previous response in order to request
* the next page of results.
* @param {number} request.pageSize
* Number of elements to retrieve in a single page.
* When a page request is too large, the server may decide to
* further limit the number of returned resources.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Stream}
* An object stream which emits an object representing [Status]{@link google.rpc.Status} on 'data' event.
* The client library will perform auto-pagination by default: it will call the API as many
* times as needed. Note that it can affect your quota.
* We recommend using `listCampaignDraftAsyncErrorsAsync()`
* method described below for async iteration which you can stop as needed.
* Please see the
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
* for more details and examples.
*/
listCampaignDraftAsyncErrorsStream(request?: protos.google.ads.googleads.v7.services.IListCampaignDraftAsyncErrorsRequest, options?: CallOptions): Transform;
/**
* Equivalent to `listCampaignDraftAsyncErrors`, but returns an iterable object.
*
* `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
* @param {Object} request
* The request object that will be sent.
* @param {string} request.resource_name
* Required. The name of the campaign draft from which to retrieve the async errors.
* @param {string} request.pageToken
* Token of the page to retrieve. If not specified, the first
* page of results will be returned. Use the value obtained from
* `next_page_token` in the previous response in order to request
* the next page of results.
* @param {number} request.pageSize
* Number of elements to retrieve in a single page.
* When a page request is too large, the server may decide to
* further limit the number of returned resources.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Object}
* An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols).
* When you iterate the returned iterable, each element will be an object representing
* [Status]{@link google.rpc.Status}. The API will be called under the hood as needed, once per the page,
* so you can stop the iteration when you don't need more results.
* Please see the
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
* for more details and examples.
* @example
* const iterable = client.listCampaignDraftAsyncErrorsAsync(request);
* for await (const response of iterable) {
* // process response
* }
*/
listCampaignDraftAsyncErrorsAsync(request?: protos.google.ads.googleads.v7.services.IListCampaignDraftAsyncErrorsRequest, options?: CallOptions): AsyncIterable<protos.google.rpc.IStatus>;
/**
* 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 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 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 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 adGroupExtensionSetting resource name string.
*
* @param {string} customer_id
* @param {string} ad_group_id
* @param {string} extension_type
* @returns {string} Resource name string.
*/
adGroupExtensionSettingPath(customerId: string, adGroupId: string, extensionType: string): string;
/**
* Parse the customer_id from AdGroupExtensionSetting resource.
*
* @param {string} adGroupExtensionSettingName
* A fully-qualified path representing AdGroupExtensionSetting resource.
* @returns {string} A string representing the customer_id.
*/
matchCustomerIdFromAdGroupExtensionSettingName(adGroupExtensionSettingName: string): string | number;
/**
* Parse the ad_group_id from AdGroupExtensionSetting resource.
*
* @param {string} adGroupExtensionSettingName
* A fully-qualified path representing AdGroupExtensionSetting resource.
* @returns {string} A string representing the ad_group_id.
*/
matchAdGroupIdFromAdGroupExtensionSettingName(adGroupExtensionSettingName: string): string | number;
/**
* Parse the extension_type from AdGroupExtensionSetting resource.
*
* @param {string} adGroupExtensionSettingName
* A fully-qualified path representing AdGroupExtensionSetting resource.
* @returns {string} A string representing the extension_type.
*/
matchExtensionTypeFromAdGroupExtensionSettingName(adGroupExtensionSettingName: string): string | number;
/**
* Return a fully-qualified adGroupFeed resource name string.
*
* @param {string} customer_id
* @param {string} ad_group_id
* @param {string} feed_id
* @returns {string} Resource name string.
*/
adGroupFeedPath(customerId: string, adGroupId: string, feedId: string): string;
/**
* Parse the customer_id from AdGroupFeed resource.
*
* @param {string} adGroupFeedName
* A fully-qualified path representing AdGroupFeed resource.
* @returns {string} A string representing the customer_id.
*/
matchCustomerIdFromAdGroupFeedName(adGroupFeedName: string): string | number;
/**
* Parse the ad_group_id from AdGroupFeed resource.
*
* @param {string} adGroupFeedName
* A fully-qualified path representing AdGroupFeed resource.
* @returns {string} A string representing the ad_group_id.
*/
matchAdGroupIdFromAdGroupFeedName(adGroupFeedName: string): string | number;
/**
* Parse the feed_id from AdGroupFeed resource.
*
* @param {string} adGroupFeedName
* A fully-qualified path representing AdGroupFeed resource.
* @returns {string} A string representing the feed_id.
*/
matchFeedIdFromAdGroupFeedName(adGroupFeedName: 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 the ad_group_id from AdGroupLabel resource.
*
* @param {string} adGroupLabelName
* A fully-qualified path representing AdGroupLabel resource.
* @returns {string} A string representing the ad_group_id.
*/
matchAdGroupIdFromAdGroupLabelName(adGroupLabelName: string): string | number;
/**
* Parse the label_id from AdGroupLabel resource.
*
* @param {string} adGroupLabelName
* A fully-qualified path representing AdGroupLabel resource.
* @returns {string} A string representing the label_id.
*/
matchLabelIdFromAdGroupLabelName(adGroupLabelName: string): string | number;
/**
* Return a fully-qualified adGroupSimulation resource name string.
*
* @param {string} customer_id
* @param {string} ad_group_id
* @param {string} type
* @param {string} modification_method
* @param {string} start_date
* @param {string} end_date
* @returns {string} Resource name string.
*/
adGroupSimulationPath(customerId: string, adGroupId: string, type: string, modificationMethod: string, startDate: string, endDate: string): string;
/**
* Parse the customer_id from AdGroupSimulation resource.
*
* @param {string} adGroupSimulationName
* A fully-qualified path representing AdGroupSimulation resource.
* @returns {string} A string representing the customer_id.
*/
matchCustomerIdFromAdGroupSimulationName(adGroupSimulationName: string): string | number;
/**
* Parse the ad_group_id from AdGroupSimulation resource.
*
* @param {string} adGroupSimulationName
* A fully-qualified path representing AdGroupSimulation resource.
* @returns {string} A string representing the ad_group_id.
*/
matchAdGroupIdFromAdGroupSimulationName(adGroupSimulationName: string): string | number;
/**
* Parse the type from AdGroupSimulation resource.
*
* @param {string} adGroupSimulationName
* A fully-qualified path representing AdGroupSimulation resource.
* @returns {string} A string representing the type.
*/
matchTypeFromAdGroupSimulationName(adGroupSimulationName: string): string | number;
/**
* Parse the modification_method from AdGroupSimulation resource.
*
* @param {string} adGroupSimulationName
* A fully-qualified path representing AdGroupSimulation resource.
* @returns {string} A string representing the modification_method.
*/
matchModificationMethodFromAdGroupSimulationName(adGroupSimulationName: string): string | number;
/**
* Parse the start_date from AdGroupSimulation resource.
*
* @param {string} adGroupSimulationName
* A fully-qualified path representing AdGroupSimulation resource.
* @returns {string} A string representing the start_date.
*/
matchStartDateFromAdGroupSimulationName(adGroupSimulationName: string): string | number;
/**
* Parse the end_date from AdGroupSimulation resource.
*
* @param {string} adGroupSimulationName
* A fully-qualified path representing AdGroupSimulation resource.
* @returns {string} A string representing the end_date.
*/
matchEndDateFromAdGroupSimulationName(adGroupSimulationName: string): string | number;
/**
* Return a fully-qualified adParameter resource name string.
*
* @param {string} customer_id
* @param {string} ad_group_id
* @param {string} criterion_id
* @param {string} parameter_index
* @returns {string} Resource name string.
*/
adParameterPath(customerId: string, adGroupId: string, criterionId: string, parameterIndex: string): string;
/**
* Parse the customer_id from AdParameter resource.
*
* @param {string} adParameterName
* A fully-qualified path representing AdParameter resource.
* @returns {string} A string representing the customer_id.
*/
matchCustomerIdFromAdParameterName(adParameterName: string): string | number;
/**
* Parse the ad_group_id from AdParameter resource.
*
* @param {string} adParameterName
* A fully-qualified path representing AdParameter resource.
* @returns {string} A string representing the ad_group_id.
*/
matchAdGroupIdFromAdParameterName(adParameterName: string): string | number;
/**
* Parse the criterion_id from AdParameter resource.
*
* @param {string} adParameterName
* A fully-qualified path representing AdParameter resource.
* @returns {string} A string representing the criterion_id.
*/
matchCriterionIdFromAdParameterName(adParameterName: string): string | number;
/**
* Parse the parameter_index from AdParameter resource.
*
* @param {string} adParameterName
* A fully-qualified path representing AdParameter resource.
* @returns {string} A string representing the parameter_index.
*/
matchParameterIndexFromAdParameterName(adParameterName: string): string | number;
/**
* Return a fully-qualified adScheduleView resource name string.
*
* @param {string} customer_id
* @param {string} campaign_id
* @param {string} criterion_id
* @returns {string} Resource name string.
*/
adScheduleViewPath(customerId: string, campaignId: string, criterionId: string): string;
/**
* Parse the customer_id from AdScheduleView resource.
*
* @param {string} adScheduleViewName
* A fully-qualified path representing AdScheduleView resource.
* @returns {string} A string representing the customer_id.
*/
matchCustomerIdFromAdScheduleViewName(adScheduleViewName: string): string | number;
/**
* Parse the campaign_id from AdScheduleView resource.
*
* @param {string} adScheduleViewName
* A fully-qualified path representing AdScheduleView resource.
* @returns {string} A string representing the campaign_id.
*/
matchCampaignIdFromAdScheduleViewName(adScheduleViewName: string): string | number;
/**
* Parse the criterion_id from AdScheduleView resource.
*
* @param {string} adScheduleViewName
* A fully-qualified path representing AdScheduleView resource.
* @returns {string} A string representing the criterion_id.
*/
matchCriterionIdFromAdScheduleViewName(adScheduleViewName: string): string | number;
/**
* Return a fully-qualified ageRangeView resource name string.
*
* @param {string} customer_id
* @param {string} ad_group_id
* @param {string} criterion_id
* @returns {string} Resource name string.
*/
ageRangeViewPath(customerId: string, adGroupId: string, criterionId: string): string;
/**
* Parse the customer_id from AgeRangeView resource.
*
* @param {string} ageRangeViewName
* A fully-qualified path representing AgeRangeView resource.
* @returns {string} A string representing the customer_id.
*/
matchCustomerIdFromAgeRangeViewName(ageRangeViewName: string): string | number;
/**
* Parse the ad_group_id from AgeRangeView resource.
*
* @param {string} ageRangeViewName
* A fully-qualified path representing AgeRangeView resource.
* @returns {string} A string representing the ad_group_id.
*/
matchAdGroupIdFromAgeRangeViewName(ageRangeViewName: string): string | number;
/**
* Parse the criterion_id from AgeRangeView resource.
*
* @param {string} ageRangeViewName
* A fully-qualified path representing AgeRangeView resource.
* @returns {string} A string representing the criterion_id.
*/
matchCriterionIdFromAgeRangeViewName(ageRangeViewName: string): string | number;
/**
* Return a fully-qualified asset resource name string.
*
* @param {string} customer_id
* @param {string} asset_id
* @returns {string} Resource name string.
*/
assetPath(customerId: string, assetId: string): string;
/**
* Parse the customer_id from Asset resource.
*
* @param {string} assetName
* A fully-qualified path representing Asset resource.
* @returns {string} A string representing the customer_id.
*/
matchCustomerIdFromAssetName(assetName: string): string | number;
/**
* Parse the asset_id from Asset resource.
*
* @param {string} assetName
* A fully-qualified path representing Asset resource.
* @returns {string} A string representing the asset_id.
*/
matchAssetIdFromAssetName(assetName: string): string | number;
/**
* Return a fully-qualified batchJob resource name string.
*
* @param {string} customer_id
* @param {string} batch_job_id
* @returns {string} Resource name string.
*/
batchJobPath(customerId: string, batchJobId: string): string;
/**
* Parse the customer_id from BatchJob resource.
*
* @param {string} batchJobName
* A fully-qualified path representing BatchJob resource.
* @returns {string} A string representing the customer_id.
*/
matchCustomerIdFromBatchJobName(batchJobName: string): string | number;
/**
* Parse the batch_job_id from BatchJob resource.
*
* @param {string} batchJobName
* A fully-qualified path representing BatchJob resource.
* @returns {string} A string representing the batch_job_id.
*/
matchBatchJobIdFromBatchJobName(batchJobName: string): string | number;
/**
* Return a fully-qualified biddingStrategy resource name string.
*
* @param {string} customer_id
* @param {string} bidding_strategy_id
* @returns {string} Resource name string.
*/
biddingStrategyPath(customerId: string, biddingStrategyId: string): string;
/**
* Parse the customer_id from BiddingStrategy resource.
*
* @param {string} biddingStrategyName
* A fully-qualified path representing BiddingStrategy resource.
* @returns {string} A string representing the customer_id.
*/
matchCustomerIdFromBiddingStrategyName(biddingStrategyName: string): string | number;
/**
* Parse the bidding_strategy_id from BiddingStrategy resource.
*
* @param {string} biddingStrategyName
* A fully-qualified path representing BiddingStrategy resource.
* @returns {string} A string representing the bidding_strategy_id.
*/
matchBiddingStrategyIdFromBiddingStrategyName(biddingStrategyName: string): string | number;
/**
* Return a fully-qualified biddingStrategySimulation resource name string.
*
* @param {string} customer_id
* @param {string} bidding_strategy_id
* @param {string} type
* @param {string} modification_method
* @param {string} start_date
* @param {string} end_date
* @returns {string} Resource name string.
*/
biddingStrategySimulationPath(customerId: string, biddingStrategyId: string, type: string, modificationMethod: string, startDate: string, endDate: string): string;
/**
* Parse the customer_id from BiddingStrategySimulation resource.
*
* @param {string} biddingStrategySimulationName
* A fully-qualified path representing BiddingStrategySimulation resource.
* @returns {string} A string representing the customer_id.
*/
matchCustomerIdFromBiddingStrategySimulationName(biddingStrategySimulationName: string): string | number;
/**
* Parse the bidding_strategy_id from BiddingStrategySimulation resource.
*
* @param {string} biddingStrategySimulationName
* A fully-qualified path representing BiddingStrategySimulation resource.
* @returns {string} A string representing the bidding_strategy_id.
*/
matchBiddingStrategyIdFromBiddingStrategySimulationName(biddingStrategySimulationName: string): string | number;
/**