google-ads-api-client/dist/protos/bindings/ads/services/audience_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 { Audience } from "../resources/audience";
import { FieldMask } from "../../google/protobuf/field_mask";
import { Status } from "../../google/rpc/status";
import { ResponseContentTypeEnum_ResponseContentType } from "../enums/response_content_type";
/**
 * Request message for [AudienceService.MutateAudiences][google.ads.googleads.v11.services.AudienceService.MutateAudiences].
 *
 * @generated from protobuf message google.ads.googleads.v11.services.MutateAudiencesRequest
 */
export interface MutateAudiencesRequest {
    /**
     * Required. The ID of the customer whose audiences are being modified.
     *
     * @generated from protobuf field: string customer_id = 1;
     */
    customerId: string;
    /**
     * Required. The list of operations to perform on individual audiences.
     *
     * @generated from protobuf field: repeated google.ads.googleads.v11.services.AudienceOperation operations = 2;
     */
    operations: AudienceOperation[];
    /**
     * 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;
}
/**
 * Response message for an audience mutate.
 *
 * @generated from protobuf message google.ads.googleads.v11.services.MutateAudiencesResponse
 */
export interface MutateAudiencesResponse {
    /**
     * All results for the mutate.
     *
     * @generated from protobuf field: repeated google.ads.googleads.v11.services.MutateAudienceResult results = 1;
     */
    results: MutateAudienceResult[];
    /**
     * 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;
}
/**
 * A single operation (create, update) on an audience.
 *
 * @generated from protobuf message google.ads.googleads.v11.services.AudienceOperation
 */
export interface AudienceOperation {
    /**
     * 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 audience
         *
         * @generated from protobuf field: google.ads.googleads.v11.resources.Audience create = 1;
         */
        create: Audience;
    } | {
        oneofKind: "update";
        /**
         * Update operation: The audience is expected to have a valid resource
         * name.
         *
         * @generated from protobuf field: google.ads.googleads.v11.resources.Audience update = 2;
         */
        update: Audience;
    } | {
        oneofKind: undefined;
    };
}
/**
 * The result for the audience mutate.
 *
 * @generated from protobuf message google.ads.googleads.v11.services.MutateAudienceResult
 */
export interface MutateAudienceResult {
    /**
     * Returned for successful operations.
     *
     * @generated from protobuf field: string resource_name = 1;
     */
    resourceName: string;
    /**
     * The mutated Audience 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.Audience audience = 2;
     */
    audience?: Audience;
}
declare class MutateAudiencesRequest$Type extends MessageType<MutateAudiencesRequest> {
    constructor();
    create(value?: PartialMessage<MutateAudiencesRequest>): MutateAudiencesRequest;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateAudiencesRequest): MutateAudiencesRequest;
    internalBinaryWrite(message: MutateAudiencesRequest, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateAudiencesRequest
 */
export declare const MutateAudiencesRequest: MutateAudiencesRequest$Type;
declare class MutateAudiencesResponse$Type extends MessageType<MutateAudiencesResponse> {
    constructor();
    create(value?: PartialMessage<MutateAudiencesResponse>): MutateAudiencesResponse;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateAudiencesResponse): MutateAudiencesResponse;
    internalBinaryWrite(message: MutateAudiencesResponse, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateAudiencesResponse
 */
export declare const MutateAudiencesResponse: MutateAudiencesResponse$Type;
declare class AudienceOperation$Type extends MessageType<AudienceOperation> {
    constructor();
    create(value?: PartialMessage<AudienceOperation>): AudienceOperation;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: AudienceOperation): AudienceOperation;
    internalBinaryWrite(message: AudienceOperation, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.AudienceOperation
 */
export declare const AudienceOperation: AudienceOperation$Type;
declare class MutateAudienceResult$Type extends MessageType<MutateAudienceResult> {
    constructor();
    create(value?: PartialMessage<MutateAudienceResult>): MutateAudienceResult;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateAudienceResult): MutateAudienceResult;
    internalBinaryWrite(message: MutateAudienceResult, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateAudienceResult
 */
export declare const MutateAudienceResult: MutateAudienceResult$Type;
/**
 * @generated ServiceType for protobuf service google.ads.googleads.v11.services.AudienceService
 */
export declare const AudienceService: ServiceType;
export {};