Package admin
Overview ▹
Index ▹
Constants
OAuth2 scopes used by this API.
const ( // View audit reports for your G Suite domain AdminReportsAuditReadonlyScope = "https://www.googleapis.com/auth/admin.reports.audit.readonly" // View usage reports for your G Suite domain AdminReportsUsageReadonlyScope = "https://www.googleapis.com/auth/admin.reports.usage.readonly" )
type Activities ¶
Activities: JSON template for a collection of activites.
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"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Etag") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Etag") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*Activities) MarshalJSON ¶
func (s *Activities) MarshalJSON() ([]byte, error)
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) Context ¶
func (c *ActivitiesListCall) Context(ctx context.Context) *ActivitiesListCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
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(opts ...googleapi.CallOption) (*Activities, error)
Do executes the "reports.activities.list" call. Exactly one of *Activities or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Activities.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ActivitiesListCall) EndTime ¶
func (c *ActivitiesListCall) EndTime(endTime string) *ActivitiesListCall
EndTime sets the optional parameter "endTime": Return events which occurred 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) Header ¶
func (c *ActivitiesListCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ActivitiesListCall) IfNoneMatch ¶
func (c *ActivitiesListCall) IfNoneMatch(entityTag string) *ActivitiesListCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
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) Pages ¶
func (c *ActivitiesListCall) Pages(ctx context.Context, f func(*Activities) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
func (*ActivitiesListCall) StartTime ¶
func (c *ActivitiesListCall) StartTime(startTime string) *ActivitiesListCall
StartTime sets the optional parameter "startTime": Return events which occurred 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) Context ¶
func (c *ActivitiesWatchCall) Context(ctx context.Context) *ActivitiesWatchCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
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(opts ...googleapi.CallOption) (*Channel, error)
Do executes the "reports.activities.watch" call. Exactly one of *Channel or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Channel.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ActivitiesWatchCall) EndTime ¶
func (c *ActivitiesWatchCall) EndTime(endTime string) *ActivitiesWatchCall
EndTime sets the optional parameter "endTime": Return events which occurred 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) Header ¶
func (c *ActivitiesWatchCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
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 occurred at or after this time.
type Activity ¶
Activity: JSON template for the activity resource.
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"` // ForceSendFields is a list of field names (e.g. "Actor") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Actor") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*Activity) MarshalJSON ¶
func (s *Activity) MarshalJSON() ([]byte, error)
type ActivityActor ¶
ActivityActor: User doing the action.
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"` // ForceSendFields is a list of field names (e.g. "CallerType") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "CallerType") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*ActivityActor) MarshalJSON ¶
func (s *ActivityActor) MarshalJSON() ([]byte, error)
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"` // ForceSendFields is a list of field names (e.g. "Name") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Name") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*ActivityEvents) MarshalJSON ¶
func (s *ActivityEvents) MarshalJSON() ([]byte, error)
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"` // ForceSendFields is a list of field names (e.g. "BoolValue") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "BoolValue") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*ActivityEventsParameters) MarshalJSON ¶
func (s *ActivityEventsParameters) MarshalJSON() ([]byte, error)
type ActivityId ¶
ActivityId: Unique identifier for each activity record.
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"` // ForceSendFields is a list of field names (e.g. "ApplicationName") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ApplicationName") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
func (*ActivityId) MarshalJSON ¶
func (s *ActivityId) MarshalJSON() ([]byte, error)
type Channel ¶
Channel: An notification channel used to watch for resource changes.
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"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Address") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Address") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*Channel) MarshalJSON ¶
func (s *Channel) MarshalJSON() ([]byte, error)
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) Context ¶
func (c *ChannelsStopCall) Context(ctx context.Context) *ChannelsStopCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ChannelsStopCall) Do ¶
func (c *ChannelsStopCall) Do(opts ...googleapi.CallOption) error
Do executes the "admin.channels.stop" call.
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.
func (*ChannelsStopCall) Header ¶
func (c *ChannelsStopCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type CustomerUsageReportsGetCall ¶
type CustomerUsageReportsGetCall struct {
// contains filtered or unexported fields
}
func (*CustomerUsageReportsGetCall) Context ¶
func (c *CustomerUsageReportsGetCall) Context(ctx context.Context) *CustomerUsageReportsGetCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
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(opts ...googleapi.CallOption) (*UsageReports, error)
Do executes the "reports.customerUsageReports.get" call. Exactly one of *UsageReports or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *UsageReports.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
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) Header ¶
func (c *CustomerUsageReportsGetCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*CustomerUsageReportsGetCall) IfNoneMatch ¶
func (c *CustomerUsageReportsGetCall) IfNoneMatch(entityTag string) *CustomerUsageReportsGetCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*CustomerUsageReportsGetCall) PageToken ¶
func (c *CustomerUsageReportsGetCall) PageToken(pageToken string) *CustomerUsageReportsGetCall
PageToken sets the optional parameter "pageToken": Token to specify next page.
func (*CustomerUsageReportsGetCall) Pages ¶
func (c *CustomerUsageReportsGetCall) Pages(ctx context.Context, f func(*UsageReports) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
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 ¶
UsageReport: JSON template for a usage report.
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"` // ForceSendFields is a list of field names (e.g. "Date") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Date") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*UsageReport) MarshalJSON ¶
func (s *UsageReport) MarshalJSON() ([]byte, error)
type UsageReportEntity ¶
UsageReportEntity: Information about the type of the item.
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"` // ForceSendFields is a list of field names (e.g. "CustomerId") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "CustomerId") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*UsageReportEntity) MarshalJSON ¶
func (s *UsageReportEntity) MarshalJSON() ([]byte, error)
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 []googleapi.RawMessage `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"` // ForceSendFields is a list of field names (e.g. "BoolValue") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "BoolValue") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*UsageReportParameters) MarshalJSON ¶
func (s *UsageReportParameters) MarshalJSON() ([]byte, error)
type UsageReports ¶
UsageReports: JSON template for a collection of usage reports.
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"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Etag") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Etag") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*UsageReports) MarshalJSON ¶
func (s *UsageReports) MarshalJSON() ([]byte, error)
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"` // ForceSendFields is a list of field names (e.g. "Code") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Code") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*UsageReportsWarnings) MarshalJSON ¶
func (s *UsageReportsWarnings) MarshalJSON() ([]byte, error)
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"` // ForceSendFields is a list of field names (e.g. "Key") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Key") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*UsageReportsWarningsData) MarshalJSON ¶
func (s *UsageReportsWarningsData) MarshalJSON() ([]byte, error)
type UserUsageReportGetCall ¶
type UserUsageReportGetCall struct {
// contains filtered or unexported fields
}
func (*UserUsageReportGetCall) Context ¶
func (c *UserUsageReportGetCall) Context(ctx context.Context) *UserUsageReportGetCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
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(opts ...googleapi.CallOption) (*UsageReports, error)
Do executes the "reports.userUsageReport.get" call. Exactly one of *UsageReports or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *UsageReports.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
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) Header ¶
func (c *UserUsageReportGetCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*UserUsageReportGetCall) IfNoneMatch ¶
func (c *UserUsageReportGetCall) IfNoneMatch(entityTag string) *UserUsageReportGetCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
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) Pages ¶
func (c *UserUsageReportGetCall) Pages(ctx context.Context, f func(*UsageReports) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
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.