1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
|
# Copyright 2015 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
require 'google/apis/core/base_service'
require 'google/apis/core/json_representation'
require 'google/apis/core/hashable'
require 'google/apis/errors'
module Google
module Apis
module BloggerV2
# Blogger API v3
#
# The Blogger API provides access to posts, comments and pages of a Blogger blog.
#
# @example
# require 'google/apis/blogger_v2'
#
# Blogger = Google::Apis::BloggerV2 # Alias the module
# service = Blogger::BloggerService.new
#
# @see https://developers.google.com/blogger/docs/3.0/getting_started
class BloggerService < Google::Apis::Core::BaseService
# @return [String]
# API key. Your API key identifies your project and provides you with API access,
# quota, and reports. Required unless you provide an OAuth 2.0 token.
attr_accessor :key
# @return [String]
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
attr_accessor :quota_user
def initialize
super('https://blogger.googleapis.com/', '')
@batch_path = 'batch'
end
# Gets a blog by id.
# @param [String] blog_id
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::BloggerV2::Blog] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::BloggerV2::Blog]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_blog(blog_id, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v2/blogs/{blogId}', options)
command.response_representation = Google::Apis::BloggerV2::Blog::Representation
command.response_class = Google::Apis::BloggerV2::Blog
command.params['blogId'] = blog_id unless blog_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists blogs by user id, possibly filtered.
# @param [String] user_id
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::BloggerV2::BlogList] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::BloggerV2::BlogList]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_blogs(user_id, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v2/users/{userId}/blogs', options)
command.response_representation = Google::Apis::BloggerV2::BlogList::Representation
command.response_class = Google::Apis::BloggerV2::BlogList
command.params['userId'] = user_id unless user_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets a comment by blog id, post id and comment id.
# @param [String] blog_id
# @param [String] post_id
# @param [String] comment_id
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::BloggerV2::Comment] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::BloggerV2::Comment]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_comment(blog_id, post_id, comment_id, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v2/blogs/{blogId}/posts/{postId}/comments/{commentId}', options)
command.response_representation = Google::Apis::BloggerV2::Comment::Representation
command.response_class = Google::Apis::BloggerV2::Comment
command.params['blogId'] = blog_id unless blog_id.nil?
command.params['postId'] = post_id unless post_id.nil?
command.params['commentId'] = comment_id unless comment_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists comments.
# @param [String] blog_id
# @param [String] post_id
# @param [Boolean] fetch_bodies
# @param [Fixnum] max_results
# @param [String] page_token
# @param [String] start_date
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::BloggerV2::CommentList] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::BloggerV2::CommentList]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_comments(blog_id, post_id, fetch_bodies: nil, max_results: nil, page_token: nil, start_date: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v2/blogs/{blogId}/posts/{postId}/comments', options)
command.response_representation = Google::Apis::BloggerV2::CommentList::Representation
command.response_class = Google::Apis::BloggerV2::CommentList
command.params['blogId'] = blog_id unless blog_id.nil?
command.params['postId'] = post_id unless post_id.nil?
command.query['fetchBodies'] = fetch_bodies unless fetch_bodies.nil?
command.query['maxResults'] = max_results unless max_results.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['startDate'] = start_date unless start_date.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets a page by blog id and page id.
# @param [String] blog_id
# @param [String] page_id
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::BloggerV2::Page] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::BloggerV2::Page]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_page(blog_id, page_id, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v2/blogs/{blogId}/pages/{pageId}', options)
command.response_representation = Google::Apis::BloggerV2::Page::Representation
command.response_class = Google::Apis::BloggerV2::Page
command.params['blogId'] = blog_id unless blog_id.nil?
command.params['pageId'] = page_id unless page_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists pages.
# @param [String] blog_id
# @param [Boolean] fetch_bodies
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::BloggerV2::PageList] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::BloggerV2::PageList]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_pages(blog_id, fetch_bodies: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v2/blogs/{blogId}/pages', options)
command.response_representation = Google::Apis::BloggerV2::PageList::Representation
command.response_class = Google::Apis::BloggerV2::PageList
command.params['blogId'] = blog_id unless blog_id.nil?
command.query['fetchBodies'] = fetch_bodies unless fetch_bodies.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets a post by blog id and post id
# @param [String] blog_id
# @param [String] post_id
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::BloggerV2::Post] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::BloggerV2::Post]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_post(blog_id, post_id, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v2/blogs/{blogId}/posts/{postId}', options)
command.response_representation = Google::Apis::BloggerV2::Post::Representation
command.response_class = Google::Apis::BloggerV2::Post
command.params['blogId'] = blog_id unless blog_id.nil?
command.params['postId'] = post_id unless post_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists posts.
# @param [String] blog_id
# @param [Boolean] fetch_bodies
# @param [Fixnum] max_results
# @param [String] page_token
# @param [String] start_date
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::BloggerV2::PostList] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::BloggerV2::PostList]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_posts(blog_id, fetch_bodies: nil, max_results: nil, page_token: nil, start_date: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v2/blogs/{blogId}/posts', options)
command.response_representation = Google::Apis::BloggerV2::PostList::Representation
command.response_class = Google::Apis::BloggerV2::PostList
command.params['blogId'] = blog_id unless blog_id.nil?
command.query['fetchBodies'] = fetch_bodies unless fetch_bodies.nil?
command.query['maxResults'] = max_results unless max_results.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['startDate'] = start_date unless start_date.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets a user by user id.
# @param [String] user_id
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::BloggerV2::User] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::BloggerV2::User]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_user(user_id, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v2/users/{userId}', options)
command.response_representation = Google::Apis::BloggerV2::User::Representation
command.response_class = Google::Apis::BloggerV2::User
command.params['userId'] = user_id unless user_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
protected
def apply_command_defaults(command)
command.query['key'] = key unless key.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
end
end
end
end
end
|
