Joe Gregorio | 0250385 | 2011-08-31 09:07:55 -0400 | [diff] [blame] | 1 | |
| 2 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
| 3 | <html><head><title>Python: class Resource</title> |
| 4 | </head><body bgcolor="#f0f0f8"> |
| 5 | <p> |
| 6 | <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
| 7 | <tr bgcolor="#ffc8d8"> |
| 8 | <td colspan=3 valign=bottom> <br> |
| 9 | <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> |
| 10 | |
| 11 | <tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> |
| 12 | <td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr> |
| 13 | <tr><td> </td> |
| 14 | <td width="100%">Methods defined here:<br> |
| 15 | <dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl> |
| 16 | |
| 17 | <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> |
| 18 | <br> |
| 19 | Args:<br> |
Joe Gregorio | 3d55ac5 | 2012-02-21 10:11:19 -0500 | [diff] [blame] | 20 | max_results: integer, The maximum number of goals to include in this response.<br> |
| 21 | 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> |
| 22 | 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> |
| 23 | 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> |
| 24 | 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> |
Joe Gregorio | b417caf | 2011-12-08 12:04:24 -0500 | [diff] [blame] | 25 | <br> |
| 26 | Returns:<br> |
| 27 | An object of the form<br> |
| 28 | <br> |
| 29 | {<br> |
| 30 | "username": "A String", # Email ID of the authenticated user<br> |
| 31 | "kind": "analytics#goals", # Collection type.<br> |
| 32 | "items": [ # A list of goals.<br> |
| 33 | {<br> |
| 34 | "kind": "analytics#goal", # Resource type for an Analytics goal.<br> |
| 35 | "visitTimeOnSiteDetails": { # Details for the goal of the type VISIT_TIME_ON_SITE.<br> |
| 36 | "comparisonType": "A String", # Type of comparison. Possible values are LESS_THAN or GREATER_THAN.<br> |
| 37 | "comparisonValue": "A String", # Value used for this comparison.<br> |
| 38 | },<br> |
| 39 | "name": "A String", # Goal name.<br> |
| 40 | "created": "A String", # Time this goal was created.<br> |
| 41 | "urlDestinationDetails": { # Details for the goal of the type URL_DESTINATION.<br> |
| 42 | "url": "A String", # URL for this goal.<br> |
| 43 | "caseSensitive": True or False, # Determines if the goal URL must exactly match the capitalization of visited URLs.<br> |
| 44 | "matchType": "A String", # Match type for the goal URL. Possible values are HEAD, EXACT, or REGEX.<br> |
| 45 | "steps": [ # List of steps configured for this goal funnel.<br> |
| 46 | {<br> |
| 47 | "url": "A String", # URL for this step.<br> |
| 48 | "name": "A String", # Step name.<br> |
| 49 | "number": 42, # Step number.<br> |
| 50 | },<br> |
| 51 | ],<br> |
| 52 | "firstStepRequired": True or False, # Determines if the first step in this goal is required.<br> |
| 53 | },<br> |
| 54 | "updated": "A String", # Time this goal was last modified.<br> |
Joe Gregorio | 3d55ac5 | 2012-02-21 10:11:19 -0500 | [diff] [blame] | 55 | "value": 3.14, # Goal value.<br> |
Joe Gregorio | b417caf | 2011-12-08 12:04:24 -0500 | [diff] [blame] | 56 | "visitNumPagesDetails": { # Details for the goal of the type VISIT_NUM_PAGES.<br> |
| 57 | "comparisonType": "A String", # Type of comparison. Possible values are LESS_THAN, GREATER_THAN, or EQUAL.<br> |
| 58 | "comparisonValue": "A String", # Value used for this comparison.<br> |
| 59 | },<br> |
| 60 | "internalWebPropertyId": "A String", # Internal ID for the web property to which this goal belongs.<br> |
| 61 | "eventDetails": { # Details for the goal of the type EVENT.<br> |
| 62 | "eventConditions": [ # List of event conditions.<br> |
| 63 | {<br> |
| 64 | "type": "A String", # Type of this event condition. Possible values are CATEGORY, ACTION, LABEL, or VALUE.<br> |
| 65 | "matchType": "A String", # Type of the match to be performed. Possible values are REGEXP, BEGINS_WITH, or EXACT.<br> |
| 66 | "expression": "A String", # Expression used for this match.<br> |
| 67 | "comparisonType": "A String", # Type of comparison. Possible values are LESS_THAN, GREATER_THAN or EQUAL.<br> |
| 68 | "comparisonValue": "A String", # Value used for this comparison.<br> |
| 69 | },<br> |
| 70 | ],<br> |
| 71 | "useEventValue": True or False, # Determines if the event value should be used as the value for this goal.<br> |
| 72 | },<br> |
| 73 | "webPropertyId": "A String", # Web property ID to which this goal belongs. The web property ID is of the form UA-XXXXX-YY.<br> |
| 74 | "active": True or False, # Determines whether this goal is active.<br> |
| 75 | "profileId": "A String", # Profile ID to which this goal belongs.<br> |
| 76 | "parentLink": { # Parent link for a goal. Points to the profile to which this goal belongs.<br> |
| 77 | "href": "A String", # Link to the profile to which this goal belongs.<br> |
| 78 | "type": "analytics#profile", # Value is "analytics#profile".<br> |
| 79 | },<br> |
| 80 | "type": "A String", # Goal type. Possible values are URL_DESTINATION, VISIT_TIME_ON_SITE, VISIT_NUM_PAGES, AND EVENT.<br> |
| 81 | "id": "A String", # Goal ID.<br> |
| 82 | "selfLink": "A String", # Link for this goal.<br> |
| 83 | "accountId": "A String", # Account ID to which this goal belongs.<br> |
| 84 | },<br> |
| 85 | ],<br> |
| 86 | "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> |
| 87 | "previousLink": "A String", # Link to previous page for this goal collection.<br> |
| 88 | "startIndex": 42, # The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.<br> |
| 89 | "nextLink": "A String", # Link to next page for this goal collection.<br> |
| 90 | "totalResults": 42, # The total number of results for the query, regardless of the number of resources in the result.<br> |
| 91 | }</tt></dd></dl> |
Joe Gregorio | 0250385 | 2011-08-31 09:07:55 -0400 | [diff] [blame] | 92 | |
| 93 | <hr> |
| 94 | Data descriptors defined here:<br> |
| 95 | <dl><dt><strong>__dict__</strong></dt> |
| 96 | <dd><tt>dictionary for instance variables (if defined)</tt></dd> |
| 97 | </dl> |
| 98 | <dl><dt><strong>__weakref__</strong></dt> |
| 99 | <dd><tt>list of weak references to the object (if defined)</tt></dd> |
| 100 | </dl> |
| 101 | </td></tr></table> |
| 102 | </body></html> |