| |
| <!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 goals to which the user has access.<br> |
| <br> |
| Args:<br> |
| max_results: integer, The maximum number of goals to include in this response.<br> |
| webPropertyId: string, Web property ID to retrieve goals for. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to. (required)<br> |
| profileId: string, Profile ID to retrieve goals for. Can either be a specific profile ID or '~all', which refers to all the profiles that user has access to. (required)<br> |
| start_index: integer, An index of the first goal to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.<br> |
| accountId: string, Account ID to retrieve goals for. Can either be a specific account ID or '~all', which refers to all the accounts that user has access to. (required)<br> |
| <br> |
| Returns:<br> |
| An object of the form<br> |
| <br> |
| {<br> |
| "username": "A String", # Email ID of the authenticated user<br> |
| "kind": "analytics#goals", # Collection type.<br> |
| "items": [ # A list of goals.<br> |
| {<br> |
| "kind": "analytics#goal", # Resource type for an Analytics goal.<br> |
| "visitTimeOnSiteDetails": { # Details for the goal of the type VISIT_TIME_ON_SITE.<br> |
| "comparisonType": "A String", # Type of comparison. Possible values are LESS_THAN or GREATER_THAN.<br> |
| "comparisonValue": "A String", # Value used for this comparison.<br> |
| },<br> |
| "name": "A String", # Goal name.<br> |
| "created": "A String", # Time this goal was created.<br> |
| "urlDestinationDetails": { # Details for the goal of the type URL_DESTINATION.<br> |
| "url": "A String", # URL for this goal.<br> |
| "caseSensitive": True or False, # Determines if the goal URL must exactly match the capitalization of visited URLs.<br> |
| "matchType": "A String", # Match type for the goal URL. Possible values are HEAD, EXACT, or REGEX.<br> |
| "steps": [ # List of steps configured for this goal funnel.<br> |
| {<br> |
| "url": "A String", # URL for this step.<br> |
| "name": "A String", # Step name.<br> |
| "number": 42, # Step number.<br> |
| },<br> |
| ],<br> |
| "firstStepRequired": True or False, # Determines if the first step in this goal is required.<br> |
| },<br> |
| "updated": "A String", # Time this goal was last modified.<br> |
| "value": 3.14, # Goal value.<br> |
| "visitNumPagesDetails": { # Details for the goal of the type VISIT_NUM_PAGES.<br> |
| "comparisonType": "A String", # Type of comparison. Possible values are LESS_THAN, GREATER_THAN, or EQUAL.<br> |
| "comparisonValue": "A String", # Value used for this comparison.<br> |
| },<br> |
| "internalWebPropertyId": "A String", # Internal ID for the web property to which this goal belongs.<br> |
| "eventDetails": { # Details for the goal of the type EVENT.<br> |
| "eventConditions": [ # List of event conditions.<br> |
| {<br> |
| "type": "A String", # Type of this event condition. Possible values are CATEGORY, ACTION, LABEL, or VALUE.<br> |
| "matchType": "A String", # Type of the match to be performed. Possible values are REGEXP, BEGINS_WITH, or EXACT.<br> |
| "expression": "A String", # Expression used for this match.<br> |
| "comparisonType": "A String", # Type of comparison. Possible values are LESS_THAN, GREATER_THAN or EQUAL.<br> |
| "comparisonValue": "A String", # Value used for this comparison.<br> |
| },<br> |
| ],<br> |
| "useEventValue": True or False, # Determines if the event value should be used as the value for this goal.<br> |
| },<br> |
| "webPropertyId": "A String", # Web property ID to which this goal belongs. The web property ID is of the form UA-XXXXX-YY.<br> |
| "active": True or False, # Determines whether this goal is active.<br> |
| "profileId": "A String", # Profile ID to which this goal belongs.<br> |
| "parentLink": { # Parent link for a goal. Points to the profile to which this goal belongs.<br> |
| "href": "A String", # Link to the profile to which this goal belongs.<br> |
| "type": "analytics#profile", # Value is "analytics#profile".<br> |
| },<br> |
| "type": "A String", # Goal type. Possible values are URL_DESTINATION, VISIT_TIME_ON_SITE, VISIT_NUM_PAGES, AND EVENT.<br> |
| "id": "A String", # Goal ID.<br> |
| "selfLink": "A String", # Link for this goal.<br> |
| "accountId": "A String", # Account ID to which this goal belongs.<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 goal 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 goal collection.<br> |
| "totalResults": 42, # The total number of results for the query, regardless of the number of resources in the result.<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> |