Sites

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

Resource representations

Contains properties of a site.

{
  "kind": "dfareporting#site",
  "id": long,
  "idDimensionValue": dimensionValues Resource,
  "keyName": string,
  "name": string,
  "accountId": long,
  "subaccountId": long,
  "approved": boolean,
  "siteSettings": {
    "disableNewCookie": boolean,
    "creativeSettings": {
      "iFrameHeader": string,
      "iFrameFooter": string
    },
    "tagSetting": {
      "additionalKeyValues": string,
      "includeClickTracking": boolean,
      "includeClickThroughUrls": boolean,
      "keywordOption": string
    },
    "lookbackConfiguration": {
      "clickDuration": integer,
      "postImpressionActivitiesDuration": integer
    },
    "activeViewOptOut": boolean,
    "adBlockingOptOut": boolean,
    "videoActiveViewOptOutTemplate": boolean,
    "vpaidAdapterChoiceTemplate": string
  },
  "siteContacts": [
    {
      "id": long,
      "email": string,
      "firstName": string,
      "lastName": string,
      "title": string,
      "address": string,
      "phone": string,
      "contactType": string
    }
  ],
  "directorySiteId": long,
  "directorySiteIdDimensionValue": dimensionValues Resource
}
Property name Value Description Notes
accountId long Account ID of this site. This is a read-only field that can be left blank.
approved boolean Whether this site is approved.
directorySiteId long Directory site associated with this site. This is a required field that is read-only after insertion.
directorySiteIdDimensionValue nested object Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
id long ID of this site. This is a read-only, auto-generated field.
idDimensionValue nested object Dimension value for the ID of this site. This is a read-only, auto-generated field.
keyName string Key name of this site. This is a read-only, auto-generated field.
kind string Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
name string Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account.
siteContacts[] list Site contacts.
siteContacts[].address string Address of this site contact.
siteContacts[].contactType string Site contact type.

Acceptable values are:
  • "SALES_PERSON"
  • "TRAFFICKER"
siteContacts[].email string Email address of this site contact. This is a required field.
siteContacts[].firstName string First name of this site contact.
siteContacts[].id long ID of this site contact. This is a read-only, auto-generated field.
siteContacts[].lastName string Last name of this site contact.
siteContacts[].phone string Primary phone number of this site contact.
siteContacts[].title string Title or designation of this site contact.
siteSettings nested object Site-wide settings.
siteSettings.activeViewOptOut boolean Whether active view creatives are disabled for this site.
siteSettings.adBlockingOptOut boolean Whether this site opts out of ad blocking. When true, ad blocking is disabled for all placements under the site, regardless of the individual placement settings. When false, the campaign and placement settings take effect.
siteSettings.creativeSettings nested object Site-wide creative settings.
siteSettings.creativeSettings.iFrameFooter string Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
siteSettings.creativeSettings.iFrameHeader string Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
siteSettings.disableNewCookie boolean Whether new cookies are disabled for this site.
siteSettings.lookbackConfiguration nested object Lookback window settings for this site.
siteSettings.lookbackConfiguration.clickDuration integer Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
siteSettings.lookbackConfiguration.postImpressionActivitiesDuration integer Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
siteSettings.tagSetting nested object Configuration settings for dynamic and image floodlight tags.
siteSettings.tagSetting.additionalKeyValues string Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
siteSettings.tagSetting.includeClickThroughUrls boolean Whether static landing page URLs should be included in the tags. This setting applies only to placements.
siteSettings.tagSetting.includeClickTracking boolean Whether click-tracking string should be included in the tags.
siteSettings.tagSetting.keywordOption string Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.

Acceptable values are:
  • "GENERATE_SEPARATE_TAG_FOR_EACH_KEYWORD"
  • "IGNORE"
  • "PLACEHOLDER_WITH_LIST_OF_KEYWORDS"
siteSettings.videoActiveViewOptOutTemplate boolean Whether Verification and ActiveView for in-stream video creatives are disabled by default for new placements created under this site. This value will be used to populate the placement.videoActiveViewOptOut field, when no value is specified for the new placement.
siteSettings.vpaidAdapterChoiceTemplate string Default VPAID adapter setting for new placements created under this site. This value will be used to populate the placements.vpaidAdapterChoice field, when no value is specified for the new placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to the placement. The publisher's specifications will typically determine this setting. For VPAID creatives, the adapter format will match the VPAID format (HTML5 VPAID creatives use the HTML5 adapter).

Note: Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH.

Acceptable values are:
  • "BOTH"
  • "DEFAULT"
  • "FLASH"
  • "HTML5"
subaccountId long Subaccount ID of this site. This is a read-only field that can be left blank.

Methods

get
Gets one site by ID.
insert
Inserts a new site.
list
Retrieves a list of sites, possibly filtered. This method supports paging.
patch
Updates an existing site. This method supports patch semantics.
update
Updates an existing site.

Send feedback about...

DoubleClick Campaign Manager
DoubleClick Campaign Manager