The Campaign Manager 360 API v3.4 is deprecated and will be sunset on Dec 24th, 2021. All users must migrate to a newer API version by that date.

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,
  "active": boolean,
  "kind": string,
  "settings": {
    object (DirectorySiteSettings)
  },
  "inpageTagFormats": [
    enum (InpageTagFormats)
  ],
  "interstitialTagFormats": [
    enum (InterstitialTagFormats)
  ],
  "idDimensionValue": {
    object (DimensionValue)
  }
}
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.

active

boolean

Whether this directory site is active.

kind

string

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

"dfareporting#directorySite"

.

settings

object (DirectorySiteSettings)

Directory site settings.

inpageTagFormats[]

enum (InpageTagFormats)

Tag types for regular placements.

Acceptable values are:

  • "

    STANDARD

    "

  • "

    IFRAME_JAVASCRIPT_INPAGE

    "

  • "

    INTERNAL_REDIRECT_INPAGE

    "

  • "

    JAVASCRIPT_INPAGE

    "

interstitialTagFormats[]

enum (InterstitialTagFormats)

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.

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.

InpageTagFormats

Enums
STANDARD
IFRAME_JAVASCRIPT_INPAGE
INTERNAL_REDIRECT_INPAGE
JAVASCRIPT_INPAGE

InterstitialTagFormats

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.