Class PrivateAuctionDeal (0.27.0)

public final class PrivateAuctionDeal extends GeneratedMessageV3 implements PrivateAuctionDealOrBuilder

The PrivateAuctionDeal resource.

Protobuf type google.ads.admanager.v1.PrivateAuctionDeal

Static Fields

AUCTION_PRIORITY_ENABLED_FIELD_NUMBER

public static final int AUCTION_PRIORITY_ENABLED_FIELD_NUMBER
Field Value
Type Description
int

BLOCK_OVERRIDE_ENABLED_FIELD_NUMBER

public static final int BLOCK_OVERRIDE_ENABLED_FIELD_NUMBER
Field Value
Type Description
int

BUYER_ACCOUNT_ID_FIELD_NUMBER

public static final int BUYER_ACCOUNT_ID_FIELD_NUMBER
Field Value
Type Description
int

BUYER_DATA_FIELD_NUMBER

public static final int BUYER_DATA_FIELD_NUMBER
Field Value
Type Description
int

BUYER_PERMISSION_TYPE_FIELD_NUMBER

public static final int BUYER_PERMISSION_TYPE_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

CREATIVE_SIZES_FIELD_NUMBER

public static final int CREATIVE_SIZES_FIELD_NUMBER
Field Value
Type Description
int

END_TIME_FIELD_NUMBER

public static final int END_TIME_FIELD_NUMBER
Field Value
Type Description
int

EXTERNAL_DEAL_ID_FIELD_NUMBER

public static final int EXTERNAL_DEAL_ID_FIELD_NUMBER
Field Value
Type Description
int

FLOOR_PRICE_FIELD_NUMBER

public static final int FLOOR_PRICE_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PRIVATE_AUCTION_DEAL_ID_FIELD_NUMBER

public static final int PRIVATE_AUCTION_DEAL_ID_FIELD_NUMBER
Field Value
Type Description
int

PRIVATE_AUCTION_DISPLAY_NAME_FIELD_NUMBER

public static final int PRIVATE_AUCTION_DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

PRIVATE_AUCTION_ID_FIELD_NUMBER

public static final int PRIVATE_AUCTION_ID_FIELD_NUMBER
Field Value
Type Description
int

STATUS_FIELD_NUMBER

public static final int STATUS_FIELD_NUMBER
Field Value
Type Description
int

TARGETING_FIELD_NUMBER

public static final int TARGETING_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static PrivateAuctionDeal getDefaultInstance()
Returns
Type Description
PrivateAuctionDeal

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static PrivateAuctionDeal.Builder newBuilder()
Returns
Type Description
PrivateAuctionDeal.Builder

newBuilder(PrivateAuctionDeal prototype)

public static PrivateAuctionDeal.Builder newBuilder(PrivateAuctionDeal prototype)
Parameter
Name Description
prototype PrivateAuctionDeal
Returns
Type Description
PrivateAuctionDeal.Builder

parseDelimitedFrom(InputStream input)

public static PrivateAuctionDeal parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PrivateAuctionDeal
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PrivateAuctionDeal parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PrivateAuctionDeal
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static PrivateAuctionDeal parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
PrivateAuctionDeal
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PrivateAuctionDeal parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PrivateAuctionDeal
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PrivateAuctionDeal parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
PrivateAuctionDeal
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PrivateAuctionDeal parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PrivateAuctionDeal
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PrivateAuctionDeal parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
PrivateAuctionDeal
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PrivateAuctionDeal parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PrivateAuctionDeal
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static PrivateAuctionDeal parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PrivateAuctionDeal
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PrivateAuctionDeal parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PrivateAuctionDeal
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static PrivateAuctionDeal parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
PrivateAuctionDeal
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PrivateAuctionDeal parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PrivateAuctionDeal
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<PrivateAuctionDeal> parser()
Returns
Type Description
Parser<PrivateAuctionDeal>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAuctionPriorityEnabled()

public boolean getAuctionPriorityEnabled()

Optional. Whether the deal is enabled with priority over open auction.

optional bool auction_priority_enabled = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The auctionPriorityEnabled.

getBlockOverrideEnabled()

public boolean getBlockOverrideEnabled()

Optional. Whether the deal has block override enabled.

optional bool block_override_enabled = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The blockOverrideEnabled.

getBuyerAccountId()

public long getBuyerAccountId()

Immutable. The account ID of the buyer of the PrivateAuctionDeal.

optional int64 buyer_account_id = 4 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
long

The buyerAccountId.

getBuyerData()

public PrivateAuctionDeal.BuyerData getBuyerData()

Optional. The buyer data required by the Marketplace API.

optional .google.ads.admanager.v1.PrivateAuctionDeal.BuyerData buyer_data = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PrivateAuctionDeal.BuyerData

The buyerData.

getBuyerDataOrBuilder()

