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

{

Bu Sun Kim

6502091

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

[diff] [blame]

107

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

108

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

Dan O'Meara

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

[diff] [blame]

109

{

Yoshi Automation Bot

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

[diff] [blame^]

110

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

111

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

112

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

113

{

114

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

115

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

116

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

117

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

118

},

119

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

120

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

121

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

122

},

123

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

124

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

125

},

126

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

127

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

128

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

129

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

130

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

131

},

132

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

133

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

134

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

135

},

136

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

137

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

138

},

139

],

140

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

141

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

142

},

143

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

Yoshi Automation Bot

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

[diff] [blame]

144

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

Yoshi Automation Bot

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

[diff] [blame]

145

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

Yoshi Automation Bot

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

[diff] [blame^]

146

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

147

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

148

},

149

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

150

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

151

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

152

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

153

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

154

},

155

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

156

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

157

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

158

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

159

},

160

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

161

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

162

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

163

},

164

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

165

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

166

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

Yoshi Automation Bot

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

[diff] [blame]

167

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

{

"url": "A String",

},

],

Yoshi Automation Bot

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

[diff] [blame^]

172

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

Yoshi Automation Bot

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

[diff] [blame]

173

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

Yoshi Automation Bot

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

[diff] [blame^]

174

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

Yoshi Automation Bot

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

[diff] [blame]

175

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

Yoshi Automation Bot

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

[diff] [blame^]

176

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

177

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

178

"A String",

179

],

Dan O'Meara

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

[diff] [blame]

180

},

181

],

Yoshi Automation Bot

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

[diff] [blame]

182

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

Yoshi Automation Bot

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

[diff] [blame^]

183

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

Yoshi Automation Bot

c2228be

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

[diff] [blame]

184

},

Yoshi Automation Bot

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

[diff] [blame^]

185

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

Yoshi Automation Bot

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

[diff] [blame]

186

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

Yoshi Automation Bot

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

[diff] [blame^]

187

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

188

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

189

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

190

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

191

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

192

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

193

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

194

},

195

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

196

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

197

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

198

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

199

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

200

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

201

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

202

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

203

},

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-25 07:50:41 -0800

[diff] [blame]

222

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

223

{

Yoshi Automation Bot

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

[diff] [blame^]

224

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

Yoshi Automation Bot

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

[diff] [blame]

225

"blog": { # The Blog resource.

Yoshi Automation Bot

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

[diff] [blame]

226

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

227

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

228

{

Yoshi Automation Bot

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

[diff] [blame^]

229

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

230

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

231

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

232

{

233

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

234

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

235

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

236

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

237

},

238

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

239

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

240

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

241

},

242

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

243

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

244

},

245

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

246

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

247

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

248

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

249

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

250

},

251

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

252

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

253

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

254

},

255

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

256

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

257

},

258

],

259

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

260

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

261

},

262

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

Yoshi Automation Bot

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

[diff] [blame]

263

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

Yoshi Automation Bot

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

[diff] [blame]

264

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

Yoshi Automation Bot

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

[diff] [blame^]

265

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

266

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

267

},

268

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

269

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

270

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

271

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

272

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

273

},

274

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

275

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

276

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

277

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

278

},

279

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

280

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

281

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

282

},

283

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

284

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

285

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

Yoshi Automation Bot

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

[diff] [blame]

286

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

{

"url": "A String",

},

],

Yoshi Automation Bot

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

[diff] [blame^]

291

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

Yoshi Automation Bot

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

[diff] [blame]

292

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

Yoshi Automation Bot

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

[diff] [blame^]

293

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

Yoshi Automation Bot

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

[diff] [blame]

294

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

Yoshi Automation Bot

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

[diff] [blame^]

295

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

296

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

297

"A String",

298

],

Yoshi Automation Bot

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

[diff] [blame]

299

},

300

],

301

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

Yoshi Automation Bot

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

[diff] [blame^]

302

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

Yoshi Automation Bot

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

[diff] [blame]

303

},

Yoshi Automation Bot

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

[diff] [blame^]

304

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

Yoshi Automation Bot

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

[diff] [blame]

305

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

Yoshi Automation Bot

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

[diff] [blame^]

306

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

307

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

308

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

309

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

310

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

311

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

312

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

313

},

314

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

315

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

316

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

317

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

318

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

319

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

320

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

321

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

322

},

Yoshi Automation Bot

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

[diff] [blame]

323

},

Yoshi Automation Bot

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

[diff] [blame^]

324

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

325

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

326

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

327

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

328

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

329

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

330

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

331

},

Yoshi Automation Bot

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

[diff] [blame]

332

},

333

],

Yoshi Automation Bot

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

[diff] [blame^]

334

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

335

{

336

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

337

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

338

{

339

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

340

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

341

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

342

{

343

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

344

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

345

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

346

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

347

},

348

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

349

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

350

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

351

},

352

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

353

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

354

},

355

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

356

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

357

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

358

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

359

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

360

},

361

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

362

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

363

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

364

},

365

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

366

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

367

},

368

],

369

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

370

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

371

},

372

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

373

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

374

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

375

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

376

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

377

},

378

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

379

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

380

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

381

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

382

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

383

},

384

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

385

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

386

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

387

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

388

},

389

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

390

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

391

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

392

},

393

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

394

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

395

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

396

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

{

"url": "A String",

},

],

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

402

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

403

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

404

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

405

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

406

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

"A String",

],

},

],

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

412

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

413

},

414

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

415

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

416

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

417

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

418

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

419

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

420

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

421

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

422

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

423

},

424

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

425

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

426

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

427

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

428

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

429

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

430

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

431

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

},

},

],

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

Sai Cheemalapati