# Copyright 2015 Google Inc. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. require 'google/apis/core/base_service' require 'google/apis/core/json_representation' require 'google/apis/core/hashable' require 'google/apis/errors' module Google module Apis module PlusDomainsV1 # Google+ Domains API # # The Google+ API enables developers to build on top of the Google+ platform. # # @example # require 'google/apis/plus_domains_v1' # # PlusDomains = Google::Apis::PlusDomainsV1 # Alias the module # service = PlusDomains::PlusDomainsService.new # # @see https://developers.google.com/+/domains/ class PlusDomainsService < Google::Apis::Core::BaseService # @return [String] # API key. Your API key identifies your project and provides you with API access, # quota, and reports. Required unless you provide an OAuth 2.0 token. attr_accessor :key # @return [String] # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. attr_accessor :quota_user # @return [String] # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. attr_accessor :user_ip def initialize super('https://www.googleapis.com/', 'plusDomains/v1/') end # Get an activity. # @param [String] activity_id # The ID of the activity to get. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::PlusDomainsV1::Activity] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::PlusDomainsV1::Activity] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def get_activity(activity_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'activities/{activityId}', options) command.response_representation = Google::Apis::PlusDomainsV1::Activity::Representation command.response_class = Google::Apis::PlusDomainsV1::Activity command.params['activityId'] = activity_id unless activity_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 # Create a new activity for the authenticated user. # @param [String] user_id # The ID of the user to create the activity on behalf of. Its value should be " # me", to indicate the authenticated user. # @param [Google::Apis::PlusDomainsV1::Activity] activity_object # @param [Boolean] preview # If "true", extract the potential media attachments for a URL. The response # will include all possible attachments for a URL, including video, photos, and # articles based on the content of the page. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::PlusDomainsV1::Activity] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::PlusDomainsV1::Activity] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def insert_activity(user_id, activity_object = nil, preview: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'people/{userId}/activities', options) command.request_representation = Google::Apis::PlusDomainsV1::Activity::Representation command.request_object = activity_object command.response_representation = Google::Apis::PlusDomainsV1::Activity::Representation command.response_class = Google::Apis::PlusDomainsV1::Activity command.params['userId'] = user_id unless user_id.nil? command.query['preview'] = preview unless preview.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 all of the activities in the specified collection for a particular user. # @param [String] user_id # The ID of the user to get activities for. The special value "me" can be used # to indicate the authenticated user. # @param [String] collection # The collection of activities to list. # @param [Fixnum] max_results # The maximum number of activities to include in the response, which is used for # paging. For any response, the actual number returned might be less than the # specified maxResults. # @param [String] page_token # The continuation token, which is used to page through large result sets. To # get the next page of results, set this parameter to the value of " # nextPageToken" from the previous response. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::PlusDomainsV1::ActivityFeed] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::PlusDomainsV1::ActivityFeed] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def list_activities(user_id, collection, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'people/{userId}/activities/{collection}', options) command.response_representation = Google::Apis::PlusDomainsV1::ActivityFeed::Representation command.response_class = Google::Apis::PlusDomainsV1::ActivityFeed command.params['userId'] = user_id unless user_id.nil? command.params['collection'] = collection unless collection.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.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 all of the audiences to which a user can share. # @param [String] user_id # The ID of the user to get audiences for. The special value "me" can be used to # indicate the authenticated user. # @param [Fixnum] max_results # The maximum number of circles to include in the response, which is used for # paging. For any response, the actual number returned might be less than the # specified maxResults. # @param [String] page_token # The continuation token, which is used to page through large result sets. To # get the next page of results, set this parameter to the value of " # nextPageToken" from the previous response. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::PlusDomainsV1::AudiencesFeed] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::PlusDomainsV1::AudiencesFeed] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def list_audiences(user_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'people/{userId}/audiences', options) command.response_representation = Google::Apis::PlusDomainsV1::AudiencesFeed::Representation command.response_class = Google::Apis::PlusDomainsV1::AudiencesFeed command.params['userId'] = user_id unless user_id.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.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 # Add a person to a circle. Google+ limits certain circle operations, including # the number of circle adds. Learn More. # @param [String] circle_id # The ID of the circle to add the person to. # @param [Array, String] email # Email of the people to add to the circle. Optional, can be repeated. # @param [Array, String] user_id # IDs of the people to add to the circle. Optional, can be repeated. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::PlusDomainsV1::Circle] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::PlusDomainsV1::Circle] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def add_people(circle_id, email: nil, user_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'circles/{circleId}/people', options) command.response_representation = Google::Apis::PlusDomainsV1::Circle::Representation command.response_class = Google::Apis::PlusDomainsV1::Circle command.params['circleId'] = circle_id unless circle_id.nil? command.query['email'] = email unless email.nil? command.query['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 # Get a circle. # @param [String] circle_id # The ID of the circle to get. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::PlusDomainsV1::Circle] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::PlusDomainsV1::Circle] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def get_circle(circle_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'circles/{circleId}', options) command.response_representation = Google::Apis::PlusDomainsV1::Circle::Representation command.response_class = Google::Apis::PlusDomainsV1::Circle command.params['circleId'] = circle_id unless circle_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 # Create a new circle for the authenticated user. # @param [String] user_id # The ID of the user to create the circle on behalf of. The value "me" can be # used to indicate the authenticated user. # @param [Google::Apis::PlusDomainsV1::Circle] circle_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::PlusDomainsV1::Circle] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::PlusDomainsV1::Circle] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def insert_circle(user_id, circle_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'people/{userId}/circles', options) command.request_representation = Google::Apis::PlusDomainsV1::Circle::Representation command.request_object = circle_object command.response_representation = Google::Apis::PlusDomainsV1::Circle::Representation command.response_class = Google::Apis::PlusDomainsV1::Circle 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 # List all of the circles for a user. # @param [String] user_id # The ID of the user to get circles for. The special value "me" can be used to # indicate the authenticated user. # @param [Fixnum] max_results # The maximum number of circles to include in the response, which is used for # paging. For any response, the actual number returned might be less than the # specified maxResults. # @param [String] page_token # The continuation token, which is used to page through large result sets. To # get the next page of results, set this parameter to the value of " # nextPageToken" from the previous response. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::PlusDomainsV1::CircleFeed] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::PlusDomainsV1::CircleFeed] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def list_circles(user_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'people/{userId}/circles', options) command.response_representation = Google::Apis::PlusDomainsV1::CircleFeed::Representation command.response_class = Google::Apis::PlusDomainsV1::CircleFeed command.params['userId'] = user_id unless user_id.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.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 a circle's description. This method supports patch semantics. # @param [String] circle_id # The ID of the circle to update. # @param [Google::Apis::PlusDomainsV1::Circle] circle_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::PlusDomainsV1::Circle] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::PlusDomainsV1::Circle] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def patch_circle(circle_id, circle_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'circles/{circleId}', options) command.request_representation = Google::Apis::PlusDomainsV1::Circle::Representation command.request_object = circle_object command.response_representation = Google::Apis::PlusDomainsV1::Circle::Representation command.response_class = Google::Apis::PlusDomainsV1::Circle command.params['circleId'] = circle_id unless circle_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 a circle. # @param [String] circle_id # The ID of the circle to delete. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [NilClass] No result returned for this method # @yieldparam err [StandardError] error object if request failed # # @return [void] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def remove_circle(circle_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'circles/{circleId}', options) command.params['circleId'] = circle_id unless circle_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 # Remove a person from a circle. # @param [String] circle_id # The ID of the circle to remove the person from. # @param [Array, String] email # Email of the people to add to the circle. Optional, can be repeated. # @param [Array, String] user_id # IDs of the people to remove from the circle. Optional, can be repeated. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [NilClass] No result returned for this method # @yieldparam err [StandardError] error object if request failed # # @return [void] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def remove_people(circle_id, email: nil, user_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'circles/{circleId}/people', options) command.params['circleId'] = circle_id unless circle_id.nil? command.query['email'] = email unless email.nil? command.query['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 # Update a circle's description. # @param [String] circle_id # The ID of the circle to update. # @param [Google::Apis::PlusDomainsV1::Circle] circle_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::PlusDomainsV1::Circle] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::PlusDomainsV1::Circle] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def update_circle(circle_id, circle_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'circles/{circleId}', options) command.request_representation = Google::Apis::PlusDomainsV1::Circle::Representation command.request_object = circle_object command.response_representation = Google::Apis::PlusDomainsV1::Circle::Representation command.response_class = Google::Apis::PlusDomainsV1::Circle command.params['circleId'] = circle_id unless circle_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 a comment. # @param [String] comment_id # The ID of the comment to get. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::PlusDomainsV1::Comment] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::PlusDomainsV1::Comment] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def get_comment(comment_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'comments/{commentId}', options) command.response_representation = Google::Apis::PlusDomainsV1::Comment::Representation command.response_class = Google::Apis::PlusDomainsV1::Comment 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 # Create a new comment in reply to an activity. # @param [String] activity_id # The ID of the activity to reply to. # @param [Google::Apis::PlusDomainsV1::Comment] comment_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::PlusDomainsV1::Comment] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::PlusDomainsV1::Comment] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def insert_comment(activity_id, comment_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'activities/{activityId}/comments', options) command.request_representation = Google::Apis::PlusDomainsV1::Comment::Representation command.request_object = comment_object command.response_representation = Google::Apis::PlusDomainsV1::Comment::Representation command.response_class = Google::Apis::PlusDomainsV1::Comment command.params['activityId'] = activity_id unless activity_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 # List all of the comments for an activity. # @param [String] activity_id # The ID of the activity to get comments for. # @param [Fixnum] max_results # The maximum number of comments to include in the response, which is used for # paging. For any response, the actual number returned might be less than the # specified maxResults. # @param [String] page_token # The continuation token, which is used to page through large result sets. To # get the next page of results, set this parameter to the value of " # nextPageToken" from the previous response. # @param [String] sort_order # The order in which to sort the list of comments. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::PlusDomainsV1::CommentFeed] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::PlusDomainsV1::CommentFeed] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def list_comments(activity_id, max_results: nil, page_token: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'activities/{activityId}/comments', options) command.response_representation = Google::Apis::PlusDomainsV1::CommentFeed::Representation command.response_class = Google::Apis::PlusDomainsV1::CommentFeed command.params['activityId'] = activity_id unless activity_id.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['sortOrder'] = sort_order unless sort_order.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 # Add a new media item to an album. The current upload size limitations are 36MB # for a photo and 1GB for a video. Uploads do not count against quota if photos # are less than 2048 pixels on their longest side or videos are less than 15 # minutes in length. # @param [String] user_id # The ID of the user to create the activity on behalf of. # @param [String] collection # @param [Google::Apis::PlusDomainsV1::Media] media_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [IO, String] upload_source # IO stream or filename containing content to upload # @param [String] content_type # Content type of the uploaded content. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::PlusDomainsV1::Media] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::PlusDomainsV1::Media] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def insert_medium(user_id, collection, media_object = nil, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil, &block) if upload_source.nil? command = make_simple_command(:post, 'people/{userId}/media/{collection}', options) else command = make_upload_command(:post, 'people/{userId}/media/{collection}', options) command.upload_source = upload_source command.upload_content_type = content_type end command.request_representation = Google::Apis::PlusDomainsV1::Media::Representation command.request_object = media_object command.response_representation = Google::Apis::PlusDomainsV1::Media::Representation command.response_class = Google::Apis::PlusDomainsV1::Media command.params['userId'] = user_id unless user_id.nil? command.params['collection'] = collection unless collection.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 a person's profile. # @param [String] user_id # The ID of the person to get the profile for. The special value "me" can be # used to indicate the authenticated user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::PlusDomainsV1::Person] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::PlusDomainsV1::Person] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def get_person(user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'people/{userId}', options) command.response_representation = Google::Apis::PlusDomainsV1::Person::Representation command.response_class = Google::Apis::PlusDomainsV1::Person 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 # List all of the people in the specified collection. # @param [String] user_id # Get the collection of people for the person identified. Use "me" to indicate # the authenticated user. # @param [String] collection # The collection of people to list. # @param [Fixnum] max_results # The maximum number of people to include in the response, which is used for # paging. For any response, the actual number returned might be less than the # specified maxResults. # @param [String] order_by # The order to return people in. # @param [String] page_token # The continuation token, which is used to page through large result sets. To # get the next page of results, set this parameter to the value of " # nextPageToken" from the previous response. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::PlusDomainsV1::PeopleFeed] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::PlusDomainsV1::PeopleFeed] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def list_people(user_id, collection, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'people/{userId}/people/{collection}', options) command.response_representation = Google::Apis::PlusDomainsV1::PeopleFeed::Representation command.response_class = Google::Apis::PlusDomainsV1::PeopleFeed command.params['userId'] = user_id unless user_id.nil? command.params['collection'] = collection unless collection.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['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 all of the people in the specified collection for a particular activity. # @param [String] activity_id # The ID of the activity to get the list of people for. # @param [String] collection # The collection of people to list. # @param [Fixnum] max_results # The maximum number of people to include in the response, which is used for # paging. For any response, the actual number returned might be less than the # specified maxResults. # @param [String] page_token # The continuation token, which is used to page through large result sets. To # get the next page of results, set this parameter to the value of " # nextPageToken" from the previous response. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::PlusDomainsV1::PeopleFeed] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::PlusDomainsV1::PeopleFeed] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def list_people_by_activity(activity_id, collection, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'activities/{activityId}/people/{collection}', options) command.response_representation = Google::Apis::PlusDomainsV1::PeopleFeed::Representation command.response_class = Google::Apis::PlusDomainsV1::PeopleFeed command.params['activityId'] = activity_id unless activity_id.nil? command.params['collection'] = collection unless collection.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.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 all of the people who are members of a circle. # @param [String] circle_id # The ID of the circle to get the members of. # @param [Fixnum] max_results # The maximum number of people to include in the response, which is used for # paging. For any response, the actual number returned might be less than the # specified maxResults. # @param [String] page_token # The continuation token, which is used to page through large result sets. To # get the next page of results, set this parameter to the value of " # nextPageToken" from the previous response. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::PlusDomainsV1::PeopleFeed] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::PlusDomainsV1::PeopleFeed] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def list_people_by_circle(circle_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'circles/{circleId}/people', options) command.response_representation = Google::Apis::PlusDomainsV1::PeopleFeed::Representation command.response_class = Google::Apis::PlusDomainsV1::PeopleFeed command.params['circleId'] = circle_id unless circle_id.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.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 protected def apply_command_defaults(command) command.query['key'] = key unless key.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? end end end end end