List
|
|||||
|
|
||||
Retrieves a list of event tags, possibly filtered
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 11 input parameters
| Name | Format | Description |
|---|---|---|
profileId Required |
INTEGER |
User profile ID associated with this request |
adId |
INTEGER |
Select only event tags that belong to this ad |
advertiserId |
INTEGER |
Select only event tags that belong to this advertiser |
campaignId |
INTEGER |
Select only event tags that belong to this campaign |
definitionsOnly |
BOOLEAN |
Examine only the specified campaign or advertiser's event tags for matching selector criteria. When set to false, the parent advertiser and parent campaign of the specified ad or campaign is examined as well. In addition, when set to false, the status field is examined as well, along with the enabledByDefault field. This parameter can not be set to true when adId is specified as ads do not define their own even tags |
enabled |
BOOLEAN |
Select only enabled event tags. What is considered enabled or disabled depends on the definitionsOnly parameter. When definitionsOnly is set to true, only the specified advertiser or campaign's event tags' enabledByDefault field is examined. When definitionsOnly is set to false, the specified ad or specified campaign's parent advertiser's or parent campaign's event tags' enabledByDefault and status fields are examined as well |
eventTagTypes |
ENUMERATION |
Select only event tags with the specified event tag types. Event tag types can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking |
ids |
INTEGER |
Select only event tags with these IDs |
searchString |
STRING |
Allows searching for objects by name or ID. Wildcards () are allowed. For example, "eventtag2015" will return objects with names like "eventtag June 2015", "eventtag April 2015", or simply "eventtag 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 "eventtag" will match objects with name "my eventtag", "eventtag 2015", or simply "eventtag" |
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 |
|
adId INTEGER Select only event tags that belong to this ad |
|
advertiserId INTEGER Select only event tags that belong to this advertiser |
|
campaignId INTEGER Select only event tags that belong to this campaign |
|
definitionsOnly BOOLEAN Examine only the specified campaign or advertiser's event tags for matching selector criteria. When set to false, the parent advertiser and parent campaign of the specified ad or campaign is examined as well. In addition, when set to false, the status field is examined as well, along with the enabledByDefault field. This parameter can not be set to true when adId is specified as ads do not define their own even tags |
|
enabled BOOLEAN Select only enabled event tags. What is considered enabled or disabled depends on the definitionsOnly parameter. When definitionsOnly is set to true, only the specified advertiser or campaign's event tags' enabledByDefault field is examined. When definitionsOnly is set to false, the specified ad or specified campaign's parent advertiser's or parent campaign's event tags' enabledByDefault and status fields are examined as well |
|
eventTagTypes ENUMERATION Select only event tags with the specified event tag types. Event tag types can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking |
|
ids INTEGER Select only event tags with these IDs |
|
searchString STRING Allows searching for objects by name or ID. Wildcards () are allowed. For example, "eventtag2015" will return objects with names like "eventtag June 2015", "eventtag April 2015", or simply "eventtag 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 "eventtag" will match objects with name "my eventtag", "eventtag 2015", or simply "eventtag" |
|
sortField ENUMERATION Field by which to sort the list |
|
sortOrder ENUMERATION Order of sorted results |
Output
This building block provides 32 output parameters
| Name | Format | Description |
|---|---|---|
eventTags[] |
OBJECT |
Contains properties of an event tag |
eventTags[].accountId |
INTEGER |
Account ID of this event tag. This is a read-only field that can be left blank |
eventTags[].advertiserId |
INTEGER |
Advertiser ID of this event tag. This field or the campaignId field is required on insertion |
eventTags[].advertiserIdDimensionValue |
OBJECT |
Represents a DimensionValue resource |
eventTags[].advertiserIdDimensionValue.dimensionName |
STRING |
The name of the dimension |
eventTags[].advertiserIdDimensionValue.etag |
STRING |
The eTag of this response for caching purposes |
eventTags[].advertiserIdDimensionValue.id |
STRING |
The ID associated with the value if available |
eventTags[].advertiserIdDimensionValue.kind |
STRING |
The kind of resource this is, in this case dfareporting#dimensionValue |
eventTags[].advertiserIdDimensionValue.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 |
eventTags[].advertiserIdDimensionValue.value |
STRING |
The value of the dimension |
eventTags[].campaignId |
INTEGER |
Campaign ID of this event tag. This field or the advertiserId field is required on insertion |
eventTags[].campaignIdDimensionValue |
OBJECT |
Represents a DimensionValue resource |
eventTags[].campaignIdDimensionValue.dimensionName |
STRING |
The name of the dimension |
eventTags[].campaignIdDimensionValue.etag |
STRING |
The eTag of this response for caching purposes |
eventTags[].campaignIdDimensionValue.id |
STRING |
The ID associated with the value if available |
eventTags[].campaignIdDimensionValue.kind |
STRING |
The kind of resource this is, in this case dfareporting#dimensionValue |
eventTags[].campaignIdDimensionValue.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 |
eventTags[].campaignIdDimensionValue.value |
STRING |
The value of the dimension |
eventTags[].enabledByDefault |
BOOLEAN |
Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads |
eventTags[].excludeFromAdxRequests |
BOOLEAN |
Whether to remove this event tag from ads that are trafficked through Display & Video 360 to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network |
eventTags[].id |
INTEGER |
ID of this event tag. This is a read-only, auto-generated field |
eventTags[].kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag" |
eventTags[].name |
STRING |
Name of this event tag. This is a required field and must be less than 256 characters long |
eventTags[].siteFilterType |
ENUMERATION |
Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites |
eventTags[].siteIds[] |
INTEGER |
|
eventTags[].sslCompliant |
BOOLEAN |
Whether this tag is SSL-compliant or not. This is a read-only field |
eventTags[].status |
ENUMERATION |
Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field |
eventTags[].subaccountId |
INTEGER |
Subaccount ID of this event tag. This is a read-only field that can be left blank |
eventTags[].type |
ENUMERATION |
Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field |
eventTags[].url |
STRING |
Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion |
eventTags[].urlEscapeLevels |
INTEGER |
Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type |
kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTagsListResponse" |
= Parameter name
= Format
|
eventTags[] OBJECT Contains properties of an event tag |
|
eventTags[].accountId INTEGER Account ID of this event tag. This is a read-only field that can be left blank |
|
eventTags[].advertiserId INTEGER Advertiser ID of this event tag. This field or the campaignId field is required on insertion |
|
eventTags[].advertiserIdDimensionValue OBJECT Represents a DimensionValue resource |
|
eventTags[].advertiserIdDimensionValue.dimensionName STRING The name of the dimension |
|
eventTags[].advertiserIdDimensionValue.etag STRING The eTag of this response for caching purposes |
|
eventTags[].advertiserIdDimensionValue.id STRING The ID associated with the value if available |
|
eventTags[].advertiserIdDimensionValue.kind STRING The kind of resource this is, in this case dfareporting#dimensionValue |
|
eventTags[].advertiserIdDimensionValue.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 |
|
eventTags[].advertiserIdDimensionValue.value STRING The value of the dimension |
|
eventTags[].campaignId INTEGER Campaign ID of this event tag. This field or the advertiserId field is required on insertion |
|
eventTags[].campaignIdDimensionValue OBJECT Represents a DimensionValue resource |
|
eventTags[].campaignIdDimensionValue.dimensionName STRING The name of the dimension |
|
eventTags[].campaignIdDimensionValue.etag STRING The eTag of this response for caching purposes |
|
eventTags[].campaignIdDimensionValue.id STRING The ID associated with the value if available |
|
eventTags[].campaignIdDimensionValue.kind STRING The kind of resource this is, in this case dfareporting#dimensionValue |
|
eventTags[].campaignIdDimensionValue.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 |
|
eventTags[].campaignIdDimensionValue.value STRING The value of the dimension |
|
eventTags[].enabledByDefault BOOLEAN Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads |
|
eventTags[].excludeFromAdxRequests BOOLEAN Whether to remove this event tag from ads that are trafficked through Display & Video 360 to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network |
|
eventTags[].id INTEGER ID of this event tag. This is a read-only, auto-generated field |
|
eventTags[].kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag" |
|
eventTags[].name STRING Name of this event tag. This is a required field and must be less than 256 characters long |
|
eventTags[].siteFilterType ENUMERATION Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites |
|
eventTags[].siteIds[] INTEGER |
|
eventTags[].sslCompliant BOOLEAN Whether this tag is SSL-compliant or not. This is a read-only field |
|
eventTags[].status ENUMERATION Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field |
|
eventTags[].subaccountId INTEGER Subaccount ID of this event tag. This is a read-only field that can be left blank |
|
eventTags[].type ENUMERATION Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field |
|
eventTags[].url STRING Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion |
|
eventTags[].urlEscapeLevels INTEGER Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type |
|
kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTagsListResponse" |