- [Resource: PrivateAuctionDeal](https://developers.google.com/ad-manager/api/beta/reference/rest/v1/networks.privateAuctionDeals.md.txt#PrivateAuctionDeal)
  - [JSON representation](https://developers.google.com/ad-manager/api/beta/reference/rest/v1/networks.privateAuctionDeals.md.txt#PrivateAuctionDeal.SCHEMA_REPRESENTATION)
- [PrivateMarketplaceDealStatus](https://developers.google.com/ad-manager/api/beta/reference/rest/v1/networks.privateAuctionDeals.md.txt#PrivateMarketplaceDealStatus)
- [BuyerData](https://developers.google.com/ad-manager/api/beta/reference/rest/v1/networks.privateAuctionDeals.md.txt#BuyerData)
  - [JSON representation](https://developers.google.com/ad-manager/api/beta/reference/rest/v1/networks.privateAuctionDeals.md.txt#BuyerData.SCHEMA_REPRESENTATION)
- [NonGuaranteedDealPriority](https://developers.google.com/ad-manager/api/beta/reference/rest/v1/networks.privateAuctionDeals.md.txt#NonGuaranteedDealPriority)
  - [JSON representation](https://developers.google.com/ad-manager/api/beta/reference/rest/v1/networks.privateAuctionDeals.md.txt#NonGuaranteedDealPriority.SCHEMA_REPRESENTATION)
- [DealPriorityTier](https://developers.google.com/ad-manager/api/beta/reference/rest/v1/networks.privateAuctionDeals.md.txt#DealPriorityTier)
- [Methods](https://developers.google.com/ad-manager/api/beta/reference/rest/v1/networks.privateAuctionDeals.md.txt#METHODS_SUMMARY)

## Resource: PrivateAuctionDeal

The `PrivateAuctionDeal` resource.

| JSON representation |
|---|
| ``` { "name": string, "creativeSizes": [ { object (`Size`) } ], "privateAuctionDealId": string, "privateAuctionId": string, "privateAuctionDisplayName": string, "buyerAccountId": string, "externalDealId": string, "targeting": { object (`Targeting`) }, "startTime": string, "endTime": string, "floorPrice": { object (`Money`) }, "status": enum (`PrivateMarketplaceDealStatus`), "auctionPriorityEnabled": boolean, "blockOverrideEnabled": boolean, "publisherFloorExempt": boolean, "buyerPermissionType": enum (`DealBuyerPermissionType`), "buyerData": { object (`BuyerData`) }, "dealPriority": { object (`NonGuaranteedDealPriority`) }, "archived": boolean, "createTime": string, "updateTime": string } ``` |

| Fields ||
|---|---|
| `name` | `string` Identifier. The resource name of the `PrivateAuctionDeal`. Format: `networks/{networkCode}/privateAuctionDeals/{privateAuctionDealId}` |
| `creativeSizes[]` | ``object (`Size`)`` Optional. The expected creative sizes of the `PrivateAuctionDeal`. |
| `privateAuctionDealId (deprecated)` | `string (int64 format)` > [!WARNING] > Output only. Parse the ID from the `name` field instead. Output only. Deprecated: `PrivateAuctionDeal` ID. |
| `privateAuctionId` | `string (int64 format)` Immutable. The ID of the `PrivateAuction`. |
| `privateAuctionDisplayName` | `string` Output only. The display name of the `PrivateAuction`. |
| `buyerAccountId` | `string (int64 format)` Immutable. The account ID of the buyer of the `PrivateAuctionDeal`. |
| `externalDealId` | `string (int64 format)` Output only. The external ID of the `PrivateAuctionDeal`. |
| `targeting` | ``object (`Targeting`)`` Optional. The targeting of the `PrivateAuctionDeal`. |
| `startTime` | ``string (`Timestamp` format)`` Optional. Non-empty default. The start time of the `PrivateAuctionDeal`. If unset, the `startTime` will default as follows: On create: To the deal's `createTime`. On update: To the deal's existing `startTime`, which can be null. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: `"2014-10-02T15:01:23Z"`, `"2014-10-02T15:01:23.045123456Z"` or `"2014-10-02T15:01:23+05:30"`. |
| `endTime` | ``string (`Timestamp` format)`` Optional. The end time of the `PrivateAuctionDeal`. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: `"2014-10-02T15:01:23Z"`, `"2014-10-02T15:01:23.045123456Z"` or `"2014-10-02T15:01:23+05:30"`. |
| `floorPrice` | ``object (`Money`)`` Required. The floor price of the `PrivateAuctionDeal`. |
| `status` | ``enum (`PrivateMarketplaceDealStatus`)`` Output only. The status of the `PrivateAuctionDeal`. |
| `auctionPriorityEnabled` | `boolean` Optional. Whether the deal is enabled with priority over open auction. |
| `blockOverrideEnabled` | `boolean` Optional. Whether the deal has block override enabled. |
| `publisherFloorExempt` | `boolean` Optional. Whether the deal is exempt from publisher floor price. |
| `buyerPermissionType` | ``enum (`DealBuyerPermissionType`)`` Optional. The buyer permission model defining how the deal would transact among all buyers under the same bidder. |
| `buyerData` | ``object (`BuyerData`)`` Optional. The buyer data required by the Marketplace API. |
| `dealPriority` | ``object (`NonGuaranteedDealPriority`)`` Optional. The priority of the deal across all non-guaranteed deals. |
| `archived` | `boolean` Output only. Whether the deal is archived. |
| `createTime` | ``string (`Timestamp` format)`` Output only. The instant at which the `PrivateAuctionDeal` was created. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: `"2014-10-02T15:01:23Z"`, `"2014-10-02T15:01:23.045123456Z"` or `"2014-10-02T15:01:23+05:30"`. |
| `updateTime` | ``string (`Timestamp` format)`` Output only. The instant at which the `PrivateAuctionDeal` was last updated. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: `"2014-10-02T15:01:23Z"`, `"2014-10-02T15:01:23.045123456Z"` or `"2014-10-02T15:01:23+05:30"`. |

## PrivateMarketplaceDealStatus

Describes the status of a private marketplace deal.

| Enums ||
|---|---|
| `PRIVATE_MARKETPLACE_DEAL_STATUS_UNSPECIFIED` | No value specified. |
| `PENDING` | The deal is pending. |
| `ACTIVE` | The deal is active. |
| `CANCELED` | The deal is canceled. |
| `SELLER_PAUSED` | The deal is paused by the seller. |
| `BUYER_PAUSED` | The deal is paused by the buyer. |
| `COMPLETED` | The deal is past its end date. |

## BuyerData

Contains buyer data. This data is required by the Marketplace API.

| JSON representation |
|---|
| ``` { "buyerEmails": [ string ] } ``` |

| Fields ||
|---|---|
| `buyerEmails[]` | `string` Optional. The email contacts of the buyer of the `PrivateAuctionDeal`. |

## NonGuaranteedDealPriority

Represents the priority settings to apply to non-guaranteed deals, independently of their types.

| JSON representation |
|---|
| ``` { "priorityTier": enum (`DealPriorityTier`) } ``` |

| Fields ||
|---|---|
| `priorityTier` | ``enum (`DealPriorityTier`)`` Required. Enables publishers to favor certain deals, even if their default priorities are lower. For example, allowing a PA deal to beat a PD deal. |

## DealPriorityTier

Priority tier of non guaranteed deal products.

| Enums ||
|---|---|
| `DEAL_PRIORITY_TIER_UNSPECIFIED` | No value specified. |
| `TIER1` | Tier 1 |
| `TIER2` | Tier 2 |
| `TIER3` | Tier 3 |
| `TIER4` | Tier 4 |
| `TIER5` | Tier 5 |
| `TIER6` | Tier 6 |
| `TIER7` | Tier 7 |
| `TIER8` | Tier 8 |
| `TIER9` | Tier 9 |
| `OPTIMIZED` | Open Auction optimized tier |

| ## Methods ||
|---|---|
| ### `create` | Creates a `PrivateAuctionDeal` object. |
| ### `get` | Retrieves a `PrivateAuctionDeal` object. |
| ### `list` | Lists `PrivateAuctionDeal` objects. |
| ### `patch` | Updates a `PrivateAuctionDeal` object. |