REST Resource: accounts.products

  • A Product represents a segment of inventory a seller wants to sell, including terms and targeting information.

  • Products have a JSON representation with fields such as productId, createTime, updateTime, seller, and targetingCriterion.

  • You can use the get method to retrieve a specific product by its ID or the list method to view all products visible to the buyer, with optional filtering.

Resource: Product

A product is a segment of inventory that a seller wants to sell. It is associated with certain terms and targeting information which helps the buyer know more about the inventory.

JSON representation 
{
  "productId": string,
  "createTime": string,
  "updateTime": string,
  "seller": {
    object (Seller)
  },
  "publisherProfileId": string,
  "displayName": string,
  "terms": {
    object (DealTerms)
  },
  "creatorContacts": [
    {
      object (ContactInformation)
    }
  ],
  "availableStartTime": string,
  "availableEndTime": string,
  "hasCreatorSignedOff": boolean,
  "targetingCriterion": [
    {
      object (TargetingCriteria)
    }
  ],
  "webPropertyCode": string,
  "productRevision": string,
  "syndicationProduct": enum (SyndicationProduct)
}
Fields
productId

string

The unique ID for the product.
createTime

string (Timestamp format)

Creation time.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Time of last update.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
seller

object (Seller)

Information about the seller that created this product.
publisherProfileId

string

An ID which can be used by the Publisher Profile API to get more information about the seller that created this product.
displayName

string

The display name for this product as set by the seller.
terms

object (DealTerms)

The negotiable terms of the deal.
creatorContacts[]

object (ContactInformation)

Optional contact information for the creator of this product.
availableStartTime

string (Timestamp format)

Inventory availability dates. The start time will be truncated to seconds during serving. Thus, a field specified as 3:23:34.456 (HH:mm:ss.SSS) will be truncated to 3:23:34 when serving.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
availableEndTime

string (Timestamp format)

The proposed end time for the deal. The field will be truncated to the order of seconds during serving.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
hasCreatorSignedOff

boolean

If the creator has already signed off on the product, then the buyer can finalize the deal by accepting the product as is. When copying to a proposal, if any of the terms are changed, then auto_finalize is automatically set to false.
targetingCriterion[]

object (TargetingCriteria)

Targeting that is shared between the buyer and the seller. Each targeting criterion has a specified key and for each key there is a list of inclusion value or exclusion values.
webPropertyCode

string

The web-property code for the seller. This needs to be copied as is when adding a new deal to a proposal.
productRevision

string (int64 format)

The revision number of the product (auto-assigned by Marketplace).
syndicationProduct

enum (SyndicationProduct)

The syndication product associated with the deal.

Methods

get

 Gets the requested product by ID.

list

 List all products visible to the buyer (optionally filtered by the specified PQL query).