1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
|
<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="readerrevenuesubscriptionlinking_v1.html">Reader Revenue Subscription Linking API</a> . <a href="readerrevenuesubscriptionlinking_v1.publications.html">publications</a> . <a href="readerrevenuesubscriptionlinking_v1.publications.readers.html">readers</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(name, force=None, x__xgafv=None)</a></code></p>
<p class="firstline">Removes a publication reader, effectively severing the association with a Google user. If `force` is set to true, any entitlements for this reader will also be deleted. (Otherwise, the request will only work if the reader has no entitlements.) - If the reader does not exist, return NOT_FOUND. - Return FAILED_PRECONDITION if the force field is false (or unset) and entitlements are present.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a reader of a publication. Returns NOT_FOUND if the reader does not exist.</p>
<p class="toc_element">
<code><a href="#getEntitlements">getEntitlements(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the reader entitlements for a publication reader. - Returns PERMISSION_DENIED if the caller does not have access. - Returns NOT_FOUND if the reader does not exist.</p>
<p class="toc_element">
<code><a href="#updateEntitlements">updateEntitlements(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the reader entitlements for a publication reader. The entire reader entitlements will be overwritten by the new reader entitlements in the payload, like a PUT. - Returns PERMISSION_DENIED if the caller does not have access. - Returns NOT_FOUND if the reader does not exist.</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(name, force=None, x__xgafv=None)</code>
<pre>Removes a publication reader, effectively severing the association with a Google user. If `force` is set to true, any entitlements for this reader will also be deleted. (Otherwise, the request will only work if the reader has no entitlements.) - If the reader does not exist, return NOT_FOUND. - Return FAILED_PRECONDITION if the force field is false (or unset) and entitlements are present.
Args:
name: string, Required. The resource name of the reader. Format: publications/{publication_id}/readers/{ppid} (required)
force: boolean, If set to true, any entitlements under the reader will also be purged.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response to deleting a reader of a publication.
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets a reader of a publication. Returns NOT_FOUND if the reader does not exist.
Args:
name: string, Required. The resource name of the reader. Format: publications/{publication_id}/readers/{ppid} (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A reader of a publication.
"createTime": "A String", # Output only. Time the publication reader was created and associated with a Google user.
"name": "A String", # Output only. The resource name of the reader. The last part of ppid in the resource name is the publisher provided id.
"originatingPublicationId": "A String", # Output only. The SwG publication id that the reader's subscription linking was originating from.
"ppid": "A String", # Output only. The publisher provided id of the reader.
"publicationId": "A String", # Output only. The SwG publication id that the reader has linked their subscription to.
}</pre>
</div>
<div class="method">
<code class="details" id="getEntitlements">getEntitlements(name, x__xgafv=None)</code>
<pre>Gets the reader entitlements for a publication reader. - Returns PERMISSION_DENIED if the caller does not have access. - Returns NOT_FOUND if the reader does not exist.
Args:
name: string, Required. The name of the reader entitlements to retrieve. Format: publications/{publication_id}/readers/{reader_id}/entitlements (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A singleton containing all of a reader's entitlements for a publication.
"entitlements": [ # All of the entitlements for a publication reader.
{ # A single entitlement for a publication reader
"detail": "A String", # The detail field can carry a description of the SKU that corresponds to what the user has been granted access to. This description, which is opaque to Google, can be displayed in the Google user subscription console for users who linked the subscription to a Google Account. Max 80 character limit.
"expireTime": "A String", # Required. Expiration time of the entitlement. Entitlements that have expired over 30 days will be purged. The max expire_time is 398 days from now().
"productId": "A String", # Required. The publication's product ID that the user has access to. This is the same product ID as can be found in Schema.org markup (http://schema.org/productID). E.g. "dailybugle.com:basic"
"subscriptionToken": "A String", # A source-specific subscription token. This is an opaque string that the publisher provides to Google. This token is opaque and has no meaning to Google.
},
],
"name": "A String", # Output only. The resource name of the singleton.
}</pre>
</div>
<div class="method">
<code class="details" id="updateEntitlements">updateEntitlements(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates the reader entitlements for a publication reader. The entire reader entitlements will be overwritten by the new reader entitlements in the payload, like a PUT. - Returns PERMISSION_DENIED if the caller does not have access. - Returns NOT_FOUND if the reader does not exist.
Args:
name: string, Output only. The resource name of the singleton. (required)
body: object, The request body.
The object takes the form of:
{ # A singleton containing all of a reader's entitlements for a publication.
"entitlements": [ # All of the entitlements for a publication reader.
{ # A single entitlement for a publication reader
"detail": "A String", # The detail field can carry a description of the SKU that corresponds to what the user has been granted access to. This description, which is opaque to Google, can be displayed in the Google user subscription console for users who linked the subscription to a Google Account. Max 80 character limit.
"expireTime": "A String", # Required. Expiration time of the entitlement. Entitlements that have expired over 30 days will be purged. The max expire_time is 398 days from now().
"productId": "A String", # Required. The publication's product ID that the user has access to. This is the same product ID as can be found in Schema.org markup (http://schema.org/productID). E.g. "dailybugle.com:basic"
"subscriptionToken": "A String", # A source-specific subscription token. This is an opaque string that the publisher provides to Google. This token is opaque and has no meaning to Google.
},
],
"name": "A String", # Output only. The resource name of the singleton.
}
updateMask: string, Optional. The list of fields to update. Defaults to all fields.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A singleton containing all of a reader's entitlements for a publication.
"entitlements": [ # All of the entitlements for a publication reader.
{ # A single entitlement for a publication reader
"detail": "A String", # The detail field can carry a description of the SKU that corresponds to what the user has been granted access to. This description, which is opaque to Google, can be displayed in the Google user subscription console for users who linked the subscription to a Google Account. Max 80 character limit.
"expireTime": "A String", # Required. Expiration time of the entitlement. Entitlements that have expired over 30 days will be purged. The max expire_time is 398 days from now().
"productId": "A String", # Required. The publication's product ID that the user has access to. This is the same product ID as can be found in Schema.org markup (http://schema.org/productID). E.g. "dailybugle.com:basic"
"subscriptionToken": "A String", # A source-specific subscription token. This is an opaque string that the publisher provides to Google. This token is opaque and has no meaning to Google.
},
],
"name": "A String", # Output only. The resource name of the singleton.
}</pre>
</div>
</body></html>
|
