Method: eventTags.list

  • The purpose of this page is to detail how to retrieve a list of event tags, which can be optionally filtered.

  • The HTTP request uses a GET method with a specific URL structure including a user profile ID as a path parameter.

  • The request supports various query parameters to filter the results based on criteria such as IDs, advertiser or campaign association, enabled status, event tag types, and a search string.

  • The request body must be empty for this operation.

  • The successful response includes a JSON representation containing a list of event tag objects.

Retrieves a list of event tags, possibly filtered.

HTTP request

GET https://dfareporting.googleapis.com/dfareporting/v5/userprofiles/{profileId}/eventTags

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
profileId

string (int64 format)

User profile ID associated with this request.

Query parameters

Parameters
ids[]

string (int64 format)

Select only event tags with these IDs.
advertiserId

string (int64 format)

Select only event tags that belong to this advertiser.
campaignId

string (int64 format)

Select only event tags that belong to this campaign.
adId

string (int64 format)

Select only event tags that belong to this ad.
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.
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.
eventTagTypes[]

enum (EventTagType)

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

string

Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "eventtag*2015" 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

enum (SortField)

Field by which to sort the list.
sortOrder

enum (SortOrder)

Order of sorted results.

Request body

The request body must be empty.

Response body

Event Tag eventTags.list Response

If successful, the response body contains data with the following structure:

JSON representation 
{
  "kind": string,
  "eventTags": [
    {
      object (EventTag)
    }
  ]
}
Fields
kind

string

Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTagsListResponse".
eventTags[]

object (EventTag)

Event tag collection.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/dfatrafficking