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.45 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 { CampaignBudget } from "../resources/campaign_budget";
import { FieldMask } from "../../google/protobuf/field_mask";
import { ResponseContentTypeEnum_ResponseContentType } from "../enums/response_content_type";
/**
* Request message for [CampaignBudgetService.MutateCampaignBudgets][google.ads.googleads.v11.services.CampaignBudgetService.MutateCampaignBudgets].
*
* @generated from protobuf message google.ads.googleads.v11.services.MutateCampaignBudgetsRequest
*/
export interface MutateCampaignBudgetsRequest {
/**
* Required. The ID of the customer whose campaign budgets are being modified.
*
* @generated from protobuf field: string customer_id = 1;
*/
customerId: string;
/**
* Required. The list of operations to perform on individual campaign budgets.
*
* @generated from protobuf field: repeated google.ads.googleads.v11.services.CampaignBudgetOperation operations = 2;
*/
operations: CampaignBudgetOperation[];
/**
* 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 budget.
*
* @generated from protobuf message google.ads.googleads.v11.services.CampaignBudgetOperation
*/
export interface CampaignBudgetOperation {
/**
* 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 budget.
*
* @generated from protobuf field: google.ads.googleads.v11.resources.CampaignBudget create = 1;
*/
create: CampaignBudget;
} | {
oneofKind: "update";
/**
* Update operation: The campaign budget is expected to have a valid
* resource name.
*
* @generated from protobuf field: google.ads.googleads.v11.resources.CampaignBudget update = 2;
*/
update: CampaignBudget;
} | {
oneofKind: "remove";
/**
* Remove operation: A resource name for the removed budget is expected, in
* this format:
*
* `customers/{customer_id}/campaignBudgets/{budget_id}`
*
* @generated from protobuf field: string remove = 3;
*/
remove: string;
} | {
oneofKind: undefined;
};
}
/**
* Response message for campaign budget mutate.
*
* @generated from protobuf message google.ads.googleads.v11.services.MutateCampaignBudgetsResponse
*/
export interface MutateCampaignBudgetsResponse {
/**
* 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.MutateCampaignBudgetResult results = 2;
*/
results: MutateCampaignBudgetResult[];
}
/**
* The result for the campaign budget mutate.
*
* @generated from protobuf message google.ads.googleads.v11.services.MutateCampaignBudgetResult
*/
export interface MutateCampaignBudgetResult {
/**
* Returned for successful operations.
*
* @generated from protobuf field: string resource_name = 1;
*/
resourceName: string;
/**
* The mutated campaign budget 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.CampaignBudget campaign_budget = 2;
*/
campaignBudget?: CampaignBudget;
}
declare class MutateCampaignBudgetsRequest$Type extends MessageType<MutateCampaignBudgetsRequest> {
constructor();
create(value?: PartialMessage<MutateCampaignBudgetsRequest>): MutateCampaignBudgetsRequest;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateCampaignBudgetsRequest): MutateCampaignBudgetsRequest;
internalBinaryWrite(message: MutateCampaignBudgetsRequest, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateCampaignBudgetsRequest
*/
export declare const MutateCampaignBudgetsRequest: MutateCampaignBudgetsRequest$Type;
declare class CampaignBudgetOperation$Type extends MessageType<CampaignBudgetOperation> {
constructor();
create(value?: PartialMessage<CampaignBudgetOperation>): CampaignBudgetOperation;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: CampaignBudgetOperation): CampaignBudgetOperation;
internalBinaryWrite(message: CampaignBudgetOperation, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.CampaignBudgetOperation
*/
export declare const CampaignBudgetOperation: CampaignBudgetOperation$Type;
declare class MutateCampaignBudgetsResponse$Type extends MessageType<MutateCampaignBudgetsResponse> {
constructor();
create(value?: PartialMessage<MutateCampaignBudgetsResponse>): MutateCampaignBudgetsResponse;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateCampaignBudgetsResponse): MutateCampaignBudgetsResponse;
internalBinaryWrite(message: MutateCampaignBudgetsResponse, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateCampaignBudgetsResponse
*/
export declare const MutateCampaignBudgetsResponse: MutateCampaignBudgetsResponse$Type;
declare class MutateCampaignBudgetResult$Type extends MessageType<MutateCampaignBudgetResult> {
constructor();
create(value?: PartialMessage<MutateCampaignBudgetResult>): MutateCampaignBudgetResult;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateCampaignBudgetResult): MutateCampaignBudgetResult;
internalBinaryWrite(message: MutateCampaignBudgetResult, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateCampaignBudgetResult
*/
export declare const MutateCampaignBudgetResult: MutateCampaignBudgetResult$Type;
/**
* @generated ServiceType for protobuf service google.ads.googleads.v11.services.CampaignBudgetService
*/
export declare const CampaignBudgetService: ServiceType;
export {};