| Copyright | (c) 2015 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.Google.Resource.DFAReporting.EventTags.List
Description
Retrieves a list of event tags, possibly filtered.
See: DCM/DFA Reporting And Trafficking API Reference for dfareporting.eventTags.list.
- type EventTagsListResource = "dfareporting" :> ("v2.2" :> ("userprofiles" :> (Capture "profileId" (Textual Int64) :> ("eventTags" :> (QueryParam "definitionsOnly" Bool :> (QueryParams "eventTagTypes" EventTagsListEventTagTypes :> (QueryParam "enabled" Bool :> (QueryParam "advertiserId" (Textual Int64) :> (QueryParam "searchString" Text :> (QueryParam "campaignId" (Textual Int64) :> (QueryParams "ids" (Textual Int64) :> (QueryParam "sortOrder" EventTagsListSortOrder :> (QueryParam "adId" (Textual Int64) :> (QueryParam "sortField" EventTagsListSortField :> (QueryParam "alt" AltJSON :> Get `[JSON]` EventTagsListResponse)))))))))))))))
- eventTagsList :: Int64 -> EventTagsList
- data EventTagsList
- etlDefinitionsOnly :: Lens' EventTagsList (Maybe Bool)
- etlEventTagTypes :: Lens' EventTagsList [EventTagsListEventTagTypes]
- etlEnabled :: Lens' EventTagsList (Maybe Bool)
- etlAdvertiserId :: Lens' EventTagsList (Maybe Int64)
- etlSearchString :: Lens' EventTagsList (Maybe Text)
- etlCampaignId :: Lens' EventTagsList (Maybe Int64)
- etlIds :: Lens' EventTagsList [Int64]
- etlProFileId :: Lens' EventTagsList Int64
- etlSortOrder :: Lens' EventTagsList (Maybe EventTagsListSortOrder)
- etlAdId :: Lens' EventTagsList (Maybe Int64)
- etlSortField :: Lens' EventTagsList (Maybe EventTagsListSortField)
REST Resource
type EventTagsListResource = "dfareporting" :> ("v2.2" :> ("userprofiles" :> (Capture "profileId" (Textual Int64) :> ("eventTags" :> (QueryParam "definitionsOnly" Bool :> (QueryParams "eventTagTypes" EventTagsListEventTagTypes :> (QueryParam "enabled" Bool :> (QueryParam "advertiserId" (Textual Int64) :> (QueryParam "searchString" Text :> (QueryParam "campaignId" (Textual Int64) :> (QueryParams "ids" (Textual Int64) :> (QueryParam "sortOrder" EventTagsListSortOrder :> (QueryParam "adId" (Textual Int64) :> (QueryParam "sortField" EventTagsListSortField :> (QueryParam "alt" AltJSON :> Get `[JSON]` EventTagsListResponse))))))))))))))) Source
A resource alias for dfareporting.eventTags.list method which the
EventTagsList request conforms to.
Creating a Request
Arguments
| :: Int64 | |
| -> EventTagsList |
Creates a value of EventTagsList with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data EventTagsList Source
Retrieves a list of event tags, possibly filtered.
See: eventTagsList smart constructor.
Request Lenses
etlDefinitionsOnly :: Lens' EventTagsList (Maybe Bool) Source
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.
etlEventTagTypes :: Lens' EventTagsList [EventTagsListEventTagTypes] Source
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.
etlEnabled :: Lens' EventTagsList (Maybe Bool) Source
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.
etlAdvertiserId :: Lens' EventTagsList (Maybe Int64) Source
Select only event tags that belong to this advertiser.
etlSearchString :: Lens' EventTagsList (Maybe Text) Source
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".
etlCampaignId :: Lens' EventTagsList (Maybe Int64) Source
Select only event tags that belong to this campaign.
etlIds :: Lens' EventTagsList [Int64] Source
Select only event tags with these IDs.
etlProFileId :: Lens' EventTagsList Int64 Source
User profile ID associated with this request.
etlSortOrder :: Lens' EventTagsList (Maybe EventTagsListSortOrder) Source
Order of sorted results, default is ASCENDING.
etlSortField :: Lens' EventTagsList (Maybe EventTagsListSortField) Source
Field by which to sort the list.