Blame - docs/dyn/blogger_v2.blogs.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.blogs.html">blogs</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, x__xgafv=None)</a></code></p>

82

83

84

<code><a href="#list">list(userId, x__xgafv=None)</a></code></p>

85

<p class="firstline">Lists blogs by user id, possibly filtered.</p>

Sai Cheemalapati

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

[diff] [blame]

86

<h3>Method Details</h3>

87

Dmitry Frenkel

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

[diff] [blame]

88

<code class="details" id="close">close()</code>

89

<pre>Close httplib2 connections.</pre>

</div>

Dan O'Meara

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

[diff] [blame]

93

<code class="details" id="get">get(blogId, x__xgafv=None)</code>

94

<pre>Gets a blog by id.

Sai Cheemalapati

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

[diff] [blame]

95

96

Args:

Dan O'Meara

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

[diff] [blame]

97

blogId: string, A parameter (required)

98

x__xgafv: string, V1 error format.

99

Allowed values

100

1 - v1 error format

101

2 - v2 error format

Sai Cheemalapati

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

[diff] [blame]

102

103

Returns:

104

An object of the form:

105

106

{

Dmitry Frenkel

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

[diff] [blame]

107

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

Dmitry Frenkel

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

[diff] [blame]

108

"locale": { # The locale this Blog is set to.

109

"country": "A String", # The country this blog's locale is set to.

110

"variant": "A String", # The language variant this blog is authored in.

111

"language": "A String", # The language this blog is authored in.

112

},

Dmitry Frenkel

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

[diff] [blame]

113

"description": "A String", # The description of this blog. This is displayed underneath the title.

114

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

Bu Sun Kim

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

[diff] [blame^]

115

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

Dmitry Frenkel

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

[diff] [blame]

116

"status": "A String", # The status of the blog.

Bu Sun Kim

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

[diff] [blame^]

117

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

Bu Sun Kim

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

[diff] [blame]

118

"posts": { # The container of posts in this blog.

119

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

Dan O'Meara

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

[diff] [blame]

120

{

Bu Sun Kim

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

[diff] [blame^]

121

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

122

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

123

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

124

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

125

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

126

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

127

},

128

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

129

"A String",

130

],

131

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

132

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

133

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

134

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

135

{

136

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

137

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

138

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

139

},

140

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

141

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

142

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

143

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

144

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

145

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

146

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

147

},

148

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

149

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

150

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

151

},

152

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

153

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

154

},

155

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

156

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

157

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

158

},

159

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

},

],

},

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

164

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

165

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

{

"url": "A String",

},

],

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

171

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

172

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

173

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

174

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

175

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

176

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

Bu Sun Kim

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

[diff] [blame]

177

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

178

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

Dmitry Frenkel

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

[diff] [blame]

179

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

Bu Sun Kim

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

[diff] [blame]

180

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

181

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

182

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

183

},

Bu Sun Kim

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

[diff] [blame]

184

},

Dmitry Frenkel

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

[diff] [blame]

185

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

Dmitry Frenkel

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

[diff] [blame]

186

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

Bu Sun Kim

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

[diff] [blame^]

187

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

Dmitry Frenkel

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

[diff] [blame]

188

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

Bu Sun Kim

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

[diff] [blame^]

189

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

Dmitry Frenkel

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

[diff] [blame]

190

},

Dan O'Meara

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

[diff] [blame]

191

},

192

],

Dmitry Frenkel

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

[diff] [blame]

193

"selfLink": "A String", # The URL of the container for posts in this blog.

Bu Sun Kim

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

[diff] [blame^]

194

"totalItems": 42, # The count of posts in this blog.

Sai Cheemalapati

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

[diff] [blame]

195

},

Bu Sun Kim

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

[diff] [blame^]

196

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

197

"pages": { # The container of pages in this blog.

198

"totalItems": 42, # The count of pages in this blog.

199

"selfLink": "A String", # The URL of the container for pages in this blog.

200

},

201

"name": "A String", # The name of this blog. This is displayed as the title.

202

"url": "A String", # The URL where this blog is published.

203

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

Dan O'Meara

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

[diff] [blame]

}</pre>

</div>

<code class="details" id="list">list(userId, x__xgafv=None)</code>

209

<pre>Lists blogs by user id, possibly filtered.

210

211

Args:

212

userId: string, A parameter (required)

213

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

220

221

{

Bu Sun Kim

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

[diff] [blame]

222

"blogUserInfos": [ # Admin level list of blog per-user information.

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

"blog": { # The Blog resource.

Dmitry Frenkel

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

[diff] [blame]

225

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

Dmitry Frenkel

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

[diff] [blame]

226

"locale": { # The locale this Blog is set to.

227

"country": "A String", # The country this blog's locale is set to.

228

"variant": "A String", # The language variant this blog is authored in.

229

"language": "A String", # The language this blog is authored in.

230

},

Dmitry Frenkel

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

[diff] [blame]

231

"description": "A String", # The description of this blog. This is displayed underneath the title.

232

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

Bu Sun Kim

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

[diff] [blame^]

233

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

Dmitry Frenkel

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

[diff] [blame]

234

"status": "A String", # The status of the blog.

Bu Sun Kim

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

[diff] [blame^]

235

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

Bu Sun Kim

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

[diff] [blame]

236

"posts": { # The container of posts in this blog.

237

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

Dan O'Meara

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

[diff] [blame]

238

{

Bu Sun Kim

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

[diff] [blame^]

239

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

240

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

241

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

242

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

243

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

244

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

245

},

246

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

247

"A String",

248

],

249

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

250

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

251

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

252

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

253

{

254

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

255

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

256

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

257

},

258

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

259

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

260

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

261

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

262

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

263

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

264

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

265

},

266

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

267

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

268

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

269

},

270

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

271

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

272

},

