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

[diff] [blame^]

103

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

104

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

105

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

Bu Sun Kim

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

[diff] [blame]

106

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

Bu Sun Kim

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

[diff] [blame^]

107

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

108

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

109

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

110

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

Bu Sun Kim

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

[diff] [blame]

111

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

112

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

Dan O'Meara

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

[diff] [blame]

113

{

Bu Sun Kim

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

[diff] [blame]

114

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

Bu Sun Kim

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

[diff] [blame]

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

[diff] [blame^]

118

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

119

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

120

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

121

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

122

},

123

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

124

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

125

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

Bu Sun Kim

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

[diff] [blame]

126

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

127

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

Bu Sun Kim

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

[diff] [blame^]

128

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

Bu Sun Kim

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

[diff] [blame]

129

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

130

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

Dan O'Meara

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

[diff] [blame]

131

},

Bu Sun Kim

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

[diff] [blame]

132

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

Bu Sun Kim

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

[diff] [blame^]

133

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

Dan O'Meara

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

[diff] [blame]

134

},

Bu Sun Kim

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

[diff] [blame]

135

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

136

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

Dan O'Meara

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

[diff] [blame]

137

},

Dan O'Meara

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

[diff] [blame]

138

},

139

],

Bu Sun Kim

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

[diff] [blame]

140

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

Bu Sun Kim

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

[diff] [blame^]

141

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

Dan O'Meara

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

[diff] [blame]

142

},

Bu Sun Kim

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

[diff] [blame^]

143

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

Bu Sun Kim

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

[diff] [blame]

144

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

Bu Sun Kim

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

[diff] [blame]

145

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

146

"A String",

147

],

Bu Sun Kim

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

[diff] [blame]

148

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

Dan O'Meara

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

[diff] [blame]

149

{

Bu Sun Kim

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

[diff] [blame]

150

"url": "A String",

Dan O'Meara

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

[diff] [blame]

151

},

152

],

Bu Sun Kim

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

[diff] [blame^]

153

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

154

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

155

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

156

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

157

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

158

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

159

},

160

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

161

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

162

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

163

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

164

},

165

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

166

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

167

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

168

},

Bu Sun Kim

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

[diff] [blame]

169

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

170

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

171

},

Bu Sun Kim

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

[diff] [blame^]

172

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

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

[diff] [blame]

195

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

Bu Sun Kim

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

[diff] [blame]

196

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

Sai Cheemalapati

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

[diff] [blame]

197

{

Bu Sun Kim

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

[diff] [blame^]

198

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

199

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

200

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

Bu Sun Kim

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

[diff] [blame]

201

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

Bu Sun Kim

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

[diff] [blame^]

202

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

203

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

204

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

205

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

Bu Sun Kim

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

[diff] [blame]

206

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

207

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

Dan O'Meara

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

[diff] [blame]

208

{

Bu Sun Kim

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

[diff] [blame]

209

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

Bu Sun Kim

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

[diff] [blame]

210

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

211

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

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

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

214

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

215

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

216

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

217

},

218

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

219

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

220

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

Bu Sun Kim

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

[diff] [blame]

221

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

222

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

Bu Sun Kim

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

[diff] [blame^]

223

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

Bu Sun Kim

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

[diff] [blame]

224

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

225

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

Dan O'Meara

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

[diff] [blame]

226

},

Bu Sun Kim

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

[diff] [blame]

227

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

Bu Sun Kim

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

[diff] [blame^]

228

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

Dan O'Meara

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

[diff] [blame]

229

},

Bu Sun Kim

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

[diff] [blame]

230

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

231

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

Dan O'Meara

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

[diff] [blame]

232

},

Dan O'Meara

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

[diff] [blame]

233

},

234

],

Bu Sun Kim

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

[diff] [blame]

235

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

Bu Sun Kim

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

[diff] [blame^]

236

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

Dan O'Meara

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

[diff] [blame]

237

},

Bu Sun Kim

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

[diff] [blame^]

238

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

Bu Sun Kim

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

[diff] [blame]

239

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

Bu Sun Kim

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

[diff] [blame]

240

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

241

"A String",

242

],

Bu Sun Kim

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

[diff] [blame]

243

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

Dan O'Meara

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

[diff] [blame]

244

{

Bu Sun Kim

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

[diff] [blame]

245

"url": "A String",

Dan O'Meara

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

[diff] [blame]

246

},

247

],

Bu Sun Kim

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

[diff] [blame^]

248

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

249

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

250

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

251

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

252

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

253

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

254

},

255

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

256

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

257

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

258

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

259

},

260

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

261

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

262

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

263

},

Bu Sun Kim

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

[diff] [blame]

264

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

265

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

266

},

Bu Sun Kim

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

[diff] [blame^]

267

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

Sai Cheemalapati

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

[diff] [blame]

268

},

269

],

Bu Sun Kim

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

[diff] [blame^]

270

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

271

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

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