REST Resource: exchanges.publishers

Resource: Publisher

Encapsulates a single publisher.

JSON representation
{
  "name": string,
  "externalPublisherId": string,
  "externalPublisherIds": [
    string
  ],
  "displayName": string,
  "status": enum (DiscoveryObjectStatus),
  "mediumCapability": enum (MediumCapability),
  "description": string,
  "contactInfo": [
    string
  ],
  "commitmentCapability": [
    enum (CommitmentCapability)
  ],
  "forecast": {
    object (SellerProvidedInventoryAvailabilityEstimate)
  },
  "logoUrl": string,
  "floorPrice": {
    object (Money)
  },
  "ceilingPrice": {
    object (Money)
  },
  "generalCapability": string,
  "tvMetadata": {
    object (TVMetadata)
  },
  "urgOwners": [
    enum (UnderRepresentedGroup)
  ]
}
Fields
name

string

Output only. Relative route name for this publisher. Should be of the form: "exchanges/{seller_id}/publishers/{publisherId} Example: "exchanges/1234/publishers/5678".

externalPublisherId

string

Required. [DEPRECATED] This field will soon be replaced by the externalPublisherIds[]. Exchange provided unique publisher id. Must match the publisher id sent in bid requests.

Max 100 characters. Allowed characters are alphanumeric, underscore, dash, and dot.

externalPublisherIds[]

string

Optional. Exchange provided publisher ids. Each id must be unique and match the publisher id sent in bid requests.

Max 10 counts. Max 100 characters per ID. Allowed characters are alphanumeric, underscore, dash, and dot.

displayName

string

Required. The display name of this publisher. Must be UTF-8 encoded with a maximum size of 30 characters.

status

enum (DiscoveryObjectStatus)

Required. The status of this publisher. Publishers with status PAUSED or REMOVED are not shown to DV3 advertisers.

mediumCapability

enum (MediumCapability)

Required. The media this publisher plans to host their ads on.

description

string

Required. The description text for this publisher. Must be UTF-8 encoded with a maximum size of 1000 characters. Required.

contactInfo[]

string

Required. Point of contact emails for the advertisers to communicate with publisher. Max 10 contacts. Each contact max 100 characters. Example: [US contact - John Smith: john.smith@abc.com]. Required.

commitmentCapability[]

enum (CommitmentCapability)

Optional. Commitment types this publisher supports.

forecast

object (SellerProvidedInventoryAvailabilityEstimate)

Required. Forecasting breakdown for this publisher’s inventory. DV3 advertisers can see and filter on these breakdowns. Domain forecast breakdown is required.

logoUrl

string

Output only. The url for the logo of this publisher.

floorPrice

object (Money)

Optional. The floor price of this publisher. Must have same currency code with ceiling price.

ceilingPrice

object (Money)

Optional. The ceiling price of this publisher. Must have same currency code with floor price.

generalCapability

string

Optional.

tvMetadata

object (TVMetadata)

Optional. Metadata for publisher that has TV offerings. Required when medium capability contains TV. Not applicable when medium capability does not contain TV.

urgOwners[]

enum (UnderRepresentedGroup)

Optional. Under represented groups the owner is a member of, if any.

MediumCapability

Medium capability enum. The Marketplace frontend (within DV360’s Inventory Module) includes different sections for inventory. "Digital: This includes publishers & auction packages spanning across Display, Video (incl. CTV & OTT) and Audio inventory." "TV: This is our newly launched dedicated section for discovering CTV & OTT inventory. CTV & OTT are defined as below: "Connected TV (CTV) includes all devices that fit into the following descriptions: - Connected or Streaming devices: Devices that connect to a TV screen to display video streams (Roku, Apple TV, etc.) - Smart TV: TVs with integrated Internet connections (Samsung Smart TV, etc.) - Gaming consoles: Internet-connected gaming consoles (Xbox, PlayStation, Wii, etc.) - Set top boxes: Devices delivering traditional cable and video on demand content." "Over the Top (OTT) means TV-like video content delivered by a video provider over the Internet outside the closed networks of telecom and cable providers. OTT Video can be viewed on desktop, mobile, tablet, as well as CTV or STB devices (as long as the content is delivered over IP for the latter). "Audio: This is a newly launched, dedicated section for audio inventory." "OOH: Digital out of home publishers."

Enums
MEDIUM_CAPABILITY_UNSPECIFIED Medium capability unspecified. Not valid input.
MEDIUM_CAPABILITY_DIGITAL Medium capability digital.
MEDIUM_CAPABILITY_TV Medium capability TV.
MEDIUM_CAPABILITY_AUDIO Medium capability audio.
MEDIUM_CAPABILITY_OOH Medium capability Out of home.

CommitmentCapability

Commitment capability enum.

Enums
COMMITMENT_CAPABILITY_UNSPECIFIED Commitment capability unspecified. Not valid input.
COMMITMENT_CAPABILITY_GUARANTEED Publisher has guaranteed inventory.
COMMITMENT_CAPABILITY_NON_GUARANTEED Publisher has non guaranteed inventory.

TVMetadata

Metadata for publishers that has TV offerings.

JSON representation
{
  "tvDeliveryType": enum (TVDeliveryType),
  "topShows": [
    string
  ]
}
Fields
tvDeliveryType

enum (TVDeliveryType)

Required. Delivery type of TV ads.

topShows[]

string

Optional. List of top TV shows titles owned by the publisher. Max size 10. Must be UTF-8 encoded.

TVDeliveryType

TV delivery type enum.

Enums
TV_DELIVERY_TYPE_UNSPECIFIED Tv delivery type unspecified. Not valid input.
TV_DELIVERY_TYPE_CTV TV delivery type connected TV.
TV_DELIVERY_TYPE_LINEAR_TV TV delivery type linear TV.

Methods

create

Creates a new publisher.

get

Gets an publisher.

list

Lists publishers.

patch

Updates an publisher.
Upload publisher Logo.