google-ads-api-client/dist/protos/bindings/ads/services/asset_group_signal_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 { AssetGroupSignal } from "../resources/asset_group_signal";
import { ResponseContentTypeEnum_ResponseContentType } from "../enums/response_content_type";
/**
 * Request message for
 * [AssetGroupSignalService.MutateAssetGroupSignals][google.ads.googleads.v11.services.AssetGroupSignalService.MutateAssetGroupSignals].
 *
 * @generated from protobuf message google.ads.googleads.v11.services.MutateAssetGroupSignalsRequest
 */
export interface MutateAssetGroupSignalsRequest {
    /**
     * Required. The ID of the customer whose asset group signals are being modified.
     *
     * @generated from protobuf field: string customer_id = 1;
     */
    customerId: string;
    /**
     * Required. The list of operations to perform on individual asset group signals.
     *
     * @generated from protobuf field: repeated google.ads.googleads.v11.services.AssetGroupSignalOperation operations = 2;
     */
    operations: AssetGroupSignalOperation[];
    /**
     * 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 group signal.
 *
 * @generated from protobuf message google.ads.googleads.v11.services.AssetGroupSignalOperation
 */
export interface AssetGroupSignalOperation {
    /**
     * @generated from protobuf oneof: operation
     */
    operation: {
        oneofKind: "create";
        /**
         * Create operation: No resource name is expected for the new asset group
         * signal.
         *
         * @generated from protobuf field: google.ads.googleads.v11.resources.AssetGroupSignal create = 1;
         */
        create: AssetGroupSignal;
    } | {
        oneofKind: "remove";
        /**
         * Remove operation: A resource name for the removed asset group signal is
         * expected, in this format:
         * `customers/{customer_id}/assetGroupSignals/{asset_group_id}~{criterion_id}`
         *
         * @generated from protobuf field: string remove = 2;
         */
        remove: string;
    } | {
        oneofKind: undefined;
    };
}
/**
 * Response message for an asset group signal mutate.
 *
 * @generated from protobuf message google.ads.googleads.v11.services.MutateAssetGroupSignalsResponse
 */
export interface MutateAssetGroupSignalsResponse {
    /**
     * All results for the mutate.
     *
     * @generated from protobuf field: repeated google.ads.googleads.v11.services.MutateAssetGroupSignalResult results = 1;
     */
    results: MutateAssetGroupSignalResult[];
    /**
     * 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 signal mutate.
 *
 * @generated from protobuf message google.ads.googleads.v11.services.MutateAssetGroupSignalResult
 */
export interface MutateAssetGroupSignalResult {
    /**
     * Returned for successful operations.
     *
     * @generated from protobuf field: string resource_name = 1;
     */
    resourceName: string;
    /**
     * The mutated AssetGroupSignal 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.AssetGroupSignal asset_group_signal = 2;
     */
    assetGroupSignal?: AssetGroupSignal;
}
declare class MutateAssetGroupSignalsRequest$Type extends MessageType<MutateAssetGroupSignalsRequest> {
    constructor();
    create(value?: PartialMessage<MutateAssetGroupSignalsRequest>): MutateAssetGroupSignalsRequest;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateAssetGroupSignalsRequest): MutateAssetGroupSignalsRequest;
    internalBinaryWrite(message: MutateAssetGroupSignalsRequest, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateAssetGroupSignalsRequest
 */
export declare const MutateAssetGroupSignalsRequest: MutateAssetGroupSignalsRequest$Type;
declare class AssetGroupSignalOperation$Type extends MessageType<AssetGroupSignalOperation> {
    constructor();
    create(value?: PartialMessage<AssetGroupSignalOperation>): AssetGroupSignalOperation;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: AssetGroupSignalOperation): AssetGroupSignalOperation;
    internalBinaryWrite(message: AssetGroupSignalOperation, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.AssetGroupSignalOperation
 */
export declare const AssetGroupSignalOperation: AssetGroupSignalOperation$Type;
declare class MutateAssetGroupSignalsResponse$Type extends MessageType<MutateAssetGroupSignalsResponse> {
    constructor();
    create(value?: PartialMessage<MutateAssetGroupSignalsResponse>): MutateAssetGroupSignalsResponse;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateAssetGroupSignalsResponse): MutateAssetGroupSignalsResponse;
    internalBinaryWrite(message: MutateAssetGroupSignalsResponse, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateAssetGroupSignalsResponse
 */
export declare const MutateAssetGroupSignalsResponse: MutateAssetGroupSignalsResponse$Type;
declare class MutateAssetGroupSignalResult$Type extends MessageType<MutateAssetGroupSignalResult> {
    constructor();
    create(value?: PartialMessage<MutateAssetGroupSignalResult>): MutateAssetGroupSignalResult;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateAssetGroupSignalResult): MutateAssetGroupSignalResult;
    internalBinaryWrite(message: MutateAssetGroupSignalResult, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateAssetGroupSignalResult
 */
export declare const MutateAssetGroupSignalResult: MutateAssetGroupSignalResult$Type;
/**
 * @generated ServiceType for protobuf service google.ads.googleads.v11.services.AssetGroupSignalService
 */
export declare const AssetGroupSignalService: ServiceType;
export {};