Network.Google.Reports.Types

Service Configuration

reportsService :: Service

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 :: OAuthScope

View usage reports of Google Apps for your domain

adminReportsAuditReadonlyScope :: OAuthScope

View audit reports of Google Apps for your domain

UsageReportParametersItem

data UsageReportParametersItem

Instances

Eq UsageReportParametersItem

Data UsageReportParametersItem

Show UsageReportParametersItem

Generic UsageReportParametersItem

ToJSON UsageReportParametersItem

FromJSON UsageReportParametersItem

type Rep UsageReportParametersItem

usageReportParametersItem :: UsageReportParametersItem

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
• urpiBoolValue
• urpiIntValue
• urpiStringValue
• urpiName
• urpiMsgValue

urpiDatetimeValue :: Lens' UsageReportParametersItem (Maybe UTCTime)

RFC 3339 formatted value of the parameter.

urpiBoolValue :: Lens' UsageReportParametersItem (Maybe Bool)

Boolean value of the parameter.

urpiIntValue :: Lens' UsageReportParametersItem (Maybe Int64)

Integral value of the parameter.

urpiStringValue :: Lens' UsageReportParametersItem (Maybe Text)

String value of the parameter.

urpiName :: Lens' UsageReportParametersItem (Maybe Text)

The name of the parameter.

urpiMsgValue :: Lens' UsageReportParametersItem [UsageReportParametersItemMsgValueItem]

Nested message value of the parameter.

ActivityId

data ActivityId

Unique identifier for each activity record.

See: activityId smart constructor.

Instances

Eq ActivityId

Data ActivityId

Show ActivityId

Generic ActivityId

ToJSON ActivityId

FromJSON ActivityId

type Rep ActivityId

activityId :: ActivityId

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:

• aiTime
• aiUniqueQualifier
• aiCustomerId
• aiApplicationName

aiTime :: Lens' ActivityId (Maybe UTCTime)

Time of occurrence of the activity.

aiUniqueQualifier :: Lens' ActivityId (Maybe Int64)

Unique qualifier if multiple events have the same time.

aiCustomerId :: Lens' ActivityId (Maybe Text)

Obfuscated customer ID of the source customer.

aiApplicationName :: Lens' ActivityId (Maybe Text)

Application name to which the event belongs.

UsageReports

data UsageReports

JSON template for a collection of usage reports.

See: usageReports smart constructor.

Instances

Eq UsageReports

Data UsageReports

Show UsageReports

Generic UsageReports

ToJSON UsageReports

FromJSON UsageReports

type Rep UsageReports

usageReports :: UsageReports

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:

• urEtag
• urNextPageToken
• urUsageReports
• urKind
• urWarnings

urEtag :: Lens' UsageReports (Maybe Text)

ETag of the resource.

urNextPageToken :: Lens' UsageReports (Maybe Text)

Token for retrieving the next page

urUsageReports :: Lens' UsageReports [UsageReport]

Various application parameter records.

urKind :: Lens' UsageReports Text

The kind of object.

urWarnings :: Lens' UsageReports [UsageReportsWarningsItem]

Warnings if any.

UsageReportParametersItemMsgValueItem

data UsageReportParametersItemMsgValueItem

Instances

Eq UsageReportParametersItemMsgValueItem

Data UsageReportParametersItemMsgValueItem

Show UsageReportParametersItemMsgValueItem

Generic UsageReportParametersItemMsgValueItem

ToJSON UsageReportParametersItemMsgValueItem

FromJSON UsageReportParametersItemMsgValueItem

type Rep UsageReportParametersItemMsgValueItem

usageReportParametersItemMsgValueItem

Arguments

:: HashMap Text JSONValue

urpimviAddtional

-> UsageReportParametersItemMsgValueItem

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:

• urpimviAddtional

urpimviAddtional :: Lens' UsageReportParametersItemMsgValueItem (HashMap Text JSONValue)

Activities

data Activities

JSON template for a collection of activites.

See: activities smart constructor.

Instances

Eq Activities

Data Activities

Show Activities

Generic Activities

ToJSON Activities

FromJSON Activities

type Rep Activities

activities :: Activities

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:

• aEtag
• aNextPageToken
• aKind
• aItems

aEtag :: Lens' Activities (Maybe Text)

ETag of the resource.

aNextPageToken :: Lens' Activities (Maybe Text)

Token for retrieving the next page

aKind :: Lens' Activities Text

Kind of list response this is.

