List
|
|||||
|
|
Retrieves a list of advertisers, 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 13 input parameters
Name | Format | Description |
---|---|---|
profileId Required |
INTEGER |
User profile ID associated with this request |
advertiserGroupIds |
INTEGER |
Select only advertisers with these advertiser group IDs |
floodlightConfigurationIds |
INTEGER |
Select only advertisers with these floodlight configuration IDs |
ids |
INTEGER |
Select only advertisers with these IDs |
includeAdvertisersWithoutGroupsOnly |
BOOLEAN |
Select only advertisers which do not belong to any advertiser group |
maxResults |
INTEGER |
Maximum number of results to return |
onlyParent |
BOOLEAN |
Select only advertisers which use another advertiser's floodlight configuration |
pageToken |
STRING |
Value of the nextPageToken from the previous result page |
searchString |
STRING |
Allows searching for objects by name or ID. Wildcards () are allowed. For example, "advertiser2015" will return objects with names like "advertiser June 2015", "advertiser April 2015", or simply "advertiser 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 "advertiser" will match objects with name "my advertiser", "advertiser 2015", or simply "advertiser" |
sortField |
ENUMERATION |
Field by which to sort the list |
sortOrder |
ENUMERATION |
Order of sorted results |
status |
ENUMERATION |
Select only advertisers with the specified status |
subaccountId |
INTEGER |
Select only advertisers with these subaccount IDs |
= Parameter name
= Format
profileId INTEGER Required User profile ID associated with this request |
advertiserGroupIds INTEGER Select only advertisers with these advertiser group IDs |
floodlightConfigurationIds INTEGER Select only advertisers with these floodlight configuration IDs |
ids INTEGER Select only advertisers with these IDs |
includeAdvertisersWithoutGroupsOnly BOOLEAN Select only advertisers which do not belong to any advertiser group |
maxResults INTEGER Maximum number of results to return |
onlyParent BOOLEAN Select only advertisers which use another advertiser's floodlight configuration |
pageToken STRING Value of the nextPageToken from the previous result page |
searchString STRING Allows searching for objects by name or ID. Wildcards () are allowed. For example, "advertiser2015" will return objects with names like "advertiser June 2015", "advertiser April 2015", or simply "advertiser 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 "advertiser" will match objects with name "my advertiser", "advertiser 2015", or simply "advertiser" |
sortField ENUMERATION Field by which to sort the list |
sortOrder ENUMERATION Order of sorted results |
status ENUMERATION Select only advertisers with the specified status |
subaccountId INTEGER Select only advertisers with these subaccount IDs |
Output
This building block provides 30 output parameters
Name | Format | Description |
---|---|---|
advertisers[] |
OBJECT |
Contains properties of a Campaign Manager advertiser |
advertisers[].accountId |
INTEGER |
Account ID of this advertiser.This is a read-only field that can be left blank |
advertisers[].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 |
advertisers[].clickThroughUrlSuffix |
STRING |
Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long |
advertisers[].defaultClickThroughEventTagId |
INTEGER |
ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns |
advertisers[].defaultEmail |
STRING |
Default email address used in sender field for tag emails |
advertisers[].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:
|
advertisers[].floodlightConfigurationIdDimensionValue |
OBJECT |
Represents a DimensionValue resource |
advertisers[].floodlightConfigurationIdDimensionValue.dimensionName |
STRING |
The name of the dimension |
advertisers[].floodlightConfigurationIdDimensionValue.etag |
STRING |
The eTag of this response for caching purposes |
advertisers[].floodlightConfigurationIdDimensionValue.id |
STRING |
The ID associated with the value if available |
advertisers[].floodlightConfigurationIdDimensionValue.kind |
STRING |
The kind of resource this is, in this case dfareporting#dimensionValue |
advertisers[].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 |
advertisers[].floodlightConfigurationIdDimensionValue.value |
STRING |
The value of the dimension |
advertisers[].id |
INTEGER |
ID of this advertiser. This is a read-only, auto-generated field |
advertisers[].idDimensionValue |
OBJECT |
Represents a DimensionValue resource |
advertisers[].idDimensionValue.dimensionName |
STRING |
The name of the dimension |
advertisers[].idDimensionValue.etag |
STRING |
The eTag of this response for caching purposes |
advertisers[].idDimensionValue.id |
STRING |
The ID associated with the value if available |
advertisers[].idDimensionValue.kind |
STRING |
The kind of resource this is, in this case dfareporting#dimensionValue |
advertisers[].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 |
advertisers[].idDimensionValue.value |
STRING |
The value of the dimension |
advertisers[].kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser" |
advertisers[].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 |
advertisers[].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 |
advertisers[].status |
ENUMERATION |
Status of this advertiser |
advertisers[].subaccountId |
INTEGER |
Subaccount ID of this advertiser.This is a read-only field that can be left blank |
advertisers[].suspended |
BOOLEAN |
Suspension status of this advertiser |
kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertisersListResponse" |
nextPageToken |
STRING |
Pagination token to be used for the next list operation |
= Parameter name
= Format
advertisers[] OBJECT Contains properties of a Campaign Manager advertiser |
advertisers[].accountId INTEGER Account ID of this advertiser.This is a read-only field that can be left blank |
advertisers[].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 |
advertisers[].clickThroughUrlSuffix STRING Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long |
advertisers[].defaultClickThroughEventTagId INTEGER ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns |
advertisers[].defaultEmail STRING Default email address used in sender field for tag emails |
advertisers[].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:
|
advertisers[].floodlightConfigurationIdDimensionValue OBJECT Represents a DimensionValue resource |
advertisers[].floodlightConfigurationIdDimensionValue.dimensionName STRING The name of the dimension |
advertisers[].floodlightConfigurationIdDimensionValue.etag STRING The eTag of this response for caching purposes |
advertisers[].floodlightConfigurationIdDimensionValue.id STRING The ID associated with the value if available |
advertisers[].floodlightConfigurationIdDimensionValue.kind STRING The kind of resource this is, in this case dfareporting#dimensionValue |
advertisers[].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 |
advertisers[].floodlightConfigurationIdDimensionValue.value STRING The value of the dimension |
advertisers[].id INTEGER ID of this advertiser. This is a read-only, auto-generated field |
advertisers[].idDimensionValue OBJECT Represents a DimensionValue resource |
advertisers[].idDimensionValue.dimensionName STRING The name of the dimension |
advertisers[].idDimensionValue.etag STRING The eTag of this response for caching purposes |
advertisers[].idDimensionValue.id STRING The ID associated with the value if available |
advertisers[].idDimensionValue.kind STRING The kind of resource this is, in this case dfareporting#dimensionValue |
advertisers[].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 |
advertisers[].idDimensionValue.value STRING The value of the dimension |
advertisers[].kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser" |
advertisers[].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 |
advertisers[].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 |
advertisers[].status ENUMERATION Status of this advertiser |
advertisers[].subaccountId INTEGER Subaccount ID of this advertiser.This is a read-only field that can be left blank |
advertisers[].suspended BOOLEAN Suspension status of this advertiser |
kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertisersListResponse" |
nextPageToken STRING Pagination token to be used for the next list operation |