docs: update generated docs (#1053)
Updates for both discovery docs and epydoc API Documentation
Fixes: #1049
diff --git a/docs/dyn/analytics_v3.management.profileUserLinks.html b/docs/dyn/analytics_v3.management.profileUserLinks.html
index d459e79..6d15308 100644
--- a/docs/dyn/analytics_v3.management.profileUserLinks.html
+++ b/docs/dyn/analytics_v3.management.profileUserLinks.html
@@ -75,19 +75,27 @@
<h1><a href="analytics_v3.html">Google Analytics API</a> . <a href="analytics_v3.management.html">management</a> . <a href="analytics_v3.management.profileUserLinks.html">profileUserLinks</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
+ <code><a href="#close">close()</a></code></p>
+<p class="firstline">Close httplib2 connections.</p>
+<p class="toc_element">
<code><a href="#delete">delete(accountId, webPropertyId, profileId, linkId)</a></code></p>
<p class="firstline">Removes a user from the given view (profile).</p>
<p class="toc_element">
<code><a href="#insert">insert(accountId, webPropertyId, profileId, body=None)</a></code></p>
<p class="firstline">Adds a new user to the given view (profile).</p>
<p class="toc_element">
- <code><a href="#list">list(accountId, webPropertyId, profileId, max_results=None, start_index=None)</a></code></p>
+ <code><a href="#list">list(accountId, webPropertyId, profileId, start_index=None, max_results=None)</a></code></p>
<p class="firstline">Lists profile-user links for a given view (profile).</p>
<p class="toc_element">
<code><a href="#update">update(accountId, webPropertyId, profileId, linkId, body=None)</a></code></p>
<p class="firstline">Updates permissions for an existing user on the given view (profile).</p>
<h3>Method Details</h3>
<div class="method">
+ <code class="details" id="close">close()</code>
+ <pre>Close httplib2 connections.</pre>
+</div>
+
+<div class="method">
<code class="details" id="delete">delete(accountId, webPropertyId, profileId, linkId)</code>
<pre>Removes a user from the given view (profile).
@@ -111,37 +119,39 @@
The object takes the form of:
{ # JSON template for an Analytics Entity-User Link. Returns permissions that a user has for an entity.
- "id": "A String", # Entity user link ID
- "entity": { # Entity for this link. It can be an account, a web property, or a view (profile).
- "accountRef": { # JSON template for a linked account. # Account for this link.
- "name": "A String", # Account name.
- "kind": "analytics#accountRef", # Analytics account reference.
- "href": "A String", # Link for this account.
- "id": "A String", # Account ID.
- },
- "webPropertyRef": { # JSON template for a web property reference. # Web property for this link.
- "name": "A String", # Name of this web property.
- "id": "A String", # Web property ID of the form UA-XXXXX-YY.
- "kind": "analytics#webPropertyRef", # Analytics web property reference.
- "href": "A String", # Link for this web property.
- "accountId": "A String", # Account ID to which this web property belongs.
- "internalWebPropertyId": "A String", # Internal ID for this web property.
- },
- "profileRef": { # JSON template for a linked view (profile). # View (Profile) for this link.
- "id": "A String", # View (Profile) ID.
- "name": "A String", # Name of this view (profile).
- "kind": "analytics#profileRef", # Analytics view (profile) reference.
- "accountId": "A String", # Account ID to which this view (profile) belongs.
- "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.
- "href": "A String", # Link for this view (profile).
- "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.
- },
- },
"userRef": { # JSON template for a user reference. # User reference.
- "id": "A String", # User ID.
"email": "A String", # Email ID of this user.
"kind": "analytics#userRef",
+ "id": "A String", # User ID.
},
+ "selfLink": "A String", # Self link for this resource.
+ "kind": "analytics#entityUserLink", # Resource type for entity user link.
+ "entity": { # Entity for this link. It can be an account, a web property, or a view (profile).
+ "accountRef": { # JSON template for a linked account. # Account for this link.
+ "href": "A String", # Link for this account.
+ "kind": "analytics#accountRef", # Analytics account reference.
+ "name": "A String", # Account name.
+ "id": "A String", # Account ID.
+ },
+ "profileRef": { # JSON template for a linked view (profile). # View (Profile) for this link.
+ "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.
+ "kind": "analytics#profileRef", # Analytics view (profile) reference.
+ "name": "A String", # Name of this view (profile).
+ "href": "A String", # Link for this view (profile).
+ "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.
+ "id": "A String", # View (Profile) ID.
+ "accountId": "A String", # Account ID to which this view (profile) belongs.
+ },
+ "webPropertyRef": { # JSON template for a web property reference. # Web property for this link.
+ "internalWebPropertyId": "A String", # Internal ID for this web property.
+ "href": "A String", # Link for this web property.
+ "accountId": "A String", # Account ID to which this web property belongs.
+ "id": "A String", # Web property ID of the form UA-XXXXX-YY.
+ "name": "A String", # Name of this web property.
+ "kind": "analytics#webPropertyRef", # Analytics web property reference.
+ },
+ },
+ "id": "A String", # Entity user link ID
"permissions": { # Permissions the user has for this entity.
"local": [ # Permissions that a user has been assigned at this very level. Does not include any implied or inherited permissions. Local permissions are modifiable.
"A String",
@@ -150,8 +160,6 @@
"A String",
],
},
- "selfLink": "A String", # Self link for this resource.
- "kind": "analytics#entityUserLink", # Resource type for entity user link.
}
@@ -159,37 +167,39 @@
An object of the form:
{ # JSON template for an Analytics Entity-User Link. Returns permissions that a user has for an entity.
- "id": "A String", # Entity user link ID
- "entity": { # Entity for this link. It can be an account, a web property, or a view (profile).
- "accountRef": { # JSON template for a linked account. # Account for this link.
- "name": "A String", # Account name.
- "kind": "analytics#accountRef", # Analytics account reference.
- "href": "A String", # Link for this account.
- "id": "A String", # Account ID.
- },
- "webPropertyRef": { # JSON template for a web property reference. # Web property for this link.
- "name": "A String", # Name of this web property.
- "id": "A String", # Web property ID of the form UA-XXXXX-YY.
- "kind": "analytics#webPropertyRef", # Analytics web property reference.
- "href": "A String", # Link for this web property.
- "accountId": "A String", # Account ID to which this web property belongs.
- "internalWebPropertyId": "A String", # Internal ID for this web property.
- },
- "profileRef": { # JSON template for a linked view (profile). # View (Profile) for this link.
- "id": "A String", # View (Profile) ID.
- "name": "A String", # Name of this view (profile).
- "kind": "analytics#profileRef", # Analytics view (profile) reference.
- "accountId": "A String", # Account ID to which this view (profile) belongs.
- "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.
- "href": "A String", # Link for this view (profile).
- "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.
- },
- },
"userRef": { # JSON template for a user reference. # User reference.
- "id": "A String", # User ID.
"email": "A String", # Email ID of this user.
"kind": "analytics#userRef",
+ "id": "A String", # User ID.
},
+ "selfLink": "A String", # Self link for this resource.
+ "kind": "analytics#entityUserLink", # Resource type for entity user link.
+ "entity": { # Entity for this link. It can be an account, a web property, or a view (profile).
+ "accountRef": { # JSON template for a linked account. # Account for this link.
+ "href": "A String", # Link for this account.
+ "kind": "analytics#accountRef", # Analytics account reference.
+ "name": "A String", # Account name.
+ "id": "A String", # Account ID.
+ },
+ "profileRef": { # JSON template for a linked view (profile). # View (Profile) for this link.
+ "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.
+ "kind": "analytics#profileRef", # Analytics view (profile) reference.
+ "name": "A String", # Name of this view (profile).
+ "href": "A String", # Link for this view (profile).
+ "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.
+ "id": "A String", # View (Profile) ID.
+ "accountId": "A String", # Account ID to which this view (profile) belongs.
+ },
+ "webPropertyRef": { # JSON template for a web property reference. # Web property for this link.
+ "internalWebPropertyId": "A String", # Internal ID for this web property.
+ "href": "A String", # Link for this web property.
+ "accountId": "A String", # Account ID to which this web property belongs.
+ "id": "A String", # Web property ID of the form UA-XXXXX-YY.
+ "name": "A String", # Name of this web property.
+ "kind": "analytics#webPropertyRef", # Analytics web property reference.
+ },
+ },
+ "id": "A String", # Entity user link ID
"permissions": { # Permissions the user has for this entity.
"local": [ # Permissions that a user has been assigned at this very level. Does not include any implied or inherited permissions. Local permissions are modifiable.
"A String",
@@ -198,59 +208,62 @@
"A String",
],
},
- "selfLink": "A String", # Self link for this resource.
- "kind": "analytics#entityUserLink", # Resource type for entity user link.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(accountId, webPropertyId, profileId, max_results=None, start_index=None)</code>
+ <code class="details" id="list">list(accountId, webPropertyId, profileId, start_index=None, max_results=None)</code>
<pre>Lists profile-user links for a given view (profile).
Args:
accountId: string, Account ID which the given view (profile) belongs to. (required)
webPropertyId: string, Web Property ID which the given view (profile) belongs to. 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 the profile-user links for. Can either be a specific profile ID or '~all', which refers to all the profiles that user has access to. (required)
- max_results: integer, The maximum number of profile-user links to include in this response.
start_index: integer, An index of the first profile-user link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
+ max_results: integer, The maximum number of profile-user links to include in this response.
Returns:
An object of the form:
{ # An entity user link collection provides a list of Analytics ACL links Each resource in this collection corresponds to a single link.
+ "previousLink": "A String", # Previous link for this account collection.
+ "nextLink": "A String", # Next link for this account collection.
+ "totalResults": 42, # The total number of results for the query, regardless of the number of results in the response.
"items": [ # A list of entity user links.
{ # JSON template for an Analytics Entity-User Link. Returns permissions that a user has for an entity.
- "id": "A String", # Entity user link ID
- "entity": { # Entity for this link. It can be an account, a web property, or a view (profile).
- "accountRef": { # JSON template for a linked account. # Account for this link.
- "name": "A String", # Account name.
- "kind": "analytics#accountRef", # Analytics account reference.
- "href": "A String", # Link for this account.
- "id": "A String", # Account ID.
- },
- "webPropertyRef": { # JSON template for a web property reference. # Web property for this link.
- "name": "A String", # Name of this web property.
- "id": "A String", # Web property ID of the form UA-XXXXX-YY.
- "kind": "analytics#webPropertyRef", # Analytics web property reference.
- "href": "A String", # Link for this web property.
- "accountId": "A String", # Account ID to which this web property belongs.
- "internalWebPropertyId": "A String", # Internal ID for this web property.
- },
- "profileRef": { # JSON template for a linked view (profile). # View (Profile) for this link.
- "id": "A String", # View (Profile) ID.
- "name": "A String", # Name of this view (profile).
- "kind": "analytics#profileRef", # Analytics view (profile) reference.
- "accountId": "A String", # Account ID to which this view (profile) belongs.
- "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.
- "href": "A String", # Link for this view (profile).
- "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.
- },
- },
"userRef": { # JSON template for a user reference. # User reference.
- "id": "A String", # User ID.
"email": "A String", # Email ID of this user.
"kind": "analytics#userRef",
+ "id": "A String", # User ID.
},
+ "selfLink": "A String", # Self link for this resource.
+ "kind": "analytics#entityUserLink", # Resource type for entity user link.
+ "entity": { # Entity for this link. It can be an account, a web property, or a view (profile).
+ "accountRef": { # JSON template for a linked account. # Account for this link.
+ "href": "A String", # Link for this account.
+ "kind": "analytics#accountRef", # Analytics account reference.
+ "name": "A String", # Account name.
+ "id": "A String", # Account ID.
+ },
+ "profileRef": { # JSON template for a linked view (profile). # View (Profile) for this link.
+ "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.
+ "kind": "analytics#profileRef", # Analytics view (profile) reference.
+ "name": "A String", # Name of this view (profile).
+ "href": "A String", # Link for this view (profile).
+ "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.
+ "id": "A String", # View (Profile) ID.
+ "accountId": "A String", # Account ID to which this view (profile) belongs.
+ },
+ "webPropertyRef": { # JSON template for a web property reference. # Web property for this link.
+ "internalWebPropertyId": "A String", # Internal ID for this web property.
+ "href": "A String", # Link for this web property.
+ "accountId": "A String", # Account ID to which this web property belongs.
+ "id": "A String", # Web property ID of the form UA-XXXXX-YY.
+ "name": "A String", # Name of this web property.
+ "kind": "analytics#webPropertyRef", # Analytics web property reference.
+ },
+ },
+ "id": "A String", # Entity user link ID
"permissions": { # Permissions the user has for this entity.
"local": [ # Permissions that a user has been assigned at this very level. Does not include any implied or inherited permissions. Local permissions are modifiable.
"A String",
@@ -259,16 +272,11 @@
"A String",
],
},
- "selfLink": "A String", # Self link for this resource.
- "kind": "analytics#entityUserLink", # Resource type for entity user link.
},
],
- "startIndex": 42, # The starting index of the entries, which is 1 by default or otherwise specified by the start-index query parameter.
- "itemsPerPage": 42, # The maximum number of entries the response can contain, regardless of the actual number of entries returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.
- "totalResults": 42, # The total number of results for the query, regardless of the number of results in the response.
- "previousLink": "A String", # Previous link for this account collection.
"kind": "analytics#entityUserLinks", # Collection type.
- "nextLink": "A String", # Next link for this account collection.
+ "itemsPerPage": 42, # The maximum number of entries the response can contain, regardless of the actual number of entries returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.
+ "startIndex": 42, # The starting index of the entries, which is 1 by default or otherwise specified by the start-index query parameter.
}</pre>
</div>
@@ -285,37 +293,39 @@
The object takes the form of:
{ # JSON template for an Analytics Entity-User Link. Returns permissions that a user has for an entity.
- "id": "A String", # Entity user link ID
- "entity": { # Entity for this link. It can be an account, a web property, or a view (profile).
- "accountRef": { # JSON template for a linked account. # Account for this link.
- "name": "A String", # Account name.
- "kind": "analytics#accountRef", # Analytics account reference.
- "href": "A String", # Link for this account.
- "id": "A String", # Account ID.
- },
- "webPropertyRef": { # JSON template for a web property reference. # Web property for this link.
- "name": "A String", # Name of this web property.
- "id": "A String", # Web property ID of the form UA-XXXXX-YY.
- "kind": "analytics#webPropertyRef", # Analytics web property reference.
- "href": "A String", # Link for this web property.
- "accountId": "A String", # Account ID to which this web property belongs.
- "internalWebPropertyId": "A String", # Internal ID for this web property.
- },
- "profileRef": { # JSON template for a linked view (profile). # View (Profile) for this link.
- "id": "A String", # View (Profile) ID.
- "name": "A String", # Name of this view (profile).
- "kind": "analytics#profileRef", # Analytics view (profile) reference.
- "accountId": "A String", # Account ID to which this view (profile) belongs.
- "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.
- "href": "A String", # Link for this view (profile).
- "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.
- },
- },
"userRef": { # JSON template for a user reference. # User reference.
- "id": "A String", # User ID.
"email": "A String", # Email ID of this user.
"kind": "analytics#userRef",
+ "id": "A String", # User ID.
},
+ "selfLink": "A String", # Self link for this resource.
+ "kind": "analytics#entityUserLink", # Resource type for entity user link.
+ "entity": { # Entity for this link. It can be an account, a web property, or a view (profile).
+ "accountRef": { # JSON template for a linked account. # Account for this link.
+ "href": "A String", # Link for this account.
+ "kind": "analytics#accountRef", # Analytics account reference.
+ "name": "A String", # Account name.
+ "id": "A String", # Account ID.
+ },
+ "profileRef": { # JSON template for a linked view (profile). # View (Profile) for this link.
+ "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.
+ "kind": "analytics#profileRef", # Analytics view (profile) reference.
+ "name": "A String", # Name of this view (profile).
+ "href": "A String", # Link for this view (profile).
+ "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.
+ "id": "A String", # View (Profile) ID.
+ "accountId": "A String", # Account ID to which this view (profile) belongs.
+ },
+ "webPropertyRef": { # JSON template for a web property reference. # Web property for this link.
+ "internalWebPropertyId": "A String", # Internal ID for this web property.
+ "href": "A String", # Link for this web property.
+ "accountId": "A String", # Account ID to which this web property belongs.
+ "id": "A String", # Web property ID of the form UA-XXXXX-YY.
+ "name": "A String", # Name of this web property.
+ "kind": "analytics#webPropertyRef", # Analytics web property reference.
+ },
+ },
+ "id": "A String", # Entity user link ID
"permissions": { # Permissions the user has for this entity.
"local": [ # Permissions that a user has been assigned at this very level. Does not include any implied or inherited permissions. Local permissions are modifiable.
"A String",
@@ -324,8 +334,6 @@
"A String",
],
},
- "selfLink": "A String", # Self link for this resource.
- "kind": "analytics#entityUserLink", # Resource type for entity user link.
}
@@ -333,37 +341,39 @@
An object of the form:
{ # JSON template for an Analytics Entity-User Link. Returns permissions that a user has for an entity.
- "id": "A String", # Entity user link ID
- "entity": { # Entity for this link. It can be an account, a web property, or a view (profile).
- "accountRef": { # JSON template for a linked account. # Account for this link.
- "name": "A String", # Account name.
- "kind": "analytics#accountRef", # Analytics account reference.
- "href": "A String", # Link for this account.
- "id": "A String", # Account ID.
- },
- "webPropertyRef": { # JSON template for a web property reference. # Web property for this link.
- "name": "A String", # Name of this web property.
- "id": "A String", # Web property ID of the form UA-XXXXX-YY.
- "kind": "analytics#webPropertyRef", # Analytics web property reference.
- "href": "A String", # Link for this web property.
- "accountId": "A String", # Account ID to which this web property belongs.
- "internalWebPropertyId": "A String", # Internal ID for this web property.
- },
- "profileRef": { # JSON template for a linked view (profile). # View (Profile) for this link.
- "id": "A String", # View (Profile) ID.
- "name": "A String", # Name of this view (profile).
- "kind": "analytics#profileRef", # Analytics view (profile) reference.
- "accountId": "A String", # Account ID to which this view (profile) belongs.
- "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.
- "href": "A String", # Link for this view (profile).
- "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.
- },
- },
"userRef": { # JSON template for a user reference. # User reference.
- "id": "A String", # User ID.
"email": "A String", # Email ID of this user.
"kind": "analytics#userRef",
+ "id": "A String", # User ID.
},
+ "selfLink": "A String", # Self link for this resource.
+ "kind": "analytics#entityUserLink", # Resource type for entity user link.
+ "entity": { # Entity for this link. It can be an account, a web property, or a view (profile).
+ "accountRef": { # JSON template for a linked account. # Account for this link.
+ "href": "A String", # Link for this account.
+ "kind": "analytics#accountRef", # Analytics account reference.
+ "name": "A String", # Account name.
+ "id": "A String", # Account ID.
+ },
+ "profileRef": { # JSON template for a linked view (profile). # View (Profile) for this link.
+ "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.
+ "kind": "analytics#profileRef", # Analytics view (profile) reference.
+ "name": "A String", # Name of this view (profile).
+ "href": "A String", # Link for this view (profile).
+ "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.
+ "id": "A String", # View (Profile) ID.
+ "accountId": "A String", # Account ID to which this view (profile) belongs.
+ },
+ "webPropertyRef": { # JSON template for a web property reference. # Web property for this link.
+ "internalWebPropertyId": "A String", # Internal ID for this web property.
+ "href": "A String", # Link for this web property.
+ "accountId": "A String", # Account ID to which this web property belongs.
+ "id": "A String", # Web property ID of the form UA-XXXXX-YY.
+ "name": "A String", # Name of this web property.
+ "kind": "analytics#webPropertyRef", # Analytics web property reference.
+ },
+ },
+ "id": "A String", # Entity user link ID
"permissions": { # Permissions the user has for this entity.
"local": [ # Permissions that a user has been assigned at this very level. Does not include any implied or inherited permissions. Local permissions are modifiable.
"A String",
@@ -372,8 +382,6 @@
"A String",
],
},
- "selfLink": "A String", # Self link for this resource.
- "kind": "analytics#entityUserLink", # Resource type for entity user link.
}</pre>
</div>