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

3e17f89

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

3e17f89

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

{

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

107

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

108

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

109

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

110

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

111

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

112

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

113

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

114

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

115

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

116

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

117

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

118

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

119

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

120

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

121

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

122

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

123

},

Bu Sun Kim

6502091

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

[diff] [blame]

124

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

125

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

Bu Sun Kim

6502091

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

[diff] [blame]

126

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

Dan O'Meara

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

[diff] [blame]

127

{

Bu Sun Kim

673ec5c

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

[diff] [blame]

128

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

129

"A String",

130

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

131

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

132

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

133

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

134

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

{

"url": "A String",

},

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

139

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

140

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

141

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

142

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

143

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

144

},

145

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

146

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

147

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

148

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

149

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

150

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

151

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

152

},

153

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

154

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

155

},

156

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

157

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

158

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

159

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

160

{

161

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

162

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

163

},

164

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

165

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

166

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

167

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

168

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

169

},

170

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

171

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

172

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

173

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

174

},

175

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

176

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

177

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

178

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

179

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

180

},

181

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

182

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

183

},

184

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

185

},

186

],

187

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

188

},

189

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

190

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

191

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

192

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

193

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

194

},

195

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

196

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

197

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

Dan O'Meara

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

[diff] [blame]

198

},

199

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

200

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

201

},

202

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

203

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

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

{

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

222

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

Bu Sun Kim

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

[diff] [blame]

223

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

224

{

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

225

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

226

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

227

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

228

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

229

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

230

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

231

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

232

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

233

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

234

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

235

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

236

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

237

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

238

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

239

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

240

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

241

},

Bu Sun Kim

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

[diff] [blame]

242

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

243

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

Bu Sun Kim

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

[diff] [blame]

244

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

245

{

Bu Sun Kim

673ec5c

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

[diff] [blame]

246

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

247

"A String",

248

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

249

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

250

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

251

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

252

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

{

"url": "A String",

},

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

257

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

258

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

259

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

260

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

261

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

262

},

263

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

264

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

265

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

266

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

267

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

268

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

269

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

270

},

271

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

272

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

273

},

274

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

275

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

276

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

277

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

278

{

279

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

280

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

281

},

282

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

283

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

284

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

285

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

286

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

287

},

288

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

289

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

290

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

291

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

292

},

293

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

294

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

295

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

296

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

297

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

298

},

299

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

300

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

301

},

302

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

303

},

304

],

305

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

306

},

307

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

308

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

309

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

310

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

311

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

312

},

313

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

314

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

315

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

Bu Sun Kim

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

[diff] [blame]

316

},

317

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

318

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

319

},

320

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

321

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

Bu Sun Kim

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

[diff] [blame]

322

},

323

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

324

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

325

{

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

326

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

327

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

328

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

329

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

330

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

331

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

332

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

333

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

334

"blog": { # The Blog resource.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

335

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

336

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

337

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

338

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

339

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

340

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

341

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

342

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

343

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

344

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

345

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

346

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

347

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

348

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

349

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

350

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

351

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

352

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

353

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

354

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

355

{

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

356

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

357

"A String",

358

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

359

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

360

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

361

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

362

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

{

"url": "A String",

},

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

367

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

368

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

369

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

370

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

371

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

372

},

373

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

374

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

375

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

376

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

377

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

378

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

379

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

380

},

381

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

382

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

383

},

384

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

385

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

386

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

387

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

388

{

389

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

390

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

391

},

392

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

393

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

394

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

395

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

396

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

397

},

398

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

399

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

400

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

401

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

402

},

403

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

404

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

405

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

406

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

407

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

408

},

409

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

410

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

411

},

412

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

413

},

414

],

415

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

416

},

417

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

418

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

419

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

420

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

421

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

422

},

423

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

424

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

425

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

426

},

427

],

428

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

429

},

430

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

431

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

432

},

433

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

434

},

435

],

Sai Cheemalapati