public PrivateAuctionDeal.BuyerDataOrBuilder getBuyerDataOrBuilder()

Optional. The buyer data required by the Marketplace API.

optional .google.ads.admanager.v1.PrivateAuctionDeal.BuyerData buyer_data = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PrivateAuctionDeal.BuyerDataOrBuilder

getBuyerPermissionType()

public DealBuyerPermissionTypeEnum.DealBuyerPermissionType getBuyerPermissionType()

Optional. The buyer permission model defining how the deal would transact among all buyers under the same bidder.

optional .google.ads.admanager.v1.DealBuyerPermissionTypeEnum.DealBuyerPermissionType buyer_permission_type = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DealBuyerPermissionTypeEnum.DealBuyerPermissionType

The buyerPermissionType.

getBuyerPermissionTypeValue()

public int getBuyerPermissionTypeValue()

Optional. The buyer permission model defining how the deal would transact among all buyers under the same bidder.

optional .google.ads.admanager.v1.DealBuyerPermissionTypeEnum.DealBuyerPermissionType buyer_permission_type = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for buyerPermissionType.

getCreateTime()

public Timestamp getCreateTime()

Output only. The instant at which the PrivateAuctionDeal was created.

optional .google.protobuf.Timestamp create_time = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The instant at which the PrivateAuctionDeal was created.

optional .google.protobuf.Timestamp create_time = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getCreativeSizes(int index)

public Size getCreativeSizes(int index)

Optional. The expected creative sizes of the PrivateAuctionDeal.

repeated .google.ads.admanager.v1.Size creative_sizes = 18 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Size

getCreativeSizesCount()

public int getCreativeSizesCount()

Optional. The expected creative sizes of the PrivateAuctionDeal.

repeated .google.ads.admanager.v1.Size creative_sizes = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getCreativeSizesList()

public List<Size> getCreativeSizesList()

Optional. The expected creative sizes of the PrivateAuctionDeal.

repeated .google.ads.admanager.v1.Size creative_sizes = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Size>

getCreativeSizesOrBuilder(int index)

public SizeOrBuilder getCreativeSizesOrBuilder(int index)

Optional. The expected creative sizes of the PrivateAuctionDeal.

repeated .google.ads.admanager.v1.Size creative_sizes = 18 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
SizeOrBuilder

getCreativeSizesOrBuilderList()

public List<? extends SizeOrBuilder> getCreativeSizesOrBuilderList()

Optional. The expected creative sizes of the PrivateAuctionDeal.

repeated .google.ads.admanager.v1.Size creative_sizes = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.ads.admanager.v1.SizeOrBuilder>

getDefaultInstanceForType()

public PrivateAuctionDeal getDefaultInstanceForType()
Returns
Type Description
PrivateAuctionDeal

getEndTime()

public Timestamp getEndTime()

Optional. The end time of the PrivateAuctionDeal.

optional .google.protobuf.Timestamp end_time = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Timestamp

The endTime.

getEndTimeOrBuilder()

public TimestampOrBuilder getEndTimeOrBuilder()

Optional. The end time of the PrivateAuctionDeal.

optional .google.protobuf.Timestamp end_time = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TimestampOrBuilder

getExternalDealId()

public long getExternalDealId()

Output only. The external ID of the PrivateAuctionDeal.

optional int64 external_deal_id = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
long

The externalDealId.

getFloorPrice()

public Money getFloorPrice()

Required. The floor price of the PrivateAuctionDeal.

optional .google.type.Money floor_price = 9 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
com.google.type.Money

The floorPrice.

getFloorPriceOrBuilder()

public MoneyOrBuilder getFloorPriceOrBuilder()

Required. The floor price of the PrivateAuctionDeal.

optional .google.type.Money floor_price = 9 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
com.google.type.MoneyOrBuilder

getName()

public String getName()

Identifier. The resource name of the PrivateAuctionDeal. Format: networks/{network_code}/privateAuctionDeals/{private_auction_deal_id}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. The resource name of the PrivateAuctionDeal. Format: networks/{network_code}/privateAuctionDeals/{private_auction_deal_id}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<PrivateAuctionDeal> getParserForType()
Returns
Type Description
Parser<PrivateAuctionDeal>
Overrides

getPrivateAuctionDealId()

public long getPrivateAuctionDealId()

Output only. PrivateAuctionDeal ID.

optional int64 private_auction_deal_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
long

The privateAuctionDealId.

getPrivateAuctionDisplayName()

public String getPrivateAuctionDisplayName()

Output only. The display name of the PrivateAuction.

optional string private_auction_display_name = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The privateAuctionDisplayName.

getPrivateAuctionDisplayNameBytes()

public ByteString getPrivateAuctionDisplayNameBytes()

Output only. The display name of the PrivateAuction.

optional string private_auction_display_name = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for privateAuctionDisplayName.

getPrivateAuctionId()

public long getPrivateAuctionId()

