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-20 12:08:20 -0700

[diff] [blame^]

81

<code><a href="#list">list(blogId, fetchBodies=None, startDate=None, maxResults=None, pageToken=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-05-20 12:08:20 -0700

[diff] [blame^]

103

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

104

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

105

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

106

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

107

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

108

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

Dan O'Meara

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

[diff] [blame]

109

{

Bu Sun Kim

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

[diff] [blame^]

110

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

111

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

112

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

113

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

114

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

115

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

116

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

Dan O'Meara

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

[diff] [blame]

117

},

Bu Sun Kim

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

[diff] [blame^]

118

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

119

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

120

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

121

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

122

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

Dan O'Meara

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

[diff] [blame]

123

},

Bu Sun Kim

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

[diff] [blame^]

124

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

125

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

Dan O'Meara

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

[diff] [blame]

126

},

Bu Sun Kim

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

[diff] [blame^]

127

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

128

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

129

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

Dan O'Meara

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

[diff] [blame]

130

},

Bu Sun Kim

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

[diff] [blame^]

131

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

132

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

Dan O'Meara

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

[diff] [blame]

133

},

Dan O'Meara

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

[diff] [blame]

134

},

135

],

Bu Sun Kim

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

[diff] [blame^]

136

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

137

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

Dan O'Meara

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

[diff] [blame]

138

},

Bu Sun Kim

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

[diff] [blame^]

139

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

140

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

141

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

142

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

143

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

144

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

145

},

Dan O'Meara

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

[diff] [blame]

146

},

Bu Sun Kim

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

[diff] [blame^]

147

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

148

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

149

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

150

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

151

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

152

},

153

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

154

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

155

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

156

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

157

"A String",

158

],

159

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

160

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

161

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

162

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

163

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

Dan O'Meara

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

[diff] [blame]

164

{

Bu Sun Kim

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

[diff] [blame^]

165

"url": "A String",

Dan O'Meara

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

[diff] [blame]

166

},

167

],

Bu Sun Kim

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

[diff] [blame^]

168

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

169

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

170

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

171

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

172

},

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame^]

177

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

Bu Sun Kim

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

[diff] [blame^]

182

fetchBodies: boolean, A parameter

Dan O'Meara

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

[diff] [blame]

183

startDate: string, A parameter

184

maxResults: integer, A parameter

185

pageToken: string, A parameter

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-05-20 12:08:20 -0700

[diff] [blame^]

195

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

196

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

197

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

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-05-20 12:08:20 -0700

[diff] [blame^]

200

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

201

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

202

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

203

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

204

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

205

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

Dan O'Meara

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

[diff] [blame]

206

{

Bu Sun Kim

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

[diff] [blame^]

207

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

208

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

209

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

210

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

211

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

212

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

213

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

Dan O'Meara

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

[diff] [blame]

214

},

Bu Sun Kim

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

[diff] [blame^]

215

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

216

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

217

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

218

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

219

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

Dan O'Meara

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

[diff] [blame]

220

},

Bu Sun Kim

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

[diff] [blame^]

221

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

222

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

Dan O'Meara

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

[diff] [blame]

223

},

Bu Sun Kim

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

[diff] [blame^]

224

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

225

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

226

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

Dan O'Meara

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

[diff] [blame]

227

},

Bu Sun Kim

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

[diff] [blame^]

228

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

229

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

Dan O'Meara

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

[diff] [blame]

230

},

Dan O'Meara

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

[diff] [blame]

231

},

232

],

Bu Sun Kim

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

[diff] [blame^]

233

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

234

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

Dan O'Meara

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

[diff] [blame]

235

},

Bu Sun Kim

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

[diff] [blame^]

236

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

237

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

238

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

239

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

240

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

241

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

242

},

Dan O'Meara

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

[diff] [blame]

243

},

Bu Sun Kim

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

[diff] [blame^]

244

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

245

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

246

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

247

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

248

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

249

},

250

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

251

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

252

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

253

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

254

"A String",

255

],

256

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

257

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

258

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

259

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

260

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

Dan O'Meara

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

[diff] [blame]

261

{

Bu Sun Kim

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

[diff] [blame^]

262

"url": "A String",

Dan O'Meara

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

[diff] [blame]

263

},

264

],

Bu Sun Kim

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

[diff] [blame^]

265

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

266

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

267

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

268

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

269

},

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