Class: Google::Apis::BloggerV3::BloggerService

Inherits:
Core::BaseService show all
Defined in:
generated/google/apis/blogger_v3/service.rb

Overview

Blogger API

API for access to the data within Blogger.

Examples:

require 'google/apis/blogger_v3'

Blogger = Google::Apis::BloggerV3 # Alias the module
service = Blogger::BloggerService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Core::Logging

#logger

Constructor Details

#initializeBloggerService


49
50
51
52
# File 'generated/google/apis/blogger_v3/service.rb', line 49

def initialize
  super('https://www.googleapis.com/', 'blogger/v3/')
  @batch_path = 'batch/blogger/v3'
end

Instance Attribute Details

#keyString


38
39
40
# File 'generated/google/apis/blogger_v3/service.rb', line 38

def key
  @key
end

#quota_userString


43
44
45
# File 'generated/google/apis/blogger_v3/service.rb', line 43

def quota_user
  @quota_user
end

#user_ipString


47
48
49
# File 'generated/google/apis/blogger_v3/service.rb', line 47

def user_ip
  @user_ip
end

Instance Method Details

#approve_comment(blog_id, post_id, comment_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BloggerV3::Comment

Marks a comment as not spam.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


248
249
250
251
252
253
254
255
256
257
258
259
# File 'generated/google/apis/blogger_v3/service.rb', line 248