aItems :: Lens' Activities [Activity]

Each record in read response.

Channel

data Channel

An notification channel used to watch for resource changes.

See: channel smart constructor.

Instances

Eq Channel

Data Channel

Show Channel

Generic Channel

ToJSON Channel

FromJSON Channel

type Rep Channel

channel :: Channel

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
• cResourceId
• cKind
• cExpiration
• cToken
• cAddress
• cPayload
• cParams
• cId
• cType

cResourceURI :: Lens' Channel (Maybe Text)

A version-specific identifier for the watched resource.

cResourceId :: Lens' Channel (Maybe Text)

An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.

cKind :: Lens' Channel Text

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)

Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.

cToken :: Lens' Channel (Maybe Text)

An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.

cAddress :: Lens' Channel (Maybe Text)

The address where notifications are delivered for this channel.

cPayload :: Lens' Channel (Maybe Bool)

A Boolean value to indicate whether payload is wanted. Optional.

cParams :: Lens' Channel (Maybe ChannelParams)

Additional parameters controlling delivery channel behavior. Optional.

cId :: Lens' Channel (Maybe Text)

A UUID or similar unique string that identifies this channel.

cType :: Lens' Channel (Maybe Text)

The type of delivery mechanism used for this channel.

UsageReport

data UsageReport

JSON template for a usage report.

See: usageReport smart constructor.

Instances

Eq UsageReport

Data UsageReport

Show UsageReport

Generic UsageReport

ToJSON UsageReport

FromJSON UsageReport

type Rep UsageReport

usageReport :: UsageReport

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:

• uEtag
• uKind
• uDate
• uParameters
• uEntity

uEtag :: Lens' UsageReport (Maybe Text)

ETag of the resource.

uKind :: Lens' UsageReport Text

The kind of object.

uDate :: Lens' UsageReport (Maybe Text)

The date to which the record belongs.

uParameters :: Lens' UsageReport [UsageReportParametersItem]

Parameter value pairs for various applications.

uEntity :: Lens' UsageReport (Maybe UsageReportEntity)

Information about the type of the item.

UsageReportsWarningsItemDataItem

data UsageReportsWarningsItemDataItem

Instances

Eq UsageReportsWarningsItemDataItem

Data UsageReportsWarningsItemDataItem

Show UsageReportsWarningsItemDataItem

Generic UsageReportsWarningsItemDataItem

ToJSON UsageReportsWarningsItemDataItem

FromJSON UsageReportsWarningsItemDataItem

type Rep UsageReportsWarningsItemDataItem

usageReportsWarningsItemDataItem :: UsageReportsWarningsItemDataItem

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
• urwidiKey

urwidiValue :: Lens' UsageReportsWarningsItemDataItem (Maybe Text)

Value associated with a key-value pair to give detailed information on the warning.

urwidiKey :: Lens' UsageReportsWarningsItemDataItem (Maybe Text)

Key associated with a key-value pair to give detailed information on the warning.

UsageReportsWarningsItem

data UsageReportsWarningsItem

Instances

Eq UsageReportsWarningsItem

Data UsageReportsWarningsItem

Show UsageReportsWarningsItem

Generic UsageReportsWarningsItem

ToJSON UsageReportsWarningsItem

FromJSON UsageReportsWarningsItem

type Rep UsageReportsWarningsItem

usageReportsWarningsItem :: UsageReportsWarningsItem

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
• urwiCode
• urwiMessage

urwiData :: Lens' UsageReportsWarningsItem [UsageReportsWarningsItemDataItem]

Key-Value pairs to give detailed information on the warning.

urwiCode :: Lens' UsageReportsWarningsItem (Maybe Text)

Machine readable code / warning type.

urwiMessage :: Lens' UsageReportsWarningsItem (Maybe Text)

Human readable message for the warning.

ActivityEventsItem

data ActivityEventsItem

Instances

Eq ActivityEventsItem

Data ActivityEventsItem

Show ActivityEventsItem

Generic ActivityEventsItem

ToJSON ActivityEventsItem

FromJSON ActivityEventsItem

type Rep ActivityEventsItem

activityEventsItem :: ActivityEventsItem

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:

• aeiName
• aeiParameters
• aeiType

aeiName :: Lens' ActivityEventsItem (Maybe Text)

Name of event.

aeiParameters :: Lens' ActivityEventsItem [ActivityEventsItemParametersItem]

Parameter value pairs for various applications.

aeiType :: Lens' ActivityEventsItem (Maybe Text)

