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

2021-01-15 07:10:04 -0800

[diff] [blame^]

107

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

108

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

109

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

110

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

111

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

112

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

113

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

114

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

115

},

116

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

117

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

118

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

119

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

120

},

121

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

122

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

123

{

124

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

125

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

126

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

127

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

128

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

129

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

130

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

Dan O'Meara

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

[diff] [blame]

131

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

132

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

133

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

134

},

135

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

136

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

137

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

138

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

139

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

{

"url": "A String",

},

],

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

145

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

146

"A String",

147

],

148

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

149

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

150

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

151

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

152

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

153

},

154

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

155

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

156

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

157

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

158

{

159

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

160

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

161

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

162

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

163

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

164

},

165

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

166

},

167

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

168

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

169

},

170

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

171

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

172

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

173

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

174

},

175

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

176

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

177

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

178

},

179

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

180

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

181

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

182

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

183

},

184

],

185

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

186

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

187

},

188

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

189

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

190

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

191

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

192

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

193

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

194

},

195

],

196

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

197

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

198

},

199

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

200

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

201

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

202

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

203

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

204

}</pre>

Dan O'Meara

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

[diff] [blame]

</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

2021-01-15 07:10:04 -0800

[diff] [blame^]

222

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

223

{

224

"blog": { # The Blog resource.

225

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

226

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

227

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

228

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

229

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

230

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

231

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

232

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

Yoshi Automation Bot

0d561ef

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

[diff] [blame]

233

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

234

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

235

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

236

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

237

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

238

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

239

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

240

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

241

{

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

242

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

243

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

244

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

245

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

246

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

247

},

248

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

249

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

250

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

251

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

252

},

253

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

254

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

255

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

256

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

257

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

{

"url": "A String",

},

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

262

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

263

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

264

"A String",

265

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

266

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

267

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

268

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

269

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

270

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

271

},

272

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

273

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

274

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

275

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

276

{

277

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

278

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

279

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

280

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

281

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

282

},

283

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

284

},

285

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

286

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

287

},

288

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

289

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

290

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

291

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

292

},

293

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

294

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

295

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

296

},

297

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

298

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

299

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

300

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

301

},

302

],

303

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

304

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

305

},

306

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

307

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

308

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

309

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

310

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

311

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

312

},

313

],

314

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

315

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

316

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

317

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

318

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

319

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

320

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

321

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

322

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

323

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

324

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

325

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

326

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

327

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

328

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

329

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

330

},

331

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

332

},

333

],

334

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

335

{

336

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

337

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

338

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

339

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

340

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

341

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

342

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

343

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

344

},

345

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

346

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

347

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

348

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

349

},

350

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

351

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

352

{

353

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

354

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

355

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

356

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

357

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

358

},

359

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

360

},

361

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

362

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

363

},

364

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

365

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

366

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

367

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

368

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

{

"url": "A String",

},

],

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

374

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

375

"A String",

376

],

377

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

378

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

379

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

380

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

381

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

382

},

383

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

384

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

385

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

386

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

387

{

388

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

389

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

390

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

391

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

392

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

393

},

394

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

395

},

396

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

397

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

398

},

399

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

400

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

401

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

402

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

403

},

404

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

405

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

406

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

407

},

408

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

409

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

410

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

411

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

412

},

413

],

414

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

415

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

416

},

417

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

418

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

419

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

420

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

421

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

422

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

423

},

424

],

425

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

426

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

427

},

428

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

429

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

430

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

431

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

432

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

433

},

434

],

435

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

436

}</pre>

Sai Cheemalapati