admin

package
v0.0.0-...-b036f29 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 9, 2015 License: BSD-3-Clause Imports: 11 Imported by: 0

Documentation

Overview

Package admin provides access to the Admin Reports API.

See https://developers.google.com/admin-sdk/reports/

Usage example: 

import "google.golang.org/api/admin/reports_v1"
...
adminService, err := admin.New(oauthHttpClient)

Index

Constants

View Source 
const (
	// View audit reports of Google Apps for your domain
	AdminReportsAuditReadonlyScope = "https://www.googleapis.com/auth/admin.reports.audit.readonly"

	// View usage reports of Google Apps for your domain
	AdminReportsUsageReadonlyScope = "https://www.googleapis.com/auth/admin.reports.usage.readonly"
)

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

type Activities 

type Activities struct {
	// Etag: ETag of the resource.
	Etag string `json:"etag,omitempty"`

	// Items: Each record in read response.
	Items []*Activity `json:"items,omitempty"`

	// Kind: Kind of list response this is.
	Kind string `json:"kind,omitempty"`

	// NextPageToken: Token for retrieving the next page
	NextPageToken string `json:"nextPageToken,omitempty"`
}

type ActivitiesListCall 

type ActivitiesListCall struct {
	// contains filtered or unexported fields
}

func (*ActivitiesListCall) ActorIpAddress 

func (c *ActivitiesListCall) ActorIpAddress(actorIpAddress string) *ActivitiesListCall

ActorIpAddress sets the optional parameter "actorIpAddress": IP Address of host where the event was performed. Supports both IPv4 and IPv6 addresses.

func (*ActivitiesListCall) CustomerId 

func (c *ActivitiesListCall) CustomerId(customerId string) *ActivitiesListCall

CustomerId sets the optional parameter "customerId": Represents the customer for which the data is to be fetched.

func (*ActivitiesListCall) Do 

func (c *ActivitiesListCall) Do() (*Activities, error)

func (*ActivitiesListCall) EndTime 

func (c *ActivitiesListCall) EndTime(endTime string) *ActivitiesListCall

EndTime sets the optional parameter "endTime": Return events which occured at or before this time.

func (*ActivitiesListCall) EventName 

func (c *ActivitiesListCall) EventName(eventName string) *ActivitiesListCall

EventName sets the optional parameter "eventName": Name of the event being queried.

func (*ActivitiesListCall) Fields 

func (c *ActivitiesListCall) Fields(s ...googleapi.Field) *ActivitiesListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ActivitiesListCall) Filters 

func (c *ActivitiesListCall) Filters(filters string) *ActivitiesListCall

Filters sets the optional parameter "filters": Event parameters in the form [parameter1 name][operator][parameter1 value],[parameter2 name][operator][parameter2 value],...

func (*ActivitiesListCall) MaxResults 

func (c *ActivitiesListCall) MaxResults(maxResults int64) *ActivitiesListCall

MaxResults sets the optional parameter "maxResults": Number of activity records to be shown in each page.

func (*ActivitiesListCall) PageToken 

func (c *ActivitiesListCall) PageToken(pageToken string) *ActivitiesListCall

PageToken sets the optional parameter "pageToken": Token to specify next page.

func (*ActivitiesListCall) StartTime 

func (c *ActivitiesListCall) StartTime(startTime string) *ActivitiesListCall

StartTime sets the optional parameter "startTime": Return events which occured at or after this time.

type ActivitiesService 

type ActivitiesService struct {
	// contains filtered or unexported fields
}

func NewActivitiesService 

func NewActivitiesService(s *Service) *ActivitiesService

func (*ActivitiesService) List 

func (r *ActivitiesService) List(userKey string, applicationName string) *ActivitiesListCall

List: Retrieves a list of activities for a specific customer and application.

func (*ActivitiesService) Watch 

func (r *ActivitiesService) Watch(userKey string, applicationName string, channel *Channel) *ActivitiesWatchCall

Watch: Push changes to activities

type ActivitiesWatchCall 

type ActivitiesWatchCall struct {
	// contains filtered or unexported fields
}

func (*ActivitiesWatchCall) ActorIpAddress 

func (c *ActivitiesWatchCall) ActorIpAddress(actorIpAddress string) *ActivitiesWatchCall

ActorIpAddress sets the optional parameter "actorIpAddress": IP Address of host where the event was performed. Supports both IPv4 and IPv6 addresses.

func (*ActivitiesWatchCall) CustomerId 

func (c *ActivitiesWatchCall) CustomerId(customerId string) *ActivitiesWatchCall

