| Craig Citro | 0e5b9bf | 2014-10-15 10:26:14 -0700 | [diff] [blame^] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| 75 | <h1><a href="mapsengine_v1.html">Google Maps Engine API</a> . <a href="mapsengine_v1.tables.html">tables</a> . <a href="mapsengine_v1.tables.permissions.html">permissions</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="#batchDelete">batchDelete(id, body)</a></code></p> |
| 79 | <p class="firstline">Remove permission entries from an already existing asset.</p> |
| 80 | <p class="toc_element"> |
| 81 | <code><a href="#batchUpdate">batchUpdate(id, body)</a></code></p> |
| 82 | <p class="firstline">Add or update permission entries to an already existing asset.</p> |
| 83 | <p class="toc_element"> |
| 84 | <code><a href="#list">list(id)</a></code></p> |
| 85 | <p class="firstline">Return all of the permissions for the specified asset.</p> |
| 86 | <h3>Method Details</h3> |
| 87 | <div class="method"> |
| 88 | <code class="details" id="batchDelete">batchDelete(id, body)</code> |
| 89 | <pre>Remove permission entries from an already existing asset. |
| 90 | |
| 91 | Args: |
| 92 | id: string, The ID of the asset from which permissions will be removed. (required) |
| 93 | body: object, The request body. (required) |
| 94 | The object takes the form of: |
| 95 | |
| 96 | { # The request sent to mapsengine.permissions.batchDelete. |
| 97 | "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. |
| 98 | "A String", |
| 99 | ], |
| 100 | } |
| 101 | |
| 102 | |
| 103 | Returns: |
| 104 | An object of the form: |
| 105 | |
| 106 | { # The response returned by a call to mapsengine.permissions.batchDelete. |
| 107 | }</pre> |
| 108 | </div> |
| 109 | |
| 110 | <div class="method"> |
| 111 | <code class="details" id="batchUpdate">batchUpdate(id, body)</code> |
| 112 | <pre>Add or update permission entries to an already existing asset. |
| 113 | |
| 114 | An asset can hold up to 20 different permission entries. Each batchInsert request is atomic. |
| 115 | |
| 116 | Args: |
| 117 | id: string, The ID of the asset to which permissions will be added. (required) |
| 118 | body: object, The request body. (required) |
| 119 | The object takes the form of: |
| 120 | |
| 121 | { # The request sent to mapsengine.permissions.batchUpdate. |
| 122 | "permissions": [ # The permissions to be inserted or updated. |
| 123 | { # A permission defines the user or group that has access to an asset, and the type of access they have. |
| 124 | "type": "A String", # The account type. |
| 125 | "role": "A String", # The type of access granted to this user or group. |
| 126 | "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). |
| 127 | "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. |
| 128 | }, |
| 129 | ], |
| 130 | } |
| 131 | |
| 132 | |
| 133 | Returns: |
| 134 | An object of the form: |
| 135 | |
| 136 | { # The response returned by a call to mapsengine.permissions.batchUpdate. |
| 137 | }</pre> |
| 138 | </div> |
| 139 | |
| 140 | <div class="method"> |
| 141 | <code class="details" id="list">list(id)</code> |
| 142 | <pre>Return all of the permissions for the specified asset. |
| 143 | |
| 144 | Args: |
| 145 | id: string, The ID of the asset whose permissions will be listed. (required) |
| 146 | |
| 147 | Returns: |
| 148 | An object of the form: |
| 149 | |
| 150 | { |
| 151 | "permissions": [ # The set of permissions associated with this asset. |
| 152 | { # A permission defines the user or group that has access to an asset, and the type of access they have. |
| 153 | "type": "A String", # The account type. |
| 154 | "role": "A String", # The type of access granted to this user or group. |
| 155 | "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). |
| 156 | "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. |
| 157 | }, |
| 158 | ], |
| 159 | }</pre> |
| 160 | </div> |
| 161 | |
| 162 | </body></html> |