gogol-dfareporting-0.3.0: Google DCM/DFA Reporting And Trafficking SDK.

Copyright(c) 2015-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.Google.Resource.DFAReporting.EventTags.List

Contents

Description

Retrieves a list of event tags, possibly filtered.

See: DCM/DFA Reporting And Trafficking API Reference for dfareporting.eventTags.list.

Synopsis

REST Resource

type EventTagsListResource = "dfareporting" :> ("v2.7" :> ("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

eventTagsList Source #

Arguments

:: Int64

etlProFileId

-> 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.

Instances

Eq EventTagsList Source # 
Data EventTagsList Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> EventTagsList -> c EventTagsList #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c EventTagsList #

toConstr :: EventTagsList -> Constr #

dataTypeOf :: EventTagsList -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c EventTagsList) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c EventTagsList) #

gmapT :: (forall b. Data b => b -> b) -> EventTagsList -> EventTagsList #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> EventTagsList -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> EventTagsList -> r #

gmapQ :: (forall d. Data d => d -> u) -> EventTagsList -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> EventTagsList -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> EventTagsList -> m EventTagsList #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> EventTagsList -> m EventTagsList #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> EventTagsList -> m EventTagsList #

Show EventTagsList Source # 
Generic EventTagsList Source # 

Associated Types

type Rep EventTagsList :: * -> * #

Methods

from :: EventTagsList -> Rep EventTagsList x #

to :: Rep EventTagsList x -> EventTagsList #

GoogleRequest EventTagsList Source # 

Associated Types

type Rs EventTagsList :: * #

type Scopes EventTagsList :: [Symbol] #

Methods

requestClient :: EventTagsList -> Client (Rs EventTagsList) #

type Rep EventTagsList Source # 
type Rep EventTagsList = D1 (MetaData "EventTagsList" "Network.Google.Resource.DFAReporting.EventTags.List" "gogol-dfareporting-0.3.0-1Sz7MzcQaqT30NKUHnKpNh" False) (C1 (MetaCons "EventTagsList'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_etlDefinitionsOnly") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_etlEventTagTypes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [EventTagsListEventTagTypes])))) ((:*:) (S1 (MetaSel (Just Symbol "_etlEnabled") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) ((:*:) (S1 (MetaSel (Just Symbol "_etlAdvertiserId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int64)))) (S1 (MetaSel (Just Symbol "_etlSearchString") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_etlCampaignId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int64)))) ((:*:) (S1 (MetaSel (Just Symbol "_etlIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64]))) (S1 (MetaSel (Just Symbol "_etlProFileId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Int64))))) ((:*:) (S1 (MetaSel (Just Symbol "_etlSortOrder") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe EventTagsListSortOrder))) ((:*:) (S1 (MetaSel (Just Symbol "_etlAdId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int64)))) (S1 (MetaSel (Just Symbol "_etlSortField") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe EventTagsListSortField))))))))
type Scopes EventTagsList Source # 
type Scopes EventTagsList = (:) Symbol "https://www.googleapis.com/auth/dfatrafficking" ([] Symbol)
type Rs EventTagsList Source # 

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.

etlAdId :: Lens' EventTagsList (Maybe Int64) Source #

Select only event tags that belong to this ad.

etlSortField :: Lens' EventTagsList (Maybe EventTagsListSortField) Source #

Field by which to sort the list.