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

Dan O'Meara

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

[diff] [blame]

78

<code><a href="#get">get(blogId, postId, commentId, x__xgafv=None)</a></code></p>

79

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

80

Bu Sun Kim

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

[diff] [blame^]

81

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

Dan O'Meara

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

[diff] [blame]

82

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

Sai Cheemalapati

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

[diff] [blame]

83

84

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

85

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

86

<h3>Method Details</h3>

87

Dan O'Meara

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

[diff] [blame]

88

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

89

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

Sai Cheemalapati

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

[diff] [blame]

90

91

Args:

Dan O'Meara

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

[diff] [blame]

92

blogId: string, A parameter (required)

93

postId: string, A parameter (required)

94

commentId: string, A parameter (required)

95

x__xgafv: string, V1 error format.

96

Allowed values

97

1 - v1 error format

98

2 - v2 error format

Sai Cheemalapati

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

[diff] [blame]

99

100

Returns:

101

An object of the form:

102

103

{

Bu Sun Kim

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

[diff] [blame^]

104

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

105

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

106

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

107

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

108

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

109

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

110

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

Sai Cheemalapati

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

[diff] [blame]

111

},

Bu Sun Kim

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

[diff] [blame^]

112

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

113

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

114

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

115

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

116

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

Sai Cheemalapati

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

[diff] [blame]

117

},

Bu Sun Kim

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

[diff] [blame^]

118

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

119

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

Sai Cheemalapati

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

[diff] [blame]

120

},

Bu Sun Kim

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

[diff] [blame^]

121

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

122

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

123

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

Sai Cheemalapati

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

[diff] [blame]

124

},

Bu Sun Kim

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

[diff] [blame^]

125

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

126

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

Sai Cheemalapati

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

[diff] [blame]

127

},

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame^]

132

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

Dan O'Meara

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

[diff] [blame]

133

<pre>Lists comments.

Sai Cheemalapati

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

[diff] [blame]

134

135

Args:

Dan O'Meara

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

[diff] [blame]

136

blogId: string, A parameter (required)

137

postId: string, A parameter (required)

Dan O'Meara

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

[diff] [blame]

138

maxResults: integer, A parameter

Bu Sun Kim

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

[diff] [blame^]

139

fetchBodies: boolean, A parameter

Dan O'Meara

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

[diff] [blame]

140

pageToken: string, A parameter

Bu Sun Kim

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

[diff] [blame^]

141

startDate: string, A parameter

Dan O'Meara

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

[diff] [blame]

142

x__xgafv: string, V1 error format.

143

Allowed values

144

1 - v1 error format

145

2 - v2 error format

Sai Cheemalapati

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

[diff] [blame]

146

147

Returns:

148

An object of the form:

149

150

{

Bu Sun Kim

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

[diff] [blame^]

151

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

Sai Cheemalapati

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

[diff] [blame]

152

{

Bu Sun Kim

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

[diff] [blame^]

153

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

154

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

155

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

156

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

157

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

158

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

159

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

Sai Cheemalapati

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

[diff] [blame]

160

},

Bu Sun Kim

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

[diff] [blame^]

161

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

162

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

163

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

164

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

165

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

Sai Cheemalapati

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

[diff] [blame]

166

},

Bu Sun Kim

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

[diff] [blame^]

167

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

168

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

Sai Cheemalapati

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

[diff] [blame]

169

},

Bu Sun Kim

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

[diff] [blame^]

170

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

171

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

172

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

Sai Cheemalapati

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

[diff] [blame]

173

},

Bu Sun Kim

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

[diff] [blame^]

174

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

175

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

Sai Cheemalapati

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

[diff] [blame]

176

},

Sai Cheemalapati

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

[diff] [blame]

177

},

178

],

Bu Sun Kim

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

[diff] [blame^]

179

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

180

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

181

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

182

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

188

<pre>Retrieves the next page of results.

189

190

Args:

191

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

192

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

193

194

Returns:

Bu Sun Kim

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

[diff] [blame^]

195

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

Sai Cheemalapati