google-ads-api-client
Version:
A friendly and exhaustive client to the google-ads-api, code generated directly from google's published protobuf schema.
195 lines (194 loc) • 8.38 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 { AdGroupAd } from "../resources/ad_group_ad";
import { PolicyValidationParameter } from "../common/policy";
import { FieldMask } from "../../google/protobuf/field_mask";
import { ResponseContentTypeEnum_ResponseContentType } from "../enums/response_content_type";
/**
* Request message for [AdGroupAdService.MutateAdGroupAds][google.ads.googleads.v11.services.AdGroupAdService.MutateAdGroupAds].
*
* @generated from protobuf message google.ads.googleads.v11.services.MutateAdGroupAdsRequest
*/
export interface MutateAdGroupAdsRequest {
/**
* Required. The ID of the customer whose ads are being modified.
*
* @generated from protobuf field: string customer_id = 1;
*/
customerId: string;
/**
* Required. The list of operations to perform on individual ads.
*
* @generated from protobuf field: repeated google.ads.googleads.v11.services.AdGroupAdOperation operations = 2;
*/
operations: AdGroupAdOperation[];
/**
* 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 an ad group ad.
*
* @generated from protobuf message google.ads.googleads.v11.services.AdGroupAdOperation
*/
export interface AdGroupAdOperation {
/**
* FieldMask that determines which resource fields are modified in an update.
*
* @generated from protobuf field: google.protobuf.FieldMask update_mask = 4;
*/
updateMask?: FieldMask;
/**
* Configuration for how policies are validated.
*
* @generated from protobuf field: google.ads.googleads.v11.common.PolicyValidationParameter policy_validation_parameter = 5;
*/
policyValidationParameter?: PolicyValidationParameter;
/**
* @generated from protobuf oneof: operation
*/
operation: {
oneofKind: "create";
/**
* Create operation: No resource name is expected for the new ad.
*
* @generated from protobuf field: google.ads.googleads.v11.resources.AdGroupAd create = 1;
*/
create: AdGroupAd;
} | {
oneofKind: "update";
/**
* Update operation: The ad is expected to have a valid resource name.
*
* @generated from protobuf field: google.ads.googleads.v11.resources.AdGroupAd update = 2;
*/
update: AdGroupAd;
} | {
oneofKind: "remove";
/**
* Remove operation: A resource name for the removed ad is expected,
* in this format:
*
* `customers/{customer_id}/adGroupAds/{ad_group_id}~{ad_id}`
*
* @generated from protobuf field: string remove = 3;
*/
remove: string;
} | {
oneofKind: undefined;
};
}
/**
* Response message for an ad group ad mutate.
*
* @generated from protobuf message google.ads.googleads.v11.services.MutateAdGroupAdsResponse
*/
export interface MutateAdGroupAdsResponse {
/**
* 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.MutateAdGroupAdResult results = 2;
*/
results: MutateAdGroupAdResult[];
}
/**
* The result for the ad mutate.
*
* @generated from protobuf message google.ads.googleads.v11.services.MutateAdGroupAdResult
*/
export interface MutateAdGroupAdResult {
/**
* The resource name returned for successful operations.
*
* @generated from protobuf field: string resource_name = 1;
*/
resourceName: string;
/**
* The mutated ad group ad 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.AdGroupAd ad_group_ad = 2;
*/
adGroupAd?: AdGroupAd;
}
declare class MutateAdGroupAdsRequest$Type extends MessageType<MutateAdGroupAdsRequest> {
constructor();
create(value?: PartialMessage<MutateAdGroupAdsRequest>): MutateAdGroupAdsRequest;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateAdGroupAdsRequest): MutateAdGroupAdsRequest;
internalBinaryWrite(message: MutateAdGroupAdsRequest, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateAdGroupAdsRequest
*/
export declare const MutateAdGroupAdsRequest: MutateAdGroupAdsRequest$Type;
declare class AdGroupAdOperation$Type extends MessageType<AdGroupAdOperation> {
constructor();
create(value?: PartialMessage<AdGroupAdOperation>): AdGroupAdOperation;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: AdGroupAdOperation): AdGroupAdOperation;
internalBinaryWrite(message: AdGroupAdOperation, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.AdGroupAdOperation
*/
export declare const AdGroupAdOperation: AdGroupAdOperation$Type;
declare class MutateAdGroupAdsResponse$Type extends MessageType<MutateAdGroupAdsResponse> {
constructor();
create(value?: PartialMessage<MutateAdGroupAdsResponse>): MutateAdGroupAdsResponse;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateAdGroupAdsResponse): MutateAdGroupAdsResponse;
internalBinaryWrite(message: MutateAdGroupAdsResponse, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateAdGroupAdsResponse
*/
export declare const MutateAdGroupAdsResponse: MutateAdGroupAdsResponse$Type;
declare class MutateAdGroupAdResult$Type extends MessageType<MutateAdGroupAdResult> {
constructor();
create(value?: PartialMessage<MutateAdGroupAdResult>): MutateAdGroupAdResult;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateAdGroupAdResult): MutateAdGroupAdResult;
internalBinaryWrite(message: MutateAdGroupAdResult, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateAdGroupAdResult
*/
export declare const MutateAdGroupAdResult: MutateAdGroupAdResult$Type;
/**
* @generated ServiceType for protobuf service google.ads.googleads.v11.services.AdGroupAdService
*/
export declare const AdGroupAdService: ServiceType;
export {};