gestione documentale avanzata 1 parte

This commit is contained in:
2026-05-28 09:34:28 +02:00
parent 3471befb1a
commit f2b0833b90
34482 changed files with 4312269 additions and 546 deletions
@@ -0,0 +1,115 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Reports;
class Activities extends \Google\Collection
{
protected $collection_key = 'items';
/**
* ETag of the resource.
*
* @var string
*/
public $etag;
protected $itemsType = Activity::class;
protected $itemsDataType = 'array';
/**
* The type of API resource. For an activity report, the value is
* `reports#activities`.
*
* @var string
*/
public $kind;
/**
* Token for retrieving the follow-on next page of the report. The
* `nextPageToken` value is used in the request's `pageToken` query string.
*
* @var string
*/
public $nextPageToken;
/**
* ETag of the resource.
*
* @param string $etag
*/
public function setEtag($etag)
{
$this->etag = $etag;
}
/**
* @return string
*/
public function getEtag()
{
return $this->etag;
}
/**
* Each activity record in the response.
*
* @param Activity[] $items
*/
public function setItems($items)
{
$this->items = $items;
}
/**
* @return Activity[]
*/
public function getItems()
{
return $this->items;
}
/**
* The type of API resource. For an activity report, the value is
* `reports#activities`.
*
* @param string $kind
*/
public function setKind($kind)
{
$this->kind = $kind;
}
/**
* @return string
*/
public function getKind()
{
return $this->kind;
}
/**
* Token for retrieving the follow-on next page of the report. The
* `nextPageToken` value is used in the request's `pageToken` query string.
*
* @param string $nextPageToken
*/
public function setNextPageToken($nextPageToken)
{
$this->nextPageToken = $nextPageToken;
}
/**
* @return string
*/
public function getNextPageToken()
{
return $this->nextPageToken;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Activities::class, 'Google_Service_Reports_Activities');
@@ -0,0 +1,217 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Reports;
class Activity extends \Google\Collection
{
protected $collection_key = 'resourceDetails';
protected $actorType = ActivityActor::class;
protected $actorDataType = '';
/**
* ETag of the entry.
*
* @var string
*/
public $etag;
protected $eventsType = ActivityEvents::class;
protected $eventsDataType = 'array';
protected $idType = ActivityId::class;
protected $idDataType = '';
/**
* 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.
*
* @var string
*/
public $ipAddress;
/**
* The type of API resource. For an activity report, the value is
* `audit#activity`.
*
* @var string
*/
public $kind;
protected $networkInfoType = ActivityNetworkInfo::class;
protected $networkInfoDataType = '';
/**
* 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.
*
* @var string
*/
public $ownerDomain;
protected $resourceDetailsType = ResourceDetails::class;
protected $resourceDetailsDataType = 'array';
/**
* User doing the action.
*
* @param ActivityActor $actor
*/
public function setActor(ActivityActor $actor)
{
$this->actor = $actor;
}
/**
* @return ActivityActor
*/
public function getActor()
{
return $this->actor;
}
/**
* ETag of the entry.
*
* @param string $etag
*/
public function setEtag($etag)
{
$this->etag = $etag;
}
/**
* @return string
*/
public function getEtag()
{
return $this->etag;
}
/**
* Activity events in the report.
*
* @param ActivityEvents[] $events
*/
public function setEvents($events)
{
$this->events = $events;
}
/**
* @return ActivityEvents[]
*/
public function getEvents()
{
return $this->events;
}
/**
* Unique identifier for each activity record.
*
* @param ActivityId $id
*/
public function setId(ActivityId $id)
{
$this->id = $id;
}
/**
* @return ActivityId
*/
public function getId()
{
return $this->id;
}
/**
* 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.
*
* @param string $ipAddress
*/
public function setIpAddress($ipAddress)
{
$this->ipAddress = $ipAddress;
}
/**
* @return string
*/
public function getIpAddress()
{
return $this->ipAddress;
}
/**
* The type of API resource. For an activity report, the value is
* `audit#activity`.
*
* @param string $kind
*/
public function setKind($kind)
{
$this->kind = $kind;
}
/**
* @return string
*/
public function getKind()
{
return $this->kind;
}
/**
* Network information of the user doing the action.
*
* @param ActivityNetworkInfo $networkInfo
*/
public function setNetworkInfo(ActivityNetworkInfo $networkInfo)
{
$this->networkInfo = $networkInfo;
}
/**
* @return ActivityNetworkInfo
*/
public function getNetworkInfo()
{
return $this->networkInfo;
}
/**
* 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.
*
* @param string $ownerDomain
*/
public function setOwnerDomain($ownerDomain)
{
$this->ownerDomain = $ownerDomain;
}
/**
* @return string
*/
public function getOwnerDomain()
{
return $this->ownerDomain;
}
/**
* Details of the resource on which the action was performed.
*
* @param ResourceDetails[] $resourceDetails
*/
public function setResourceDetails($resourceDetails)
{
$this->resourceDetails = $resourceDetails;
}
/**
* @return ResourceDetails[]
*/
public function getResourceDetails()
{
return $this->resourceDetails;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Activity::class, 'Google_Service_Reports_Activity');
@@ -0,0 +1,140 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Reports;
class ActivityActor extends \Google\Model
{
protected $applicationInfoType = ActivityActorApplicationInfo::class;
protected $applicationInfoDataType = '';
/**
* The type of actor.
*
* @var string
*/
public $callerType;
/**
* The primary email address of the actor. May be absent if there is no email
* address associated with the actor.
*
* @var string
*/
public $email;
/**
* 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.
*
* @var string
*/
public $key;
/**
* 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.
*
* @var string
*/
public $profileId;
/**
* Details of the application that was the actor for the activity.
*
* @param ActivityActorApplicationInfo $applicationInfo
*/
public function setApplicationInfo(ActivityActorApplicationInfo $applicationInfo)
{
$this->applicationInfo = $applicationInfo;
}
/**
* @return ActivityActorApplicationInfo
*/
public function getApplicationInfo()
{
return $this->applicationInfo;
}
/**
* The type of actor.
*
* @param string $callerType
*/
public function setCallerType($callerType)
{
$this->callerType = $callerType;
}
/**
* @return string
*/
public function getCallerType()
{
return $this->callerType;
}
/**
* The primary email address of the actor. May be absent if there is no email
* address associated with the actor.
*
* @param string $email
*/
public function setEmail($email)
{
$this->email = $email;
}
/**
* @return string
*/
public function getEmail()
{
return $this->email;
}
/**
* 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.
*
* @param string $key
*/
public function setKey($key)
{
$this->key = $key;
}
/**
* @return string
*/
public function getKey()
{
return $this->key;
}
/**
* 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.
*
* @param string $profileId
*/
public function setProfileId($profileId)
{
$this->profileId = $profileId;
}
/**
* @return string
*/
public function getProfileId()
{
return $this->profileId;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ActivityActor::class, 'Google_Service_Reports_ActivityActor');
@@ -0,0 +1,92 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Reports;
class ActivityActorApplicationInfo extends \Google\Model
{
/**
* Name of the application used to perform the action.
*
* @var string
*/
public $applicationName;
/**
* Whether the application was impersonating a user.
*
* @var bool
*/
public $impersonation;
/**
* OAuth client id of the third party application used to perform the action.
*
* @var string
*/
public $oauthClientId;
/**
* Name of the application used to perform the action.
*
* @param string $applicationName
*/
public function setApplicationName($applicationName)
{
$this->applicationName = $applicationName;
}
/**
* @return string
*/
public function getApplicationName()
{
return $this->applicationName;
}
/**
* Whether the application was impersonating a user.
*
* @param bool $impersonation
*/
public function setImpersonation($impersonation)
{
$this->impersonation = $impersonation;
}
/**
* @return bool
*/
public function getImpersonation()
{
return $this->impersonation;
}
/**
* OAuth client id of the third party application used to perform the action.
*
* @param string $oauthClientId
*/
public function setOauthClientId($oauthClientId)
{
$this->oauthClientId = $oauthClientId;
}
/**
* @return string
*/
public function getOauthClientId()
{
return $this->oauthClientId;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ActivityActorApplicationInfo::class, 'Google_Service_Reports_ActivityActorApplicationInfo');
@@ -0,0 +1,173 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Reports;
class ActivityEvents extends \Google\Collection
{
protected $collection_key = 'sensitiveParameters';
/**
* 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`.
*
* @var string
*/
public $name;
protected $parametersType = ActivityEventsParameters::class;
protected $parametersDataType = 'array';
/**
* Resource ids associated with the event.
*
* @var string[]
*/
public $resourceIds;
protected $sensitiveParametersType = ActivityEventsSensitiveParameters::class;
protected $sensitiveParametersDataType = 'array';
protected $statusType = ActivityEventsStatus::class;
protected $statusDataType = '';
/**
* 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`.
*
* @var string
*/
public $type;
/**
* 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`.
*
* @param string $name
*/
public function setName($name)
{
$this->name = $name;
}
/**
* @return string
*/
public function getName()
{
return $this->name;
}
/**
* Parameter value pairs for various applications. For more information about
* `eventName` parameters, see the list of event names for various
* applications above in `applicationName`.
*
* @param ActivityEventsParameters[] $parameters
*/
public function setParameters($parameters)
{
$this->parameters = $parameters;
}
/**
* @return ActivityEventsParameters[]
*/
public function getParameters()
{
return $this->parameters;
}
/**
* Resource ids associated with the event.
*
* @param string[] $resourceIds
*/
public function setResourceIds($resourceIds)
{
$this->resourceIds = $resourceIds;
}
/**
* @return string[]
*/
public function getResourceIds()
{
return $this->resourceIds;
}
/**
* Includes sensitive parameter value pairs for various applications.
*
* @param ActivityEventsSensitiveParameters[] $sensitiveParameters
*/
public function setSensitiveParameters($sensitiveParameters)
{
$this->sensitiveParameters = $sensitiveParameters;
}
/**
* @return ActivityEventsSensitiveParameters[]
*/
public function getSensitiveParameters()
{
return $this->sensitiveParameters;
}
/**
* Status of the event. Note: Not all events have status.
*
* @param ActivityEventsStatus $status
*/
public function setStatus(ActivityEventsStatus $status)
{
$this->status = $status;
}
/**
* @return ActivityEventsStatus
*/
public function getStatus()
{
return $this->status;
}
/**
* 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`.
*
* @param string $type
*/
public function setType($type)
{
$this->type = $type;
}
/**
* @return string
*/
public function getType()
{
return $this->type;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ActivityEvents::class, 'Google_Service_Reports_ActivityEvents');
@@ -0,0 +1,198 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Reports;
class ActivityEventsParameters extends \Google\Collection
{
protected $collection_key = 'multiValue';
/**
* Boolean value of the parameter.
*
* @var bool
*/
public $boolValue;
/**
* Integer value of the parameter.
*
* @var string
*/
public $intValue;
protected $messageValueType = ActivityEventsParametersMessageValue::class;
protected $messageValueDataType = '';
/**
* Integer values of the parameter.
*
* @var string[]
*/
public $multiIntValue;
protected $multiMessageValueType = ActivityEventsParametersMultiMessageValue::class;
protected $multiMessageValueDataType = 'array';
/**
* String values of the parameter.
*
* @var string[]
*/
public $multiValue;
/**
* The name of the parameter.
*
* @var string
*/
public $name;
/**
* String value of the parameter.
*
* @var string
*/
public $value;
/**
* Boolean value of the parameter.
*
* @param bool $boolValue
*/
public function setBoolValue($boolValue)
{
$this->boolValue = $boolValue;
}
/**
* @return bool
*/
public function getBoolValue()
{
return $this->boolValue;
}
/**
* Integer value of the parameter.
*
* @param string $intValue
*/
public function setIntValue($intValue)
{
$this->intValue = $intValue;
}
/**
* @return string
*/
public function getIntValue()
{
return $this->intValue;
}
/**
* 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}]}]`
*
* @param ActivityEventsParametersMessageValue $messageValue
*/
public function setMessageValue(ActivityEventsParametersMessageValue $messageValue)
{
$this->messageValue = $messageValue;
}
/**
* @return ActivityEventsParametersMessageValue
*/
public function getMessageValue()
{
return $this->messageValue;
}
/**
* Integer values of the parameter.
*
* @param string[] $multiIntValue
*/
public function setMultiIntValue($multiIntValue)
{
$this->multiIntValue = $multiIntValue;
}
/**
* @return string[]
*/
public function getMultiIntValue()
{
return $this->multiIntValue;
}
/**
* List of `messageValue` objects.
*
* @param ActivityEventsParametersMultiMessageValue[] $multiMessageValue
*/
public function setMultiMessageValue($multiMessageValue)
{
$this->multiMessageValue = $multiMessageValue;
}
/**
* @return ActivityEventsParametersMultiMessageValue[]
*/
public function getMultiMessageValue()
{
return $this->multiMessageValue;
}
/**
* String values of the parameter.
*
* @param string[] $multiValue
*/
public function setMultiValue($multiValue)
{
$this->multiValue = $multiValue;
}
/**
* @return string[]
*/
public function getMultiValue()
{
return $this->multiValue;
}
/**
* The name of the parameter.
*
* @param string $name
*/
public function setName($name)
{
$this->name = $name;
}
/**
* @return string
*/
public function getName()
{
return $this->name;
}
/**
* String value of the parameter.
*
* @param string $value
*/
public function setValue($value)
{
$this->value = $value;
}
/**
* @return string
*/
public function getValue()
{
return $this->value;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ActivityEventsParameters::class, 'Google_Service_Reports_ActivityEventsParameters');
@@ -0,0 +1,45 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Reports;
class ActivityEventsParametersMessageValue extends \Google\Collection
{
protected $collection_key = 'parameter';
protected $parameterType = NestedParameter::class;
protected $parameterDataType = 'array';
/**
* Parameter values
*
* @param NestedParameter[] $parameter
*/
public function setParameter($parameter)
{
$this->parameter = $parameter;
}
/**
* @return NestedParameter[]
*/
public function getParameter()
{
return $this->parameter;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ActivityEventsParametersMessageValue::class, 'Google_Service_Reports_ActivityEventsParametersMessageValue');
@@ -0,0 +1,45 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Reports;
class ActivityEventsParametersMultiMessageValue extends \Google\Collection
{
protected $collection_key = 'parameter';
protected $parameterType = NestedParameter::class;
protected $parameterDataType = 'array';
/**
* Parameter values
*
* @param NestedParameter[] $parameter
*/
public function setParameter($parameter)
{
$this->parameter = $parameter;
}
/**
* @return NestedParameter[]
*/
public function getParameter()
{
return $this->parameter;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ActivityEventsParametersMultiMessageValue::class, 'Google_Service_Reports_ActivityEventsParametersMultiMessageValue');
@@ -0,0 +1,198 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Reports;
class ActivityEventsSensitiveParameters extends \Google\Collection
{
protected $collection_key = 'multiValue';
/**
* Boolean value of the parameter.
*
* @var bool
*/
public $boolValue;
/**
* Integer value of the parameter.
*
* @var string
*/
public $intValue;
protected $messageValueType = ActivityEventsSensitiveParametersMessageValue::class;
protected $messageValueDataType = '';
/**
* Integer values of the parameter.
*
* @var string[]
*/
public $multiIntValue;
protected $multiMessageValueType = ActivityEventsSensitiveParametersMultiMessageValue::class;
protected $multiMessageValueDataType = 'array';
/**
* String values of the parameter.
*
* @var string[]
*/
public $multiValue;
/**
* The name of the parameter.
*
* @var string
*/
public $name;
/**
* String value of the parameter.
*
* @var string
*/
public $value;
/**
* Boolean value of the parameter.
*
* @param bool $boolValue
*/
public function setBoolValue($boolValue)
{
$this->boolValue = $boolValue;
}
/**
* @return bool
*/
public function getBoolValue()
{
return $this->boolValue;
}
/**
* Integer value of the parameter.
*
* @param string $intValue
*/
public function setIntValue($intValue)
{
$this->intValue = $intValue;
}
/**
* @return string
*/
public function getIntValue()
{
return $this->intValue;
}
/**
* 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}]}]`
*
* @param ActivityEventsSensitiveParametersMessageValue $messageValue
*/
public function setMessageValue(ActivityEventsSensitiveParametersMessageValue $messageValue)
{
$this->messageValue = $messageValue;
}
/**
* @return ActivityEventsSensitiveParametersMessageValue
*/
public function getMessageValue()
{
return $this->messageValue;
}
/**
* Integer values of the parameter.
*
* @param string[] $multiIntValue
*/
public function setMultiIntValue($multiIntValue)
{
$this->multiIntValue = $multiIntValue;
}
/**
* @return string[]
*/
public function getMultiIntValue()
{
return $this->multiIntValue;
}
/**
* List of `messageValue` objects.
*
* @param ActivityEventsSensitiveParametersMultiMessageValue[] $multiMessageValue
*/
public function setMultiMessageValue($multiMessageValue)
{
$this->multiMessageValue = $multiMessageValue;
}
/**
* @return ActivityEventsSensitiveParametersMultiMessageValue[]
*/
public function getMultiMessageValue()
{
return $this->multiMessageValue;
}
/**
* String values of the parameter.
*
* @param string[] $multiValue
*/
public function setMultiValue($multiValue)
{
$this->multiValue = $multiValue;
}
/**
* @return string[]
*/
public function getMultiValue()
{
return $this->multiValue;
}
/**
* The name of the parameter.
*
* @param string $name
*/
public function setName($name)
{
$this->name = $name;
}
/**
* @return string
*/
public function getName()
{
return $this->name;
}
/**
* String value of the parameter.
*
* @param string $value
*/
public function setValue($value)
{
$this->value = $value;
}
/**
* @return string
*/
public function getValue()
{
return $this->value;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ActivityEventsSensitiveParameters::class, 'Google_Service_Reports_ActivityEventsSensitiveParameters');
@@ -0,0 +1,45 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Reports;
class ActivityEventsSensitiveParametersMessageValue extends \Google\Collection
{
protected $collection_key = 'parameter';
protected $parameterType = NestedParameter::class;
protected $parameterDataType = 'array';
/**
* Parameter values
*
* @param NestedParameter[] $parameter
*/
public function setParameter($parameter)
{
$this->parameter = $parameter;
}
/**
* @return NestedParameter[]
*/
public function getParameter()
{
return $this->parameter;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ActivityEventsSensitiveParametersMessageValue::class, 'Google_Service_Reports_ActivityEventsSensitiveParametersMessageValue');
@@ -0,0 +1,45 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Reports;
class ActivityEventsSensitiveParametersMultiMessageValue extends \Google\Collection
{
protected $collection_key = 'parameter';
protected $parameterType = NestedParameter::class;
protected $parameterDataType = 'array';
/**
* Parameter values
*
* @param NestedParameter[] $parameter
*/
public function setParameter($parameter)
{
$this->parameter = $parameter;
}
/**
* @return NestedParameter[]
*/
public function getParameter()
{
return $this->parameter;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ActivityEventsSensitiveParametersMultiMessageValue::class, 'Google_Service_Reports_ActivityEventsSensitiveParametersMultiMessageValue');
@@ -0,0 +1,116 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Reports;
class ActivityEventsStatus extends \Google\Model
{
/**
* Error code of the event. Note: Field can be empty.
*
* @var string
*/
public $errorCode;
/**
* Error message of the event. Note: Field can be empty.
*
* @var string
*/
public $errorMessage;
/**
* Status of the event. Possible values if not empty: - UNKNOWN_EVENT_STATUS -
* SUCCEEDED - SUCCEEDED_WITH_WARNINGS - FAILED - SKIPPED
*
* @var string
*/
public $eventStatus;
/**
* Status code of the event. Note: Field can be empty.
*
* @var int
*/
public $httpStatusCode;
/**
* Error code of the event. Note: Field can be empty.
*
* @param string $errorCode
*/
public function setErrorCode($errorCode)
{
$this->errorCode = $errorCode;
}
/**
* @return string
*/
public function getErrorCode()
{
return $this->errorCode;
}
/**
* Error message of the event. Note: Field can be empty.
*
* @param string $errorMessage
*/
public function setErrorMessage($errorMessage)
{
$this->errorMessage = $errorMessage;
}
/**
* @return string
*/
public function getErrorMessage()
{
return $this->errorMessage;
}
/**
* Status of the event. Possible values if not empty: - UNKNOWN_EVENT_STATUS -
* SUCCEEDED - SUCCEEDED_WITH_WARNINGS - FAILED - SKIPPED
*
* @param string $eventStatus
*/
public function setEventStatus($eventStatus)
{
$this->eventStatus = $eventStatus;
}
/**
* @return string
*/
public function getEventStatus()
{
return $this->eventStatus;
}
/**
* Status code of the event. Note: Field can be empty.
*
* @param int $httpStatusCode
*/
public function setHttpStatusCode($httpStatusCode)
{
$this->httpStatusCode = $httpStatusCode;
}
/**
* @return int
*/
public function getHttpStatusCode()
{
return $this->httpStatusCode;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ActivityEventsStatus::class, 'Google_Service_Reports_ActivityEventsStatus');
@@ -0,0 +1,116 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Reports;
class ActivityId extends \Google\Model
{
/**
* Application name to which the event belongs. For possible values see the
* list of applications above in `applicationName`.
*
* @var string
*/
public $applicationName;
/**
* The unique identifier for a Google Workspace account.
*
* @var string
*/
public $customerId;
/**
* Time of occurrence of the activity. This is in UNIX epoch time in seconds.
*
* @var string
*/
public $time;
/**
* Unique qualifier if multiple events have the same time.
*
* @var string
*/
public $uniqueQualifier;
/**
* Application name to which the event belongs. For possible values see the
* list of applications above in `applicationName`.
*
* @param string $applicationName
*/
public function setApplicationName($applicationName)
{
$this->applicationName = $applicationName;
}
/**
* @return string
*/
public function getApplicationName()
{
return $this->applicationName;
}
/**
* The unique identifier for a Google Workspace account.
*
* @param string $customerId
*/
public function setCustomerId($customerId)
{
$this->customerId = $customerId;
}
/**
* @return string
*/
public function getCustomerId()
{
return $this->customerId;
}
/**
* Time of occurrence of the activity. This is in UNIX epoch time in seconds.
*
* @param string $time
*/
public function setTime($time)
{
$this->time = $time;
}
/**
* @return string
*/
public function getTime()
{
return $this->time;
}
/**
* Unique qualifier if multiple events have the same time.
*
* @param string $uniqueQualifier
*/
public function setUniqueQualifier($uniqueQualifier)
{
$this->uniqueQualifier = $uniqueQualifier;
}
/**
* @return string
*/
public function getUniqueQualifier()
{
return $this->uniqueQualifier;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ActivityId::class, 'Google_Service_Reports_ActivityId');
@@ -0,0 +1,95 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Reports;
class ActivityNetworkInfo extends \Google\Collection
{
protected $collection_key = 'ipAsn';
/**
* IP Address of the user doing the action.
*
* @var int[]
*/
public $ipAsn;
/**
* ISO 3166-1 alpha-2 region code of the user doing the action.
*
* @var string
*/
public $regionCode;
/**
* ISO 3166-2 region code (states and provinces) for countries of the user
* doing the action.
*
* @var string
*/
public $subdivisionCode;
/**
* IP Address of the user doing the action.
*
* @param int[] $ipAsn
*/
public function setIpAsn($ipAsn)
{
$this->ipAsn = $ipAsn;
}
/**
* @return int[]
*/
public function getIpAsn()
{
return $this->ipAsn;
}
/**
* ISO 3166-1 alpha-2 region code of the user doing the action.
*
* @param string $regionCode
*/
public function setRegionCode($regionCode)
{
$this->regionCode = $regionCode;
}
/**
* @return string
*/
public function getRegionCode()
{
return $this->regionCode;
}
/**
* ISO 3166-2 region code (states and provinces) for countries of the user
* doing the action.
*
* @param string $subdivisionCode
*/
public function setSubdivisionCode($subdivisionCode)
{
$this->subdivisionCode = $subdivisionCode;
}
/**
* @return string
*/
public function getSubdivisionCode()
{
return $this->subdivisionCode;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ActivityNetworkInfo::class, 'Google_Service_Reports_ActivityNetworkInfo');
@@ -0,0 +1,111 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Reports;
class AppliedLabel extends \Google\Collection
{
protected $collection_key = 'fieldValues';
protected $fieldValuesType = FieldValue::class;
protected $fieldValuesDataType = 'array';
/**
* Identifier of the label - Only the label id, not the full OnePlatform
* resource name.
*
* @var string
*/
public $id;
protected $reasonType = Reason::class;
protected $reasonDataType = '';
/**
* Title of the label
*
* @var string
*/
public $title;
/**
* 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.
*
* @param FieldValue[] $fieldValues
*/
public function setFieldValues($fieldValues)
{
$this->fieldValues = $fieldValues;
}
/**
* @return FieldValue[]
*/
public function getFieldValues()
{
return $this->fieldValues;
}
/**
* Identifier of the label - Only the label id, not the full OnePlatform
* resource name.
*
* @param string $id
*/
public function setId($id)
{
$this->id = $id;
}
/**
* @return string
*/
public function getId()
{
return $this->id;
}
/**
* The reason why the label was applied on the resource.
*
* @param Reason $reason
*/
public function setReason(Reason $reason)
{
$this->reason = $reason;
}
/**
* @return Reason
*/
public function getReason()
{
return $this->reason;
}
/**
* Title of the label
*
* @param string $title
*/
public function setTitle($title)
{
$this->title = $title;
}
/**
* @return string
*/
public function getTitle()
{
return $this->title;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(AppliedLabel::class, 'Google_Service_Reports_AppliedLabel');
+260
View File
@@ -0,0 +1,260 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Reports;
class Channel extends \Google\Model
{
/**
* The address where notifications are delivered for this channel.
*
* @var string
*/
public $address;
/**
* Date and time of notification channel expiration, expressed as a Unix
* timestamp, in milliseconds. Optional.
*
* @var string
*/
public $expiration;
/**
* A UUID or similar unique string that identifies this channel.
*
* @var string
*/
public $id;
/**
* Identifies this as a notification channel used to watch for changes to a
* resource, which is "`api#channel`".
*
* @var string
*/
public $kind;
/**
* Additional parameters controlling delivery channel behavior. Optional.
*
* @var string[]
*/
public $params;
/**
* 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.
*
* @var bool
*/
public $payload;
/**
* An opaque ID that identifies the resource being watched on this channel.
* Stable across different API versions.
*
* @var string
*/
public $resourceId;
/**
* A version-specific identifier for the watched resource.
*
* @var string
*/
public $resourceUri;
/**
* An arbitrary string delivered to the target address with each notification
* delivered over this channel. Optional.
*
* @var string
*/
public $token;
/**
* The type of delivery mechanism used for this channel. The value should be
* set to `"web_hook"`.
*
* @var string
*/
public $type;
/**
* The address where notifications are delivered for this channel.
*
* @param string $address
*/
public function setAddress($address)
{
$this->address = $address;
}
/**
* @return string
*/
public function getAddress()
{
return $this->address;
}
/**
* Date and time of notification channel expiration, expressed as a Unix
* timestamp, in milliseconds. Optional.
*
* @param string $expiration
*/
public function setExpiration($expiration)
{
$this->expiration = $expiration;
}
/**
* @return string
*/
public function getExpiration()
{
return $this->expiration;
}
/**
* A UUID or similar unique string that identifies this channel.
*
* @param string $id
*/
public function setId($id)
{
$this->id = $id;
}
/**
* @return string
*/
public function getId()
{
return $this->id;
}
/**
* Identifies this as a notification channel used to watch for changes to a
* resource, which is "`api#channel`".
*
* @param string $kind
*/
public function setKind($kind)
{
$this->kind = $kind;
}
/**
* @return string
*/
public function getKind()
{
return $this->kind;
}
/**
* Additional parameters controlling delivery channel behavior. Optional.
*
* @param string[] $params
*/
public function setParams($params)
{
$this->params = $params;
}
/**
* @return string[]
*/
public function getParams()
{
return $this->params;
}
/**
* 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.
*
* @param bool $payload
*/
public function setPayload($payload)
{
$this->payload = $payload;
}
/**
* @return bool
*/
public function getPayload()
{
return $this->payload;
}
/**
* An opaque ID that identifies the resource being watched on this channel.
* Stable across different API versions.
*
* @param string $resourceId
*/
public function setResourceId($resourceId)
{
$this->resourceId = $resourceId;
}
/**
* @return string
*/
public function getResourceId()
{
return $this->resourceId;
}
/**
* A version-specific identifier for the watched resource.
*
* @param string $resourceUri
*/
public function setResourceUri($resourceUri)
{
$this->resourceUri = $resourceUri;
}
/**
* @return string
*/
public function getResourceUri()
{
return $this->resourceUri;
}
/**
* An arbitrary string delivered to the target address with each notification
* delivered over this channel. Optional.
*
* @param string $token
*/
public function setToken($token)
{
$this->token = $token;
}
/**
* @return string
*/
public function getToken()
{
return $this->token;
}
/**
* The type of delivery mechanism used for this channel. The value should be
* set to `"web_hook"`.
*
* @param string $type
*/
public function setType($type)
{
$this->type = $type;
}
/**
* @return string
*/
public function getType()
{
return $this->type;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Channel::class, 'Google_Service_Reports_Channel');
@@ -0,0 +1,48 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Reports;
class CustomerIdentity extends \Google\Model
{
/**
* Customer id.
*
* @var string
*/
public $id;
/**
* Customer id.
*
* @param string $id
*/
public function setId($id)
{
$this->id = $id;
}
/**
* @return string
*/
public function getId()
{
return $this->id;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(CustomerIdentity::class, 'Google_Service_Reports_CustomerIdentity');
+100
View File
@@ -0,0 +1,100 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Reports;
class Date extends \Google\Model
{
/**
* 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.
*
* @var int
*/
public $day;
/**
* Month of a year. Must be from 1 to 12, or 0 to specify a year without a
* month and day.
*
* @var int
*/
public $month;
/**
* Year of the date. Must be from 1 to 9999, or 0 to specify a date without a
* year.
*
* @var int
*/
public $year;
/**
* 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.
*
* @param int $day
*/
public function setDay($day)
{
$this->day = $day;
}
/**
* @return int
*/
public function getDay()
{
return $this->day;
}
/**
* Month of a year. Must be from 1 to 12, or 0 to specify a year without a
* month and day.
*
* @param int $month
*/
public function setMonth($month)
{
$this->month = $month;
}
/**
* @return int
*/
public function getMonth()
{
return $this->month;
}
/**
* Year of the date. Must be from 1 to 9999, or 0 to specify a date without a
* year.
*
* @param int $year
*/
public function setYear($year)
{
$this->year = $year;
}
/**
* @return int
*/
public function getYear()
{
return $this->year;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Date::class, 'Google_Service_Reports_Date');
@@ -0,0 +1,307 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Reports;
class FieldValue extends \Google\Model
{
protected $dateValueType = Date::class;
protected $dateValueDataType = '';
/**
* Display name of the field
*
* @var string
*/
public $displayName;
/**
* Identifier of the field
*
* @var string
*/
public $id;
/**
* Setting an integer value.
*
* @var string
*/
public $integerValue;
/**
* Setting a long text value.
*
* @var string
*/
public $longTextValue;
protected $reasonType = Reason::class;
protected $reasonDataType = '';
protected $selectionListValueType = FieldValueSelectionListValue::class;
protected $selectionListValueDataType = '';
protected $selectionValueType = FieldValueSelectionValue::class;
protected $selectionValueDataType = '';
protected $textListValueType = FieldValueTextListValue::class;
protected $textListValueDataType = '';
/**
* Setting a text value.
*
* @var string
*/
public $textValue;
/**
* Type of the field
*
* @var string
*/
public $type;
/**
* If the field is unset, this will be true.
*
* @var bool
*/
public $unsetValue;
protected $userListValueType = FieldValueUserListValue::class;
protected $userListValueDataType = '';
protected $userValueType = FieldValueUserValue::class;
protected $userValueDataType = '';
/**
* Setting a date value.
*
* @param Date $dateValue
*/
public function setDateValue(Date $dateValue)
{
$this->dateValue = $dateValue;
}
/**
* @return Date
*/
public function getDateValue()
{
return $this->dateValue;
}
/**
* Display name of the field
*
* @param string $displayName
*/
public function setDisplayName($displayName)
{
$this->displayName = $displayName;
}
/**
* @return string
*/
public function getDisplayName()
{
return $this->displayName;
}
/**
* Identifier of the field
*
* @param string $id
*/
public function setId($id)
{
$this->id = $id;
}
/**
* @return string
*/
public function getId()
{
return $this->id;
}
/**
* Setting an integer value.
*
* @param string $integerValue
*/
public function setIntegerValue($integerValue)
{
$this->integerValue = $integerValue;
}
/**
* @return string
*/
public function getIntegerValue()
{
return $this->integerValue;
}
/**
* Setting a long text value.
*
* @param string $longTextValue
*/
public function setLongTextValue($longTextValue)
{
$this->longTextValue = $longTextValue;
}
/**
* @return string
*/
public function getLongTextValue()
{
return $this->longTextValue;
}
/**
* The reason why the field was applied to the label.
*
* @param Reason $reason
*/
public function setReason(Reason $reason)
{
$this->reason = $reason;
}
/**
* @return Reason
*/
public function getReason()
{
return $this->reason;
}
/**
* Setting a selection list value by selecting multiple values from a
* dropdown.
*
* @param FieldValueSelectionListValue $selectionListValue
*/
public function setSelectionListValue(FieldValueSelectionListValue $selectionListValue)
{
$this->selectionListValue = $selectionListValue;
}
/**
* @return FieldValueSelectionListValue
*/
public function getSelectionListValue()
{
return $this->selectionListValue;
}
/**
* Setting a selection value by selecting a single value from a dropdown.
*
* @param FieldValueSelectionValue $selectionValue
*/
public function setSelectionValue(FieldValueSelectionValue $selectionValue)
{
$this->selectionValue = $selectionValue;
}
/**
* @return FieldValueSelectionValue
*/
public function getSelectionValue()
{
return $this->selectionValue;
}
/**
* Setting a text list value.
*
* @param FieldValueTextListValue $textListValue
*/
public function setTextListValue(FieldValueTextListValue $textListValue)
{
$this->textListValue = $textListValue;
}
/**
* @return FieldValueTextListValue
*/
public function getTextListValue()
{
return $this->textListValue;
}
/**
* Setting a text value.
*
* @param string $textValue
*/
public function setTextValue($textValue)
{
$this->textValue = $textValue;
}
/**
* @return string
*/
public function getTextValue()
{
return $this->textValue;
}
/**
* Type of the field
*
* @param string $type
*/
public function setType($type)
{
$this->type = $type;
}
/**
* @return string
*/
public function getType()
{
return $this->type;
}
/**
* If the field is unset, this will be true.
*
* @param bool $unsetValue
*/
public function setUnsetValue($unsetValue)
{
$this->unsetValue = $unsetValue;
}
/**
* @return bool
*/
public function getUnsetValue()
{
return $this->unsetValue;
}
/**
* Setting a user list value by selecting multiple users.
*
* @param FieldValueUserListValue $userListValue
*/
public function setUserListValue(FieldValueUserListValue $userListValue)
{
$this->userListValue = $userListValue;
}
/**
* @return FieldValueUserListValue
*/
public function getUserListValue()
{
return $this->userListValue;
}
/**
* Setting a user value by selecting a single user.
*
* @param FieldValueUserValue $userValue
*/
public function setUserValue(FieldValueUserValue $userValue)
{
$this->userValue = $userValue;
}
/**
* @return FieldValueUserValue
*/
public function getUserValue()
{
return $this->userValue;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(FieldValue::class, 'Google_Service_Reports_FieldValue');
@@ -0,0 +1,45 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Reports;
class FieldValueSelectionListValue extends \Google\Collection
{
protected $collection_key = 'values';
protected $valuesType = FieldValueSelectionValue::class;
protected $valuesDataType = 'array';
/**
* List of selections.
*
* @param FieldValueSelectionValue[] $values
*/
public function setValues($values)
{
$this->values = $values;
}
/**
* @return FieldValueSelectionValue[]
*/
public function getValues()
{
return $this->values;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(FieldValueSelectionListValue::class, 'Google_Service_Reports_FieldValueSelectionListValue');
@@ -0,0 +1,92 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Reports;
class FieldValueSelectionValue extends \Google\Model
{
/**
* Whether the selection is badged.
*
* @var bool
*/
public $badged;
/**
* Display name of the selection.
*
* @var string
*/
public $displayName;
/**
* Identifier of the selection.
*
* @var string
*/
public $id;
/**
* Whether the selection is badged.
*
* @param bool $badged
*/
public function setBadged($badged)
{
$this->badged = $badged;
}
/**
* @return bool
*/
public function getBadged()
{
return $this->badged;
}
/**
* Display name of the selection.
*
* @param string $displayName
*/
public function setDisplayName($displayName)
{
$this->displayName = $displayName;
}
/**
* @return string
*/
public function getDisplayName()
{
return $this->displayName;
}
/**
* Identifier of the selection.
*
* @param string $id
*/
public function setId($id)
{
$this->id = $id;
}
/**
* @return string
*/
public function getId()
{
return $this->id;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(FieldValueSelectionValue::class, 'Google_Service_Reports_FieldValueSelectionValue');
@@ -0,0 +1,49 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Reports;
class FieldValueTextListValue extends \Google\Collection
{
protected $collection_key = 'values';
/**
* List of text values.
*
* @var string[]
*/
public $values;
/**
* List of text values.
*
* @param string[] $values
*/
public function setValues($values)
{
$this->values = $values;
}
/**
* @return string[]
*/
public function getValues()
{
return $this->values;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(FieldValueTextListValue::class, 'Google_Service_Reports_FieldValueTextListValue');
@@ -0,0 +1,45 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Reports;
class FieldValueUserListValue extends \Google\Collection
{
protected $collection_key = 'values';
protected $valuesType = FieldValueUserValue::class;
protected $valuesDataType = 'array';
/**
* List of users.
*
* @param FieldValueUserValue[] $values
*/
public function setValues($values)
{
$this->values = $values;
}
/**
* @return FieldValueUserValue[]
*/
public function getValues()
{
return $this->values;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(FieldValueUserListValue::class, 'Google_Service_Reports_FieldValueUserListValue');
@@ -0,0 +1,48 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Reports;
class FieldValueUserValue extends \Google\Model
{
/**
* Email of the user.
*
* @var string
*/
public $email;
/**
* Email of the user.
*
* @param string $email
*/
public function setEmail($email)
{
$this->email = $email;
}
/**
* @return string
*/
public function getEmail()
{
return $this->email;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(FieldValueUserValue::class, 'Google_Service_Reports_FieldValueUserValue');
@@ -0,0 +1,70 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Reports;
class GroupIdentity extends \Google\Model
{
/**
* Group email.
*
* @var string
*/
public $groupEmail;
/**
* Group gaia id.
*
* @var string
*/
public $id;
/**
* Group email.
*
* @param string $groupEmail
*/
public function setGroupEmail($groupEmail)
{
$this->groupEmail = $groupEmail;
}
/**
* @return string
*/
public function getGroupEmail()
{
return $this->groupEmail;
}
/**
* Group gaia id.
*
* @param string $id
*/
public function setId($id)
{
$this->id = $id;
}
/**
* @return string
*/
public function getId()
{
return $this->id;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GroupIdentity::class, 'Google_Service_Reports_GroupIdentity');
@@ -0,0 +1,181 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Reports;
class NestedParameter extends \Google\Collection
{
protected $collection_key = 'multiValue';
/**
* Boolean value of the parameter.
*
* @var bool
*/
public $boolValue;
/**
* Integer value of the parameter.
*
* @var string
*/
public $intValue;
/**
* Multiple boolean values of the parameter.
*
* @var bool[]
*/
public $multiBoolValue;
/**
* Multiple integer values of the parameter.
*
* @var string[]
*/
public $multiIntValue;
/**
* Multiple string values of the parameter.
*
* @var string[]
*/
public $multiValue;
/**
* The name of the parameter.
*
* @var string
*/
public $name;
/**
* String value of the parameter.
*
* @var string
*/
public $value;
/**
* Boolean value of the parameter.
*
* @param bool $boolValue
*/
public function setBoolValue($boolValue)
{
$this->boolValue = $boolValue;
}
/**
* @return bool
*/
public function getBoolValue()
{
return $this->boolValue;
}
/**
* Integer value of the parameter.
*
* @param string $intValue
*/
public function setIntValue($intValue)
{
$this->intValue = $intValue;
}
/**
* @return string
*/
public function getIntValue()
{
return $this->intValue;
}
/**
* Multiple boolean values of the parameter.
*
* @param bool[] $multiBoolValue
*/
public function setMultiBoolValue($multiBoolValue)
{
$this->multiBoolValue = $multiBoolValue;
}
/**
* @return bool[]
*/
public function getMultiBoolValue()
{
return $this->multiBoolValue;
}
/**
* Multiple integer values of the parameter.
*
* @param string[] $multiIntValue
*/
public function setMultiIntValue($multiIntValue)
{
$this->multiIntValue = $multiIntValue;
}
/**
* @return string[]
*/
public function getMultiIntValue()
{
return $this->multiIntValue;
}
/**
* Multiple string values of the parameter.
*
* @param string[] $multiValue
*/
public function setMultiValue($multiValue)
{
$this->multiValue = $multiValue;
}
/**
* @return string[]
*/
public function getMultiValue()
{
return $this->multiValue;
}
/**
* The name of the parameter.
*
* @param string $name
*/
public function setName($name)
{
$this->name = $name;
}
/**
* @return string
*/
public function getName()
{
return $this->name;
}
/**
* String value of the parameter.
*
* @param string $value
*/
public function setValue($value)
{
$this->value = $value;
}
/**
* @return string
*/
public function getValue()
{
return $this->value;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(NestedParameter::class, 'Google_Service_Reports_NestedParameter');
@@ -0,0 +1,67 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Reports;
class OwnerDetails extends \Google\Collection
{
protected $collection_key = 'ownerIdentity';
protected $ownerIdentityType = OwnerIdentity::class;
protected $ownerIdentityDataType = 'array';
/**
* Type of the owner of the resource.
*
* @var string
*/
public $ownerType;
/**
* Identity details of the owner(s) of the resource.
*
* @param OwnerIdentity[] $ownerIdentity
*/
public function setOwnerIdentity($ownerIdentity)
{
$this->ownerIdentity = $ownerIdentity;
}
/**
* @return OwnerIdentity[]
*/
public function getOwnerIdentity()
{
return $this->ownerIdentity;
}
/**
* Type of the owner of the resource.
*
* @param string $ownerType
*/
public function setOwnerType($ownerType)
{
$this->ownerType = $ownerType;
}
/**
* @return string
*/
public function getOwnerType()
{
return $this->ownerType;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(OwnerDetails::class, 'Google_Service_Reports_OwnerDetails');
@@ -0,0 +1,80 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Reports;
class OwnerIdentity extends \Google\Model
{
protected $customerIdentityType = CustomerIdentity::class;
protected $customerIdentityDataType = '';
protected $groupIdentityType = GroupIdentity::class;
protected $groupIdentityDataType = '';
protected $userIdentityType = UserIdentity::class;
protected $userIdentityDataType = '';
/**
* Identity of the Google Workspace customer who owns the resource.
*
* @param CustomerIdentity $customerIdentity
*/
public function setCustomerIdentity(CustomerIdentity $customerIdentity)
{
$this->customerIdentity = $customerIdentity;
}
/**
* @return CustomerIdentity
*/
public function getCustomerIdentity()
{
return $this->customerIdentity;
}
/**
* Identity of the group who owns the resource.
*
* @param GroupIdentity $groupIdentity
*/
public function setGroupIdentity(GroupIdentity $groupIdentity)
{
$this->groupIdentity = $groupIdentity;
}
/**
* @return GroupIdentity
*/
public function getGroupIdentity()
{
return $this->groupIdentity;
}
/**
* Identity of the user who owns the resource.
*
* @param UserIdentity $userIdentity
*/
public function setUserIdentity(UserIdentity $userIdentity)
{
$this->userIdentity = $userIdentity;
}
/**
* @return UserIdentity
*/
public function getUserIdentity()
{
return $this->userIdentity;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(OwnerIdentity::class, 'Google_Service_Reports_OwnerIdentity');
+48
View File
@@ -0,0 +1,48 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Reports;
class Reason extends \Google\Model
{
/**
* The type of the reason.
*
* @var string
*/
public $reasonType;
/**
* The type of the reason.
*
* @param string $reasonType
*/
public function setReasonType($reasonType)
{
$this->reasonType = $reasonType;
}
/**
* @return string
*/
public function getReasonType()
{
return $this->reasonType;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Reason::class, 'Google_Service_Reports_Reason');
@@ -0,0 +1,324 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Reports\Resource;
use Google\Service\Reports\Activities as ActivitiesModel;
use Google\Service\Reports\Channel;
/**
* The "activities" collection of methods.
* Typical usage is:
* <code>
* $adminService = new Google\Service\Reports(...);
* $activities = $adminService->activities;
* </code>
*/
class Activities extends \Google\Service\Resource
{
/**
* Retrieves a list of activities for a specific customer's account and
* application such as the Admin console application or the Google Drive
* application. For more information, see the guides for administrator and
* Google Drive activity reports. For more information about the activity
* report's parameters, see the activity parameters reference guides.
* (activities.listActivities)
*
* @param string $userKey Represents the profile ID or the user email for which
* the data should be filtered. Can be `all` for all information, or `userKey`
* for a user's unique Google Workspace profile ID or their primary email
* address. Must not be a deleted user. For a deleted user, call `users.list` in
* Directory API with `showDeleted=true`, then use the returned `ID` as the
* `userKey`.
* @param string $applicationName Application name for which the events are to
* be retrieved.
* @param array $optParams Optional parameters.
*
* @opt_param string actorIpAddress The Internet Protocol (IP) Address of host
* where the event was performed. This is an additional way to filter a report's
* summary using the IP address of the user whose activity is being reported.
* This IP address 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. This parameter supports both IPv4 and IPv6
* address versions.
* @opt_param string applicationInfoFilter Optional. Used to filter on the
* `oAuthClientId` field present in [`ApplicationInfo`](#applicationinfo)
* message. **Usage** ``` GET...&applicationInfoFilter=oAuthClientId="clientId"
* GET...&applicationInfoFilter=oAuthClientId=%22clientId%22 ```
* @opt_param string customerId The unique ID of the customer to retrieve data
* for.
* @opt_param string endTime Sets the end of the range of time shown in the
* report. The date is in the RFC 3339 format, for example
* 2010-10-28T10:26:35.000Z. The default value is the approximate time of the
* API request. An API report has three basic time concepts: - *Date of the
* API'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 current time
* when the request is made, or the API returns an error. - *Report's end time*:
* The end of the timespan shown in the report. For example, the timespan 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 not specified, the
* report returns all activities from the `startTime` until the current time or
* the most recent 180 days if the `startTime` is more than 180 days in the
* past. For Gmail requests, `startTime` and `endTime` must be provided and the
* difference must not be greater than 30 days.
* @opt_param string eventName The name of the event being queried by the API.
* Each `eventName` is related to a specific Google Workspace service or feature
* which the API organizes into types of events. An example is the Google
* Calendar events in the Admin console application's reports. The Calendar
* Settings `type` structure has all of the Calendar `eventName` activities
* reported by the API. When an administrator changes a Calendar 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 various applications above in
* `applicationName`.
* @opt_param string filters The `filters` query string is a comma-separated
* list composed of event parameters manipulated by relational operators. Event
* parameters are in the form `{parameter1 name}{relational operator}{parameter1
* value},{parameter2 name}{relational operator}{parameter2 value},...` These
* event parameters are associated with a specific `eventName`. An empty report
* is returned if the request's parameter doesn't belong to the `eventName`. For
* more information about the available `eventName` fields for each application
* and their associated parameters, go to the
* [ApplicationName](#applicationname) table, then click through to the Activity
* Events page in the Appendix for the application you want. In the following
* Drive activity examples, the returned list consists of all `edit` events
* where the `doc_id` parameter value matches the conditions defined by the
* relational operator. In the first example, the request 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 in the request's query string
* (`%3C%3E`): ``` GET...&eventName=edit&filters=doc_id==12345
* GET...&eventName=edit&filters=doc_id%3C%3E98765 ``` A `filters` query
* supports these relational operators: * `==`—'equal to'. * `<>`—'not equal
* to'. Must be URL-encoded (%3C%3E). * `<`—'less than'. Must be URL-encoded
* (%3C). * `<=`—'less than or equal to'. Must be URL-encoded (%3C=). *
* `>`—'greater than'. Must be URL-encoded (%3E). * `>=`—'greater than or equal
* to'. Must be URL-encoded (%3E=). **Note:** The API doesn't accept multiple
* values of the same parameter. If a parameter is supplied more than once in
* the API request, the API only accepts the last value of that parameter. In
* addition, if an invalid parameter is supplied in the API request, the API
* ignores that parameter and returns the response corresponding to the
* remaining valid parameters. If no parameters are requested, all parameters
* are returned.
* @opt_param string groupIdFilter Comma separated group ids (obfuscated) on
* which user activities are filtered, i.e. the response will contain activities
* for only those users that are a part of at least one of the group ids
* mentioned here. Format: "id:abc123,id:xyz456" *Important:* To filter by
* groups, you must explicitly add the groups to your filtering groups
* allowlist. For more information about adding groups to filtering groups
* allowlist, see [Filter results by Google
* Group](https://support.google.com/a/answer/11482175)
* @opt_param bool includeSensitiveData Optional. When set to `true`, this field
* allows sensitive user-generated content to be included in the returned audit
* logs. This parameter is supported only for Rules (DLP) and Chat applications;
* using it with any other application will result in a permission error.
* @opt_param int maxResults Determines how many activity records are shown on
* each response page. For example, if the request sets `maxResults=1` and the
* report has two activities, the report has two pages. The response's
* `nextPageToken` property has the token to the second page. The `maxResults`
* query string is optional in the request. The default value is 1000.
* @opt_param string networkInfoFilter Optional. Used to filter on the
* `regionCode` field present in [`NetworkInfo`](#networkinfo) message.
* **Usage** ``` GET...&networkInfoFilter=regionCode="IN"
* GET...&networkInfoFilter=regionCode=%22IN%22 ```
* @opt_param string orgUnitID ID of the organizational unit to report on.
* Activity records will be shown only for users who belong to the specified
* organizational unit. Data before Dec 17, 2018 doesn't appear in the filtered
* results.
* @opt_param string pageToken The token to specify next page. A report with
* multiple pages has a `nextPageToken` property in the response. In your
* follow-on request getting the next page of the report, enter the
* `nextPageToken` value in the `pageToken` query string.
* @opt_param string resourceDetailsFilter Optional. The `resourceDetailsFilter`
* query string is an AND separated list composed of [Resource
* Details](#resourcedetails) fields manipulated by relational operators.
* Resource Details Filters are in the form `{resourceDetails.field1}{relational
* operator}{field1 value} AND {resourceDetails.field2}{relational
* operator}{field2 value}...` All the inner fields are traversed using the `.`
* operator, as shown in the following example: ``` resourceDetails.id =
* "resourceId" AND resourceDetails.appliedLabels.id = "appliedLabelId" AND
* resourceDetails.appliedLabels.fieldValue.id = "fieldValueId" ```
* `resourceDetailsFilter` query supports these relational operators: *
* `=`—'equal to'. * `!=`—'not equal to'. * `:`—'exists'. This is used for
* filtering on repeated fields. [`FieldValue`](#fieldvalue) types that are
* repeated 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 filter
* checks whether [`SelectionListValue`](#selectionlistvalue) contains
* `selection_id`: ``` resourceDetails.id = "resourceId" AND
* resourceDetails.appliedLabels.id = "appliedLabelId" AND
* resourceDetails.appliedLabels.fieldValue.id = "fieldValueId" AND
* resourceDetails.appliedLabels.fieldValue.type = "SELECTION_LIST_VALUE" AND
* resourceDetails.appliedLabels.fieldValue.selectionListValue.id: "id" ```
* **Usage** ``` GET...&resourceDetailsFilter=resourceDetails.id = "resourceId"
* AND resourceDetails.appliedLabels.id = "appliedLabelId" GET...&resourceDetail
* sFilter=resourceDetails.id=%22resourceId%22%20AND%20resourceDetails.appliedLa
* bels.id=%22appliedLabelId%22 ``` **Note the following**: * You must URL
* encode the query string before sending the request. * The API supports a
* maximum of 5 fields separated by the AND operator. - When filtering on deeper
* levels (e.g., [`AppliedLabel`](#appliedlabel), [`FieldValue`](#fieldvalue)),
* the IDs of all preceding levels 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) types like `longTextValue` and
* `textValue` requires `resourceDetails.appliedLabels.fieldValue.type` to be
* present. * Only Filtering on a single [`AppliedLabel`](#appliedlabel) id and
* [`FieldValue`](#fieldvalue) id is supported.
* @opt_param string startTime Sets the beginning of the range of time shown in
* the report. The date is in the RFC 3339 format, for example
* 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 API returns an error.
* For Gmail requests, `startTime` and `endTime` must be provided and the
* difference must not be greater than 30 days.
* @opt_param string statusFilter Optional. Used to filter on the `statusCode`
* field present in [`Status`](#status) message. **Usage** ```
* GET...&statusFilter=statusCode="200" GET...&statusFilter=statusCode=%22200%22
* ```
* @return ActivitiesModel
* @throws \Google\Service\Exception
*/
public function listActivities($userKey, $applicationName, $optParams = [])
{
$params = ['userKey' => $userKey, 'applicationName' => $applicationName];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ActivitiesModel::class);
}
/**
* Start receiving notifications for account activities. For more information,
* see Receiving Push Notifications. (activities.watch)
*
* @param string $userKey Represents the profile ID or the user email for which
* the data should be filtered. Can be `all` for all information, or `userKey`
* for a user's unique Google Workspace profile ID or their primary email
* address. Must not be a deleted user. For a deleted user, call `users.list` in
* Directory API with `showDeleted=true`, then use the returned `ID` as the
* `userKey`.
* @param string $applicationName Application name for which the events are to
* be retrieved.
* @param Channel $postBody
* @param array $optParams Optional parameters.
*
* @opt_param string actorIpAddress The Internet Protocol (IP) Address of host
* where the event was performed. This is an additional way to filter a report's
* summary using the IP address of the user whose activity is being reported.
* This IP address 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. This parameter supports both IPv4 and IPv6
* address versions.
* @opt_param string customerId The unique ID of the customer to retrieve data
* for.
* @opt_param string endTime Sets the end of the range of time shown in the
* report. The date is in the RFC 3339 format, for example
* 2010-10-28T10:26:35.000Z. The default value is the approximate time of the
* API request. An API report has three basic time concepts: - *Date of the
* API'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 current time
* when the request is made, or the API returns an error. - *Report's end time*:
* The end of the timespan shown in the report. For example, the timespan 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 not specified, the
* report returns all activities from the `startTime` until the current time or
* the most recent 180 days if the `startTime` is more than 180 days in the
* past.
* @opt_param string eventName The name of the event being queried by the API.
* Each `eventName` is related to a specific Google Workspace service or feature
* which the API organizes into types of events. An example is the Google
* Calendar events in the Admin console application's reports. The Calendar
* Settings `type` structure has all of the Calendar `eventName` activities
* reported by the API. When an administrator changes a Calendar 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 various applications above in
* `applicationName`.
* @opt_param string filters The `filters` query string is a comma-separated
* list composed of event parameters manipulated by relational operators. Event
* parameters are in the form `{parameter1 name}{relational operator}{parameter1
* value},{parameter2 name}{relational operator}{parameter2 value},...` These
* event parameters are associated with a specific `eventName`. An empty report
* is returned if the request's parameter doesn't belong to the `eventName`. For
* more information about the available `eventName` fields for each application
* and their associated parameters, go to the
* [ApplicationName](#applicationname) table, then click through to the Activity
* Events page in the Appendix for the application you want. In the following
* Drive activity examples, the returned list consists of all `edit` events
* where the `doc_id` parameter value matches the conditions defined by the
* relational operator. In the first example, the request 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 in the request's query string
* (`%3C%3E`): ``` GET...&eventName=edit&filters=doc_id==12345
* GET...&eventName=edit&filters=doc_id%3C%3E98765 ``` A `filters` query
* supports these relational operators: * `==`—'equal to'. * `<>`—'not equal
* to'. Must be URL-encoded (%3C%3E). * `<`—'less than'. Must be URL-encoded
* (%3C). * `<=`—'less than or equal to'. Must be URL-encoded (%3C=). *
* `>`—'greater than'. Must be URL-encoded (%3E). * `>=`—'greater than or equal
* to'. Must be URL-encoded (%3E=). **Note:** The API doesn't accept multiple
* values of the same parameter. If a parameter is supplied more than once in
* the API request, the API only accepts the last value of that parameter. In
* addition, if an invalid parameter is supplied in the API request, the API
* ignores that parameter and returns the response corresponding to the
* remaining valid parameters. If no parameters are requested, all parameters
* are returned.
* @opt_param string groupIdFilter `Deprecated`. This field is deprecated and is
* no longer supported. Comma separated group ids (obfuscated) on which user
* activities are filtered, i.e. the response will contain activities for only
* those users that are a part of at least one of the group ids mentioned here.
* Format: "id:abc123,id:xyz456" *Important:* To filter by groups, you must
* explicitly add the groups to your filtering groups allowlist. For more
* information about adding groups to filtering groups allowlist, see [Filter
* results by Google Group](https://support.google.com/a/answer/11482175)
* @opt_param int maxResults Determines how many activity records are shown on
* each response page. For example, if the request sets `maxResults=1` and the
* report has two activities, the report has two pages. The response's
* `nextPageToken` property has the token to the second page. The `maxResults`
* query string is optional in the request. The default value is 1000.
* @opt_param string orgUnitID `Deprecated`. This field is deprecated and is no
* longer supported. ID of the organizational unit to report on. Activity
* records will be shown only for users who belong to the specified
* organizational unit. Data before Dec 17, 2018 doesn't appear in the filtered
* results.
* @opt_param string pageToken The token to specify next page. A report with
* multiple pages has a `nextPageToken` property in the response. In your
* follow-on request getting the next page of the report, enter the
* `nextPageToken` value in the `pageToken` query string.
* @opt_param string startTime Sets the beginning of the range of time shown in
* the report. The date is in the RFC 3339 format, for example
* 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 API returns an error.
* @return Channel
* @throws \Google\Service\Exception
*/
public function watch($userKey, $applicationName, Channel $postBody, $optParams = [])
{
$params = ['userKey' => $userKey, 'applicationName' => $applicationName, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('watch', [$params], Channel::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Activities::class, 'Google_Service_Reports_Resource_Activities');
@@ -0,0 +1,48 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Reports\Resource;
use Google\Service\Reports\Channel;
/**
* The "channels" collection of methods.
* Typical usage is:
* <code>
* $adminService = new Google\Service\Reports(...);
* $channels = $adminService->channels;
* </code>
*/
class Channels extends \Google\Service\Resource
{
/**
* Stop watching resources through this channel. (channels.stop)
*
* @param Channel $postBody
* @param array $optParams Optional parameters.
* @throws \Google\Service\Exception
*/
public function stop(Channel $postBody, $optParams = [])
{
$params = ['postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('stop', [$params]);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Channels::class, 'Google_Service_Reports_Resource_Channels');
@@ -0,0 +1,77 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Reports\Resource;
use Google\Service\Reports\UsageReports;
/**
* The "customerUsageReports" collection of methods.
* Typical usage is:
* <code>
* $adminService = new Google\Service\Reports(...);
* $customerUsageReports = $adminService->customerUsageReports;
* </code>
*/
class CustomerUsageReports extends \Google\Service\Resource
{
/**
* Retrieves a report which is a collection of properties and statistics for a
* specific customer's account. For more information, see the Customers Usage
* Report guide. For more information about the customer report's parameters,
* see the Customers Usage parameters reference guides.
* (customerUsageReports.get)
*
* @param string $date Represents the date the usage occurred, based on UTC-8:00
* (Pacific Standard Time). The timestamp is in the [ISO 8601
* format](https://en.wikipedia.org/wiki/ISO_8601), `yyyy-mm-dd`.
* @param array $optParams Optional parameters.
*
* @opt_param string customerId The unique ID of the customer to retrieve data
* for.
* @opt_param string pageToken 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.
* @opt_param string parameters The `parameters` query string is a comma-
* separated list of event parameters that refine a report's results. The
* parameter is associated with a specific application. The application 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 a parameter. If a
* particular parameter is supplied more than once in the API 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 response corresponding to the
* remaining valid request parameters. An example of an invalid request
* parameter is one that does not belong to the application. If no parameters
* are requested, all parameters are returned.
* @return UsageReports
* @throws \Google\Service\Exception
*/
public function get($date, $optParams = [])
{
$params = ['date' => $date];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], UsageReports::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(CustomerUsageReports::class, 'Google_Service_Reports_Resource_CustomerUsageReports');
@@ -0,0 +1,101 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Reports\Resource;
use Google\Service\Reports\UsageReports;
/**
* The "entityUsageReports" collection of methods.
* Typical usage is:
* <code>
* $adminService = new Google\Service\Reports(...);
* $entityUsageReports = $adminService->entityUsageReports;
* </code>
*/
class EntityUsageReports extends \Google\Service\Resource
{
/**
* Retrieves a report which is a collection of properties and statistics for
* entities used by users within the account. For more information, see the
* Entities Usage Report guide. For more information about the entities report's
* parameters, see the Entities Usage parameters reference guides.
* (entityUsageReports.get)
*
* @param string $entityType Represents the type of entity for the report.
* @param string $entityKey Represents the key of the object to filter the data
* with. It is a string which can take the value `all` to get activity events
* for all users, or any other value for an app-specific entity. For details on
* how to obtain the `entityKey` for a particular `entityType`, see the Entities
* Usage parameters reference guides.
* @param string $date Represents the date the usage occurred, based on UTC-8:00
* (Pacific Standard Time). The timestamp is in the [ISO 8601
* format](https://en.wikipedia.org/wiki/ISO_8601), `yyyy-mm-dd`.
* @param array $optParams Optional parameters.
*
* @opt_param string customerId The unique ID of the customer to retrieve data
* for.
* @opt_param string filters The `filters` query string is a comma-separated
* list of an application's event parameters where the parameter's value is
* manipulated by a relational operator. The `filters` query string includes the
* name of the application whose usage is returned in the report. The
* application values for the Entities usage report include `accounts`, `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 query string (%3C%3E): GET https://www.google
* apis.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 equal to'. 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.
* @opt_param string maxResults Determines how many activity records are shown
* on each response page. For example, if the request sets `maxResults=1` and
* the report has two activities, the report has two pages. The response's
* `nextPageToken` property has the token to the second page.
* @opt_param string pageToken Token to specify next page. A report with
* multiple pages has a `nextPageToken` property in the response. In your
* follow-on request getting the next page of the report, enter the
* `nextPageToken` value in the `pageToken` query string.
* @opt_param string parameters The `parameters` query string is a comma-
* separated list of event parameters that refine a report's results. The
* parameter is associated with a specific application. The application 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 values of a parameter. If a
* particular parameter is supplied more than once in the API 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 response corresponding to the
* remaining valid request parameters. An example of an invalid request
* parameter is one that does not belong to the application. If no parameters
* are requested, all parameters are returned.
* @return UsageReports
* @throws \Google\Service\Exception
*/
public function get($entityType, $entityKey, $date, $optParams = [])
{
$params = ['entityType' => $entityType, 'entityKey' => $entityKey, 'date' => $date];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], UsageReports::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(EntityUsageReports::class, 'Google_Service_Reports_Resource_EntityUsageReports');
@@ -0,0 +1,111 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Reports\Resource;
use Google\Service\Reports\UsageReports;
/**
* The "userUsageReport" collection of methods.
* Typical usage is:
* <code>
* $adminService = new Google\Service\Reports(...);
* $userUsageReport = $adminService->userUsageReport;
* </code>
*/
class UserUsageReport extends \Google\Service\Resource
{
/**
* Retrieves a report which is a collection of properties and statistics for a
* set of users with the account. For more information, see the User Usage
* Report guide. For more information about the user report's parameters, see
* the Users Usage parameters reference guides. (userUsageReport.get)
*
* @param string $userKey Represents the profile ID or the user email for which
* the data should be filtered. Can be `all` for all information, or `userKey`
* for a user's unique Google Workspace profile ID or their primary email
* address. Must not be a deleted user. For a deleted user, call `users.list` in
* Directory API with `showDeleted=true`, then use the returned `ID` as the
* `userKey`.
* @param string $date Represents the date the usage occurred, based on UTC-8:00
* (Pacific Standard Time). The timestamp is in the [ISO 8601
* format](https://en.wikipedia.org/wiki/ISO_8601), `yyyy-mm-dd`.
* @param array $optParams Optional parameters.
*
* @opt_param string customerId The unique ID of the customer to retrieve data
* for.
* @opt_param string filters The `filters` query string is a comma-separated
* list of an application's event parameters where the parameter's value is
* manipulated by a relational operator. The `filters` query string includes the
* name of the application whose usage is returned in the 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 query string (%3C%3E): GET
* https://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 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 equal to'. It is URL-encoded (%3C=). - `>` - 'greater
* than'. It is URL-encoded (%3E). - `>=` - 'greater than or equal to'. It is
* URL-encoded (%3E=).
* @opt_param string groupIdFilter Comma separated group ids (obfuscated) on
* which user activities are filtered, i.e. the response will contain activities
* for only those users that are a part of at least one of the group ids
* mentioned here. Format: "id:abc123,id:xyz456"
* @opt_param string maxResults Determines how many activity records are shown
* on each response page. For example, if the request sets `maxResults=1` and
* the report has two activities, the report has two pages. The response's
* `nextPageToken` property has the token to the second page. The `maxResults`
* query string is optional.
* @opt_param string orgUnitID ID of the organizational unit to report on. User
* activity will be shown only for users who belong to the specified
* organizational unit. Data before Dec 17, 2018 doesn't appear in the filtered
* results.
* @opt_param string pageToken Token to specify next page. A report with
* multiple pages has a `nextPageToken` property in the response. In your
* follow-on request getting the next page of the report, enter the
* `nextPageToken` value in the `pageToken` query string.
* @opt_param string parameters The `parameters` query string is a comma-
* separated list of event parameters that refine a report's results. The
* parameter is associated with a specific application. The application 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 a parameter. If a
* particular parameter is supplied more than once in the API 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 response corresponding to the
* remaining valid request parameters. An example of an invalid request
* parameter is one that does not belong to the application. If no parameters
* are requested, all parameters are returned.
* @return UsageReports
* @throws \Google\Service\Exception
*/
public function get($userKey, $date, $optParams = [])
{
$params = ['userKey' => $userKey, 'date' => $date];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], UsageReports::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(UserUsageReport::class, 'Google_Service_Reports_Resource_UserUsageReport');
@@ -0,0 +1,159 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Reports;
class ResourceDetails extends \Google\Collection
{
protected $collection_key = 'appliedLabels';
protected $appliedLabelsType = AppliedLabel::class;
protected $appliedLabelsDataType = 'array';
/**
* Identifier of the resource, such as a doc_id for a Drive document, a
* conference_id for a Meet conference, or a "gaia_id/rfc2822_message_id" for
* an email.
*
* @var string
*/
public $id;
protected $ownerDetailsType = OwnerDetails::class;
protected $ownerDetailsDataType = '';
/**
* Defines relationship of the resource to the events
*
* @var string
*/
public $relation;
/**
* 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.
*
* @var string
*/
public $title;
/**
* Type of the resource - document, email, chat message
*
* @var string
*/
public $type;
/**
* List of labels applied on the resource
*
* @param AppliedLabel[] $appliedLabels
*/
public function setAppliedLabels($appliedLabels)
{
$this->appliedLabels = $appliedLabels;
}
/**
* @return AppliedLabel[]
*/
public function getAppliedLabels()
{
return $this->appliedLabels;
}
/**
* Identifier of the resource, such as a doc_id for a Drive document, a
* conference_id for a Meet conference, or a "gaia_id/rfc2822_message_id" for
* an email.
*
* @param string $id
*/
public function setId($id)
{
$this->id = $id;
}
/**
* @return string
*/
public function getId()
{
return $this->id;
}
/**
* Owner details of the resource.
*
* @param OwnerDetails $ownerDetails
*/
public function setOwnerDetails(OwnerDetails $ownerDetails)
{
$this->ownerDetails = $ownerDetails;
}
/**
* @return OwnerDetails
*/
public function getOwnerDetails()
{
return $this->ownerDetails;
}
/**
* Defines relationship of the resource to the events
*
* @param string $relation
*/
public function setRelation($relation)
{
$this->relation = $relation;
}
/**
* @return string
*/
public function getRelation()
{
return $this->relation;
}
/**
* 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.
*
* @param string $title
*/
public function setTitle($title)
{
$this->title = $title;
}
/**
* @return string
*/
public function getTitle()
{
return $this->title;
}
/**
* Type of the resource - document, email, chat message
*
* @param string $type
*/
public function setType($type)
{
$this->type = $type;
}
/**
* @return string
*/
public function getType()
{
return $this->type;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ResourceDetails::class, 'Google_Service_Reports_ResourceDetails');
@@ -0,0 +1,134 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Reports;
class UsageReport extends \Google\Collection
{
protected $collection_key = 'parameters';
/**
* Output only. The date of the report request.
*
* @var string
*/
public $date;
protected $entityType = UsageReportEntity::class;
protected $entityDataType = '';
/**
* ETag of the resource.
*
* @var string
*/
public $etag;
/**
* The type of API resource. For a usage report, the value is
* `admin#reports#usageReport`.
*
* @var string
*/
public $kind;
protected $parametersType = UsageReportParameters::class;
protected $parametersDataType = 'array';
/**
* Output only. The date of the report request.
*
* @param string $date
*/
public function setDate($date)
{
$this->date = $date;
}
/**
* @return string
*/
public function getDate()
{
return $this->date;
}
/**
* Output only. Information about the type of the item.
*
* @param UsageReportEntity $entity
*/
public function setEntity(UsageReportEntity $entity)
{
$this->entity = $entity;
}
/**
* @return UsageReportEntity
*/
public function getEntity()
{
return $this->entity;
}
/**
* ETag of the resource.
*
* @param string $etag
*/
public function setEtag($etag)
{
$this->etag = $etag;
}
/**
* @return string
*/
public function getEtag()
{
return $this->etag;
}
/**
* The type of API resource. For a usage report, the value is
* `admin#reports#usageReport`.
*
* @param string $kind
*/
public function setKind($kind)
{
$this->kind = $kind;
}
/**
* @return string
*/
public function getKind()
{
return $this->kind;
}
/**
* Output only. Parameter value pairs for various applications. For the Entity
* Usage Report parameters and values, see [the Entity Usage parameters refere
* nce](https://developers.google.com/workspace/admin/reports/v1/reference/usa
* ge-ref-appendix-a/entities).
*
* @param UsageReportParameters[] $parameters
*/
public function setParameters($parameters)
{
$this->parameters = $parameters;
}
/**
* @return UsageReportParameters[]
*/
public function getParameters()
{
return $this->parameters;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(UsageReport::class, 'Google_Service_Reports_UsageReport');
@@ -0,0 +1,140 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Reports;
class UsageReportEntity extends \Google\Model
{
/**
* Output only. The unique identifier of the customer's account.
*
* @var string
*/
public $customerId;
/**
* Output only. Object key. Only relevant if entity.type = "OBJECT" Note:
* external-facing name of report is "Entities" rather than "Objects".
*
* @var string
*/
public $entityId;
/**
* Output only. The user's immutable Google Workspace profile identifier.
*
* @var string
*/
public $profileId;
/**
* Output only. The type of item. The value is `user`.
*
* @var string
*/
public $type;
/**
* Output only. The user's email address. Only relevant if entity.type =
* "USER"
*
* @var string
*/
public $userEmail;
/**
* Output only. The unique identifier of the customer's account.
*
* @param string $customerId
*/
public function setCustomerId($customerId)
{
$this->customerId = $customerId;
}
/**
* @return string
*/
public function getCustomerId()
{
return $this->customerId;
}
/**
* Output only. Object key. Only relevant if entity.type = "OBJECT" Note:
* external-facing name of report is "Entities" rather than "Objects".
*
* @param string $entityId
*/
public function setEntityId($entityId)
{
$this->entityId = $entityId;
}
/**
* @return string
*/
public function getEntityId()
{
return $this->entityId;
}
/**
* Output only. The user's immutable Google Workspace profile identifier.
*
* @param string $profileId
*/
public function setProfileId($profileId)
{
$this->profileId = $profileId;
}
/**
* @return string
*/
public function getProfileId()
{
return $this->profileId;
}
/**
* Output only. The type of item. The value is `user`.
*
* @param string $type
*/
public function setType($type)
{
$this->type = $type;
}
/**
* @return string
*/
public function getType()
{
return $this->type;
}
/**
* Output only. The user's email address. Only relevant if entity.type =
* "USER"
*
* @param string $userEmail
*/
public function setUserEmail($userEmail)
{
$this->userEmail = $userEmail;
}
/**
* @return string
*/
public function getUserEmail()
{
return $this->userEmail;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(UsageReportEntity::class, 'Google_Service_Reports_UsageReportEntity');
@@ -0,0 +1,163 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Reports;
class UsageReportParameters extends \Google\Collection
{
protected $collection_key = 'msgValue';
/**
* Output only. Boolean value of the parameter.
*
* @var bool
*/
public $boolValue;
/**
* The RFC 3339 formatted value of the parameter, for example
* 2010-10-28T10:26:35.000Z.
*
* @var string
*/
public $datetimeValue;
/**
* Output only. Integer value of the parameter.
*
* @var string
*/
public $intValue;
/**
* Output only. Nested message value of the parameter.
*
* @var array[]
*/
public $msgValue;
/**
* The name of the parameter. For the User Usage Report parameter names, see
* the User Usage parameters reference.
*
* @var string
*/
public $name;
/**
* Output only. String value of the parameter.
*
* @var string
*/
public $stringValue;
/**
* Output only. Boolean value of the parameter.
*
* @param bool $boolValue
*/
public function setBoolValue($boolValue)
{
$this->boolValue = $boolValue;
}
/**
* @return bool
*/
public function getBoolValue()
{
return $this->boolValue;
}
/**
* The RFC 3339 formatted value of the parameter, for example
* 2010-10-28T10:26:35.000Z.
*
* @param string $datetimeValue
*/
public function setDatetimeValue($datetimeValue)
{
$this->datetimeValue = $datetimeValue;
}
/**
* @return string
*/
public function getDatetimeValue()
{
return $this->datetimeValue;
}
/**
* Output only. Integer value of the parameter.
*
* @param string $intValue
*/
public function setIntValue($intValue)
{
$this->intValue = $intValue;
}
/**
* @return string
*/
public function getIntValue()
{
return $this->intValue;
}
/**
* Output only. Nested message value of the parameter.
*
* @param array[] $msgValue
*/
public function setMsgValue($msgValue)
{
$this->msgValue = $msgValue;
}
/**
* @return array[]
*/
public function getMsgValue()
{
return $this->msgValue;
}
/**
* The name of the parameter. For the User Usage Report parameter names, see
* the User Usage parameters reference.
*
* @param string $name
*/
public function setName($name)
{
$this->name = $name;
}
/**
* @return string
*/
public function getName()
{
return $this->name;
}
/**
* Output only. String value of the parameter.
*
* @param string $stringValue
*/
public function setStringValue($stringValue)
{
$this->stringValue = $stringValue;
}
/**
* @return string
*/
public function getStringValue()
{
return $this->stringValue;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(UsageReportParameters::class, 'Google_Service_Reports_UsageReportParameters');
@@ -0,0 +1,137 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Reports;
class UsageReports extends \Google\Collection
{
protected $collection_key = 'warnings';
/**
* ETag of the resource.
*
* @var string
*/
public $etag;
/**
* The type of API resource. For a usage report, the value is
* `admin#reports#usageReports`.
*
* @var string
*/
public $kind;
/**
* 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.
*
* @var string
*/
public $nextPageToken;
protected $usageReportsType = UsageReport::class;
protected $usageReportsDataType = 'array';
protected $warningsType = UsageReportsWarnings::class;
protected $warningsDataType = 'array';
/**
* ETag of the resource.
*
* @param string $etag
*/
public function setEtag($etag)
{
$this->etag = $etag;
}
/**
* @return string
*/
public function getEtag()
{
return $this->etag;
}
/**
* The type of API resource. For a usage report, the value is
* `admin#reports#usageReports`.
*
* @param string $kind
*/
public function setKind($kind)
{
$this->kind = $kind;
}
/**
* @return string
*/
public function getKind()
{
return $this->kind;
}
/**
* 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.
*
* @param string $nextPageToken
*/
public function setNextPageToken($nextPageToken)
{
$this->nextPageToken = $nextPageToken;
}
/**
* @return string
*/
public function getNextPageToken()
{
return $this->nextPageToken;
}
/**
* Various application parameter records.
*
* @param UsageReport[] $usageReports
*/
public function setUsageReports($usageReports)
{
$this->usageReports = $usageReports;
}
/**
* @return UsageReport[]
*/
public function getUsageReports()
{
return $this->usageReports;
}
/**
* Warnings, if any.
*
* @param UsageReportsWarnings[] $warnings
*/
public function setWarnings($warnings)
{
$this->warnings = $warnings;
}
/**
* @return UsageReportsWarnings[]
*/
public function getWarnings()
{
return $this->warnings;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(UsageReports::class, 'Google_Service_Reports_UsageReports');
@@ -0,0 +1,97 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Reports;
class UsageReportsWarnings extends \Google\Collection
{
protected $collection_key = 'data';
/**
* Machine readable code or warning type. The warning code value is `200`.
*
* @var string
*/
public $code;
protected $dataType = UsageReportsWarningsData::class;
protected $dataDataType = 'array';
/**
* 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.
*
* @var string
*/
public $message;
/**
* Machine readable code or warning type. The warning code value is `200`.
*
* @param string $code
*/
public function setCode($code)
{
$this->code = $code;
}
/**
* @return string
*/
public function getCode()
{
return $this->code;
}
/**
* Key-value pairs to give detailed information on the warning.
*
* @param UsageReportsWarningsData[] $data
*/
public function setData($data)
{
$this->data = $data;
}
/**
* @return UsageReportsWarningsData[]
*/
public function getData()
{
return $this->data;
}
/**
* 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.
*
* @param string $message
*/
public function setMessage($message)
{
$this->message = $message;
}
/**
* @return string
*/
public function getMessage()
{
return $this->message;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(UsageReportsWarnings::class, 'Google_Service_Reports_UsageReportsWarnings');
@@ -0,0 +1,74 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Reports;
class UsageReportsWarningsData extends \Google\Model
{
/**
* Key associated with a key-value pair to give detailed information on the
* warning.
*
* @var string
*/
public $key;
/**
* Value associated with a key-value pair to give detailed information on the
* warning.
*
* @var string
*/
public $value;
/**
* Key associated with a key-value pair to give detailed information on the
* warning.
*
* @param string $key
*/
public function setKey($key)
{
$this->key = $key;
}
/**
* @return string
*/
public function getKey()
{
return $this->key;
}
/**
* Value associated with a key-value pair to give detailed information on the
* warning.
*
* @param string $value
*/
public function setValue($value)
{
$this->value = $value;
}
/**
* @return string
*/
public function getValue()
{
return $this->value;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(UsageReportsWarningsData::class, 'Google_Service_Reports_UsageReportsWarningsData');
@@ -0,0 +1,70 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Reports;
class UserIdentity extends \Google\Model
{
/**
* User gaia id.
*
* @var string
*/
public $id;
/**
* User email.
*
* @var string
*/
public $userEmail;
/**
* User gaia id.
*
* @param string $id
*/
public function setId($id)
{
$this->id = $id;
}
/**
* @return string
*/
public function getId()
{
return $this->id;
}
/**
* User email.
*
* @param string $userEmail
*/
public function setUserEmail($userEmail)
{
$this->userEmail = $userEmail;
}
/**
* @return string
*/
public function getUserEmail()
{
return $this->userEmail;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(UserIdentity::class, 'Google_Service_Reports_UserIdentity');