Retrieves a list of event tags, possibly filtered.
HTTP request
GET https://dfareporting.googleapis.com/dfareporting/v3.3/userprofiles/{profileId}/eventTags
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
profileId |
User profile ID associated with this request. |
Query parameters
Parameters | |
---|---|
ids[] |
Select only event tags with these IDs. |
advertiserId |
Select only event tags that belong to this advertiser. |
campaignId |
Select only event tags that belong to this campaign. |
adId |
Select only event tags that belong to this ad. |
enabled |
Select only enabled event tags. What is considered enabled or disabled depends on the
parameter. When
is set to true, only the specified advertiser or campaign's event tags'
field is examined. When
is set to false, the specified ad or specified campaign's parent advertiser's or parent campaign's event tags'
and
fields are examined as well. |
definitionsOnly |
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
field is examined as well, along with the
field. This parameter can not be set to true when
is specified as ads do not define their own even tags. |
eventTagTypes[] |
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. |
searchString |
Allows searching for objects by name or ID. Wildcards (
) are allowed. For example,
will return objects with names like
,
, or simply
. Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of
will match objects with name
,
, or simply
. |
sortField |
Field by which to sort the list. |
sortOrder |
Order of sorted results. |
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
Event Tag accountPermissionGroups.list Response
JSON representation | |
---|---|
{
"kind": string,
"eventTags": [
{
object ( |
Fields | |
---|---|
kind |
Identifies what kind of resource this is. Value: the fixed string
. |
eventTags[] |
Event tag collection. |
Authorization Scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/dfatrafficking
EventTagTypes
Enums | |
---|---|
IMPRESSION_IMAGE_EVENT_TAG |
|
IMPRESSION_JAVASCRIPT_EVENT_TAG |
|
CLICK_THROUGH_EVENT_TAG |
SortField
Enums | |
---|---|
ID |
|
NAME |
SortOrder
Enums | |
---|---|
ASCENDING |
|
DESCENDING |