google-ads-api-client/dist/protos/bindings/ads/services/conversion_custom_variable_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 { ConversionCustomVariable } from "../resources/conversion_custom_variable";
import { FieldMask } from "../../google/protobuf/field_mask";
import { ResponseContentTypeEnum_ResponseContentType } from "../enums/response_content_type";
/**
 * Request message for
 * [ConversionCustomVariableService.MutateConversionCustomVariables][google.ads.googleads.v11.services.ConversionCustomVariableService.MutateConversionCustomVariables].
 *
 * @generated from protobuf message google.ads.googleads.v11.services.MutateConversionCustomVariablesRequest
 */
export interface MutateConversionCustomVariablesRequest {
    /**
     * Required. The ID of the customer whose conversion custom variables are being
     * modified.
     *
     * @generated from protobuf field: string customer_id = 1;
     */
    customerId: string;
    /**
     * Required. The list of operations to perform on individual conversion custom
     * variables.
     *
     * @generated from protobuf field: repeated google.ads.googleads.v11.services.ConversionCustomVariableOperation operations = 2;
     */
    operations: ConversionCustomVariableOperation[];
    /**
     * 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) on a conversion custom variable.
 *
 * @generated from protobuf message google.ads.googleads.v11.services.ConversionCustomVariableOperation
 */
export interface ConversionCustomVariableOperation {
    /**
     * FieldMask that determines which resource fields are modified in an update.
     *
     * @generated from protobuf field: google.protobuf.FieldMask update_mask = 3;
     */
    updateMask?: FieldMask;
    /**
     * @generated from protobuf oneof: operation
     */
    operation: {
        oneofKind: "create";
        /**
         * Create operation: No resource name is expected for the new conversion
         * custom variable.
         *
         * @generated from protobuf field: google.ads.googleads.v11.resources.ConversionCustomVariable create = 1;
         */
        create: ConversionCustomVariable;
    } | {
        oneofKind: "update";
        /**
         * Update operation: The conversion custom variable is expected to have a
         * valid resource name.
         *
         * @generated from protobuf field: google.ads.googleads.v11.resources.ConversionCustomVariable update = 2;
         */
        update: ConversionCustomVariable;
    } | {
        oneofKind: undefined;
    };
}
/**
 * Response message for
 * [ConversionCustomVariableService.MutateConversionCustomVariables][google.ads.googleads.v11.services.ConversionCustomVariableService.MutateConversionCustomVariables].
 *
 * @generated from protobuf message google.ads.googleads.v11.services.MutateConversionCustomVariablesResponse
 */
export interface MutateConversionCustomVariablesResponse {
    /**
     * 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.MutateConversionCustomVariableResult results = 2;
     */
    results: MutateConversionCustomVariableResult[];
}
/**
 * The result for the conversion custom variable mutate.
 *
 * @generated from protobuf message google.ads.googleads.v11.services.MutateConversionCustomVariableResult
 */
export interface MutateConversionCustomVariableResult {
    /**
     * Returned for successful operations.
     *
     * @generated from protobuf field: string resource_name = 1;
     */
    resourceName: string;
    /**
     * The mutated conversion custom variable 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.ConversionCustomVariable conversion_custom_variable = 2;
     */
    conversionCustomVariable?: ConversionCustomVariable;
}
declare class MutateConversionCustomVariablesRequest$Type extends MessageType<MutateConversionCustomVariablesRequest> {
    constructor();
    create(value?: PartialMessage<MutateConversionCustomVariablesRequest>): MutateConversionCustomVariablesRequest;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateConversionCustomVariablesRequest): MutateConversionCustomVariablesRequest;
    internalBinaryWrite(message: MutateConversionCustomVariablesRequest, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateConversionCustomVariablesRequest
 */
export declare const MutateConversionCustomVariablesRequest: MutateConversionCustomVariablesRequest$Type;
declare class ConversionCustomVariableOperation$Type extends MessageType<ConversionCustomVariableOperation> {
    constructor();
    create(value?: PartialMessage<ConversionCustomVariableOperation>): ConversionCustomVariableOperation;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: ConversionCustomVariableOperation): ConversionCustomVariableOperation;
    internalBinaryWrite(message: ConversionCustomVariableOperation, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.ConversionCustomVariableOperation
 */
export declare const ConversionCustomVariableOperation: ConversionCustomVariableOperation$Type;
declare class MutateConversionCustomVariablesResponse$Type extends MessageType<MutateConversionCustomVariablesResponse> {
    constructor();
    create(value?: PartialMessage<MutateConversionCustomVariablesResponse>): MutateConversionCustomVariablesResponse;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateConversionCustomVariablesResponse): MutateConversionCustomVariablesResponse;
    internalBinaryWrite(message: MutateConversionCustomVariablesResponse, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateConversionCustomVariablesResponse
 */
export declare const MutateConversionCustomVariablesResponse: MutateConversionCustomVariablesResponse$Type;
declare class MutateConversionCustomVariableResult$Type extends MessageType<MutateConversionCustomVariableResult> {
    constructor();
    create(value?: PartialMessage<MutateConversionCustomVariableResult>): MutateConversionCustomVariableResult;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateConversionCustomVariableResult): MutateConversionCustomVariableResult;
    internalBinaryWrite(message: MutateConversionCustomVariableResult, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateConversionCustomVariableResult
 */
export declare const MutateConversionCustomVariableResult: MutateConversionCustomVariableResult$Type;
/**
 * @generated ServiceType for protobuf service google.ads.googleads.v11.services.ConversionCustomVariableService
 */
export declare const ConversionCustomVariableService: ServiceType;
export {};