google-ads-api-client/dist/protos/bindings/ads/services/shared_criterion_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 { SharedCriterion } from "../resources/shared_criterion";
import { ResponseContentTypeEnum_ResponseContentType } from "../enums/response_content_type";
/**
 * Request message for [SharedCriterionService.MutateSharedCriteria][google.ads.googleads.v11.services.SharedCriterionService.MutateSharedCriteria].
 *
 * @generated from protobuf message google.ads.googleads.v11.services.MutateSharedCriteriaRequest
 */
export interface MutateSharedCriteriaRequest {
    /**
     * Required. The ID of the customer whose shared criteria are being modified.
     *
     * @generated from protobuf field: string customer_id = 1;
     */
    customerId: string;
    /**
     * Required. The list of operations to perform on individual shared criteria.
     *
     * @generated from protobuf field: repeated google.ads.googleads.v11.services.SharedCriterionOperation operations = 2;
     */
    operations: SharedCriterionOperation[];
    /**
     * 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, remove) on an shared criterion.
 *
 * @generated from protobuf message google.ads.googleads.v11.services.SharedCriterionOperation
 */
export interface SharedCriterionOperation {
    /**
     * @generated from protobuf oneof: operation
     */
    operation: {
        oneofKind: "create";
        /**
         * Create operation: No resource name is expected for the new shared
         * criterion.
         *
         * @generated from protobuf field: google.ads.googleads.v11.resources.SharedCriterion create = 1;
         */
        create: SharedCriterion;
    } | {
        oneofKind: "remove";
        /**
         * Remove operation: A resource name for the removed shared criterion is
         * expected, in this format:
         *
         * `customers/{customer_id}/sharedCriteria/{shared_set_id}~{criterion_id}`
         *
         * @generated from protobuf field: string remove = 3;
         */
        remove: string;
    } | {
        oneofKind: undefined;
    };
}
/**
 * Response message for a shared criterion mutate.
 *
 * @generated from protobuf message google.ads.googleads.v11.services.MutateSharedCriteriaResponse
 */
export interface MutateSharedCriteriaResponse {
    /**
     * 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.MutateSharedCriterionResult results = 2;
     */
    results: MutateSharedCriterionResult[];
}
/**
 * The result for the shared criterion mutate.
 *
 * @generated from protobuf message google.ads.googleads.v11.services.MutateSharedCriterionResult
 */
export interface MutateSharedCriterionResult {
    /**
     * Returned for successful operations.
     *
     * @generated from protobuf field: string resource_name = 1;
     */
    resourceName: string;
    /**
     * The mutated shared criterion 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.SharedCriterion shared_criterion = 2;
     */
    sharedCriterion?: SharedCriterion;
}
declare class MutateSharedCriteriaRequest$Type extends MessageType<MutateSharedCriteriaRequest> {
    constructor();
    create(value?: PartialMessage<MutateSharedCriteriaRequest>): MutateSharedCriteriaRequest;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateSharedCriteriaRequest): MutateSharedCriteriaRequest;
    internalBinaryWrite(message: MutateSharedCriteriaRequest, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateSharedCriteriaRequest
 */
export declare const MutateSharedCriteriaRequest: MutateSharedCriteriaRequest$Type;
declare class SharedCriterionOperation$Type extends MessageType<SharedCriterionOperation> {
    constructor();
    create(value?: PartialMessage<SharedCriterionOperation>): SharedCriterionOperation;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: SharedCriterionOperation): SharedCriterionOperation;
    internalBinaryWrite(message: SharedCriterionOperation, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.SharedCriterionOperation
 */
export declare const SharedCriterionOperation: SharedCriterionOperation$Type;
declare class MutateSharedCriteriaResponse$Type extends MessageType<MutateSharedCriteriaResponse> {
    constructor();
    create(value?: PartialMessage<MutateSharedCriteriaResponse>): MutateSharedCriteriaResponse;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateSharedCriteriaResponse): MutateSharedCriteriaResponse;
    internalBinaryWrite(message: MutateSharedCriteriaResponse, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateSharedCriteriaResponse
 */
export declare const MutateSharedCriteriaResponse: MutateSharedCriteriaResponse$Type;
declare class MutateSharedCriterionResult$Type extends MessageType<MutateSharedCriterionResult> {
    constructor();
    create(value?: PartialMessage<MutateSharedCriterionResult>): MutateSharedCriterionResult;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateSharedCriterionResult): MutateSharedCriterionResult;
    internalBinaryWrite(message: MutateSharedCriterionResult, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateSharedCriterionResult
 */
export declare const MutateSharedCriterionResult: MutateSharedCriterionResult$Type;
/**
 * @generated ServiceType for protobuf service google.ads.googleads.v11.services.SharedCriterionService
 */
export declare const SharedCriterionService: ServiceType;
export {};