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.42 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 { CampaignAsset } from "../resources/campaign_asset";
import { FieldMask } from "../../google/protobuf/field_mask";
import { ResponseContentTypeEnum_ResponseContentType } from "../enums/response_content_type";
/**
* Request message for [CampaignAssetService.MutateCampaignAssets][google.ads.googleads.v11.services.CampaignAssetService.MutateCampaignAssets].
*
* @generated from protobuf message google.ads.googleads.v11.services.MutateCampaignAssetsRequest
*/
export interface MutateCampaignAssetsRequest {
/**
* Required. The ID of the customer whose campaign assets are being modified.
*
* @generated from protobuf field: string customer_id = 1;
*/
customerId: string;
/**
* Required. The list of operations to perform on individual campaign assets.
*
* @generated from protobuf field: repeated google.ads.googleads.v11.services.CampaignAssetOperation operations = 2;
*/
operations: CampaignAssetOperation[];
/**
* 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 asset.
*
* @generated from protobuf message google.ads.googleads.v11.services.CampaignAssetOperation
*/
export interface CampaignAssetOperation {
/**
* 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
* asset.
*
* @generated from protobuf field: google.ads.googleads.v11.resources.CampaignAsset create = 1;
*/
create: CampaignAsset;
} | {
oneofKind: "update";
/**
* Update operation: The campaign asset is expected to have a valid resource
* name.
*
* @generated from protobuf field: google.ads.googleads.v11.resources.CampaignAsset update = 3;
*/
update: CampaignAsset;
} | {
oneofKind: "remove";
/**
* Remove operation: A resource name for the removed campaign asset is
* expected, in this format:
*
* `customers/{customer_id}/campaignAssets/{campaign_id}~{asset_id}~{field_type}`
*
* @generated from protobuf field: string remove = 2;
*/
remove: string;
} | {
oneofKind: undefined;
};
}
/**
* Response message for a campaign asset mutate.
*
* @generated from protobuf message google.ads.googleads.v11.services.MutateCampaignAssetsResponse
*/
export interface MutateCampaignAssetsResponse {
/**
* 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 = 1;
*/
partialFailureError?: Status;
/**
* All results for the mutate.
*
* @generated from protobuf field: repeated google.ads.googleads.v11.services.MutateCampaignAssetResult results = 2;
*/
results: MutateCampaignAssetResult[];
}
/**
* The result for the campaign asset mutate.
*
* @generated from protobuf message google.ads.googleads.v11.services.MutateCampaignAssetResult
*/
export interface MutateCampaignAssetResult {
/**
* Returned for successful operations.
*
* @generated from protobuf field: string resource_name = 1;
*/
resourceName: string;
/**
* The mutated campaign asset 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.CampaignAsset campaign_asset = 2;
*/
campaignAsset?: CampaignAsset;
}
declare class MutateCampaignAssetsRequest$Type extends MessageType<MutateCampaignAssetsRequest> {
constructor();
create(value?: PartialMessage<MutateCampaignAssetsRequest>): MutateCampaignAssetsRequest;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateCampaignAssetsRequest): MutateCampaignAssetsRequest;
internalBinaryWrite(message: MutateCampaignAssetsRequest, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateCampaignAssetsRequest
*/
export declare const MutateCampaignAssetsRequest: MutateCampaignAssetsRequest$Type;
declare class CampaignAssetOperation$Type extends MessageType<CampaignAssetOperation> {
constructor();
create(value?: PartialMessage<CampaignAssetOperation>): CampaignAssetOperation;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: CampaignAssetOperation): CampaignAssetOperation;
internalBinaryWrite(message: CampaignAssetOperation, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.CampaignAssetOperation
*/
export declare const CampaignAssetOperation: CampaignAssetOperation$Type;
declare class MutateCampaignAssetsResponse$Type extends MessageType<MutateCampaignAssetsResponse> {
constructor();
create(value?: PartialMessage<MutateCampaignAssetsResponse>): MutateCampaignAssetsResponse;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateCampaignAssetsResponse): MutateCampaignAssetsResponse;
internalBinaryWrite(message: MutateCampaignAssetsResponse, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateCampaignAssetsResponse
*/
export declare const MutateCampaignAssetsResponse: MutateCampaignAssetsResponse$Type;
declare class MutateCampaignAssetResult$Type extends MessageType<MutateCampaignAssetResult> {
constructor();
create(value?: PartialMessage<MutateCampaignAssetResult>): MutateCampaignAssetResult;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateCampaignAssetResult): MutateCampaignAssetResult;
internalBinaryWrite(message: MutateCampaignAssetResult, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateCampaignAssetResult
*/
export declare const MutateCampaignAssetResult: MutateCampaignAssetResult$Type;
/**
* @generated ServiceType for protobuf service google.ads.googleads.v11.services.CampaignAssetService
*/
export declare const CampaignAssetService: ServiceType;
export {};