Get
|
|||||
|
|
||||
Gets one advertiser 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 |
Advertiser ID |
= Parameter name
= Format
|
profileId INTEGER Required User profile ID associated with this request |
|
id INTEGER Required Advertiser ID |
Output
This building block provides 27 output parameters
| Name | Format | Description |
|---|---|---|
accountId |
INTEGER |
Account ID of this advertiser.This is a read-only field that can be left blank |
advertiserGroupId |
INTEGER |
ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group |
clickThroughUrlSuffix |
STRING |
Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long |
defaultClickThroughEventTagId |
INTEGER |
ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns |
defaultEmail |
STRING |
Default email address used in sender field for tag emails |
floodlightConfigurationId |
INTEGER |
Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as:
|
floodlightConfigurationIdDimensionValue |
OBJECT |
Represents a DimensionValue resource |
floodlightConfigurationIdDimensionValue.dimensionName |
STRING |
The name of the dimension |
floodlightConfigurationIdDimensionValue.etag |
STRING |
The eTag of this response for caching purposes |
floodlightConfigurationIdDimensionValue.id |
STRING |
The ID associated with the value if available |
floodlightConfigurationIdDimensionValue.kind |
STRING |
The kind of resource this is, in this case dfareporting#dimensionValue |
floodlightConfigurationIdDimensionValue.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 |
floodlightConfigurationIdDimensionValue.value |
STRING |
The value of the dimension |
id |
INTEGER |
ID of this advertiser. 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 |
kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser" |
name |
STRING |
Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account |
originalFloodlightConfigurationId |
INTEGER |
Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement |
status |
ENUMERATION |
Status of this advertiser |
subaccountId |
INTEGER |
Subaccount ID of this advertiser.This is a read-only field that can be left blank |
suspended |
BOOLEAN |
Suspension status of this advertiser |
= Parameter name
= Format
|
accountId INTEGER Account ID of this advertiser.This is a read-only field that can be left blank |
|
advertiserGroupId INTEGER ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group |
|
clickThroughUrlSuffix STRING Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long |
|
defaultClickThroughEventTagId INTEGER ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns |
|
defaultEmail STRING Default email address used in sender field for tag emails |
|
floodlightConfigurationId INTEGER Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as:
|
|
floodlightConfigurationIdDimensionValue OBJECT Represents a DimensionValue resource |
|
floodlightConfigurationIdDimensionValue.dimensionName STRING The name of the dimension |
|
floodlightConfigurationIdDimensionValue.etag STRING The eTag of this response for caching purposes |
|
floodlightConfigurationIdDimensionValue.id STRING The ID associated with the value if available |
|
floodlightConfigurationIdDimensionValue.kind STRING The kind of resource this is, in this case dfareporting#dimensionValue |
|
floodlightConfigurationIdDimensionValue.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 |
|
floodlightConfigurationIdDimensionValue.value STRING The value of the dimension |
|
id INTEGER ID of this advertiser. 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 |
|
kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser" |
|
name STRING Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account |
|
originalFloodlightConfigurationId INTEGER Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement |
|
status ENUMERATION Status of this advertiser |
|
subaccountId INTEGER Subaccount ID of this advertiser.This is a read-only field that can be left blank |
|
suspended BOOLEAN Suspension status of this advertiser |