public interface PrivateAuctionDealOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getAuctionPriorityEnabled()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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> | 
        |
getEndTime()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.  | 
      
getPrivateAuctionDealId()
public abstract 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 abstract 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 abstract 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 abstract 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.  | 
      
getStatus()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.  |