Get
|
|||||
|
|
||||
Gets one directory 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
| Name | Format | Description |
|---|---|---|
profileId Required |
INTEGER |
User profile ID associated with this request |
id Required |
INTEGER |
Directory site ID |
= Parameter name
= Format
|
profileId INTEGER Required User profile ID associated with this request |
|
id INTEGER Required Directory site ID |
Output
This building block provides 24 output parameters
| Name | Format | Description |
|---|---|---|
active |
BOOLEAN |
Whether this directory site is active |
id |
INTEGER |
ID of this directory 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 |
inpageTagFormats[] |
ENUMERATION |
|
interstitialTagFormats[] |
ENUMERATION |
|
kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySite" |
name |
STRING |
Name of this directory site |
settings |
OBJECT |
Directory Site Settings |
settings.activeViewOptOut |
BOOLEAN |
Whether this directory site has disabled active view creatives |
settings.dfpSettings |
OBJECT |
Google Ad Manager Settings |
settings.dfpSettings.dfpNetworkCode |
STRING |
Ad Manager network code for this directory site |
settings.dfpSettings.dfpNetworkName |
STRING |
Ad Manager network name for this directory site |
settings.dfpSettings.programmaticPlacementAccepted |
BOOLEAN |
Whether this directory site accepts programmatic placements |
settings.dfpSettings.pubPaidPlacementAccepted |
BOOLEAN |
Whether this directory site accepts publisher-paid tags |
settings.dfpSettings.publisherPortalOnly |
BOOLEAN |
Whether this directory site is available only via Publisher Portal |
settings.instreamVideoPlacementAccepted |
BOOLEAN |
Whether this site accepts in-stream video ads |
settings.interstitialPlacementAccepted |
BOOLEAN |
Whether this site accepts interstitial ads |
url |
STRING |
URL of this directory site |
= Parameter name
= Format
|
active BOOLEAN Whether this directory site is active |
|
id INTEGER ID of this directory 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 |
|
inpageTagFormats[] ENUMERATION |
|
interstitialTagFormats[] ENUMERATION |
|
kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySite" |
|
name STRING Name of this directory site |
|
settings OBJECT Directory Site Settings |
|
settings.activeViewOptOut BOOLEAN Whether this directory site has disabled active view creatives |
|
settings.dfpSettings OBJECT Google Ad Manager Settings |
|
settings.dfpSettings.dfpNetworkCode STRING Ad Manager network code for this directory site |
|
settings.dfpSettings.dfpNetworkName STRING Ad Manager network name for this directory site |
|
settings.dfpSettings.programmaticPlacementAccepted BOOLEAN Whether this directory site accepts programmatic placements |
|
settings.dfpSettings.pubPaidPlacementAccepted BOOLEAN Whether this directory site accepts publisher-paid tags |
|
settings.dfpSettings.publisherPortalOnly BOOLEAN Whether this directory site is available only via Publisher Portal |
|
settings.instreamVideoPlacementAccepted BOOLEAN Whether this site accepts in-stream video ads |
|
settings.interstitialPlacementAccepted BOOLEAN Whether this site accepts interstitial ads |
|
url STRING URL of this directory site |