CustomerId sets the optional parameter "customerId": Represents the customer for which the data is to be fetched.

func (*ActivitiesWatchCall) Do 

func (c *ActivitiesWatchCall) Do() (*Channel, error)

func (*ActivitiesWatchCall) EndTime 

func (c *ActivitiesWatchCall) EndTime(endTime string) *ActivitiesWatchCall

EndTime sets the optional parameter "endTime": Return events which occured at or before this time.

func (*ActivitiesWatchCall) EventName 

func (c *ActivitiesWatchCall) EventName(eventName string) *ActivitiesWatchCall

EventName sets the optional parameter "eventName": Name of the event being queried.

func (*ActivitiesWatchCall) Fields 

func (c *ActivitiesWatchCall) Fields(s ...googleapi.Field) *ActivitiesWatchCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ActivitiesWatchCall) Filters 

func (c *ActivitiesWatchCall) Filters(filters string) *ActivitiesWatchCall

Filters sets the optional parameter "filters": Event parameters in the form [parameter1 name][operator][parameter1 value],[parameter2 name][operator][parameter2 value],...

func (*ActivitiesWatchCall) MaxResults 

func (c *ActivitiesWatchCall) MaxResults(maxResults int64) *ActivitiesWatchCall

MaxResults sets the optional parameter "maxResults": Number of activity records to be shown in each page.

func (*ActivitiesWatchCall) PageToken 

func (c *ActivitiesWatchCall) PageToken(pageToken string) *ActivitiesWatchCall

PageToken sets the optional parameter "pageToken": Token to specify next page.

func (*ActivitiesWatchCall) StartTime 

func (c *ActivitiesWatchCall) StartTime(startTime string) *ActivitiesWatchCall

StartTime sets the optional parameter "startTime": Return events which occured at or after this time.

type Activity 

type Activity struct {
	// Actor: User doing the action.
	Actor *ActivityActor `json:"actor,omitempty"`

	// Etag: ETag of the entry.
	Etag string `json:"etag,omitempty"`

	// Events: Activity events.
	Events []*ActivityEvents `json:"events,omitempty"`

	// Id: Unique identifier for each activity record.
	Id *ActivityId `json:"id,omitempty"`

	// IpAddress: IP Address of the user doing the action.
	IpAddress string `json:"ipAddress,omitempty"`

	// Kind: Kind of resource this is.
	Kind string `json:"kind,omitempty"`

	// OwnerDomain: Domain of source customer.
	OwnerDomain string `json:"ownerDomain,omitempty"`
}

type ActivityActor 

type ActivityActor struct {
	// CallerType: User or OAuth 2LO request.
	CallerType string `json:"callerType,omitempty"`

	// Email: Email address of the user.
	Email string `json:"email,omitempty"`

	// Key: For OAuth 2LO API requests, consumer_key of the requestor.
	Key string `json:"key,omitempty"`

	// ProfileId: Obfuscated user id of the user.
	ProfileId string `json:"profileId,omitempty"`
}

type ActivityEvents 

type ActivityEvents struct {
	// Name: Name of event.
	Name string `json:"name,omitempty"`

	// Parameters: Parameter value pairs for various applications.
	Parameters []*ActivityEventsParameters `json:"parameters,omitempty"`

	// Type: Type of event.
	Type string `json:"type,omitempty"`
}

type ActivityEventsParameters 

type ActivityEventsParameters struct {
	// BoolValue: Boolean value of the parameter.
	BoolValue bool `json:"boolValue,omitempty"`

	// IntValue: Integral value of the parameter.
	IntValue int64 `json:"intValue,omitempty,string"`

	// MultiIntValue: Multi-int value of the parameter.
	MultiIntValue googleapi.Int64s `json:"multiIntValue,omitempty"`

	// MultiValue: Multi-string value of the parameter.
	MultiValue []string `json:"multiValue,omitempty"`

	// Name: The name of the parameter.
	Name string `json:"name,omitempty"`

	// Value: String value of the parameter.
	Value string `json:"value,omitempty"`
}

type ActivityId 

type ActivityId struct {
	// ApplicationName: Application name to which the event belongs.
	ApplicationName string `json:"applicationName,omitempty"`

	// CustomerId: Obfuscated customer ID of the source customer.
	CustomerId string `json:"customerId,omitempty"`

	// Time: Time of occurrence of the activity.
	Time string `json:"time,omitempty"`

	// UniqueQualifier: Unique qualifier if multiple events have the same
	// time.
	UniqueQualifier int64 `json:"uniqueQualifier,omitempty,string"`
}

type Channel 

