| 1 |
<?php |
| 2 |
/* |
| 3 |
* Copyright 2010 Google Inc. |
| 4 |
* |
| 5 |
* Licensed under the Apache License, Version 2.0 (the "License"); you may not |
| 6 |
* use this file except in compliance with the License. You may obtain a copy of |
| 7 |
* the License at |
| 8 |
* |
| 9 |
* http://www.apache.org/licenses/LICENSE-2.0 |
| 10 |
* |
| 11 |
* Unless required by applicable law or agreed to in writing, software |
| 12 |
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT |
| 13 |
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the |
| 14 |
* License for the specific language governing permissions and limitations under |
| 15 |
* the License. |
| 16 |
*/ |
| 17 |
|
| 18 |
/** |
| 19 |
* Service definition for Audit (v1). |
| 20 |
* |
| 21 |
* <p> |
| 22 |
* Lets you access user activities in your enterprise made through various applications. |
| 23 |
* </p> |
| 24 |
* |
| 25 |
* <p> |
| 26 |
* For more information about this service, see the API |
| 27 |
* <a href="https://developers.google.com/google-apps/admin-audit/get_started" target="_blank">Documentation</a> |
| 28 |
* </p> |
| 29 |
* |
| 30 |
* @author Google, Inc. |
| 31 |
*/ |
| 32 |
class Analytify_Google_Service_Audit extends Analytify_Google_Service |
| 33 |
{ |
| 34 |
|
| 35 |
|
| 36 |
public $activities; |
| 37 |
|
| 38 |
|
| 39 |
/** |
| 40 |
* Constructs the internal representation of the Audit service. |
| 41 |
* |
| 42 |
* @param Analytify_Google_Client $client |
| 43 |
*/ |
| 44 |
public function __construct(Analytify_Google_Client $client) |
| 45 |
{ |
| 46 |
parent::__construct($client); |
| 47 |
$this->servicePath = 'apps/reporting/audit/v1/'; |
| 48 |
$this->version = 'v1'; |
| 49 |
$this->serviceName = 'audit'; |
| 50 |
|
| 51 |
$this->activities = new Analytify_Google_Service_Audit_Activities_Resource( |
| 52 |
$this, |
| 53 |
$this->serviceName, |
| 54 |
'activities', |
| 55 |
array( |
| 56 |
'methods' => array( |
| 57 |
'list' => array( |
| 58 |
'path' => '{customerId}/{applicationId}', |
| 59 |
'httpMethod' => 'GET', |
| 60 |
'parameters' => array( |
| 61 |
'customerId' => array( |
| 62 |
'location' => 'path', |
| 63 |
'type' => 'string', |
| 64 |
'required' => true, |
| 65 |
), |
| 66 |
'applicationId' => array( |
| 67 |
'location' => 'path', |
| 68 |
'type' => 'string', |
| 69 |
'required' => true, |
| 70 |
), |
| 71 |
'actorEmail' => array( |
| 72 |
'location' => 'query', |
| 73 |
'type' => 'string', |
| 74 |
), |
| 75 |
'actorApplicationId' => array( |
| 76 |
'location' => 'query', |
| 77 |
'type' => 'string', |
| 78 |
), |
| 79 |
'actorIpAddress' => array( |
| 80 |
'location' => 'query', |
| 81 |
'type' => 'string', |
| 82 |
), |
| 83 |
'caller' => array( |
| 84 |
'location' => 'query', |
| 85 |
'type' => 'string', |
| 86 |
), |
| 87 |
'maxResults' => array( |
| 88 |
'location' => 'query', |
| 89 |
'type' => 'integer', |
| 90 |
), |
| 91 |
'eventName' => array( |
| 92 |
'location' => 'query', |
| 93 |
'type' => 'string', |
| 94 |
), |
| 95 |
'startTime' => array( |
| 96 |
'location' => 'query', |
| 97 |
'type' => 'string', |
| 98 |
), |
| 99 |
'endTime' => array( |
| 100 |
'location' => 'query', |
| 101 |
'type' => 'string', |
| 102 |
), |
| 103 |
'continuationToken' => array( |
| 104 |
'location' => 'query', |
| 105 |
'type' => 'string', |
| 106 |
), |
| 107 |
), |
| 108 |
), |
| 109 |
) |
| 110 |
) |
| 111 |
); |
| 112 |
} |
| 113 |
} |
| 114 |
|
| 115 |
|
| 116 |
/** |
| 117 |
* The "activities" collection of methods. |
| 118 |
* Typical usage is: |
| 119 |
* <code> |
| 120 |
* $auditService = new Analytify_Google_Service_Audit(...); |
| 121 |
* $activities = $auditService->activities; |
| 122 |
* </code> |
| 123 |
*/ |
| 124 |
class Analytify_Google_Service_Audit_Activities_Resource extends Analytify_Google_Service_Resource |
| 125 |
{ |
| 126 |
|
| 127 |
/** |
| 128 |
* Retrieves a list of activities for a specific customer and application. |
| 129 |
* (activities.listActivities) |
| 130 |
* |
| 131 |
* @param string $customerId |
| 132 |
* Represents the customer who is the owner of target object on which action was performed. |
| 133 |
* @param string $applicationId |
| 134 |
* Application ID of the application on which the event was performed. |
| 135 |
* @param array $optParams Optional parameters. |
| 136 |
* |
| 137 |
* @opt_param string actorEmail |
| 138 |
* Email address of the user who performed the action. |
| 139 |
* @opt_param string actorApplicationId |
| 140 |
* Application ID of the application which interacted on behalf of the user while performing the |
| 141 |
* event. |
| 142 |
* @opt_param string actorIpAddress |
| 143 |
* IP Address of host where the event was performed. Supports both IPv4 and IPv6 addresses. |
| 144 |
* @opt_param string caller |
| 145 |
* Type of the caller. |
| 146 |
* @opt_param int maxResults |
| 147 |
* Number of activity records to be shown in each page. |
| 148 |
* @opt_param string eventName |
| 149 |
* Name of the event being queried. |
| 150 |
* @opt_param string startTime |
| 151 |
* Return events which occured at or after this time. |
| 152 |
* @opt_param string endTime |
| 153 |
* Return events which occured at or before this time. |
| 154 |
* @opt_param string continuationToken |
| 155 |
* Next page URL. |
| 156 |
* @return Analytify_Google_Service_Audit_Activities |
| 157 |
*/ |
| 158 |
public function listActivities($customerId, $applicationId, $optParams = array()) |
| 159 |
{ |
| 160 |
$params = array('customerId' => $customerId, 'applicationId' => $applicationId); |
| 161 |
$params = array_merge($params, $optParams); |
| 162 |
return $this->call('list', array($params), "Analytify_Google_Service_Audit_Activities"); |
| 163 |
} |
| 164 |
} |
| 165 |
|
| 166 |
|
| 167 |
|
| 168 |
|
| 169 |
class Analytify_Google_Service_Audit_Activities extends Analytify_Google_Collection |
| 170 |
{ |
| 171 |
protected $itemsType = 'Analytify_Google_Service_Audit_Activity'; |
| 172 |
protected $itemsDataType = 'array'; |
| 173 |
public $kind; |
| 174 |
public $next; |
| 175 |
|
| 176 |
public function setItems($items) |
| 177 |
{ |
| 178 |
$this->items = $items; |
| 179 |
} |
| 180 |
|
| 181 |
public function getItems() |
| 182 |
{ |
| 183 |
return $this->items; |
| 184 |
} |
| 185 |
|
| 186 |
public function setKind($kind) |
| 187 |
{ |
| 188 |
$this->kind = $kind; |
| 189 |
} |
| 190 |
|
| 191 |
public function getKind() |
| 192 |
{ |
| 193 |
return $this->kind; |
| 194 |
} |
| 195 |
|
| 196 |
public function setNext($next) |
| 197 |
{ |
| 198 |
$this->next = $next; |
| 199 |
} |
| 200 |
|
| 201 |
public function getNext() |
| 202 |
{ |
| 203 |
return $this->next; |
| 204 |
} |
| 205 |
} |
| 206 |
|
| 207 |
class Analytify_Google_Service_Audit_Activity extends Analytify_Google_Collection |
| 208 |
{ |
| 209 |
protected $actorType = 'Analytify_Google_Service_Audit_ActivityActor'; |
| 210 |
protected $actorDataType = ''; |
| 211 |
protected $eventsType = 'Analytify_Google_Service_Audit_ActivityEvents'; |
| 212 |
protected $eventsDataType = 'array'; |
| 213 |
protected $idType = 'Analytify_Google_Service_Audit_ActivityId'; |
| 214 |
protected $idDataType = ''; |
| 215 |
public $ipAddress; |
| 216 |
public $kind; |
| 217 |
public $ownerDomain; |
| 218 |
|
| 219 |
public function setActor(Analytify_Google_Service_Audit_ActivityActor $actor) |
| 220 |
{ |
| 221 |
$this->actor = $actor; |
| 222 |
} |
| 223 |
|
| 224 |
public function getActor() |
| 225 |
{ |
| 226 |
return $this->actor; |
| 227 |
} |
| 228 |
|
| 229 |
public function setEvents($events) |
| 230 |
{ |
| 231 |
$this->events = $events; |
| 232 |
} |
| 233 |
|
| 234 |
public function getEvents() |
| 235 |
{ |
| 236 |
return $this->events; |
| 237 |
} |
| 238 |
|
| 239 |
public function setId(Analytify_Google_Service_Audit_ActivityId $id) |
| 240 |
{ |
| 241 |
$this->id = $id; |
| 242 |
} |
| 243 |
|
| 244 |
public function getId() |
| 245 |
{ |
| 246 |
return $this->id; |
| 247 |
} |
| 248 |
|
| 249 |
public function setIpAddress($ipAddress) |
| 250 |
{ |
| 251 |
$this->ipAddress = $ipAddress; |
| 252 |
} |
| 253 |
|
| 254 |
public function getIpAddress() |
| 255 |
{ |
| 256 |
return $this->ipAddress; |
| 257 |
} |
| 258 |
|
| 259 |
public function setKind($kind) |
| 260 |
{ |
| 261 |
$this->kind = $kind; |
| 262 |
} |
| 263 |
|
| 264 |
public function getKind() |
| 265 |
{ |
| 266 |
return $this->kind; |
| 267 |
} |
| 268 |
|
| 269 |
public function setOwnerDomain($ownerDomain) |
| 270 |
{ |
| 271 |
$this->ownerDomain = $ownerDomain; |
| 272 |
} |
| 273 |
|
| 274 |
public function getOwnerDomain() |
| 275 |
{ |
| 276 |
return $this->ownerDomain; |
| 277 |
} |
| 278 |
} |
| 279 |
|
| 280 |
class Analytify_Google_Service_Audit_ActivityActor extends Analytify_Google_Model |
| 281 |
{ |
| 282 |
public $applicationId; |
| 283 |
public $callerType; |
| 284 |
public $email; |
| 285 |
public $key; |
| 286 |
|
| 287 |
public function setApplicationId($applicationId) |
| 288 |
{ |
| 289 |
$this->applicationId = $applicationId; |
| 290 |
} |
| 291 |
|
| 292 |
public function getApplicationId() |
| 293 |
{ |
| 294 |
return $this->applicationId; |
| 295 |
} |
| 296 |
|
| 297 |
public function setCallerType($callerType) |
| 298 |
{ |
| 299 |
$this->callerType = $callerType; |
| 300 |
} |
| 301 |
|
| 302 |
public function getCallerType() |
| 303 |
{ |
| 304 |
return $this->callerType; |
| 305 |
} |
| 306 |
|
| 307 |
public function setEmail($email) |
| 308 |
{ |
| 309 |
$this->email = $email; |
| 310 |
} |
| 311 |
|
| 312 |
public function getEmail() |
| 313 |
{ |
| 314 |
return $this->email; |
| 315 |
} |
| 316 |
|
| 317 |
public function setKey($key) |
| 318 |
{ |
| 319 |
$this->key = $key; |
| 320 |
} |
| 321 |
|
| 322 |
public function getKey() |
| 323 |
{ |
| 324 |
return $this->key; |
| 325 |
} |
| 326 |
} |
| 327 |
|
| 328 |
class Analytify_Google_Service_Audit_ActivityEvents extends Analytify_Google_Collection |
| 329 |
{ |
| 330 |
public $eventType; |
| 331 |
public $name; |
| 332 |
protected $parametersType = 'Analytify_Google_Service_Audit_ActivityEventsParameters'; |
| 333 |
protected $parametersDataType = 'array'; |
| 334 |
|
| 335 |
public function setEventType($eventType) |
| 336 |
{ |
| 337 |
$this->eventType = $eventType; |
| 338 |
} |
| 339 |
|
| 340 |
public function getEventType() |
| 341 |
{ |
| 342 |
return $this->eventType; |
| 343 |
} |
| 344 |
|
| 345 |
public function setName($name) |
| 346 |
{ |
| 347 |
$this->name = $name; |
| 348 |
} |
| 349 |
|
| 350 |
public function getName() |
| 351 |
{ |
| 352 |
return $this->name; |
| 353 |
} |
| 354 |
|
| 355 |
public function setParameters($parameters) |
| 356 |
{ |
| 357 |
$this->parameters = $parameters; |
| 358 |
} |
| 359 |
|
| 360 |
public function getParameters() |
| 361 |
{ |
| 362 |
return $this->parameters; |
| 363 |
} |
| 364 |
} |
| 365 |
|
| 366 |
class Analytify_Google_Service_Audit_ActivityEventsParameters extends Analytify_Google_Model |
| 367 |
{ |
| 368 |
public $name; |
| 369 |
public $value; |
| 370 |
|
| 371 |
public function setName($name) |
| 372 |
{ |
| 373 |
$this->name = $name; |
| 374 |
} |
| 375 |
|
| 376 |
public function getName() |
| 377 |
{ |
| 378 |
return $this->name; |
| 379 |
} |
| 380 |
|
| 381 |
public function setValue($value) |
| 382 |
{ |
| 383 |
$this->value = $value; |
| 384 |
} |
| 385 |
|
| 386 |
public function getValue() |
| 387 |
{ |
| 388 |
return $this->value; |
| 389 |
} |
| 390 |
} |
| 391 |
|
| 392 |
class Analytify_Google_Service_Audit_ActivityId extends Analytify_Google_Model |
| 393 |
{ |
| 394 |
public $applicationId; |
| 395 |
public $customerId; |
| 396 |
public $time; |
| 397 |
public $uniqQualifier; |
| 398 |
|
| 399 |
public function setApplicationId($applicationId) |
| 400 |
{ |
| 401 |
$this->applicationId = $applicationId; |
| 402 |
} |
| 403 |
|
| 404 |
public function getApplicationId() |
| 405 |
{ |
| 406 |
return $this->applicationId; |
| 407 |
} |
| 408 |
|
| 409 |
public function setCustomerId($customerId) |
| 410 |
{ |
| 411 |
$this->customerId = $customerId; |
| 412 |
} |
| 413 |
|
| 414 |
public function getCustomerId() |
| 415 |
{ |
| 416 |
return $this->customerId; |
| 417 |
} |
| 418 |
|
| 419 |
public function setTime($time) |
| 420 |
{ |
| 421 |
$this->time = $time; |
| 422 |
} |
| 423 |
|
| 424 |
public function getTime() |
| 425 |
{ |
| 426 |
return $this->time; |
| 427 |
} |
| 428 |
|
| 429 |
public function setUniqQualifier($uniqQualifier) |
| 430 |
{ |
| 431 |
$this->uniqQualifier = $uniqQualifier; |
| 432 |
} |
| 433 |
|
| 434 |
public function getUniqQualifier() |
| 435 |
{ |
| 436 |
return $this->uniqQualifier; |
| 437 |
} |
| 438 |
} |
| 439 |
|