google-ads-api-client/dist/protos/bindings/ads/services/custom_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 { CustomConversionGoal } from "../resources/custom_conversion_goal";
import { FieldMask } from "../../google/protobuf/field_mask";
import { ResponseContentTypeEnum_ResponseContentType } from "../enums/response_content_type";
/**
 * Request message for
 * [CustomConversionGoalService.MutateCustomConversionGoals][google.ads.googleads.v11.services.CustomConversionGoalService.MutateCustomConversionGoals].
 *
 * @generated from protobuf message google.ads.googleads.v11.services.MutateCustomConversionGoalsRequest
 */
export interface MutateCustomConversionGoalsRequest {
    /**
     * Required. The ID of the customer whose custom conversion goals are being modified.
     *
     * @generated from protobuf field: string customer_id = 1;
     */
    customerId: string;
    /**
     * Required. The list of operations to perform on individual custom conversion goal.
     *
     * @generated from protobuf field: repeated google.ads.googleads.v11.services.CustomConversionGoalOperation operations = 2;
     */
    operations: CustomConversionGoalOperation[];
    /**
     * 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;
    /**
     * 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 = 4;
     */
    responseContentType: ResponseContentTypeEnum_ResponseContentType;
}
/**
 * A single operation (create, remove) on a custom conversion goal.
 *
 * @generated from protobuf message google.ads.googleads.v11.services.CustomConversionGoalOperation
 */
export interface CustomConversionGoalOperation {
    /**
     * 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 custom
         * conversion goal
         *
         * @generated from protobuf field: google.ads.googleads.v11.resources.CustomConversionGoal create = 1;
         */
        create: CustomConversionGoal;
    } | {
        oneofKind: "update";
        /**
         * Update operation: The custom conversion goal is expected to have a
         * valid resource name.
         *
         * @generated from protobuf field: google.ads.googleads.v11.resources.CustomConversionGoal update = 2;
         */
        update: CustomConversionGoal;
    } | {
        oneofKind: "remove";
        /**
         * Remove operation: A resource name for the removed custom conversion goal
         * is expected, in this format:
         *
         * 'customers/{customer_id}/conversionActions/{ConversionGoal.custom_goal_config.conversion_type_ids}'
         *
         * @generated from protobuf field: string remove = 3;
         */
        remove: string;
    } | {
        oneofKind: undefined;
    };
}
/**
 * Response message for a custom conversion goal mutate.
 *
 * @generated from protobuf message google.ads.googleads.v11.services.MutateCustomConversionGoalsResponse
 */
export interface MutateCustomConversionGoalsResponse {
    /**
     * All results for the mutate.
     *
     * @generated from protobuf field: repeated google.ads.googleads.v11.services.MutateCustomConversionGoalResult results = 1;
     */
    results: MutateCustomConversionGoalResult[];
}
/**
 * The result for the custom conversion goal mutate.
 *
 * @generated from protobuf message google.ads.googleads.v11.services.MutateCustomConversionGoalResult
 */
export interface MutateCustomConversionGoalResult {
    /**
     * Returned for successful operations.
     *
     * @generated from protobuf field: string resource_name = 1;
     */
    resourceName: string;
    /**
     * The mutated CustomConversionGoal 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.CustomConversionGoal custom_conversion_goal = 2;
     */
    customConversionGoal?: CustomConversionGoal;
}
declare class MutateCustomConversionGoalsRequest$Type extends MessageType<MutateCustomConversionGoalsRequest> {
    constructor();
    create(value?: PartialMessage<MutateCustomConversionGoalsRequest>): MutateCustomConversionGoalsRequest;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateCustomConversionGoalsRequest): MutateCustomConversionGoalsRequest;
    internalBinaryWrite(message: MutateCustomConversionGoalsRequest, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateCustomConversionGoalsRequest
 */
export declare const MutateCustomConversionGoalsRequest: MutateCustomConversionGoalsRequest$Type;
declare class CustomConversionGoalOperation$Type extends MessageType<CustomConversionGoalOperation> {
    constructor();
    create(value?: PartialMessage<CustomConversionGoalOperation>): CustomConversionGoalOperation;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: CustomConversionGoalOperation): CustomConversionGoalOperation;
    internalBinaryWrite(message: CustomConversionGoalOperation, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.CustomConversionGoalOperation
 */
export declare const CustomConversionGoalOperation: CustomConversionGoalOperation$Type;
declare class MutateCustomConversionGoalsResponse$Type extends MessageType<MutateCustomConversionGoalsResponse> {
    constructor();
    create(value?: PartialMessage<MutateCustomConversionGoalsResponse>): MutateCustomConversionGoalsResponse;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateCustomConversionGoalsResponse): MutateCustomConversionGoalsResponse;
    internalBinaryWrite(message: MutateCustomConversionGoalsResponse, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateCustomConversionGoalsResponse
 */
export declare const MutateCustomConversionGoalsResponse: MutateCustomConversionGoalsResponse$Type;
declare class MutateCustomConversionGoalResult$Type extends MessageType<MutateCustomConversionGoalResult> {
    constructor();
    create(value?: PartialMessage<MutateCustomConversionGoalResult>): MutateCustomConversionGoalResult;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateCustomConversionGoalResult): MutateCustomConversionGoalResult;
    internalBinaryWrite(message: MutateCustomConversionGoalResult, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateCustomConversionGoalResult
 */
export declare const MutateCustomConversionGoalResult: MutateCustomConversionGoalResult$Type;
/**
 * @generated ServiceType for protobuf service google.ads.googleads.v11.services.CustomConversionGoalService
 */
export declare const CustomConversionGoalService: ServiceType;
export {};