gogol-dfareporting-0.4.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.DirectorySiteContacts.List

Contents

Description

Retrieves a list of directory site contacts, possibly filtered. This method supports paging.

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

Synopsis

REST Resource

type DirectorySiteContactsListResource = "dfareporting" :> ("v3.2" :> ("userprofiles" :> (Capture "profileId" (Textual Int64) :> ("directorySiteContacts" :> (QueryParam "searchString" Text :> (QueryParams "ids" (Textual Int64) :> (QueryParams "directorySiteIds" (Textual Int64) :> (QueryParam "sortOrder" DirectorySiteContactsListSortOrder :> (QueryParam "pageToken" Text :> (QueryParam "sortField" DirectorySiteContactsListSortField :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltJSON :> Get '[JSON] DirectorySiteContactsListResponse)))))))))))) Source #

A resource alias for dfareporting.directorySiteContacts.list method which the DirectorySiteContactsList request conforms to.

Creating a Request

directorySiteContactsList Source #

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

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

data DirectorySiteContactsList Source #

Retrieves a list of directory site contacts, possibly filtered. This method supports paging.

See: directorySiteContactsList smart constructor.

Instances
Eq DirectorySiteContactsList Source # 
Instance details

Defined in Network.Google.Resource.DFAReporting.DirectorySiteContacts.List

Data DirectorySiteContactsList Source # 
Instance details

Defined in Network.Google.Resource.DFAReporting.DirectorySiteContacts.List

Methods

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

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

toConstr :: DirectorySiteContactsList -> Constr #

dataTypeOf :: DirectorySiteContactsList -> DataType #

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

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

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

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

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

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

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

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

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

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

Show DirectorySiteContactsList Source # 
Instance details

Defined in Network.Google.Resource.DFAReporting.DirectorySiteContacts.List

Generic DirectorySiteContactsList Source # 
Instance details

Defined in Network.Google.Resource.DFAReporting.DirectorySiteContacts.List

Associated Types

type Rep DirectorySiteContactsList :: Type -> Type #

GoogleRequest DirectorySiteContactsList Source # 
Instance details

Defined in Network.Google.Resource.DFAReporting.DirectorySiteContacts.List

type Rep DirectorySiteContactsList Source # 
Instance details

Defined in Network.Google.Resource.DFAReporting.DirectorySiteContacts.List

type Rep DirectorySiteContactsList = D1 (MetaData "DirectorySiteContactsList" "Network.Google.Resource.DFAReporting.DirectorySiteContacts.List" "gogol-dfareporting-0.4.0-9N9I1R95b3Y5YmOKldvlKw" False) (C1 (MetaCons "DirectorySiteContactsList'" PrefixI True) (((S1 (MetaSel (Just "_dsclSearchString") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_dsclIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64]))) :*: (S1 (MetaSel (Just "_dsclProFileId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Int64)) :*: S1 (MetaSel (Just "_dsclDirectorySiteIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64])))) :*: ((S1 (MetaSel (Just "_dsclSortOrder") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 DirectorySiteContactsListSortOrder) :*: S1 (MetaSel (Just "_dsclPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_dsclSortField") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 DirectorySiteContactsListSortField) :*: S1 (MetaSel (Just "_dsclMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Int32))))))
type Scopes DirectorySiteContactsList Source # 
Instance details

Defined in Network.Google.Resource.DFAReporting.DirectorySiteContacts.List

type Scopes DirectorySiteContactsList = "https://www.googleapis.com/auth/dfatrafficking" ': ([] :: [Symbol])
type Rs DirectorySiteContactsList Source # 
Instance details

Defined in Network.Google.Resource.DFAReporting.DirectorySiteContacts.List

Request Lenses

dsclSearchString :: Lens' DirectorySiteContactsList (Maybe Text) Source #

Allows searching for objects by name, ID or email. Wildcards (*) are allowed. For example, "directory site contact*2015" will return objects with names like "directory site contact June 2015", "directory site contact April 2015", or simply "directory site contact 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 "directory site contact" will match objects with name "my directory site contact", "directory site contact 2015", or simply "directory site contact".

dsclIds :: Lens' DirectorySiteContactsList [Int64] Source #

Select only directory site contacts with these IDs.

dsclProFileId :: Lens' DirectorySiteContactsList Int64 Source #

User profile ID associated with this request.

dsclDirectorySiteIds :: Lens' DirectorySiteContactsList [Int64] Source #

Select only directory site contacts with these directory site IDs. This is a required field.

dsclPageToken :: Lens' DirectorySiteContactsList (Maybe Text) Source #

Value of the nextPageToken from the previous result page.

dsclMaxResults :: Lens' DirectorySiteContactsList Int32 Source #

Maximum number of results to return.