google-ads-api-client
Version:
A friendly and exhaustive client to the google-ads-api, code generated directly from google's published protobuf schema.
161 lines • 7.42 kB
JavaScript
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.CampaignExperimentServiceClient = void 0;
const campaign_experiment_service_1 = require("./campaign_experiment_service");
const runtime_rpc_1 = require("@protobuf-ts/runtime-rpc");
// Proto file describing the Campaign Experiment service.
/**
* CampaignExperimentService manages the life cycle of campaign experiments.
* It is used to create new experiments from drafts, modify experiment
* properties, promote changes in an experiment back to its base campaign,
* graduate experiments into new stand-alone campaigns, and to remove an
* experiment.
*
* An experiment consists of two variants or arms - the base campaign and the
* experiment campaign, directing a fixed share of traffic to each arm.
* A campaign experiment is created from a draft of changes to the base campaign
* and will be a snapshot of changes in the draft at the time of creation.
*
* @generated from protobuf service google.ads.googleads.v11.services.CampaignExperimentService
*/
class CampaignExperimentServiceClient {
constructor(_transport) {
this._transport = _transport;
this.typeName = campaign_experiment_service_1.CampaignExperimentService.typeName;
this.methods = campaign_experiment_service_1.CampaignExperimentService.methods;
this.options = campaign_experiment_service_1.CampaignExperimentService.options;
}
/**
* Creates a campaign experiment based on a campaign draft. The draft campaign
* will be forked into a real campaign (called the experiment campaign) that
* will begin serving ads if successfully created.
*
* The campaign experiment is created immediately with status INITIALIZING.
* This method return a long running operation that tracks the forking of the
* draft campaign. If the forking fails, a list of errors can be retrieved
* using the ListCampaignExperimentAsyncErrors method. The operation's
* metadata will be a StringValue containing the resource name of the created
* campaign experiment.
*
* List of thrown errors:
* [AuthenticationError]()
* [AuthorizationError]()
* [CampaignExperimentError]()
* [DatabaseError]()
* [DateError]()
* [DateRangeError]()
* [FieldError]()
* [HeaderError]()
* [InternalError]()
* [QuotaError]()
* [RangeError]()
* [RequestError]()
*
* @generated from protobuf rpc: CreateCampaignExperiment(google.ads.googleads.v11.services.CreateCampaignExperimentRequest) returns (google.longrunning.Operation);
*/
createCampaignExperiment(input, options) {
const method = this.methods[0], opt = this._transport.mergeOptions(options);
return (0, runtime_rpc_1.stackIntercept)("unary", this._transport, method, opt, input);
}
/**
* Updates campaign experiments. Operation statuses are returned.
*
* List of thrown errors:
* [AuthenticationError]()
* [AuthorizationError]()
* [CampaignExperimentError]()
* [HeaderError]()
* [InternalError]()
* [QuotaError]()
* [RequestError]()
*
* @generated from protobuf rpc: MutateCampaignExperiments(google.ads.googleads.v11.services.MutateCampaignExperimentsRequest) returns (google.ads.googleads.v11.services.MutateCampaignExperimentsResponse);
*/
mutateCampaignExperiments(input, options) {
const method = this.methods[1], opt = this._transport.mergeOptions(options);
return (0, runtime_rpc_1.stackIntercept)("unary", this._transport, method, opt, input);
}
/**
* Graduates a campaign experiment to a full campaign. The base and experiment
* campaigns will start running independently with their own budgets.
*
* List of thrown errors:
* [AuthenticationError]()
* [AuthorizationError]()
* [CampaignExperimentError]()
* [HeaderError]()
* [InternalError]()
* [MutateError]()
* [QuotaError]()
* [RequestError]()
*
* @generated from protobuf rpc: GraduateCampaignExperiment(google.ads.googleads.v11.services.GraduateCampaignExperimentRequest) returns (google.ads.googleads.v11.services.GraduateCampaignExperimentResponse);
*/
graduateCampaignExperiment(input, options) {
const method = this.methods[2], opt = this._transport.mergeOptions(options);
return (0, runtime_rpc_1.stackIntercept)("unary", this._transport, method, opt, input);
}
/**
* Promotes the changes in a experiment campaign back to the base campaign.
*
* The campaign experiment is updated immediately with status PROMOTING.
* This method return a long running operation that tracks the promoting of
* the experiment campaign. If the promoting fails, a list of errors can be
* retrieved using the ListCampaignExperimentAsyncErrors method.
*
* List of thrown errors:
* [AuthenticationError]()
* [AuthorizationError]()
* [HeaderError]()
* [InternalError]()
* [QuotaError]()
* [RequestError]()
*
* @generated from protobuf rpc: PromoteCampaignExperiment(google.ads.googleads.v11.services.PromoteCampaignExperimentRequest) returns (google.longrunning.Operation);
*/
promoteCampaignExperiment(input, options) {
const method = this.methods[3], opt = this._transport.mergeOptions(options);
return (0, runtime_rpc_1.stackIntercept)("unary", this._transport, method, opt, input);
}
/**
* Immediately ends a campaign experiment, changing the experiment's scheduled
* end date and without waiting for end of day. End date is updated to be the
* time of the request.
*
* List of thrown errors:
* [AuthenticationError]()
* [AuthorizationError]()
* [CampaignExperimentError]()
* [HeaderError]()
* [InternalError]()
* [QuotaError]()
* [RequestError]()
*
* @generated from protobuf rpc: EndCampaignExperiment(google.ads.googleads.v11.services.EndCampaignExperimentRequest) returns (google.protobuf.Empty);
*/
endCampaignExperiment(input, options) {
const method = this.methods[4], opt = this._transport.mergeOptions(options);
return (0, runtime_rpc_1.stackIntercept)("unary", this._transport, method, opt, input);
}
/**
* Returns all errors that occurred during CampaignExperiment create or
* promote (whichever occurred last).
* Supports standard list paging.
*
* List of thrown errors:
* [AuthenticationError]()
* [AuthorizationError]()
* [HeaderError]()
* [InternalError]()
* [QuotaError]()
* [RequestError]()
*
* @generated from protobuf rpc: ListCampaignExperimentAsyncErrors(google.ads.googleads.v11.services.ListCampaignExperimentAsyncErrorsRequest) returns (google.ads.googleads.v11.services.ListCampaignExperimentAsyncErrorsResponse);
*/
listCampaignExperimentAsyncErrors(input, options) {
const method = this.methods[5], opt = this._transport.mergeOptions(options);
return (0, runtime_rpc_1.stackIntercept)("unary", this._transport, method, opt, input);
}
}
exports.CampaignExperimentServiceClient = CampaignExperimentServiceClient;
//# sourceMappingURL=campaign_experiment_service.client.js.map