DirectorySites

For a list of methods for this resource, see the end of this page.

Resource representations

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.

{
  "kind": "dfareporting#directorySite",
  "id": long,
  "idDimensionValue": dimensionValues Resource,
  "name": string,
  "url": string,
  "active": boolean,
  "settings": {
    "interstitialPlacementAccepted": boolean,
    "instreamVideoPlacementAccepted": boolean,
    "dfpSettings": {
      "dfpNetworkCode": string,
      "dfpNetworkName": string,
      "pubPaidPlacementAccepted": boolean,
      "publisherPortalOnly": boolean,
      "programmaticPlacementAccepted": boolean
    },
    "activeViewOptOut": boolean
  },
  "inpageTagFormats": [
    string
  ],
  "interstitialTagFormats": [
    string
  ]
}
Property name Value Description Notes
active boolean Whether this directory site is active.
id long ID of this directory site. This is a read-only, auto-generated field.
idDimensionValue nested object Dimension value for the ID of this directory site. This is a read-only, auto-generated field.
inpageTagFormats[] list Tag types for regular placements.

Acceptable values are:
  • "STANDARD"
  • "IFRAME_JAVASCRIPT_INPAGE"
  • "INTERNAL_REDIRECT_INPAGE"
  • "JAVASCRIPT_INPAGE"
interstitialTagFormats[] list Tag types for interstitial placements.

Acceptable values are:
  • "IFRAME_JAVASCRIPT_INTERSTITIAL"
  • "INTERNAL_REDIRECT_INTERSTITIAL"
  • "JAVASCRIPT_INTERSTITIAL"
kind string Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySite".
name string Name of this directory site.
settings nested object Directory site settings.
settings.activeViewOptOut boolean Whether this directory site has disabled active view creatives.
settings.dfpSettings nested object Directory site Ad Manager settings.
settings.dfpSettings.dfpNetworkCode string Ad Manager network code for this directory site.
settings.dfpSettings.dfpNetworkName string Ad Manager network name for this directory site.
settings.dfpSettings.programmaticPlacementAccepted boolean Whether this directory site accepts programmatic placements.
settings.dfpSettings.pubPaidPlacementAccepted boolean Whether this directory site accepts publisher-paid tags.
settings.dfpSettings.publisherPortalOnly boolean Whether this directory site is available only via Publisher Portal.
settings.instreamVideoPlacementAccepted boolean Whether this site accepts in-stream video ads.
settings.interstitialPlacementAccepted boolean Whether this site accepts interstitial ads.
url string URL of this directory site.

Methods

get
Gets one directory site by ID.
insert
Inserts a new directory site.
list
Retrieves a list of directory sites, possibly filtered. This method supports paging.