Blame - docs/dyn/blogger_v2.comments.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.comments.html">comments</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, postId, commentId, x__xgafv=None)</a></code></p>

82

<p class="firstline">Gets a comment by blog id, post id and comment id.</p>

Sai Cheemalapati

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

[diff] [blame]

83

Bu Sun Kim

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

[diff] [blame^]

84

<code><a href="#list">list(blogId, postId, startDate=None, maxResults=None, fetchBodies=None, pageToken=None, x__xgafv=None)</a></code></p>

Dan O'Meara

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

[diff] [blame]

85

<p class="firstline">Lists comments.</p>

Sai Cheemalapati

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

[diff] [blame]

86

87

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

88

<p class="firstline">Retrieves the next page of results.</p>

89

<h3>Method Details</h3>

90

Dmitry Frenkel

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

[diff] [blame]

91

<code class="details" id="close">close()</code>

92

<pre>Close httplib2 connections.</pre>

</div>

Dan O'Meara

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

[diff] [blame]

96

<code class="details" id="get">get(blogId, postId, commentId, x__xgafv=None)</code>

97

<pre>Gets a comment by blog id, post id and comment id.

Sai Cheemalapati

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

[diff] [blame]

98

99

Args:

Dan O'Meara

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

[diff] [blame]

100

blogId: string, A parameter (required)

101

postId: string, A parameter (required)

102

commentId: string, A parameter (required)

103

x__xgafv: string, V1 error format.

104

Allowed values

105

1 - v1 error format

106

2 - v2 error format

Sai Cheemalapati

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

[diff] [blame]

107

108

Returns:

109

An object of the form:

110

111

{

Dmitry Frenkel

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

[diff] [blame]

112

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

Bu Sun Kim

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

[diff] [blame]

113

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

114

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

Sai Cheemalapati

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

[diff] [blame]

115

},

Bu Sun Kim

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

[diff] [blame^]

116

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

117

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

118

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

119

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

120

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

121

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

122

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

123

},

124

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

125

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

126

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

127

},

Bu Sun Kim

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

[diff] [blame]

128

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

129

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

130

},

Bu Sun Kim

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

[diff] [blame^]

131

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

Bu Sun Kim

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

[diff] [blame]

132

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

133

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

134

},

Bu Sun Kim

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

[diff] [blame^]

135

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

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame^]

140

<code class="details" id="list">list(blogId, postId, startDate=None, maxResults=None, fetchBodies=None, pageToken=None, x__xgafv=None)</code>

Dan O'Meara

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

[diff] [blame]

141

<pre>Lists comments.

Sai Cheemalapati

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

[diff] [blame]

142

143

Args:

Dan O'Meara

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

[diff] [blame]

144

blogId: string, A parameter (required)

145

postId: string, A parameter (required)

Dmitry Frenkel

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

[diff] [blame]

146

startDate: string, A parameter

Bu Sun Kim

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

[diff] [blame]

147

maxResults: integer, A parameter

Bu Sun Kim

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

[diff] [blame^]

148

fetchBodies: boolean, A parameter

Bu Sun Kim

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

[diff] [blame]

149

pageToken: string, A parameter

Dan O'Meara

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

[diff] [blame]

150

x__xgafv: string, V1 error format.

151

Allowed values

152

1 - v1 error format

153

2 - v2 error format

Sai Cheemalapati

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

[diff] [blame]

154

155

Returns:

156

An object of the form:

157

158

{

Bu Sun Kim

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

[diff] [blame]

159

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

Sai Cheemalapati

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

[diff] [blame]

160

{

Dmitry Frenkel

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

[diff] [blame]

161

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

Bu Sun Kim

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

[diff] [blame]

162

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

163

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

Sai Cheemalapati

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

[diff] [blame]

164

},

Bu Sun Kim

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

[diff] [blame^]

165

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

166

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

167

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

168

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

169

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

170

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

171

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

172

},

173

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

174

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

175

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

176

},

Bu Sun Kim

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

[diff] [blame]

177

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

178

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

179

},

Bu Sun Kim

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

[diff] [blame^]

180

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

Bu Sun Kim

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

[diff] [blame]

181

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

182

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

183

},

Bu Sun Kim

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

[diff] [blame^]

184

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

Sai Cheemalapati

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

[diff] [blame]

185

},

186

],

Dmitry Frenkel

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

[diff] [blame]

187

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

Bu Sun Kim

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

[diff] [blame^]

188

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

Dmitry Frenkel

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

[diff] [blame]

189

"nextPageToken": "A String", # Pagination token to fetch the next page, if one exists.

Bu Sun Kim

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

[diff] [blame^]

190

"prevPageToken": "A String", # Pagination token to fetch the previous page, if one exists.

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

196

<pre>Retrieves the next page of results.

197

198

Args:

199

previous_request: The request for the previous page. (required)

200

previous_response: The response from the request for the previous page. (required)

201

202

Returns:

Bu Sun Kim

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

[diff] [blame]

203

A request object that you can call 'execute()' on to request the next

Sai Cheemalapati