google-ads-api-client
Version:
A friendly and exhaustive client to the google-ads-api, code generated directly from google's published protobuf schema.
92 lines (91 loc) • 4.01 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 { BidModifierSimulationPointList } from "../common/simulation";
import { SimulationModificationMethodEnum_SimulationModificationMethod } from "../enums/simulation_modification_method";
import { SimulationTypeEnum_SimulationType } from "../enums/simulation_type";
/**
* A campaign criterion simulation. Supported combinations of advertising
* channel type, criterion ids, simulation type and simulation modification
* method is detailed below respectively.
*
* 1. SEARCH - 30000,30001,30002 - BID_MODIFIER - UNIFORM
* 2. DISPLAY - 30001 - BID_MODIFIER - UNIFORM
*
* @generated from protobuf message google.ads.googleads.v11.resources.CampaignCriterionSimulation
*/
export interface CampaignCriterionSimulation {
/**
* Output only. The resource name of the campaign criterion simulation.
* Campaign criterion simulation resource names have the form:
*
* `customers/{customer_id}/campaignCriterionSimulations/{campaign_id}~{criterion_id}~{type}~{modification_method}~{start_date}~{end_date}`
*
* @generated from protobuf field: string resource_name = 1;
*/
resourceName: string;
/**
* Output only. Campaign ID of the simulation.
*
* @generated from protobuf field: optional int64 campaign_id = 9;
*/
campaignId?: bigint;
/**
* Output only. Criterion ID of the simulation.
*
* @generated from protobuf field: optional int64 criterion_id = 10;
*/
criterionId?: bigint;
/**
* Output only. The field that the simulation modifies.
*
* @generated from protobuf field: google.ads.googleads.v11.enums.SimulationTypeEnum.SimulationType type = 4;
*/
type: SimulationTypeEnum_SimulationType;
/**
* Output only. How the simulation modifies the field.
*
* @generated from protobuf field: google.ads.googleads.v11.enums.SimulationModificationMethodEnum.SimulationModificationMethod modification_method = 5;
*/
modificationMethod: SimulationModificationMethodEnum_SimulationModificationMethod;
/**
* Output only. First day on which the simulation is based, in YYYY-MM-DD format.
*
* @generated from protobuf field: optional string start_date = 11;
*/
startDate?: string;
/**
* Output only. Last day on which the simulation is based, in YYYY-MM-DD format.
*
* @generated from protobuf field: optional string end_date = 12;
*/
endDate?: string;
/**
* @generated from protobuf oneof: point_list
*/
pointList: {
oneofKind: "bidModifierPointList";
/**
* Output only. Simulation points if the simulation type is BID_MODIFIER.
*
* @generated from protobuf field: google.ads.googleads.v11.common.BidModifierSimulationPointList bid_modifier_point_list = 8;
*/
bidModifierPointList: BidModifierSimulationPointList;
} | {
oneofKind: undefined;
};
}
declare class CampaignCriterionSimulation$Type extends MessageType<CampaignCriterionSimulation> {
constructor();
create(value?: PartialMessage<CampaignCriterionSimulation>): CampaignCriterionSimulation;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: CampaignCriterionSimulation): CampaignCriterionSimulation;
internalBinaryWrite(message: CampaignCriterionSimulation, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.resources.CampaignCriterionSimulation
*/
export declare const CampaignCriterionSimulation: CampaignCriterionSimulation$Type;
export {};