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,
    "tagSetting": {
      "additionalKeyValues": string,
      "includeClickTracking": boolean,
      "includeClickThroughUrls": boolean,
      "keywordOption": string
    },
    "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,
  "videoSettings": {
    "kind": "dfareporting#siteVideoSettings",
    "companionSettings": {
      "kind": "dfareporting#siteCompanionSetting",
      "companionsDisabled": boolean,
      "enabledSizes": [
        sizes Resource
      ],
      "imageOnly": boolean
    },
    "transcodeSettings": {
      "kind": "dfareporting#siteTranscodeSetting",
      "enabledVideoFormats": [
        integer
      ]
    },
    "skippableSettings": {
      "kind": "dfareporting#siteSkippableSetting",
      "skippable": boolean,
      "skipOffset": {
        "offsetSeconds": integer,
        "offsetPercentage": integer
      },
      "progressOffset": {
        "offsetSeconds": integer,
        "offsetPercentage": integer
      }
    },
    "orientation": string
  }
}
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.disableNewCookie boolean Whether new cookies are disabled for this site.
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.
videoSettings nested object Default video settings for new placements created under this site. This value will be used to populate the placements.videoSettings field, when no value is specified for the new placement.
videoSettings.companionSettings nested object Settings for the companion creatives of video creatives served to this site.
videoSettings.companionSettings.companionsDisabled boolean Whether companions are disabled for this site template.
videoSettings.companionSettings.enabledSizes[] list Whitelist of companion sizes to be served via this site template. Set this list to null or empty to serve all companion sizes.
videoSettings.companionSettings.imageOnly boolean Whether to serve only static images as companions.
videoSettings.companionSettings.kind string Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteCompanionSetting".
videoSettings.kind string Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteVideoSettings".
videoSettings.orientation string Orientation of a site template used for video. This will act as default for new placements created under this site.

Acceptable values are:
  • "ANY"
  • "LANDSCAPE"
  • "PORTRAIT"
videoSettings.skippableSettings nested object Settings for the skippability of video creatives served to this site. This will act as default for new placements created under this site.
videoSettings.skippableSettings.kind string Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteSkippableSetting".
videoSettings.skippableSettings.progressOffset nested object Amount of time to play videos served to this site template before counting a view. Applicable when skippable is true.
videoSettings.skippableSettings.progressOffset.offsetPercentage integer Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
videoSettings.skippableSettings.progressOffset.offsetSeconds integer Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
videoSettings.skippableSettings.skipOffset nested object Amount of time to play videos served to this site before the skip button should appear. Applicable when skippable is true.
videoSettings.skippableSettings.skipOffset.offsetPercentage integer Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
videoSettings.skippableSettings.skipOffset.offsetSeconds integer Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
videoSettings.skippableSettings.skippable boolean Whether the user can skip creatives served to this site. This will act as default for new placements created under this site.
videoSettings.transcodeSettings nested object Settings for the transcodes of video creatives served to this site. This will act as default for new placements created under this site.
videoSettings.transcodeSettings.enabledVideoFormats[] list Whitelist of video formats to be served to this site template. Set this list to null or empty to serve all video formats.
videoSettings.transcodeSettings.kind string Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteTranscodeSetting".

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...

Campaign Manager
Campaign Manager