def approve_comment(blog_id, post_id, comment_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'blogs/{blogId}/posts/{postId}/comments/{commentId}/approve', options)
  command.response_representation = Google::Apis::BloggerV3::Comment::Representation
  command.response_class = Google::Apis::BloggerV3::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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_comment(blog_id, post_id, comment_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Delete a comment by ID.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:


287
288
289
290
291
292
293
294
295
296
# File 'generated/google/apis/blogger_v3/service.rb', line 287

def delete_comment(blog_id, post_id, comment_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'blogs/{blogId}/posts/{postId}/comments/{commentId}', options)
  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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_page(blog_id, page_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Delete a page by ID.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:


587
588
589
590
591
592
593
594
595
# File 'generated/google/apis/blogger_v3/service.rb', line 587

def delete_page(blog_id, page_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'blogs/{blogId}/pages/{pageId}', options)
  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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_post(blog_id, post_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Delete a post by ID.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:


1023
1024
1025
1026
1027
1028
1029
1030
1031
# File 'generated/google/apis/blogger_v3/service.rb', line 1023

def delete_post(blog_id, post_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'blogs/{blogId}/posts/{postId}', options)
  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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_blog(blog_id, max_posts: nil, view: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BloggerV3::Blog

Gets one blog by ID.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


121
122
123
124
125
126
127
128
129
130
131
132
# File 'generated/google/apis/blogger_v3/service.rb', line 121

def get_blog(blog_id, max_posts: nil, view: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'blogs/{blogId}', options)
  command.response_representation = Google::Apis::BloggerV3::Blog::Representation
  command.response_class = Google::Apis::BloggerV3::Blog
  command.params['blogId'] = blog_id unless blog_id.nil?
  command.query['maxPosts'] = max_posts unless max_posts.nil?
  command.query['view'] = view unless view.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_blog_by_url(url, view: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BloggerV3::Blog

Retrieve a Blog by URL.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


159
160
161
162
163
164
165
166
167
168
169
# File 'generated/google/apis/blogger_v3/service.rb', line 159

def get_blog_by_url(url, view: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'blogs/byurl', options)
  command.response_representation = Google::Apis::BloggerV3::Blog::Representation
  command.response_class = Google::Apis::BloggerV3::Blog
  command.query['url'] = url unless url.nil?
  command.query['view'] = view unless view.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_blog_user_info(user_id, blog_id, max_posts: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BloggerV3::BlogUserInfo

Gets one blog and user info pair by blogId and userId.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


81
82
83
84
85
86
87
88
89
90
91
92
# File 'generated/google/apis/blogger_v3/service.rb', line 81

def (user_id, blog_id, max_posts: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'users/{userId}/blogs/{blogId}', options)
  command.response_representation = Google::Apis::BloggerV3::BlogUserInfo::Representation
  command.response_class = Google::Apis::BloggerV3::BlogUserInfo
  command.params['userId'] = user_id unless user_id.nil?
  command.params['blogId'] = blog_id unless blog_id.nil?
  command.query['maxPosts'] = max_posts unless max_posts.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_comment(blog_id, post_id, comment_id, view: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BloggerV3::Comment

Gets one comment by ID.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


329
330
331
332
333
334
335
336
337
338
339
340
341
# File 'generated/google/apis/blogger_v3/service.rb', line 329

def get_comment(blog_id, post_id, comment_id, view: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'blogs/{blogId}/posts/{postId}/comments/{commentId}', options)
  command.response_representation = Google::Apis::BloggerV3::Comment::Representation
  command.response_class = Google::Apis::BloggerV3::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['view'] = view unless view.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_page(blog_id, page_id, view: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BloggerV3::Page

Gets one blog page by ID.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


622
623
624
625
626
627
628
629
630
631
632
633
# File 'generated/google/apis/blogger_v3/service.rb', line 622

def get_page(blog_id, page_id, view: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'blogs/{blogId}/pages/{pageId}', options)
  command.response_representation = Google::Apis::BloggerV3::Page::Representation
  command.response_class = Google::Apis::BloggerV3::Page
  command.params['blogId'] = blog_id unless blog_id.nil?
  command.params['pageId'] = page_id unless page_id.nil?
  command.query['view'] = view unless view.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_page_view(blog_id, range: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BloggerV3::Pageviews

Retrieve pageview stats for a Blog.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


551
552
553
554
555
556
557
558
559
560
561
# File 'generated/google/apis/blogger_v3/service.rb', line 551

def get_page_view(blog_id, range: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'blogs/{blogId}/pageviews', options)
  command.response_representation = Google::Apis::BloggerV3::Pageviews::Representation
  command.response_class = Google::Apis::BloggerV3::Pageviews
  command.params['blogId'] = blog_id unless blog_id.nil?
  command.query['range'] = range unless range.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_post(blog_id, post_id, fetch_body: nil, fetch_images: nil, max_comments: nil, view: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BloggerV3::Post

Get a post by ID.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
# File 'generated/google/apis/blogger_v3/service.rb', line 1068

def get_post(blog_id, post_id, fetch_body: nil, fetch_images: nil, max_comments: nil, view: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'blogs/{blogId}/posts/{postId}', options)
  command.response_representation = Google::Apis::BloggerV3::Post::Representation
  command.response_class = Google::Apis::BloggerV3::Post
  command.params['blogId'] = blog_id unless blog_id.nil?
  command.params['postId'] = post_id unless post_id.nil?
  command.query['fetchBody'] = fetch_body unless fetch_body.nil?
  command.query['fetchImages'] = fetch_images unless fetch_images.nil?
  command.query['maxComments'] = max_comments unless max_comments.nil?
  command.query['view'] = view unless view.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_post_by_path(blog_id, path, max_comments: nil, view: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BloggerV3::Post

Retrieve a Post by Path.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
# File 'generated/google/apis/blogger_v3/service.rb', line 1113

def get_post_by_path(blog_id, path, max_comments: nil, view: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'blogs/{blogId}/posts/bypath', options)
  command.response_representation = Google::Apis::BloggerV3::Post::Representation
  command.response_class = Google::Apis::BloggerV3::Post
  command.params['blogId'] = blog_id unless blog_id.nil?
  command.query['maxComments'] = max_comments unless max_comments.nil?
  command.query['path'] = path unless path.nil?
  command.query['view'] = view unless view.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_post_user_info(user_id, blog_id, post_id, max_comments: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BloggerV3::PostUserInfo

Gets one post and user info pair, by post ID and user ID. The post user info contains per-user information about the post, such as access rights, specific to the user.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


919
920
921
922
923
924
925
926
927
928
929
930
931
# File 'generated/google/apis/blogger_v3/service.rb', line 919

def (user_id, blog_id, post_id, max_comments: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'users/{userId}/blogs/{blogId}/posts/{postId}', options)
  command.response_representation = Google::Apis::BloggerV3::PostUserInfo::Representation
  command.response_class = Google::Apis::BloggerV3::PostUserInfo
  command.params['userId'] = user_id unless user_id.nil?
  command.params['blogId'] = blog_id unless blog_id.nil?
  command.params['postId'] = post_id unless post_id.nil?
  command.query['maxComments'] = max_comments unless max_comments.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_user(user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BloggerV3::User

Gets one user by ID.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
# File 'generated/google/apis/blogger_v3/service.rb', line 1499

def get_user(user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'users/{userId}', options)
  command.response_representation = Google::Apis::BloggerV3::User::Representation
  command.response_class = Google::Apis::BloggerV3::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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#insert_page(blog_id, page_object = nil, is_draft: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BloggerV3::Page

Add a page.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


660
661
662
663
664
665
666
667
668
669
670
671
672
# File 'generated/google/apis/blogger_v3/service.rb', line 660

def insert_page(blog_id, page_object = nil, is_draft: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'blogs/{blogId}/pages', options)
  command.request_representation = Google::Apis::BloggerV3::Page::Representation
  command.request_object = page_object
  command.response_representation = Google::Apis::BloggerV3::Page::Representation
  command.response_class = Google::Apis::BloggerV3::Page
  command.params['blogId'] = blog_id unless blog_id.nil?
  command.query['isDraft'] = is_draft unless is_draft.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#insert_post(blog_id, post_object = nil, fetch_body: nil, fetch_images: nil, is_draft: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BloggerV3::Post

Add a post.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
# File 'generated/google/apis/blogger_v3/service.rb', line 1158

def insert_post(blog_id, post_object = nil, fetch_body: nil, fetch_images: nil, is_draft: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'blogs/{blogId}/posts', options)
  command.request_representation = Google::Apis::BloggerV3::Post::Representation
  command.request_object = post_object
  command.response_representation = Google::Apis::BloggerV3::Post::Representation
  command.response_class = Google::Apis::BloggerV3::Post
  command.params['blogId'] = blog_id unless blog_id.nil?
  command.query['fetchBody'] = fetch_body unless fetch_body.nil?
  command.query['fetchImages'] = fetch_images unless fetch_images.nil?
  command.query['isDraft'] = is_draft unless is_draft.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_blogs_by_user(user_id, fetch_user_info: nil, role: nil, status: nil, view: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BloggerV3::BlogList

Retrieves a list of blogs, possibly filtered.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


207
208
209
210
211
212
213
214
215
216
217
218
219
220
# File 'generated/google/apis/blogger_v3/service.rb', line 207

def list_blogs_by_user(user_id, fetch_user_info: nil, role: nil, status: nil, view: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'users/{userId}/blogs', options)
  command.response_representation = Google::Apis::BloggerV3::BlogList::Representation
  command.response_class = Google::Apis::BloggerV3::BlogList
  command.params['userId'] = user_id unless user_id.nil?
  command.query['fetchUserInfo'] =  unless .nil?
  command.query['role'] = role unless role.nil?
  command.query['status'] = status unless status.nil?
  command.query['view'] = view unless view.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_comments(blog_id, post_id, end_date: nil, fetch_bodies: nil, max_results: nil, page_token: nil, start_date: nil, status: nil, view: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BloggerV3::CommentList

Retrieves the comments for a post, possibly filtered.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
# File 'generated/google/apis/blogger_v3/service.rb', line 381

def list_comments(blog_id, post_id, end_date: nil, fetch_bodies: nil, max_results: nil, page_token: nil, start_date: nil, status: nil, view: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'blogs/{blogId}/posts/{postId}/comments', options)
  command.response_representation = Google::Apis::BloggerV3::CommentList::Representation
  command.response_class = Google::Apis::BloggerV3::CommentList
  command.params['blogId'] = blog_id unless blog_id.nil?
  command.params['postId'] = post_id unless post_id.nil?
  command.query['endDate'] = end_date unless end_date.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['status'] = status unless status.nil?
  command.query['view'] = view unless view.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_comments_by_blog(blog_id, end_date: nil, fetch_bodies: nil, max_results: nil, page_token: nil, start_date: nil, status: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BloggerV3::CommentList

Retrieves the comments for a blog, across all posts, possibly filtered.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
# File 'generated/google/apis/blogger_v3/service.rb', line 433

def list_comments_by_blog(blog_id, end_date: nil, fetch_bodies: nil, max_results: nil, page_token: nil, start_date: nil, status: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'blogs/{blogId}/comments', options)
  command.response_representation = Google::Apis::BloggerV3::CommentList::Representation
  command.response_class = Google::Apis::BloggerV3::CommentList
  command.params['blogId'] = blog_id unless blog_id.nil?
  command.query['endDate'] = end_date unless end_date.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['status'] = status unless status.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_pages(blog_id, fetch_bodies: nil, max_results: nil, page_token: nil, status: nil, view: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BloggerV3::PageList

Retrieves the pages for a blog, optionally including non-LIVE statuses.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
# File 'generated/google/apis/blogger_v3/service.rb', line 706

def list_pages(blog_id, fetch_bodies: nil, max_results: nil, page_token: nil, status: nil, view: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'blogs/{blogId}/pages', options)
  command.response_representation = Google::Apis::BloggerV3::PageList::Representation
  command.response_class = Google::Apis::BloggerV3::PageList
  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['status'] = status unless status.nil?
  command.query['view'] = view unless view.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_post_user_info(user_id, blog_id, end_date: nil, fetch_bodies: nil, labels: nil, max_results: nil, order_by: nil, page_token: nil, start_date: nil, status: nil, view: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BloggerV3::PostUserInfosList

Retrieves a list of post and post user info pairs, possibly filtered. The post user info contains per-user information about the post, such as access rights, specific to the user.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
# File 'generated/google/apis/blogger_v3/service.rb', line 978

def (user_id, blog_id, end_date: nil, fetch_bodies: nil, labels: nil, max_results: nil, order_by: nil, page_token: nil, start_date: nil, status: nil, view: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'users/{userId}/blogs/{blogId}/posts', options)
  command.response_representation = Google::Apis::BloggerV3::PostUserInfosList::Representation
  command.response_class = Google::Apis::BloggerV3::PostUserInfosList
  command.params['userId'] = user_id unless user_id.nil?
  command.params['blogId'] = blog_id unless blog_id.nil?
  command.query['endDate'] = end_date unless end_date.nil?
  command.query['fetchBodies'] = fetch_bodies unless fetch_bodies.nil?
  command.query['labels'] = labels unless labels.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['startDate'] = start_date unless start_date.nil?
  command.query['status'] = status unless status.nil?
  command.query['view'] = view unless view.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_posts(blog_id, end_date: nil, fetch_bodies: nil, fetch_images: nil, labels: nil, max_results: nil, order_by: nil, page_token: nil, start_date: nil, status: nil, view: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BloggerV3::PostList

Retrieves a list of posts, possibly filtered.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
# File 'generated/google/apis/blogger_v3/service.rb', line 1218

def list_posts(blog_id, end_date: nil, fetch_bodies: nil, fetch_images: nil, labels: nil, max_results: nil, order_by: nil, page_token: nil, start_date: nil, status: nil, view: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'blogs/{blogId}/posts', options)
  command.response_representation = Google::Apis::BloggerV3::PostList::Representation
  command.response_class = Google::Apis::BloggerV3::PostList
  command.params['blogId'] = blog_id unless blog_id.nil?
  command.query['endDate'] = end_date unless end_date.nil?
  command.query['fetchBodies'] = fetch_bodies unless fetch_bodies.nil?
  command.query['fetchImages'] = fetch_images unless fetch_images.nil?
  command.query['labels'] = labels unless labels.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['startDate'] = start_date unless start_date.nil?
  command.query['status'] = status unless status.nil?
  command.query['view'] = view unless view.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#mark_comment_as_spam(blog_id, post_id, comment_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BloggerV3::Comment

Marks a comment as spam.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


476
477
478
479
480
481
482
483
484
485
486
487
# File 'generated/google/apis/blogger_v3/service.rb', line 476

def mark_comment_as_spam(blog_id, post_id, comment_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'blogs/{blogId}/posts/{postId}/comments/{commentId}/spam', options)
  command.response_representation = Google::Apis::BloggerV3::Comment::Representation
  command.response_class = Google::Apis::BloggerV3::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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#patch_page(blog_id, page_id, page_object = nil, publish: nil, revert: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BloggerV3::Page

Update a page. This method supports patch semantics.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
# File 'generated/google/apis/blogger_v3/service.rb', line 753

def patch_page(blog_id, page_id, page_object = nil, publish: nil, revert: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'blogs/{blogId}/pages/{pageId}', options)
  command.request_representation = Google::Apis::BloggerV3::Page::Representation
  command.request_object = page_object
  command.response_representation = Google::Apis::BloggerV3::Page::Representation
  command.response_class = Google::Apis::BloggerV3::Page
  command.params['blogId'] = blog_id unless blog_id.nil?
  command.params['pageId'] = page_id unless page_id.nil?
  command.query['publish'] = publish unless publish.nil?
  command.query['revert'] = revert unless revert.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#patch_post(blog_id, post_id, post_object = nil, fetch_body: nil, fetch_images: nil, max_comments: nil, publish: nil, revert: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BloggerV3::Post

Update a post. This method supports patch semantics.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
# File 'generated/google/apis/blogger_v3/service.rb', line 1278

def patch_post(blog_id, post_id, post_object = nil, fetch_body: nil, fetch_images: nil, max_comments: nil, publish: nil, revert: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'blogs/{blogId}/posts/{postId}', options)
  command.request_representation = Google::Apis::BloggerV3::Post::Representation
  command.request_object = post_object
  command.response_representation = Google::Apis::BloggerV3::Post::Representation
  command.response_class = Google::Apis::BloggerV3::Post
  command.params['blogId'] = blog_id unless blog_id.nil?
  command.params['postId'] = post_id unless post_id.nil?
  command.query['fetchBody'] = fetch_body unless fetch_body.nil?
  command.query['fetchImages'] = fetch_images unless fetch_images.nil?
  command.query['maxComments'] = max_comments unless max_comments.nil?
  command.query['publish'] = publish unless publish.nil?
  command.query['revert'] = revert unless revert.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#publish_page(blog_id, page_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BloggerV3::Page

Publishes a draft page.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


793
794
795
796
797
798
799
800
801
802
803
# File 'generated/google/apis/blogger_v3/service.rb', line 793

def publish_page(blog_id, page_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'blogs/{blogId}/pages/{pageId}/publish', options)
  command.response_representation = Google::Apis::BloggerV3::Page::Representation
  command.response_class = Google::Apis::BloggerV3::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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#publish_post(blog_id, post_id, publish_date: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BloggerV3::Post

Publishes a draft post, optionally at the specific time of the given publishDate parameter.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
# File 'generated/google/apis/blogger_v3/service.rb', line 1327

def publish_post(blog_id, post_id, publish_date: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'blogs/{blogId}/posts/{postId}/publish', options)
  command.response_representation = Google::Apis::BloggerV3::Post::Representation
  command.response_class = Google::Apis::BloggerV3::Post
  command.params['blogId'] = blog_id unless blog_id.nil?
  command.params['postId'] = post_id unless post_id.nil?
  command.query['publishDate'] = publish_date unless publish_date.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#remove_comment_content(blog_id, post_id, comment_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BloggerV3::Comment

Removes the content of a comment.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


515
516
517
518
519
520
521
522
523
524
525
526
# File 'generated/google/apis/blogger_v3/service.rb', line 515

def remove_comment_content(blog_id, post_id, comment_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'blogs/{blogId}/posts/{postId}/comments/{commentId}/removecontent', options)
  command.response_representation = Google::Apis::BloggerV3::Comment::Representation
  command.response_class = Google::Apis::BloggerV3::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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#revert_page(blog_id, page_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BloggerV3::Page

Revert a published or scheduled page to draft state.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


829
830
831
832
833
834
835
836
837
838
839
# File 'generated/google/apis/blogger_v3/service.rb', line 829

def revert_page(blog_id, page_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'blogs/{blogId}/pages/{pageId}/revert', options)
  command.response_representation = Google::Apis::BloggerV3::Page::Representation
  command.response_class = Google::Apis::BloggerV3::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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#revert_post(blog_id, post_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BloggerV3::Post

Revert a published or scheduled post to draft state.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
# File 'generated/google/apis/blogger_v3/service.rb', line 1364

def revert_post(blog_id, post_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'blogs/{blogId}/posts/{postId}/revert', options)
  command.response_representation = Google::Apis::BloggerV3::Post::Representation
  command.response_class = Google::Apis::BloggerV3::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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#search_posts(blog_id, q, fetch_bodies: nil, order_by: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BloggerV3::PostList

Search for a post.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
# File 'generated/google/apis/blogger_v3/service.rb', line 1405

def search_posts(blog_id, q, fetch_bodies: nil, order_by: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'blogs/{blogId}/posts/search', options)
  command.response_representation = Google::Apis::BloggerV3::PostList::Representation
  command.response_class = Google::Apis::BloggerV3::PostList
  command.params['blogId'] = blog_id unless blog_id.nil?
  command.query['fetchBodies'] = fetch_bodies unless fetch_bodies.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['q'] = q unless q.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#update_page(blog_id, page_id, page_object = nil, publish: nil, revert: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BloggerV3::Page

Update a page.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
# File 'generated/google/apis/blogger_v3/service.rb', line 872

def update_page(blog_id, page_id, page_object = nil, publish: nil, revert: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, 'blogs/{blogId}/pages/{pageId}', options)
  command.request_representation = Google::Apis::BloggerV3::Page::Representation
  command.request_object = page_object
  command.response_representation = Google::Apis::BloggerV3::Page::Representation
  command.response_class = Google::Apis::BloggerV3::Page
  command.params['blogId'] = blog_id unless blog_id.nil?
  command.params['pageId'] = page_id unless page_id.nil?
  command.query['publish'] = publish unless publish.nil?
  command.query['revert'] = revert unless revert.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#update_post(blog_id, post_id, post_object = nil, fetch_body: nil, fetch_images: nil, max_comments: nil, publish: nil, revert: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BloggerV3::Post

Update a post.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
# File 'generated/google/apis/blogger_v3/service.rb', line 1458

def update_post(blog_id, post_id, post_object = nil, fetch_body: nil, fetch_images: nil, max_comments: nil, publish: nil, revert: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, 'blogs/{blogId}/posts/{postId}', options)
  command.request_representation = Google::Apis::BloggerV3::Post::Representation
  command.request_object = post_object
  command.response_representation = Google::Apis::BloggerV3::Post::Representation
  command.response_class = Google::Apis::BloggerV3::Post
  command.params['blogId'] = blog_id unless blog_id.nil?
  command.params['postId'] = post_id unless post_id.nil?
  command.query['fetchBody'] = fetch_body unless fetch_body.nil?
  command.query['fetchImages'] = fetch_images unless fetch_images.nil?
  command.query['maxComments'] = max_comments unless max_comments.nil?
  command.query['publish'] = publish unless publish.nil?
  command.query['revert'] = revert unless revert.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end