type Channel struct {
	// Address: The address where notifications are delivered for this
	// channel.
	Address string `json:"address,omitempty"`

	// Expiration: Date and time of notification channel expiration,
	// expressed as a Unix timestamp, in milliseconds. Optional.
	Expiration int64 `json:"expiration,omitempty,string"`

	// Id: A UUID or similar unique string that identifies this channel.
	Id string `json:"id,omitempty"`

	// Kind: Identifies this as a notification channel used to watch for
	// changes to a resource. Value: the fixed string "api#channel".
	Kind string `json:"kind,omitempty"`

	// Params: Additional parameters controlling delivery channel behavior.
	// Optional.
	Params map[string]string `json:"params,omitempty"`

	// Payload: A Boolean value to indicate whether payload is wanted.
	// Optional.
	Payload bool `json:"payload,omitempty"`

	// ResourceId: An opaque ID that identifies the resource being watched
	// on this channel. Stable across different API versions.
	ResourceId string `json:"resourceId,omitempty"`

	// ResourceUri: A version-specific identifier for the watched resource.
	ResourceUri string `json:"resourceUri,omitempty"`

	// Token: An arbitrary string delivered to the target address with each
	// notification delivered over this channel. Optional.
	Token string `json:"token,omitempty"`

	// Type: The type of delivery mechanism used for this channel.
	Type string `json:"type,omitempty"`
}

type ChannelsService 

type ChannelsService struct {
	// contains filtered or unexported fields
}

func NewChannelsService 

func NewChannelsService(s *Service) *ChannelsService

func (*ChannelsService) Stop 

func (r *ChannelsService) Stop(channel *Channel) *ChannelsStopCall

Stop: Stop watching resources through this channel

type ChannelsStopCall 

type ChannelsStopCall struct {
	// contains filtered or unexported fields
}

func (*ChannelsStopCall) Do 

func (c *ChannelsStopCall) Do() error

func (*ChannelsStopCall) Fields 

func (c *ChannelsStopCall) Fields(s ...googleapi.Field) *ChannelsStopCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

type CustomerUsageReportsGetCall 

type CustomerUsageReportsGetCall struct {
	// contains filtered or unexported fields
}

func (*CustomerUsageReportsGetCall) CustomerId 

func (c *CustomerUsageReportsGetCall) CustomerId(customerId string) *CustomerUsageReportsGetCall

CustomerId sets the optional parameter "customerId": Represents the customer for which the data is to be fetched.

func (*CustomerUsageReportsGetCall) Do 

func (c *CustomerUsageReportsGetCall) Do() (*UsageReports, error)

func (*CustomerUsageReportsGetCall) Fields 

func (c *CustomerUsageReportsGetCall) Fields(s ...googleapi.Field) *CustomerUsageReportsGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*CustomerUsageReportsGetCall) PageToken 

func (c *CustomerUsageReportsGetCall) PageToken(pageToken string) *CustomerUsageReportsGetCall

PageToken sets the optional parameter "pageToken": Token to specify next page.

func (*CustomerUsageReportsGetCall) Parameters 

func (c *CustomerUsageReportsGetCall) Parameters(parameters string) *CustomerUsageReportsGetCall

Parameters sets the optional parameter "parameters": Represents the application name, parameter name pairs to fetch in csv as app_name1:param_name1, app_name2:param_name2.

type CustomerUsageReportsService 

type CustomerUsageReportsService struct {
	// contains filtered or unexported fields
}

func NewCustomerUsageReportsService 

func NewCustomerUsageReportsService(s *Service) *CustomerUsageReportsService

func (*CustomerUsageReportsService) Get 

func (r *CustomerUsageReportsService) Get(date string) *CustomerUsageReportsGetCall

Get: Retrieves a report which is a collection of properties / statistics for a specific customer.

type Service 

type Service struct {
	BasePath  string // API endpoint base URL
	UserAgent string // optional additional User-Agent fragment

	Activities *ActivitiesService

	Channels *ChannelsService

	CustomerUsageReports *CustomerUsageReportsService

	UserUsageReport *UserUsageReportService
	// contains filtered or unexported fields
}

func New 

func New(client *http.Client) (*Service, error)

type UsageReport 

type UsageReport struct {
	// Date: The date to which the record belongs.
	Date string `json:"date,omitempty"`

	// Entity: Information about the type of the item.
	Entity *UsageReportEntity `json:"entity,omitempty"`

	// Etag: ETag of the resource.
	Etag string `json:"etag,omitempty"`

	// Kind: The kind of object.
	Kind string `json:"kind,omitempty"`

	// Parameters: Parameter value pairs for various applications.
	Parameters []*UsageReportParameters `json:"parameters,omitempty"`
}

