docs/dyn/audit.v1.activities.html - platform/external/python/google-api-python-client - Gitiles


 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
 <html><head><title>Python: class Resource</title>
 </head><body bgcolor="#f0f0f8">
 <p>
 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
 <tr bgcolor="#ffc8d8">
 <td colspan=3 valign=bottom>&nbsp;<br>
 <font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>

 <tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
 <td colspan=2><tt>A&nbsp;class&nbsp;for&nbsp;interacting&nbsp;with&nbsp;a&nbsp;resource.<br>&nbsp;</tt></td></tr>
 <tr><td>&nbsp;</td>
 <td width="100%">Methods defined here:<br>
 <dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>

 <dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves&nbsp;a&nbsp;list&nbsp;of&nbsp;activities&nbsp;for&nbsp;a&nbsp;specific&nbsp;customer&nbsp;and&nbsp;application.<br>
 &nbsp;<br>
 Args:<br>
 &nbsp;&nbsp;caller:&nbsp;string,&nbsp;Type&nbsp;of&nbsp;the&nbsp;caller.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;Allowed&nbsp;values<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;application_owner&nbsp;-&nbsp;Caller&nbsp;is&nbsp;an&nbsp;application&nbsp;owner.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;customer&nbsp;-&nbsp;Caller&nbsp;is&nbsp;a&nbsp;customer.<br>
 &nbsp;&nbsp;startTime:&nbsp;string,&nbsp;Return&nbsp;events&nbsp;which&nbsp;occured&nbsp;at&nbsp;or&nbsp;after&nbsp;this&nbsp;time.<br>
 &nbsp;&nbsp;actorIpAddress:&nbsp;string,&nbsp;IP&nbsp;Address&nbsp;of&nbsp;host&nbsp;where&nbsp;the&nbsp;event&nbsp;was&nbsp;performed.&nbsp;Supports&nbsp;both&nbsp;IPv4&nbsp;and&nbsp;IPv6&nbsp;addresses.<br>
 &nbsp;&nbsp;applicationId:&nbsp;string,&nbsp;Application&nbsp;ID&nbsp;of&nbsp;the&nbsp;application&nbsp;on&nbsp;which&nbsp;the&nbsp;event&nbsp;was&nbsp;performed.&nbsp;(required)<br>
 &nbsp;&nbsp;eventName:&nbsp;string,&nbsp;Name&nbsp;of&nbsp;the&nbsp;event&nbsp;being&nbsp;queried.<br>
 &nbsp;&nbsp;pp:&nbsp;string,&nbsp;A&nbsp;parameter<br>
 &nbsp;&nbsp;trace:&nbsp;string,&nbsp;A&nbsp;parameter<br>
 &nbsp;&nbsp;actorApplicationId:&nbsp;string,&nbsp;Application&nbsp;ID&nbsp;of&nbsp;the&nbsp;application&nbsp;which&nbsp;interacted&nbsp;on&nbsp;behalf&nbsp;of&nbsp;the&nbsp;user&nbsp;while&nbsp;performing&nbsp;the&nbsp;event.<br>
 &nbsp;&nbsp;strict:&nbsp;string,&nbsp;A&nbsp;parameter<br>
 &nbsp;&nbsp;continuationToken:&nbsp;string,&nbsp;Next&nbsp;page&nbsp;URL.<br>
 &nbsp;&nbsp;maxResults:&nbsp;integer,&nbsp;Number&nbsp;of&nbsp;activity&nbsp;records&nbsp;to&nbsp;be&nbsp;shown&nbsp;in&nbsp;each&nbsp;page.<br>
 &nbsp;&nbsp;parameters:&nbsp;string,&nbsp;Event&nbsp;parameters&nbsp;in&nbsp;the&nbsp;form&nbsp;[parameter1&nbsp;name]:[parameter1&nbsp;value],[parameter2&nbsp;name]:[parameter2&nbsp;value],...<br>
 &nbsp;&nbsp;actorEmail:&nbsp;string,&nbsp;Email&nbsp;address&nbsp;of&nbsp;the&nbsp;user&nbsp;who&nbsp;performed&nbsp;the&nbsp;action.<br>
 &nbsp;&nbsp;userip:&nbsp;string,&nbsp;A&nbsp;parameter<br>
 &nbsp;&nbsp;endTime:&nbsp;string,&nbsp;Return&nbsp;events&nbsp;which&nbsp;occured&nbsp;at&nbsp;or&nbsp;before&nbsp;this&nbsp;time.<br>
 &nbsp;&nbsp;customerId:&nbsp;string,&nbsp;Represents&nbsp;the&nbsp;customer&nbsp;who&nbsp;is&nbsp;the&nbsp;owner&nbsp;of&nbsp;target&nbsp;object&nbsp;on&nbsp;which&nbsp;action&nbsp;was&nbsp;performed.&nbsp;(required)<br>
 &nbsp;<br>
 Returns:<br>
 &nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
 &nbsp;<br>
 &nbsp;&nbsp;&nbsp;&nbsp;{<br>
 &nbsp;&nbsp;&nbsp;&nbsp;"items":&nbsp;[&nbsp;#&nbsp;Each&nbsp;record&nbsp;in&nbsp;read&nbsp;response.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"audit#activity",&nbsp;#&nbsp;Kind&nbsp;of&nbsp;resource&nbsp;this&nbsp;is.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ownerDomain":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Domain&nbsp;of&nbsp;source&nbsp;customer.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"actor":&nbsp;{&nbsp;#&nbsp;User&nbsp;doing&nbsp;the&nbsp;action.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"applicationId":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;ID&nbsp;of&nbsp;application&nbsp;which&nbsp;interacted&nbsp;on&nbsp;behalf&nbsp;of&nbsp;the&nbsp;user.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"email":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Email&nbsp;address&nbsp;of&nbsp;the&nbsp;user.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"key":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;For&nbsp;OAuth&nbsp;2LO&nbsp;API&nbsp;requests,&nbsp;consumer_key&nbsp;of&nbsp;the&nbsp;requestor.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"callerType":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;User&nbsp;or&nbsp;OAuth&nbsp;2LO&nbsp;request.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;{&nbsp;#&nbsp;Unique&nbsp;identifier&nbsp;for&nbsp;each&nbsp;activity&nbsp;record.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"uniqQualifier":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Unique&nbsp;qualifier&nbsp;if&nbsp;multiple&nbsp;events&nbsp;have&nbsp;the&nbsp;same&nbsp;time.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"applicationId":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Application&nbsp;ID&nbsp;of&nbsp;the&nbsp;source&nbsp;application.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"customerId":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Obfuscated&nbsp;customer&nbsp;ID&nbsp;of&nbsp;the&nbsp;source&nbsp;customer.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"time":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Time&nbsp;of&nbsp;occurrence&nbsp;of&nbsp;the&nbsp;activity.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ipAddress":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;IP&nbsp;Address&nbsp;of&nbsp;the&nbsp;user&nbsp;doing&nbsp;the&nbsp;action.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"events":&nbsp;[&nbsp;#&nbsp;Activity&nbsp;events.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"eventType":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Type&nbsp;of&nbsp;event.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"name":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Name&nbsp;of&nbsp;event.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"parameters":&nbsp;[&nbsp;#&nbsp;Event&nbsp;parameters.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"name":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Name&nbsp;of&nbsp;the&nbsp;parameter.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"value":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Value&nbsp;of&nbsp;the&nbsp;parameter.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
 &nbsp;&nbsp;&nbsp;&nbsp;],<br>
 &nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"audit#activities",&nbsp;#&nbsp;Kind&nbsp;of&nbsp;list&nbsp;response&nbsp;this&nbsp;is.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;"next":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Next&nbsp;page&nbsp;URL.<br>
 &nbsp;&nbsp;}</tt></dd></dl>

 <hr>
 Data descriptors defined here:<br>
 <dl><dt><strong>__dict__</strong></dt>
 <dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
 </dl>
 <dl><dt><strong>__weakref__</strong></dt>
 <dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
 </dl>
 </td></tr></table>
 </body></html>

	<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
	<html><head><title>Python: class Resource</title>
	</head><body bgcolor="#f0f0f8">
	<p>
	<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
	<tr bgcolor="#ffc8d8">
	<td colspan=3 valign=bottom> <br>
	<font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>

	<tr bgcolor="#ffc8d8"><td rowspan=2><tt>   </tt></td>
	<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
	<tr><td> </td>
	<td width="100%">Methods defined here:<br>
	<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>

	<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves a list of activities for a specific customer and application.<br>
	<br>
	Args:<br>
	caller: string, Type of the caller.<br>
	Allowed values<br>
	application_owner - Caller is an application owner.<br>
	customer - Caller is a customer.<br>
	startTime: string, Return events which occured at or after this time.<br>
	actorIpAddress: string, IP Address of host where the event was performed. Supports both IPv4 and IPv6 addresses.<br>
	applicationId: string, Application ID of the application on which the event was performed. (required)<br>
	eventName: string, Name of the event being queried.<br>
	pp: string, A parameter<br>
	trace: string, A parameter<br>
	actorApplicationId: string, Application ID of the application which interacted on behalf of the user while performing the event.<br>
	strict: string, A parameter<br>
	continuationToken: string, Next page URL.<br>
	maxResults: integer, Number of activity records to be shown in each page.<br>
	parameters: string, Event parameters in the form [parameter1 name]:[parameter1 value],[parameter2 name]:[parameter2 value],...<br>
	actorEmail: string, Email address of the user who performed the action.<br>
	userip: string, A parameter<br>
	endTime: string, Return events which occured at or before this time.<br>
	customerId: string, Represents the customer who is the owner of target object on which action was performed. (required)<br>
	<br>
	Returns:<br>
	An object of the form<br>
	<br>
	{<br>
	"items": [ # Each record in read response.<br>
	{<br>
	"kind": "audit#activity", # Kind of resource this is.<br>
	"ownerDomain": "A String", # Domain of source customer.<br>
	"actor": { # User doing the action.<br>
	"applicationId": "A String", # ID of application which interacted on behalf of the user.<br>
	"email": "A String", # Email address of the user.<br>
	"key": "A String", # For OAuth 2LO API requests, consumer_key of the requestor.<br>
	"callerType": "A String", # User or OAuth 2LO request.<br>
	},<br>
	"id": { # Unique identifier for each activity record.<br>
	"uniqQualifier": "A String", # Unique qualifier if multiple events have the same time.<br>
	"applicationId": "A String", # Application ID of the source application.<br>
	"customerId": "A String", # Obfuscated customer ID of the source customer.<br>
	"time": "A String", # Time of occurrence of the activity.<br>
	},<br>
	"ipAddress": "A String", # IP Address of the user doing the action.<br>
	"events": [ # Activity events.<br>
	{<br>
	"eventType": "A String", # Type of event.<br>
	"name": "A String", # Name of event.<br>
	"parameters": [ # Event parameters.<br>
	{<br>
	"name": "A String", # Name of the parameter.<br>
	"value": "A String", # Value of the parameter.<br>
	},<br>
	],<br>
	},<br>
	],<br>
	},<br>
	],<br>
	"kind": "audit#activities", # Kind of list response this is.<br>
	"next": "A String", # Next page URL.<br>
	}</tt></dd></dl>

	<hr>
	Data descriptors defined here:<br>
	<dl><dt><strong>__dict__</strong></dt>
	<dd><tt>dictionary for instance variables (if defined)</tt></dd>
	</dl>
	<dl><dt><strong>__weakref__</strong></dt>
	<dd><tt>list of weak references to the object (if defined)</tt></dd>
	</dl>
	</td></tr></table>
	</body></html>