Get

Gets one site by ID

2 variables
67 variables

Gets one site by ID

Authorization

To use this building block you will have to grant access to at least one of the following scopes:

  • View and manage your DoubleClick Campaign Manager's (DCM) display ad campaigns

Input

This building block consumes 2 input parameters

  = Parameter name
  = Format

profileId INTEGER Required

User profile ID associated with this request

id INTEGER Required

Site ID

Output

This building block provides 67 output parameters

  = Parameter name
  = Format

accountId INTEGER

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

approved BOOLEAN

Whether this site is approved

directorySiteId INTEGER

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

directorySiteIdDimensionValue OBJECT

Represents a DimensionValue resource

directorySiteIdDimensionValue.dimensionName STRING

The name of the dimension

directorySiteIdDimensionValue.etag STRING

The eTag of this response for caching purposes

directorySiteIdDimensionValue.id STRING

The ID associated with the value if available

directorySiteIdDimensionValue.kind STRING

The kind of resource this is, in this case dfareporting#dimensionValue

directorySiteIdDimensionValue.matchType ENUMERATION

Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT

directorySiteIdDimensionValue.value STRING

The value of the dimension

id INTEGER

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

idDimensionValue OBJECT

Represents a DimensionValue resource

idDimensionValue.dimensionName STRING

The name of the dimension

idDimensionValue.etag STRING

The eTag of this response for caching purposes

idDimensionValue.id STRING

The ID associated with the value if available

idDimensionValue.kind STRING

The kind of resource this is, in this case dfareporting#dimensionValue

idDimensionValue.matchType ENUMERATION

Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT

idDimensionValue.value STRING

The value of the dimension

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[] OBJECT

Site Contact

siteContacts[].address STRING

Address of this site contact

siteContacts[].contactType ENUMERATION

Site contact type

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 INTEGER

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 OBJECT

Site 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 OBJECT

Tag Settings

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 ENUMERATION

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

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 ENUMERATION

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

subaccountId INTEGER

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

videoSettings OBJECT

Video Settings

videoSettings.companionSettings OBJECT

Companion Settings

videoSettings.companionSettings.companionsDisabled BOOLEAN

Whether companions are disabled for this site template

videoSettings.companionSettings.enabledSizes[] OBJECT

Represents the dimensions of ads, placements, creatives, or creative assets

videoSettings.companionSettings.enabledSizes[].height INTEGER

Height of this size. Acceptable values are 0 to 32767, inclusive

videoSettings.companionSettings.enabledSizes[].iab BOOLEAN

IAB standard size. This is a read-only, auto-generated field

videoSettings.companionSettings.enabledSizes[].id INTEGER

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

videoSettings.companionSettings.enabledSizes[].kind STRING

Identifies what kind of resource this is. Value: the fixed string "dfareporting#size"

videoSettings.companionSettings.enabledSizes[].width INTEGER

Width of this size. Acceptable values are 0 to 32767, inclusive

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 ENUMERATION

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

videoSettings.skippableSettings OBJECT

Skippable Settings

videoSettings.skippableSettings.kind STRING

Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteSkippableSetting"

videoSettings.skippableSettings.progressOffset OBJECT

Video Offset

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 OBJECT

Video Offset

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 OBJECT

Transcode Settings

videoSettings.transcodeSettings.enabledVideoFormats[] INTEGER

videoSettings.transcodeSettings.kind STRING

Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteTranscodeSetting"