google-ads-api-client
Version:
A friendly and exhaustive client to the google-ads-api, code generated directly from google's published protobuf schema.
190 lines (189 loc) • 8.41 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 { CampaignGroup } from "../resources/campaign_group";
import { FieldMask } from "../../google/protobuf/field_mask";
import { ResponseContentTypeEnum_ResponseContentType } from "../enums/response_content_type";
/**
* Request message for [CampaignGroupService.MutateCampaignGroups][google.ads.googleads.v11.services.CampaignGroupService.MutateCampaignGroups].
*
* @generated from protobuf message google.ads.googleads.v11.services.MutateCampaignGroupsRequest
*/
export interface MutateCampaignGroupsRequest {
/**
* Required. The ID of the customer whose campaign groups are being modified.
*
* @generated from protobuf field: string customer_id = 1;
*/
customerId: string;
/**
* Required. The list of operations to perform on individual campaign groups.
*
* @generated from protobuf field: repeated google.ads.googleads.v11.services.CampaignGroupOperation operations = 2;
*/
operations: CampaignGroupOperation[];
/**
* 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 group.
*
* @generated from protobuf message google.ads.googleads.v11.services.CampaignGroupOperation
*/
export interface CampaignGroupOperation {
/**
* 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 campaign
* group.
*
* @generated from protobuf field: google.ads.googleads.v11.resources.CampaignGroup create = 1;
*/
create: CampaignGroup;
} | {
oneofKind: "update";
/**
* Update operation: The campaign group is expected to have a valid
* resource name.
*
* @generated from protobuf field: google.ads.googleads.v11.resources.CampaignGroup update = 2;
*/
update: CampaignGroup;
} | {
oneofKind: "remove";
/**
* Remove operation: A resource name for the removed campaign group is
* expected, in this format:
*
* `customers/{customer_id}/campaignGroups/{campaign_group_id}`
*
* @generated from protobuf field: string remove = 3;
*/
remove: string;
} | {
oneofKind: undefined;
};
}
/**
* Response message for campaign group mutate.
*
* @generated from protobuf message google.ads.googleads.v11.services.MutateCampaignGroupsResponse
*/
export interface MutateCampaignGroupsResponse {
/**
* All results for the mutate.
*
* @generated from protobuf field: repeated google.ads.googleads.v11.services.MutateCampaignGroupResult results = 2;
*/
results: MutateCampaignGroupResult[];
/**
* 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;
}
/**
* The result for the campaign group mutate.
*
* @generated from protobuf message google.ads.googleads.v11.services.MutateCampaignGroupResult
*/
export interface MutateCampaignGroupResult {
/**
* Required. Returned for successful operations.
*
* @generated from protobuf field: string resource_name = 1;
*/
resourceName: string;
/**
* The mutated campaign group 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.CampaignGroup campaign_group = 2;
*/
campaignGroup?: CampaignGroup;
}
declare class MutateCampaignGroupsRequest$Type extends MessageType<MutateCampaignGroupsRequest> {
constructor();
create(value?: PartialMessage<MutateCampaignGroupsRequest>): MutateCampaignGroupsRequest;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateCampaignGroupsRequest): MutateCampaignGroupsRequest;
internalBinaryWrite(message: MutateCampaignGroupsRequest, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateCampaignGroupsRequest
*/
export declare const MutateCampaignGroupsRequest: MutateCampaignGroupsRequest$Type;
declare class CampaignGroupOperation$Type extends MessageType<CampaignGroupOperation> {
constructor();
create(value?: PartialMessage<CampaignGroupOperation>): CampaignGroupOperation;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: CampaignGroupOperation): CampaignGroupOperation;
internalBinaryWrite(message: CampaignGroupOperation, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.CampaignGroupOperation
*/
export declare const CampaignGroupOperation: CampaignGroupOperation$Type;
declare class MutateCampaignGroupsResponse$Type extends MessageType<MutateCampaignGroupsResponse> {
constructor();
create(value?: PartialMessage<MutateCampaignGroupsResponse>): MutateCampaignGroupsResponse;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateCampaignGroupsResponse): MutateCampaignGroupsResponse;
internalBinaryWrite(message: MutateCampaignGroupsResponse, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateCampaignGroupsResponse
*/
export declare const MutateCampaignGroupsResponse: MutateCampaignGroupsResponse$Type;
declare class MutateCampaignGroupResult$Type extends MessageType<MutateCampaignGroupResult> {
constructor();
create(value?: PartialMessage<MutateCampaignGroupResult>): MutateCampaignGroupResult;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateCampaignGroupResult): MutateCampaignGroupResult;
internalBinaryWrite(message: MutateCampaignGroupResult, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateCampaignGroupResult
*/
export declare const MutateCampaignGroupResult: MutateCampaignGroupResult$Type;
/**
* @generated ServiceType for protobuf service google.ads.googleads.v11.services.CampaignGroupService
*/
export declare const CampaignGroupService: ServiceType;
export {};