google-ads-api-client/dist/protos/bindings/ads/services/campaign_conversion_goal_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 { CampaignConversionGoal } from "../resources/campaign_conversion_goal";
import { FieldMask } from "../../google/protobuf/field_mask";
/**
 * Request message for
 * [CampaignConversionGoalService.MutateCampaignConversionGoals][google.ads.googleads.v11.services.CampaignConversionGoalService.MutateCampaignConversionGoals].
 *
 * @generated from protobuf message google.ads.googleads.v11.services.MutateCampaignConversionGoalsRequest
 */
export interface MutateCampaignConversionGoalsRequest {
    /**
     * Required. The ID of the customer whose campaign conversion goals are being modified.
     *
     * @generated from protobuf field: string customer_id = 1;
     */
    customerId: string;
    /**
     * Required. The list of operations to perform on individual campaign conversion goal.
     *
     * @generated from protobuf field: repeated google.ads.googleads.v11.services.CampaignConversionGoalOperation operations = 2;
     */
    operations: CampaignConversionGoalOperation[];
    /**
     * If true, the request is validated but not executed. Only errors are
     * returned, not results.
     *
     * @generated from protobuf field: bool validate_only = 3;
     */
    validateOnly: boolean;
}
/**
 * A single operation (update) on a campaign conversion goal.
 *
 * @generated from protobuf message google.ads.googleads.v11.services.CampaignConversionGoalOperation
 */
export interface CampaignConversionGoalOperation {
    /**
     * FieldMask that determines which resource fields are modified in an update.
     *
     * @generated from protobuf field: google.protobuf.FieldMask update_mask = 2;
     */
    updateMask?: FieldMask;
    /**
     * @generated from protobuf oneof: operation
     */
    operation: {
        oneofKind: "update";
        /**
         * Update operation: The customer conversion goal is expected to have a
         * valid resource name.
         *
         * @generated from protobuf field: google.ads.googleads.v11.resources.CampaignConversionGoal update = 1;
         */
        update: CampaignConversionGoal;
    } | {
        oneofKind: undefined;
    };
}
/**
 * Response message for a campaign conversion goal mutate.
 *
 * @generated from protobuf message google.ads.googleads.v11.services.MutateCampaignConversionGoalsResponse
 */
export interface MutateCampaignConversionGoalsResponse {
    /**
     * All results for the mutate.
     *
     * @generated from protobuf field: repeated google.ads.googleads.v11.services.MutateCampaignConversionGoalResult results = 1;
     */
    results: MutateCampaignConversionGoalResult[];
}
/**
 * The result for the campaign conversion goal mutate.
 *
 * @generated from protobuf message google.ads.googleads.v11.services.MutateCampaignConversionGoalResult
 */
export interface MutateCampaignConversionGoalResult {
    /**
     * Returned for successful operations.
     *
     * @generated from protobuf field: string resource_name = 1;
     */
    resourceName: string;
}
declare class MutateCampaignConversionGoalsRequest$Type extends MessageType<MutateCampaignConversionGoalsRequest> {
    constructor();
    create(value?: PartialMessage<MutateCampaignConversionGoalsRequest>): MutateCampaignConversionGoalsRequest;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateCampaignConversionGoalsRequest): MutateCampaignConversionGoalsRequest;
    internalBinaryWrite(message: MutateCampaignConversionGoalsRequest, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateCampaignConversionGoalsRequest
 */
export declare const MutateCampaignConversionGoalsRequest: MutateCampaignConversionGoalsRequest$Type;
declare class CampaignConversionGoalOperation$Type extends MessageType<CampaignConversionGoalOperation> {
    constructor();
    create(value?: PartialMessage<CampaignConversionGoalOperation>): CampaignConversionGoalOperation;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: CampaignConversionGoalOperation): CampaignConversionGoalOperation;
    internalBinaryWrite(message: CampaignConversionGoalOperation, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.CampaignConversionGoalOperation
 */
export declare const CampaignConversionGoalOperation: CampaignConversionGoalOperation$Type;
declare class MutateCampaignConversionGoalsResponse$Type extends MessageType<MutateCampaignConversionGoalsResponse> {
    constructor();
    create(value?: PartialMessage<MutateCampaignConversionGoalsResponse>): MutateCampaignConversionGoalsResponse;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateCampaignConversionGoalsResponse): MutateCampaignConversionGoalsResponse;
    internalBinaryWrite(message: MutateCampaignConversionGoalsResponse, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateCampaignConversionGoalsResponse
 */
export declare const MutateCampaignConversionGoalsResponse: MutateCampaignConversionGoalsResponse$Type;
declare class MutateCampaignConversionGoalResult$Type extends MessageType<MutateCampaignConversionGoalResult> {
    constructor();
    create(value?: PartialMessage<MutateCampaignConversionGoalResult>): MutateCampaignConversionGoalResult;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateCampaignConversionGoalResult): MutateCampaignConversionGoalResult;
    internalBinaryWrite(message: MutateCampaignConversionGoalResult, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateCampaignConversionGoalResult
 */
export declare const MutateCampaignConversionGoalResult: MutateCampaignConversionGoalResult$Type;
/**
 * @generated ServiceType for protobuf service google.ads.googleads.v11.services.CampaignConversionGoalService
 */
export declare const CampaignConversionGoalService: ServiceType;
export {};