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

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

[diff] [blame]

82

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

John Asmuth

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

[diff] [blame]

83

84

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

85

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

86

<h3>Method Details</h3>

87

Dan O'Meara

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

[diff] [blame]

88

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

89

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

90

91

Args:

Dan O'Meara

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

[diff] [blame]

92

userId: string, A parameter (required)

93

blogId: string, A parameter (required)

94

postId: string, A parameter (required)

95

maxComments: integer, A parameter

96

x__xgafv: string, V1 error format.

97

Allowed values

98

1 - v1 error format

99

2 - v2 error format

John Asmuth

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

[diff] [blame]

100

101

Returns:

102

An object of the form:

103

104

{

Bu Sun Kim

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

[diff] [blame^]

105

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

Bu Sun Kim

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

[diff] [blame]

106

"post": { # The Post resource.

Bu Sun Kim

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

[diff] [blame^]

107

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

Bu Sun Kim

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

[diff] [blame]

108

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

109

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

Bu Sun Kim

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

[diff] [blame^]

110

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

Bu Sun Kim

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

[diff] [blame]

111

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

112

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

113

},

Bu Sun Kim

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

[diff] [blame]

114

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

John Asmuth

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

[diff] [blame]

115

},

Bu Sun Kim

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

[diff] [blame^]

116

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

117

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

118

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

119

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

120

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

121

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

122

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

123

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

124

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

125

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

126

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

127

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

128

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

129

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

130

},

131

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

132

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

133

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

134

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

135

{

136

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

137

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

138

},

139

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

140

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

141

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

142

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

143

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

144

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

145

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

146

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

147

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

148

},

149

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

150

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

151

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

152

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

153

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

154

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

155

},

156

},

157

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

158

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

},

},

],

},

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

164

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

165

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

166

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

167

},

168

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

169

"A String",

170

],

171

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

Bu Sun Kim

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

[diff] [blame]

172

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

John Asmuth

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

[diff] [blame]

173

{

Bu Sun Kim

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

[diff] [blame]

174

"url": "A String",

John Asmuth

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

[diff] [blame]

175

},

176

],

John Asmuth

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

[diff] [blame]

177

},

Bu Sun Kim

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

[diff] [blame]

178

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

Bu Sun Kim

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

[diff] [blame]

179

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

180

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

Bu Sun Kim

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

[diff] [blame^]

181

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

Bu Sun Kim

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

[diff] [blame]

182

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

Bu Sun Kim

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

[diff] [blame^]

183

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

John Asmuth

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

[diff] [blame]

},

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame^]

189

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

Dan O'Meara

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

[diff] [blame]

190

<pre>Lists post and user info pairs.

John Asmuth

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

[diff] [blame]

191

192

Args:

Dan O'Meara

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

[diff] [blame]

193

userId: string, A parameter (required)

194

blogId: string, A parameter (required)

Bu Sun Kim

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

[diff] [blame^]

195

pageToken: string, A parameter

Bu Sun Kim

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

[diff] [blame]

196

endDate: string, A parameter

197

orderBy: string, A parameter

Bu Sun Kim

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

[diff] [blame^]

198

labels: string, A parameter

Bu Sun Kim

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

[diff] [blame]

199

view: string, A parameter

Bu Sun Kim

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

[diff] [blame^]

200

maxResults: integer, A parameter

201

status: string, A parameter (repeated)

202

startDate: string, A parameter

Bu Sun Kim

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

[diff] [blame]

203

fetchBodies: boolean, A parameter

Dan O'Meara

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

[diff] [blame]

204

x__xgafv: string, V1 error format.

John Asmuth

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

[diff] [blame]

205

Allowed values

Dan O'Meara

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

[diff] [blame]

206

1 - v1 error format

207

2 - v2 error format

John Asmuth

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

[diff] [blame]

208

209

Returns:

210

An object of the form:

211

212

{

Bu Sun Kim

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

[diff] [blame^]

213

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

214

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

215

{

Bu Sun Kim

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

[diff] [blame^]

216

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

Bu Sun Kim

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

[diff] [blame]

217

"post": { # The Post resource.

Bu Sun Kim

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

[diff] [blame^]

218

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

Bu Sun Kim

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

[diff] [blame]

219

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

220

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

Bu Sun Kim

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

[diff] [blame^]

221

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

Bu Sun Kim

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

[diff] [blame]

222

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

223

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

224

},

Bu Sun Kim

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

[diff] [blame]

225

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

John Asmuth

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

[diff] [blame]

226

},

Bu Sun Kim

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

[diff] [blame^]

227

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

228

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

229

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

230

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

231

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

232

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

233

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

234

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

235

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

236

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

237

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

238

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

239

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

240

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

241

},

242

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

243

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

244

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

245

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

246

{

247

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

248

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

249

},

250

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

251

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

252

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

253

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

254

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

255

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

256

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

257

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

258

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

259

},

260

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

261

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

262

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

263

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

264

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

265

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

266

},

267

},

268

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

269

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

},

},

],

},

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

275

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

276

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

277

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

278

},

279

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

280

"A String",

281

],

282

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

Bu Sun Kim

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

[diff] [blame]

283

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

John Asmuth

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

[diff] [blame]

284

{

Bu Sun Kim

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

[diff] [blame]

285

"url": "A String",

John Asmuth

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

[diff] [blame]

286

},

287

],

John Asmuth

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

[diff] [blame]

288

},

Bu Sun Kim

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

[diff] [blame]

289

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

Bu Sun Kim

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

[diff] [blame]

290

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

291

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

Bu Sun Kim

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

[diff] [blame^]

292

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

Bu Sun Kim

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

[diff] [blame]

293

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

Bu Sun Kim

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

[diff] [blame^]

294

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

John Asmuth

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

[diff] [blame]

295

},

296

},

297

],

Bu Sun Kim

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

[diff] [blame^]

298

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

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>

304

<pre>Retrieves the next page of results.

305

306

Args:

307

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

308

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

309

310

Returns:

Bu Sun Kim

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

[diff] [blame]

311

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

John Asmuth