Blame - docs/dyn/blogger_v3.postUserInfos.html - platform/external/python/google-api-python-client

2020-05-01 07:42:23 -0700

[diff] [blame]

85

<p class="firstline">Lists post and user info pairs.</p>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

86

87

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

88

<p class="firstline">Retrieves the next page of results.</p>

89

<h3>Method Details</h3>

90

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

91

<code class="details" id="close">close()</code>

92

<pre>Close httplib2 connections.</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

96

<code class="details" id="get">get(userId, blogId, postId, maxComments=None, x__xgafv=None)</code>

97

<pre>Gets one post and user info pair, by post_id and user_id.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

98

99

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

100

userId: string, A parameter (required)

101

blogId: string, A parameter (required)

102

postId: string, A parameter (required)

103

maxComments: integer, A parameter

104

x__xgafv: string, V1 error format.

105

Allowed values

106

1 - v1 error format

107

2 - v2 error format

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

108

109

Returns:

110

An object of the form:

111

112

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

113

"post": { # The Post resource.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

114

"content": "A String", # The content of the Post. May contain HTML markup.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

115

"selfLink": "A String", # The API REST URL to fetch this resource from.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

116

"kind": "A String", # The kind of this entity. Always blogger#post.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

117

"author": { # The author of this Post.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

118

"url": "A String", # The URL of the creator's Profile page.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

119

"displayName": "A String", # The display name.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

120

"image": { # The creator's avatar.

121

"url": "A String", # The creator's avatar URL.

122

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

123

"id": "A String", # The identifier of the creator.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

124

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

125

"title": "A String", # The title of the Post.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

126

"labels": [ # The list of labels this Post was tagged with.

127

"A String",

128

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

129

"titleLink": "A String", # The title link URL, similar to atom's related link.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

130

"updated": "A String", # RFC 3339 date-time when this Post was last updated.

131

"location": { # The location for geotagged posts.

132

"lat": 3.14, # Location's latitude.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

133

"lng": 3.14, # Location's longitude.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

134

"span": "A String", # Location's viewport span. Can be used when rendering a map preview.

135

"name": "A String", # Location name.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

136

},

137

"customMetaData": "A String", # The JSON meta-data for the Post.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

138

"url": "A String", # The URL where this Post is displayed.

139

"readerComments": "A String", # Comment control and display setting for readers of this post.

140

"status": "A String", # Status of the post. Only set for admin-level requests.

141

"published": "A String", # RFC 3339 date-time when this Post was published.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

142

"blog": { # Data about the blog containing this Post.

143

"id": "A String", # The identifier of the Blog that contains this Post.

144

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

145

"etag": "A String", # Etag of the resource.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

146

"replies": { # The container of comments on this Post.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

147

"items": [ # The List of Comments for this Post.

148

{

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

149

"author": { # The author of this Comment.

150

"displayName": "A String", # The display name.

151

"image": { # The creator's avatar.

152

"url": "A String", # The creator's avatar URL.

153

},

154

"id": "A String", # The identifier of the creator.

155

"url": "A String", # The URL of the creator's Profile page.

156

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

157

"inReplyTo": { # Data about the comment this is in reply to.

158

"id": "A String", # The identified of the parent of this comment.

159

},

160

"content": "A String", # The actual content of the comment. May include HTML markup.

161

"post": { # Data about the post containing this comment.

162

"id": "A String", # The identifier of the post containing this comment.

163

},

164

"kind": "A String", # The kind of this entry. Always blogger#comment.

165

"blog": { # Data about the blog containing this comment.

166

"id": "A String", # The identifier of the blog containing this comment.

167

},

168

"id": "A String", # The identifier for this resource.

169

"published": "A String", # RFC 3339 date-time when this comment was published.

170

"status": "A String", # The status of the comment (only populated for admin users).

171

"selfLink": "A String", # The API REST URL to fetch this resource from.

172

"updated": "A String", # RFC 3339 date-time when this comment was last updated.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

173

},

174

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

175

"totalItems": "A String", # The count of comments on this post.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

176

"selfLink": "A String", # The URL of the comments on this post.

177

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

178

"images": [ # Display image for the Post.

{

"url": "A String",

},

],

"id": "A String", # The identifier of this Post.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

184

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

185

"post_user_info": { # Information about a User for the Post.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

186

"blogId": "A String", # ID of the Blog that the post resource belongs to.

187

"hasEditAccess": True or False, # True if the user has Author level access to the post.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

188

"kind": "A String", # The kind of this entity. Always blogger#postPerUserInfo.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

189

"userId": "A String", # ID of the User.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

190

"postId": "A String", # ID of the Post resource.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

191

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

192

"kind": "A String", # The kind of this entity. Always blogger#postUserInfo.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

197

<code class="details" id="list">list(userId, blogId, pageToken=None, startDate=None, labels=None, maxResults=None, status=None, orderBy=None, endDate=None, view=None, fetchBodies=None, x__xgafv=None)</code>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

198

<pre>Lists post and user info pairs.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

199

200

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

201

userId: string, A parameter (required)

202

blogId: string, A parameter (required)

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

203

pageToken: string, A parameter

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

204

startDate: string, A parameter

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

205

labels: string, A parameter

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

206

maxResults: integer, A parameter

207

status: string, A parameter (repeated)

Allowed values

LIVE -

DRAFT -

SCHEDULED -

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

212

orderBy: string, A parameter

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

213

Allowed values

214

ORDER_BY_UNSPECIFIED -

215

PUBLISHED -

216

UPDATED -

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

217

endDate: string, A parameter

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

218

view: string, A parameter

219

Allowed values

220

VIEW_TYPE_UNSPECIFIED -

READER -

AUTHOR -

ADMIN -

fetchBodies: boolean, A parameter

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

225

x__xgafv: string, V1 error format.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

226

Allowed values

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

227

1 - v1 error format

228

2 - v2 error format

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

229

230

Returns:

231

An object of the form:

232

233

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

234

"items": [ # The list of Posts with User information for the post, for this Blog.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

235

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

236

"post": { # The Post resource.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

237

"content": "A String", # The content of the Post. May contain HTML markup.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

238

"selfLink": "A String", # The API REST URL to fetch this resource from.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

239

"kind": "A String", # The kind of this entity. Always blogger#post.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

240

"author": { # The author of this Post.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

241

"url": "A String", # The URL of the creator's Profile page.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

242

"displayName": "A String", # The display name.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

243

"image": { # The creator's avatar.

244

"url": "A String", # The creator's avatar URL.

245

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

246

"id": "A String", # The identifier of the creator.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

247

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

248

"title": "A String", # The title of the Post.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

249

"labels": [ # The list of labels this Post was tagged with.

250

"A String",

251

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

252

"titleLink": "A String", # The title link URL, similar to atom's related link.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

253

"updated": "A String", # RFC 3339 date-time when this Post was last updated.

254

"location": { # The location for geotagged posts.

255

"lat": 3.14, # Location's latitude.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

256

"lng": 3.14, # Location's longitude.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

257

"span": "A String", # Location's viewport span. Can be used when rendering a map preview.

258

"name": "A String", # Location name.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

259

},

260

"customMetaData": "A String", # The JSON meta-data for the Post.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

261

"url": "A String", # The URL where this Post is displayed.

262

"readerComments": "A String", # Comment control and display setting for readers of this post.

263

"status": "A String", # Status of the post. Only set for admin-level requests.

264

"published": "A String", # RFC 3339 date-time when this Post was published.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

265

"blog": { # Data about the blog containing this Post.

266

"id": "A String", # The identifier of the Blog that contains this Post.

267

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

268

"etag": "A String", # Etag of the resource.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

269

"replies": { # The container of comments on this Post.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

270

"items": [ # The List of Comments for this Post.

271

{

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

272

"author": { # The author of this Comment.

273

"displayName": "A String", # The display name.

274

"image": { # The creator's avatar.

275

"url": "A String", # The creator's avatar URL.

276

},

277

"id": "A String", # The identifier of the creator.

278

"url": "A String", # The URL of the creator's Profile page.

279

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

280

"inReplyTo": { # Data about the comment this is in reply to.

281

"id": "A String", # The identified of the parent of this comment.

282

},

283

"content": "A String", # The actual content of the comment. May include HTML markup.

284

"post": { # Data about the post containing this comment.

285

"id": "A String", # The identifier of the post containing this comment.

286

},

287

"kind": "A String", # The kind of this entry. Always blogger#comment.

288

"blog": { # Data about the blog containing this comment.

289

"id": "A String", # The identifier of the blog containing this comment.

290

},

291

"id": "A String", # The identifier for this resource.

292

"published": "A String", # RFC 3339 date-time when this comment was published.

293

"status": "A String", # The status of the comment (only populated for admin users).

294

"selfLink": "A String", # The API REST URL to fetch this resource from.

295

"updated": "A String", # RFC 3339 date-time when this comment was last updated.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

296

},

297

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

298

"totalItems": "A String", # The count of comments on this post.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

299

"selfLink": "A String", # The URL of the comments on this post.

300

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

301

"images": [ # Display image for the Post.

{

"url": "A String",

},

],

"id": "A String", # The identifier of this Post.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

307

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

308

"post_user_info": { # Information about a User for the Post.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

309

"blogId": "A String", # ID of the Blog that the post resource belongs to.

310

"hasEditAccess": True or False, # True if the user has Author level access to the post.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

311

"kind": "A String", # The kind of this entity. Always blogger#postPerUserInfo.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

312

"userId": "A String", # ID of the User.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

313

"postId": "A String", # ID of the Post resource.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

314

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

315

"kind": "A String", # The kind of this entity. Always blogger#postUserInfo.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

316

},

317

],

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

318

"kind": "A String", # The kind of this entity. Always blogger#postList.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

319

"nextPageToken": "A String", # Pagination token to fetch the next page, if one exists.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

325

<pre>Retrieves the next page of results.

326

327

Args:

328

previous_request: The request for the previous page. (required)

329

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

330

331

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

332

A request object that you can call 'execute()' on to request the next

John Asmuth