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

#initialize ⇒ BloggerService

Returns a new instance of BloggerService.



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

#key ⇒ String

Returns 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.

Returns:

  • (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.



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

def key
  @key
end

#quota_user ⇒ String

Returns An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Returns:

  • (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.



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

def quota_user
  @quota_user
end

#user_ip ⇒ String

Returns Deprecated. Please use quotaUser instead.

Returns:

  • (String) —

    Deprecated. Please use quotaUser instead.



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.

Parameters:

  • blog_id (String) —

    The ID of the Blog.

  • post_id (String) —

    The ID of the Post.

  • comment_id (String) —

    The ID of the comment to mark as not spam.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

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.

Parameters:

  • blog_id (String) —

    The ID of the Blog.

  • post_id (String) —

    The ID of the Post.

  • comment_id (String) —

    The ID of the comment to delete.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

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.

Parameters:

  • blog_id (String) —

    The ID of the Blog.

  • page_id (String) —

    The ID of the Page.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

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.

Parameters:

  • blog_id (String) —

    The ID of the Blog.

  • post_id (String) —

    The ID of the Post.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

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.

Parameters:

  • blog_id (String) —

    The ID of the blog to get.

  • max_posts (Fixnum) (defaults to: nil) —

    Maximum number of posts to pull back with the blog.

  • view (String) (defaults to: nil) —

    Access level with which to view the blog. Note that some fields require elevated access.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

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.

Parameters:

  • url (String) —

    The URL of the blog to retrieve.

  • view (String) (defaults to: nil) —

    Access level with which to view the blog. Note that some fields require elevated access.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

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.

Parameters:

  • user_id (String) —

    ID of the user whose blogs are to be fetched. Either the word 'self' or the user's profile identifier.

  • blog_id (String) —

    The ID of the blog to get.

  • max_posts (Fixnum) (defaults to: nil) —

    Maximum number of posts to pull back with the blog.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

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.

Parameters:

  • blog_id (String) —

    ID of the blog to containing the comment.

  • post_id (String) —

    ID of the post to fetch posts from.

  • comment_id (String) —

    The ID of the comment to get.

  • view (String) (defaults to: nil) —

    Access level for the requested comment (default: READER). Note that some comments will require elevated permissions, for example comments where the parent posts which is in a draft state, or comments that are pending moderation.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

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.

Parameters:

  • blog_id (String) —

    ID of the blog containing the page.

  • page_id (String) —

    The ID of the page to get.

  • view (String) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

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.

Parameters:

  • blog_id (String) —

    The ID of the blog to get.

  • range (Array<String>, String) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

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.

Parameters:

  • blog_id (String) —

    ID of the blog to fetch the post from.

  • post_id (String) —

    The ID of the post

  • fetch_body (Boolean) (defaults to: nil) —

    Whether the body content of the post is included (default: true). This should be set to false when the post bodies are not required, to help minimize traffic.

  • fetch_images (Boolean) (defaults to: nil) —

    Whether image URL metadata for each post is included (default: false).

  • max_comments (Fixnum) (defaults to: nil) —

    Maximum number of comments to pull back on a post.

  • view (String) (defaults to: nil) —

    Access level with which to view the returned result. Note that some fields require elevated access.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

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.

Parameters:

  • blog_id (String) —

    ID of the blog to fetch the post from.

  • path (String) —

    Path of the Post to retrieve.

  • max_comments (Fixnum) (defaults to: nil) —

    Maximum number of comments to pull back on a post.

  • view (String) (defaults to: nil) —

    Access level with which to view the returned result. Note that some fields require elevated access.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

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.

Parameters:

  • user_id (String) —

    ID of the user for the per-user information to be fetched. Either the word ' self' or the user's profile identifier.

  • blog_id (String) —

    The ID of the blog.

  • post_id (String) —

    The ID of the post to get.

  • max_comments (Fixnum) (defaults to: nil) —

    Maximum number of comments to pull back on a post.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

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.

Parameters:

  • user_id (String) —

    The ID of the user to get.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

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.

Parameters:

  • blog_id (String) —

    ID of the blog to add the page to.

  • page_object (Google::Apis::BloggerV3::Page) (defaults to: nil)
  • is_draft (Boolean) (defaults to: nil) —

    Whether to create the page as a draft (default: false).

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

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.

Parameters:

  • blog_id (String) —

    ID of the blog to add the post to.

  • post_object (Google::Apis::BloggerV3::Post) (defaults to: nil)
  • fetch_body (Boolean) (defaults to: nil) —

    Whether the body content of the post is included with the result (default: true).

  • fetch_images (Boolean) (defaults to: nil) —

    Whether image URL metadata for each post is included in the returned result ( default: false).

  • is_draft (Boolean) (defaults to: nil) —

    Whether to create the post as a draft (default: false).

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

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.

Parameters:

  • user_id (String) —

    ID of the user whose blogs are to be fetched. Either the word 'self' or the user's profile identifier.

  • fetch_user_info (Boolean) (defaults to: nil) —

    Whether the response is a list of blogs with per-user information instead of just blogs.

  • role (Array<String>, String) (defaults to: nil) —

    User access types for blogs to include in the results, e.g. AUTHOR will return blogs where the user has author level access. If no roles are specified, defaults to ADMIN and AUTHOR roles.

  • status (Array<String>, String) (defaults to: nil) —

    Blog statuses to include in the result (default: Live blogs only). Note that ADMIN access is required to view deleted blogs.

  • view (String) (defaults to: nil) —

    Access level with which to view the blogs. Note that some fields require elevated access.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

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.

Parameters:

  • blog_id (String) —

    ID of the blog to fetch comments from.

  • post_id (String) —

    ID of the post to fetch posts from.

  • end_date (DateTime) (defaults to: nil) —

    Latest date of comment to fetch, a date-time with RFC 3339 formatting.

  • fetch_bodies (Boolean) (defaults to: nil) —

    Whether the body content of the comments is included.

  • max_results (Fixnum) (defaults to: nil) —

    Maximum number of comments to include in the result.

  • page_token (String) (defaults to: nil) —

    Continuation token if request is paged.

  • start_date (DateTime) (defaults to: nil) —

    Earliest date of comment to fetch, a date-time with RFC 3339 formatting.

  • status (Array<String>, String) (defaults to: nil)
  • view (String) (defaults to: nil) —

    Access level with which to view the returned result. Note that some fields require elevated access.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

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.

Parameters:

  • blog_id (String) —

    ID of the blog to fetch comments from.

  • end_date (DateTime) (defaults to: nil) —

    Latest date of comment to fetch, a date-time with RFC 3339 formatting.

  • fetch_bodies (Boolean) (defaults to: nil) —

    Whether the body content of the comments is included.

  • max_results (Fixnum) (defaults to: nil) —

    Maximum number of comments to include in the result.

  • page_token (String) (defaults to: nil) —

    Continuation token if request is paged.

  • start_date (DateTime) (defaults to: nil) —

    Earliest date of comment to fetch, a date-time with RFC 3339 formatting.

  • status (Array<String>, String) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

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.

Parameters:

  • blog_id (String) —

    ID of the blog to fetch Pages from.

  • fetch_bodies (Boolean) (defaults to: nil) —

    Whether to retrieve the Page bodies.

  • max_results (Fixnum) (defaults to: nil) —

    Maximum number of Pages to fetch.

  • page_token (String) (defaults to: nil) —

    Continuation token if the request is paged.

  • status (Array<String>, String) (defaults to: nil)
  • view (String) (defaults to: nil) —

    Access level with which to view the returned result. Note that some fields require elevated access.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

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.

Parameters:

  • user_id (String) —

    ID of the user for the per-user information to be fetched. Either the word ' self' or the user's profile identifier.

  • blog_id (String) —

    ID of the blog to fetch posts from.

  • end_date (DateTime) (defaults to: nil) —

    Latest post date to fetch, a date-time with RFC 3339 formatting.

  • fetch_bodies (Boolean) (defaults to: nil) —

    Whether the body content of posts is included. Default is false.

  • labels (String) (defaults to: nil) —

    Comma-separated list of labels to search for.

  • max_results (Fixnum) (defaults to: nil) —

    Maximum number of posts to fetch.

  • order_by (String) (defaults to: nil) —

    Sort order applied to search results. Default is published.

  • page_token (String) (defaults to: nil) —

    Continuation token if the request is paged.

  • start_date (DateTime) (defaults to: nil) —

    Earliest post date to fetch, a date-time with RFC 3339 formatting.

  • status (Array<String>, String) (defaults to: nil)
  • view (String) (defaults to: nil) —

    Access level with which to view the returned result. Note that some fields require elevated access.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

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.

Parameters:

  • blog_id (String) —

    ID of the blog to fetch posts from.

  • end_date (DateTime) (defaults to: nil) —

    Latest post date to fetch, a date-time with RFC 3339 formatting.

  • fetch_bodies (Boolean) (defaults to: nil) —

    Whether the body content of posts is included (default: true). This should be set to false when the post bodies are not required, to help minimize traffic.

  • fetch_images (Boolean) (defaults to: nil) —

    Whether image URL metadata for each post is included.

  • labels (String) (defaults to: nil) —

    Comma-separated list of labels to search for.

  • max_results (Fixnum) (defaults to: nil) —

    Maximum number of posts to fetch.

  • order_by (String) (defaults to: nil) —

    Sort search results

  • page_token (String) (defaults to: nil) —

    Continuation token if the request is paged.

  • start_date (DateTime) (defaults to: nil) —

    Earliest post date to fetch, a date-time with RFC 3339 formatting.

  • status (Array<String>, String) (defaults to: nil) —

    Statuses to include in the results.

  • view (String) (defaults to: nil) —

    Access level with which to view the returned result. Note that some fields require escalated access.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

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.

Parameters:

  • blog_id (String) —

    The ID of the Blog.

  • post_id (String) —

    The ID of the Post.

  • comment_id (String) —

    The ID of the comment to mark as spam.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

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.

Parameters:

  • blog_id (String) —

    The ID of the Blog.

  • page_id (String) —

    The ID of the Page.

  • page_object (Google::Apis::BloggerV3::Page) (defaults to: nil)
  • publish (Boolean) (defaults to: nil) —

    Whether a publish action should be performed when the page is updated (default: false).

  • revert (Boolean) (defaults to: nil) —

    Whether a revert action should be performed when the page is updated (default: false).

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

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.

Parameters:

  • blog_id (String) —

    The ID of the Blog.

  • post_id (String) —

    The ID of the Post.

  • post_object (Google::Apis::BloggerV3::Post) (defaults to: nil)
  • fetch_body (Boolean) (defaults to: nil) —

    Whether the body content of the post is included with the result (default: true).

  • fetch_images (Boolean) (defaults to: nil) —

    Whether image URL metadata for each post is included in the returned result ( default: false).

  • max_comments (Fixnum) (defaults to: nil) —

    Maximum number of comments to retrieve with the returned post.

  • publish (Boolean) (defaults to: nil) —

    Whether a publish action should be performed when the post is updated (default: false).

  • revert (Boolean) (defaults to: nil) —

    Whether a revert action should be performed when the post is updated (default: false).

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

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.

Parameters:

  • blog_id (String) —

    The ID of the blog.

  • page_id (String) —

    The ID of the page.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

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.

Parameters:

  • blog_id (String) —

    The ID of the Blog.

  • post_id (String) —

    The ID of the Post.

  • publish_date (DateTime) (defaults to: nil) —

    Optional date and time to schedule the publishing of the Blog. If no publishDate parameter is given, the post is either published at the a previously saved schedule date (if present), or the current time. If a future date is given, the post will be scheduled to be published.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

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.

Parameters:

  • blog_id (String) —

    The ID of the Blog.

  • post_id (String) —

    The ID of the Post.

  • comment_id (String) —

    The ID of the comment to delete content from.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

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.

Parameters:

  • blog_id (String) —

    The ID of the blog.

  • page_id (String) —

    The ID of the page.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

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.

Parameters:

  • blog_id (String) —

    The ID of the Blog.

  • post_id (String) —

    The ID of the Post.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

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.

Parameters:

  • blog_id (String) —

    ID of the blog to fetch the post from.

  • q (String) —

    Query terms to search this blog for matching posts.

  • fetch_bodies (Boolean) (defaults to: nil) —

    Whether the body content of posts is included (default: true). This should be set to false when the post bodies are not required, to help minimize traffic.

  • order_by (String) (defaults to: nil) —

    Sort search results

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

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.

Parameters:

  • blog_id (String) —

    The ID of the Blog.

  • page_id (String) —

    The ID of the Page.

  • page_object (Google::Apis::BloggerV3::Page) (defaults to: nil)
  • publish (Boolean) (defaults to: nil) —

    Whether a publish action should be performed when the page is updated (default: false).

  • revert (Boolean) (defaults to: nil) —

    Whether a revert action should be performed when the page is updated (default: false).

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

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.

Parameters:

  • blog_id (String) —

    The ID of the Blog.

  • post_id (String) —

    The ID of the Post.

  • post_object (Google::Apis::BloggerV3::Post) (defaults to: nil)
  • fetch_body (Boolean) (defaults to: nil) —

    Whether the body content of the post is included with the result (default: true).

  • fetch_images (Boolean) (defaults to: nil) —

    Whether image URL metadata for each post is included in the returned result ( default: false).

  • max_comments (Fixnum) (defaults to: nil) —

    Maximum number of comments to retrieve with the returned post.

  • publish (Boolean) (defaults to: nil) —

    Whether a publish action should be performed when the post is updated (default: false).

  • revert (Boolean) (defaults to: nil) —

    Whether a revert action should be performed when the post is updated (default: false).

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

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