google-ads-api-client/dist/protos/bindings/ads/services/conversion_value_rule_set_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 { ConversionValueRuleSet } from "../resources/conversion_value_rule_set";
import { FieldMask } from "../../google/protobuf/field_mask";
import { ResponseContentTypeEnum_ResponseContentType } from "../enums/response_content_type";
/**
 * Request message for
 * [ConversionValueRuleSetService.MutateConversionValueRuleSets][google.ads.googleads.v11.services.ConversionValueRuleSetService.MutateConversionValueRuleSets].
 *
 * @generated from protobuf message google.ads.googleads.v11.services.MutateConversionValueRuleSetsRequest
 */
export interface MutateConversionValueRuleSetsRequest {
    /**
     * Required. The ID of the customer whose conversion value rule sets are being modified.
     *
     * @generated from protobuf field: string customer_id = 1;
     */
    customerId: string;
    /**
     * Required. The list of operations to perform on individual conversion value rule sets.
     *
     * @generated from protobuf field: repeated google.ads.googleads.v11.services.ConversionValueRuleSetOperation operations = 2;
     */
    operations: ConversionValueRuleSetOperation[];
    /**
     * 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 = 5;
     */
    partialFailure: boolean;
    /**
     * If true, the request is validated but not executed. Only errors are
     * returned, not results.
     *
     * @generated from protobuf field: bool validate_only = 3;
     */
    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 = 4;
     */
    responseContentType: ResponseContentTypeEnum_ResponseContentType;
}
/**
 * A single operation (create, update, remove) on a conversion value rule set.
 *
 * @generated from protobuf message google.ads.googleads.v11.services.ConversionValueRuleSetOperation
 */
export interface ConversionValueRuleSetOperation {
    /**
     * 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 conversion
         * value rule set.
         *
         * @generated from protobuf field: google.ads.googleads.v11.resources.ConversionValueRuleSet create = 1;
         */
        create: ConversionValueRuleSet;
    } | {
        oneofKind: "update";
        /**
         * Update operation: The conversion value rule set is expected to have a
         * valid resource name.
         *
         * @generated from protobuf field: google.ads.googleads.v11.resources.ConversionValueRuleSet update = 2;
         */
        update: ConversionValueRuleSet;
    } | {
        oneofKind: "remove";
        /**
         * Remove operation: A resource name for the removed conversion value rule
         * set is expected, in this format:
         *
         * `customers/{customer_id}/conversionValueRuleSets/{conversion_value_rule_set_id}`
         *
         * @generated from protobuf field: string remove = 3;
         */
        remove: string;
    } | {
        oneofKind: undefined;
    };
}
/**
 * Response message for
 * [ConversionValueRuleSetService.MutateConversionValueRuleSets][google.ads.googleads.v11.services.ConversionValueRuleSetService.MutateConversionValueRuleSets].
 *
 * @generated from protobuf message google.ads.googleads.v11.services.MutateConversionValueRuleSetsResponse
 */
export interface MutateConversionValueRuleSetsResponse {
    /**
     * All results for the mutate.
     *
     * @generated from protobuf field: repeated google.ads.googleads.v11.services.MutateConversionValueRuleSetResult results = 1;
     */
    results: MutateConversionValueRuleSetResult[];
    /**
     * 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 conversion value rule set mutate.
 *
 * @generated from protobuf message google.ads.googleads.v11.services.MutateConversionValueRuleSetResult
 */
export interface MutateConversionValueRuleSetResult {
    /**
     * Returned for successful operations.
     *
     * @generated from protobuf field: string resource_name = 1;
     */
    resourceName: string;
    /**
     * The mutated conversion value rule set 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.ConversionValueRuleSet conversion_value_rule_set = 2;
     */
    conversionValueRuleSet?: ConversionValueRuleSet;
}
declare class MutateConversionValueRuleSetsRequest$Type extends MessageType<MutateConversionValueRuleSetsRequest> {
    constructor();
    create(value?: PartialMessage<MutateConversionValueRuleSetsRequest>): MutateConversionValueRuleSetsRequest;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateConversionValueRuleSetsRequest): MutateConversionValueRuleSetsRequest;
    internalBinaryWrite(message: MutateConversionValueRuleSetsRequest, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateConversionValueRuleSetsRequest
 */
export declare const MutateConversionValueRuleSetsRequest: MutateConversionValueRuleSetsRequest$Type;
declare class ConversionValueRuleSetOperation$Type extends MessageType<ConversionValueRuleSetOperation> {
    constructor();
    create(value?: PartialMessage<ConversionValueRuleSetOperation>): ConversionValueRuleSetOperation;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: ConversionValueRuleSetOperation): ConversionValueRuleSetOperation;
    internalBinaryWrite(message: ConversionValueRuleSetOperation, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.ConversionValueRuleSetOperation
 */
export declare const ConversionValueRuleSetOperation: ConversionValueRuleSetOperation$Type;
declare class MutateConversionValueRuleSetsResponse$Type extends MessageType<MutateConversionValueRuleSetsResponse> {
    constructor();
    create(value?: PartialMessage<MutateConversionValueRuleSetsResponse>): MutateConversionValueRuleSetsResponse;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateConversionValueRuleSetsResponse): MutateConversionValueRuleSetsResponse;
    internalBinaryWrite(message: MutateConversionValueRuleSetsResponse, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateConversionValueRuleSetsResponse
 */
export declare const MutateConversionValueRuleSetsResponse: MutateConversionValueRuleSetsResponse$Type;
declare class MutateConversionValueRuleSetResult$Type extends MessageType<MutateConversionValueRuleSetResult> {
    constructor();
    create(value?: PartialMessage<MutateConversionValueRuleSetResult>): MutateConversionValueRuleSetResult;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateConversionValueRuleSetResult): MutateConversionValueRuleSetResult;
    internalBinaryWrite(message: MutateConversionValueRuleSetResult, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateConversionValueRuleSetResult
 */
export declare const MutateConversionValueRuleSetResult: MutateConversionValueRuleSetResult$Type;
/**
 * @generated ServiceType for protobuf service google.ads.googleads.v11.services.ConversionValueRuleSetService
 */
export declare const ConversionValueRuleSetService: ServiceType;
export {};