google-ads-api-client/dist/protos/bindings/ads/services/customer_extension_setting_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 { CustomerExtensionSetting } from "../resources/customer_extension_setting";
import { FieldMask } from "../../google/protobuf/field_mask";
import { ResponseContentTypeEnum_ResponseContentType } from "../enums/response_content_type";
/**
 * Request message for
 * [CustomerExtensionSettingService.MutateCustomerExtensionSettings][google.ads.googleads.v11.services.CustomerExtensionSettingService.MutateCustomerExtensionSettings].
 *
 * @generated from protobuf message google.ads.googleads.v11.services.MutateCustomerExtensionSettingsRequest
 */
export interface MutateCustomerExtensionSettingsRequest {
    /**
     * Required. The ID of the customer whose customer extension settings are being
     * modified.
     *
     * @generated from protobuf field: string customer_id = 1;
     */
    customerId: string;
    /**
     * Required. The list of operations to perform on individual customer extension
     * settings.
     *
     * @generated from protobuf field: repeated google.ads.googleads.v11.services.CustomerExtensionSettingOperation operations = 2;
     */
    operations: CustomerExtensionSettingOperation[];
    /**
     * 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, remove) on a customer extension setting.
 *
 * @generated from protobuf message google.ads.googleads.v11.services.CustomerExtensionSettingOperation
 */
export interface CustomerExtensionSettingOperation {
    /**
     * 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 customer
         * extension setting.
         *
         * @generated from protobuf field: google.ads.googleads.v11.resources.CustomerExtensionSetting create = 1;
         */
        create: CustomerExtensionSetting;
    } | {
        oneofKind: "update";
        /**
         * Update operation: The customer extension setting is expected to have a
         * valid resource name.
         *
         * @generated from protobuf field: google.ads.googleads.v11.resources.CustomerExtensionSetting update = 2;
         */
        update: CustomerExtensionSetting;
    } | {
        oneofKind: "remove";
        /**
         * Remove operation: A resource name for the removed customer extension
         * setting is expected, in this format:
         *
         * `customers/{customer_id}/customerExtensionSettings/{extension_type}`
         *
         * @generated from protobuf field: string remove = 3;
         */
        remove: string;
    } | {
        oneofKind: undefined;
    };
}
/**
 * Response message for a customer extension setting mutate.
 *
 * @generated from protobuf message google.ads.googleads.v11.services.MutateCustomerExtensionSettingsResponse
 */
export interface MutateCustomerExtensionSettingsResponse {
    /**
     * 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 = 3;
     */
    partialFailureError?: Status;
    /**
     * All results for the mutate.
     *
     * @generated from protobuf field: repeated google.ads.googleads.v11.services.MutateCustomerExtensionSettingResult results = 2;
     */
    results: MutateCustomerExtensionSettingResult[];
}
/**
 * The result for the customer extension setting mutate.
 *
 * @generated from protobuf message google.ads.googleads.v11.services.MutateCustomerExtensionSettingResult
 */
export interface MutateCustomerExtensionSettingResult {
    /**
     * Returned for successful operations.
     *
     * @generated from protobuf field: string resource_name = 1;
     */
    resourceName: string;
    /**
     * The mutated CustomerExtensionSetting 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.CustomerExtensionSetting customer_extension_setting = 2;
     */
    customerExtensionSetting?: CustomerExtensionSetting;
}
declare class MutateCustomerExtensionSettingsRequest$Type extends MessageType<MutateCustomerExtensionSettingsRequest> {
    constructor();
    create(value?: PartialMessage<MutateCustomerExtensionSettingsRequest>): MutateCustomerExtensionSettingsRequest;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateCustomerExtensionSettingsRequest): MutateCustomerExtensionSettingsRequest;
    internalBinaryWrite(message: MutateCustomerExtensionSettingsRequest, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateCustomerExtensionSettingsRequest
 */
export declare const MutateCustomerExtensionSettingsRequest: MutateCustomerExtensionSettingsRequest$Type;
declare class CustomerExtensionSettingOperation$Type extends MessageType<CustomerExtensionSettingOperation> {
    constructor();
    create(value?: PartialMessage<CustomerExtensionSettingOperation>): CustomerExtensionSettingOperation;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: CustomerExtensionSettingOperation): CustomerExtensionSettingOperation;
    internalBinaryWrite(message: CustomerExtensionSettingOperation, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.CustomerExtensionSettingOperation
 */
export declare const CustomerExtensionSettingOperation: CustomerExtensionSettingOperation$Type;
declare class MutateCustomerExtensionSettingsResponse$Type extends MessageType<MutateCustomerExtensionSettingsResponse> {
    constructor();
    create(value?: PartialMessage<MutateCustomerExtensionSettingsResponse>): MutateCustomerExtensionSettingsResponse;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateCustomerExtensionSettingsResponse): MutateCustomerExtensionSettingsResponse;
    internalBinaryWrite(message: MutateCustomerExtensionSettingsResponse, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateCustomerExtensionSettingsResponse
 */
export declare const MutateCustomerExtensionSettingsResponse: MutateCustomerExtensionSettingsResponse$Type;
declare class MutateCustomerExtensionSettingResult$Type extends MessageType<MutateCustomerExtensionSettingResult> {
    constructor();
    create(value?: PartialMessage<MutateCustomerExtensionSettingResult>): MutateCustomerExtensionSettingResult;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateCustomerExtensionSettingResult): MutateCustomerExtensionSettingResult;
    internalBinaryWrite(message: MutateCustomerExtensionSettingResult, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateCustomerExtensionSettingResult
 */
export declare const MutateCustomerExtensionSettingResult: MutateCustomerExtensionSettingResult$Type;
/**
 * @generated ServiceType for protobuf service google.ads.googleads.v11.services.CustomerExtensionSettingService
 */
export declare const CustomerExtensionSettingService: ServiceType;
export {};