google-ads-api-client/dist/protos/bindings/ads/services/user_list_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 { UserList } from "../resources/user_list";
import { FieldMask } from "../../google/protobuf/field_mask";
/**
 * Request message for [UserListService.MutateUserLists][google.ads.googleads.v11.services.UserListService.MutateUserLists].
 *
 * @generated from protobuf message google.ads.googleads.v11.services.MutateUserListsRequest
 */
export interface MutateUserListsRequest {
    /**
     * Required. The ID of the customer whose user lists are being modified.
     *
     * @generated from protobuf field: string customer_id = 1;
     */
    customerId: string;
    /**
     * Required. The list of operations to perform on individual user lists.
     *
     * @generated from protobuf field: repeated google.ads.googleads.v11.services.UserListOperation operations = 2;
     */
    operations: UserListOperation[];
    /**
     * 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, update) on a user list.
 *
 * @generated from protobuf message google.ads.googleads.v11.services.UserListOperation
 */
export interface UserListOperation {
    /**
     * 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 user list.
         *
         * @generated from protobuf field: google.ads.googleads.v11.resources.UserList create = 1;
         */
        create: UserList;
    } | {
        oneofKind: "update";
        /**
         * Update operation: The user list is expected to have a valid resource
         * name.
         *
         * @generated from protobuf field: google.ads.googleads.v11.resources.UserList update = 2;
         */
        update: UserList;
    } | {
        oneofKind: "remove";
        /**
         * Remove operation: A resource name for the removed user list is expected,
         * in this format:
         *
         * `customers/{customer_id}/userLists/{user_list_id}`
         *
         * @generated from protobuf field: string remove = 3;
         */
        remove: string;
    } | {
        oneofKind: undefined;
    };
}
/**
 * Response message for user list mutate.
 *
 * @generated from protobuf message google.ads.googleads.v11.services.MutateUserListsResponse
 */
export interface MutateUserListsResponse {
    /**
     * 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.MutateUserListResult results = 2;
     */
    results: MutateUserListResult[];
}
/**
 * The result for the user list mutate.
 *
 * @generated from protobuf message google.ads.googleads.v11.services.MutateUserListResult
 */
export interface MutateUserListResult {
    /**
     * Returned for successful operations.
     *
     * @generated from protobuf field: string resource_name = 1;
     */
    resourceName: string;
}
declare class MutateUserListsRequest$Type extends MessageType<MutateUserListsRequest> {
    constructor();
    create(value?: PartialMessage<MutateUserListsRequest>): MutateUserListsRequest;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateUserListsRequest): MutateUserListsRequest;
    internalBinaryWrite(message: MutateUserListsRequest, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateUserListsRequest
 */
export declare const MutateUserListsRequest: MutateUserListsRequest$Type;
declare class UserListOperation$Type extends MessageType<UserListOperation> {
    constructor();
    create(value?: PartialMessage<UserListOperation>): UserListOperation;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: UserListOperation): UserListOperation;
    internalBinaryWrite(message: UserListOperation, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.UserListOperation
 */
export declare const UserListOperation: UserListOperation$Type;
declare class MutateUserListsResponse$Type extends MessageType<MutateUserListsResponse> {
    constructor();
    create(value?: PartialMessage<MutateUserListsResponse>): MutateUserListsResponse;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateUserListsResponse): MutateUserListsResponse;
    internalBinaryWrite(message: MutateUserListsResponse, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateUserListsResponse
 */
export declare const MutateUserListsResponse: MutateUserListsResponse$Type;
declare class MutateUserListResult$Type extends MessageType<MutateUserListResult> {
    constructor();
    create(value?: PartialMessage<MutateUserListResult>): MutateUserListResult;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateUserListResult): MutateUserListResult;
    internalBinaryWrite(message: MutateUserListResult, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateUserListResult
 */
export declare const MutateUserListResult: MutateUserListResult$Type;
/**
 * @generated ServiceType for protobuf service google.ads.googleads.v11.services.UserListService
 */
export declare const UserListService: ServiceType;
export {};