File: blogger_v3.postUserInfos.html

package info (click to toggle)
python-googleapi 2.180.0-1
  • links: PTS
  • area: main
  • in suites: forky, sid
  • size: 527,124 kB
  • sloc: python: 11,076; javascript: 249; sh: 114; makefile: 59
file content (340 lines) | stat: -rw-r--r-- 15,465 bytes parent folder | download | duplicates (2)
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
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
<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="blogger_v3.html">Blogger API</a> . <a href="blogger_v3.postUserInfos.html">postUserInfos</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="#get">get(userId, blogId, postId, maxComments=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets one post and user info pair, by post_id and user_id.</p>
<p class="toc_element">
  <code><a href="#list">list(userId, blogId, endDate=None, fetchBodies=None, labels=None, maxResults=None, orderBy=None, pageToken=None, startDate=None, status=None, view=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists post and user info pairs.</p>
<p class="toc_element">
  <code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</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="get">get(userId, blogId, postId, maxComments=None, x__xgafv=None)</code>
  <pre>Gets one post and user info pair, by post_id and user_id.

Args:
  userId: string, A parameter (required)
  blogId: string, A parameter (required)
  postId: string, A parameter (required)
  maxComments: integer, A parameter
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  &quot;kind&quot;: &quot;A String&quot;, # The kind of this entity. Always blogger#postUserInfo.
  &quot;post&quot;: { # The Post resource.
    &quot;author&quot;: { # The author of this Post.
      &quot;displayName&quot;: &quot;A String&quot;, # The display name.
      &quot;id&quot;: &quot;A String&quot;, # The identifier of the creator.
      &quot;image&quot;: { # The creator&#x27;s avatar.
        &quot;url&quot;: &quot;A String&quot;, # The creator&#x27;s avatar URL.
      },
      &quot;url&quot;: &quot;A String&quot;, # The URL of the creator&#x27;s Profile page.
    },
    &quot;blog&quot;: { # Data about the blog containing this Post.
      &quot;id&quot;: &quot;A String&quot;, # The identifier of the Blog that contains this Post.
    },
    &quot;content&quot;: &quot;A String&quot;, # The content of the Post. May contain HTML markup.
    &quot;customMetaData&quot;: &quot;A String&quot;, # The JSON meta-data for the Post.
    &quot;etag&quot;: &quot;A String&quot;, # Etag of the resource.
    &quot;id&quot;: &quot;A String&quot;, # The identifier of this Post.
    &quot;images&quot;: [ # Display image for the Post.
      {
        &quot;url&quot;: &quot;A String&quot;,
      },
    ],
    &quot;kind&quot;: &quot;A String&quot;, # The kind of this entity. Always blogger#post.
    &quot;labels&quot;: [ # The list of labels this Post was tagged with.
      &quot;A String&quot;,
    ],
    &quot;location&quot;: { # The location for geotagged posts.
      &quot;lat&quot;: 3.14, # Location&#x27;s latitude.
      &quot;lng&quot;: 3.14, # Location&#x27;s longitude.
      &quot;name&quot;: &quot;A String&quot;, # Location name.
      &quot;span&quot;: &quot;A String&quot;, # Location&#x27;s viewport span. Can be used when rendering a map preview.
    },
    &quot;published&quot;: &quot;A String&quot;, # RFC 3339 date-time when this Post was published.
    &quot;readerComments&quot;: &quot;A String&quot;, # Comment control and display setting for readers of this post.
    &quot;replies&quot;: { # The container of comments on this Post.
      &quot;items&quot;: [ # The List of Comments for this Post.
        {
          &quot;author&quot;: { # The author of this Comment.
            &quot;displayName&quot;: &quot;A String&quot;, # The display name.
            &quot;id&quot;: &quot;A String&quot;, # The identifier of the creator.
            &quot;image&quot;: { # The creator&#x27;s avatar.
              &quot;url&quot;: &quot;A String&quot;, # The creator&#x27;s avatar URL.
            },
            &quot;url&quot;: &quot;A String&quot;, # The URL of the creator&#x27;s Profile page.
          },
          &quot;blog&quot;: { # Data about the blog containing this comment.
            &quot;id&quot;: &quot;A String&quot;, # The identifier of the blog containing this comment.
          },
          &quot;content&quot;: &quot;A String&quot;, # The actual content of the comment. May include HTML markup.
          &quot;id&quot;: &quot;A String&quot;, # The identifier for this resource.
          &quot;inReplyTo&quot;: { # Data about the comment this is in reply to.
            &quot;id&quot;: &quot;A String&quot;, # The identified of the parent of this comment.
          },
          &quot;kind&quot;: &quot;A String&quot;, # The kind of this entry. Always blogger#comment.
          &quot;post&quot;: { # Data about the post containing this comment.
            &quot;id&quot;: &quot;A String&quot;, # The identifier of the post containing this comment.
          },
          &quot;published&quot;: &quot;A String&quot;, # RFC 3339 date-time when this comment was published.
          &quot;selfLink&quot;: &quot;A String&quot;, # The API REST URL to fetch this resource from.
          &quot;status&quot;: &quot;A String&quot;, # The status of the comment (only populated for admin users).
          &quot;updated&quot;: &quot;A String&quot;, # RFC 3339 date-time when this comment was last updated.
        },
      ],
      &quot;selfLink&quot;: &quot;A String&quot;, # The URL of the comments on this post.
      &quot;totalItems&quot;: &quot;A String&quot;, # The count of comments on this post.
    },
    &quot;selfLink&quot;: &quot;A String&quot;, # The API REST URL to fetch this resource from.
    &quot;status&quot;: &quot;A String&quot;, # Status of the post. Only set for admin-level requests.
    &quot;title&quot;: &quot;A String&quot;, # The title of the Post.
    &quot;titleLink&quot;: &quot;A String&quot;, # The title link URL, similar to atom&#x27;s related link.
    &quot;trashed&quot;: &quot;A String&quot;, # RFC 3339 date-time when this Post was last trashed.
    &quot;updated&quot;: &quot;A String&quot;, # RFC 3339 date-time when this Post was last updated.
    &quot;url&quot;: &quot;A String&quot;, # The URL where this Post is displayed.
  },
  &quot;post_user_info&quot;: { # Information about a User for the Post.
    &quot;blogId&quot;: &quot;A String&quot;, # ID of the Blog that the post resource belongs to.
    &quot;hasEditAccess&quot;: True or False, # True if the user has Author level access to the post.
    &quot;kind&quot;: &quot;A String&quot;, # The kind of this entity. Always blogger#postPerUserInfo.
    &quot;postId&quot;: &quot;A String&quot;, # ID of the Post resource.
    &quot;userId&quot;: &quot;A String&quot;, # ID of the User.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list(userId, blogId, endDate=None, fetchBodies=None, labels=None, maxResults=None, orderBy=None, pageToken=None, startDate=None, status=None, view=None, x__xgafv=None)</code>
  <pre>Lists post and user info pairs.

Args:
  userId: string, A parameter (required)
  blogId: string, A parameter (required)
  endDate: string, A parameter
  fetchBodies: boolean, A parameter
  labels: string, A parameter
  maxResults: integer, A parameter
  orderBy: string, A parameter
    Allowed values
      ORDER_BY_UNSPECIFIED - 
      PUBLISHED - 
      UPDATED - 
  pageToken: string, A parameter
  startDate: string, A parameter
  status: string, A parameter (repeated)
    Allowed values
      LIVE - 
      DRAFT - 
      SCHEDULED - 
      SOFT_TRASHED - 
  view: string, A parameter
    Allowed values
      VIEW_TYPE_UNSPECIFIED - 
      READER - 
      AUTHOR - 
      ADMIN - 
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  &quot;items&quot;: [ # The list of Posts with User information for the post, for this Blog.
    {
      &quot;kind&quot;: &quot;A String&quot;, # The kind of this entity. Always blogger#postUserInfo.
      &quot;post&quot;: { # The Post resource.
        &quot;author&quot;: { # The author of this Post.
          &quot;displayName&quot;: &quot;A String&quot;, # The display name.
          &quot;id&quot;: &quot;A String&quot;, # The identifier of the creator.
          &quot;image&quot;: { # The creator&#x27;s avatar.
            &quot;url&quot;: &quot;A String&quot;, # The creator&#x27;s avatar URL.
          },
          &quot;url&quot;: &quot;A String&quot;, # The URL of the creator&#x27;s Profile page.
        },
        &quot;blog&quot;: { # Data about the blog containing this Post.
          &quot;id&quot;: &quot;A String&quot;, # The identifier of the Blog that contains this Post.
        },
        &quot;content&quot;: &quot;A String&quot;, # The content of the Post. May contain HTML markup.
        &quot;customMetaData&quot;: &quot;A String&quot;, # The JSON meta-data for the Post.
        &quot;etag&quot;: &quot;A String&quot;, # Etag of the resource.
        &quot;id&quot;: &quot;A String&quot;, # The identifier of this Post.
        &quot;images&quot;: [ # Display image for the Post.
          {
            &quot;url&quot;: &quot;A String&quot;,
          },
        ],
        &quot;kind&quot;: &quot;A String&quot;, # The kind of this entity. Always blogger#post.
        &quot;labels&quot;: [ # The list of labels this Post was tagged with.
          &quot;A String&quot;,
        ],
        &quot;location&quot;: { # The location for geotagged posts.
          &quot;lat&quot;: 3.14, # Location&#x27;s latitude.
          &quot;lng&quot;: 3.14, # Location&#x27;s longitude.
          &quot;name&quot;: &quot;A String&quot;, # Location name.
          &quot;span&quot;: &quot;A String&quot;, # Location&#x27;s viewport span. Can be used when rendering a map preview.
        },
        &quot;published&quot;: &quot;A String&quot;, # RFC 3339 date-time when this Post was published.
        &quot;readerComments&quot;: &quot;A String&quot;, # Comment control and display setting for readers of this post.
        &quot;replies&quot;: { # The container of comments on this Post.
          &quot;items&quot;: [ # The List of Comments for this Post.
            {
              &quot;author&quot;: { # The author of this Comment.
                &quot;displayName&quot;: &quot;A String&quot;, # The display name.
                &quot;id&quot;: &quot;A String&quot;, # The identifier of the creator.
                &quot;image&quot;: { # The creator&#x27;s avatar.
                  &quot;url&quot;: &quot;A String&quot;, # The creator&#x27;s avatar URL.
                },
                &quot;url&quot;: &quot;A String&quot;, # The URL of the creator&#x27;s Profile page.
              },
              &quot;blog&quot;: { # Data about the blog containing this comment.
                &quot;id&quot;: &quot;A String&quot;, # The identifier of the blog containing this comment.
              },
              &quot;content&quot;: &quot;A String&quot;, # The actual content of the comment. May include HTML markup.
              &quot;id&quot;: &quot;A String&quot;, # The identifier for this resource.
              &quot;inReplyTo&quot;: { # Data about the comment this is in reply to.
                &quot;id&quot;: &quot;A String&quot;, # The identified of the parent of this comment.
              },
              &quot;kind&quot;: &quot;A String&quot;, # The kind of this entry. Always blogger#comment.
              &quot;post&quot;: { # Data about the post containing this comment.
                &quot;id&quot;: &quot;A String&quot;, # The identifier of the post containing this comment.
              },
              &quot;published&quot;: &quot;A String&quot;, # RFC 3339 date-time when this comment was published.
              &quot;selfLink&quot;: &quot;A String&quot;, # The API REST URL to fetch this resource from.
              &quot;status&quot;: &quot;A String&quot;, # The status of the comment (only populated for admin users).
              &quot;updated&quot;: &quot;A String&quot;, # RFC 3339 date-time when this comment was last updated.
            },
          ],
          &quot;selfLink&quot;: &quot;A String&quot;, # The URL of the comments on this post.
          &quot;totalItems&quot;: &quot;A String&quot;, # The count of comments on this post.
        },
        &quot;selfLink&quot;: &quot;A String&quot;, # The API REST URL to fetch this resource from.
        &quot;status&quot;: &quot;A String&quot;, # Status of the post. Only set for admin-level requests.
        &quot;title&quot;: &quot;A String&quot;, # The title of the Post.
        &quot;titleLink&quot;: &quot;A String&quot;, # The title link URL, similar to atom&#x27;s related link.
        &quot;trashed&quot;: &quot;A String&quot;, # RFC 3339 date-time when this Post was last trashed.
        &quot;updated&quot;: &quot;A String&quot;, # RFC 3339 date-time when this Post was last updated.
        &quot;url&quot;: &quot;A String&quot;, # The URL where this Post is displayed.
      },
      &quot;post_user_info&quot;: { # Information about a User for the Post.
        &quot;blogId&quot;: &quot;A String&quot;, # ID of the Blog that the post resource belongs to.
        &quot;hasEditAccess&quot;: True or False, # True if the user has Author level access to the post.
        &quot;kind&quot;: &quot;A String&quot;, # The kind of this entity. Always blogger#postPerUserInfo.
        &quot;postId&quot;: &quot;A String&quot;, # ID of the Post resource.
        &quot;userId&quot;: &quot;A String&quot;, # ID of the User.
      },
    },
  ],
  &quot;kind&quot;: &quot;A String&quot;, # The kind of this entity. Always blogger#postList.
  &quot;nextPageToken&quot;: &quot;A String&quot;, # Pagination token to fetch the next page, if one exists.
}</pre>
</div>

<div class="method">
    <code class="details" id="list_next">list_next()</code>
  <pre>Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call &#x27;execute()&#x27; on to request the next
          page. Returns None if there are no more items in the collection.
        </pre>
</div>

</body></html>