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

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

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

[diff] [blame]

84

<code><a href="#list">list(blogId, startDate=None, pageToken=None, fetchBodies=None, maxResults=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

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

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

[diff] [blame]

111

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

Yoshi Automation Bot

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

[diff] [blame]

112

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

Yoshi Automation Bot

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

[diff] [blame]

113

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

Yoshi Automation Bot

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

[diff] [blame]

114

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

Bu Sun Kim

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

[diff] [blame]

115

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

116

"A String",

117

],

Yoshi Automation Bot

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

[diff] [blame]

118

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

119

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

120

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

121

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

122

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

123

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

124

},

Bu Sun Kim

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

[diff] [blame]

125

},

Yoshi Automation Bot

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

[diff] [blame]

126

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

Dmitry Frenkel

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

[diff] [blame]

127

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

Dmitry Frenkel

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

[diff] [blame]

128

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

Yoshi Automation Bot

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

[diff] [blame]

129

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

Bu Sun Kim

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

[diff] [blame]

130

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

Dmitry Frenkel

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

[diff] [blame]

131

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

132

},

Yoshi Automation Bot

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

[diff] [blame]

133

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

134

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

Yoshi Automation Bot

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

[diff] [blame]

135

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

Yoshi Automation Bot

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

[diff] [blame]

136

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

137

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

138

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

139

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

140

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

141

},

142

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

143

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

144

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

145

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

146

{

147

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

148

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

149

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

150

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

151

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

152

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

153

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

154

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

155

},

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

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

160

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

161

},

162

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

163

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

164

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

165

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

166

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

167

},

168

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

169

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

},

},

],

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

174

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

175

},

176

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

{

"url": "A String",

},

],

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

Yoshi Automation Bot

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

[diff] [blame]

185

<code class="details" id="list">list(blogId, startDate=None, pageToken=None, fetchBodies=None, maxResults=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

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

[diff] [blame]

190

startDate: string, A parameter

191

pageToken: string, A parameter

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

192

fetchBodies: boolean, A parameter

Dmitry Frenkel

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

[diff] [blame]

193

maxResults: integer, 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

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

[diff] [blame]

203

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

Bu Sun Kim

6502091

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

[diff] [blame]

204

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

Sai Cheemalapati

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

[diff] [blame]

205

{

Yoshi Automation Bot

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

[diff] [blame]

206

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

Yoshi Automation Bot

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

[diff] [blame]

207

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

Yoshi Automation Bot

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

[diff] [blame]

208

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

Yoshi Automation Bot

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

[diff] [blame]

209

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

Bu Sun Kim

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

[diff] [blame]

210

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

211

"A String",

212

],

Yoshi Automation Bot

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

[diff] [blame]

213

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

214

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

215

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

216

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

217

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

218

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

219

},

Bu Sun Kim

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

[diff] [blame]

220

},

Yoshi Automation Bot

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

[diff] [blame]

221

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

Dmitry Frenkel

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

[diff] [blame]

222

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

Dmitry Frenkel

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

[diff] [blame]

223

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

Yoshi Automation Bot

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

[diff] [blame]

224

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

Bu Sun Kim

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

[diff] [blame]

225

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

Dmitry Frenkel

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

[diff] [blame]

226

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

227

},

Yoshi Automation Bot

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

[diff] [blame]

228

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

229

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

Yoshi Automation Bot

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

[diff] [blame]

230

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

Yoshi Automation Bot

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

[diff] [blame]

231

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

232

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

233

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

234

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

235

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

236

},

237

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

238

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

239

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

240

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

241

{

242

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

243

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

244

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

245

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

246

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

247

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

248

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

249

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

250

},

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

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

255

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

256

},

257

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

258

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

259

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

260

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

261

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

262

},

263

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

264

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

},

},

],

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

269

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

270

},

271

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

{

"url": "A String",

},

],

Sai Cheemalapati

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

[diff] [blame]

276

},

277

],

Yoshi Automation Bot

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

[diff] [blame]

278

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

279

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

Bu Sun Kim

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

[diff] [blame]

280

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

Sai Cheemalapati

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

[diff] [blame]

}</pre>

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