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.Reports.UserUsageReport.Get

Contents

REST Resource
Creating a Request
Request Lenses

Description

Retrieves a report which is a collection of properties / statistics for a set of users.

See: Admin Reports API Reference for reports.userUsageReport.get.

Synopsis

type UserUsageReportGetResource = "admin" :> ("reports" :> ("v1" :> ("usage" :> ("users" :> (Capture "userKey" Text :> ("dates" :> (Capture "date" Text :> (QueryParam "filters" Text :> (QueryParam "customerId" Text :> (QueryParam "parameters" Text :> (QueryParam "pageToken" Text :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "orgUnitID" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] UsageReports))))))))))))))
userUsageReportGet :: Text -> Text -> UserUsageReportGet
data UserUsageReportGet
uurgFilters :: Lens' UserUsageReportGet (Maybe Text)
uurgCustomerId :: Lens' UserUsageReportGet (Maybe Text)
uurgDate :: Lens' UserUsageReportGet Text
uurgParameters :: Lens' UserUsageReportGet (Maybe Text)
uurgPageToken :: Lens' UserUsageReportGet (Maybe Text)
uurgUserKey :: Lens' UserUsageReportGet Text
uurgMaxResults :: Lens' UserUsageReportGet (Maybe Word32)
uurgOrgUnitId :: Lens' UserUsageReportGet Text

REST Resource

type UserUsageReportGetResource = "admin" :> ("reports" :> ("v1" :> ("usage" :> ("users" :> (Capture "userKey" Text :> ("dates" :> (Capture "date" Text :> (QueryParam "filters" Text :> (QueryParam "customerId" Text :> (QueryParam "parameters" Text :> (QueryParam "pageToken" Text :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "orgUnitID" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] UsageReports)))))))))))))) Source #

A resource alias for reports.userUsageReport.get method which the UserUsageReportGet request conforms to.

Creating a Request

userUsageReportGet Source #

Arguments

:: Text	`uurgDate`
-> Text	`uurgUserKey`
-> UserUsageReportGet

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

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

data UserUsageReportGet Source #

Retrieves a report which is a collection of properties / statistics for a set of users.

See: userUsageReportGet smart constructor.

Instances

Eq UserUsageReportGet Source #
Instance details Defined in Network.Google.Resource.Reports.UserUsageReport.Get Methods (==) :: UserUsageReportGet -> UserUsageReportGet -> Bool # (/=) :: UserUsageReportGet -> UserUsageReportGet -> Bool #
Data UserUsageReportGet Source #
Instance details Defined in Network.Google.Resource.Reports.UserUsageReport.Get Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UserUsageReportGet -> c UserUsageReportGet # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UserUsageReportGet # toConstr :: UserUsageReportGet -> Constr # dataTypeOf :: UserUsageReportGet -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c UserUsageReportGet) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UserUsageReportGet) # gmapT :: (forall b. Data b => b -> b) -> UserUsageReportGet -> UserUsageReportGet # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UserUsageReportGet -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UserUsageReportGet -> r # gmapQ :: (forall d. Data d => d -> u) -> UserUsageReportGet -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> UserUsageReportGet -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> UserUsageReportGet -> m UserUsageReportGet # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UserUsageReportGet -> m UserUsageReportGet # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UserUsageReportGet -> m UserUsageReportGet #
Show UserUsageReportGet Source #
Instance details Defined in Network.Google.Resource.Reports.UserUsageReport.Get Methods showsPrec :: Int -> UserUsageReportGet -> ShowS # show :: UserUsageReportGet -> String # showList :: [UserUsageReportGet] -> ShowS #
Generic UserUsageReportGet Source #
Instance details Defined in Network.Google.Resource.Reports.UserUsageReport.Get Associated Types type Rep UserUsageReportGet :: Type -> Type # Methods from :: UserUsageReportGet -> Rep UserUsageReportGet x # to :: Rep UserUsageReportGet x -> UserUsageReportGet #
GoogleRequest UserUsageReportGet Source #
Instance details Defined in Network.Google.Resource.Reports.UserUsageReport.Get Associated Types type Rs UserUsageReportGet :: Type # type Scopes UserUsageReportGet :: [Symbol] # Methods requestClient :: UserUsageReportGet -> GClient (Rs UserUsageReportGet) #
type Rep UserUsageReportGet Source #
Instance details Defined in Network.Google.Resource.Reports.UserUsageReport.Get type Rep UserUsageReportGet = D1 (MetaData "UserUsageReportGet" "Network.Google.Resource.Reports.UserUsageReport.Get" "gogol-admin-reports-0.4.0-rGKKrSmAty6UY4rZWvGwr" False) (C1 (MetaCons "UserUsageReportGet'" PrefixI True) (((S1 (MetaSel (Just "_uurgFilters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_uurgCustomerId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_uurgDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: S1 (MetaSel (Just "_uurgParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 (MetaSel (Just "_uurgPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_uurgUserKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) :: (S1 (MetaSel (Just "_uurgMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Word32))) :*: S1 (MetaSel (Just "_uurgOrgUnitId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))
type Scopes UserUsageReportGet Source #
Instance details Defined in Network.Google.Resource.Reports.UserUsageReport.Get type Scopes UserUsageReportGet = "https://www.googleapis.com/auth/admin.reports.usage.readonly" ': ([] :: [Symbol])
type Rs UserUsageReportGet Source #
Instance details Defined in Network.Google.Resource.Reports.UserUsageReport.Get type Rs UserUsageReportGet = UsageReports

Request Lenses

uurgFilters :: Lens' UserUsageReportGet (Maybe Text) Source #

Represents the set of filters including parameter operator value.

uurgCustomerId :: Lens' UserUsageReportGet (Maybe Text) Source #

Represents the customer for which the data is to be fetched.

uurgDate :: Lens' UserUsageReportGet Text Source #

Represents the date in yyyy-mm-dd format for which the data is to be fetched.

uurgParameters :: Lens' UserUsageReportGet (Maybe Text) Source #

Represents the application name, parameter name pairs to fetch in csv as app_name1:param_name1, app_name2:param_name2.

uurgPageToken :: Lens' UserUsageReportGet (Maybe Text) Source #

Token to specify next page.

uurgUserKey :: Lens' UserUsageReportGet Text Source #

Represents the profile id or the user email for which the data should be filtered.

uurgMaxResults :: Lens' UserUsageReportGet (Maybe Word32) Source #

Maximum number of results to return. Maximum allowed is 1000

uurgOrgUnitId :: Lens' UserUsageReportGet Text Source #

the organizational unit's ID to filter usage parameters from users belonging to a specific OU or one of its sub-OU(s).