type Activities struct {// Etag: ETag of the resource.Etagstring `json:"etag,omitempty"`// Items: Each activity record in the response.Items []*Activity `json:"items,omitempty"`// Kind: The type of API resource. For an activity report, the value is// `reports#activities`.Kindstring `json:"kind,omitempty"`// NextPageToken: Token for retrieving the follow-on next page of the report.// The `nextPageToken` value is used in the request's `pageToken` query string.NextPageTokenstring `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 or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (Activities)MarshalJSON¶

func (sActivities) MarshalJSON() ([]byte,error)

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

func (*ActivitiesListCall)ActorIpAddress¶

func (c *ActivitiesListCall) ActorIpAddress(actorIpAddressstring) *ActivitiesListCall

ActorIpAddress sets the optional parameter "actorIpAddress": The InternetProtocol (IP) Address of host where the event was performed. This is anadditional way to filter a report's summary using the IP address of the userwhose activity is being reported. This IP address may or may not reflect theuser's physical location. For example, the IP address can be the user'sproxy server's address or a virtual private network (VPN) address. Thisparameter supports both IPv4 and IPv6 address versions.

func (*ActivitiesListCall)Context¶

func (c *ActivitiesListCall) Context(ctxcontext.Context) *ActivitiesListCall

Context sets the context to be used in this call's Do method.

func (*ActivitiesListCall)CustomerId¶

func (c *ActivitiesListCall) CustomerId(customerIdstring) *ActivitiesListCall

CustomerId sets the optional parameter "customerId": The unique ID of thecustomer to retrieve data for.

func (*ActivitiesListCall)Do¶

func (c *ActivitiesListCall) Do(opts ...googleapi.CallOption) (*Activities,error)

Do executes the "reports.activities.list" call.Any non-2xx status code is an error. Response headers are in either*Activities.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ActivitiesListCall)EndTime¶

func (c *ActivitiesListCall) EndTime(endTimestring) *ActivitiesListCall

EndTime sets the optional parameter "endTime": Sets the end of the range oftime shown in the report. The date is in theRFC 3339 format, for example2010-10-28T10:26:35.000Z. The default value is the approximate time of theAPI request. An API report has three basic time concepts: - *Date of theAPI's request for a report*: When the API created and retrieved the report.- *Report's start time*: The beginning of the timespan shown in the report.The `startTime` must be before the `endTime` (if specified) and the currenttime when the request is made, or the API returns an error. - *Report's endtime*: The end of the timespan shown in the report. For example, thetimespan of events summarized in a report can start in April and end in May.The report itself can be requested in August. If the `endTime` is notspecified, the report returns all activities from the `startTime` until thecurrent time or the most recent 180 days if the `startTime` is more than 180days in the past. For Gmail requests, `startTime` and `endTime` must beprovided and the difference must not be greater than 30 days.

func (*ActivitiesListCall)EventName¶

func (c *ActivitiesListCall) EventName(eventNamestring) *ActivitiesListCall

EventName sets the optional parameter "eventName": The name of the eventbeing queried by the API. Each `eventName` is related to a specific GoogleWorkspace service or feature which the API organizes into types of events.An example is the Google Calendar events in the Admin console application'sreports. The Calendar Settings `type` structure has all of the Calendar`eventName` activities reported by the API. When an administrator changes aCalendar setting, the API reports this activity in the Calendar Settings`type` and `eventName` parameters. For more information about `eventName`query strings and parameters, see the list of event names for variousapplications above in `applicationName`.

func (*ActivitiesListCall)Fields¶

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ActivitiesListCall)Filters¶

func (c *ActivitiesListCall) Filters(filtersstring) *ActivitiesListCall

