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

Dan O'Meara

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

[diff] [blame]

78

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

79

Sai Cheemalapati

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

[diff] [blame]

80

Bu Sun Kim

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

[diff] [blame]

81

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

Dan O'Meara

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

[diff] [blame]

82

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

Sai Cheemalapati

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

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

89

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

Sai Cheemalapati

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

[diff] [blame]

90

91

Args:

Dan O'Meara

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

[diff] [blame]

92

blogId: string, A parameter (required)

93

postId: string, A parameter (required)

94

x__xgafv: string, V1 error format.

95

Allowed values

96

1 - v1 error format

97

2 - v2 error format

Sai Cheemalapati

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

[diff] [blame]

98

99

Returns:

100

An object of the form:

101

102

{

Bu Sun Kim

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

[diff] [blame^]

103

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

104

"A String",

105

],

Bu Sun Kim

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

[diff] [blame]

106

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

Bu Sun Kim

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

[diff] [blame^]

107

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

Bu Sun Kim

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

[diff] [blame]

108

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

109

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

Dan O'Meara

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

[diff] [blame]

110

{

Bu Sun Kim

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

[diff] [blame]

111

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

Bu Sun Kim

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

[diff] [blame^]

112

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

Bu Sun Kim

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

[diff] [blame]

113

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

114

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

Dan O'Meara

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

[diff] [blame]

115

},

Bu Sun Kim

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

[diff] [blame]

116

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

Bu Sun Kim

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

[diff] [blame^]

117

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

Dan O'Meara

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

[diff] [blame]

118

},

Bu Sun Kim

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

[diff] [blame]

119

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

120

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

Dan O'Meara

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

[diff] [blame]

121

},

Bu Sun Kim

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

[diff] [blame^]

122

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

123

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

124

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

125

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

126

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

127

},

128

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

129

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

130

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

131

},

132

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

133

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

134

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

Dan O'Meara

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

[diff] [blame]

135

},

136

],

Bu Sun Kim

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

[diff] [blame]

137

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

Bu Sun Kim

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

[diff] [blame]

138

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

Dan O'Meara

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

[diff] [blame]

139

},

Bu Sun Kim

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

[diff] [blame^]

140

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

141

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

142

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

143

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

144

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

145

},

Bu Sun Kim

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

[diff] [blame]

146

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

Bu Sun Kim

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

[diff] [blame^]

147

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

148

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

Bu Sun Kim

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

[diff] [blame]

149

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

150

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

151

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

152

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

153

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

154

},

155

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

156

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

157

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

158

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

159

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

160

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

161

},

162

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

163

},

164

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

Bu Sun Kim

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

[diff] [blame]

165

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

Dan O'Meara

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

[diff] [blame]

166

{

Bu Sun Kim

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

[diff] [blame]

167

"url": "A String",

Dan O'Meara

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

[diff] [blame]

168

},

169

],

Bu Sun Kim

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

[diff] [blame^]

170

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

171

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

172

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

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

177

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

Dan O'Meara

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

[diff] [blame]

178

<pre>Lists posts.

Sai Cheemalapati

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

[diff] [blame]

179

180

Args:

Dan O'Meara

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

[diff] [blame]

181

blogId: string, A parameter (required)

Dan O'Meara

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

[diff] [blame]

182

maxResults: integer, A parameter

183

pageToken: string, A parameter

Bu Sun Kim

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

[diff] [blame]

184

startDate: string, A parameter

185

fetchBodies: boolean, A parameter

Dan O'Meara

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

[diff] [blame]

186

x__xgafv: string, V1 error format.

187

Allowed values

188

1 - v1 error format

189

2 - v2 error format

Sai Cheemalapati

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

[diff] [blame]

190

191

Returns:

192

An object of the form:

193

194

{

Bu Sun Kim

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

[diff] [blame^]

195

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

196

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

Bu Sun Kim

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

[diff] [blame^]

197

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

Bu Sun Kim

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

[diff] [blame]

198

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

Sai Cheemalapati

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

[diff] [blame]

199

{

Bu Sun Kim

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

[diff] [blame^]

200

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

201

"A String",

202

],

Bu Sun Kim

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

[diff] [blame]

203

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

Bu Sun Kim

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

[diff] [blame^]

204

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

Bu Sun Kim

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

[diff] [blame]

205

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

206

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

Dan O'Meara

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

[diff] [blame]

207

{

Bu Sun Kim

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

[diff] [blame]

208

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

Bu Sun Kim

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

[diff] [blame^]

209

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

Bu Sun Kim

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

[diff] [blame]

210

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

211

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

Dan O'Meara

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

[diff] [blame]

212

},

Bu Sun Kim

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

[diff] [blame]

213

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

Bu Sun Kim

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

[diff] [blame^]

214

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

Dan O'Meara

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

[diff] [blame]

215

},

Bu Sun Kim

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

[diff] [blame]

216

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

217

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

Dan O'Meara

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

[diff] [blame]

218

},

Bu Sun Kim

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

[diff] [blame^]

219

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

220

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

221

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

222

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

223

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

224

},

225

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

226

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

227

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

228

},

229

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

230

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

231

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

Dan O'Meara

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

[diff] [blame]

232

},

233

],

Bu Sun Kim

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

[diff] [blame]

234

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

Bu Sun Kim

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

[diff] [blame]

235

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

Dan O'Meara

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

[diff] [blame]

236

},

Bu Sun Kim

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

[diff] [blame^]

237

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

238

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

239

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

240

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

241

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

242

},

Bu Sun Kim

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

[diff] [blame]

243

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

Bu Sun Kim

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

[diff] [blame^]

244

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

245

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

Bu Sun Kim

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

[diff] [blame]

246

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

247

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

248

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

249

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

250

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

251

},

252

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

253

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

254

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

255

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

256

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

257

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

258

},

259

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

260

},

261

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

Bu Sun Kim

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

[diff] [blame]

262

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

Dan O'Meara

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

[diff] [blame]

263

{

Bu Sun Kim

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

[diff] [blame]

264

"url": "A String",

Dan O'Meara

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

[diff] [blame]

265

},

266

],

Bu Sun Kim

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

[diff] [blame^]

267

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

268

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

269

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

Sai Cheemalapati

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

[diff] [blame]

270

},

271

],

Bu Sun Kim

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

[diff] [blame]

272

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

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>

278

<pre>Retrieves the next page of results.

279

280

Args:

281

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

282

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

283

284

Returns:

Bu Sun Kim

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

[diff] [blame]

285

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

Sai Cheemalapati