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: sites

Resource: Site

Contains properties of a site.

JSON representation
{
  "id": string,
  "keyName": string,
  "name": string,
  "accountId": string,
  "subaccountId": string,
  "approved": boolean,
  "siteSettings": {
    object (SiteSettings)
  },
  "siteContacts": [
    {
      object (SiteContact)
    }
  ],
  "directorySiteId": string,
  "idDimensionValue": {
    object (DimensionValue)
  },
  "directorySiteIdDimensionValue": {
    object (DimensionValue)
  },
  "kind": string,
  "videoSettings": {
    object (SiteVideoSettings)
  }
}
Fields
id

string (int64 format)

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.

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.

accountId

string (int64 format)

Account ID of this site. This is a read-only field that can be left blank.

subaccountId

string (int64 format)

Subaccount ID of this site. This is a read-only field that can be left blank.

approved

boolean

Whether this site is approved.

siteSettings

object (SiteSettings)

Site-wide settings.

siteContacts[]

object (SiteContact)

Site contacts.

directorySiteId

string (int64 format)

Directory site associated with this site. This is a required field that is read-only after insertion.

idDimensionValue

object (DimensionValue)

Dimension value for the ID of this site. This is a read-only, auto-generated field.

directorySiteIdDimensionValue

object (DimensionValue)

Dimension value for the ID of the directory site. This is a read-only, auto-generated field.

kind

string

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

"dfareporting#site"

.

videoSettings

object (SiteVideoSettings)

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.

SiteSettings

Site Settings

JSON representation
{
  "disableNewCookie": boolean,
  "tagSetting": {
    object (TagSetting)
  },
  "activeViewOptOut": boolean,
  "adBlockingOptOut": boolean,
  "videoActiveViewOptOutTemplate": boolean,
  "vpaidAdapterChoiceTemplate": enum (VpaidAdapterChoiceTemplate)
}
Fields
tagSetting

object (TagSetting)

Configuration settings for dynamic and image floodlight tags.

activeViewOptOut

boolean

Whether active view creatives are disabled for this site.

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.

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.

vpaidAdapterChoiceTemplate

enum (VpaidAdapterChoiceTemplate)

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

.

VpaidAdapterChoiceTemplate

Enums
DEFAULT
FLASH
HTML5
BOTH

SiteContact

Site Contact

JSON representation
{
  "id": string,
  "contactType": enum (ContactType),
  "email": string,
  "firstName": string,
  "lastName": string,
  "title": string,
  "address": string,
  "phone": string
}
Fields
id

string (int64 format)

ID of this site contact. This is a read-only, auto-generated field.

contactType

enum (ContactType)

Site contact type.

email

string

Email address of this site contact. This is a required field.

firstName

string

First name of this site contact.

lastName

string

Last name of this site contact.

title

string

Title or designation of this site contact.

address

string

Address of this site contact.

phone

string

Primary phone number of this site contact.

ContactType

Enums
SALES_PERSON
TRAFFICKER

SiteVideoSettings

Video Settings

JSON representation
{
  "companionSettings": {
    object (SiteCompanionSetting)
  },
  "transcodeSettings": {
    object (SiteTranscodeSetting)
  },
  "skippableSettings": {
    object (SiteSkippableSetting)
  },
  "orientation": enum (Orientation),
  "kind": string,
  "obaSettings": {
    object (ObaIcon)
  },
  "obaEnabled": boolean
}
Fields
companionSettings

object (SiteCompanionSetting)

Settings for the companion creatives of video creatives served to this site.

transcodeSettings

object (SiteTranscodeSetting)

Settings for the transcodes of video creatives served to this site. This will act as default for new placements created under this site.

skippableSettings

object (SiteSkippableSetting)

Settings for the skippability of video creatives served to this site. This will act as default for new placements created under this site.

orientation

enum (Orientation)

Orientation of a site template used for video. This will act as default for new placements created under this site.

kind

string

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

"dfareporting#siteVideoSettings"

.

obaSettings

object (ObaIcon)

Settings for the OBA icon of video creatives served to this site. This will act as default for new placements created under this site.

obaEnabled

boolean

Whether OBA icons are enabled for this placement.

SiteCompanionSetting

Companion Settings

JSON representation
{
  "companionsDisabled": boolean,
  "enabledSizes": [
    {
      object (Size)
    }
  ],
  "imageOnly": boolean,
  "kind": string
}
Fields
companionsDisabled

boolean

Whether companions are disabled for this site template.

enabledSizes[]

object (Size)

Allowlist of companion sizes to be served via this site template. Set this list to null or empty to serve all companion sizes.

imageOnly

boolean

Whether to serve only static images as companions.

kind

string

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

"dfareporting#siteCompanionSetting"

.

SiteTranscodeSetting

Transcode Settings

JSON representation
{
  "enabledVideoFormats": [
    integer
  ],
  "kind": string
}
Fields
enabledVideoFormats[]

integer

Allowlist of video formats to be served to this site template. Set this list to null or empty to serve all video formats.

kind

string

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

"dfareporting#siteTranscodeSetting"

.

SiteSkippableSetting

Skippable Settings

JSON representation
{
  "skippable": boolean,
  "skipOffset": {
    object (VideoOffset)
  },
  "progressOffset": {
    object (VideoOffset)
  },
  "kind": string
}
Fields
skippable

boolean

Whether the user can skip creatives served to this site. This will act as default for new placements created under this site.

skipOffset

object (VideoOffset)

Amount of time to play videos served to this site before the skip button should appear. Applicable when

skippable

is true.

progressOffset

object (VideoOffset)

Amount of time to play videos served to this site template before counting a view. Applicable when

skippable

is true.

kind

string

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

"dfareporting#siteSkippableSetting"

.

Orientation

Enums
ANY
LANDSCAPE
PORTRAIT

Methods

get

Gets one site by ID.

insert

Inserts a new site.

list

Retrieves a list of sites, possibly filtered.

patch

Updates an existing site.

update

Updates an existing site.