google-ads-api-client
Version:
A friendly and exhaustive client to the google-ads-api, code generated directly from google's published protobuf schema.
74 lines (73 loc) • 2.81 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";
/**
* A Google ads experiment for users to experiment changes on multiple
* campaigns, compare the performance, and apply the effective changes.
*
* @generated from protobuf message google.ads.googleads.v11.resources.ExperimentArm
*/
export interface ExperimentArm {
/**
* Immutable. The resource name of the experiment arm.
* Experiment arm resource names have the form:
*
* `customers/{customer_id}/experimentArms/{TrialArm.trial_id}~{TrialArm.trial_arm_id}`
*
* @generated from protobuf field: string resource_name = 1;
*/
resourceName: string;
/**
* Immutable. The experiment to which the ExperimentArm belongs.
*
* @generated from protobuf field: string trial = 2;
*/
trial: string;
/**
* Required. The name of the experiment arm. It must have a minimum length of 1 and
* maximum length of 1024. It must be unique under an experiment.
*
* @generated from protobuf field: string name = 3;
*/
name: string;
/**
* Whether this arm is a control arm. A control arm is the arm against
* which the other arms are compared.
*
* @generated from protobuf field: bool control = 4;
*/
control: boolean;
/**
* Traffic split of the trial arm. The value should be between 1 and 100
* and must total 100 between the two trial arms.
*
* @generated from protobuf field: int64 traffic_split = 5;
*/
trafficSplit: bigint;
/**
* List of campaigns in the trial arm. The max length is one.
*
* @generated from protobuf field: repeated string campaigns = 6;
*/
campaigns: string[];
/**
* Output only. The in design campaigns in the treatment experiment arm.
*
* @generated from protobuf field: repeated string in_design_campaigns = 7;
*/
inDesignCampaigns: string[];
}
declare class ExperimentArm$Type extends MessageType<ExperimentArm> {
constructor();
create(value?: PartialMessage<ExperimentArm>): ExperimentArm;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: ExperimentArm): ExperimentArm;
internalBinaryWrite(message: ExperimentArm, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.resources.ExperimentArm
*/
export declare const ExperimentArm: ExperimentArm$Type;
export {};