Type of event.

ChannelParams

data ChannelParams

Additional parameters controlling delivery channel behavior. Optional.

See: channelParams smart constructor.

Instances

Eq ChannelParams

Data ChannelParams

Show ChannelParams

Generic ChannelParams

ToJSON ChannelParams

FromJSON ChannelParams

type Rep ChannelParams

channelParams

Arguments

:: HashMap Text Text

cpAddtional

-> ChannelParams

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

cpAddtional :: Lens' ChannelParams (HashMap Text Text)

Declares a new parameter by name.

Activity

data Activity

JSON template for the activity resource.

See: activity smart constructor.

Instances

Eq Activity

Data Activity

Show Activity

Generic Activity

ToJSON Activity

FromJSON Activity

type Rep Activity

activity :: Activity

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:

• actEtag
• actIPAddress
• actKind
• actActor
• actOwnerDomain
• actEvents
• actId

actEtag :: Lens' Activity (Maybe Text)

ETag of the entry.

actIPAddress :: Lens' Activity (Maybe Text)

IP Address of the user doing the action.

actKind :: Lens' Activity Text

Kind of resource this is.

actActor :: Lens' Activity (Maybe ActivityActor)

User doing the action.

actOwnerDomain :: Lens' Activity (Maybe Text)

Domain of source customer.

actEvents :: Lens' Activity [ActivityEventsItem]

Activity events.

actId :: Lens' Activity (Maybe ActivityId)

Unique identifier for each activity record.

UsageReportEntity

data UsageReportEntity

Information about the type of the item.

See: usageReportEntity smart constructor.

Instances

Eq UsageReportEntity

Data UsageReportEntity

Show UsageReportEntity

Generic UsageReportEntity

ToJSON UsageReportEntity

FromJSON UsageReportEntity

type Rep UsageReportEntity

usageReportEntity :: UsageReportEntity

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
• ureCustomerId
• ureUserEmail
• ureType

ureProFileId :: Lens' UsageReportEntity (Maybe Text)

Obfuscated user id for the record.

ureCustomerId :: Lens' UsageReportEntity (Maybe Text)

Obfuscated customer id for the record.

ureUserEmail :: Lens' UsageReportEntity (Maybe Text)

user's email.

ureType :: Lens' UsageReportEntity (Maybe Text)

The type of item, can be a customer or user.

ActivityEventsItemParametersItem

data ActivityEventsItemParametersItem

Instances

Eq ActivityEventsItemParametersItem

Data ActivityEventsItemParametersItem

Show ActivityEventsItemParametersItem

Generic ActivityEventsItemParametersItem

ToJSON ActivityEventsItemParametersItem

FromJSON ActivityEventsItemParametersItem

type Rep ActivityEventsItemParametersItem

activityEventsItemParametersItem :: ActivityEventsItemParametersItem

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
• aeipiIntValue
• aeipiValue
• aeipiMultiIntValue
• aeipiName
• aeipiMultiValue

aeipiBoolValue :: Lens' ActivityEventsItemParametersItem (Maybe Bool)

Boolean value of the parameter.

aeipiIntValue :: Lens' ActivityEventsItemParametersItem (Maybe Int64)

Integral value of the parameter.

aeipiValue :: Lens' ActivityEventsItemParametersItem (Maybe Text)

String value of the parameter.

aeipiMultiIntValue :: Lens' ActivityEventsItemParametersItem [Int64]

Multi-int value of the parameter.

aeipiName :: Lens' ActivityEventsItemParametersItem (Maybe Text)

The name of the parameter.

aeipiMultiValue :: Lens' ActivityEventsItemParametersItem [Text]

Multi-string value of the parameter.

ActivityActor

data ActivityActor

User doing the action.

See: activityActor smart constructor.

Instances

Eq ActivityActor

Data ActivityActor

Show ActivityActor

Generic ActivityActor

ToJSON ActivityActor

FromJSON ActivityActor

type Rep ActivityActor

activityActor :: ActivityActor

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:

• aaEmail
• aaCallerType
• aaProFileId
• aaKey

aaEmail :: Lens' ActivityActor (Maybe Text)

Email address of the user.

aaCallerType :: Lens' ActivityActor (Maybe Text)

User or OAuth 2LO request.

aaProFileId :: Lens' ActivityActor (Maybe Text)

Obfuscated user id of the user.

aaKey :: Lens' ActivityActor (Maybe Text)

For OAuth 2LO API requests, consumer_key of the requestor.