type UsageReportEntity 

type UsageReportEntity struct {
	// CustomerId: Obfuscated customer id for the record.
	CustomerId string `json:"customerId,omitempty"`

	// ProfileId: Obfuscated user id for the record.
	ProfileId string `json:"profileId,omitempty"`

	// Type: The type of item, can be a customer or user.
	Type string `json:"type,omitempty"`

	// UserEmail: user's email.
	UserEmail string `json:"userEmail,omitempty"`
}

type UsageReportParameters 

type UsageReportParameters struct {
	// BoolValue: Boolean value of the parameter.
	BoolValue bool `json:"boolValue,omitempty"`

	// DatetimeValue: RFC 3339 formatted value of the parameter.
	DatetimeValue string `json:"datetimeValue,omitempty"`

	// IntValue: Integral value of the parameter.
	IntValue int64 `json:"intValue,omitempty,string"`

	// MsgValue: Nested message value of the parameter.
	MsgValue []UsageReportParametersMsgValue `json:"msgValue,omitempty"`

	// Name: The name of the parameter.
	Name string `json:"name,omitempty"`

	// StringValue: String value of the parameter.
	StringValue string `json:"stringValue,omitempty"`
}

type UsageReportParametersMsgValue 

type UsageReportParametersMsgValue interface{}

type UsageReports 

type UsageReports struct {
	// Etag: ETag of the resource.
	Etag string `json:"etag,omitempty"`

	// Kind: The kind of object.
	Kind string `json:"kind,omitempty"`

	// NextPageToken: Token for retrieving the next page
	NextPageToken string `json:"nextPageToken,omitempty"`

	// UsageReports: Various application parameter records.
	UsageReports []*UsageReport `json:"usageReports,omitempty"`

	// Warnings: Warnings if any.
	Warnings []*UsageReportsWarnings `json:"warnings,omitempty"`
}

type UsageReportsWarnings 

type UsageReportsWarnings struct {
	// Code: Machine readable code / warning type.
	Code string `json:"code,omitempty"`

	// Data: Key-Value pairs to give detailed information on the warning.
	Data []*UsageReportsWarningsData `json:"data,omitempty"`

	// Message: Human readable message for the warning.
	Message string `json:"message,omitempty"`
}

type UsageReportsWarningsData 

type UsageReportsWarningsData struct {
	// Key: Key associated with a key-value pair to give detailed
	// information on the warning.
	Key string `json:"key,omitempty"`

	// Value: Value associated with a key-value pair to give detailed
	// information on the warning.
	Value string `json:"value,omitempty"`
}

type UserUsageReportGetCall 

type UserUsageReportGetCall struct {
	// contains filtered or unexported fields
}

func (*UserUsageReportGetCall) CustomerId 

func (c *UserUsageReportGetCall) CustomerId(customerId string) *UserUsageReportGetCall

CustomerId sets the optional parameter "customerId": Represents the customer for which the data is to be fetched.

func (*UserUsageReportGetCall) Do 

func (c *UserUsageReportGetCall) Do() (*UsageReports, error)

func (*UserUsageReportGetCall) Fields 

func (c *UserUsageReportGetCall) Fields(s ...googleapi.Field) *UserUsageReportGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*UserUsageReportGetCall) Filters 

func (c *UserUsageReportGetCall) Filters(filters string) *UserUsageReportGetCall

Filters sets the optional parameter "filters": Represents the set of filters including parameter operator value.

func (*UserUsageReportGetCall) MaxResults 

func (c *UserUsageReportGetCall) MaxResults(maxResults int64) *UserUsageReportGetCall

MaxResults sets the optional parameter "maxResults": Maximum number of results to return. Maximum allowed is 1000

func (*UserUsageReportGetCall) PageToken 

func (c *UserUsageReportGetCall) PageToken(pageToken string) *UserUsageReportGetCall

PageToken sets the optional parameter "pageToken": Token to specify next page.

func (*UserUsageReportGetCall) Parameters 

func (c *UserUsageReportGetCall) Parameters(parameters string) *UserUsageReportGetCall

Parameters sets the optional parameter "parameters": Represents the application name, parameter name pairs to fetch in csv as app_name1:param_name1, app_name2:param_name2.

type UserUsageReportService 

type UserUsageReportService struct {
	// contains filtered or unexported fields
}

func NewUserUsageReportService 

func NewUserUsageReportService(s *Service) *UserUsageReportService

func (*UserUsageReportService) Get 

func (r *UserUsageReportService) Get(userKey string, date string) *UserUsageReportGetCall

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.