List
|
|||||
|
|
||||
Retrieves a list of directory 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 12 input parameters
| Name | Format | Description |
|---|---|---|
profileId Required |
INTEGER |
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 directory sites that accept publisher paid placements. This field can be left blank |
active |
BOOLEAN |
Select only active directory sites. Leave blank to retrieve both active and inactive directory sites |
dfpNetworkCode |
STRING |
Select only directory sites with this Ad Manager network code |
ids |
INTEGER |
Select only directory 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 URL. Wildcards () are allowed. For example, "directory site2015" will return objects with names like "directory site June 2015", "directory site April 2015", or simply "directory 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 "directory site" will match objects with name "my directory site", "directory site 2015" or simply, "directory site" |
sortField |
ENUMERATION |
Field by which to sort the list |
sortOrder |
ENUMERATION |
Order of sorted results |
= 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 directory sites that accept publisher paid placements. This field can be left blank |
|
active BOOLEAN Select only active directory sites. Leave blank to retrieve both active and inactive directory sites |
|
dfpNetworkCode STRING Select only directory sites with this Ad Manager network code |
|
ids INTEGER Select only directory 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 URL. Wildcards () are allowed. For example, "directory site2015" will return objects with names like "directory site June 2015", "directory site April 2015", or simply "directory 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 "directory site" will match objects with name "my directory site", "directory site 2015" or simply, "directory site" |
|
sortField ENUMERATION Field by which to sort the list |
|
sortOrder ENUMERATION Order of sorted results |
Output
This building block provides 27 output parameters
| Name | Format | Description |
|---|---|---|
directorySites[] |
OBJECT |
DirectorySites contains properties of a website from the Site Directory. Sites need to be added to an account via the Sites resource before they can be assigned to a placement |
directorySites[].active |
BOOLEAN |
Whether this directory site is active |
directorySites[].id |
INTEGER |
ID of this directory site. This is a read-only, auto-generated field |
directorySites[].idDimensionValue |
OBJECT |
Represents a DimensionValue resource |
directorySites[].idDimensionValue.dimensionName |
STRING |
The name of the dimension |
directorySites[].idDimensionValue.etag |
STRING |
The eTag of this response for caching purposes |
directorySites[].idDimensionValue.id |
STRING |
The ID associated with the value if available |
directorySites[].idDimensionValue.kind |
STRING |
The kind of resource this is, in this case dfareporting#dimensionValue |
directorySites[].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 |
directorySites[].idDimensionValue.value |
STRING |
The value of the dimension |
directorySites[].inpageTagFormats[] |
ENUMERATION |
|
directorySites[].interstitialTagFormats[] |
ENUMERATION |
|
directorySites[].kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySite" |
directorySites[].name |
STRING |
Name of this directory site |
directorySites[].settings |
OBJECT |
Directory Site Settings |
directorySites[].settings.activeViewOptOut |
BOOLEAN |
Whether this directory site has disabled active view creatives |
directorySites[].settings.dfpSettings |
OBJECT |
Google Ad Manager Settings |
directorySites[].settings.dfpSettings.dfpNetworkCode |
STRING |
Ad Manager network code for this directory site |
directorySites[].settings.dfpSettings.dfpNetworkName |
STRING |
Ad Manager network name for this directory site |
directorySites[].settings.dfpSettings.programmaticPlacementAccepted |
BOOLEAN |
Whether this directory site accepts programmatic placements |
directorySites[].settings.dfpSettings.pubPaidPlacementAccepted |
BOOLEAN |
Whether this directory site accepts publisher-paid tags |
directorySites[].settings.dfpSettings.publisherPortalOnly |
BOOLEAN |
Whether this directory site is available only via Publisher Portal |
directorySites[].settings.instreamVideoPlacementAccepted |
BOOLEAN |
Whether this site accepts in-stream video ads |
directorySites[].settings.interstitialPlacementAccepted |
BOOLEAN |
Whether this site accepts interstitial ads |
directorySites[].url |
STRING |
URL of this directory site |
kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySitesListResponse" |
nextPageToken |
STRING |
Pagination token to be used for the next list operation |
= Parameter name
= Format
|
directorySites[] OBJECT DirectorySites contains properties of a website from the Site Directory. Sites need to be added to an account via the Sites resource before they can be assigned to a placement |
|
directorySites[].active BOOLEAN Whether this directory site is active |
|
directorySites[].id INTEGER ID of this directory site. This is a read-only, auto-generated field |
|
directorySites[].idDimensionValue OBJECT Represents a DimensionValue resource |
|
directorySites[].idDimensionValue.dimensionName STRING The name of the dimension |
|
directorySites[].idDimensionValue.etag STRING The eTag of this response for caching purposes |
|
directorySites[].idDimensionValue.id STRING The ID associated with the value if available |
|
directorySites[].idDimensionValue.kind STRING The kind of resource this is, in this case dfareporting#dimensionValue |
|
directorySites[].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 |
|
directorySites[].idDimensionValue.value STRING The value of the dimension |
|
directorySites[].inpageTagFormats[] ENUMERATION |
|
directorySites[].interstitialTagFormats[] ENUMERATION |
|
directorySites[].kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySite" |
|
directorySites[].name STRING Name of this directory site |
|
directorySites[].settings OBJECT Directory Site Settings |
|
directorySites[].settings.activeViewOptOut BOOLEAN Whether this directory site has disabled active view creatives |
|
directorySites[].settings.dfpSettings OBJECT Google Ad Manager Settings |
|
directorySites[].settings.dfpSettings.dfpNetworkCode STRING Ad Manager network code for this directory site |
|
directorySites[].settings.dfpSettings.dfpNetworkName STRING Ad Manager network name for this directory site |
|
directorySites[].settings.dfpSettings.programmaticPlacementAccepted BOOLEAN Whether this directory site accepts programmatic placements |
|
directorySites[].settings.dfpSettings.pubPaidPlacementAccepted BOOLEAN Whether this directory site accepts publisher-paid tags |
|
directorySites[].settings.dfpSettings.publisherPortalOnly BOOLEAN Whether this directory site is available only via Publisher Portal |
|
directorySites[].settings.instreamVideoPlacementAccepted BOOLEAN Whether this site accepts in-stream video ads |
|
directorySites[].settings.interstitialPlacementAccepted BOOLEAN Whether this site accepts interstitial ads |
|
directorySites[].url STRING URL of this directory site |
|
kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySitesListResponse" |
|
nextPageToken STRING Pagination token to be used for the next list operation |