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

{

Yoshi Automation Bot

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

[diff] [blame]

107

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

Yoshi Automation Bot

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

[diff] [blame]

108

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

Yoshi Automation Bot

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

[diff] [blame]

109

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

Yoshi Automation Bot

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

[diff] [blame]

110

"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]

111

},

Yoshi Automation Bot

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

[diff] [blame]

112

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

Bu Sun Kim

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

[diff] [blame]

113

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

Yoshi Automation Bot

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

[diff] [blame]

114

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

115

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

116

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

117

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

118

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

Bu Sun Kim

6502091

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

[diff] [blame]

119

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

120

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

Dan O'Meara

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

[diff] [blame]

121

{

Yoshi Automation Bot

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

[diff] [blame]

122

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

Yoshi Automation Bot

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

[diff] [blame]

123

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

Yoshi Automation Bot

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

[diff] [blame]

124

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

Yoshi Automation Bot

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

[diff] [blame]

125

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

Bu Sun Kim

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

[diff] [blame]

126

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

127

"A String",

128

],

Yoshi Automation Bot

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

[diff] [blame]

129

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

130

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

131

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

132

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

133

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

134

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

135

},

Bu Sun Kim

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

[diff] [blame]

136

},

Yoshi Automation Bot

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

[diff] [blame]

137

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

Dmitry Frenkel

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

[diff] [blame]

138

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

Dmitry Frenkel

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

[diff] [blame]

139

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

Yoshi Automation Bot

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

[diff] [blame]

140

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

Bu Sun Kim

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

[diff] [blame]

141

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

Dmitry Frenkel

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

[diff] [blame]

142

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

143

},

Yoshi Automation Bot

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

[diff] [blame]

144

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

145

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

Yoshi Automation Bot

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

[diff] [blame]

146

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

Yoshi Automation Bot

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

[diff] [blame]

147

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

148

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

149

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

150

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

151

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

152

},

153

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

154

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

155

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

156

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

157

{

158

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

159

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

160

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

161

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

162

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

163

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

164

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

165

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

166

},

167

},

168

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

169

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

170

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

171

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

172

},

173

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

174

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

175

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

176

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

177

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

178

},

179

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

180

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

},

},

],

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

185

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

186

},

187

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

{

"url": "A String",

},

],

Dan O'Meara

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

[diff] [blame]

192

},

193

],

Yoshi Automation Bot

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

[diff] [blame]

194

"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]

195

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

Sai Cheemalapati

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

[diff] [blame]

196

},

Yoshi Automation Bot

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

[diff] [blame]

197

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

Yoshi Automation Bot

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

[diff] [blame]

198

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

199

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

Yoshi Automation Bot

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

[diff] [blame]

200

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

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-24 15:48:03 -0800

[diff] [blame]

203

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

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-07-22 17:02:09 -0700

[diff] [blame]

222

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

223

{

Yoshi Automation Bot

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

[diff] [blame]

224

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

Yoshi Automation Bot

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

[diff] [blame]

225

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

Yoshi Automation Bot

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

[diff] [blame]

226

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

Yoshi Automation Bot

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

[diff] [blame]

227

"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]

228

},

Yoshi Automation Bot

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

[diff] [blame]

229

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

Bu Sun Kim

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

[diff] [blame]

230

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

Yoshi Automation Bot

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

[diff] [blame]

231

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

232

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

233

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

234

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

235

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

Bu Sun Kim

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

[diff] [blame]

236

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

237

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

238

{

Yoshi Automation Bot

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

[diff] [blame]

239

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

Yoshi Automation Bot

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

[diff] [blame]

240

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

Yoshi Automation Bot

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

[diff] [blame]

241

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

Yoshi Automation Bot

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

[diff] [blame]

242

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

Bu Sun Kim

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

[diff] [blame]

243

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

244

"A String",

245

],

Yoshi Automation Bot

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

[diff] [blame]

246

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

247

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

248

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

249

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

250

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

251

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

252

},

Bu Sun Kim

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

[diff] [blame]

253

},

Yoshi Automation Bot

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

[diff] [blame]

254

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

Dmitry Frenkel

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

[diff] [blame]

255

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

Dmitry Frenkel

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

[diff] [blame]

256

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

Yoshi Automation Bot

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

[diff] [blame]

257

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

Bu Sun Kim

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

[diff] [blame]

258

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

Dmitry Frenkel

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

[diff] [blame]

259

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

260

},

Yoshi Automation Bot

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

[diff] [blame]

261

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

262

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

Yoshi Automation Bot

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

[diff] [blame]

263

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

Yoshi Automation Bot

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

[diff] [blame]

264

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

265

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

266

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

267

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

268

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

269

},

270

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

271

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

272

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

273

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

274

{

275

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

276

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

277

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

278

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

279

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

280

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

281

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

282

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

283

},

284

},

285

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

286

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

287

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

288

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

289

},

290

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

291

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

292

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

293

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

294

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

295

},

296

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

297

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

},

},

],

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

302

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

303

},

304

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

{

"url": "A String",

},

],

Bu Sun Kim

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

[diff] [blame]

309

},

310

],

Yoshi Automation Bot

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

[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.

Bu Sun Kim

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

[diff] [blame]

313

},

Yoshi Automation Bot

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

[diff] [blame]

314

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

Yoshi Automation Bot

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

[diff] [blame]

315

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

316

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

Yoshi Automation Bot

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

[diff] [blame]

317

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

Yoshi Automation Bot

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

[diff] [blame]

318

},

319

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

Yoshi Automation Bot

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

[diff] [blame]

320

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

Bu Sun Kim

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

[diff] [blame]

321

},

322

],

Yoshi Automation Bot

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

[diff] [blame]

323

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

324

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

325

{

326

"blog": { # The Blog resource.

327

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

328

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

329

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

330

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

331

},

332

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

333

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

334

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

335

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

336

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

337

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

338

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

339

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

340

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

341

{

342

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

343

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

344

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

345

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

346

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

347

"A String",

348

],

349

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

350

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

351

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

352

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

353

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

354

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

355

},

356

},

357

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

358

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

359

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

360

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

361

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

362

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

363

},

364

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

365

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

366

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

367

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

368

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

369

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

370

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

371

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

372

},

373

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

374

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

375

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

376

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

377

{

378

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

379

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

380

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

381

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

382

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

383

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

384

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

385

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

386

},

387

},

388

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

389

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

390

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

391

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

392

},

393

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

394

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

395

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

396

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

397

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

398

},

399

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

400

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

},

},

],

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

405

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

406

},

407

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

{

"url": "A String",

},

],

},

],

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

415

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

416

},

417

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

418

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

419

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

420

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

421

},

422

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

423

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

424

},

425

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

426

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

427

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

428

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

429

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

430

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

431

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

432

},

433

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

434

},

435

],

Sai Cheemalapati