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

Dmitry Frenkel

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

[diff] [blame]

84

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

{

Bu Sun Kim

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

[diff] [blame]

111

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

112

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

Dmitry Frenkel

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

[diff] [blame]

113

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

Bu Sun Kim

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

[diff] [blame]

114

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

115

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

116

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

117

},

Bu Sun Kim

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

[diff] [blame]

118

},

Dmitry Frenkel

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

[diff] [blame]

119

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

Bu Sun Kim

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

[diff] [blame]

120

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

Dan O'Meara

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

[diff] [blame]

121

{

Bu Sun Kim

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

[diff] [blame]

122

"url": "A String",

Dan O'Meara

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

[diff] [blame]

123

},

124

],

Dmitry Frenkel

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

[diff] [blame]

125

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

126

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

127

"A String",

128

],

129

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

130

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

131

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

Dmitry Frenkel

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

[diff] [blame]

132

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

133

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

134

},

135

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

136

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

137

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

138

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

139

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

140

},

Bu Sun Kim

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

[diff] [blame]

141

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

Dmitry Frenkel

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

[diff] [blame]

142

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

143

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

144

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

145

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

146

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

147

{

148

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

149

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

150

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

151

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

152

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

153

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

154

},

155

},

156

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

157

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

158

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

159

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

160

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

161

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

162

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

163

},

164

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

165

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

166

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

167

},

168

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

169

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

170

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

},

},

],

},

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

176

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

Bu Sun Kim

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

[diff] [blame]

177

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

Dmitry Frenkel

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

[diff] [blame]

178

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

179

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

180

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

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

Dmitry Frenkel

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

[diff] [blame]

185

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

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

190

startDate: string, A parameter

191

fetchBodies: boolean, A parameter

Dmitry Frenkel

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

[diff] [blame]

192

pageToken: string, A parameter

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

{

Dmitry Frenkel

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

[diff] [blame]

203

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

204

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

Dmitry Frenkel

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

[diff] [blame]

205

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

Bu Sun Kim

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

[diff] [blame]

206

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

Sai Cheemalapati

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

[diff] [blame]

207

{

Bu Sun Kim

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

[diff] [blame]

208

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

209

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

Dmitry Frenkel

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

[diff] [blame]

210

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

Bu Sun Kim

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

[diff] [blame]

211

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

212

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

213

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

214

},

Bu Sun Kim

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

[diff] [blame]

215

},

Dmitry Frenkel

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

[diff] [blame]

216

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

Bu Sun Kim

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

[diff] [blame]

217

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

Dan O'Meara

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

[diff] [blame]

218

{

Bu Sun Kim

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

[diff] [blame]

219

"url": "A String",

Dan O'Meara

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

[diff] [blame]

220

},

221

],

Dmitry Frenkel

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

[diff] [blame]

222

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

223

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

224

"A String",

225

],

226

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

227

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

228

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

Dmitry Frenkel

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

[diff] [blame]

229

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

230

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

231

},

232

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

233

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

234

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

235

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

236

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

237

},

Bu Sun Kim

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

[diff] [blame]

238

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

Dmitry Frenkel

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

[diff] [blame]

239

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

240

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

241

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

242

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

243

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

244

{

245

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

246

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

247

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

248

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

249

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

250

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

251

},

252

},

253

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

254

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

255

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

256

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

257

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

258

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

259

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

260

},

261

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

262

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

263

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

264

},

265

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

266

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

267

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

},

},

],

},

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

273

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

Bu Sun Kim

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

[diff] [blame]

274

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

Dmitry Frenkel

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

[diff] [blame]

275

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

276

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

277

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

Sai Cheemalapati

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

[diff] [blame]

278

},

279

],

Dmitry Frenkel

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

[diff] [blame]

280

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

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

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