REST Resource: directorySites

Resource: DirectorySite

DirectorySites contains properties of a website from the Site Directory. Sites need to be added to an account via the Sites resource before they can be assigned to a placement.

JSON representation 
{
  "id": string,
  "name": string,
  "url": string,
  "kind": string,
  "settings": {
    object (DirectorySiteSettings)
  },
  "inpageTagFormats": [
    enum (InpageTagFormat)
  ],
  "interstitialTagFormats": [
    enum (InterstitialTagFormat)
  ],
  "idDimensionValue": {
    object (DimensionValue)
  },
  "publisherSpecificationId": string
}
Fields
id

string (int64 format)

ID of this directory site. This is a read-only, auto-generated field.
name

string

Name of this directory site.
url

string

URL of this directory site.
kind

string

Identifies what kind of resource this is. Value: the fixed string

"dfareporting#directorySite"

.
settings

object (DirectorySiteSettings)

Directory site settings.
inpageTagFormats[]

enum (InpageTagFormat)

Tag types for regular placements.

Acceptable values are:

  • "

    STANDARD

    "

  • "

    IFRAME_JAVASCRIPT_INPAGE

    "

  • "

    INTERNAL_REDIRECT_INPAGE

    "

  • "

    JAVASCRIPT_INPAGE

    "
interstitialTagFormats[]

enum (InterstitialTagFormat)

Tag types for interstitial placements.

Acceptable values are:

  • "

    IFRAME_JAVASCRIPT_INTERSTITIAL

    "

  • "

    INTERNAL_REDIRECT_INTERSTITIAL

    "

  • "

    JAVASCRIPT_INTERSTITIAL

    "
idDimensionValue

object (DimensionValue)

Dimension value for the ID of this directory site. This is a read-only, auto-generated field.
publisherSpecificationId

string (int64 format)

Output only. Default publisher specification ID of video placements under this directory site. Possible values are:

  • 1, Hulu
  • 2, NBC
  • 3, CBS
  • 4, CBS Desktop
  • 5, Discovery
  • 6, VEVO HD
  • 7, VEVO Vertical
  • 8, Fox
  • 9, CW Network
  • 10, Disney
  • 11, IGN
  • 12, NFL.com
  • 13, Turner Broadcasting
  • 14, Tubi on Fox
  • 15, Hearst Corporation
  • 16, Twitch Desktop
  • 17, ABC
  • 18, Univision
  • 19, MLB.com
  • 20, MLB.com Mobile
  • 21, MLB.com OTT
  • 22, Polsat
  • 23, TVN
  • 24, Mediaset
  • 25, Antena 3
  • 26, Mediamond
  • 27, Sky Italia
  • 28, Tubi on CBS
  • 29, Spotify
  • 30, Paramount
  • 31, Max

DirectorySiteSettings

Directory Site Settings

JSON representation 
{
  "interstitialPlacementAccepted": boolean,
  "instreamVideoPlacementAccepted": boolean,
  "dfpSettings": {
    object (DfpSettings)
  },
  "activeViewOptOut": boolean
}
Fields
interstitialPlacementAccepted

boolean

Whether this site accepts interstitial ads.
instreamVideoPlacementAccepted

boolean

Whether this site accepts in-stream video ads.
dfpSettings

object (DfpSettings)

Directory site Ad Manager settings.
activeViewOptOut

boolean

Whether this directory site has disabled active view creatives.

DfpSettings

Google Ad Manager Settings

JSON representation 
{
  "dfpNetworkCode": string,
  "dfpNetworkName": string,
  "pubPaidPlacementAccepted": boolean,
  "publisherPortalOnly": boolean,
  "programmaticPlacementAccepted": boolean
}
Fields
dfpNetworkCode

string

Ad Manager network code for this directory site.
dfpNetworkName

string

Ad Manager network name for this directory site.
pubPaidPlacementAccepted

boolean

Whether this directory site accepts publisher-paid tags.
publisherPortalOnly

boolean

Whether this directory site is available only via Publisher Portal.
programmaticPlacementAccepted

boolean

Whether this directory site accepts programmatic placements.

InpageTagFormat

Enums
STANDARD
IFRAME_JAVASCRIPT_INPAGE
INTERNAL_REDIRECT_INPAGE
JAVASCRIPT_INPAGE

InterstitialTagFormat

Enums
IFRAME_JAVASCRIPT_INTERSTITIAL
INTERNAL_REDIRECT_INTERSTITIAL
JAVASCRIPT_INTERSTITIAL

Methods

get

 Gets one directory site by ID.

insert

 Inserts a new directory site.

list

 Retrieves a list of directory sites, possibly filtered.