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

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

108

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

109

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

110

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

111

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

112

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

113

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

114

},

115

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

116

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

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

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

120

},

121

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

122

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

123

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

124

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

125

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

Bu Sun Kim

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

[diff] [blame]

126

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

127

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

Dan O'Meara

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

[diff] [blame]

128

{

Bu Sun Kim

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

[diff] [blame]

129

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

130

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

Dmitry Frenkel

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

[diff] [blame]

131

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

Bu Sun Kim

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

[diff] [blame]

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

[diff] [blame]

136

},

Dmitry Frenkel

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

[diff] [blame]

137

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

Bu Sun Kim

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

[diff] [blame]

138

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

Dan O'Meara

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

[diff] [blame]

139

{

Bu Sun Kim

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

[diff] [blame]

140

"url": "A String",

Dan O'Meara

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

[diff] [blame]

141

},

142

],

Dmitry Frenkel

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

[diff] [blame]

143

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

144

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

145

"A String",

146

],

147

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

148

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

Bu Sun Kim

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

[diff] [blame]

149

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

Dmitry Frenkel

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

[diff] [blame]

150

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

151

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

152

},

153

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

154

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

155

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

156

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

157

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

158

},

Bu Sun Kim

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

[diff] [blame]

159

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

Dmitry Frenkel

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

[diff] [blame]

160

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

161

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

162

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

163

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

164

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

165

{

166

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

167

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

168

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

169

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

170

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

171

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

172

},

173

},

174

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

175

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

176

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

177

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

178

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

179

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

180

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

181

},

182

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

183

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

184

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

185

},

186

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

187

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

188

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

},

},

],

},

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

194

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

Bu Sun Kim

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

[diff] [blame]

195

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

Dmitry Frenkel

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

[diff] [blame]

196

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

197

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

198

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

Dan O'Meara

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

[diff] [blame]

199

},

200

],

Bu Sun Kim

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

[diff] [blame]

201

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

Dmitry Frenkel

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

[diff] [blame]

202

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

Sai Cheemalapati

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

[diff] [blame]

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

{

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_user_info": { # Information about a User for the Blog.

Dmitry Frenkel

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

[diff] [blame]

225

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

Bu Sun Kim

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

[diff] [blame]

226

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

Bu Sun Kim

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

[diff] [blame]

227

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

Dmitry Frenkel

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

[diff] [blame]

228

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

229

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

230

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

Bu Sun Kim

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

[diff] [blame]

231

},

232

"blog": { # The Blog resource.

Dmitry Frenkel

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

[diff] [blame]

233

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

234

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

235

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

236

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

237

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

238

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

239

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

240

},

241

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

242

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

243

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

244

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

245

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

246

},

247

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

248

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

249

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

250

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

251

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

Bu Sun Kim

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

[diff] [blame]

252

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

253

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

Dan O'Meara

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

[diff] [blame]

254

{

Bu Sun Kim

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

[diff] [blame]

255

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

256

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

Dmitry Frenkel

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

[diff] [blame]

257

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

Bu Sun Kim

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

[diff] [blame]

258

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

259

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

260

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

261

},

Bu Sun Kim

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

[diff] [blame]

262

},

Dmitry Frenkel

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

[diff] [blame]

263

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

Bu Sun Kim

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

[diff] [blame]

264

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

Dan O'Meara

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

[diff] [blame]

265

{

Bu Sun Kim

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

[diff] [blame]

266

"url": "A String",

Dan O'Meara

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

[diff] [blame]

267

},

268

],

Dmitry Frenkel

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

[diff] [blame]

269

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

270

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

271

"A String",

272

],

273

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

274

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

Bu Sun Kim

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

[diff] [blame]

275

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

Dmitry Frenkel

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

[diff] [blame]

276

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

277

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

278

},

279

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

280

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

281

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

282

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

283

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

284

},

Bu Sun Kim

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

[diff] [blame]

285

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

Dmitry Frenkel

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

[diff] [blame]

286

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

287

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

288

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

289

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

290

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

291

{

292

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

293

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

294

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

295

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

296

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

297

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

298

},

299

},

300

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

301

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

302

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

303

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

304

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

305

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

306

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

307

},

308

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

309

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

310

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

311

},

312

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

313

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

314

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

},

},

],

},

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

320

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

Bu Sun Kim

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

[diff] [blame]

321

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

Dmitry Frenkel

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

[diff] [blame]

322

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

323

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

324

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

Dan O'Meara

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

[diff] [blame]

325

},

326

],

Bu Sun Kim

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

[diff] [blame]

327

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

Dmitry Frenkel

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

[diff] [blame]

328

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

Dan O'Meara

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

[diff] [blame]

329

},

Dan O'Meara

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

[diff] [blame]

330

},

Dmitry Frenkel

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

[diff] [blame]

331

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

Dan O'Meara

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

[diff] [blame]

332

},

333

],

Bu Sun Kim

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

[diff] [blame]

334

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

335

{

Dmitry Frenkel

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

[diff] [blame]

336

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

337

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

338

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

339

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

340

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

341

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

342

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

343

},

344

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

345

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

346

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

347

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

348

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

349

},

350

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

351

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

352

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

353

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

354

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

Bu Sun Kim

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

[diff] [blame]

355

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

356

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

357

{

Bu Sun Kim

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

[diff] [blame]

358

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

359

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

Dmitry Frenkel

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

[diff] [blame]

360

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

Bu Sun Kim

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

[diff] [blame]

361

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

362

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

363

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

364

},

Bu Sun Kim

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

[diff] [blame]

365

},

Dmitry Frenkel

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

[diff] [blame]

366

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

Bu Sun Kim

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

[diff] [blame]

367

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

{

"url": "A String",

},

],

Dmitry Frenkel

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

[diff] [blame]

372

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

373

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

374

"A String",

375

],

376

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

377

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

Bu Sun Kim

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

[diff] [blame]

378

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

Dmitry Frenkel

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

[diff] [blame]

379

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

380

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

381

},

382

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

383

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

384

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

385

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

386

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

387

},

Bu Sun Kim

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

[diff] [blame]

388

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

Dmitry Frenkel

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

[diff] [blame]

389

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

390

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

391

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

392

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

393

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

394

{

395

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

396

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

397

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

398

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

399

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

400

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

401

},

402

},

403

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

404

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

405

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

406

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

407

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

408

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

409

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

410

},

411

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

412

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

413

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

414

},

415

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

416

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

417

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

},

},

],

},

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

423

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

Bu Sun Kim

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

[diff] [blame]

424

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

Dmitry Frenkel

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

[diff] [blame]

425

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

426

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

427

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

Bu Sun Kim

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

[diff] [blame]

428

},

429

],

Bu Sun Kim

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

[diff] [blame]

430

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

Dmitry Frenkel

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

[diff] [blame]

431

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

Bu Sun Kim

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

[diff] [blame]

432

},

Bu Sun Kim

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

[diff] [blame]

433

},

434

],

Dmitry Frenkel

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

[diff] [blame]

435

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

Sai Cheemalapati