Blame - docs/dyn/blogger_v2.posts.html - platform/external/python/google-api-python-client

2016-10-21 13:59:49 -0700

[diff] [blame]

<style>

body, h1, h2, h3, div, span, p, pre, a {

margin: 0;

padding: 0;

border: 0;

font-weight: inherit;

9

font-style: inherit;

10

font-size: 100%;

11

font-family: inherit;

12

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>

Dan O'Meara

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

[diff] [blame]

75

<h1><a href="blogger_v2.html">Blogger API v3</a> . <a href="blogger_v2.posts.html">posts</a></h1>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

76

<h2>Instance Methods</h2>

77

Dmitry Frenkel

3e17f89

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

[diff] [blame]

78

<code><a href="#close">close()</a></code></p>

79

<p class="firstline">Close httplib2 connections.</p>

80

Dan O'Meara

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

[diff] [blame]

81

<code><a href="#get">get(blogId, postId, x__xgafv=None)</a></code></p>

82

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

83

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

84

<code><a href="#list">list(blogId, fetchBodies=None, maxResults=None, pageToken=None, startDate=None, x__xgafv=None)</a></code></p>

Dan O'Meara

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

[diff] [blame]

85

<p class="firstline">Lists posts.</p>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[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

3e17f89

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(blogId, postId, x__xgafv=None)</code>

97

<pre>Gets a post by blog id and post id

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

98

99

Args:

Dan O'Meara

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

[diff] [blame]

100

blogId: string, A parameter (required)

101

postId: string, A parameter (required)

102

x__xgafv: string, V1 error format.

103

Allowed values

104

1 - v1 error format

105

2 - v2 error format

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

106

107

Returns:

108

An object of the form:

109

110

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

111

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

112

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

113

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

114

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

115

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

Yoshi Automation Bot

0bf565c

2020-12-09 08:56:03 -0800

[diff] [blame]

116

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

117

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

118

},

119

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

120

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

121

},

122

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

123

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

124

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

125

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

126

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

127

{

128

"url": "A String",

Yoshi Automation Bot

0bf565c

2020-12-09 08:56:03 -0800

[diff] [blame]

129

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

130

],

131

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

132

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

133

"A String",

134

],

135

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

136

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

137

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

138

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

139

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

140

},

141

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

142

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

143

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

144

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

Yoshi Automation Bot

0d561ef

2020-11-25 07:50:41 -0800

[diff] [blame]

145

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

146

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

147

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

148

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

149

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

150

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

151

},

152

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

153

},

154

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

155

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

156

},

157

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

158

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

159

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

160

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

161

},

162

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

163

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

164

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

165

},

166

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

167

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

168

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

169

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

Yoshi Automation Bot

0d561ef

2020-11-25 07:50:41 -0800

[diff] [blame]

170

},

171

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

172

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

173

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

174

},

175

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

176

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

177

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

178

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

179

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

180

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

181

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

185

<code class="details" id="list">list(blogId, fetchBodies=None, maxResults=None, pageToken=None, startDate=None, x__xgafv=None)</code>

Dan O'Meara

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

[diff] [blame]

186

<pre>Lists posts.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

187

188

Args:

Dan O'Meara

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

[diff] [blame]

189

blogId: string, A parameter (required)

Yoshi Automation Bot

b6971b0

2020-11-26 17:16:03 -0800

[diff] [blame]

190

fetchBodies: boolean, A parameter

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

191

maxResults: integer, A parameter

Yoshi Automation Bot

b6971b0

2020-11-26 17:16:03 -0800

[diff] [blame]

192

pageToken: string, A parameter

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

193

startDate: string, A parameter

Dan O'Meara

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

[diff] [blame]

194

x__xgafv: string, V1 error format.

195

Allowed values

196

1 - v1 error format

197

2 - v2 error format

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

198

199

Returns:

200

An object of the form:

201

202

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

203

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

204

"items": [ # The list of Posts for this Blog.

205

{

206

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

207

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

208

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

209

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

210

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

Yoshi Automation Bot

0bf565c

2020-12-09 08:56:03 -0800

[diff] [blame]

211

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

212

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

213

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

214

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

215

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

216

},

217

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

218

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

219

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

220

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

221

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

{

"url": "A String",

},

],

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

227

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

228

"A String",

229

],

230

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

231

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

232

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

233

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

234

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

235

},

236

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

237

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

238

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

239

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

240

{

241

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

242

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

243

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

244

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

245

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

246

},

247

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

248

},

249

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

250

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

251

},

252

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

253

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

254

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

255

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

256

},

257

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

258

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

259

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

260

},

261

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

262

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

263

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

264

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

265

},

266

],

267

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

268

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

269

},

270

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

271

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

272

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

273

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

274

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

275

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

276

},

277

],

278

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

279

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

280

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

281

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

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

286

<pre>Retrieves the next page of results.

287

288

Args:

289

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

290

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

291

292

Returns:

Bu Sun Kim

6502091

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

[diff] [blame]

293

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

Sai Cheemalapati