Filters sets the optional parameter "filters": The `filters` query string isa comma-separated list composed of event parameters manipulated byrelational operators. Event parameters are in the form `{parameter1name}{relational operator}{parameter1 value},{parameter2 name}{relationaloperator}{parameter2 value},...` These event parameters are associated witha specific `eventName`. An empty report is returned if the request'sparameter doesn't belong to the `eventName`. For more information about theavailable `eventName` fields for each application and their associatedparameters, go to the ApplicationName (#applicationname) table, then clickthrough to the Activity Events page in the Appendix for the application youwant. In the following Drive activity examples, the returned list consistsof all `edit` events where the `doc_id` parameter value matches theconditions defined by the relational operator. In the first example, therequest returns all edited documents with a `doc_id` value equal to `12345`.In the second example, the report returns any edited documents where the`doc_id` value is not equal to `98765`. The `<>` operator is URL-encoded inthe request's query string (`%3C%3E`): ```GET...&eventName=edit&filters=doc_id==12345GET...&eventName=edit&filters=doc_id%3C%3E98765 ``` A `filters` querysupports these relational operators: * `==`—'equal to'. * `<>`—'notequal to'. Must be URL-encoded (%3C%3E). * `<`—'less than'. Must beURL-encoded (%3C). * `<=`—'less than or equal to'. Must be URL-encoded(%3C=). * `>`—'greater than'. Must be URL-encoded (%3E). * `>=`—'greaterthan or equal to'. Must be URL-encoded (%3E=). **Note:** The API doesn'taccept multiple values of the same parameter. If a parameter is suppliedmore than once in the API request, the API only accepts the last value ofthat parameter. In addition, if an invalid parameter is supplied in the APIrequest, the API ignores that parameter and returns the responsecorresponding to the remaining valid parameters. If no parameters arerequested, all parameters are returned.

func (*ActivitiesListCall)GroupIdFilter¶added inv0.34.0

func (c *ActivitiesListCall) GroupIdFilter(groupIdFilterstring) *ActivitiesListCall

GroupIdFilter sets the optional parameter "groupIdFilter": Comma separatedgroup ids (obfuscated) on which user activities are filtered, i.e. theresponse will contain activities for only those users that are a part of atleast one of the group ids mentioned here. Format: "id:abc123,id:xyz456"*Important:* To filter by groups, you must explicitly add the groups to yourfiltering groups allowlist. For more information about adding groups tofiltering groups allowlist, see Filter results by Google Group(https://support.google.com/a/answer/11482175)

func (*ActivitiesListCall)Header¶

func (c *ActivitiesListCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ActivitiesListCall)IfNoneMatch¶

func (c *ActivitiesListCall) IfNoneMatch(entityTagstring) *ActivitiesListCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ActivitiesListCall)MaxResults¶

func (c *ActivitiesListCall) MaxResults(maxResultsint64) *ActivitiesListCall

MaxResults sets the optional parameter "maxResults": Determines how manyactivity records are shown on each response page. For example, if therequest sets `maxResults=1` and the report has two activities, the reporthas two pages. The response's `nextPageToken` property has the token to thesecond page. The `maxResults` query string is optional in the request. Thedefault value is 1000.

func (*ActivitiesListCall)OrgUnitID¶

func (c *ActivitiesListCall) OrgUnitID(orgUnitIDstring) *ActivitiesListCall

OrgUnitID sets the optional parameter "orgUnitID": ID of the organizationalunit to report on. Activity records will be shown only for users who belongto the specified organizational unit. Data before Dec 17, 2018 doesn'tappear in the filtered results.

func (*ActivitiesListCall)PageToken¶

func (c *ActivitiesListCall) PageToken(pageTokenstring) *ActivitiesListCall

PageToken sets the optional parameter "pageToken": The token to specify nextpage. A report with multiple pages has a `nextPageToken` property in theresponse. In your follow-on request getting the next page of the report,enter the `nextPageToken` value in the `pageToken` query string.

func (*ActivitiesListCall)Pages¶

func (c *ActivitiesListCall) Pages(ctxcontext.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)ResourceDetailsFilter¶added inv0.257.0

func (c *ActivitiesListCall) ResourceDetailsFilter(resourceDetailsFilterstring) *ActivitiesListCall

ResourceDetailsFilter sets the optional parameter "resourceDetailsFilter":The `resourceDetailsFilter` query string is an AND separated list composedof Resource Details (#resourcedetails) fields manipulated by relationaloperators. Resource Details Filters are in the form`{resourceDetails.field1}{relational operator}{field1 value} AND{resourceDetails.field2}{relational operator}{field2 value}...` All theinner fields are traversed using the `.` operator, as shown in the followingexample: ``` resourceDetails.id = "resourceId" ANDresourceDetails.appliedLabels.id = "appliedLabelId" ANDresourceDetails.appliedLabels.fieldValue.id = "fieldValueId" ````resourceDetailsFilter` query supports these relational operators: *`=`—'equal to'. * `!=`—'not equal to'. * `:`—'exists'. This is usedfor filtering on repeated fields. `FieldValue` (#fieldvalue) types that arerepeated in nature uses `exists` operator for filtering. The following`FieldValue` (#fieldvalue) types are repeated: * `TextListValue`(#textlistvalue) * `SelectionListValue` (#selectionlistvalue) *`UserListValue` (#userlistvalue) For example, in the following filter,`SelectionListValue` (#selectionlistvalue), is a repeated field. The filterchecks whether `SelectionListValue` (#selectionlistvalue) contains`selection_id`: ``` resourceDetails.id = "resourceId" ANDresourceDetails.appliedLabels.id = "appliedLabelId" ANDresourceDetails.appliedLabels.fieldValue.id = "fieldValueId" ANDresourceDetails.appliedLabels.fieldValue.type = "SELECTION_LIST_VALUE" ANDresourceDetails.appliedLabels.fieldValue.selectionListValue.id: "id" ```**Usage** ``` GET...&resourceDetailsFilter=resourceDetails.id = "resourceId"AND resourceDetails.appliedLabels.id = "appliedLabelId"GET...&resourceDetailsFilter=resourceDetails.id=%22resourceId%22%20AND%20resourceDetails.appliedLabels.id=%22appliedLabelId%22 ``` **Note thefollowing**: * You must URL encode the query string before sending therequest. * The API supports a maximum of 5 fields separated by the ANDoperator. - When filtering on deeper levels (e.g., `AppliedLabel`(#appliedlabel), `FieldValue` (#fieldvalue)), the IDs of all precedinglevels in the hierarchy must be included in the filter. For example:Filtering on `FieldValue` (#fieldvalue) requires `AppliedLabel`(#appliedlabel) ID and resourceDetails ID to be present. *Sample Query*: ```resourceDetails.id = "resourceId" AND resourceDetails.appliedLabels.id ="appliedLabelId" AND resourceDetails.appliedLabels.fieldValue.id ="fieldValueId" ``` * Filtering on inner `FieldValue` (#fieldvalue) typeslike `longTextValue` and `textValue` requires`resourceDetails.appliedLabels.fieldValue.type` to be present. * OnlyFiltering on a single `AppliedLabel` (#appliedlabel) id and `FieldValue`(#fieldvalue) id is supported.

func (*ActivitiesListCall)StartTime¶

func (c *ActivitiesListCall) StartTime(startTimestring) *ActivitiesListCall

StartTime sets the optional parameter "startTime": Sets the beginning of therange of time shown in the report. The date is in theRFC 3339 format, forexample 2010-10-28T10:26:35.000Z. The report returns all activities from`startTime` until `endTime`. The `startTime` must be before the `endTime`(if specified) and the current time when the request is made, or the APIreturns an error. For Gmail requests, `startTime` and `endTime` must beprovided and the difference must not be greater than 30 days.

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

funcNewActivitiesService¶

func NewActivitiesService(s *Service) *ActivitiesService

func (*ActivitiesService)List¶

func (r *ActivitiesService) List(userKeystring, applicationNamestring) *ActivitiesListCall

List: Retrieves a list of activities for a specific customer's account andapplication such as the Admin console application or the Google Driveapplication. For more information, see the guides for administrator andGoogle Drive activity reports. For more information about the activityreport's parameters, see the activity parameters reference guides.

• applicationName: Application name for which the events are to beretrieved.
• userKey: Represents the profile ID or the user email for which the datashould be filtered. Can be `all` for all information, or `userKey` for auser's unique Google Workspace profile ID or their primary email address.Must not be a deleted user. For a deleted user, call `users.list` inDirectory API with `showDeleted=true`, then use the returned `ID` as the`userKey`.

func (*ActivitiesService)Watch¶

func (r *ActivitiesService) Watch(userKeystring, applicationNamestring, channel *Channel) *ActivitiesWatchCall

Watch: Start receiving notifications for account activities. For moreinformation, see Receiving Push Notifications.

• applicationName: Application name for which the events are to beretrieved.
• userKey: Represents the profile ID or the user email for which the datashould be filtered. Can be `all` for all information, or `userKey` for auser's unique Google Workspace profile ID or their primary email address.Must not be a deleted user. For a deleted user, call `users.list` inDirectory API with `showDeleted=true`, then use the returned `ID` as the`userKey`.

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

func (*ActivitiesWatchCall)ActorIpAddress¶

func (c *ActivitiesWatchCall) ActorIpAddress(actorIpAddressstring) *ActivitiesWatchCall

ActorIpAddress sets the optional parameter "actorIpAddress": The InternetProtocol (IP) Address of host where the event was performed. This is anadditional way to filter a report's summary using the IP address of the userwhose activity is being reported. This IP address may or may not reflect theuser's physical location. For example, the IP address can be the user'sproxy server's address or a virtual private network (VPN) address. Thisparameter supports both IPv4 and IPv6 address versions.

func (*ActivitiesWatchCall)Context¶

func (c *ActivitiesWatchCall) Context(ctxcontext.Context) *ActivitiesWatchCall

Context sets the context to be used in this call's Do method.

func (*ActivitiesWatchCall)CustomerId¶

func (c *ActivitiesWatchCall) CustomerId(customerIdstring) *ActivitiesWatchCall

CustomerId sets the optional parameter "customerId": The unique ID of thecustomer to retrieve data for.

func (*ActivitiesWatchCall)Do¶

func (c *ActivitiesWatchCall) Do(opts ...googleapi.CallOption) (*Channel,error)

Do executes the "reports.activities.watch" call.Any non-2xx status code is an error. Response headers are in either*Channel.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ActivitiesWatchCall)EndTime¶

func (c *ActivitiesWatchCall) EndTime(endTimestring) *ActivitiesWatchCall

EndTime sets the optional parameter "endTime": Sets the end of the range oftime shown in the report. The date is in theRFC 3339 format, for example2010-10-28T10:26:35.000Z. The default value is the approximate time of theAPI request. An API report has three basic time concepts: - *Date of theAPI's request for a report*: When the API created and retrieved the report.- *Report's start time*: The beginning of the timespan shown in the report.The `startTime` must be before the `endTime` (if specified) and the currenttime when the request is made, or the API returns an error. - *Report's endtime*: The end of the timespan shown in the report. For example, thetimespan of events summarized in a report can start in April and end in May.The report itself can be requested in August. If the `endTime` is notspecified, the report returns all activities from the `startTime` until thecurrent time or the most recent 180 days if the `startTime` is more than 180days in the past.

func (*ActivitiesWatchCall)EventName¶

func (c *ActivitiesWatchCall) EventName(eventNamestring) *ActivitiesWatchCall

EventName sets the optional parameter "eventName": The name of the eventbeing queried by the API. Each `eventName` is related to a specific GoogleWorkspace service or feature which the API organizes into types of events.An example is the Google Calendar events in the Admin console application'sreports. The Calendar Settings `type` structure has all of the Calendar`eventName` activities reported by the API. When an administrator changes aCalendar setting, the API reports this activity in the Calendar Settings`type` and `eventName` parameters. For more information about `eventName`query strings and parameters, see the list of event names for variousapplications above in `applicationName`.

func (*ActivitiesWatchCall)Fields¶

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ActivitiesWatchCall)Filters¶

