REST Resource: networks.privateAuctions
Stay organized with collections
Save and categorize content based on your preferences.
Resource: PrivateAuction
The PrivateAuction resource.
| JSON representation |
{
"name": string,
"sellerContactUsers": [
string
],
"privateAuctionId": string,
"displayName": string,
"description": string,
"archived": boolean,
"createTime": string,
"updateTime": string
} |
| Fields |
name |
string
Identifier. The resource name of the PrivateAuction. Format: networks/{networkCode}/privateAuctions/{privateAuctionId}
|
sellerContactUsers[] |
string
Optional. The resource names of the seller contact users associated with this PrivateAuction. Format: networks/{networkCode}/users/{userId}
|
privateAuctionId |
string (int64 format)
Output only. PrivateAuction ID.
|
displayName |
string
Required. Display name of the PrivateAuction. This attribute has a maximum length of 255 bytes.
|
description |
string
Optional. Description of the PrivateAuction. This attribute has a maximum length of 4096 bytes.
|
archived |
boolean
Output only. Whether the PrivateAuction is archived.
|
createTime |
string (Timestamp format)
Output only. The instant at which the PrivateAuction was created. Uses RFC 3339, where generated output will always be Z-normalized and uses 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 PrivateAuction was last updated. Uses RFC 3339, where generated output will always be Z-normalized and uses 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".
|
Methods |
|
|
API to create a PrivateAuction object. |
|
|
API to retrieve a PrivateAuction object. |
|
|
API to retrieve a list of PrivateAuction objects. |
|
|
API to update a PrivateAuction object. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-20 UTC.
[null,null,["Last updated 2025-08-20 UTC."],[],[],null,["# REST Resource: networks.privateAuctions\n\n- [Resource: PrivateAuction](#PrivateAuction)\n - [JSON representation](#PrivateAuction.SCHEMA_REPRESENTATION)\n- [Methods](#METHODS_SUMMARY)\n\nResource: PrivateAuction\n------------------------\n\nThe `PrivateAuction` resource.\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"sellerContactUsers\": [ string ], \"privateAuctionId\": string, \"displayName\": string, \"description\": string, \"archived\": boolean, \"createTime\": string, \"updateTime\": string } ``` |\n\n| Fields ||\n|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Identifier. The resource name of the `PrivateAuction`. Format: `networks/{networkCode}/privateAuctions/{privateAuctionId}` |\n| `sellerContactUsers[]` | `string` Optional. The resource names of the seller contact users associated with this `PrivateAuction`. Format: `networks/{networkCode}/users/{userId}` |\n| `privateAuctionId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Output only. `PrivateAuction` ID. |\n| `displayName` | `string` Required. Display name of the `PrivateAuction`. This attribute has a maximum length of 255 bytes. |\n| `description` | `string` Optional. Description of the `PrivateAuction`. This attribute has a maximum length of 4096 bytes. |\n| `archived` | `boolean` Output only. Whether the `PrivateAuction` is archived. |\n| `createTime` | `string (`[Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp)` format)` Output only. The instant at which the PrivateAuction was created. Uses RFC 3339, where generated output will always be Z-normalized and uses 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\"`. |\n| `updateTime` | `string (`[Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp)` format)` Output only. The instant at which the PrivateAuction was last updated. Uses RFC 3339, where generated output will always be Z-normalized and uses 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\"`. |\n\n| Methods ------- ||\n|--------------------------------------------------------------------------------------|-----------------------------------------------------|\n| ### [create](/ad-manager/api/beta/reference/rest/v1/networks.privateAuctions/create) | API to create a `PrivateAuction` object. |\n| ### [get](/ad-manager/api/beta/reference/rest/v1/networks.privateAuctions/get) | API to retrieve a `PrivateAuction` object. |\n| ### [list](/ad-manager/api/beta/reference/rest/v1/networks.privateAuctions/list) | API to retrieve a list of `PrivateAuction` objects. |\n| ### [patch](/ad-manager/api/beta/reference/rest/v1/networks.privateAuctions/patch) | API to update a `PrivateAuction` object. |"]]
