blob: c612ae6ac8b39522fbf63c72860a97b3c1343731 [file] [log] [blame]
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="mapsengine_v1.html">Google Maps Engine API</a> . <a href="mapsengine_v1.maps.html">maps</a> . <a href="mapsengine_v1.maps.permissions.html">permissions</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#batchDelete">batchDelete(id, body)</a></code></p>
<p class="firstline">Remove permission entries from an already existing asset.</p>
<p class="toc_element">
<code><a href="#batchUpdate">batchUpdate(id, body)</a></code></p>
<p class="firstline">Add or update permission entries to an already existing asset.</p>
<p class="toc_element">
<code><a href="#list">list(id)</a></code></p>
<p class="firstline">Return all of the permissions for the specified asset.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="batchDelete">batchDelete(id, body)</code>
<pre>Remove permission entries from an already existing asset.
Args:
id: string, The ID of the asset from which permissions will be removed. (required)
body: object, The request body. (required)
The object takes the form of:
{ # The request sent to mapsengine.permissions.batchDelete.
"ids": [ # An array of permission ids to be removed. This could be the email address of the user or group this permission refers to, or the string "anyone" for public permissions.
"A String",
],
}
Returns:
An object of the form:
{ # The response returned by a call to mapsengine.permissions.batchDelete.
}</pre>
</div>
<div class="method">
<code class="details" id="batchUpdate">batchUpdate(id, body)</code>
<pre>Add or update permission entries to an already existing asset.
An asset can hold up to 20 different permission entries. Each batchInsert request is atomic.
Args:
id: string, The ID of the asset to which permissions will be added. (required)
body: object, The request body. (required)
The object takes the form of:
{ # The request sent to mapsengine.permissions.batchUpdate.
"permissions": [ # The permissions to be inserted or updated.
{ # A permission defines the user or group that has access to an asset, and the type of access they have.
"type": "A String", # The account type.
"role": "A String", # The type of access granted to this user or group.
"discoverable": True or False, # Indicates whether a public asset is listed and can be found via a web search (value true), or is visible only to people who have a link to the asset (value false).
"id": "A String", # The unique identifier of the permission. This could be the email address of the user or group this permission refers to, or the string "anyone" for public permissions.
},
],
}
Returns:
An object of the form:
{ # The response returned by a call to mapsengine.permissions.batchUpdate.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(id)</code>
<pre>Return all of the permissions for the specified asset.
Args:
id: string, The ID of the asset whose permissions will be listed. (required)
Returns:
An object of the form:
{
"permissions": [ # The set of permissions associated with this asset.
{ # A permission defines the user or group that has access to an asset, and the type of access they have.
"type": "A String", # The account type.
"role": "A String", # The type of access granted to this user or group.
"discoverable": True or False, # Indicates whether a public asset is listed and can be found via a web search (value true), or is visible only to people who have a link to the asset (value false).
"id": "A String", # The unique identifier of the permission. This could be the email address of the user or group this permission refers to, or the string "anyone" for public permissions.
},
],
}</pre>
</div>
</body></html>