google-ads-api-client
Version:
A friendly and exhaustive client to the google-ads-api, code generated directly from google's published protobuf schema.
189 lines (188 loc) • 8.28 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 { Status } from "../../google/rpc/status";
import { AdParameter } from "../resources/ad_parameter";
import { FieldMask } from "../../google/protobuf/field_mask";
import { ResponseContentTypeEnum_ResponseContentType } from "../enums/response_content_type";
/**
* Request message for [AdParameterService.MutateAdParameters][google.ads.googleads.v11.services.AdParameterService.MutateAdParameters]
*
* @generated from protobuf message google.ads.googleads.v11.services.MutateAdParametersRequest
*/
export interface MutateAdParametersRequest {
/**
* Required. The ID of the customer whose ad parameters are being modified.
*
* @generated from protobuf field: string customer_id = 1;
*/
customerId: string;
/**
* Required. The list of operations to perform on individual ad parameters.
*
* @generated from protobuf field: repeated google.ads.googleads.v11.services.AdParameterOperation operations = 2;
*/
operations: AdParameterOperation[];
/**
* 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, update, remove) on ad parameter.
*
* @generated from protobuf message google.ads.googleads.v11.services.AdParameterOperation
*/
export interface AdParameterOperation {
/**
* 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 parameter.
*
* @generated from protobuf field: google.ads.googleads.v11.resources.AdParameter create = 1;
*/
create: AdParameter;
} | {
oneofKind: "update";
/**
* Update operation: The ad parameter is expected to have a valid resource
* name.
*
* @generated from protobuf field: google.ads.googleads.v11.resources.AdParameter update = 2;
*/
update: AdParameter;
} | {
oneofKind: "remove";
/**
* Remove operation: A resource name for the ad parameter to remove is
* expected in this format:
*
* `customers/{customer_id}/adParameters/{ad_group_id}~{criterion_id}~{parameter_index}`
*
* @generated from protobuf field: string remove = 3;
*/
remove: string;
} | {
oneofKind: undefined;
};
}
/**
* Response message for an ad parameter mutate.
*
* @generated from protobuf message google.ads.googleads.v11.services.MutateAdParametersResponse
*/
export interface MutateAdParametersResponse {
/**
* 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.MutateAdParameterResult results = 2;
*/
results: MutateAdParameterResult[];
}
/**
* The result for the ad parameter mutate.
*
* @generated from protobuf message google.ads.googleads.v11.services.MutateAdParameterResult
*/
export interface MutateAdParameterResult {
/**
* The resource name returned for successful operations.
*
* @generated from protobuf field: string resource_name = 1;
*/
resourceName: string;
/**
* The mutated AdParameter 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.AdParameter ad_parameter = 2;
*/
adParameter?: AdParameter;
}
declare class MutateAdParametersRequest$Type extends MessageType<MutateAdParametersRequest> {
constructor();
create(value?: PartialMessage<MutateAdParametersRequest>): MutateAdParametersRequest;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateAdParametersRequest): MutateAdParametersRequest;
internalBinaryWrite(message: MutateAdParametersRequest, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateAdParametersRequest
*/
export declare const MutateAdParametersRequest: MutateAdParametersRequest$Type;
declare class AdParameterOperation$Type extends MessageType<AdParameterOperation> {
constructor();
create(value?: PartialMessage<AdParameterOperation>): AdParameterOperation;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: AdParameterOperation): AdParameterOperation;
internalBinaryWrite(message: AdParameterOperation, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.AdParameterOperation
*/
export declare const AdParameterOperation: AdParameterOperation$Type;
declare class MutateAdParametersResponse$Type extends MessageType<MutateAdParametersResponse> {
constructor();
create(value?: PartialMessage<MutateAdParametersResponse>): MutateAdParametersResponse;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateAdParametersResponse): MutateAdParametersResponse;
internalBinaryWrite(message: MutateAdParametersResponse, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateAdParametersResponse
*/
export declare const MutateAdParametersResponse: MutateAdParametersResponse$Type;
declare class MutateAdParameterResult$Type extends MessageType<MutateAdParameterResult> {
constructor();
create(value?: PartialMessage<MutateAdParameterResult>): MutateAdParameterResult;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateAdParameterResult): MutateAdParameterResult;
internalBinaryWrite(message: MutateAdParameterResult, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateAdParameterResult
*/
export declare const MutateAdParameterResult: MutateAdParameterResult$Type;
/**
* @generated ServiceType for protobuf service google.ads.googleads.v11.services.AdParameterService
*/
export declare const AdParameterService: ServiceType;
export {};