google-ads-api-client/dist/protos/bindings/ads/services/asset_set_asset_service.d.ts

A friendly and exhaustive client to the google-ads-api, code generated directly from google's published protobuf schema.

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 { AssetSetAsset } from "../resources/asset_set_asset";
import { ResponseContentTypeEnum_ResponseContentType } from "../enums/response_content_type";
/**
 * Request message for [AssetSetAssetService.MutateAssetSetAssets][google.ads.googleads.v11.services.AssetSetAssetService.MutateAssetSetAssets].
 *
 * @generated from protobuf message google.ads.googleads.v11.services.MutateAssetSetAssetsRequest
 */
export interface MutateAssetSetAssetsRequest {
    /**
     * Required. The ID of the customer whose asset set assets are being modified.
     *
     * @generated from protobuf field: string customer_id = 1;
     */
    customerId: string;
    /**
     * Required. The list of operations to perform on individual asset set assets.
     *
     * @generated from protobuf field: repeated google.ads.googleads.v11.services.AssetSetAssetOperation operations = 2;
     */
    operations: AssetSetAssetOperation[];
    /**
     * 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 asset.
 *
 * @generated from protobuf message google.ads.googleads.v11.services.AssetSetAssetOperation
 */
export interface AssetSetAssetOperation {
    /**
     * @generated from protobuf oneof: operation
     */
    operation: {
        oneofKind: "create";
        /**
         * Create operation: No resource name is expected for the new asset set
         * asset
         *
         * @generated from protobuf field: google.ads.googleads.v11.resources.AssetSetAsset create = 1;
         */
        create: AssetSetAsset;
    } | {
        oneofKind: "remove";
        /**
         * Remove operation: A resource name for the removed asset set asset is
         * expected, in this format:
         * `customers/{customer_id}/assetSetAssets/{asset_set_id}~{asset_id}`
         *
         * @generated from protobuf field: string remove = 2;
         */
        remove: string;
    } | {
        oneofKind: undefined;
    };
}
/**
 * Response message for an asset set asset mutate.
 *
 * @generated from protobuf message google.ads.googleads.v11.services.MutateAssetSetAssetsResponse
 */
export interface MutateAssetSetAssetsResponse {
    /**
     * All results for the mutate.
     *
     * @generated from protobuf field: repeated google.ads.googleads.v11.services.MutateAssetSetAssetResult results = 1;
     */
    results: MutateAssetSetAssetResult[];
    /**
     * 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 asset mutate.
 *
 * @generated from protobuf message google.ads.googleads.v11.services.MutateAssetSetAssetResult
 */
export interface MutateAssetSetAssetResult {
    /**
     * Returned for successful operations.
     *
     * @generated from protobuf field: string resource_name = 1;
     */
    resourceName: string;
    /**
     * The mutated asset set 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.AssetSetAsset asset_set_asset = 2;
     */
    assetSetAsset?: AssetSetAsset;
}
declare class MutateAssetSetAssetsRequest$Type extends MessageType<MutateAssetSetAssetsRequest> {
    constructor();
    create(value?: PartialMessage<MutateAssetSetAssetsRequest>): MutateAssetSetAssetsRequest;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateAssetSetAssetsRequest): MutateAssetSetAssetsRequest;
    internalBinaryWrite(message: MutateAssetSetAssetsRequest, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateAssetSetAssetsRequest
 */
export declare const MutateAssetSetAssetsRequest: MutateAssetSetAssetsRequest$Type;
declare class AssetSetAssetOperation$Type extends MessageType<AssetSetAssetOperation> {
    constructor();
    create(value?: PartialMessage<AssetSetAssetOperation>): AssetSetAssetOperation;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: AssetSetAssetOperation): AssetSetAssetOperation;
    internalBinaryWrite(message: AssetSetAssetOperation, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.AssetSetAssetOperation
 */
export declare const AssetSetAssetOperation: AssetSetAssetOperation$Type;
declare class MutateAssetSetAssetsResponse$Type extends MessageType<MutateAssetSetAssetsResponse> {
    constructor();
    create(value?: PartialMessage<MutateAssetSetAssetsResponse>): MutateAssetSetAssetsResponse;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateAssetSetAssetsResponse): MutateAssetSetAssetsResponse;
    internalBinaryWrite(message: MutateAssetSetAssetsResponse, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateAssetSetAssetsResponse
 */
export declare const MutateAssetSetAssetsResponse: MutateAssetSetAssetsResponse$Type;
declare class MutateAssetSetAssetResult$Type extends MessageType<MutateAssetSetAssetResult> {
    constructor();
    create(value?: PartialMessage<MutateAssetSetAssetResult>): MutateAssetSetAssetResult;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateAssetSetAssetResult): MutateAssetSetAssetResult;
    internalBinaryWrite(message: MutateAssetSetAssetResult, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateAssetSetAssetResult
 */
export declare const MutateAssetSetAssetResult: MutateAssetSetAssetResult$Type;
/**
 * @generated ServiceType for protobuf service google.ads.googleads.v11.services.AssetSetAssetService
 */
export declare const AssetSetAssetService: ServiceType;
export {};