chore: update generated docs (#1115)
This PR was generated using Autosynth. :rainbow:
Synth log will be available here:
https://source.cloud.google.com/results/invocations/2ed9ab0e-55b4-4ab2-aede-c95e765f7376/targets
- [x] To automatically regenerate this PR, check this box.
Source-Link: https://github.com/googleapis/discovery-artifact-manager/commit/0bed8bdae25d545e796cfcdd7a9bfffff11e69da
Source-Link: https://github.com/googleapis/synthtool/commit/c2de32114ec484aa708d32012d1fa8d75232daf5
diff --git a/docs/dyn/analytics_v3.management.goals.html b/docs/dyn/analytics_v3.management.goals.html
index f5c3293..a7c0df2 100644
--- a/docs/dyn/analytics_v3.management.goals.html
+++ b/docs/dyn/analytics_v3.management.goals.html
@@ -84,7 +84,7 @@
<code><a href="#insert">insert(accountId, webPropertyId, profileId, body=None)</a></code></p>
<p class="firstline">Create a new goal.</p>
<p class="toc_element">
- <code><a href="#list">list(accountId, webPropertyId, profileId, start_index=None, max_results=None)</a></code></p>
+ <code><a href="#list">list(accountId, webPropertyId, profileId, max_results=None, start_index=None)</a></code></p>
<p class="firstline">Lists goals to which the user has access.</p>
<p class="toc_element">
<code><a href="#patch">patch(accountId, webPropertyId, profileId, goalId, body=None)</a></code></p>
@@ -112,56 +112,56 @@
An object of the form:
{ # JSON template for Analytics goal resource.
- "selfLink": "A String", # Link for this goal.
"id": "A String", # Goal ID.
- "updated": "A String", # Time this goal was last modified.
- "kind": "analytics#goal", # Resource type for an Analytics 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.
+ "created": "A String", # Time this goal was created.
+ "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.
{
- "comparisonValue": "A String", # Value used for this comparison.
- "matchType": "A String", # Type of the match to be performed. Possible values are REGEXP, BEGINS_WITH, or EXACT.
"comparisonType": "A String", # Type of comparison. Possible values are LESS_THAN, GREATER_THAN or EQUAL.
"expression": "A String", # Expression used for this match.
"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.
+ "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.
},
- "accountId": "A String", # Account ID to which this goal belongs.
"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.
},
- "urlDestinationDetails": { # Details for the goal of the type URL_DESTINATION.
- "steps": [ # List of steps configured for this goal funnel.
- {
- "url": "A String", # URL for this step.
- "number": 42, # Step number.
- "name": "A String", # Step name.
- },
- ],
- "matchType": "A String", # Match type for the goal URL. Possible values are HEAD, EXACT, or REGEX.
- "firstStepRequired": True or False, # Determines if the first step in this goal is required.
- "url": "A String", # URL for this goal.
- "caseSensitive": True or False, # Determines if the goal URL must exactly match the capitalization of visited URLs.
- },
+ "updated": "A String", # Time this goal was last modified.
+ "profileId": "A String", # View (Profile) ID to which this goal belongs.
+ "type": "A String", # Goal type. Possible values are URL_DESTINATION, VISIT_TIME_ON_SITE, VISIT_NUM_PAGES, AND EVENT.
+ "webPropertyId": "A String", # Web property ID to which this goal belongs. The web property ID is of the form UA-XXXXX-YY.
"parentLink": { # Parent link for a goal. Points to the view (profile) to which this goal belongs.
"type": "analytics#profile", # Value is "analytics#profile".
"href": "A String", # Link to the view (profile) to which this goal belongs.
},
- "internalWebPropertyId": "A String", # Internal ID for the web property to which this goal belongs.
- "value": 3.14, # Goal value.
- "visitTimeOnSiteDetails": { # Details for the goal of the type VISIT_TIME_ON_SITE.
- "comparisonValue": "A String", # Value used for this comparison.
- "comparisonType": "A String", # Type of comparison. Possible values are LESS_THAN or GREATER_THAN.
- },
- "type": "A String", # Goal type. Possible values are URL_DESTINATION, VISIT_TIME_ON_SITE, VISIT_NUM_PAGES, AND EVENT.
- "created": "A String", # Time this goal was created.
+ "active": True or False, # Determines whether this goal is active.
"name": "A String", # Goal name.
- "profileId": "A String", # View (Profile) ID to which this goal belongs.
+ "accountId": "A String", # Account ID to which this goal belongs.
+ "selfLink": "A String", # Link for this 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.
+ },
+ "kind": "analytics#goal", # Resource type for an Analytics goal.
+ "value": 3.14, # Goal value.
+ "urlDestinationDetails": { # Details for the goal of the type URL_DESTINATION.
+ "matchType": "A String", # Match type for the goal URL. Possible values are HEAD, EXACT, or REGEX.
+ "url": "A String", # URL for this goal.
+ "caseSensitive": True or False, # Determines if the goal URL must exactly match the capitalization of visited URLs.
+ "steps": [ # List of steps configured for this goal funnel.
+ {
+ "name": "A String", # Step name.
+ "url": "A String", # URL for this step.
+ "number": 42, # Step number.
+ },
+ ],
+ "firstStepRequired": True or False, # Determines if the first step in this goal is required.
+ },
}</pre>
</div>
@@ -177,56 +177,56 @@
The object takes the form of:
{ # JSON template for Analytics goal resource.
- "selfLink": "A String", # Link for this goal.
"id": "A String", # Goal ID.
- "updated": "A String", # Time this goal was last modified.
- "kind": "analytics#goal", # Resource type for an Analytics 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.
+ "created": "A String", # Time this goal was created.
+ "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.
{
- "comparisonValue": "A String", # Value used for this comparison.
- "matchType": "A String", # Type of the match to be performed. Possible values are REGEXP, BEGINS_WITH, or EXACT.
"comparisonType": "A String", # Type of comparison. Possible values are LESS_THAN, GREATER_THAN or EQUAL.
"expression": "A String", # Expression used for this match.
"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.
+ "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.
},
- "accountId": "A String", # Account ID to which this goal belongs.
"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.
},
- "urlDestinationDetails": { # Details for the goal of the type URL_DESTINATION.
- "steps": [ # List of steps configured for this goal funnel.
- {
- "url": "A String", # URL for this step.
- "number": 42, # Step number.
- "name": "A String", # Step name.
- },
- ],
- "matchType": "A String", # Match type for the goal URL. Possible values are HEAD, EXACT, or REGEX.
- "firstStepRequired": True or False, # Determines if the first step in this goal is required.
- "url": "A String", # URL for this goal.
- "caseSensitive": True or False, # Determines if the goal URL must exactly match the capitalization of visited URLs.
- },
+ "updated": "A String", # Time this goal was last modified.
+ "profileId": "A String", # View (Profile) ID to which this goal belongs.
+ "type": "A String", # Goal type. Possible values are URL_DESTINATION, VISIT_TIME_ON_SITE, VISIT_NUM_PAGES, AND EVENT.
+ "webPropertyId": "A String", # Web property ID to which this goal belongs. The web property ID is of the form UA-XXXXX-YY.
"parentLink": { # Parent link for a goal. Points to the view (profile) to which this goal belongs.
"type": "analytics#profile", # Value is "analytics#profile".
"href": "A String", # Link to the view (profile) to which this goal belongs.
},
- "internalWebPropertyId": "A String", # Internal ID for the web property to which this goal belongs.
- "value": 3.14, # Goal value.
- "visitTimeOnSiteDetails": { # Details for the goal of the type VISIT_TIME_ON_SITE.
- "comparisonValue": "A String", # Value used for this comparison.
- "comparisonType": "A String", # Type of comparison. Possible values are LESS_THAN or GREATER_THAN.
- },
- "type": "A String", # Goal type. Possible values are URL_DESTINATION, VISIT_TIME_ON_SITE, VISIT_NUM_PAGES, AND EVENT.
- "created": "A String", # Time this goal was created.
+ "active": True or False, # Determines whether this goal is active.
"name": "A String", # Goal name.
- "profileId": "A String", # View (Profile) ID to which this goal belongs.
+ "accountId": "A String", # Account ID to which this goal belongs.
+ "selfLink": "A String", # Link for this 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.
+ },
+ "kind": "analytics#goal", # Resource type for an Analytics goal.
+ "value": 3.14, # Goal value.
+ "urlDestinationDetails": { # Details for the goal of the type URL_DESTINATION.
+ "matchType": "A String", # Match type for the goal URL. Possible values are HEAD, EXACT, or REGEX.
+ "url": "A String", # URL for this goal.
+ "caseSensitive": True or False, # Determines if the goal URL must exactly match the capitalization of visited URLs.
+ "steps": [ # List of steps configured for this goal funnel.
+ {
+ "name": "A String", # Step name.
+ "url": "A String", # URL for this step.
+ "number": 42, # Step number.
+ },
+ ],
+ "firstStepRequired": True or False, # Determines if the first step in this goal is required.
+ },
}
@@ -234,135 +234,135 @@
An object of the form:
{ # JSON template for Analytics goal resource.
- "selfLink": "A String", # Link for this goal.
"id": "A String", # Goal ID.
- "updated": "A String", # Time this goal was last modified.
- "kind": "analytics#goal", # Resource type for an Analytics 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.
+ "created": "A String", # Time this goal was created.
+ "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.
{
- "comparisonValue": "A String", # Value used for this comparison.
- "matchType": "A String", # Type of the match to be performed. Possible values are REGEXP, BEGINS_WITH, or EXACT.
"comparisonType": "A String", # Type of comparison. Possible values are LESS_THAN, GREATER_THAN or EQUAL.
"expression": "A String", # Expression used for this match.
"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.
+ "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.
},
- "accountId": "A String", # Account ID to which this goal belongs.
"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.
},
- "urlDestinationDetails": { # Details for the goal of the type URL_DESTINATION.
- "steps": [ # List of steps configured for this goal funnel.
- {
- "url": "A String", # URL for this step.
- "number": 42, # Step number.
- "name": "A String", # Step name.
- },
- ],
- "matchType": "A String", # Match type for the goal URL. Possible values are HEAD, EXACT, or REGEX.
- "firstStepRequired": True or False, # Determines if the first step in this goal is required.
- "url": "A String", # URL for this goal.
- "caseSensitive": True or False, # Determines if the goal URL must exactly match the capitalization of visited URLs.
- },
+ "updated": "A String", # Time this goal was last modified.
+ "profileId": "A String", # View (Profile) ID to which this goal belongs.
+ "type": "A String", # Goal type. Possible values are URL_DESTINATION, VISIT_TIME_ON_SITE, VISIT_NUM_PAGES, AND EVENT.
+ "webPropertyId": "A String", # Web property ID to which this goal belongs. The web property ID is of the form UA-XXXXX-YY.
"parentLink": { # Parent link for a goal. Points to the view (profile) to which this goal belongs.
"type": "analytics#profile", # Value is "analytics#profile".
"href": "A String", # Link to the view (profile) to which this goal belongs.
},
- "internalWebPropertyId": "A String", # Internal ID for the web property to which this goal belongs.
- "value": 3.14, # Goal value.
- "visitTimeOnSiteDetails": { # Details for the goal of the type VISIT_TIME_ON_SITE.
- "comparisonValue": "A String", # Value used for this comparison.
- "comparisonType": "A String", # Type of comparison. Possible values are LESS_THAN or GREATER_THAN.
- },
- "type": "A String", # Goal type. Possible values are URL_DESTINATION, VISIT_TIME_ON_SITE, VISIT_NUM_PAGES, AND EVENT.
- "created": "A String", # Time this goal was created.
+ "active": True or False, # Determines whether this goal is active.
"name": "A String", # Goal name.
- "profileId": "A String", # View (Profile) ID to which this goal belongs.
+ "accountId": "A String", # Account ID to which this goal belongs.
+ "selfLink": "A String", # Link for this 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.
+ },
+ "kind": "analytics#goal", # Resource type for an Analytics goal.
+ "value": 3.14, # Goal value.
+ "urlDestinationDetails": { # Details for the goal of the type URL_DESTINATION.
+ "matchType": "A String", # Match type for the goal URL. Possible values are HEAD, EXACT, or REGEX.
+ "url": "A String", # URL for this goal.
+ "caseSensitive": True or False, # Determines if the goal URL must exactly match the capitalization of visited URLs.
+ "steps": [ # List of steps configured for this goal funnel.
+ {
+ "name": "A String", # Step name.
+ "url": "A String", # URL for this step.
+ "number": 42, # Step number.
+ },
+ ],
+ "firstStepRequired": True or False, # Determines if the first step in this goal is required.
+ },
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(accountId, webPropertyId, profileId, start_index=None, max_results=None)</code>
+ <code class="details" id="list">list(accountId, webPropertyId, profileId, max_results=None, start_index=None)</code>
<pre>Lists goals to which the user has access.
Args:
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)
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, View (Profile) ID to retrieve goals for. Can either be a specific view (profile) ID or '~all', which refers to all the views (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.
max_results: integer, The maximum number of goals to include in this response.
+ start_index: integer, An index of the first goal to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
Returns:
An object of the form:
{ # A goal collection lists Analytics goals to which the user has access. Each view (profile) can have a set of goals. Each resource in the Goal collection corresponds to a single Analytics goal.
- "username": "A String", # Email ID of the authenticated user
+ "previousLink": "A String", # Link to previous page for this goal collection.
+ "kind": "analytics#goals", # Collection type.
"items": [ # A list of goals.
{ # JSON template for Analytics goal resource.
- "selfLink": "A String", # Link for this goal.
"id": "A String", # Goal ID.
- "updated": "A String", # Time this goal was last modified.
- "kind": "analytics#goal", # Resource type for an Analytics 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.
+ "created": "A String", # Time this goal was created.
+ "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.
{
- "comparisonValue": "A String", # Value used for this comparison.
- "matchType": "A String", # Type of the match to be performed. Possible values are REGEXP, BEGINS_WITH, or EXACT.
"comparisonType": "A String", # Type of comparison. Possible values are LESS_THAN, GREATER_THAN or EQUAL.
"expression": "A String", # Expression used for this match.
"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.
+ "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.
},
- "accountId": "A String", # Account ID to which this goal belongs.
"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.
},
- "urlDestinationDetails": { # Details for the goal of the type URL_DESTINATION.
- "steps": [ # List of steps configured for this goal funnel.
- {
- "url": "A String", # URL for this step.
- "number": 42, # Step number.
- "name": "A String", # Step name.
- },
- ],
- "matchType": "A String", # Match type for the goal URL. Possible values are HEAD, EXACT, or REGEX.
- "firstStepRequired": True or False, # Determines if the first step in this goal is required.
- "url": "A String", # URL for this goal.
- "caseSensitive": True or False, # Determines if the goal URL must exactly match the capitalization of visited URLs.
- },
+ "updated": "A String", # Time this goal was last modified.
+ "profileId": "A String", # View (Profile) ID to which this goal belongs.
+ "type": "A String", # Goal type. Possible values are URL_DESTINATION, VISIT_TIME_ON_SITE, VISIT_NUM_PAGES, AND EVENT.
+ "webPropertyId": "A String", # Web property ID to which this goal belongs. The web property ID is of the form UA-XXXXX-YY.
"parentLink": { # Parent link for a goal. Points to the view (profile) to which this goal belongs.
"type": "analytics#profile", # Value is "analytics#profile".
"href": "A String", # Link to the view (profile) to which this goal belongs.
},
- "internalWebPropertyId": "A String", # Internal ID for the web property to which this goal belongs.
- "value": 3.14, # Goal value.
- "visitTimeOnSiteDetails": { # Details for the goal of the type VISIT_TIME_ON_SITE.
- "comparisonValue": "A String", # Value used for this comparison.
- "comparisonType": "A String", # Type of comparison. Possible values are LESS_THAN or GREATER_THAN.
- },
- "type": "A String", # Goal type. Possible values are URL_DESTINATION, VISIT_TIME_ON_SITE, VISIT_NUM_PAGES, AND EVENT.
- "created": "A String", # Time this goal was created.
+ "active": True or False, # Determines whether this goal is active.
"name": "A String", # Goal name.
- "profileId": "A String", # View (Profile) ID to which this goal belongs.
+ "accountId": "A String", # Account ID to which this goal belongs.
+ "selfLink": "A String", # Link for this 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.
+ },
+ "kind": "analytics#goal", # Resource type for an Analytics goal.
+ "value": 3.14, # Goal value.
+ "urlDestinationDetails": { # Details for the goal of the type URL_DESTINATION.
+ "matchType": "A String", # Match type for the goal URL. Possible values are HEAD, EXACT, or REGEX.
+ "url": "A String", # URL for this goal.
+ "caseSensitive": True or False, # Determines if the goal URL must exactly match the capitalization of visited URLs.
+ "steps": [ # List of steps configured for this goal funnel.
+ {
+ "name": "A String", # Step name.
+ "url": "A String", # URL for this step.
+ "number": 42, # Step number.
+ },
+ ],
+ "firstStepRequired": True or False, # Determines if the first step in this goal is required.
+ },
},
],
- "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 1000 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.
- "kind": "analytics#goals", # Collection type.
- "nextLink": "A String", # Link to next page for this goal collection.
+ "username": "A String", # Email ID of the authenticated user
"totalResults": 42, # The total number of results for the query, regardless of the number of resources in the result.
"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.
+ "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 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.
}</pre>
</div>
@@ -379,56 +379,56 @@
The object takes the form of:
{ # JSON template for Analytics goal resource.
- "selfLink": "A String", # Link for this goal.
"id": "A String", # Goal ID.
- "updated": "A String", # Time this goal was last modified.
- "kind": "analytics#goal", # Resource type for an Analytics 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.
+ "created": "A String", # Time this goal was created.
+ "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.
{
- "comparisonValue": "A String", # Value used for this comparison.
- "matchType": "A String", # Type of the match to be performed. Possible values are REGEXP, BEGINS_WITH, or EXACT.
"comparisonType": "A String", # Type of comparison. Possible values are LESS_THAN, GREATER_THAN or EQUAL.
"expression": "A String", # Expression used for this match.
"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.
+ "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.
},
- "accountId": "A String", # Account ID to which this goal belongs.
"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.
},
- "urlDestinationDetails": { # Details for the goal of the type URL_DESTINATION.
- "steps": [ # List of steps configured for this goal funnel.
- {
- "url": "A String", # URL for this step.
- "number": 42, # Step number.
- "name": "A String", # Step name.
- },
- ],
- "matchType": "A String", # Match type for the goal URL. Possible values are HEAD, EXACT, or REGEX.
- "firstStepRequired": True or False, # Determines if the first step in this goal is required.
- "url": "A String", # URL for this goal.
- "caseSensitive": True or False, # Determines if the goal URL must exactly match the capitalization of visited URLs.
- },
+ "updated": "A String", # Time this goal was last modified.
+ "profileId": "A String", # View (Profile) ID to which this goal belongs.
+ "type": "A String", # Goal type. Possible values are URL_DESTINATION, VISIT_TIME_ON_SITE, VISIT_NUM_PAGES, AND EVENT.
+ "webPropertyId": "A String", # Web property ID to which this goal belongs. The web property ID is of the form UA-XXXXX-YY.
"parentLink": { # Parent link for a goal. Points to the view (profile) to which this goal belongs.
"type": "analytics#profile", # Value is "analytics#profile".
"href": "A String", # Link to the view (profile) to which this goal belongs.
},
- "internalWebPropertyId": "A String", # Internal ID for the web property to which this goal belongs.
- "value": 3.14, # Goal value.
- "visitTimeOnSiteDetails": { # Details for the goal of the type VISIT_TIME_ON_SITE.
- "comparisonValue": "A String", # Value used for this comparison.
- "comparisonType": "A String", # Type of comparison. Possible values are LESS_THAN or GREATER_THAN.
- },
- "type": "A String", # Goal type. Possible values are URL_DESTINATION, VISIT_TIME_ON_SITE, VISIT_NUM_PAGES, AND EVENT.
- "created": "A String", # Time this goal was created.
+ "active": True or False, # Determines whether this goal is active.
"name": "A String", # Goal name.
- "profileId": "A String", # View (Profile) ID to which this goal belongs.
+ "accountId": "A String", # Account ID to which this goal belongs.
+ "selfLink": "A String", # Link for this 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.
+ },
+ "kind": "analytics#goal", # Resource type for an Analytics goal.
+ "value": 3.14, # Goal value.
+ "urlDestinationDetails": { # Details for the goal of the type URL_DESTINATION.
+ "matchType": "A String", # Match type for the goal URL. Possible values are HEAD, EXACT, or REGEX.
+ "url": "A String", # URL for this goal.
+ "caseSensitive": True or False, # Determines if the goal URL must exactly match the capitalization of visited URLs.
+ "steps": [ # List of steps configured for this goal funnel.
+ {
+ "name": "A String", # Step name.
+ "url": "A String", # URL for this step.
+ "number": 42, # Step number.
+ },
+ ],
+ "firstStepRequired": True or False, # Determines if the first step in this goal is required.
+ },
}
@@ -436,56 +436,56 @@
An object of the form:
{ # JSON template for Analytics goal resource.
- "selfLink": "A String", # Link for this goal.
"id": "A String", # Goal ID.
- "updated": "A String", # Time this goal was last modified.
- "kind": "analytics#goal", # Resource type for an Analytics 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.
+ "created": "A String", # Time this goal was created.
+ "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.
{
- "comparisonValue": "A String", # Value used for this comparison.
- "matchType": "A String", # Type of the match to be performed. Possible values are REGEXP, BEGINS_WITH, or EXACT.
"comparisonType": "A String", # Type of comparison. Possible values are LESS_THAN, GREATER_THAN or EQUAL.
"expression": "A String", # Expression used for this match.
"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.
+ "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.
},
- "accountId": "A String", # Account ID to which this goal belongs.
"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.
},
- "urlDestinationDetails": { # Details for the goal of the type URL_DESTINATION.
- "steps": [ # List of steps configured for this goal funnel.
- {
- "url": "A String", # URL for this step.
- "number": 42, # Step number.
- "name": "A String", # Step name.
- },
- ],
- "matchType": "A String", # Match type for the goal URL. Possible values are HEAD, EXACT, or REGEX.
- "firstStepRequired": True or False, # Determines if the first step in this goal is required.
- "url": "A String", # URL for this goal.
- "caseSensitive": True or False, # Determines if the goal URL must exactly match the capitalization of visited URLs.
- },
+ "updated": "A String", # Time this goal was last modified.
+ "profileId": "A String", # View (Profile) ID to which this goal belongs.
+ "type": "A String", # Goal type. Possible values are URL_DESTINATION, VISIT_TIME_ON_SITE, VISIT_NUM_PAGES, AND EVENT.
+ "webPropertyId": "A String", # Web property ID to which this goal belongs. The web property ID is of the form UA-XXXXX-YY.
"parentLink": { # Parent link for a goal. Points to the view (profile) to which this goal belongs.
"type": "analytics#profile", # Value is "analytics#profile".
"href": "A String", # Link to the view (profile) to which this goal belongs.
},
- "internalWebPropertyId": "A String", # Internal ID for the web property to which this goal belongs.
- "value": 3.14, # Goal value.
- "visitTimeOnSiteDetails": { # Details for the goal of the type VISIT_TIME_ON_SITE.
- "comparisonValue": "A String", # Value used for this comparison.
- "comparisonType": "A String", # Type of comparison. Possible values are LESS_THAN or GREATER_THAN.
- },
- "type": "A String", # Goal type. Possible values are URL_DESTINATION, VISIT_TIME_ON_SITE, VISIT_NUM_PAGES, AND EVENT.
- "created": "A String", # Time this goal was created.
+ "active": True or False, # Determines whether this goal is active.
"name": "A String", # Goal name.
- "profileId": "A String", # View (Profile) ID to which this goal belongs.
+ "accountId": "A String", # Account ID to which this goal belongs.
+ "selfLink": "A String", # Link for this 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.
+ },
+ "kind": "analytics#goal", # Resource type for an Analytics goal.
+ "value": 3.14, # Goal value.
+ "urlDestinationDetails": { # Details for the goal of the type URL_DESTINATION.
+ "matchType": "A String", # Match type for the goal URL. Possible values are HEAD, EXACT, or REGEX.
+ "url": "A String", # URL for this goal.
+ "caseSensitive": True or False, # Determines if the goal URL must exactly match the capitalization of visited URLs.
+ "steps": [ # List of steps configured for this goal funnel.
+ {
+ "name": "A String", # Step name.
+ "url": "A String", # URL for this step.
+ "number": 42, # Step number.
+ },
+ ],
+ "firstStepRequired": True or False, # Determines if the first step in this goal is required.
+ },
}</pre>
</div>
@@ -502,56 +502,56 @@
The object takes the form of:
{ # JSON template for Analytics goal resource.
- "selfLink": "A String", # Link for this goal.
"id": "A String", # Goal ID.
- "updated": "A String", # Time this goal was last modified.
- "kind": "analytics#goal", # Resource type for an Analytics 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.
+ "created": "A String", # Time this goal was created.
+ "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.
{
- "comparisonValue": "A String", # Value used for this comparison.
- "matchType": "A String", # Type of the match to be performed. Possible values are REGEXP, BEGINS_WITH, or EXACT.
"comparisonType": "A String", # Type of comparison. Possible values are LESS_THAN, GREATER_THAN or EQUAL.
"expression": "A String", # Expression used for this match.
"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.
+ "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.
},
- "accountId": "A String", # Account ID to which this goal belongs.
"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.
},
- "urlDestinationDetails": { # Details for the goal of the type URL_DESTINATION.
- "steps": [ # List of steps configured for this goal funnel.
- {
- "url": "A String", # URL for this step.
- "number": 42, # Step number.
- "name": "A String", # Step name.
- },
- ],
- "matchType": "A String", # Match type for the goal URL. Possible values are HEAD, EXACT, or REGEX.
- "firstStepRequired": True or False, # Determines if the first step in this goal is required.
- "url": "A String", # URL for this goal.
- "caseSensitive": True or False, # Determines if the goal URL must exactly match the capitalization of visited URLs.
- },
+ "updated": "A String", # Time this goal was last modified.
+ "profileId": "A String", # View (Profile) ID to which this goal belongs.
+ "type": "A String", # Goal type. Possible values are URL_DESTINATION, VISIT_TIME_ON_SITE, VISIT_NUM_PAGES, AND EVENT.
+ "webPropertyId": "A String", # Web property ID to which this goal belongs. The web property ID is of the form UA-XXXXX-YY.
"parentLink": { # Parent link for a goal. Points to the view (profile) to which this goal belongs.
"type": "analytics#profile", # Value is "analytics#profile".
"href": "A String", # Link to the view (profile) to which this goal belongs.
},
- "internalWebPropertyId": "A String", # Internal ID for the web property to which this goal belongs.
- "value": 3.14, # Goal value.
- "visitTimeOnSiteDetails": { # Details for the goal of the type VISIT_TIME_ON_SITE.
- "comparisonValue": "A String", # Value used for this comparison.
- "comparisonType": "A String", # Type of comparison. Possible values are LESS_THAN or GREATER_THAN.
- },
- "type": "A String", # Goal type. Possible values are URL_DESTINATION, VISIT_TIME_ON_SITE, VISIT_NUM_PAGES, AND EVENT.
- "created": "A String", # Time this goal was created.
+ "active": True or False, # Determines whether this goal is active.
"name": "A String", # Goal name.
- "profileId": "A String", # View (Profile) ID to which this goal belongs.
+ "accountId": "A String", # Account ID to which this goal belongs.
+ "selfLink": "A String", # Link for this 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.
+ },
+ "kind": "analytics#goal", # Resource type for an Analytics goal.
+ "value": 3.14, # Goal value.
+ "urlDestinationDetails": { # Details for the goal of the type URL_DESTINATION.
+ "matchType": "A String", # Match type for the goal URL. Possible values are HEAD, EXACT, or REGEX.
+ "url": "A String", # URL for this goal.
+ "caseSensitive": True or False, # Determines if the goal URL must exactly match the capitalization of visited URLs.
+ "steps": [ # List of steps configured for this goal funnel.
+ {
+ "name": "A String", # Step name.
+ "url": "A String", # URL for this step.
+ "number": 42, # Step number.
+ },
+ ],
+ "firstStepRequired": True or False, # Determines if the first step in this goal is required.
+ },
}
@@ -559,56 +559,56 @@
An object of the form:
{ # JSON template for Analytics goal resource.
- "selfLink": "A String", # Link for this goal.
"id": "A String", # Goal ID.
- "updated": "A String", # Time this goal was last modified.
- "kind": "analytics#goal", # Resource type for an Analytics 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.
+ "created": "A String", # Time this goal was created.
+ "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.
{
- "comparisonValue": "A String", # Value used for this comparison.
- "matchType": "A String", # Type of the match to be performed. Possible values are REGEXP, BEGINS_WITH, or EXACT.
"comparisonType": "A String", # Type of comparison. Possible values are LESS_THAN, GREATER_THAN or EQUAL.
"expression": "A String", # Expression used for this match.
"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.
+ "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.
},
- "accountId": "A String", # Account ID to which this goal belongs.
"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.
},
- "urlDestinationDetails": { # Details for the goal of the type URL_DESTINATION.
- "steps": [ # List of steps configured for this goal funnel.
- {
- "url": "A String", # URL for this step.
- "number": 42, # Step number.
- "name": "A String", # Step name.
- },
- ],
- "matchType": "A String", # Match type for the goal URL. Possible values are HEAD, EXACT, or REGEX.
- "firstStepRequired": True or False, # Determines if the first step in this goal is required.
- "url": "A String", # URL for this goal.
- "caseSensitive": True or False, # Determines if the goal URL must exactly match the capitalization of visited URLs.
- },
+ "updated": "A String", # Time this goal was last modified.
+ "profileId": "A String", # View (Profile) ID to which this goal belongs.
+ "type": "A String", # Goal type. Possible values are URL_DESTINATION, VISIT_TIME_ON_SITE, VISIT_NUM_PAGES, AND EVENT.
+ "webPropertyId": "A String", # Web property ID to which this goal belongs. The web property ID is of the form UA-XXXXX-YY.
"parentLink": { # Parent link for a goal. Points to the view (profile) to which this goal belongs.
"type": "analytics#profile", # Value is "analytics#profile".
"href": "A String", # Link to the view (profile) to which this goal belongs.
},
- "internalWebPropertyId": "A String", # Internal ID for the web property to which this goal belongs.
- "value": 3.14, # Goal value.
- "visitTimeOnSiteDetails": { # Details for the goal of the type VISIT_TIME_ON_SITE.
- "comparisonValue": "A String", # Value used for this comparison.
- "comparisonType": "A String", # Type of comparison. Possible values are LESS_THAN or GREATER_THAN.
- },
- "type": "A String", # Goal type. Possible values are URL_DESTINATION, VISIT_TIME_ON_SITE, VISIT_NUM_PAGES, AND EVENT.
- "created": "A String", # Time this goal was created.
+ "active": True or False, # Determines whether this goal is active.
"name": "A String", # Goal name.
- "profileId": "A String", # View (Profile) ID to which this goal belongs.
+ "accountId": "A String", # Account ID to which this goal belongs.
+ "selfLink": "A String", # Link for this 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.
+ },
+ "kind": "analytics#goal", # Resource type for an Analytics goal.
+ "value": 3.14, # Goal value.
+ "urlDestinationDetails": { # Details for the goal of the type URL_DESTINATION.
+ "matchType": "A String", # Match type for the goal URL. Possible values are HEAD, EXACT, or REGEX.
+ "url": "A String", # URL for this goal.
+ "caseSensitive": True or False, # Determines if the goal URL must exactly match the capitalization of visited URLs.
+ "steps": [ # List of steps configured for this goal funnel.
+ {
+ "name": "A String", # Step name.
+ "url": "A String", # URL for this step.
+ "number": 42, # Step number.
+ },
+ ],
+ "firstStepRequired": True or False, # Determines if the first step in this goal is required.
+ },
}</pre>
</div>