func (c *ActivitiesWatchCall) Filters(filtersstring) *ActivitiesWatchCall

Filters sets the optional parameter "filters": The `filters` query string isa comma-separated list composed of event parameters manipulated byrelational operators. Event parameters are in the form `{parameter1name}{relational operator}{parameter1 value},{parameter2 name}{relationaloperator}{parameter2 value},...` These event parameters are associated witha specific `eventName`. An empty report is returned if the request'sparameter doesn't belong to the `eventName`. For more information about theavailable `eventName` fields for each application and their associatedparameters, go to the ApplicationName (#applicationname) table, then clickthrough to the Activity Events page in the Appendix for the application youwant. In the following Drive activity examples, the returned list consistsof all `edit` events where the `doc_id` parameter value matches theconditions defined by the relational operator. In the first example, therequest returns all edited documents with a `doc_id` value equal to `12345`.In the second example, the report returns any edited documents where the`doc_id` value is not equal to `98765`. The `<>` operator is URL-encoded inthe request's query string (`%3C%3E`): ```GET...&eventName=edit&filters=doc_id==12345GET...&eventName=edit&filters=doc_id%3C%3E98765 ``` A `filters` querysupports these relational operators: * `==`—'equal to'. * `<>`—'notequal to'. Must be URL-encoded (%3C%3E). * `<`—'less than'. Must beURL-encoded (%3C). * `<=`—'less than or equal to'. Must be URL-encoded(%3C=). * `>`—'greater than'. Must be URL-encoded (%3E). * `>=`—'greaterthan or equal to'. Must be URL-encoded (%3E=). **Note:** The API doesn'taccept multiple values of the same parameter. If a parameter is suppliedmore than once in the API request, the API only accepts the last value ofthat parameter. In addition, if an invalid parameter is supplied in the APIrequest, the API ignores that parameter and returns the responsecorresponding to the remaining valid parameters. If no parameters arerequested, all parameters are returned.

func (*ActivitiesWatchCall)GroupIdFilter¶added inv0.34.0

func (c *ActivitiesWatchCall) GroupIdFilter(groupIdFilterstring) *ActivitiesWatchCall

GroupIdFilter sets the optional parameter "groupIdFilter": `Deprecated`.This field is deprecated and is no longer supported. Comma separated groupids (obfuscated) on which user activities are filtered, i.e. the responsewill contain activities for only those users that are a part of at least oneof the group ids mentioned here. Format: "id:abc123,id:xyz456" *Important:*To filter by groups, you must explicitly add the groups to your filteringgroups allowlist. For more information about adding groups to filteringgroups allowlist, see Filter results by Google Group(https://support.google.com/a/answer/11482175)

func (*ActivitiesWatchCall)Header¶

func (c *ActivitiesWatchCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ActivitiesWatchCall)MaxResults¶

func (c *ActivitiesWatchCall) MaxResults(maxResultsint64) *ActivitiesWatchCall

MaxResults sets the optional parameter "maxResults": Determines how manyactivity records are shown on each response page. For example, if therequest sets `maxResults=1` and the report has two activities, the reporthas two pages. The response's `nextPageToken` property has the token to thesecond page. The `maxResults` query string is optional in the request. Thedefault value is 1000.

func (*ActivitiesWatchCall)OrgUnitID¶

func (c *ActivitiesWatchCall) OrgUnitID(orgUnitIDstring) *ActivitiesWatchCall

OrgUnitID sets the optional parameter "orgUnitID": `Deprecated`. This fieldis deprecated and is no longer supported. ID of the organizational unit toreport on. Activity records will be shown only for users who belong to thespecified organizational unit. Data before Dec 17, 2018 doesn't appear inthe filtered results.

func (*ActivitiesWatchCall)PageToken¶

func (c *ActivitiesWatchCall) PageToken(pageTokenstring) *ActivitiesWatchCall

PageToken sets the optional parameter "pageToken": The token to specify nextpage. A report with multiple pages has a `nextPageToken` property in theresponse. In your follow-on request getting the next page of the report,enter the `nextPageToken` value in the `pageToken` query string.

func (*ActivitiesWatchCall)StartTime¶

func (c *ActivitiesWatchCall) StartTime(startTimestring) *ActivitiesWatchCall

StartTime sets the optional parameter "startTime": Sets the beginning of therange of time shown in the report. The date is in theRFC 3339 format, forexample 2010-10-28T10:26:35.000Z. The report returns all activities from`startTime` until `endTime`. The `startTime` must be before the `endTime`(if specified) and the current time when the request is made, or the APIreturns an error.

type Activity struct {// Actor: User doing the action.Actor *ActivityActor `json:"actor,omitempty"`// Etag: ETag of the entry.Etagstring `json:"etag,omitempty"`// Events: Activity events in the report.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. This is the Internet// Protocol (IP) address of the user when logging into Google Workspace, which// may or may not reflect the user's physical location. For example, the IP// address can be the user's proxy server's address or a virtual private// network (VPN) address. The API supports IPv4 and IPv6.IpAddressstring `json:"ipAddress,omitempty"`// Kind: The type of API resource. For an activity report, the value is// `audit#activity`.Kindstring `json:"kind,omitempty"`// NetworkInfo: Network information of the user doing the action.NetworkInfo *ActivityNetworkInfo `json:"networkInfo,omitempty"`// OwnerDomain: This is the domain that is affected by the report's event. For// example domain of Admin console or the Drive application's document owner.OwnerDomainstring `json:"ownerDomain,omitempty"`// ResourceDetails: Details of the resource on which the action was performed.ResourceDetails []*ResourceDetails `json:"resourceDetails,omitempty"`// ForceSendFields is a list of field names (e.g. "Actor") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (Activity)MarshalJSON¶

func (sActivity) MarshalJSON() ([]byte,error)

type ActivityActor struct {// ApplicationInfo: Details of the application that was the actor for the// activity.ApplicationInfo *ActivityActorApplicationInfo `json:"applicationInfo,omitempty"`// CallerType: The type of actor.CallerTypestring `json:"callerType,omitempty"`// Email: The primary email address of the actor. May be absent if there is no// email address associated with the actor.Emailstring `json:"email,omitempty"`// Key: Only present when `callerType` is `KEY`. Can be the `consumer_key` of// the requestor for OAuth 2LO API requests or an identifier for robot// accounts.Keystring `json:"key,omitempty"`// ProfileId: The unique Google Workspace profile ID of the actor. This value// might be absent if the actor is not a Google Workspace user, or may be the// number 105250506097979753968 which acts as a placeholder ID.ProfileIdstring `json:"profileId,omitempty"`// ForceSendFields is a list of field names (e.g. "ApplicationInfo") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ApplicationInfo") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (ActivityActor)MarshalJSON¶

func (sActivityActor) MarshalJSON() ([]byte,error)

type ActivityActorApplicationInfo struct {// ApplicationName: Name of the application used to perform the action.ApplicationNamestring `json:"applicationName,omitempty"`// Impersonation: Whether the application was impersonating a user.Impersonationbool `json:"impersonation,omitempty"`// OauthClientId: OAuth client id of the third party application used to// perform the action.OauthClientIdstring `json:"oauthClientId,omitempty"`// ForceSendFields is a list of field names (e.g. "ApplicationName") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (ActivityActorApplicationInfo)MarshalJSON¶added inv0.229.0

func (sActivityActorApplicationInfo) MarshalJSON() ([]byte,error)

type ActivityEvents struct {// Name: Name of the event. This is the specific name of the activity reported// by the API. And each `eventName` is related to a specific Google Workspace// service or feature which the API organizes into types of events. For// `eventName` request parameters in general: - If no `eventName` is given, the// report returns all possible instances of an `eventName`. - When you request// an `eventName`, the API's response returns all activities which contain that// `eventName`. For more information about `eventName` properties, see the list// of event names for various applications above in `applicationName`.Namestring `json:"name,omitempty"`// Parameters: Parameter value pairs for various applications. For more// information about `eventName` parameters, see the list of event names for// various applications above in `applicationName`.Parameters []*ActivityEventsParameters `json:"parameters,omitempty"`// ResourceIds: Resource ids associated with the event.ResourceIds []string `json:"resourceIds,omitempty"`// Type: Type of event. The Google Workspace service or feature that an// administrator changes is identified in the `type` property which identifies// an event using the `eventName` property. For a full list of the API's `type`// categories, see the list of event names for various applications above in// `applicationName`.Typestring `json:"type,omitempty"`// ForceSendFields is a list of field names (e.g. "Name") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (ActivityEvents)MarshalJSON¶

func (sActivityEvents) MarshalJSON() ([]byte,error)

type ActivityEventsParameters struct {// BoolValue: Boolean value of the parameter.BoolValuebool `json:"boolValue,omitempty"`// IntValue: Integer value of the parameter.IntValueint64 `json:"intValue,omitempty,string"`// MessageValue: Nested parameter value pairs associated with this parameter.// Complex value type for a parameter are returned as a list of parameter// values. For example, the address parameter may have a value as `[{parameter:// [{name: city, value: abc}]}]`MessageValue *ActivityEventsParametersMessageValue `json:"messageValue,omitempty"`// MultiIntValue: Integer values of the parameter.MultiIntValuegoogleapi.Int64s `json:"multiIntValue,omitempty"`// MultiMessageValue: List of `messageValue` objects.MultiMessageValue []*ActivityEventsParametersMultiMessageValue `json:"multiMessageValue,omitempty"`// MultiValue: String values of the parameter.MultiValue []string `json:"multiValue,omitempty"`// Name: The name of the parameter.Namestring `json:"name,omitempty"`// Value: String value of the parameter.Valuestring `json:"value,omitempty"`// ForceSendFields is a list of field names (e.g. "BoolValue") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (ActivityEventsParameters)MarshalJSON¶

func (sActivityEventsParameters) MarshalJSON() ([]byte,error)

type ActivityEventsParametersMessageValue struct {// Parameter: Parameter valuesParameter []*NestedParameter `json:"parameter,omitempty"`// ForceSendFields is a list of field names (e.g. "Parameter") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Parameter") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (ActivityEventsParametersMessageValue)MarshalJSON¶added inv0.6.0

func (sActivityEventsParametersMessageValue) MarshalJSON() ([]byte,error)

type ActivityEventsParametersMultiMessageValue struct {// Parameter: Parameter valuesParameter []*NestedParameter `json:"parameter,omitempty"`// ForceSendFields is a list of field names (e.g. "Parameter") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Parameter") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (ActivityEventsParametersMultiMessageValue)MarshalJSON¶added inv0.6.0

func (sActivityEventsParametersMultiMessageValue) MarshalJSON() ([]byte,error)

type ActivityId struct {// ApplicationName: Application name to which the event belongs. For possible// values see the list of applications above in `applicationName`.ApplicationNamestring `json:"applicationName,omitempty"`// CustomerId: The unique identifier for a Google Workspace account.CustomerIdstring `json:"customerId,omitempty"`// Time: Time of occurrence of the activity. This is in UNIX epoch time in// seconds.Timestring `json:"time,omitempty"`// UniqueQualifier: Unique qualifier if multiple events have the same time.UniqueQualifierint64 `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 or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (ActivityId)MarshalJSON¶

func (sActivityId) MarshalJSON() ([]byte,error)

type ActivityNetworkInfo struct {// IpAsn: IP Address of the user doing the action.IpAsn []int64 `json:"ipAsn,omitempty"`// RegionCode: ISO 3166-1 alpha-2 region code of the user doing the action.RegionCodestring `json:"regionCode,omitempty"`// SubdivisionCode: ISO 3166-2 region code (states and provinces) for countries// of the user doing the action.SubdivisionCodestring `json:"subdivisionCode,omitempty"`// ForceSendFields is a list of field names (e.g. "IpAsn") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "IpAsn") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (ActivityNetworkInfo)MarshalJSON¶added inv0.242.0

func (sActivityNetworkInfo) MarshalJSON() ([]byte,error)

type AppliedLabel struct {// FieldValues: List of fields which are part of the label and have been set by// the user. If label has a field which was not set by the user, it would not// be present in this list.FieldValues []*FieldValue `json:"fieldValues,omitempty"`// Id: Identifier of the label - Only the label id, not the full OnePlatform// resource name.Idstring `json:"id,omitempty"`// Reason: The reason why the label was applied on the resource.Reason *Reason `json:"reason,omitempty"`// Title: Title of the labelTitlestring `json:"title,omitempty"`// ForceSendFields is a list of field names (e.g. "FieldValues") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "FieldValues") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (AppliedLabel)MarshalJSON¶added inv0.229.0

func (sAppliedLabel) MarshalJSON() ([]byte,error)

type Channel struct {// Address: The address where notifications are delivered for this channel.Addressstring `json:"address,omitempty"`// Expiration: Date and time of notification channel expiration, expressed as a// Unix timestamp, in milliseconds. Optional.Expirationint64 `json:"expiration,omitempty,string"`// Id: A UUID or similar unique string that identifies this channel.Idstring `json:"id,omitempty"`// Kind: Identifies this as a notification channel used to watch for changes to// a resource, which is "api#channel".Kindstring `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. A payload is// data that is sent in the body of an HTTP POST, PUT, or PATCH message and// contains important information about the request. Optional.Payloadbool `json:"payload,omitempty"`// ResourceId: An opaque ID that identifies the resource being watched on this// channel. Stable across different API versions.ResourceIdstring `json:"resourceId,omitempty"`// ResourceUri: A version-specific identifier for the watched resource.ResourceUristring `json:"resourceUri,omitempty"`// Token: An arbitrary string delivered to the target address with each// notification delivered over this channel. Optional.Tokenstring `json:"token,omitempty"`// Type: The type of delivery mechanism used for this channel. The value should// be set to "web_hook".Typestring `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 or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (Channel)MarshalJSON¶

func (sChannel) MarshalJSON() ([]byte,error)

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

funcNewChannelsService¶

func NewChannelsService(s *Service) *ChannelsService

func (*ChannelsService)Stop¶

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

Stop: Stop watching resources through this channel.

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

func (*ChannelsStopCall)Context¶

func (c *ChannelsStopCall) Context(ctxcontext.Context) *ChannelsStopCall

Context sets the context to be used in this call's Do method.

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. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ChannelsStopCall)Header¶

func (c *ChannelsStopCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

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

func (*CustomerUsageReportsGetCall)Context¶

func (c *CustomerUsageReportsGetCall) Context(ctxcontext.Context) *CustomerUsageReportsGetCall

Context sets the context to be used in this call's Do method.

func (*CustomerUsageReportsGetCall)CustomerId¶

func (c *CustomerUsageReportsGetCall) CustomerId(customerIdstring) *CustomerUsageReportsGetCall

CustomerId sets the optional parameter "customerId": The unique ID of thecustomer to retrieve data for.

func (*CustomerUsageReportsGetCall)Do¶

func (c *CustomerUsageReportsGetCall) Do(opts ...googleapi.CallOption) (*UsageReports,error)

Do executes the "reports.customerUsageReports.get" call.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 checkwhether 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. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CustomerUsageReportsGetCall)Header¶

func (c *CustomerUsageReportsGetCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*CustomerUsageReportsGetCall)IfNoneMatch¶

func (c *CustomerUsageReportsGetCall) IfNoneMatch(entityTagstring) *CustomerUsageReportsGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*CustomerUsageReportsGetCall)PageToken¶

func (c *CustomerUsageReportsGetCall) PageToken(pageTokenstring) *CustomerUsageReportsGetCall

PageToken sets the optional parameter "pageToken": Token to specify nextpage. A report with multiple pages has a `nextPageToken` property in theresponse. For your follow-on requests getting all of the report's pages,enter the `nextPageToken` value in the `pageToken` query string.

func (*CustomerUsageReportsGetCall)Pages¶

func (c *CustomerUsageReportsGetCall) Pages(ctxcontext.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(parametersstring) *CustomerUsageReportsGetCall

Parameters sets the optional parameter "parameters": The `parameters` querystring is a comma-separated list of event parameters that refine a report'sresults. The parameter is associated with a specific application. Theapplication values for the Customers usage report include `accounts`,`app_maker`, `apps_scripts`, `calendar`, `chat`, `classroom`, `cros`,`docs`, `gmail`, `gplus`, `device_management`, `meet`, and `sites`. A`parameters` query string is in the CSV form of `app_name1:param_name1,app_name2:param_name2`. *Note:* The API doesn't accept multiple values of aparameter. If a particular parameter is supplied more than once in the APIrequest, the API only accepts the last value of that request parameter. Inaddition, if an invalid request parameter is supplied in the API request,the API ignores that request parameter and returns the responsecorresponding to the remaining valid request parameters. An example of aninvalid request parameter is one that does not belong to the application. Ifno parameters are requested, all parameters are returned.

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

funcNewCustomerUsageReportsService¶

func NewCustomerUsageReportsService(s *Service) *CustomerUsageReportsService

func (*CustomerUsageReportsService)Get¶

func (r *CustomerUsageReportsService) Get(datestring) *CustomerUsageReportsGetCall

Get: Retrieves a report which is a collection of properties and statisticsfor a specific customer's account. For more information, see the CustomersUsage Report guide. For more information about the customer report'sparameters, see the Customers Usage parameters reference guides.

• date: Represents the date the usage occurred, based on UTC-8:00 (PacificStandard Time). The timestamp is in the ISO 8601 format(https://en.wikipedia.org/wiki/ISO_8601), `yyyy-mm-dd`.

type Date struct {// Day: Day of a month. Must be from 1 to 31 and valid for the year and month,// or 0 to specify a year by itself or a year and month where the day isn't// significant.Dayint64 `json:"day,omitempty"`// Month: Month of a year. Must be from 1 to 12, or 0 to specify a year without// a month and day.Monthint64 `json:"month,omitempty"`// Year: Year of the date. Must be from 1 to 9999, or 0 to specify a date// without a year.Yearint64 `json:"year,omitempty"`// ForceSendFields is a list of field names (e.g. "Day") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Day") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (Date)MarshalJSON¶added inv0.229.0

func (sDate) MarshalJSON() ([]byte,error)

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

func (*EntityUsageReportsGetCall)Context¶

func (c *EntityUsageReportsGetCall) Context(ctxcontext.Context) *EntityUsageReportsGetCall

Context sets the context to be used in this call's Do method.

func (*EntityUsageReportsGetCall)CustomerId¶

func (c *EntityUsageReportsGetCall) CustomerId(customerIdstring) *EntityUsageReportsGetCall

CustomerId sets the optional parameter "customerId": The unique ID of thecustomer to retrieve data for.

func (*EntityUsageReportsGetCall)Do¶

func (c *EntityUsageReportsGetCall) Do(opts ...googleapi.CallOption) (*UsageReports,error)

Do executes the "reports.entityUsageReports.get" call.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 checkwhether the returned error was because http.StatusNotModified was returned.

func (*EntityUsageReportsGetCall)Fields¶

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*EntityUsageReportsGetCall)Filters¶

func (c *EntityUsageReportsGetCall) Filters(filtersstring) *EntityUsageReportsGetCall

Filters sets the optional parameter "filters": The `filters` query string isa comma-separated list of an application's event parameters where theparameter's value is manipulated by a relational operator. The `filters`query string includes the name of the application whose usage is returned inthe report. The application values for the Entities usage report include`accounts`, `docs`, and `gmail`. Filters are in the form `[applicationname]:parameter name[parameter value],...`. In this example, the `<>` 'notequal to' operator is URL-encoded in the request's query string (%3C%3E):GEThttps://www.googleapis.com/admin/reports/v1/usage/gplus_communities/all/dates/2017-12-01?parameters=gplus:community_name,gplus:num_total_members&filters=gplus:num_total_members%3C%3E0 The relational operators include: -`==` - 'equal to'. - `<>` - 'not equal to'. It is URL-encoded (%3C%3E). -`<` - 'less than'. It is URL-encoded (%3C). - `<=` - 'less than or equalto'. It is URL-encoded (%3C=). - `>` - 'greater than'. It is URL-encoded(%3E). - `>=` - 'greater than or equal to'. It is URL-encoded (%3E=).Filters can only be applied to numeric parameters.

func (*EntityUsageReportsGetCall)Header¶

func (c *EntityUsageReportsGetCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*EntityUsageReportsGetCall)IfNoneMatch¶

func (c *EntityUsageReportsGetCall) IfNoneMatch(entityTagstring) *EntityUsageReportsGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*EntityUsageReportsGetCall)MaxResults¶

func (c *EntityUsageReportsGetCall) MaxResults(maxResultsint64) *EntityUsageReportsGetCall

MaxResults sets the optional parameter "maxResults": Determines how manyactivity records are shown on each response page. For example, if therequest sets `maxResults=1` and the report has two activities, the reporthas two pages. The response's `nextPageToken` property has the token to thesecond page.

func (*EntityUsageReportsGetCall)PageToken¶

func (c *EntityUsageReportsGetCall) PageToken(pageTokenstring) *EntityUsageReportsGetCall

PageToken sets the optional parameter "pageToken": Token to specify nextpage. A report with multiple pages has a `nextPageToken` property in theresponse. In your follow-on request getting the next page of the report,enter the `nextPageToken` value in the `pageToken` query string.

func (*EntityUsageReportsGetCall)Pages¶

func (c *EntityUsageReportsGetCall) Pages(ctxcontext.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 (*EntityUsageReportsGetCall)Parameters¶

func (c *EntityUsageReportsGetCall) Parameters(parametersstring) *EntityUsageReportsGetCall

Parameters sets the optional parameter "parameters": The `parameters` querystring is a comma-separated list of event parameters that refine a report'sresults. The parameter is associated with a specific application. Theapplication values for the Entities usage report are only `gplus`. A`parameter` query string is in the CSV form of `[app_name1:param_name1],[app_name2:param_name2]...`. *Note:* The API doesn't accept multiple valuesof a parameter. If a particular parameter is supplied more than once in theAPI request, the API only accepts the last value of that request parameter.In addition, if an invalid request parameter is supplied in the API request,the API ignores that request parameter and returns the responsecorresponding to the remaining valid request parameters. An example of aninvalid request parameter is one that does not belong to the application. Ifno parameters are requested, all parameters are returned.

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

funcNewEntityUsageReportsService¶

func NewEntityUsageReportsService(s *Service) *EntityUsageReportsService

func (*EntityUsageReportsService)Get¶

func (r *EntityUsageReportsService) Get(entityTypestring, entityKeystring, datestring) *EntityUsageReportsGetCall

Get: Retrieves a report which is a collection of properties and statisticsfor entities used by users within the account. For more information, see theEntities Usage Report guide. For more information about the entitiesreport's parameters, see the Entities Usage parameters reference guides.

• date: Represents the date the usage occurred, based on UTC-8:00 (PacificStandard Time). The timestamp is in the ISO 8601 format(https://en.wikipedia.org/wiki/ISO_8601), `yyyy-mm-dd`.
• entityKey: Represents the key of the object to filter the data with. It isa string which can take the value `all` to get activity events for allusers, or any other value for an app-specific entity. For details on howto obtain the `entityKey` for a particular `entityType`, see the EntitiesUsage parameters reference guides.
• entityType: Represents the type of entity for the report.

type FieldValue struct {// DateValue: Setting a date value.DateValue *Date `json:"dateValue,omitempty"`// DisplayName: Display name of the fieldDisplayNamestring `json:"displayName,omitempty"`// Id: Identifier of the fieldIdstring `json:"id,omitempty"`// IntegerValue: Setting an integer value.IntegerValueint64 `json:"integerValue,omitempty,string"`// LongTextValue: Setting a long text value.LongTextValuestring `json:"longTextValue,omitempty"`// Reason: The reason why the field was applied to the label.Reason *Reason `json:"reason,omitempty"`// SelectionListValue: Setting a selection list value by selecting multiple// values from a dropdown.SelectionListValue *FieldValueSelectionListValue `json:"selectionListValue,omitempty"`// SelectionValue: Setting a selection value by selecting a single value from a// dropdown.SelectionValue *FieldValueSelectionValue `json:"selectionValue,omitempty"`// TextListValue: Setting a text list value.TextListValue *FieldValueTextListValue `json:"textListValue,omitempty"`// TextValue: Setting a text value.TextValuestring `json:"textValue,omitempty"`// Type: Type of the fieldTypestring `json:"type,omitempty"`// UnsetValue: If the field is unset, this will be true.UnsetValuebool `json:"unsetValue,omitempty"`// UserListValue: Setting a user list value by selecting multiple users.UserListValue *FieldValueUserListValue `json:"userListValue,omitempty"`// UserValue: Setting a user value by selecting a single user.UserValue *FieldValueUserValue `json:"userValue,omitempty"`// ForceSendFields is a list of field names (e.g. "DateValue") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DateValue") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (FieldValue)MarshalJSON¶added inv0.229.0

func (sFieldValue) MarshalJSON() ([]byte,error)

type FieldValueSelectionListValue struct {// Values: List of selections.Values []*FieldValueSelectionValue `json:"values,omitempty"`// ForceSendFields is a list of field names (e.g. "Values") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Values") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (FieldValueSelectionListValue)MarshalJSON¶added inv0.229.0

func (sFieldValueSelectionListValue) MarshalJSON() ([]byte,error)

type FieldValueSelectionValue struct {// Badged: Whether the selection is badged.Badgedbool `json:"badged,omitempty"`// DisplayName: Display name of the selection.DisplayNamestring `json:"displayName,omitempty"`// Id: Identifier of the selection.Idstring `json:"id,omitempty"`// ForceSendFields is a list of field names (e.g. "Badged") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Badged") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (FieldValueSelectionValue)MarshalJSON¶added inv0.229.0

func (sFieldValueSelectionValue) MarshalJSON() ([]byte,error)

type FieldValueTextListValue struct {// Values: List of text values.Values []string `json:"values,omitempty"`// ForceSendFields is a list of field names (e.g. "Values") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Values") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (FieldValueTextListValue)MarshalJSON¶added inv0.229.0

func (sFieldValueTextListValue) MarshalJSON() ([]byte,error)

type FieldValueUserListValue struct {// Values: List of users.Values []*FieldValueUserValue `json:"values,omitempty"`// ForceSendFields is a list of field names (e.g. "Values") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Values") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (FieldValueUserListValue)MarshalJSON¶added inv0.229.0

func (sFieldValueUserListValue) MarshalJSON() ([]byte,error)

type FieldValueUserValue struct {// Email: Email of the user.Emailstring `json:"email,omitempty"`// ForceSendFields is a list of field names (e.g. "Email") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Email") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (FieldValueUserValue)MarshalJSON¶added inv0.229.0

func (sFieldValueUserValue) MarshalJSON() ([]byte,error)

type NestedParameter struct {// BoolValue: Boolean value of the parameter.BoolValuebool `json:"boolValue,omitempty"`// IntValue: Integer value of the parameter.IntValueint64 `json:"intValue,omitempty,string"`// MultiBoolValue: Multiple boolean values of the parameter.MultiBoolValue []bool `json:"multiBoolValue,omitempty"`// MultiIntValue: Multiple integer values of the parameter.MultiIntValuegoogleapi.Int64s `json:"multiIntValue,omitempty"`// MultiValue: Multiple string values of the parameter.MultiValue []string `json:"multiValue,omitempty"`// Name: The name of the parameter.Namestring `json:"name,omitempty"`// Value: String value of the parameter.Valuestring `json:"value,omitempty"`// ForceSendFields is a list of field names (e.g. "BoolValue") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (NestedParameter)MarshalJSON¶added inv0.6.0

func (sNestedParameter) MarshalJSON() ([]byte,error)

type Reason struct {// ReasonType: The type of the reason.ReasonTypestring `json:"reasonType,omitempty"`// ForceSendFields is a list of field names (e.g. "ReasonType") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ReasonType") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (Reason)MarshalJSON¶added inv0.229.0

func (sReason) MarshalJSON() ([]byte,error)

type ResourceDetails struct {// AppliedLabels: List of labels applied on the resourceAppliedLabels []*AppliedLabel `json:"appliedLabels,omitempty"`// Id: Identifier of the resource.Idstring `json:"id,omitempty"`// Relation: Defines relationship of the resource to the eventsRelationstring `json:"relation,omitempty"`// Title: Title of the resource. For instance, in case of a drive document,// this would be the title of the document. In case of an email, this would be// the subject.Titlestring `json:"title,omitempty"`// Type: Type of the resource - document, email, chat messageTypestring `json:"type,omitempty"`// ForceSendFields is a list of field names (e.g. "AppliedLabels") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AppliedLabels") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (ResourceDetails)MarshalJSON¶added inv0.229.0

func (sResourceDetails) MarshalJSON() ([]byte,error)

type Service struct {BasePathstring// API endpoint base URLUserAgentstring// optional additional User-Agent fragmentActivities *ActivitiesServiceChannels *ChannelsServiceCustomerUsageReports *CustomerUsageReportsServiceEntityUsageReports *EntityUsageReportsServiceUserUsageReport *UserUsageReportService// contains filtered or unexported fields}

funcNewService¶added inv0.3.0

func NewService(ctxcontext.Context, opts ...option.ClientOption) (*Service,error)

NewService creates a new Service.

type UsageReport struct {// Date: Output only. The date of the report request.Datestring `json:"date,omitempty"`// Entity: Output only. Information about the type of the item.Entity *UsageReportEntity `json:"entity,omitempty"`// Etag: ETag of the resource.Etagstring `json:"etag,omitempty"`// Kind: The type of API resource. For a usage report, the value is// `admin#reports#usageReport`.Kindstring `json:"kind,omitempty"`// Parameters: Output only. Parameter value pairs for various applications. For// the Entity Usage Report parameters and values, see the Entity Usage// parameters reference// (https://developers.google.com/workspace/admin/reports/v1/reference/usage-ref-appendix-a/entities).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 or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (UsageReport)MarshalJSON¶

func (sUsageReport) MarshalJSON() ([]byte,error)

type UsageReportEntity struct {// CustomerId: Output only. The unique identifier of the customer's account.CustomerIdstring `json:"customerId,omitempty"`// EntityId: Output only. Object key. Only relevant if entity.type = "OBJECT"// Note: external-facing name of report is "Entities" rather than "Objects".EntityIdstring `json:"entityId,omitempty"`// ProfileId: Output only. The user's immutable Google Workspace profile// identifier.ProfileIdstring `json:"profileId,omitempty"`// Type: Output only. The type of item. The value is `user`.Typestring `json:"type,omitempty"`// UserEmail: Output only. The user's email address. Only relevant if// entity.type = "USER"UserEmailstring `json:"userEmail,omitempty"`// ForceSendFields is a list of field names (e.g. "CustomerId") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (UsageReportEntity)MarshalJSON¶

func (sUsageReportEntity) MarshalJSON() ([]byte,error)

type UsageReportParameters struct {// BoolValue: Output only. Boolean value of the parameter.BoolValuebool `json:"boolValue,omitempty"`// DatetimeValue: TheRFC 3339 formatted value of the parameter, for example// 2010-10-28T10:26:35.000Z.DatetimeValuestring `json:"datetimeValue,omitempty"`// IntValue: Output only. Integer value of the parameter.IntValueint64 `json:"intValue,omitempty,string"`// MsgValue: Output only. Nested message value of the parameter.MsgValue []googleapi.RawMessage `json:"msgValue,omitempty"`// Name: The name of the parameter. For the User Usage Report parameter names,// see the User Usage parameters reference.Namestring `json:"name,omitempty"`// StringValue: Output only. String value of the parameter.StringValuestring `json:"stringValue,omitempty"`// ForceSendFields is a list of field names (e.g. "BoolValue") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (UsageReportParameters)MarshalJSON¶

func (sUsageReportParameters) MarshalJSON() ([]byte,error)

type UsageReports struct {// Etag: ETag of the resource.Etagstring `json:"etag,omitempty"`// Kind: The type of API resource. For a usage report, the value is// `admin#reports#usageReports`.Kindstring `json:"kind,omitempty"`// NextPageToken: Token to specify next page. A report with multiple pages has// a `nextPageToken` property in the response. For your follow-on requests// getting all of the report's pages, enter the `nextPageToken` value in the// `pageToken` query string.NextPageTokenstring `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 or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (UsageReports)MarshalJSON¶

func (sUsageReports) MarshalJSON() ([]byte,error)

type UsageReportsWarnings struct {// Code: Machine readable code or warning type. The warning code value is// `200`.Codestring `json:"code,omitempty"`// Data: Key-value pairs to give detailed information on the warning.Data []*UsageReportsWarningsData `json:"data,omitempty"`// Message: The human readable messages for a warning are: - Data is not// available warning - Sorry, data for date yyyy-mm-dd for application// "application name" is not available. - Partial data is available warning -// Data for date yyyy-mm-dd for application "application name" is not// available right now, please try again after a few hours.Messagestring `json:"message,omitempty"`// ForceSendFields is a list of field names (e.g. "Code") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (UsageReportsWarnings)MarshalJSON¶

func (sUsageReportsWarnings) MarshalJSON() ([]byte,error)

type UsageReportsWarningsData struct {// Key: Key associated with a key-value pair to give detailed information on// the warning.Keystring `json:"key,omitempty"`// Value: Value associated with a key-value pair to give detailed information// on the warning.Valuestring `json:"value,omitempty"`// ForceSendFields is a list of field names (e.g. "Key") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (UsageReportsWarningsData)MarshalJSON¶

func (sUsageReportsWarningsData) MarshalJSON() ([]byte,error)

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

func (*UserUsageReportGetCall)Context¶

func (c *UserUsageReportGetCall) Context(ctxcontext.Context) *UserUsageReportGetCall

Context sets the context to be used in this call's Do method.

func (*UserUsageReportGetCall)CustomerId¶

func (c *UserUsageReportGetCall) CustomerId(customerIdstring) *UserUsageReportGetCall

CustomerId sets the optional parameter "customerId": The unique ID of thecustomer to retrieve data for.

func (*UserUsageReportGetCall)Do¶

func (c *UserUsageReportGetCall) Do(opts ...googleapi.CallOption) (*UsageReports,error)

Do executes the "reports.userUsageReport.get" call.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 checkwhether 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. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*UserUsageReportGetCall)Filters¶

func (c *UserUsageReportGetCall) Filters(filtersstring) *UserUsageReportGetCall

Filters sets the optional parameter "filters": The `filters` query string isa comma-separated list of an application's event parameters where theparameter's value is manipulated by a relational operator. The `filters`query string includes the name of the application whose usage is returned inthe report. The application values for the Users Usage Report include`accounts`, `chat`, `docs`, and `gmail`. Filters are in the form`[application name]:parameter name[parameter value],...`. In this example,the `<>` 'not equal to' operator is URL-encoded in the request's querystring (%3C%3E): GEThttps://www.googleapis.com/admin/reports/v1/usage/users/all/dates/2013-03-03?parameters=accounts:last_login_time&filters=accounts:last_login_time%3C%3E2010-10-28T10:26:35.000Z Therelational operators include: - `==` - 'equal to'. - `<>` - 'not equal to'.It is URL-encoded (%3C%3E). - `<` - 'less than'. It is URL-encoded (%3C). -`<=` - 'less than or equal to'. It is URL-encoded (%3C=). - `>` - 'greaterthan'. It is URL-encoded (%3E). - `>=` - 'greater than or equal to'. It isURL-encoded (%3E=).

func (*UserUsageReportGetCall)GroupIdFilter¶added inv0.34.0

func (c *UserUsageReportGetCall) GroupIdFilter(groupIdFilterstring) *UserUsageReportGetCall

GroupIdFilter sets the optional parameter "groupIdFilter": Comma separatedgroup ids (obfuscated) on which user activities are filtered, i.e. theresponse will contain activities for only those users that are a part of atleast one of the group ids mentioned here. Format: "id:abc123,id:xyz456"

func (*UserUsageReportGetCall)Header¶

func (c *UserUsageReportGetCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*UserUsageReportGetCall)IfNoneMatch¶

func (c *UserUsageReportGetCall) IfNoneMatch(entityTagstring) *UserUsageReportGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*UserUsageReportGetCall)MaxResults¶

func (c *UserUsageReportGetCall) MaxResults(maxResultsint64) *UserUsageReportGetCall

MaxResults sets the optional parameter "maxResults": Determines how manyactivity records are shown on each response page. For example, if therequest sets `maxResults=1` and the report has two activities, the reporthas two pages. The response's `nextPageToken` property has the token to thesecond page. The `maxResults` query string is optional.

func (*UserUsageReportGetCall)OrgUnitID¶

func (c *UserUsageReportGetCall) OrgUnitID(orgUnitIDstring) *UserUsageReportGetCall

OrgUnitID sets the optional parameter "orgUnitID": ID of the organizationalunit to report on. User activity will be shown only for users who belong tothe specified organizational unit. Data before Dec 17, 2018 doesn't appearin the filtered results.

func (*UserUsageReportGetCall)PageToken¶

func (c *UserUsageReportGetCall) PageToken(pageTokenstring) *UserUsageReportGetCall

PageToken sets the optional parameter "pageToken": Token to specify nextpage. A report with multiple pages has a `nextPageToken` property in theresponse. In your follow-on request getting the next page of the report,enter the `nextPageToken` value in the `pageToken` query string.

func (*UserUsageReportGetCall)Pages¶

func (c *UserUsageReportGetCall) Pages(ctxcontext.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(parametersstring) *UserUsageReportGetCall

Parameters sets the optional parameter "parameters": The `parameters` querystring is a comma-separated list of event parameters that refine a report'sresults. The parameter is associated with a specific application. Theapplication values for the Customers Usage report include `accounts`,`app_maker`, `apps_scripts`, `calendar`, `chat`, `classroom`, `cros`,`docs`, `gmail`, `gplus`, `device_management`, `meet`, and `sites`. A`parameters` query string is in the CSV form of `app_name1:param_name1,app_name2:param_name2`. *Note:* The API doesn't accept multiple values of aparameter. If a particular parameter is supplied more than once in the APIrequest, the API only accepts the last value of that request parameter. Inaddition, if an invalid request parameter is supplied in the API request,the API ignores that request parameter and returns the responsecorresponding to the remaining valid request parameters. An example of aninvalid request parameter is one that does not belong to the application. Ifno parameters are requested, all parameters are returned.

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

funcNewUserUsageReportService¶

func NewUserUsageReportService(s *Service) *UserUsageReportService

func (*UserUsageReportService)Get¶

func (r *UserUsageReportService) Get(userKeystring, datestring) *UserUsageReportGetCall

Get: Retrieves a report which is a collection of properties and statisticsfor a set of users with the account. For more information, see the UserUsage Report guide. For more information about the user report's parameters,see the Users Usage parameters reference guides.

• date: Represents the date the usage occurred, based on UTC-8:00 (PacificStandard Time). The timestamp is in the ISO 8601 format(https://en.wikipedia.org/wiki/ISO_8601), `yyyy-mm-dd`.
• userKey: Represents the profile ID or the user email for which the datashould be filtered. Can be `all` for all information, or `userKey` for auser's unique Google Workspace profile ID or their primary email address.Must not be a deleted user. For a deleted user, call `users.list` inDirectory API with `showDeleted=true`, then use the returned `ID` as the`userKey`.