| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [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="books_v1.html">Books API</a> . <a href="books_v1.layers.html">layers</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="books_v1.layers.annotationData.html">annotationData()</a></code> |
| 79 | </p> |
| 80 | <p class="firstline">Returns the annotationData Resource.</p> |
| 81 | |
| 82 | <p class="toc_element"> |
| 83 | <code><a href="books_v1.layers.volumeAnnotations.html">volumeAnnotations()</a></code> |
| 84 | </p> |
| 85 | <p class="firstline">Returns the volumeAnnotations Resource.</p> |
| 86 | |
| 87 | <p class="toc_element"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 88 | <code><a href="#close">close()</a></code></p> |
| 89 | <p class="firstline">Close httplib2 connections.</p> |
| 90 | <p class="toc_element"> |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 91 | <code><a href="#get">get(volumeId, summaryId, contentVersion=None, source=None, x__xgafv=None)</a></code></p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 92 | <p class="firstline">Gets the layer summary for a volume.</p> |
| 93 | <p class="toc_element"> |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 94 | <code><a href="#list">list(volumeId, contentVersion=None, maxResults=None, pageToken=None, source=None, x__xgafv=None)</a></code></p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 95 | <p class="firstline">List the layer summaries for a volume.</p> |
| 96 | <h3>Method Details</h3> |
| 97 | <div class="method"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 98 | <code class="details" id="close">close()</code> |
| 99 | <pre>Close httplib2 connections.</pre> |
| 100 | </div> |
| 101 | |
| 102 | <div class="method"> |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 103 | <code class="details" id="get">get(volumeId, summaryId, contentVersion=None, source=None, x__xgafv=None)</code> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 104 | <pre>Gets the layer summary for a volume. |
| 105 | |
| 106 | Args: |
| 107 | volumeId: string, The volume to retrieve layers for. (required) |
| 108 | summaryId: string, The ID for the layer to get the summary for. (required) |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 109 | contentVersion: string, The content version for the requested volume. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 110 | source: string, String to identify the originator of this request. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 111 | x__xgafv: string, V1 error format. |
| 112 | Allowed values |
| 113 | 1 - v1 error format |
| 114 | 2 - v2 error format |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 115 | |
| 116 | Returns: |
| 117 | An object of the form: |
| 118 | |
| 119 | { |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 120 | "annotationCount": 42, # The number of annotations for this layer. |
| 121 | "annotationTypes": [ # The list of annotation types contained for this layer. |
| 122 | "A String", |
| 123 | ], |
| 124 | "annotationsDataLink": "A String", # Link to get data for this annotation. |
| 125 | "annotationsLink": "A String", # The link to get the annotations for this layer. |
| 126 | "contentVersion": "A String", # The content version this resource is for. |
| 127 | "dataCount": 42, # The number of data items for this layer. |
| 128 | "id": "A String", # Unique id of this layer summary. |
| 129 | "kind": "A String", # Resource Type |
| 130 | "layerId": "A String", # The layer id for this summary. |
| 131 | "selfLink": "A String", # URL to this resource. |
| 132 | "updated": "A String", # Timestamp for the last time an item in this layer was updated. (RFC 3339 UTC date-time format). |
| 133 | "volumeAnnotationsVersion": "A String", # The current version of this layer's volume annotations. Note that this version applies only to the data in the books.layers.volumeAnnotations.* responses. The actual annotation data is versioned separately. |
| 134 | "volumeId": "A String", # The volume id this resource is for. |
| 135 | }</pre> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 136 | </div> |
| 137 | |
| 138 | <div class="method"> |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 139 | <code class="details" id="list">list(volumeId, contentVersion=None, maxResults=None, pageToken=None, source=None, x__xgafv=None)</code> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 140 | <pre>List the layer summaries for a volume. |
| 141 | |
| 142 | Args: |
| 143 | volumeId: string, The volume to retrieve layers for. (required) |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 144 | contentVersion: string, The content version for the requested volume. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 145 | maxResults: integer, Maximum number of results to return |
| 146 | pageToken: string, The value of the nextToken from the previous page. |
| 147 | source: string, String to identify the originator of this request. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 148 | x__xgafv: string, V1 error format. |
| 149 | Allowed values |
| 150 | 1 - v1 error format |
| 151 | 2 - v2 error format |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 152 | |
| 153 | Returns: |
| 154 | An object of the form: |
| 155 | |
| 156 | { |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 157 | "items": [ # A list of layer summary items. |
| 158 | { |
| 159 | "annotationCount": 42, # The number of annotations for this layer. |
| 160 | "annotationTypes": [ # The list of annotation types contained for this layer. |
| 161 | "A String", |
| 162 | ], |
| 163 | "annotationsDataLink": "A String", # Link to get data for this annotation. |
| 164 | "annotationsLink": "A String", # The link to get the annotations for this layer. |
| 165 | "contentVersion": "A String", # The content version this resource is for. |
| 166 | "dataCount": 42, # The number of data items for this layer. |
| 167 | "id": "A String", # Unique id of this layer summary. |
| 168 | "kind": "A String", # Resource Type |
| 169 | "layerId": "A String", # The layer id for this summary. |
| 170 | "selfLink": "A String", # URL to this resource. |
| 171 | "updated": "A String", # Timestamp for the last time an item in this layer was updated. (RFC 3339 UTC date-time format). |
| 172 | "volumeAnnotationsVersion": "A String", # The current version of this layer's volume annotations. Note that this version applies only to the data in the books.layers.volumeAnnotations.* responses. The actual annotation data is versioned separately. |
| 173 | "volumeId": "A String", # The volume id this resource is for. |
| 174 | }, |
| 175 | ], |
| 176 | "kind": "A String", # Resource type. |
| 177 | "totalItems": 42, # The total number of layer summaries found. |
| 178 | }</pre> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 179 | </div> |
| 180 | |
| 181 | </body></html> |