docs/dyn/analytics.v3.management.segments.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>Lists&nbsp;advanced&nbsp;segments&nbsp;to&nbsp;which&nbsp;the&nbsp;user&nbsp;has&nbsp;access.<br>
 &nbsp;<br>
 Args:<br>
 &nbsp;&nbsp;max_results:&nbsp;integer,&nbsp;The&nbsp;maximum&nbsp;number&nbsp;of&nbsp;advanced&nbsp;segments&nbsp;to&nbsp;include&nbsp;in&nbsp;this&nbsp;response.<br>
 &nbsp;&nbsp;start_index:&nbsp;integer,&nbsp;An&nbsp;index&nbsp;of&nbsp;the&nbsp;first&nbsp;advanced&nbsp;segment&nbsp;to&nbsp;retrieve.&nbsp;Use&nbsp;this&nbsp;parameter&nbsp;as&nbsp;a&nbsp;pagination&nbsp;mechanism&nbsp;along&nbsp;with&nbsp;the&nbsp;max-results&nbsp;parameter.<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;"username":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Email&nbsp;ID&nbsp;of&nbsp;the&nbsp;authenticated&nbsp;user<br>
 &nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"analytics#segments",&nbsp;#&nbsp;Collection&nbsp;type&nbsp;for&nbsp;advanced&nbsp;segments.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;"items":&nbsp;[&nbsp;#&nbsp;A&nbsp;list&nbsp;of&nbsp;advanced&nbsp;segments.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"definition":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Advanced&nbsp;segment&nbsp;definition.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"analytics#segment",&nbsp;#&nbsp;Resource&nbsp;type&nbsp;for&nbsp;Analytics&nbsp;advanced&nbsp;segment.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"segmentId":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Segment&nbsp;ID.&nbsp;Can&nbsp;be&nbsp;used&nbsp;with&nbsp;the&nbsp;'segment'&nbsp;parameter&nbsp;in&nbsp;Data&nbsp;Feed.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"created":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Time&nbsp;the&nbsp;advanced&nbsp;segment&nbsp;was&nbsp;created.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"updated":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Time&nbsp;the&nbsp;advanced&nbsp;segment&nbsp;was&nbsp;last&nbsp;modified.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Advanced&nbsp;segment&nbsp;ID.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"selfLink":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Link&nbsp;for&nbsp;this&nbsp;advanced&nbsp;segment.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"name":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Advanced&nbsp;segment&nbsp;name.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
 &nbsp;&nbsp;&nbsp;&nbsp;],<br>
 &nbsp;&nbsp;&nbsp;&nbsp;"itemsPerPage":&nbsp;42,&nbsp;#&nbsp;The&nbsp;maximum&nbsp;number&nbsp;of&nbsp;resources&nbsp;the&nbsp;response&nbsp;can&nbsp;contain,&nbsp;regardless&nbsp;of&nbsp;the&nbsp;actual&nbsp;number&nbsp;of&nbsp;resources&nbsp;returned.&nbsp;Its&nbsp;value&nbsp;ranges&nbsp;from&nbsp;1&nbsp;to&nbsp;10,000&nbsp;with&nbsp;a&nbsp;value&nbsp;of&nbsp;1000&nbsp;by&nbsp;default,&nbsp;or&nbsp;otherwise&nbsp;specified&nbsp;by&nbsp;the&nbsp;max-results&nbsp;query&nbsp;parameter.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;"previousLink":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Link&nbsp;to&nbsp;previous&nbsp;page&nbsp;for&nbsp;this&nbsp;advanced&nbsp;segment&nbsp;collection.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;"startIndex":&nbsp;42,&nbsp;#&nbsp;The&nbsp;starting&nbsp;index&nbsp;of&nbsp;the&nbsp;resources,&nbsp;which&nbsp;is&nbsp;1&nbsp;by&nbsp;default&nbsp;or&nbsp;otherwise&nbsp;specified&nbsp;by&nbsp;the&nbsp;start-index&nbsp;query&nbsp;parameter.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;"nextLink":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Link&nbsp;to&nbsp;next&nbsp;page&nbsp;for&nbsp;this&nbsp;advanced&nbsp;segment&nbsp;collection.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;"totalResults":&nbsp;42,&nbsp;#&nbsp;The&nbsp;total&nbsp;number&nbsp;of&nbsp;results&nbsp;for&nbsp;the&nbsp;query,&nbsp;regardless&nbsp;of&nbsp;the&nbsp;number&nbsp;of&nbsp;results&nbsp;in&nbsp;the&nbsp;response.<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>Lists advanced segments to which the user has access.<br>
	<br>
	Args:<br>
	max_results: integer, The maximum number of advanced segments to include in this response.<br>
	start_index: integer, An index of the first advanced segment to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.<br>
	<br>
	Returns:<br>
	An object of the form<br>
	<br>
	{<br>
	"username": "A String", # Email ID of the authenticated user<br>
	"kind": "analytics#segments", # Collection type for advanced segments.<br>
	"items": [ # A list of advanced segments.<br>
	{<br>
	"definition": "A String", # Advanced segment definition.<br>
	"kind": "analytics#segment", # Resource type for Analytics advanced segment.<br>
	"segmentId": "A String", # Segment ID. Can be used with the 'segment' parameter in Data Feed.<br>
	"created": "A String", # Time the advanced segment was created.<br>
	"updated": "A String", # Time the advanced segment was last modified.<br>
	"id": "A String", # Advanced segment ID.<br>
	"selfLink": "A String", # Link for this advanced segment.<br>
	"name": "A String", # Advanced segment name.<br>
	},<br>
	],<br>
	"itemsPerPage": 42, # The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 10,000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.<br>
	"previousLink": "A String", # Link to previous page for this advanced segment collection.<br>
	"startIndex": 42, # The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.<br>
	"nextLink": "A String", # Link to next page for this advanced segment collection.<br>
	"totalResults": 42, # The total number of results for the query, regardless of the number of results in the response.<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>