|
Methods defined here:
- __init__(self)
- list = method(self, **kwargs)
- Lists goals to which the user has access.
Args:
max_results: integer, The maximum number of goals to include in this response.
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)
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)
start_index: integer, An index of the first goal to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
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)
Returns:
An object of the form
{
"username": "A String", # Email ID of the authenticated user
"kind": "analytics#goals", # Collection type.
"items": [ # A list of goals.
{
"kind": "analytics#goal", # Resource type for an Analytics goal.
"visitTimeOnSiteDetails": { # Details for the goal of the type VISIT_TIME_ON_SITE.
"comparisonType": "A String", # Type of comparison. Possible values are LESS_THAN or GREATER_THAN.
"comparisonValue": "A String", # Value used for this comparison.
},
"name": "A String", # Goal name.
"created": "A String", # Time this goal was created.
"urlDestinationDetails": { # Details for the goal of the type URL_DESTINATION.
"url": "A String", # URL for this goal.
"caseSensitive": True or False, # Determines if the goal URL must exactly match the capitalization of visited URLs.
"matchType": "A String", # Match type for the goal URL. Possible values are HEAD, EXACT, or REGEX.
"steps": [ # List of steps configured for this goal funnel.
{
"url": "A String", # URL for this step.
"name": "A String", # Step name.
"number": 42, # Step number.
},
],
"firstStepRequired": True or False, # Determines if the first step in this goal is required.
},
"updated": "A String", # Time this goal was last modified.
"value": 3.14, # Goal value.
"visitNumPagesDetails": { # Details for the goal of the type VISIT_NUM_PAGES.
"comparisonType": "A String", # Type of comparison. Possible values are LESS_THAN, GREATER_THAN, or EQUAL.
"comparisonValue": "A String", # Value used for this comparison.
},
"internalWebPropertyId": "A String", # Internal ID for the web property to which this goal belongs.
"eventDetails": { # Details for the goal of the type EVENT.
"eventConditions": [ # List of event conditions.
{
"type": "A String", # Type of this event condition. Possible values are CATEGORY, ACTION, LABEL, or VALUE.
"matchType": "A String", # Type of the match to be performed. Possible values are REGEXP, BEGINS_WITH, or EXACT.
"expression": "A String", # Expression used for this match.
"comparisonType": "A String", # Type of comparison. Possible values are LESS_THAN, GREATER_THAN or EQUAL.
"comparisonValue": "A String", # Value used for this comparison.
},
],
"useEventValue": True or False, # Determines if the event value should be used as the value for this goal.
},
"webPropertyId": "A String", # Web property ID to which this goal belongs. The web property ID is of the form UA-XXXXX-YY.
"active": True or False, # Determines whether this goal is active.
"profileId": "A String", # Profile ID to which this goal belongs.
"parentLink": { # Parent link for a goal. Points to the profile to which this goal belongs.
"href": "A String", # Link to the profile to which this goal belongs.
"type": "analytics#profile", # Value is "analytics#profile".
},
"type": "A String", # Goal type. Possible values are URL_DESTINATION, VISIT_TIME_ON_SITE, VISIT_NUM_PAGES, AND EVENT.
"id": "A String", # Goal ID.
"selfLink": "A String", # Link for this goal.
"accountId": "A String", # Account ID to which this goal belongs.
},
],
"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.
"previousLink": "A String", # Link to previous page for this goal collection.
"startIndex": 42, # The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.
"nextLink": "A String", # Link to next page for this goal collection.
"totalResults": 42, # The total number of results for the query, regardless of the number of resources in the result.
}
Data descriptors defined here:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
|