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,
  "description": string,
  "parentId": long,
  "countryId": long,
  "currencyId": long,
  "settings": {
    "interstitialPlacementAccepted": boolean,
    "instreamVideoPlacementAccepted": boolean,
    "dfpSettings": {
      "dfpNetworkCode": string,
      "dfpNetworkName": string,
      "pubPaidPlacementAccepted": boolean,
      "publisherPortalOnly": boolean,
      "programmaticPlacementAccepted": boolean
    },
    "activeViewOptOut": boolean,
    "videoActiveViewOptOut": boolean,
    "verificationTagOptOut": boolean,
    "nielsenOcrOptOut": boolean
  },
  "inpageTagFormats": [
    string
  ],
  "interstitialTagFormats": [
    string
  ],
  "contactAssignments": [
    {
      "contactId": long,
      "visibility": string
    }
  ]
}
Property name Value Description Notes
active boolean Whether this directory site is active.
contactAssignments[] list Directory site contacts.
contactAssignments[].contactId long ID of this directory site contact. This is a read-only, auto-generated field.
contactAssignments[].visibility string Visibility of this directory site contact assignment. When set to PUBLIC this contact assignment is visible to all account and agency users; when set to PRIVATE it is visible only to the site.

Acceptable values are:
  • "PRIVATE"
  • "PUBLIC"
countryId long Country ID of this directory site. This is a read-only field.
currencyId long Currency ID of this directory site. This is a read-only field.

Possible values are:

  • "1" for USD
  • "2" for GBP
  • "3" for ESP
  • "4" for SEK
  • "5" for CAD
  • "6" for JPY
  • "7" for DEM
  • "8" for AUD
  • "9" for FRF
  • "10" for ITL
  • "11" for DKK
  • "12" for NOK
  • "13" for FIM
  • "14" for ZAR
  • "15" for IEP
  • "16" for NLG
  • "17" for EUR
  • "18" for KRW
  • "19" for TWD
  • "20" for SGD
  • "21" for CNY
  • "22" for HKD
  • "23" for NZD
  • "24" for MYR
  • "25" for BRL
  • "26" for PTE
  • "27" for MXP
  • "28" for CLP
  • "29" for TRY
  • "30" for ARS
  • "31" for PEN
  • "32" for ILS
  • "33" for CHF
  • "34" for VEF
  • "35" for COP
  • "36" for GTQ
  • "37" for PLN
  • "39" for INR
  • "40" for THB
  • "41" for IDR
  • "42" for CZK
  • "43" for RON
  • "44" for HUF
  • "45" for RUB
  • "46" for AED
  • "47" for BGN
  • "48" for HRK
  • "49" for MXN

description string Description of this directory site. This is a read-only field.
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.
parentId long Parent directory site ID.
settings nested object Directory site settings.
settings.activeViewOptOut boolean Whether this directory site has disabled active view creatives.
settings.dfpSettings nested object Directory site DFP settings.
settings.dfpSettings.dfpNetworkCode string DFP network code for this directory site.
settings.dfpSettings.dfpNetworkName string DFP 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 DoubleClick Publisher Portal.
settings.instreamVideoPlacementAccepted boolean Whether this site accepts in-stream video ads.
settings.interstitialPlacementAccepted boolean Whether this site accepts interstitial ads.
settings.nielsenOcrOptOut boolean Whether this directory site has disabled Nielsen OCR reach ratings.
settings.verificationTagOptOut boolean Whether this directory site has disabled generation of Verification ins tags.
settings.videoActiveViewOptOut boolean Whether this directory site has disabled active view for in-stream video creatives. This is a read-only field.
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.

Send feedback about...

DoubleClick Campaign Manager
DoubleClick Campaign Manager