Class protos.google.ads.admanager.v1.PrivateAuctionDeal (0.6.0)

Represents a PrivateAuctionDeal.

Package

@google-ads/admanager

Constructors

(constructor)(properties)

constructor(properties?: google.ads.admanager.v1.IPrivateAuctionDeal);

Constructs a new PrivateAuctionDeal.

Parameter
Name Description
properties IPrivateAuctionDeal

Properties to set

Properties

auctionPriorityEnabled

public auctionPriorityEnabled?: (boolean|null);

PrivateAuctionDeal auctionPriorityEnabled.

blockOverrideEnabled

public blockOverrideEnabled?: (boolean|null);

PrivateAuctionDeal blockOverrideEnabled.

buyerAccountId

public buyerAccountId?: (number|Long|string|null);

PrivateAuctionDeal buyerAccountId.

buyerData

public buyerData?: (google.ads.admanager.v1.PrivateAuctionDeal.IBuyerData|null);

PrivateAuctionDeal buyerData.

buyerPermissionType

public buyerPermissionType?: (google.ads.admanager.v1.DealBuyerPermissionTypeEnum.DealBuyerPermissionType|keyof typeof google.ads.admanager.v1.DealBuyerPermissionTypeEnum.DealBuyerPermissionType|null);

PrivateAuctionDeal buyerPermissionType.

createTime

public createTime?: (google.protobuf.ITimestamp|null);

PrivateAuctionDeal createTime.

creativeSizes

public creativeSizes: google.ads.admanager.v1.ISize[];

PrivateAuctionDeal creativeSizes.

endTime

public endTime?: (google.protobuf.ITimestamp|null);

PrivateAuctionDeal endTime.

externalDealId

public externalDealId?: (number|Long|string|null);

PrivateAuctionDeal externalDealId.

floorPrice

public floorPrice?: (google.type.IMoney|null);

PrivateAuctionDeal floorPrice.

name

public name: string;

PrivateAuctionDeal name.

privateAuctionDealId

public privateAuctionDealId?: (number|Long|string|null);

PrivateAuctionDeal privateAuctionDealId.

privateAuctionDisplayName

public privateAuctionDisplayName?: (string|null);

PrivateAuctionDeal privateAuctionDisplayName.

privateAuctionId

public privateAuctionId?: (number|Long|string|null);

PrivateAuctionDeal privateAuctionId.

status

public status?: (google.ads.admanager.v1.PrivateMarketplaceDealStatusEnum.PrivateMarketplaceDealStatus|keyof typeof google.ads.admanager.v1.PrivateMarketplaceDealStatusEnum.PrivateMarketplaceDealStatus|null);

PrivateAuctionDeal status.

targeting

public targeting?: (google.ads.admanager.v1.ITargeting|null);

PrivateAuctionDeal targeting.

updateTime

public updateTime?: (google.protobuf.ITimestamp|null);

PrivateAuctionDeal updateTime.

Methods

create(properties)

public static create(properties?: google.ads.admanager.v1.IPrivateAuctionDeal): google.ads.admanager.v1.PrivateAuctionDeal;

Creates a new PrivateAuctionDeal instance using the specified properties.

Parameter
Name Description
properties IPrivateAuctionDeal

Properties to set

Returns
Type Description
PrivateAuctionDeal

PrivateAuctionDeal instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.ads.admanager.v1.PrivateAuctionDeal;

Decodes a PrivateAuctionDeal message from the specified reader or buffer.

Parameters
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
Type Description
PrivateAuctionDeal

PrivateAuctionDeal

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.ads.admanager.v1.PrivateAuctionDeal;

Decodes a PrivateAuctionDeal message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
PrivateAuctionDeal

PrivateAuctionDeal

encode(message, writer)

public static encode(message: google.ads.admanager.v1.IPrivateAuctionDeal, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified PrivateAuctionDeal message. Does not implicitly messages.

Parameters
Name Description
message IPrivateAuctionDeal

PrivateAuctionDeal message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
Type Description
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.ads.admanager.v1.IPrivateAuctionDeal, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified PrivateAuctionDeal message, length delimited. Does not implicitly messages.

Parameters
Name Description
message IPrivateAuctionDeal

PrivateAuctionDeal message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
Type Description
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.ads.admanager.v1.PrivateAuctionDeal;

Creates a PrivateAuctionDeal message from a plain object. Also converts values to their respective internal types.

Parameter
Name Description
object { [k: string]: any }

Plain object

Returns
Type Description
PrivateAuctionDeal

PrivateAuctionDeal

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for PrivateAuctionDeal

Parameter
Name Description
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
Type Description
string

The default type url

toJSON()

public toJSON(): { [k: string]: any };

Converts this PrivateAuctionDeal to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.ads.admanager.v1.PrivateAuctionDeal, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a PrivateAuctionDeal message. Also converts values to other types if specified.

Parameters
Name Description
message PrivateAuctionDeal

PrivateAuctionDeal

options $protobuf.IConversionOptions

Conversion options

Returns
Type Description
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a PrivateAuctionDeal message.

Parameter
Name Description
message { [k: string]: any }

Plain object to verify

Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not