google-ads-api-client
Version:
A friendly and exhaustive client to the google-ads-api, code generated directly from google's published protobuf schema.
189 lines (188 loc) • 8.6 kB
TypeScript
import { ServiceType } from "@protobuf-ts/runtime-rpc";
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 { Status } from "../../google/rpc/status";
import { CampaignCriterion } from "../resources/campaign_criterion";
import { FieldMask } from "../../google/protobuf/field_mask";
import { ResponseContentTypeEnum_ResponseContentType } from "../enums/response_content_type";
/**
* Request message for [CampaignCriterionService.MutateCampaignCriteria][google.ads.googleads.v11.services.CampaignCriterionService.MutateCampaignCriteria].
*
* @generated from protobuf message google.ads.googleads.v11.services.MutateCampaignCriteriaRequest
*/
export interface MutateCampaignCriteriaRequest {
/**
* Required. The ID of the customer whose criteria are being modified.
*
* @generated from protobuf field: string customer_id = 1;
*/
customerId: string;
/**
* Required. The list of operations to perform on individual criteria.
*
* @generated from protobuf field: repeated google.ads.googleads.v11.services.CampaignCriterionOperation operations = 2;
*/
operations: CampaignCriterionOperation[];
/**
* If true, successful operations will be carried out and invalid
* operations will return errors. If false, all operations will be carried
* out in one transaction if and only if they are all valid.
* Default is false.
*
* @generated from protobuf field: bool partial_failure = 3;
*/
partialFailure: boolean;
/**
* If true, the request is validated but not executed. Only errors are
* returned, not results.
*
* @generated from protobuf field: bool validate_only = 4;
*/
validateOnly: boolean;
/**
* The response content type setting. Determines whether the mutable resource
* or just the resource name should be returned post mutation.
*
* @generated from protobuf field: google.ads.googleads.v11.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5;
*/
responseContentType: ResponseContentTypeEnum_ResponseContentType;
}
/**
* A single operation (create, update, remove) on a campaign criterion.
*
* @generated from protobuf message google.ads.googleads.v11.services.CampaignCriterionOperation
*/
export interface CampaignCriterionOperation {
/**
* FieldMask that determines which resource fields are modified in an update.
*
* @generated from protobuf field: google.protobuf.FieldMask update_mask = 4;
*/
updateMask?: FieldMask;
/**
* @generated from protobuf oneof: operation
*/
operation: {
oneofKind: "create";
/**
* Create operation: No resource name is expected for the new criterion.
*
* @generated from protobuf field: google.ads.googleads.v11.resources.CampaignCriterion create = 1;
*/
create: CampaignCriterion;
} | {
oneofKind: "update";
/**
* Update operation: The criterion is expected to have a valid resource
* name.
*
* @generated from protobuf field: google.ads.googleads.v11.resources.CampaignCriterion update = 2;
*/
update: CampaignCriterion;
} | {
oneofKind: "remove";
/**
* Remove operation: A resource name for the removed criterion is expected,
* in this format:
*
* `customers/{customer_id}/campaignCriteria/{campaign_id}~{criterion_id}`
*
* @generated from protobuf field: string remove = 3;
*/
remove: string;
} | {
oneofKind: undefined;
};
}
/**
* Response message for campaign criterion mutate.
*
* @generated from protobuf message google.ads.googleads.v11.services.MutateCampaignCriteriaResponse
*/
export interface MutateCampaignCriteriaResponse {
/**
* Errors that pertain to operation failures in the partial failure mode.
* Returned only when partial_failure = true and all errors occur inside the
* operations. If any errors occur outside the operations (for example, auth
* errors), we return an RPC level error.
*
* @generated from protobuf field: google.rpc.Status partial_failure_error = 3;
*/
partialFailureError?: Status;
/**
* All results for the mutate.
*
* @generated from protobuf field: repeated google.ads.googleads.v11.services.MutateCampaignCriterionResult results = 2;
*/
results: MutateCampaignCriterionResult[];
}
/**
* The result for the criterion mutate.
*
* @generated from protobuf message google.ads.googleads.v11.services.MutateCampaignCriterionResult
*/
export interface MutateCampaignCriterionResult {
/**
* Returned for successful operations.
*
* @generated from protobuf field: string resource_name = 1;
*/
resourceName: string;
/**
* The mutated campaign criterion with only mutable fields after mutate. The
* field will only be returned when response_content_type is set to
* "MUTABLE_RESOURCE".
*
* @generated from protobuf field: google.ads.googleads.v11.resources.CampaignCriterion campaign_criterion = 2;
*/
campaignCriterion?: CampaignCriterion;
}
declare class MutateCampaignCriteriaRequest$Type extends MessageType<MutateCampaignCriteriaRequest> {
constructor();
create(value?: PartialMessage<MutateCampaignCriteriaRequest>): MutateCampaignCriteriaRequest;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateCampaignCriteriaRequest): MutateCampaignCriteriaRequest;
internalBinaryWrite(message: MutateCampaignCriteriaRequest, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateCampaignCriteriaRequest
*/
export declare const MutateCampaignCriteriaRequest: MutateCampaignCriteriaRequest$Type;
declare class CampaignCriterionOperation$Type extends MessageType<CampaignCriterionOperation> {
constructor();
create(value?: PartialMessage<CampaignCriterionOperation>): CampaignCriterionOperation;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: CampaignCriterionOperation): CampaignCriterionOperation;
internalBinaryWrite(message: CampaignCriterionOperation, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.CampaignCriterionOperation
*/
export declare const CampaignCriterionOperation: CampaignCriterionOperation$Type;
declare class MutateCampaignCriteriaResponse$Type extends MessageType<MutateCampaignCriteriaResponse> {
constructor();
create(value?: PartialMessage<MutateCampaignCriteriaResponse>): MutateCampaignCriteriaResponse;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateCampaignCriteriaResponse): MutateCampaignCriteriaResponse;
internalBinaryWrite(message: MutateCampaignCriteriaResponse, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateCampaignCriteriaResponse
*/
export declare const MutateCampaignCriteriaResponse: MutateCampaignCriteriaResponse$Type;
declare class MutateCampaignCriterionResult$Type extends MessageType<MutateCampaignCriterionResult> {
constructor();
create(value?: PartialMessage<MutateCampaignCriterionResult>): MutateCampaignCriterionResult;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateCampaignCriterionResult): MutateCampaignCriterionResult;
internalBinaryWrite(message: MutateCampaignCriterionResult, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateCampaignCriterionResult
*/
export declare const MutateCampaignCriterionResult: MutateCampaignCriterionResult$Type;
/**
* @generated ServiceType for protobuf service google.ads.googleads.v11.services.CampaignCriterionService
*/
export declare const CampaignCriterionService: ServiceType;
export {};