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

[diff] [blame^]

113

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

114

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

115

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

116

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

117

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

118

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

119

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

120

},

Bu Sun Kim

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

[diff] [blame]

121

"post": { # The Post resource.

Dmitry Frenkel

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

[diff] [blame]

122

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

Bu Sun Kim

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

[diff] [blame]

123

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

Bu Sun Kim

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

[diff] [blame]

124

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

125

{

Bu Sun Kim

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

[diff] [blame^]

126

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

127

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

128

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

129

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

130

},

131

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

132

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

133

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

134

},

135

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

136

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

137

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

138

},

139

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

140

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

141

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

142

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

Bu Sun Kim

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

[diff] [blame^]

143

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

Bu Sun Kim

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

[diff] [blame]

144

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

145

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

146

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

147

},

148

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

Bu Sun Kim

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

[diff] [blame]

149

},

150

},

151

],

Dmitry Frenkel

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

[diff] [blame]

152

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

Bu Sun Kim

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

[diff] [blame]

153

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

154

},

Bu Sun Kim

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

[diff] [blame^]

155

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

156

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

157

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

158

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

159

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

160

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

161

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

162

},

163

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

164

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

165

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

166

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

167

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

168

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

169

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

170

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

171

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

172

},

173

},

Dmitry Frenkel

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

[diff] [blame]

174

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

{

"url": "A String",

},

],

Bu Sun Kim

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

[diff] [blame^]

179

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

180

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

181

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

182

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

183

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

184

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

185

},

186

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

187

"A String",

188

],

189

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

190

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

Dmitry Frenkel

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

[diff] [blame]

191

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

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>

Bu Sun Kim

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

[diff] [blame^]

197

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

Dmitry Frenkel

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

[diff] [blame]

204

maxResults: integer, A parameter

Bu Sun Kim

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

[diff] [blame]

205

orderBy: string, A parameter

Dmitry Frenkel

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

[diff] [blame]

206

Allowed values

207

ORDER_BY_UNSPECIFIED -

208

PUBLISHED -

209

UPDATED -

Dmitry Frenkel

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

[diff] [blame]

210

view: string, A parameter

211

Allowed values

212

VIEW_TYPE_UNSPECIFIED -

213

READER -

214

AUTHOR -

215

ADMIN -

Bu Sun Kim

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

[diff] [blame^]

216

endDate: string, A parameter

217

status: string, A parameter (repeated)

Allowed values

LIVE -

DRAFT -

SCHEDULED -

labels: string, A parameter

223

pageToken: string, A parameter

224

startDate: 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

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

235

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

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

[diff] [blame^]

238

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

239

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

240

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

241

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

242

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

243

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

244

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

245

},

Bu Sun Kim

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

[diff] [blame]

246

"post": { # The Post resource.

Dmitry Frenkel

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

[diff] [blame]

247

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

Bu Sun Kim

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

[diff] [blame]

248

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

Bu Sun Kim

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

[diff] [blame]

249

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

250

{

Bu Sun Kim

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

[diff] [blame^]

251

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

252

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

253

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

254

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

255

},

256

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

257

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

258

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

259

},

260

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

261

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

262

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

263

},

264

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

265

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

266

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

267

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

Bu Sun Kim

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

[diff] [blame^]

268

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

Bu Sun Kim

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

[diff] [blame]

269

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

270

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

271

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

272

},

273

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

Bu Sun Kim

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

[diff] [blame]

274

},

275

},

276

],

Dmitry Frenkel

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

[diff] [blame]

277

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

Bu Sun Kim

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

[diff] [blame]

278

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

279

},

Bu Sun Kim

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

[diff] [blame^]

280

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

281

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

282

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

283

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

284

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

285

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

286

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

287

},

288

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

289

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

290

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

291

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

292

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

293

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

294

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

295

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

296

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

297

},

298

},

Dmitry Frenkel

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

[diff] [blame]

299

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

{

"url": "A String",

},

],

Bu Sun Kim

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

[diff] [blame^]

304

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

305

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

306

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

307

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

308

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

309

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

310

},

311

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

312

"A String",

313

],

314

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

315

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

Dmitry Frenkel

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

[diff] [blame]

316

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

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