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.08 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 { SharedSet } from "../resources/shared_set";
import { FieldMask } from "../../google/protobuf/field_mask";
import { ResponseContentTypeEnum_ResponseContentType } from "../enums/response_content_type";
/**
* Request message for [SharedSetService.MutateSharedSets][google.ads.googleads.v11.services.SharedSetService.MutateSharedSets].
*
* @generated from protobuf message google.ads.googleads.v11.services.MutateSharedSetsRequest
*/
export interface MutateSharedSetsRequest {
/**
* Required. The ID of the customer whose shared sets are being modified.
*
* @generated from protobuf field: string customer_id = 1;
*/
customerId: string;
/**
* Required. The list of operations to perform on individual shared sets.
*
* @generated from protobuf field: repeated google.ads.googleads.v11.services.SharedSetOperation operations = 2;
*/
operations: SharedSetOperation[];
/**
* 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 an shared set.
*
* @generated from protobuf message google.ads.googleads.v11.services.SharedSetOperation
*/
export interface SharedSetOperation {
/**
* 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 shared set.
*
* @generated from protobuf field: google.ads.googleads.v11.resources.SharedSet create = 1;
*/
create: SharedSet;
} | {
oneofKind: "update";
/**
* Update operation: The shared set is expected to have a valid resource
* name.
*
* @generated from protobuf field: google.ads.googleads.v11.resources.SharedSet update = 2;
*/
update: SharedSet;
} | {
oneofKind: "remove";
/**
* Remove operation: A resource name for the removed shared set is expected,
* in this format:
*
* `customers/{customer_id}/sharedSets/{shared_set_id}`
*
* @generated from protobuf field: string remove = 3;
*/
remove: string;
} | {
oneofKind: undefined;
};
}
/**
* Response message for a shared set mutate.
*
* @generated from protobuf message google.ads.googleads.v11.services.MutateSharedSetsResponse
*/
export interface MutateSharedSetsResponse {
/**
* 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.MutateSharedSetResult results = 2;
*/
results: MutateSharedSetResult[];
}
/**
* The result for the shared set mutate.
*
* @generated from protobuf message google.ads.googleads.v11.services.MutateSharedSetResult
*/
export interface MutateSharedSetResult {
/**
* Returned for successful operations.
*
* @generated from protobuf field: string resource_name = 1;
*/
resourceName: string;
/**
* The mutated shared set 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.SharedSet shared_set = 2;
*/
sharedSet?: SharedSet;
}
declare class MutateSharedSetsRequest$Type extends MessageType<MutateSharedSetsRequest> {
constructor();
create(value?: PartialMessage<MutateSharedSetsRequest>): MutateSharedSetsRequest;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateSharedSetsRequest): MutateSharedSetsRequest;
internalBinaryWrite(message: MutateSharedSetsRequest, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateSharedSetsRequest
*/
export declare const MutateSharedSetsRequest: MutateSharedSetsRequest$Type;
declare class SharedSetOperation$Type extends MessageType<SharedSetOperation> {
constructor();
create(value?: PartialMessage<SharedSetOperation>): SharedSetOperation;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: SharedSetOperation): SharedSetOperation;
internalBinaryWrite(message: SharedSetOperation, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.SharedSetOperation
*/
export declare const SharedSetOperation: SharedSetOperation$Type;
declare class MutateSharedSetsResponse$Type extends MessageType<MutateSharedSetsResponse> {
constructor();
create(value?: PartialMessage<MutateSharedSetsResponse>): MutateSharedSetsResponse;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateSharedSetsResponse): MutateSharedSetsResponse;
internalBinaryWrite(message: MutateSharedSetsResponse, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateSharedSetsResponse
*/
export declare const MutateSharedSetsResponse: MutateSharedSetsResponse$Type;
declare class MutateSharedSetResult$Type extends MessageType<MutateSharedSetResult> {
constructor();
create(value?: PartialMessage<MutateSharedSetResult>): MutateSharedSetResult;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateSharedSetResult): MutateSharedSetResult;
internalBinaryWrite(message: MutateSharedSetResult, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateSharedSetResult
*/
export declare const MutateSharedSetResult: MutateSharedSetResult$Type;
/**
* @generated ServiceType for protobuf service google.ads.googleads.v11.services.SharedSetService
*/
export declare const SharedSetService: ServiceType;
export {};