google-apis-webmasters_v3 0.1.0

data/lib/google/apis/webmasters_v3/gem_version.rb

@@ -0,0 +1,28 @@
+# Copyright 2020 Google LLC
+#
+# 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.
+
+module Google
+  module Apis
+    module WebmastersV3
+      # Version of the google-apis-webmasters_v3 gem
+      GEM_VERSION = "0.1.0"
+
+      # Version of the code generator used to generate this client
+      GENERATOR_VERSION = "0.1.1"
+
+      # Revision of the discovery document this client was generated from
+      REVISION = "20190428"
+    end
+  end
+end

data/lib/google/apis/webmasters_v3/representations.rb

@@ -0,0 +1,191 @@
+# Copyright 2020 Google LLC
+#
+# 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 'date'
+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 WebmastersV3
+      
+      class ApiDataRow
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class ApiDimensionFilter
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class ApiDimensionFilterGroup
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class SearchAnalyticsQueryRequest
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class SearchAnalyticsQueryResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class ListSitemapsResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class ListSitesResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class WmxSite
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class WmxSitemap
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class WmxSitemapContent
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class ApiDataRow
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :clicks, as: 'clicks'
+          property :ctr, as: 'ctr'
+          property :impressions, as: 'impressions'
+          collection :keys, as: 'keys'
+          property :position, as: 'position'
+        end
+      end
+      
+      class ApiDimensionFilter
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :dimension, as: 'dimension'
+          property :expression, as: 'expression'
+          property :operator, as: 'operator'
+        end
+      end
+      
+      class ApiDimensionFilterGroup
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :filters, as: 'filters', class: Google::Apis::WebmastersV3::ApiDimensionFilter, decorator: Google::Apis::WebmastersV3::ApiDimensionFilter::Representation
+      
+          property :group_type, as: 'groupType'
+        end
+      end
+      
+      class SearchAnalyticsQueryRequest
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :aggregation_type, as: 'aggregationType'
+          property :data_state, as: 'dataState'
+          collection :dimension_filter_groups, as: 'dimensionFilterGroups', class: Google::Apis::WebmastersV3::ApiDimensionFilterGroup, decorator: Google::Apis::WebmastersV3::ApiDimensionFilterGroup::Representation
+      
+          collection :dimensions, as: 'dimensions'
+          property :end_date, as: 'endDate'
+          property :row_limit, as: 'rowLimit'
+          property :search_type, as: 'searchType'
+          property :start_date, as: 'startDate'
+          property :start_row, as: 'startRow'
+        end
+      end
+      
+      class SearchAnalyticsQueryResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :response_aggregation_type, as: 'responseAggregationType'
+          collection :rows, as: 'rows', class: Google::Apis::WebmastersV3::ApiDataRow, decorator: Google::Apis::WebmastersV3::ApiDataRow::Representation
+      
+        end
+      end
+      
+      class ListSitemapsResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :sitemap, as: 'sitemap', class: Google::Apis::WebmastersV3::WmxSitemap, decorator: Google::Apis::WebmastersV3::WmxSitemap::Representation
+      
+        end
+      end
+      
+      class ListSitesResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :site_entry, as: 'siteEntry', class: Google::Apis::WebmastersV3::WmxSite, decorator: Google::Apis::WebmastersV3::WmxSite::Representation
+      
+        end
+      end
+      
+      class WmxSite
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :permission_level, as: 'permissionLevel'
+          property :site_url, as: 'siteUrl'
+        end
+      end
+      
+      class WmxSitemap
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :contents, as: 'contents', class: Google::Apis::WebmastersV3::WmxSitemapContent, decorator: Google::Apis::WebmastersV3::WmxSitemapContent::Representation
+      
+          property :errors, :numeric_string => true, as: 'errors'
+          property :is_pending, as: 'isPending'
+          property :is_sitemaps_index, as: 'isSitemapsIndex'
+          property :last_downloaded, as: 'lastDownloaded', type: DateTime
+      
+          property :last_submitted, as: 'lastSubmitted', type: DateTime
+      
+          property :path, as: 'path'
+          property :type, as: 'type'
+          property :warnings, :numeric_string => true, as: 'warnings'
+        end
+      end
+      
+      class WmxSitemapContent
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :indexed, :numeric_string => true, as: 'indexed'
+          property :submitted, :numeric_string => true, as: 'submitted'
+          property :type, as: 'type'
+        end
+      end
+    end
+  end
+end

