REST Resource: networks.privateAuctions

Resource: PrivateAuction

The PrivateAuction resource.

JSON representation 
{
  "name": string,
  "privateAuctionId": string,
  "displayName": string,
  "description": string,
  "sellerContactUsers": [
    string
  ],
  "archived": boolean,
  "createTime": string,
  "updateTime": string
}
Fields
name

string

Identifier. The resource name of the PrivateAuction. Format: networks/{networkCode}/privateAuctions/{privateAuctionId}
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.
sellerContactUsers[]

string

Optional. The resource names of the seller contact users associated with this PrivateAuction. Format: networks/{networkCode}/users/{userId}
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

batchArchive

 API to batch archive PrivateAuction objects.

batchCreate

 API to batch create PrivateAuction objects.

batchUnarchive

 API to batch unarchive PrivateAuction objects.

batchUpdate

 API to batch update PrivateAuction objects.

create

 API to create a PrivateAuction object.

get

 API to retrieve a PrivateAuction object.

list

 API to retrieve a list of PrivateAuction objects.

patch

 API to update a PrivateAuction object.