google-ads-api-client
Version:
A friendly and exhaustive client to the google-ads-api, code generated directly from google's published protobuf schema.
187 lines (186 loc) • 7.97 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 { AssetSet } from "../resources/asset_set";
import { FieldMask } from "../../google/protobuf/field_mask";
import { ResponseContentTypeEnum_ResponseContentType } from "../enums/response_content_type";
/**
* Request message for [AssetSetService.MutateAssetSets][google.ads.googleads.v11.services.AssetSetService.MutateAssetSets].
*
* @generated from protobuf message google.ads.googleads.v11.services.MutateAssetSetsRequest
*/
export interface MutateAssetSetsRequest {
/**
* Required. The ID of the customer whose asset sets are being modified.
*
* @generated from protobuf field: string customer_id = 1;
*/
customerId: string;
/**
* Required. The list of operations to perform on individual asset sets.
*
* @generated from protobuf field: repeated google.ads.googleads.v11.services.AssetSetOperation operations = 2;
*/
operations: AssetSetOperation[];
/**
* 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, remove) on an asset set.
*
* @generated from protobuf message google.ads.googleads.v11.services.AssetSetOperation
*/
export interface AssetSetOperation {
/**
* 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 asset set
*
* @generated from protobuf field: google.ads.googleads.v11.resources.AssetSet create = 1;
*/
create: AssetSet;
} | {
oneofKind: "update";
/**
* Update operation: The asset set is expected to have a valid resource
* name.
*
* @generated from protobuf field: google.ads.googleads.v11.resources.AssetSet update = 2;
*/
update: AssetSet;
} | {
oneofKind: "remove";
/**
* Remove operation: A resource name for the removed asset set is
* expected, in this format:
* `customers/{customer_id}/assetSets/{asset_set_id}`
*
* @generated from protobuf field: string remove = 3;
*/
remove: string;
} | {
oneofKind: undefined;
};
}
/**
* Response message for an asset set mutate.
*
* @generated from protobuf message google.ads.googleads.v11.services.MutateAssetSetsResponse
*/
export interface MutateAssetSetsResponse {
/**
* All results for the mutate.
*
* @generated from protobuf field: repeated google.ads.googleads.v11.services.MutateAssetSetResult results = 1;
*/
results: MutateAssetSetResult[];
/**
* 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 = 2;
*/
partialFailureError?: Status;
}
/**
* The result for the asset set mutate.
*
* @generated from protobuf message google.ads.googleads.v11.services.MutateAssetSetResult
*/
export interface MutateAssetSetResult {
/**
* Returned for successful operations.
*
* @generated from protobuf field: string resource_name = 1;
*/
resourceName: string;
/**
* The mutated asset 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.AssetSet asset_set = 2;
*/
assetSet?: AssetSet;
}
declare class MutateAssetSetsRequest$Type extends MessageType<MutateAssetSetsRequest> {
constructor();
create(value?: PartialMessage<MutateAssetSetsRequest>): MutateAssetSetsRequest;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateAssetSetsRequest): MutateAssetSetsRequest;
internalBinaryWrite(message: MutateAssetSetsRequest, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateAssetSetsRequest
*/
export declare const MutateAssetSetsRequest: MutateAssetSetsRequest$Type;
declare class AssetSetOperation$Type extends MessageType<AssetSetOperation> {
constructor();
create(value?: PartialMessage<AssetSetOperation>): AssetSetOperation;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: AssetSetOperation): AssetSetOperation;
internalBinaryWrite(message: AssetSetOperation, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.AssetSetOperation
*/
export declare const AssetSetOperation: AssetSetOperation$Type;
declare class MutateAssetSetsResponse$Type extends MessageType<MutateAssetSetsResponse> {
constructor();
create(value?: PartialMessage<MutateAssetSetsResponse>): MutateAssetSetsResponse;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateAssetSetsResponse): MutateAssetSetsResponse;
internalBinaryWrite(message: MutateAssetSetsResponse, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateAssetSetsResponse
*/
export declare const MutateAssetSetsResponse: MutateAssetSetsResponse$Type;
declare class MutateAssetSetResult$Type extends MessageType<MutateAssetSetResult> {
constructor();
create(value?: PartialMessage<MutateAssetSetResult>): MutateAssetSetResult;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateAssetSetResult): MutateAssetSetResult;
internalBinaryWrite(message: MutateAssetSetResult, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateAssetSetResult
*/
export declare const MutateAssetSetResult: MutateAssetSetResult$Type;
/**
* @generated ServiceType for protobuf service google.ads.googleads.v11.services.AssetSetService
*/
export declare const AssetSetService: ServiceType;
export {};