google-ads-api-client
Version:
A friendly and exhaustive client to the google-ads-api, code generated directly from google's published protobuf schema.
94 lines (93 loc) • 4.12 kB
TypeScript
import type { BinaryWriteOptions } from "@protobuf-ts/runtime";
import type { IBinaryWriter } from "@protobuf-ts/runtime";
import type { BinaryReadOptions } from "@protobuf-ts/runtime";
import type { IBinaryReader } from "@protobuf-ts/runtime";
import type { PartialMessage } from "@protobuf-ts/runtime";
import { MessageType } from "@protobuf-ts/runtime";
import { TargetRoasSimulationPointList } from "../common/simulation";
import { TargetCpaSimulationPointList } from "../common/simulation";
import { SimulationModificationMethodEnum_SimulationModificationMethod } from "../enums/simulation_modification_method";
import { SimulationTypeEnum_SimulationType } from "../enums/simulation_type";
/**
* A bidding strategy simulation. Supported combinations of simulation type
* and simulation modification method are detailed below respectively.
*
* 1. TARGET_CPA - UNIFORM
* 2. TARGET_ROAS - UNIFORM
*
* @generated from protobuf message google.ads.googleads.v11.resources.BiddingStrategySimulation
*/
export interface BiddingStrategySimulation {
/**
* Output only. The resource name of the bidding strategy simulation.
* Bidding strategy simulation resource names have the form:
*
* `customers/{customer_id}/biddingStrategySimulations/{bidding_strategy_id}~{type}~{modification_method}~{start_date}~{end_date}`
*
* @generated from protobuf field: string resource_name = 1;
*/
resourceName: string;
/**
* Output only. Bidding strategy shared set id of the simulation.
*
* @generated from protobuf field: int64 bidding_strategy_id = 2;
*/
biddingStrategyId: bigint;
/**
* Output only. The field that the simulation modifies.
*
* @generated from protobuf field: google.ads.googleads.v11.enums.SimulationTypeEnum.SimulationType type = 3;
*/
type: SimulationTypeEnum_SimulationType;
/**
* Output only. How the simulation modifies the field.
*
* @generated from protobuf field: google.ads.googleads.v11.enums.SimulationModificationMethodEnum.SimulationModificationMethod modification_method = 4;
*/
modificationMethod: SimulationModificationMethodEnum_SimulationModificationMethod;
/**
* Output only. First day on which the simulation is based, in YYYY-MM-DD format.
*
* @generated from protobuf field: string start_date = 5;
*/
startDate: string;
/**
* Output only. Last day on which the simulation is based, in YYYY-MM-DD format
*
* @generated from protobuf field: string end_date = 6;
*/
endDate: string;
/**
* @generated from protobuf oneof: point_list
*/
pointList: {
oneofKind: "targetCpaPointList";
/**
* Output only. Simulation points if the simulation type is TARGET_CPA.
*
* @generated from protobuf field: google.ads.googleads.v11.common.TargetCpaSimulationPointList target_cpa_point_list = 7;
*/
targetCpaPointList: TargetCpaSimulationPointList;
} | {
oneofKind: "targetRoasPointList";
/**
* Output only. Simulation points if the simulation type is TARGET_ROAS.
*
* @generated from protobuf field: google.ads.googleads.v11.common.TargetRoasSimulationPointList target_roas_point_list = 8;
*/
targetRoasPointList: TargetRoasSimulationPointList;
} | {
oneofKind: undefined;
};
}
declare class BiddingStrategySimulation$Type extends MessageType<BiddingStrategySimulation> {
constructor();
create(value?: PartialMessage<BiddingStrategySimulation>): BiddingStrategySimulation;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: BiddingStrategySimulation): BiddingStrategySimulation;
internalBinaryWrite(message: BiddingStrategySimulation, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.resources.BiddingStrategySimulation
*/
export declare const BiddingStrategySimulation: BiddingStrategySimulation$Type;
export {};