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 |
Fetches reports for the administrators of G Suite customers about the usage, collaboration, security, and risk for their users.
Synopsis
- reportsService :: ServiceConfig
- adminReportsUsageReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/admin.reports.usage.readonly"]
- adminReportsAuditReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/admin.reports.audit.readonly"]
- type ReportsAPI = ChannelsStopResource :<|> (ActivitiesListResource :<|> (ActivitiesWatchResource :<|> (CustomerUsageReportsGetResource :<|> (UserUsageReportGetResource :<|> EntityUsageReportsGetResource))))
- module Network.Google.Resource.Admin.Channels.Stop
- module Network.Google.Resource.Reports.Activities.List
- module Network.Google.Resource.Reports.Activities.Watch
- module Network.Google.Resource.Reports.CustomerUsageReports.Get
- module Network.Google.Resource.Reports.EntityUsageReports.Get
- module Network.Google.Resource.Reports.UserUsageReport.Get
- data UsageReportParametersItem
- usageReportParametersItem :: UsageReportParametersItem
- urpiDatetimeValue :: Lens' UsageReportParametersItem (Maybe UTCTime)
- urpiBoolValue :: Lens' UsageReportParametersItem (Maybe Bool)
- urpiIntValue :: Lens' UsageReportParametersItem (Maybe Int64)
- urpiStringValue :: Lens' UsageReportParametersItem (Maybe Text)
- urpiName :: Lens' UsageReportParametersItem (Maybe Text)
- urpiMsgValue :: Lens' UsageReportParametersItem [UsageReportParametersItemMsgValueItem]
- data ActivityId
- activityId :: ActivityId
- aiTime :: Lens' ActivityId (Maybe UTCTime)
- aiUniqueQualifier :: Lens' ActivityId (Maybe Int64)
- aiCustomerId :: Lens' ActivityId (Maybe Text)
- aiApplicationName :: Lens' ActivityId (Maybe Text)
- data UsageReports
- usageReports :: UsageReports
- urEtag :: Lens' UsageReports (Maybe Text)
- urNextPageToken :: Lens' UsageReports (Maybe Text)
- urUsageReports :: Lens' UsageReports [UsageReport]
- urKind :: Lens' UsageReports Text
- urWarnings :: Lens' UsageReports [UsageReportsWarningsItem]
- data UsageReportParametersItemMsgValueItem
- usageReportParametersItemMsgValueItem :: HashMap Text JSONValue -> UsageReportParametersItemMsgValueItem
- urpimviAddtional :: Lens' UsageReportParametersItemMsgValueItem (HashMap Text JSONValue)
- data Activities
- activities :: Activities
- aEtag :: Lens' Activities (Maybe Text)
- aNextPageToken :: Lens' Activities (Maybe Text)
- aKind :: Lens' Activities Text
- aItems :: Lens' Activities [Activity]
- data Channel
- channel :: Channel
- cResourceURI :: Lens' Channel (Maybe Text)
- cResourceId :: Lens' Channel (Maybe Text)
- cKind :: Lens' Channel Text
- cExpiration :: Lens' Channel (Maybe Int64)
- cToken :: Lens' Channel (Maybe Text)
- cAddress :: Lens' Channel (Maybe Text)
- cPayload :: Lens' Channel (Maybe Bool)
- cParams :: Lens' Channel (Maybe ChannelParams)
- cId :: Lens' Channel (Maybe Text)
- cType :: Lens' Channel (Maybe Text)
- data UsageReport
- usageReport :: UsageReport
- uEtag :: Lens' UsageReport (Maybe Text)
- uKind :: Lens' UsageReport Text
- uDate :: Lens' UsageReport (Maybe Text)
- uParameters :: Lens' UsageReport [UsageReportParametersItem]
- uEntity :: Lens' UsageReport (Maybe UsageReportEntity)
- data UsageReportsWarningsItemDataItem
- usageReportsWarningsItemDataItem :: UsageReportsWarningsItemDataItem
- urwidiValue :: Lens' UsageReportsWarningsItemDataItem (Maybe Text)
- urwidiKey :: Lens' UsageReportsWarningsItemDataItem (Maybe Text)
- data UsageReportsWarningsItem
- usageReportsWarningsItem :: UsageReportsWarningsItem
- urwiData :: Lens' UsageReportsWarningsItem [UsageReportsWarningsItemDataItem]
- urwiCode :: Lens' UsageReportsWarningsItem (Maybe Text)
- urwiMessage :: Lens' UsageReportsWarningsItem (Maybe Text)
- data ActivityEventsItem
- activityEventsItem :: ActivityEventsItem
- aeiName :: Lens' ActivityEventsItem (Maybe Text)
- aeiParameters :: Lens' ActivityEventsItem [ActivityEventsItemParametersItem]
- aeiType :: Lens' ActivityEventsItem (Maybe Text)
- data ChannelParams
- channelParams :: HashMap Text Text -> ChannelParams
- cpAddtional :: Lens' ChannelParams (HashMap Text Text)
- data Activity
- activity :: Activity
- actEtag :: Lens' Activity (Maybe Text)
- actIPAddress :: Lens' Activity (Maybe Text)
- actKind :: Lens' Activity Text
- actActor :: Lens' Activity (Maybe ActivityActor)
- actOwnerDomain :: Lens' Activity (Maybe Text)
- actEvents :: Lens' Activity [ActivityEventsItem]
- actId :: Lens' Activity (Maybe ActivityId)
- data UsageReportEntity
- usageReportEntity :: UsageReportEntity
- ureProFileId :: Lens' UsageReportEntity (Maybe Text)
- ureCustomerId :: Lens' UsageReportEntity (Maybe Text)
- ureUserEmail :: Lens' UsageReportEntity (Maybe Text)
- ureType :: Lens' UsageReportEntity (Maybe Text)
- ureEntityId :: Lens' UsageReportEntity (Maybe Text)
- data ActivityEventsItemParametersItem
- activityEventsItemParametersItem :: ActivityEventsItemParametersItem
- aeipiBoolValue :: Lens' ActivityEventsItemParametersItem (Maybe Bool)
- aeipiIntValue :: Lens' ActivityEventsItemParametersItem (Maybe Int64)
- aeipiValue :: Lens' ActivityEventsItemParametersItem (Maybe Text)
- aeipiMultiIntValue :: Lens' ActivityEventsItemParametersItem [Int64]
- aeipiName :: Lens' ActivityEventsItemParametersItem (Maybe Text)
- aeipiMultiValue :: Lens' ActivityEventsItemParametersItem [Text]
- data ActivityActor
- activityActor :: ActivityActor
- aaEmail :: Lens' ActivityActor (Maybe Text)
- aaCallerType :: Lens' ActivityActor (Maybe Text)
- aaProFileId :: Lens' ActivityActor (Maybe Text)
- aaKey :: Lens' ActivityActor (Maybe Text)
Service Configuration
reportsService :: ServiceConfig Source #
Default request referring to version reports_v1
of the Admin Reports API. This contains the host and root path used as a starting point for constructing service requests.
OAuth Scopes
adminReportsUsageReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/admin.reports.usage.readonly"] Source #
View usage reports for your G Suite domain
adminReportsAuditReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/admin.reports.audit.readonly"] Source #
View audit reports for your G Suite domain
API Declaration
type ReportsAPI = ChannelsStopResource :<|> (ActivitiesListResource :<|> (ActivitiesWatchResource :<|> (CustomerUsageReportsGetResource :<|> (UserUsageReportGetResource :<|> EntityUsageReportsGetResource)))) Source #
Represents the entirety of the methods and resources available for the Admin Reports API service.
Resources
admin.channels.stop
reports.activities.list
reports.activities.watch
reports.customerUsageReports.get
reports.entityUsageReports.get
reports.userUsageReport.get
Types
UsageReportParametersItem
data UsageReportParametersItem Source #
Instances
usageReportParametersItem :: UsageReportParametersItem Source #
Creates a value of UsageReportParametersItem
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
urpiDatetimeValue :: Lens' UsageReportParametersItem (Maybe UTCTime) Source #
RFC 3339 formatted value of the parameter.
urpiBoolValue :: Lens' UsageReportParametersItem (Maybe Bool) Source #
Boolean value of the parameter.
urpiIntValue :: Lens' UsageReportParametersItem (Maybe Int64) Source #
Integral value of the parameter.
urpiStringValue :: Lens' UsageReportParametersItem (Maybe Text) Source #
String value of the parameter.
urpiMsgValue :: Lens' UsageReportParametersItem [UsageReportParametersItemMsgValueItem] Source #
Nested message value of the parameter.
ActivityId
data ActivityId Source #
Unique identifier for each activity record.
See: activityId
smart constructor.
Instances
activityId :: ActivityId Source #
Creates a value of ActivityId
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
aiUniqueQualifier :: Lens' ActivityId (Maybe Int64) Source #
Unique qualifier if multiple events have the same time.
aiCustomerId :: Lens' ActivityId (Maybe Text) Source #
Obfuscated customer ID of the source customer.
aiApplicationName :: Lens' ActivityId (Maybe Text) Source #
Application name to which the event belongs.
UsageReports
data UsageReports Source #
JSON template for a collection of usage reports.
See: usageReports
smart constructor.
Instances
usageReports :: UsageReports Source #
Creates a value of UsageReports
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
urNextPageToken :: Lens' UsageReports (Maybe Text) Source #
Token for retrieving the next page
urUsageReports :: Lens' UsageReports [UsageReport] Source #
Various application parameter records.
urWarnings :: Lens' UsageReports [UsageReportsWarningsItem] Source #
Warnings if any.
UsageReportParametersItemMsgValueItem
data UsageReportParametersItemMsgValueItem Source #
Instances
usageReportParametersItemMsgValueItem Source #
Creates a value of UsageReportParametersItemMsgValueItem
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
Activities
data Activities Source #
JSON template for a collection of activites.
See: activities
smart constructor.
Instances
activities :: Activities Source #
Creates a value of Activities
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
aNextPageToken :: Lens' Activities (Maybe Text) Source #
Token for retrieving the next page
Channel
An notification channel used to watch for resource changes.
See: channel
smart constructor.
Instances
Creates a value of Channel
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cResourceURI :: Lens' Channel (Maybe Text) Source #
A version-specific identifier for the watched resource.
cResourceId :: Lens' Channel (Maybe Text) Source #
An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
cKind :: Lens' Channel Text Source #
Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".
cExpiration :: Lens' Channel (Maybe Int64) Source #
Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
cToken :: Lens' Channel (Maybe Text) Source #
An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
cAddress :: Lens' Channel (Maybe Text) Source #
The address where notifications are delivered for this channel.
cPayload :: Lens' Channel (Maybe Bool) Source #
A Boolean value to indicate whether payload is wanted. Optional.
cParams :: Lens' Channel (Maybe ChannelParams) Source #
Additional parameters controlling delivery channel behavior. Optional.
cId :: Lens' Channel (Maybe Text) Source #
A UUID or similar unique string that identifies this channel.
UsageReport
data UsageReport Source #
JSON template for a usage report.
See: usageReport
smart constructor.
Instances
usageReport :: UsageReport Source #
Creates a value of UsageReport
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
uParameters :: Lens' UsageReport [UsageReportParametersItem] Source #
Parameter value pairs for various applications.
uEntity :: Lens' UsageReport (Maybe UsageReportEntity) Source #
Information about the type of the item.
UsageReportsWarningsItemDataItem
data UsageReportsWarningsItemDataItem Source #
Instances
usageReportsWarningsItemDataItem :: UsageReportsWarningsItemDataItem Source #
Creates a value of UsageReportsWarningsItemDataItem
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
urwidiValue :: Lens' UsageReportsWarningsItemDataItem (Maybe Text) Source #
Value associated with a key-value pair to give detailed information on the warning.
urwidiKey :: Lens' UsageReportsWarningsItemDataItem (Maybe Text) Source #
Key associated with a key-value pair to give detailed information on the warning.
UsageReportsWarningsItem
data UsageReportsWarningsItem Source #
Instances
usageReportsWarningsItem :: UsageReportsWarningsItem Source #
Creates a value of UsageReportsWarningsItem
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
urwiData :: Lens' UsageReportsWarningsItem [UsageReportsWarningsItemDataItem] Source #
Key-Value pairs to give detailed information on the warning.
urwiCode :: Lens' UsageReportsWarningsItem (Maybe Text) Source #
Machine readable code / warning type.
urwiMessage :: Lens' UsageReportsWarningsItem (Maybe Text) Source #
Human readable message for the warning.
ActivityEventsItem
data ActivityEventsItem Source #
Instances
activityEventsItem :: ActivityEventsItem Source #
Creates a value of ActivityEventsItem
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
aeiParameters :: Lens' ActivityEventsItem [ActivityEventsItemParametersItem] Source #
Parameter value pairs for various applications.
ChannelParams
data ChannelParams Source #
Additional parameters controlling delivery channel behavior. Optional.
See: channelParams
smart constructor.
Instances
Creates a value of ChannelParams
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cpAddtional :: Lens' ChannelParams (HashMap Text Text) Source #
Declares a new parameter by name.
Activity
JSON template for the activity resource.
See: activity
smart constructor.
Instances
Creates a value of Activity
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
UsageReportEntity
data UsageReportEntity Source #
Information about the type of the item.
See: usageReportEntity
smart constructor.
Instances
usageReportEntity :: UsageReportEntity Source #
Creates a value of UsageReportEntity
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ureProFileId :: Lens' UsageReportEntity (Maybe Text) Source #
Obfuscated user id for the record.
ureCustomerId :: Lens' UsageReportEntity (Maybe Text) Source #
Obfuscated customer id for the record.
ureUserEmail :: Lens' UsageReportEntity (Maybe Text) Source #
user's email. Only relevant if entity.type = "USER"
ureType :: Lens' UsageReportEntity (Maybe Text) Source #
The type of item, can be customer, user, or entity (aka. object).
ureEntityId :: Lens' UsageReportEntity (Maybe Text) Source #
Object key. Only relevant if entity.type = "OBJECT" Note: external-facing name of report is "Entities" rather than "Objects".
ActivityEventsItemParametersItem
data ActivityEventsItemParametersItem Source #
Instances
activityEventsItemParametersItem :: ActivityEventsItemParametersItem Source #
Creates a value of ActivityEventsItemParametersItem
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
aeipiBoolValue :: Lens' ActivityEventsItemParametersItem (Maybe Bool) Source #
Boolean value of the parameter.
aeipiIntValue :: Lens' ActivityEventsItemParametersItem (Maybe Int64) Source #
Integral value of the parameter.
aeipiValue :: Lens' ActivityEventsItemParametersItem (Maybe Text) Source #
String value of the parameter.
aeipiMultiIntValue :: Lens' ActivityEventsItemParametersItem [Int64] Source #
Multi-int value of the parameter.
aeipiMultiValue :: Lens' ActivityEventsItemParametersItem [Text] Source #
Multi-string value of the parameter.
ActivityActor
data ActivityActor Source #
User doing the action.
See: activityActor
smart constructor.
Instances
activityActor :: ActivityActor Source #
Creates a value of ActivityActor
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
aaCallerType :: Lens' ActivityActor (Maybe Text) Source #
User or OAuth 2LO request.
aaProFileId :: Lens' ActivityActor (Maybe Text) Source #
Obfuscated user id of the user.