google-ads-api-client/dist/protos/bindings/ads/services/asset_group_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 { AssetGroupAsset } from "../resources/asset_group_asset";
import { FieldMask } from "../../google/protobuf/field_mask";
/**
 * Request message for [AssetGroupAssetService.MutateAssetGroupAssets][google.ads.googleads.v11.services.AssetGroupAssetService.MutateAssetGroupAssets].
 *
 * @generated from protobuf message google.ads.googleads.v11.services.MutateAssetGroupAssetsRequest
 */
export interface MutateAssetGroupAssetsRequest {
    /**
     * Required. The ID of the customer whose asset group assets are being modified.
     *
     * @generated from protobuf field: string customer_id = 1;
     */
    customerId: string;
    /**
     * Required. The list of operations to perform on individual asset group assets.
     *
     * @generated from protobuf field: repeated google.ads.googleads.v11.services.AssetGroupAssetOperation operations = 2;
     */
    operations: AssetGroupAssetOperation[];
    /**
     * 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;
}
/**
 * A single operation (create, remove) on an asset group asset.
 *
 * @generated from protobuf message google.ads.googleads.v11.services.AssetGroupAssetOperation
 */
export interface AssetGroupAssetOperation {
    /**
     * 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 group
         * asset
         *
         * @generated from protobuf field: google.ads.googleads.v11.resources.AssetGroupAsset create = 1;
         */
        create: AssetGroupAsset;
    } | {
        oneofKind: "update";
        /**
         * Update operation: The asset group asset sis expected to have a valid
         * resource name.
         *
         * @generated from protobuf field: google.ads.googleads.v11.resources.AssetGroupAsset update = 2;
         */
        update: AssetGroupAsset;
    } | {
        oneofKind: "remove";
        /**
         * Remove operation: A resource name for the removed asset group asset is
         * expected, in this format:
         * `customers/{customer_id}/assetGroupAssets/{asset_group_id}~{asset_id}~{field_type}`
         *
         * @generated from protobuf field: string remove = 3;
         */
        remove: string;
    } | {
        oneofKind: undefined;
    };
}
/**
 * Response message for an asset group asset mutate.
 *
 * @generated from protobuf message google.ads.googleads.v11.services.MutateAssetGroupAssetsResponse
 */
export interface MutateAssetGroupAssetsResponse {
    /**
     * All results for the mutate.
     *
     * @generated from protobuf field: repeated google.ads.googleads.v11.services.MutateAssetGroupAssetResult results = 1;
     */
    results: MutateAssetGroupAssetResult[];
    /**
     * 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 group asset mutate.
 *
 * @generated from protobuf message google.ads.googleads.v11.services.MutateAssetGroupAssetResult
 */
export interface MutateAssetGroupAssetResult {
    /**
     * Returned for successful operations.
     *
     * @generated from protobuf field: string resource_name = 1;
     */
    resourceName: string;
}
declare class MutateAssetGroupAssetsRequest$Type extends MessageType<MutateAssetGroupAssetsRequest> {
    constructor();
    create(value?: PartialMessage<MutateAssetGroupAssetsRequest>): MutateAssetGroupAssetsRequest;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateAssetGroupAssetsRequest): MutateAssetGroupAssetsRequest;
    internalBinaryWrite(message: MutateAssetGroupAssetsRequest, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateAssetGroupAssetsRequest
 */
export declare const MutateAssetGroupAssetsRequest: MutateAssetGroupAssetsRequest$Type;
declare class AssetGroupAssetOperation$Type extends MessageType<AssetGroupAssetOperation> {
    constructor();
    create(value?: PartialMessage<AssetGroupAssetOperation>): AssetGroupAssetOperation;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: AssetGroupAssetOperation): AssetGroupAssetOperation;
    internalBinaryWrite(message: AssetGroupAssetOperation, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.AssetGroupAssetOperation
 */
export declare const AssetGroupAssetOperation: AssetGroupAssetOperation$Type;
declare class MutateAssetGroupAssetsResponse$Type extends MessageType<MutateAssetGroupAssetsResponse> {
    constructor();
    create(value?: PartialMessage<MutateAssetGroupAssetsResponse>): MutateAssetGroupAssetsResponse;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateAssetGroupAssetsResponse): MutateAssetGroupAssetsResponse;
    internalBinaryWrite(message: MutateAssetGroupAssetsResponse, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateAssetGroupAssetsResponse
 */
export declare const MutateAssetGroupAssetsResponse: MutateAssetGroupAssetsResponse$Type;
declare class MutateAssetGroupAssetResult$Type extends MessageType<MutateAssetGroupAssetResult> {
    constructor();
    create(value?: PartialMessage<MutateAssetGroupAssetResult>): MutateAssetGroupAssetResult;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateAssetGroupAssetResult): MutateAssetGroupAssetResult;
    internalBinaryWrite(message: MutateAssetGroupAssetResult, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateAssetGroupAssetResult
 */
export declare const MutateAssetGroupAssetResult: MutateAssetGroupAssetResult$Type;
/**
 * @generated ServiceType for protobuf service google.ads.googleads.v11.services.AssetGroupAssetService
 */
export declare const AssetGroupAssetService: ServiceType;
export {};