List

Retrieves a list of sites, possibly filtered

16 variables
58 variables

Retrieves a list of sites, possibly filtered. This method supports paging

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 16 input parameters

  = Parameter name
  = Format

profileId INTEGER Required

User profile ID associated with this request

acceptsInStreamVideoPlacements BOOLEAN

This search filter is no longer supported and will have no effect on the results returned

acceptsInterstitialPlacements BOOLEAN

This search filter is no longer supported and will have no effect on the results returned

acceptsPublisherPaidPlacements BOOLEAN

Select only sites that accept publisher paid placements

adWordsSite BOOLEAN

Select only AdWords sites

approved BOOLEAN

Select only approved sites

campaignIds INTEGER

Select only sites with these campaign IDs

directorySiteIds INTEGER

Select only sites with these directory site IDs

ids INTEGER

Select only sites with these IDs

maxResults INTEGER

Maximum number of results to return

pageToken STRING

Value of the nextPageToken from the previous result page

searchString STRING

Allows searching for objects by name, ID or keyName. Wildcards () are allowed. For example, "site2015" will return objects with names like "site June 2015", "site April 2015", or simply "site 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "site" will match objects with name "my site", "site 2015", or simply "site"

sortField ENUMERATION

Field by which to sort the list

sortOrder ENUMERATION

Order of sorted results

subaccountId INTEGER

Select only sites with this subaccount ID

unmappedSite BOOLEAN

Select only sites that have not been mapped to a directory site

Output

This building block provides 58 output parameters

  = Parameter name
  = Format

kind STRING

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

nextPageToken STRING

Pagination token to be used for the next list operation

sites[] OBJECT

Contains properties of a site

sites[].accountId INTEGER

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

sites[].approved BOOLEAN

Whether this site is approved

sites[].directorySiteId INTEGER

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

sites[].directorySiteIdDimensionValue OBJECT

Represents a DimensionValue resource

sites[].directorySiteIdDimensionValue.dimensionName STRING

The name of the dimension

sites[].directorySiteIdDimensionValue.etag STRING

The eTag of this response for caching purposes

sites[].directorySiteIdDimensionValue.id STRING

The ID associated with the value if available

sites[].directorySiteIdDimensionValue.kind STRING

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

sites[].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

sites[].directorySiteIdDimensionValue.value STRING

The value of the dimension

sites[].id INTEGER

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

sites[].idDimensionValue OBJECT

Represents a DimensionValue resource

sites[].idDimensionValue.dimensionName STRING

The name of the dimension

sites[].idDimensionValue.etag STRING

The eTag of this response for caching purposes

sites[].idDimensionValue.id STRING

The ID associated with the value if available

sites[].idDimensionValue.kind STRING

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

sites[].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

sites[].idDimensionValue.value STRING

The value of the dimension

sites[].keyName STRING

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

sites[].kind STRING

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

sites[].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

sites[].siteContacts[] OBJECT

Site Contact

sites[].siteContacts[].address STRING

Address of this site contact

sites[].siteContacts[].contactType ENUMERATION

Site contact type

sites[].siteContacts[].email STRING

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

sites[].siteContacts[].firstName STRING

First name of this site contact

sites[].siteContacts[].id INTEGER

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

sites[].siteContacts[].lastName STRING

Last name of this site contact

sites[].siteContacts[].phone STRING

Primary phone number of this site contact

sites[].siteContacts[].title STRING

Title or designation of this site contact

sites[].siteSettings OBJECT

Site Settings

sites[].siteSettings.activeViewOptOut BOOLEAN

Whether active view creatives are disabled for this site

sites[].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

sites[].siteSettings.disableNewCookie BOOLEAN

Whether new cookies are disabled for this site

sites[].siteSettings.tagSetting OBJECT

Tag Settings

sites[].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

sites[].siteSettings.tagSetting.includeClickThroughUrls BOOLEAN

Whether static landing page URLs should be included in the tags. This setting applies only to placements

sites[].siteSettings.tagSetting.includeClickTracking BOOLEAN

Whether click-tracking string should be included in the tags

sites[].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

sites[].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

sites[].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

sites[].subaccountId INTEGER

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

sites[].videoSettings OBJECT

Video Settings

sites[].videoSettings.companionSettings OBJECT

Companion Settings

sites[].videoSettings.companionSettings.companionsDisabled BOOLEAN

Whether companions are disabled for this site template

sites[].videoSettings.companionSettings.imageOnly BOOLEAN

Whether to serve only static images as companions

sites[].videoSettings.companionSettings.kind STRING

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

sites[].videoSettings.kind STRING

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

sites[].videoSettings.orientation ENUMERATION

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

sites[].videoSettings.skippableSettings OBJECT

Skippable Settings

sites[].videoSettings.skippableSettings.kind STRING

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

sites[].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

sites[].videoSettings.transcodeSettings OBJECT

Transcode Settings

sites[].videoSettings.transcodeSettings.enabledVideoFormats[] INTEGER

sites[].videoSettings.transcodeSettings.kind STRING

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