data/lib/google/apis/webmasters_v3/service.rb

@@ -0,0 +1,379 @@
+# Copyright 2020 Google LLC
+#
+# 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 WebmastersV3
+      # Search Console API
+      #
+      # View Google Search Console data for your verified sites.
+      #
+      # @example
+      #    require 'google/apis/webmasters_v3'
+      #
+      #    Webmasters = Google::Apis::WebmastersV3 # Alias the module
+      #    service = Webmasters::WebmastersService.new
+      #
+      # @see https://developers.google.com/webmaster-tools/
+      class WebmastersService < 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]
+        #  An opaque string that represents a user for quota purposes. Must not exceed 40
+        #  characters.
+        attr_accessor :quota_user
+
+        # @return [String]
+        #  Deprecated. Please use quotaUser instead.
+        attr_accessor :user_ip
+
+        def initialize
+          super('https://www.googleapis.com/', 'webmasters/v3/',
+                client_name: 'google-apis-webmasters_v3',
+                client_version: Google::Apis::WebmastersV3::GEM_VERSION)
+          @batch_path = 'batch/webmasters/v3'
+        end
+        
+        # Query your data with filters and parameters that you define. Returns zero or
+        # more rows grouped by the row keys that you define. You must define a date
+        # range of one or more days.
+        # When date is one of the group by values, any days without data are omitted
+        # from the result list. If you need to know which days have data, issue a broad
+        # date range query grouped by date for any metric, and see which day rows are
+        # returned.
+        # @param [String] site_url
+        #   The site's URL, including protocol. For example: http://www.example.com/
+        # @param [Google::Apis::WebmastersV3::SearchAnalyticsQueryRequest] search_analytics_query_request_object
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   An opaque string that represents a user for quota purposes. Must not exceed 40
+        #   characters.
+        # @param [String] user_ip
+        #   Deprecated. Please use quotaUser instead.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::WebmastersV3::SearchAnalyticsQueryResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::WebmastersV3::SearchAnalyticsQueryResponse]
+        #
+        # @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 query_search_analytics(site_url, search_analytics_query_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
+          command = make_simple_command(:post, 'sites/{siteUrl}/searchAnalytics/query', options)
+          command.request_representation = Google::Apis::WebmastersV3::SearchAnalyticsQueryRequest::Representation
+          command.request_object = search_analytics_query_request_object
+          command.response_representation = Google::Apis::WebmastersV3::SearchAnalyticsQueryResponse::Representation
+          command.response_class = Google::Apis::WebmastersV3::SearchAnalyticsQueryResponse
+          command.params['siteUrl'] = site_url unless site_url.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
+        
+        # Deletes a sitemap from this site.
+        # @param [String] site_url
+        #   The site's URL, including protocol. For example: http://www.example.com/
+        # @param [String] feedpath
+        #   The URL of the actual sitemap. For example: http://www.example.com/sitemap.xml
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   An opaque string that represents a user for quota purposes. Must not exceed 40
+        #   characters.
+        # @param [String] user_ip
+        #   Deprecated. Please use quotaUser instead.
+        # @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 delete_sitemap(site_url, feedpath, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
+          command = make_simple_command(:delete, 'sites/{siteUrl}/sitemaps/{feedpath}', options)
+          command.params['siteUrl'] = site_url unless site_url.nil?
+          command.params['feedpath'] = feedpath unless feedpath.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
+        
+        # Retrieves information about a specific sitemap.
+        # @param [String] site_url
+        #   The site's URL, including protocol. For example: http://www.example.com/
+        # @param [String] feedpath
+        #   The URL of the actual sitemap. For example: http://www.example.com/sitemap.xml
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   An opaque string that represents a user for quota purposes. Must not exceed 40
+        #   characters.
+        # @param [String] user_ip
+        #   Deprecated. Please use quotaUser instead.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::WebmastersV3::WmxSitemap] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::WebmastersV3::WmxSitemap]
+        #
+        # @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_sitemap(site_url, feedpath, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
+          command = make_simple_command(:get, 'sites/{siteUrl}/sitemaps/{feedpath}', options)
+          command.response_representation = Google::Apis::WebmastersV3::WmxSitemap::Representation
+          command.response_class = Google::Apis::WebmastersV3::WmxSitemap
+          command.params['siteUrl'] = site_url unless site_url.nil?
+          command.params['feedpath'] = feedpath unless feedpath.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
+        
+        # Lists the sitemaps-entries submitted for this site, or included in the sitemap
+        # index file (if sitemapIndex is specified in the request).
+        # @param [String] site_url
+        #   The site's URL, including protocol. For example: http://www.example.com/
+        # @param [String] sitemap_index
+        #   A URL of a site's sitemap index. For example: http://www.example.com/
+        #   sitemapindex.xml
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   An opaque string that represents a user for quota purposes. Must not exceed 40
+        #   characters.
+        # @param [String] user_ip
+        #   Deprecated. Please use quotaUser instead.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::WebmastersV3::ListSitemapsResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::WebmastersV3::ListSitemapsResponse]
+        #
+        # @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_sitemaps(site_url, sitemap_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
+          command = make_simple_command(:get, 'sites/{siteUrl}/sitemaps', options)
+          command.response_representation = Google::Apis::WebmastersV3::ListSitemapsResponse::Representation
+          command.response_class = Google::Apis::WebmastersV3::ListSitemapsResponse
+          command.params['siteUrl'] = site_url unless site_url.nil?
+          command.query['sitemapIndex'] = sitemap_index unless sitemap_index.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
+        
+        # Submits a sitemap for a site.
+        # @param [String] site_url
+        #   The site's URL, including protocol. For example: http://www.example.com/
+        # @param [String] feedpath
+        #   The URL of the sitemap to add. For example: http://www.example.com/sitemap.xml
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   An opaque string that represents a user for quota purposes. Must not exceed 40
+        #   characters.
+        # @param [String] user_ip
+        #   Deprecated. Please use quotaUser instead.
+        # @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 submit_sitemap(site_url, feedpath, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
+          command = make_simple_command(:put, 'sites/{siteUrl}/sitemaps/{feedpath}', options)
+          command.params['siteUrl'] = site_url unless site_url.nil?
+          command.params['feedpath'] = feedpath unless feedpath.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
+        
+        # Adds a site to the set of the user's sites in Search Console.
+        # @param [String] site_url
+        #   The URL of the site to add.
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   An opaque string that represents a user for quota purposes. Must not exceed 40
+        #   characters.
+        # @param [String] user_ip
+        #   Deprecated. Please use quotaUser instead.
+        # @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 add_site(site_url, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
+          command = make_simple_command(:put, 'sites/{siteUrl}', options)
+          command.params['siteUrl'] = site_url unless site_url.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
+        
+        # Removes a site from the set of the user's Search Console sites.
+        # @param [String] site_url
+        #   The URI of the property as defined in Search Console. Examples: http://www.
+        #   example.com/ or android-app://com.example/ Note: for property-sets, use the
+        #   URI that starts with sc-set: which is used in Search Console URLs.
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   An opaque string that represents a user for quota purposes. Must not exceed 40
+        #   characters.
+        # @param [String] user_ip
+        #   Deprecated. Please use quotaUser instead.
+        # @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 delete_site(site_url, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
+          command = make_simple_command(:delete, 'sites/{siteUrl}', options)
+          command.params['siteUrl'] = site_url unless site_url.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
+        
+        # Retrieves information about specific site.
+        # @param [String] site_url
+        #   The URI of the property as defined in Search Console. Examples: http://www.
+        #   example.com/ or android-app://com.example/ Note: for property-sets, use the
+        #   URI that starts with sc-set: which is used in Search Console URLs.
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   An opaque string that represents a user for quota purposes. Must not exceed 40
+        #   characters.
+        # @param [String] user_ip
+        #   Deprecated. Please use quotaUser instead.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::WebmastersV3::WmxSite] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::WebmastersV3::WmxSite]
+        #
+        # @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_site(site_url, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
+          command = make_simple_command(:get, 'sites/{siteUrl}', options)
+          command.response_representation = Google::Apis::WebmastersV3::WmxSite::Representation
+          command.response_class = Google::Apis::WebmastersV3::WmxSite
+          command.params['siteUrl'] = site_url unless site_url.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
+        
+        # Lists the user's Search Console sites.
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   An opaque string that represents a user for quota purposes. Must not exceed 40
+        #   characters.
+        # @param [String] user_ip
+        #   Deprecated. Please use quotaUser instead.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::WebmastersV3::ListSitesResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::WebmastersV3::ListSitesResponse]
+        #
+        # @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_sites(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
+          command = make_simple_command(:get, 'sites', options)
+          command.response_representation = Google::Apis::WebmastersV3::ListSitesResponse::Representation
+          command.response_class = Google::Apis::WebmastersV3::ListSitesResponse
+          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