Immutable. The ID of the PrivateAuction.

optional int64 private_auction_id = 3 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
long

The privateAuctionId.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStatus()

public PrivateMarketplaceDealStatusEnum.PrivateMarketplaceDealStatus getStatus()

Output only. The status of the PrivateAuctionDeal.

optional .google.ads.admanager.v1.PrivateMarketplaceDealStatusEnum.PrivateMarketplaceDealStatus status = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
PrivateMarketplaceDealStatusEnum.PrivateMarketplaceDealStatus

The status.

getStatusValue()

public int getStatusValue()

Output only. The status of the PrivateAuctionDeal.

optional .google.ads.admanager.v1.PrivateMarketplaceDealStatusEnum.PrivateMarketplaceDealStatus status = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for status.

getTargeting()

public Targeting getTargeting()

Optional. The targeting of the PrivateAuctionDeal.

optional .google.ads.admanager.v1.Targeting targeting = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Targeting

The targeting.

getTargetingOrBuilder()

public TargetingOrBuilder getTargetingOrBuilder()

Optional. The targeting of the PrivateAuctionDeal.

optional .google.ads.admanager.v1.Targeting targeting = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TargetingOrBuilder

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The instant at which the PrivateAuctionDeal was last updated.

optional .google.protobuf.Timestamp update_time = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The instant at which the PrivateAuctionDeal was last updated.

optional .google.protobuf.Timestamp update_time = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasAuctionPriorityEnabled()

public boolean hasAuctionPriorityEnabled()

Optional. Whether the deal is enabled with priority over open auction.

optional bool auction_priority_enabled = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the auctionPriorityEnabled field is set.

hasBlockOverrideEnabled()

public boolean hasBlockOverrideEnabled()

Optional. Whether the deal has block override enabled.

optional bool block_override_enabled = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the blockOverrideEnabled field is set.

hasBuyerAccountId()

public boolean hasBuyerAccountId()

Immutable. The account ID of the buyer of the PrivateAuctionDeal.

optional int64 buyer_account_id = 4 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
boolean

Whether the buyerAccountId field is set.

hasBuyerData()

public boolean hasBuyerData()

Optional. The buyer data required by the Marketplace API.

optional .google.ads.admanager.v1.PrivateAuctionDeal.BuyerData buyer_data = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the buyerData field is set.

hasBuyerPermissionType()

public boolean hasBuyerPermissionType()

Optional. The buyer permission model defining how the deal would transact among all buyers under the same bidder.

optional .google.ads.admanager.v1.DealBuyerPermissionTypeEnum.DealBuyerPermissionType buyer_permission_type = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the buyerPermissionType field is set.

hasCreateTime()

public boolean hasCreateTime()

Output only. The instant at which the PrivateAuctionDeal was created.

optional .google.protobuf.Timestamp create_time = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasEndTime()

public boolean hasEndTime()

Optional. The end time of the PrivateAuctionDeal.

optional .google.protobuf.Timestamp end_time = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the endTime field is set.

hasExternalDealId()

public boolean hasExternalDealId()

Output only. The external ID of the PrivateAuctionDeal.

optional int64 external_deal_id = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the externalDealId field is set.

hasFloorPrice()

public boolean hasFloorPrice()

Required. The floor price of the PrivateAuctionDeal.

optional .google.type.Money floor_price = 9 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the floorPrice field is set.

hasPrivateAuctionDealId()

public boolean hasPrivateAuctionDealId()

Output only. PrivateAuctionDeal ID.

optional int64 private_auction_deal_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the privateAuctionDealId field is set.

hasPrivateAuctionDisplayName()

public boolean hasPrivateAuctionDisplayName()

Output only. The display name of the PrivateAuction.

optional string private_auction_display_name = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the privateAuctionDisplayName field is set.

hasPrivateAuctionId()

public boolean hasPrivateAuctionId()

Immutable. The ID of the PrivateAuction.

optional int64 private_auction_id = 3 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
boolean

Whether the privateAuctionId field is set.

hasStatus()

public boolean hasStatus()

Output only. The status of the PrivateAuctionDeal.

optional .google.ads.admanager.v1.PrivateMarketplaceDealStatusEnum.PrivateMarketplaceDealStatus status = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the status field is set.

hasTargeting()

public boolean hasTargeting()

Optional. The targeting of the PrivateAuctionDeal.

optional .google.ads.admanager.v1.Targeting targeting = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the targeting field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. The instant at which the PrivateAuctionDeal was last updated.

optional .google.protobuf.Timestamp update_time = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public PrivateAuctionDeal.Builder newBuilderForType()
Returns
Type Description
PrivateAuctionDeal.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PrivateAuctionDeal.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
PrivateAuctionDeal.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public PrivateAuctionDeal.Builder toBuilder()
Returns
Type Description
PrivateAuctionDeal.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException