google-ads-api-client/dist/protos/bindings/ads/services/ad_group_bid_modifier_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 { AdGroupBidModifier } from "../resources/ad_group_bid_modifier";
import { FieldMask } from "../../google/protobuf/field_mask";
import { ResponseContentTypeEnum_ResponseContentType } from "../enums/response_content_type";
/**
 * Request message for [AdGroupBidModifierService.MutateAdGroupBidModifiers][google.ads.googleads.v11.services.AdGroupBidModifierService.MutateAdGroupBidModifiers].
 *
 * @generated from protobuf message google.ads.googleads.v11.services.MutateAdGroupBidModifiersRequest
 */
export interface MutateAdGroupBidModifiersRequest {
    /**
     * Required. ID of the customer whose ad group bid modifiers are being modified.
     *
     * @generated from protobuf field: string customer_id = 1;
     */
    customerId: string;
    /**
     * Required. The list of operations to perform on individual ad group bid modifiers.
     *
     * @generated from protobuf field: repeated google.ads.googleads.v11.services.AdGroupBidModifierOperation operations = 2;
     */
    operations: AdGroupBidModifierOperation[];
    /**
     * 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, update) on an ad group bid modifier.
 *
 * @generated from protobuf message google.ads.googleads.v11.services.AdGroupBidModifierOperation
 */
export interface AdGroupBidModifierOperation {
    /**
     * 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 ad group bid
         * modifier.
         *
         * @generated from protobuf field: google.ads.googleads.v11.resources.AdGroupBidModifier create = 1;
         */
        create: AdGroupBidModifier;
    } | {
        oneofKind: "update";
        /**
         * Update operation: The ad group bid modifier is expected to have a valid
         * resource name.
         *
         * @generated from protobuf field: google.ads.googleads.v11.resources.AdGroupBidModifier update = 2;
         */
        update: AdGroupBidModifier;
    } | {
        oneofKind: "remove";
        /**
         * Remove operation: A resource name for the removed ad group bid modifier
         * is expected, in this format:
         *
         * `customers/{customer_id}/adGroupBidModifiers/{ad_group_id}~{criterion_id}`
         *
         * @generated from protobuf field: string remove = 3;
         */
        remove: string;
    } | {
        oneofKind: undefined;
    };
}
/**
 * Response message for ad group bid modifiers mutate.
 *
 * @generated from protobuf message google.ads.googleads.v11.services.MutateAdGroupBidModifiersResponse
 */
export interface MutateAdGroupBidModifiersResponse {
    /**
     * 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.MutateAdGroupBidModifierResult results = 2;
     */
    results: MutateAdGroupBidModifierResult[];
}
/**
 * The result for the criterion mutate.
 *
 * @generated from protobuf message google.ads.googleads.v11.services.MutateAdGroupBidModifierResult
 */
export interface MutateAdGroupBidModifierResult {
    /**
     * Returned for successful operations.
     *
     * @generated from protobuf field: string resource_name = 1;
     */
    resourceName: string;
    /**
     * The mutated ad group bid modifier 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.AdGroupBidModifier ad_group_bid_modifier = 2;
     */
    adGroupBidModifier?: AdGroupBidModifier;
}
declare class MutateAdGroupBidModifiersRequest$Type extends MessageType<MutateAdGroupBidModifiersRequest> {
    constructor();
    create(value?: PartialMessage<MutateAdGroupBidModifiersRequest>): MutateAdGroupBidModifiersRequest;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateAdGroupBidModifiersRequest): MutateAdGroupBidModifiersRequest;
    internalBinaryWrite(message: MutateAdGroupBidModifiersRequest, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateAdGroupBidModifiersRequest
 */
export declare const MutateAdGroupBidModifiersRequest: MutateAdGroupBidModifiersRequest$Type;
declare class AdGroupBidModifierOperation$Type extends MessageType<AdGroupBidModifierOperation> {
    constructor();
    create(value?: PartialMessage<AdGroupBidModifierOperation>): AdGroupBidModifierOperation;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: AdGroupBidModifierOperation): AdGroupBidModifierOperation;
    internalBinaryWrite(message: AdGroupBidModifierOperation, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.AdGroupBidModifierOperation
 */
export declare const AdGroupBidModifierOperation: AdGroupBidModifierOperation$Type;
declare class MutateAdGroupBidModifiersResponse$Type extends MessageType<MutateAdGroupBidModifiersResponse> {
    constructor();
    create(value?: PartialMessage<MutateAdGroupBidModifiersResponse>): MutateAdGroupBidModifiersResponse;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateAdGroupBidModifiersResponse): MutateAdGroupBidModifiersResponse;
    internalBinaryWrite(message: MutateAdGroupBidModifiersResponse, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateAdGroupBidModifiersResponse
 */
export declare const MutateAdGroupBidModifiersResponse: MutateAdGroupBidModifiersResponse$Type;
declare class MutateAdGroupBidModifierResult$Type extends MessageType<MutateAdGroupBidModifierResult> {
    constructor();
    create(value?: PartialMessage<MutateAdGroupBidModifierResult>): MutateAdGroupBidModifierResult;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateAdGroupBidModifierResult): MutateAdGroupBidModifierResult;
    internalBinaryWrite(message: MutateAdGroupBidModifierResult, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateAdGroupBidModifierResult
 */
export declare const MutateAdGroupBidModifierResult: MutateAdGroupBidModifierResult$Type;
/**
 * @generated ServiceType for protobuf service google.ads.googleads.v11.services.AdGroupBidModifierService
 */
export declare const AdGroupBidModifierService: ServiceType;
export {};