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.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

114

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

115

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

116

"A String",

117

],

118

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

119

"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]

120

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

Bu Sun Kim

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

[diff] [blame]

121

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

122

{

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

123

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

124

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

125

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

126

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

127

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

128

},

Bu Sun Kim

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

[diff] [blame]

129

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

130

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

131

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

Bu Sun Kim

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

[diff] [blame]

132

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

133

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

134

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

135

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

136

},

137

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

138

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

139

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

140

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

141

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

142

},

143

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

144

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

145

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

Bu Sun Kim

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

[diff] [blame]

146

},

147

},

148

],

Dmitry Frenkel

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

[diff] [blame]

149

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

Bu Sun Kim

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

[diff] [blame]

150

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

151

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

152

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

153

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

154

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

155

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

156

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

157

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

158

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

159

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

160

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

161

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

Dmitry Frenkel

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

[diff] [blame]

162

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

{

"url": "A String",

},

],

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

168

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

169

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

170

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

171

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

172

},

173

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

174

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

175

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

176

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

177

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

178

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

179

},

180

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

181

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

182

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

183

},

184

},

185

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

186

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

187

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

188

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

189

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

190

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

191

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

John Asmuth

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

[diff] [blame]

192

},

John Asmuth

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

[diff] [blame]

}</pre>

</div>

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

197

<code class="details" id="list">list(userId, blogId, fetchBodies=None, labels=None, endDate=None, status=None, maxResults=None, orderBy=None, startDate=None, view=None, pageToken=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-11-16 11:05:03 -0700

[diff] [blame]

203

fetchBodies: boolean, A parameter

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

204

labels: string, A parameter

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

205

endDate: string, A parameter

206

status: string, A parameter (repeated)

Allowed values

LIVE -

DRAFT -

SCHEDULED -

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

211

maxResults: integer, A parameter

212

orderBy: string, A parameter

213

Allowed values

214

ORDER_BY_UNSPECIFIED -

215

PUBLISHED -

216

UPDATED -

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

217

startDate: string, A parameter

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

218

view: string, A parameter

219

Allowed values

220

VIEW_TYPE_UNSPECIFIED -

READER -

AUTHOR -

ADMIN -

pageToken: string, 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-11-16 11:05:03 -0700

[diff] [blame]

234

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

235

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

Bu Sun Kim

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

[diff] [blame]

236

"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]

237

{

Bu Sun Kim

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

[diff] [blame]

238

"post": { # The Post resource.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

239

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

240

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

241

"A String",

242

],

243

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

244

"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]

245

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

Bu Sun Kim

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

[diff] [blame]

246

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

247

{

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

248

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

249

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

250

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

251

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

252

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

253

},

Bu Sun Kim

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

[diff] [blame]

254

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

255

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

256

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

Bu Sun Kim

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

[diff] [blame]

257

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

258

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

259

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

260

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

261

},

262

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

263

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

264

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

265

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

266

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

267

},

268

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

269

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

270

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

Bu Sun Kim

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

[diff] [blame]

271

},

272

},

273

],

Dmitry Frenkel

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

[diff] [blame]

274

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

Bu Sun Kim

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

[diff] [blame]

275

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

276

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

277

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

278

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

279

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

280

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

281

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

282

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

283

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

284

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

285

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

286

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

Dmitry Frenkel

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

[diff] [blame]

287

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

{

"url": "A String",

},

],

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

293

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

294

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

295

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

296

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

297

},

298

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

299

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

300

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

301

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

302

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

303

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

304

},

305

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

306

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

307

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

308

},

309

},

310

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

311

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

312

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

313

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

314

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

315

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

316

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

John Asmuth

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

[diff] [blame]

317

},

John Asmuth

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

[diff] [blame]

318

},

319

],

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