Copyright	(c) 2015-2016 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.CreativeGroups.List

Contents

REST Resource
Creating a Request
Request Lenses

Description

Retrieves a list of creative groups, possibly filtered. This method supports paging.

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

Synopsis

type CreativeGroupsListResource = "dfareporting" :> ("v3.2" :> ("userprofiles" :> (Capture "profileId" (Textual Int64) :> ("creativeGroups" :> (QueryParam "searchString" Text :> (QueryParams "ids" (Textual Int64) :> (QueryParam "sortOrder" CreativeGroupsListSortOrder :> (QueryParam "groupNumber" (Textual Int32) :> (QueryParam "pageToken" Text :> (QueryParam "sortField" CreativeGroupsListSortField :> (QueryParams "advertiserIds" (Textual Int64) :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltJSON :> Get '[JSON] CreativeGroupsListResponse)))))))))))))
creativeGroupsList :: Int64 -> CreativeGroupsList
data CreativeGroupsList
cglSearchString :: Lens' CreativeGroupsList (Maybe Text)
cglIds :: Lens' CreativeGroupsList [Int64]
cglProFileId :: Lens' CreativeGroupsList Int64
cglSortOrder :: Lens' CreativeGroupsList CreativeGroupsListSortOrder
cglGroupNumber :: Lens' CreativeGroupsList (Maybe Int32)
cglPageToken :: Lens' CreativeGroupsList (Maybe Text)
cglSortField :: Lens' CreativeGroupsList CreativeGroupsListSortField
cglAdvertiserIds :: Lens' CreativeGroupsList [Int64]
cglMaxResults :: Lens' CreativeGroupsList Int32

REST Resource

type CreativeGroupsListResource = "dfareporting" :> ("v3.2" :> ("userprofiles" :> (Capture "profileId" (Textual Int64) :> ("creativeGroups" :> (QueryParam "searchString" Text :> (QueryParams "ids" (Textual Int64) :> (QueryParam "sortOrder" CreativeGroupsListSortOrder :> (QueryParam "groupNumber" (Textual Int32) :> (QueryParam "pageToken" Text :> (QueryParam "sortField" CreativeGroupsListSortField :> (QueryParams "advertiserIds" (Textual Int64) :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltJSON :> Get '[JSON] CreativeGroupsListResponse))))))))))))) Source #

A resource alias for dfareporting.creativeGroups.list method which the CreativeGroupsList request conforms to.

Creating a Request

creativeGroupsList Source #

Arguments

:: Int64	`cglProFileId`
-> CreativeGroupsList

Creates a value of CreativeGroupsList with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

data CreativeGroupsList Source #

Retrieves a list of creative groups, possibly filtered. This method supports paging.

See: creativeGroupsList smart constructor.

Instances

Eq CreativeGroupsList Source #
Instance details Defined in Network.Google.Resource.DFAReporting.CreativeGroups.List Methods (==) :: CreativeGroupsList -> CreativeGroupsList -> Bool # (/=) :: CreativeGroupsList -> CreativeGroupsList -> Bool #
Data CreativeGroupsList Source #
Instance details Defined in Network.Google.Resource.DFAReporting.CreativeGroups.List Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreativeGroupsList -> c CreativeGroupsList # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreativeGroupsList # toConstr :: CreativeGroupsList -> Constr # dataTypeOf :: CreativeGroupsList -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CreativeGroupsList) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreativeGroupsList) # gmapT :: (forall b. Data b => b -> b) -> CreativeGroupsList -> CreativeGroupsList # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreativeGroupsList -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreativeGroupsList -> r # gmapQ :: (forall d. Data d => d -> u) -> CreativeGroupsList -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> CreativeGroupsList -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreativeGroupsList -> m CreativeGroupsList # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreativeGroupsList -> m CreativeGroupsList # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreativeGroupsList -> m CreativeGroupsList #
Show CreativeGroupsList Source #
Instance details Defined in Network.Google.Resource.DFAReporting.CreativeGroups.List Methods showsPrec :: Int -> CreativeGroupsList -> ShowS # show :: CreativeGroupsList -> String # showList :: [CreativeGroupsList] -> ShowS #
Generic CreativeGroupsList Source #
Instance details Defined in Network.Google.Resource.DFAReporting.CreativeGroups.List Associated Types type Rep CreativeGroupsList :: Type -> Type # Methods from :: CreativeGroupsList -> Rep CreativeGroupsList x # to :: Rep CreativeGroupsList x -> CreativeGroupsList #
GoogleRequest CreativeGroupsList Source #
Instance details Defined in Network.Google.Resource.DFAReporting.CreativeGroups.List Associated Types type Rs CreativeGroupsList :: Type # type Scopes CreativeGroupsList :: [Symbol] # Methods requestClient :: CreativeGroupsList -> GClient (Rs CreativeGroupsList) #
type Rep CreativeGroupsList Source #
Instance details Defined in Network.Google.Resource.DFAReporting.CreativeGroups.List type Rep CreativeGroupsList = D1 (MetaData "CreativeGroupsList" "Network.Google.Resource.DFAReporting.CreativeGroups.List" "gogol-dfareporting-0.4.0-9N9I1R95b3Y5YmOKldvlKw" False) (C1 (MetaCons "CreativeGroupsList'" PrefixI True) (((S1 (MetaSel (Just "_cglSearchString") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_cglIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64]))) :: (S1 (MetaSel (Just "_cglProFileId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Int64)) :: S1 (MetaSel (Just "_cglSortOrder") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 CreativeGroupsListSortOrder))) :: ((S1 (MetaSel (Just "_cglGroupNumber") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32))) :: S1 (MetaSel (Just "_cglPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_cglSortField") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 CreativeGroupsListSortField) :: (S1 (MetaSel (Just "_cglAdvertiserIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64])) :: S1 (MetaSel (Just "_cglMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Int32)))))))
type Scopes CreativeGroupsList Source #
Instance details Defined in Network.Google.Resource.DFAReporting.CreativeGroups.List type Scopes CreativeGroupsList = "https://www.googleapis.com/auth/dfatrafficking" ': ([] :: [Symbol])
type Rs CreativeGroupsList Source #
Instance details Defined in Network.Google.Resource.DFAReporting.CreativeGroups.List type Rs CreativeGroupsList = CreativeGroupsListResponse

Request Lenses

cglSearchString :: Lens' CreativeGroupsList (Maybe Text) Source #

Allows searching for creative groups by name or ID. Wildcards (*) are allowed. For example, "creativegroup*2015" will return creative groups with names like "creativegroup June 2015", "creativegroup April 2015", or simply "creativegroup 2015". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of "creativegroup" will match creative groups with the name "my creativegroup", "creativegroup 2015", or simply "creativegroup".

cglIds :: Lens' CreativeGroupsList [Int64] Source #

Select only creative groups with these IDs.

cglProFileId :: Lens' CreativeGroupsList Int64 Source #

User profile ID associated with this request.

cglSortOrder :: Lens' CreativeGroupsList CreativeGroupsListSortOrder Source #

Order of sorted results.

cglGroupNumber :: Lens' CreativeGroupsList (Maybe Int32) Source #

Select only creative groups that belong to this subgroup.

cglPageToken :: Lens' CreativeGroupsList (Maybe Text) Source #

Value of the nextPageToken from the previous result page.

cglSortField :: Lens' CreativeGroupsList CreativeGroupsListSortField Source #

Field by which to sort the list.

cglAdvertiserIds :: Lens' CreativeGroupsList [Int64] Source #

Select only creative groups that belong to these advertisers.

cglMaxResults :: Lens' CreativeGroupsList Int32 Source #

Maximum number of results to return.