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

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

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

Synopsis

REST Resource

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

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 (Maybe Int32) Source

Maximum number of results to return.