Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / b6971b0405ba59d905b84fa5fc8e27e12d29b70c / . / docs / dyn / books_v1.myconfig.html
blob: a50665ce9665e481d4a7b405b6901080e397932a [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1<html><body>
2<style>
3
4body, 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
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, 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.myconfig.html">myconfig</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]81 <code><a href="#getUserSettings">getUserSettings(country=None, x__xgafv=None)</a></code></p>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]82<p class="firstline">Gets the current settings for the user.</p>
83<p class="toc_element">
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]84 <code><a href="#releaseDownloadAccess">releaseDownloadAccess(cpksver, volumeIds, locale=None, source=None, x__xgafv=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]85<p class="firstline">Release downloaded content access restriction.</p>
86<p class="toc_element">
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]87 <code><a href="#requestAccess">requestAccess(cpksver, nonce, source, volumeId, licenseTypes=None, locale=None, x__xgafv=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]88<p class="firstline">Request concurrent and download access restrictions.</p>
89<p class="toc_element">
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]90 <code><a href="#syncVolumeLicenses">syncVolumeLicenses(cpksver, nonce, source, features=None, includeNonComicsSeries=None, locale=None, showPreorders=None, volumeIds=None, x__xgafv=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]91<p class="firstline">Request downloaded content access for specified volumes on the My eBooks shelf.</p>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]92<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]93 <code><a href="#updateUserSettings">updateUserSettings(body=None, x__xgafv=None)</a></code></p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]94<p class="firstline">Sets the settings for the user. If a sub-object is specified, it will overwrite the existing sub-object stored in the server. Unspecified sub-objects will retain the existing value.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]95<h3>Method Details</h3>
96<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]97 <code class="details" id="close">close()</code>
98 <pre>Close httplib2 connections.</pre>
99</div>
100
101<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]102 <code class="details" id="getUserSettings">getUserSettings(country=None, x__xgafv=None)</code>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]103 <pre>Gets the current settings for the user.
104
105Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]106 country: string, Unused. Added only to workaround TEX mandatory request template requirement
107 x__xgafv: string, V1 error format.
108 Allowed values
109 1 - v1 error format
110 2 - v2 error format
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]111
112Returns:
113 An object of the form:
114
115 {
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]116 &quot;notification&quot;: {
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]117 &quot;rewardExpirations&quot;: {
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]118 &quot;opted_state&quot;: &quot;A String&quot;,
119 },
120 &quot;moreFromSeries&quot;: {
121 &quot;opted_state&quot;: &quot;A String&quot;,
122 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]123 &quot;matchMyInterests&quot;: {
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]124 &quot;opted_state&quot;: &quot;A String&quot;,
125 },
126 &quot;priceDrop&quot;: {
127 &quot;opted_state&quot;: &quot;A String&quot;,
128 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]129 &quot;moreFromAuthors&quot;: {
130 &quot;opted_state&quot;: &quot;A String&quot;,
131 },
132 },
133 &quot;kind&quot;: &quot;A String&quot;, # Resource type.
134 &quot;notesExport&quot;: { # User settings in sub-objects, each for different purposes.
135 &quot;isEnabled&quot;: True or False,
136 &quot;folderName&quot;: &quot;A String&quot;,
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]137 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]138 }</pre>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]139</div>
140
141<div class="method">
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]142 <code class="details" id="releaseDownloadAccess">releaseDownloadAccess(cpksver, volumeIds, locale=None, source=None, x__xgafv=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]143 <pre>Release downloaded content access restriction.
144
145Args:
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]146 cpksver: string, The device/version ID from which to release the restriction. (required)
147 volumeIds: string, The volume(s) to release restrictions for. (required) (repeated)
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]148 locale: string, ISO-639-1, ISO-3166-1 codes for message localization, i.e. en_US.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]149 source: string, String to identify the originator of this request.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]150 x__xgafv: string, V1 error format.
151 Allowed values
152 1 - v1 error format
153 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]154
155Returns:
156 An object of the form:
157
158 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]159 &quot;downloadAccessList&quot;: [ # A list of download access responses.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]160 {
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]161 &quot;signature&quot;: &quot;A String&quot;, # Response signature.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]162 &quot;downloadsAcquired&quot;: 42, # If restricted, the number of content download licenses already acquired (including the requesting client, if licensed).
163 &quot;restricted&quot;: True or False, # Whether this volume has any download access restrictions.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]164 &quot;maxDownloadDevices&quot;: 42, # If restricted, the maximum number of content download licenses for this volume.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]165 &quot;source&quot;: &quot;A String&quot;, # Client app identifier for verification. Download access and client-validation only.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]166 &quot;kind&quot;: &quot;A String&quot;, # Resource type.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]167 &quot;reasonCode&quot;: &quot;A String&quot;, # Error/warning reason code. Additional codes may be added in the future. 0 OK 100 ACCESS_DENIED_PUBLISHER_LIMIT 101 ACCESS_DENIED_LIMIT 200 WARNING_USED_LAST_ACCESS
168 &quot;nonce&quot;: &quot;A String&quot;, # Client nonce for verification. Download access and client-validation only.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]169 &quot;volumeId&quot;: &quot;A String&quot;, # Identifies the volume for which this entry applies.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]170 &quot;message&quot;: &quot;A String&quot;, # Error/warning message.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]171 &quot;deviceAllowed&quot;: True or False, # If restricted, whether access is granted for this (user, device, volume).
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]172 &quot;justAcquired&quot;: True or False, # If deviceAllowed, whether access was just acquired with this request.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]173 },
174 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]175 &quot;kind&quot;: &quot;A String&quot;, # Resource type.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]176 }</pre>
177</div>
178
179<div class="method">
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]180 <code class="details" id="requestAccess">requestAccess(cpksver, nonce, source, volumeId, licenseTypes=None, locale=None, x__xgafv=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]181 <pre>Request concurrent and download access restrictions.
182
183Args:
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]184 cpksver: string, The device/version ID from which to request the restrictions. (required)
185 nonce: string, The client nonce value. (required)
186 source: string, String to identify the originator of this request. (required)
187 volumeId: string, The volume to request concurrent/download restrictions for. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]188 licenseTypes: string, The type of access license to request. If not specified, the default is BOTH.
189 Allowed values
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]190 LICENSE_TYPES_UNDEFINED -
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]191 BOTH - Both concurrent and download licenses.
192 CONCURRENT - Concurrent access license.
193 DOWNLOAD - Offline download access license.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]194 locale: string, ISO-639-1, ISO-3166-1 codes for message localization, i.e. en_US.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]195 x__xgafv: string, V1 error format.
196 Allowed values
197 1 - v1 error format
198 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]199
200Returns:
201 An object of the form:
202
203 {
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]204 &quot;concurrentAccess&quot;: { # A concurrent access response.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]205 &quot;kind&quot;: &quot;A String&quot;, # Resource type.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]206 &quot;message&quot;: &quot;A String&quot;, # Error/warning message.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]207 &quot;timeWindowSeconds&quot;: 42, # Time in seconds for license auto-expiration.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]208 &quot;reasonCode&quot;: &quot;A String&quot;, # Error/warning reason code.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]209 &quot;nonce&quot;: &quot;A String&quot;, # Client nonce for verification. Download access and client-validation only.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]210 &quot;deviceAllowed&quot;: True or False, # Whether access is granted for this (user, device, volume).
211 &quot;maxConcurrentDevices&quot;: 42, # The maximum number of concurrent access licenses for this volume.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]212 &quot;source&quot;: &quot;A String&quot;, # Client app identifier for verification. Download access and client-validation only.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]213 &quot;volumeId&quot;: &quot;A String&quot;, # Identifies the volume for which this entry applies.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]214 &quot;signature&quot;: &quot;A String&quot;, # Response signature.
215 &quot;restricted&quot;: True or False, # Whether this volume has any concurrent access restrictions.
216 },
217 &quot;kind&quot;: &quot;A String&quot;, # Resource type.
218 &quot;downloadAccess&quot;: { # A download access response.
219 &quot;signature&quot;: &quot;A String&quot;, # Response signature.
220 &quot;downloadsAcquired&quot;: 42, # If restricted, the number of content download licenses already acquired (including the requesting client, if licensed).
221 &quot;restricted&quot;: True or False, # Whether this volume has any download access restrictions.
222 &quot;maxDownloadDevices&quot;: 42, # If restricted, the maximum number of content download licenses for this volume.
223 &quot;source&quot;: &quot;A String&quot;, # Client app identifier for verification. Download access and client-validation only.
224 &quot;kind&quot;: &quot;A String&quot;, # Resource type.
225 &quot;reasonCode&quot;: &quot;A String&quot;, # Error/warning reason code. Additional codes may be added in the future. 0 OK 100 ACCESS_DENIED_PUBLISHER_LIMIT 101 ACCESS_DENIED_LIMIT 200 WARNING_USED_LAST_ACCESS
226 &quot;nonce&quot;: &quot;A String&quot;, # Client nonce for verification. Download access and client-validation only.
227 &quot;volumeId&quot;: &quot;A String&quot;, # Identifies the volume for which this entry applies.
228 &quot;message&quot;: &quot;A String&quot;, # Error/warning message.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]229 &quot;deviceAllowed&quot;: True or False, # If restricted, whether access is granted for this (user, device, volume).
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]230 &quot;justAcquired&quot;: True or False, # If deviceAllowed, whether access was just acquired with this request.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]231 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]232 }</pre>
233</div>
234
235<div class="method">
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]236 <code class="details" id="syncVolumeLicenses">syncVolumeLicenses(cpksver, nonce, source, features=None, includeNonComicsSeries=None, locale=None, showPreorders=None, volumeIds=None, x__xgafv=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]237 <pre>Request downloaded content access for specified volumes on the My eBooks shelf.
238
239Args:
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]240 cpksver: string, The device/version ID from which to release the restriction. (required)
241 nonce: string, The client nonce value. (required)
242 source: string, String to identify the originator of this request. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]243 features: string, List of features supported by the client, i.e., &#x27;RENTALS&#x27; (repeated)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]244 Allowed values
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]245 FEATURES_UNDEFINED -
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]246 RENTALS - Client supports rentals.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]247 includeNonComicsSeries: boolean, Set to true to include non-comics series. Defaults to false.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]248 locale: string, ISO-639-1, ISO-3166-1 codes for message localization, i.e. en_US.
249 showPreorders: boolean, Set to true to show pre-ordered books. Defaults to false.
250 volumeIds: string, The volume(s) to request download restrictions for. (repeated)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]251 x__xgafv: string, V1 error format.
252 Allowed values
253 1 - v1 error format
254 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]255
256Returns:
257 An object of the form:
258
259 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]260 &quot;items&quot;: [ # A list of volumes.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]261 {
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]262 &quot;layerInfo&quot;: { # What layers exist in this volume and high level information about them.
263 &quot;layers&quot;: [ # A layer should appear here if and only if the layer exists for this book.
264 {
265 &quot;layerId&quot;: &quot;A String&quot;, # The layer id of this layer (e.g. &quot;geo&quot;).
266 &quot;volumeAnnotationsVersion&quot;: &quot;A String&quot;, # The current version of this layer&#x27;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.
267 },
268 ],
269 },
270 &quot;searchInfo&quot;: { # Search result information related to this volume.
271 &quot;textSnippet&quot;: &quot;A String&quot;, # A text snippet containing the search query.
272 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]273 &quot;userInfo&quot;: { # User specific information related to this volume. (e.g. page this user last read or whether they purchased this book)
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]274 &quot;updated&quot;: &quot;A String&quot;, # Timestamp when this volume was last modified by a user action, such as a reading position update, volume purchase or writing a review. (RFC 3339 UTC date-time format).
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]275 &quot;isUploaded&quot;: True or False, # Whether or not this volume was user uploaded.
276 &quot;isFamilySharedToUser&quot;: True or False, # Whether or not the user received this volume through family sharing.
277 &quot;isPurchased&quot;: True or False, # Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.)
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]278 &quot;readingPosition&quot;: { # The user&#x27;s current reading position in the volume, if one is available. (In LITE projection.)
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]279 &quot;gbImagePosition&quot;: &quot;A String&quot;, # Position in a volume for image-based content.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]280 &quot;kind&quot;: &quot;A String&quot;, # Resource type for a reading position.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]281 &quot;volumeId&quot;: &quot;A String&quot;, # Volume id associated with this reading position.
282 &quot;updated&quot;: &quot;A String&quot;, # Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution).
283 &quot;epubCfiPosition&quot;: &quot;A String&quot;, # Position in an EPUB as a CFI.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]284 &quot;pdfPosition&quot;: &quot;A String&quot;, # Position in a PDF file.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]285 &quot;gbTextPosition&quot;: &quot;A String&quot;, # Position in a volume for text-based content.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]286 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]287 &quot;isFamilySharingAllowed&quot;: True or False, # Deprecated: Replaced by familySharing.
288 &quot;isFamilySharingDisabledByFop&quot;: True or False, # Deprecated: Replaced by familySharing.
289 &quot;acquisitionType&quot;: 42, # How this volume was acquired.
290 &quot;acquiredTime&quot;: &quot;A String&quot;, # Timestamp when this volume was acquired by the user. (RFC 3339 UTC date-time format) Acquiring includes purchase, user upload, receiving family sharing, etc.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]291 &quot;review&quot;: { # This user&#x27;s review of this volume, if one exists.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]292 &quot;date&quot;: &quot;A String&quot;, # Date of this review.
293 &quot;type&quot;: &quot;A String&quot;, # Source type for this review. Possible values are EDITORIAL, WEB_USER or GOOGLE_USER.
294 &quot;volumeId&quot;: &quot;A String&quot;, # Volume that this review is for.
295 &quot;rating&quot;: &quot;A String&quot;, # Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, FIVE or NOT_RATED.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]296 &quot;source&quot;: { # Information regarding the source of this review, when the review is not from a Google Books user.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]297 &quot;url&quot;: &quot;A String&quot;, # URL of the source of the review.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]298 &quot;extraDescription&quot;: &quot;A String&quot;, # Extra text about the source of the review.
299 &quot;description&quot;: &quot;A String&quot;, # Name of the source.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]300 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]301 &quot;content&quot;: &quot;A String&quot;, # Review text.
302 &quot;fullTextUrl&quot;: &quot;A String&quot;, # URL for the full review text, for reviews gathered from the web.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]303 &quot;author&quot;: { # Author of this review.
304 &quot;displayName&quot;: &quot;A String&quot;, # Name of this person.
305 },
306 &quot;kind&quot;: &quot;A String&quot;, # Resource type for a review.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]307 &quot;title&quot;: &quot;A String&quot;, # Title for this review.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]308 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]309 &quot;userUploadedVolumeInfo&quot;: {
310 &quot;processingState&quot;: &quot;A String&quot;,
311 },
312 &quot;rentalState&quot;: &quot;A String&quot;, # Whether this book is an active or an expired rental.
313 &quot;familySharing&quot;: { # Information on the ability to share with the family.
314 &quot;isSharingAllowed&quot;: True or False, # Whether or not this volume can be shared with the family by the user. This includes sharing eligibility of both the volume and the user. If the value is true, the user can initiate a family sharing action.
315 &quot;isSharingDisabledByFop&quot;: True or False, # Whether or not sharing this volume is temporarily disabled due to issues with the Family Wallet.
316 &quot;familyRole&quot;: &quot;A String&quot;, # The role of the user in the family.
317 },
318 &quot;rentalPeriod&quot;: { # Period during this book is/was a valid rental.
319 &quot;startUtcSec&quot;: &quot;A String&quot;,
320 &quot;endUtcSec&quot;: &quot;A String&quot;,
321 },
322 &quot;isInMyBooks&quot;: True or False, # Whether or not this volume is currently in &quot;my books.&quot;
323 &quot;copy&quot;: { # Copy/Paste accounting information.
324 &quot;updated&quot;: &quot;A String&quot;,
325 &quot;limitType&quot;: &quot;A String&quot;,
326 &quot;allowedCharacterCount&quot;: 42,
327 &quot;remainingCharacterCount&quot;: 42,
328 },
329 &quot;entitlementType&quot;: 42, # Whether this volume is purchased, sample, pd download etc.
330 &quot;isPreordered&quot;: True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)
331 &quot;isFamilySharedFromUser&quot;: True or False, # Whether or not the user shared this volume with the family.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]332 },
333 &quot;kind&quot;: &quot;A String&quot;, # Resource type for a volume. (In LITE projection.)
334 &quot;etag&quot;: &quot;A String&quot;, # Opaque identifier for a specific version of a volume resource. (In LITE projection)
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]335 &quot;saleInfo&quot;: { # Any information about a volume related to the eBookstore and/or purchaseability. This information can depend on the country where the request originates from (i.e. books may not be for sale in certain countries).
336 &quot;buyLink&quot;: &quot;A String&quot;, # URL to purchase this volume on the Google Books site. (In LITE projection)
337 &quot;listPrice&quot;: { # Suggested retail price. (In LITE projection.)
338 &quot;amount&quot;: 3.14, # Amount in the currency listed below. (In LITE projection.)
339 &quot;currencyCode&quot;: &quot;A String&quot;, # An ISO 4217, three-letter currency code. (In LITE projection.)
340 },
341 &quot;retailPrice&quot;: { # The actual selling price of the book. This is the same as the suggested retail or list price unless there are offers or discounts on this volume. (In LITE projection.)
342 &quot;currencyCode&quot;: &quot;A String&quot;, # An ISO 4217, three-letter currency code. (In LITE projection.)
343 &quot;amount&quot;: 3.14, # Amount in the currency listed below. (In LITE projection.)
344 },
345 &quot;isEbook&quot;: True or False, # Whether or not this volume is an eBook (can be added to the My eBooks shelf).
346 &quot;offers&quot;: [ # Offers available for this volume (sales and rentals).
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]347 {
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]348 &quot;rentalDuration&quot;: { # The rental duration (for rental offers only).
349 &quot;count&quot;: 3.14,
350 &quot;unit&quot;: &quot;A String&quot;,
351 },
352 &quot;giftable&quot;: True or False, # Indicates whether the offer is giftable.
353 &quot;listPrice&quot;: { # Offer list (=undiscounted) price in Micros.
354 &quot;amountInMicros&quot;: 3.14,
355 &quot;currencyCode&quot;: &quot;A String&quot;,
356 },
357 &quot;finskyOfferType&quot;: 42, # The finsky offer type (e.g., PURCHASE=0 RENTAL=3)
358 &quot;retailPrice&quot;: { # Offer retail (=discounted) price in Micros
359 &quot;amountInMicros&quot;: 3.14,
360 &quot;currencyCode&quot;: &quot;A String&quot;,
361 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]362 },
363 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]364 &quot;country&quot;: &quot;A String&quot;, # The two-letter ISO_3166-1 country code for which this sale information is valid. (In LITE projection.)
365 &quot;saleability&quot;: &quot;A String&quot;, # Whether or not this book is available for sale or offered for free in the Google eBookstore for the country listed above. Possible values are FOR_SALE, FOR_RENTAL_ONLY, FOR_SALE_AND_RENTAL, FREE, NOT_FOR_SALE, or FOR_PREORDER.
366 &quot;onSaleDate&quot;: &quot;A String&quot;, # The date on which this book is available for sale.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]367 },
368 &quot;volumeInfo&quot;: { # General volume information.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]369 &quot;authors&quot;: [ # The names of the authors and/or editors for this volume. (In LITE projection)
370 &quot;A String&quot;,
371 ],
372 &quot;samplePageCount&quot;: 42, # Total number of sample pages as per publisher metadata.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]373 &quot;seriesInfo&quot;: {
374 &quot;bookDisplayNumber&quot;: &quot;A String&quot;, # The display number string. This should be used only for display purposes and the actual sequence should be inferred from the below orderNumber.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]375 &quot;kind&quot;: &quot;A String&quot;, # Resource type.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]376 &quot;volumeSeries&quot;: [
377 {
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]378 &quot;seriesBookType&quot;: &quot;A String&quot;, # The book type in the context of series. Examples - Single Issue, Collection Edition, etc.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]379 &quot;issue&quot;: [ # List of issues. Applicable only for Collection Edition and Omnibus.
380 {
381 &quot;issueDisplayNumber&quot;: &quot;A String&quot;,
382 &quot;issueOrderNumber&quot;: 42,
383 },
384 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]385 &quot;orderNumber&quot;: 42, # The book order number in the series.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]386 &quot;seriesId&quot;: &quot;A String&quot;, # The series id.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]387 },
388 ],
389 &quot;shortSeriesBookTitle&quot;: &quot;A String&quot;, # Short book title in the context of the series.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]390 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]391 &quot;publishedDate&quot;: &quot;A String&quot;, # Date of publication. (In LITE projection.)
392 &quot;contentVersion&quot;: &quot;A String&quot;, # An identifier for the version of the volume content (text &amp; images). (In LITE projection)
393 &quot;ratingsCount&quot;: 42, # The number of review ratings for this volume.
394 &quot;subtitle&quot;: &quot;A String&quot;, # Volume subtitle. (In LITE projection.)
395 &quot;comicsContent&quot;: True or False, # Whether the volume has comics content.
396 &quot;printType&quot;: &quot;A String&quot;, # Type of publication of this volume. Possible values are BOOK or MAGAZINE.
397 &quot;language&quot;: &quot;A String&quot;, # Best language for this volume (based on content). It is the two-letter ISO 639-1 code such as &#x27;fr&#x27;, &#x27;en&#x27;, etc.
398 &quot;imageLinks&quot;: { # A list of image links for all the sizes that are available. (In LITE projection.)
399 &quot;extraLarge&quot;: &quot;A String&quot;, # Image link for extra large size (width of ~1280 pixels). (In LITE projection)
400 &quot;large&quot;: &quot;A String&quot;, # Image link for large size (width of ~800 pixels). (In LITE projection)
401 &quot;small&quot;: &quot;A String&quot;, # Image link for small size (width of ~300 pixels). (In LITE projection)
402 &quot;medium&quot;: &quot;A String&quot;, # Image link for medium size (width of ~575 pixels). (In LITE projection)
403 &quot;thumbnail&quot;: &quot;A String&quot;, # Image link for thumbnail size (width of ~128 pixels). (In LITE projection)
404 &quot;smallThumbnail&quot;: &quot;A String&quot;, # Image link for small thumbnail size (width of ~80 pixels). (In LITE projection)
405 },
406 &quot;averageRating&quot;: 3.14, # The mean review rating for this volume. (min = 1.0, max = 5.0)
407 &quot;title&quot;: &quot;A String&quot;, # Volume title. (In LITE projection.)
408 &quot;publisher&quot;: &quot;A String&quot;, # Publisher of this volume. (In LITE projection.)
409 &quot;allowAnonLogging&quot;: True or False, # Whether anonymous logging should be allowed.
410 &quot;pageCount&quot;: 42, # Total number of pages as per publisher metadata.
411 &quot;panelizationSummary&quot;: { # A top-level summary of the panelization info in this volume.
412 &quot;containsImageBubbles&quot;: True or False,
413 &quot;epubBubbleVersion&quot;: &quot;A String&quot;,
414 &quot;imageBubbleVersion&quot;: &quot;A String&quot;,
415 &quot;containsEpubBubbles&quot;: True or False,
416 },
417 &quot;maturityRating&quot;: &quot;A String&quot;,
418 &quot;description&quot;: &quot;A String&quot;, # A synopsis of the volume. The text of the description is formatted in HTML and includes simple formatting elements, such as b, i, and br tags. (In LITE projection.)
419 &quot;canonicalVolumeLink&quot;: &quot;A String&quot;, # Canonical URL for a volume. (In LITE projection.)
420 &quot;mainCategory&quot;: &quot;A String&quot;, # The main category to which this volume belongs. It will be the category from the categories list returned below that has the highest weight.
421 &quot;printedPageCount&quot;: 42, # Total number of printed pages in generated pdf representation.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]422 &quot;dimensions&quot;: { # Physical dimensions of this volume.
423 &quot;height&quot;: &quot;A String&quot;, # Height or length of this volume (in cm).
424 &quot;thickness&quot;: &quot;A String&quot;, # Thickness of this volume (in cm).
425 &quot;width&quot;: &quot;A String&quot;, # Width of this volume (in cm).
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]426 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]427 &quot;categories&quot;: [ # A list of subject categories, such as &quot;Fiction&quot;, &quot;Suspense&quot;, etc.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]428 &quot;A String&quot;,
429 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]430 &quot;infoLink&quot;: &quot;A String&quot;, # URL to view information about this volume on the Google Books site. (In LITE projection)
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]431 &quot;readingModes&quot;: { # The reading modes available for this volume.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]432 &quot;text&quot;: True or False,
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]433 &quot;image&quot;: True or False,
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]434 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]435 &quot;previewLink&quot;: &quot;A String&quot;, # URL to preview this volume on the Google Books site.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]436 &quot;industryIdentifiers&quot;: [ # Industry standard identifiers for this volume.
437 {
438 &quot;type&quot;: &quot;A String&quot;, # Identifier type. Possible values are ISBN_10, ISBN_13, ISSN and OTHER.
439 &quot;identifier&quot;: &quot;A String&quot;, # Industry specific volume identifier.
440 },
441 ],
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]442 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]443 &quot;recommendedInfo&quot;: { # Recommendation related information for this volume.
444 &quot;explanation&quot;: &quot;A String&quot;, # A text explaining why this volume is recommended.
445 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]446 &quot;selfLink&quot;: &quot;A String&quot;, # URL to this resource. (In LITE projection.)
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]447 &quot;accessInfo&quot;: { # Any information about a volume related to reading or obtaining that volume text. This information can depend on country (books may be public domain in one country but not in another, e.g.).
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]448 &quot;downloadAccess&quot;: { # Information about a volume&#x27;s download license access restrictions.
449 &quot;signature&quot;: &quot;A String&quot;, # Response signature.
450 &quot;downloadsAcquired&quot;: 42, # If restricted, the number of content download licenses already acquired (including the requesting client, if licensed).
451 &quot;restricted&quot;: True or False, # Whether this volume has any download access restrictions.
452 &quot;maxDownloadDevices&quot;: 42, # If restricted, the maximum number of content download licenses for this volume.
453 &quot;source&quot;: &quot;A String&quot;, # Client app identifier for verification. Download access and client-validation only.
454 &quot;kind&quot;: &quot;A String&quot;, # Resource type.
455 &quot;reasonCode&quot;: &quot;A String&quot;, # Error/warning reason code. Additional codes may be added in the future. 0 OK 100 ACCESS_DENIED_PUBLISHER_LIMIT 101 ACCESS_DENIED_LIMIT 200 WARNING_USED_LAST_ACCESS
456 &quot;nonce&quot;: &quot;A String&quot;, # Client nonce for verification. Download access and client-validation only.
457 &quot;volumeId&quot;: &quot;A String&quot;, # Identifies the volume for which this entry applies.
458 &quot;message&quot;: &quot;A String&quot;, # Error/warning message.
459 &quot;deviceAllowed&quot;: True or False, # If restricted, whether access is granted for this (user, device, volume).
460 &quot;justAcquired&quot;: True or False, # If deviceAllowed, whether access was just acquired with this request.
461 },
462 &quot;quoteSharingAllowed&quot;: True or False, # Whether quote sharing is allowed for this volume.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]463 &quot;textToSpeechPermission&quot;: &quot;A String&quot;, # Whether text-to-speech is permitted for this volume. Values can be ALLOWED, ALLOWED_FOR_ACCESSIBILITY, or NOT_ALLOWED.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]464 &quot;viewability&quot;: &quot;A String&quot;, # The read access of a volume. Possible values are PARTIAL, ALL_PAGES, NO_PAGES or UNKNOWN. This value depends on the country listed above. A value of PARTIAL means that the publisher has allowed some portion of the volume to be viewed publicly, without purchase. This can apply to eBooks as well as non-eBooks. Public domain books will always have a value of ALL_PAGES.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]465 &quot;pdf&quot;: { # Information about pdf content. (In LITE projection.)
466 &quot;isAvailable&quot;: True or False, # Is a scanned image pdf available either as public domain or for purchase. (In LITE projection.)
467 &quot;acsTokenLink&quot;: &quot;A String&quot;, # URL to retrieve ACS token for pdf download. (In LITE projection.)
468 &quot;downloadLink&quot;: &quot;A String&quot;, # URL to download pdf. (In LITE projection.)
469 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]470 &quot;epub&quot;: { # Information about epub content. (In LITE projection.)
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]471 &quot;isAvailable&quot;: True or False, # Is a flowing text epub available either as public domain or for purchase. (In LITE projection.)
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]472 &quot;acsTokenLink&quot;: &quot;A String&quot;, # URL to retrieve ACS token for epub download. (In LITE projection.)
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]473 &quot;downloadLink&quot;: &quot;A String&quot;, # URL to download epub. (In LITE projection.)
474 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]475 &quot;viewOrderUrl&quot;: &quot;A String&quot;, # For ordered but not yet processed orders, we give a URL that can be used to go to the appropriate Google Wallet page.
476 &quot;publicDomain&quot;: True or False, # Whether or not this book is public domain in the country listed above.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]477 &quot;webReaderLink&quot;: &quot;A String&quot;, # URL to read this volume on the Google Books site. Link will not allow users to read non-viewable volumes.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]478 &quot;country&quot;: &quot;A String&quot;, # The two-letter ISO_3166-1 country code for which this access information is valid. (In LITE projection.)
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]479 &quot;driveImportedContentLink&quot;: &quot;A String&quot;, # URL to the Google Drive viewer if this volume is uploaded by the user by selecting the file from Google Drive.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]480 &quot;accessViewStatus&quot;: &quot;A String&quot;, # Combines the access and viewability of this volume into a single status field for this user. Values can be FULL_PURCHASED, FULL_PUBLIC_DOMAIN, SAMPLE or NONE. (In LITE projection.)
481 &quot;embeddable&quot;: True or False, # Whether this volume can be embedded in a viewport using the Embedded Viewer API.
482 &quot;explicitOfflineLicenseManagement&quot;: True or False, # Whether this volume requires that the client explicitly request offline download license rather than have it done automatically when loading the content, if the client supports it.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]483 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]484 &quot;id&quot;: &quot;A String&quot;, # Unique identifier for a volume. (In LITE projection.)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]485 },
486 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]487 &quot;kind&quot;: &quot;A String&quot;, # Resource type.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]488 &quot;totalItems&quot;: 42, # Total number of volumes found. This might be greater than the number of volumes returned in this response if results have been paginated.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]489 }</pre>
490</div>
491
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]492<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]493 <code class="details" id="updateUserSettings">updateUserSettings(body=None, x__xgafv=None)</code>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]494 <pre>Sets the settings for the user. If a sub-object is specified, it will overwrite the existing sub-object stored in the server. Unspecified sub-objects will retain the existing value.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]495
496Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]497 body: object, The request body.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]498 The object takes the form of:
499
500{
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]501 &quot;notification&quot;: {
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]502 &quot;rewardExpirations&quot;: {
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]503 &quot;opted_state&quot;: &quot;A String&quot;,
504 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]505 &quot;moreFromSeries&quot;: {
506 &quot;opted_state&quot;: &quot;A String&quot;,
507 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]508 &quot;matchMyInterests&quot;: {
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]509 &quot;opted_state&quot;: &quot;A String&quot;,
510 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]511 &quot;priceDrop&quot;: {
512 &quot;opted_state&quot;: &quot;A String&quot;,
513 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]514 &quot;moreFromAuthors&quot;: {
515 &quot;opted_state&quot;: &quot;A String&quot;,
516 },
517 },
518 &quot;kind&quot;: &quot;A String&quot;, # Resource type.
519 &quot;notesExport&quot;: { # User settings in sub-objects, each for different purposes.
520 &quot;isEnabled&quot;: True or False,
521 &quot;folderName&quot;: &quot;A String&quot;,
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]522 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]523 }
524
525 x__xgafv: string, V1 error format.
526 Allowed values
527 1 - v1 error format
528 2 - v2 error format
529
530Returns:
531 An object of the form:
532
533 {
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]534 &quot;notification&quot;: {
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]535 &quot;rewardExpirations&quot;: {
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]536 &quot;opted_state&quot;: &quot;A String&quot;,
537 },
538 &quot;moreFromSeries&quot;: {
539 &quot;opted_state&quot;: &quot;A String&quot;,
540 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]541 &quot;matchMyInterests&quot;: {
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]542 &quot;opted_state&quot;: &quot;A String&quot;,
543 },
544 &quot;priceDrop&quot;: {
545 &quot;opted_state&quot;: &quot;A String&quot;,
546 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]547 &quot;moreFromAuthors&quot;: {
548 &quot;opted_state&quot;: &quot;A String&quot;,
549 },
550 },
551 &quot;kind&quot;: &quot;A String&quot;, # Resource type.
552 &quot;notesExport&quot;: { # User settings in sub-objects, each for different purposes.
553 &quot;isEnabled&quot;: True or False,
554 &quot;folderName&quot;: &quot;A String&quot;,
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]555 },
556 }</pre>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]557</div>
558
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]559</body></html>