google-ads-api-client
Version:
A friendly and exhaustive client to the google-ads-api, code generated directly from google's published protobuf schema.
153 lines (152 loc) • 7.9 kB
TypeScript
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 { ConversionGoalCampaignConfig } from "../resources/conversion_goal_campaign_config";
import { FieldMask } from "../../google/protobuf/field_mask";
import { ResponseContentTypeEnum_ResponseContentType } from "../enums/response_content_type";
/**
* Request message for
* [ConversionGoalCampaignConfigService.MutateConversionGoalCampaignConfig][].
*
* @generated from protobuf message google.ads.googleads.v11.services.MutateConversionGoalCampaignConfigsRequest
*/
export interface MutateConversionGoalCampaignConfigsRequest {
/**
* 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 conversion goal campaign
* config.
*
* @generated from protobuf field: repeated google.ads.googleads.v11.services.ConversionGoalCampaignConfigOperation operations = 2;
*/
operations: ConversionGoalCampaignConfigOperation[];
/**
* 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 (update) on a conversion goal campaign config.
*
* @generated from protobuf message google.ads.googleads.v11.services.ConversionGoalCampaignConfigOperation
*/
export interface ConversionGoalCampaignConfigOperation {
/**
* 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 conversion goal campaign config is expected to have
* a valid resource name.
*
* @generated from protobuf field: google.ads.googleads.v11.resources.ConversionGoalCampaignConfig update = 1;
*/
update: ConversionGoalCampaignConfig;
} | {
oneofKind: undefined;
};
}
/**
* Response message for a conversion goal campaign config mutate.
*
* @generated from protobuf message google.ads.googleads.v11.services.MutateConversionGoalCampaignConfigsResponse
*/
export interface MutateConversionGoalCampaignConfigsResponse {
/**
* All results for the mutate.
*
* @generated from protobuf field: repeated google.ads.googleads.v11.services.MutateConversionGoalCampaignConfigResult results = 1;
*/
results: MutateConversionGoalCampaignConfigResult[];
}
/**
* The result for the conversion goal campaign config mutate.
*
* @generated from protobuf message google.ads.googleads.v11.services.MutateConversionGoalCampaignConfigResult
*/
export interface MutateConversionGoalCampaignConfigResult {
/**
* Returned for successful operations.
*
* @generated from protobuf field: string resource_name = 1;
*/
resourceName: string;
/**
* The mutated ConversionGoalCampaignConfig 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.ConversionGoalCampaignConfig conversion_goal_campaign_config = 2;
*/
conversionGoalCampaignConfig?: ConversionGoalCampaignConfig;
}
declare class MutateConversionGoalCampaignConfigsRequest$Type extends MessageType<MutateConversionGoalCampaignConfigsRequest> {
constructor();
create(value?: PartialMessage<MutateConversionGoalCampaignConfigsRequest>): MutateConversionGoalCampaignConfigsRequest;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateConversionGoalCampaignConfigsRequest): MutateConversionGoalCampaignConfigsRequest;
internalBinaryWrite(message: MutateConversionGoalCampaignConfigsRequest, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateConversionGoalCampaignConfigsRequest
*/
export declare const MutateConversionGoalCampaignConfigsRequest: MutateConversionGoalCampaignConfigsRequest$Type;
declare class ConversionGoalCampaignConfigOperation$Type extends MessageType<ConversionGoalCampaignConfigOperation> {
constructor();
create(value?: PartialMessage<ConversionGoalCampaignConfigOperation>): ConversionGoalCampaignConfigOperation;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: ConversionGoalCampaignConfigOperation): ConversionGoalCampaignConfigOperation;
internalBinaryWrite(message: ConversionGoalCampaignConfigOperation, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.ConversionGoalCampaignConfigOperation
*/
export declare const ConversionGoalCampaignConfigOperation: ConversionGoalCampaignConfigOperation$Type;
declare class MutateConversionGoalCampaignConfigsResponse$Type extends MessageType<MutateConversionGoalCampaignConfigsResponse> {
constructor();
create(value?: PartialMessage<MutateConversionGoalCampaignConfigsResponse>): MutateConversionGoalCampaignConfigsResponse;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateConversionGoalCampaignConfigsResponse): MutateConversionGoalCampaignConfigsResponse;
internalBinaryWrite(message: MutateConversionGoalCampaignConfigsResponse, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateConversionGoalCampaignConfigsResponse
*/
export declare const MutateConversionGoalCampaignConfigsResponse: MutateConversionGoalCampaignConfigsResponse$Type;
declare class MutateConversionGoalCampaignConfigResult$Type extends MessageType<MutateConversionGoalCampaignConfigResult> {
constructor();
create(value?: PartialMessage<MutateConversionGoalCampaignConfigResult>): MutateConversionGoalCampaignConfigResult;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateConversionGoalCampaignConfigResult): MutateConversionGoalCampaignConfigResult;
internalBinaryWrite(message: MutateConversionGoalCampaignConfigResult, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateConversionGoalCampaignConfigResult
*/
export declare const MutateConversionGoalCampaignConfigResult: MutateConversionGoalCampaignConfigResult$Type;
/**
* @generated ServiceType for protobuf service google.ads.googleads.v11.services.ConversionGoalCampaignConfigService
*/
export declare const ConversionGoalCampaignConfigService: ServiceType;
export {};