273

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

274

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

275

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

276

},

277

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

},

],

},

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

282

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

283

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

{

"url": "A String",

},

],

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

289

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

290

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

291

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

292

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

293

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

294

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

Bu Sun Kim

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

[diff] [blame]

295

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

296

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

Dmitry Frenkel

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

[diff] [blame]

297

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

Bu Sun Kim

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

[diff] [blame]

298

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

299

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

300

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

301

},

Bu Sun Kim

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

[diff] [blame]

302

},

Dmitry Frenkel

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

[diff] [blame]

303

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

Dmitry Frenkel

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

[diff] [blame]

304

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

Bu Sun Kim

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

[diff] [blame^]

305

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

Dmitry Frenkel

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

[diff] [blame]

306

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

Bu Sun Kim

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

[diff] [blame^]

307

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

Dmitry Frenkel

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

[diff] [blame]

308

},

Dan O'Meara

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

[diff] [blame]

309

},

310

],

Dmitry Frenkel

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

[diff] [blame]

311

"selfLink": "A String", # The URL of the container for posts in this blog.

Bu Sun Kim

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

[diff] [blame^]

312

"totalItems": 42, # The count of posts in this blog.

Dan O'Meara

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

[diff] [blame]

313

},

Bu Sun Kim

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

[diff] [blame^]

314

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

315

"pages": { # The container of pages in this blog.

316

"totalItems": 42, # The count of pages in this blog.

317

"selfLink": "A String", # The URL of the container for pages in this blog.

318

},

319

"name": "A String", # The name of this blog. This is displayed as the title.

320

"url": "A String", # The URL where this blog is published.

321

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

Dan O'Meara

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

[diff] [blame]

322

},

Dmitry Frenkel

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

[diff] [blame]

323

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

Bu Sun Kim

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

[diff] [blame^]

324

"blog_user_info": { # Information about a User for the Blog.

325

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

326

"userId": "A String", # ID of the User.

327

"blogId": "A String", # ID of the Blog resource.

328

"photosAlbumKey": "A String", # The Photo Album Key for the user when adding photos to the blog.

329

"role": "A String", # Access permissions that the user has for the blog (ADMIN, AUTHOR, or READER).

330

"hasAdminAccess": True or False, # True if the user has Admin level access to the blog.

331

},

Dan O'Meara

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

[diff] [blame]

332

},

333

],

Bu Sun Kim

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

[diff] [blame^]

334

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

Bu Sun Kim

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

[diff] [blame]

335

"items": [ # The list of Blogs this user has Authorship or Admin rights over.

336

{

Dmitry Frenkel

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

[diff] [blame]

337

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

Dmitry Frenkel

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

[diff] [blame]

338

"locale": { # The locale this Blog is set to.

339

"country": "A String", # The country this blog's locale is set to.

340

"variant": "A String", # The language variant this blog is authored in.

341

"language": "A String", # The language this blog is authored in.

342

},

Dmitry Frenkel

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

[diff] [blame]

343

"description": "A String", # The description of this blog. This is displayed underneath the title.

344

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

Bu Sun Kim

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

[diff] [blame^]

345

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

Dmitry Frenkel

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

[diff] [blame]

346

"status": "A String", # The status of the blog.

Bu Sun Kim

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

[diff] [blame^]

347

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

Bu Sun Kim

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

[diff] [blame]

348

"posts": { # The container of posts in this blog.

349

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

350

{

Bu Sun Kim

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

[diff] [blame^]

351

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

352

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

353

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

354

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

355

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

356

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

357

},

358

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

359

"A String",

360

],

361

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

362

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

363

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

364

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

365

{

366

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

367

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

368

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

369

},

370

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

371

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

372

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

373

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

374

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

375

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

376

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

377

},

378

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

379

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

380

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

381

},

382

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

383

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

384

},

385

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

386

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

387

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

388

},

389

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

},

],

},

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

394

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

395

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

{

"url": "A String",

},

],

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

401

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

402

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

403

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

404

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

405

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

406

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

Bu Sun Kim

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

[diff] [blame]

407

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

408

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

Dmitry Frenkel

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

[diff] [blame]

409

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

Bu Sun Kim

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

[diff] [blame]

410

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

411

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

412

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

413

},

Bu Sun Kim

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

[diff] [blame]

414

},

Dmitry Frenkel

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

[diff] [blame]

415

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

Dmitry Frenkel

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

[diff] [blame]

416

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

Bu Sun Kim

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

[diff] [blame^]

417

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

Dmitry Frenkel

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

[diff] [blame]

418

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

Bu Sun Kim

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

[diff] [blame^]

419

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

Dmitry Frenkel

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

[diff] [blame]

420

},

Bu Sun Kim

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

[diff] [blame]

421

},

422

],

Dmitry Frenkel

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

[diff] [blame]

423

"selfLink": "A String", # The URL of the container for posts in this blog.

Bu Sun Kim

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

[diff] [blame^]

424

"totalItems": 42, # The count of posts in this blog.

Bu Sun Kim

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

[diff] [blame]

425

},

Bu Sun Kim

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

[diff] [blame^]

426

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

427

"pages": { # The container of pages in this blog.

428

"totalItems": 42, # The count of pages in this blog.

429

"selfLink": "A String", # The URL of the container for pages in this blog.

430

},

431

"name": "A String", # The name of this blog. This is displayed as the title.

432

"url": "A String", # The URL where this blog is published.

433

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

Bu Sun Kim

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

[diff] [blame]

434

},

435

],

Sai Cheemalapati