google-api-client 0.8.6 → 0.9

data/generated/google/apis/webmasters_v3.rb

@@ -0,0 +1,37 @@
+# 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/webmasters_v3/service.rb'
+require 'google/apis/webmasters_v3/classes.rb'
+require 'google/apis/webmasters_v3/representations.rb'
+
+module Google
+  module Apis
+    # Search Console API
+    #
+    # Lets you view Google Search Console data for your verified sites.
+    #
+    # @see https://developers.google.com/webmaster-tools/
+    module WebmastersV3
+      VERSION = 'V3'
+      REVISION = '20151229'
+
+      # View and manage Search Console data for your verified sites
+      AUTH_WEBMASTERS = 'https://www.googleapis.com/auth/webmasters'
+
+      # View Search Console data for your verified sites
+      AUTH_WEBMASTERS_READONLY = 'https://www.googleapis.com/auth/webmasters.readonly'
+    end
+  end
+end

data/generated/google/apis/webmasters_v3/classes.rb

@@ -0,0 +1,563 @@
+# 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 '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
+        include Google::Apis::Core::Hashable
+      
+        # 
+        # Corresponds to the JSON property `clicks`
+        # @return [Float]
+        attr_accessor :clicks
+      
+        # 
+        # Corresponds to the JSON property `ctr`
+        # @return [Float]
+        attr_accessor :ctr
+      
+        # 
+        # Corresponds to the JSON property `impressions`
+        # @return [Float]
+        attr_accessor :impressions
+      
+        # 
+        # Corresponds to the JSON property `keys`
+        # @return [Array<String>]
+        attr_accessor :keys
+      
+        # 
+        # Corresponds to the JSON property `position`
+        # @return [Float]
+        attr_accessor :position
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @clicks = args[:clicks] unless args[:clicks].nil?
+          @ctr = args[:ctr] unless args[:ctr].nil?
+          @impressions = args[:impressions] unless args[:impressions].nil?
+          @keys = args[:keys] unless args[:keys].nil?
+          @position = args[:position] unless args[:position].nil?
+        end
+      end
+      
+      # 
+      class ApiDimensionFilter
+        include Google::Apis::Core::Hashable
+      
+        # 
+        # Corresponds to the JSON property `dimension`
+        # @return [String]
+        attr_accessor :dimension
+      
+        # 
+        # Corresponds to the JSON property `expression`
+        # @return [String]
+        attr_accessor :expression
+      
+        # 
+        # Corresponds to the JSON property `operator`
+        # @return [String]
+        attr_accessor :operator
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @dimension = args[:dimension] unless args[:dimension].nil?
+          @expression = args[:expression] unless args[:expression].nil?
+          @operator = args[:operator] unless args[:operator].nil?
+        end
+      end
+      
+      # 
+      class ApiDimensionFilterGroup
+        include Google::Apis::Core::Hashable
+      
+        # 
+        # Corresponds to the JSON property `filters`
+        # @return [Array<Google::Apis::WebmastersV3::ApiDimensionFilter>]
+        attr_accessor :filters
+      
+        # 
+        # Corresponds to the JSON property `groupType`
+        # @return [String]
+        attr_accessor :group_type
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @filters = args[:filters] unless args[:filters].nil?
+          @group_type = args[:group_type] unless args[:group_type].nil?
+        end
+      end
+      
+      # 
+      class SearchAnalyticsQueryRequest
+        include Google::Apis::Core::Hashable
+      
+        # [Optional; Default is "auto"] How data is aggregated. If aggregated by
+        # property, all data for the same property is aggregated; if aggregated by page,
+        # all data is aggregated by canonical URI. If you filter or group by page,
+        # choose AUTO; otherwise you can aggregate either by property or by page,
+        # depending on how you want your data calculated; see  the help documentation to
+        # learn how data is calculated differently by site versus by page.
+        # Note: If you group or filter by page, you cannot aggregate by property.
+        # If you specify any value other than AUTO, the aggregation type in the result
+        # will match the requested type, or if you request an invalid type, you will get
+        # an error. The API will never change your aggregation type if the requested
+        # type is invalid.
+        # Corresponds to the JSON property `aggregationType`
+        # @return [String]
+        attr_accessor :aggregation_type
+      
+        # [Optional] Zero or more filters to apply to the dimension grouping values; for
+        # example, 'query contains "buy"' to see only data where the query string
+        # contains the substring "buy" (not case-sensitive). You can filter by a
+        # dimension without grouping by it.
+        # Corresponds to the JSON property `dimensionFilterGroups`
+        # @return [Array<Google::Apis::WebmastersV3::ApiDimensionFilterGroup>]
+        attr_accessor :dimension_filter_groups
+      
+        # [Optional] Zero or more dimensions to group results by. Dimensions are the
+        # group-by values in the Search Analytics page. Dimensions are combined to
+        # create a unique row key for each row. Results are grouped in the order that
+        # you supply these dimensions.
+        # Corresponds to the JSON property `dimensions`
+        # @return [Array<String>]
+        attr_accessor :dimensions
+      
+        # [Required] End date of the requested date range, in YYYY-MM-DD format, in PST (
+        # UTC - 8:00). Must be greater than or equal to the start date. This value is
+        # included in the range.
+        # Corresponds to the JSON property `endDate`
+        # @return [String]
+        attr_accessor :end_date
+      
+        # [Optional; Default is 1000] The maximum number of rows to return. Must be a
+        # number from 1 to 5,000 (inclusive).
+        # Corresponds to the JSON property `rowLimit`
+        # @return [Fixnum]
+        attr_accessor :row_limit
+      
+        # [Optional; Default is "web"] The search type to filter for.
+        # Corresponds to the JSON property `searchType`
+        # @return [String]
+        attr_accessor :search_type
+      
+        # [Required] Start date of the requested date range, in YYYY-MM-DD format, in
+        # PST time (UTC - 8:00). Must be less than or equal to the end date. This value
+        # is included in the range.
+        # Corresponds to the JSON property `startDate`
+        # @return [String]
+        attr_accessor :start_date
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @aggregation_type = args[:aggregation_type] unless args[:aggregation_type].nil?
+          @dimension_filter_groups = args[:dimension_filter_groups] unless args[:dimension_filter_groups].nil?
+          @dimensions = args[:dimensions] unless args[:dimensions].nil?
+          @end_date = args[:end_date] unless args[:end_date].nil?
+          @row_limit = args[:row_limit] unless args[:row_limit].nil?
+          @search_type = args[:search_type] unless args[:search_type].nil?
+          @start_date = args[:start_date] unless args[:start_date].nil?
+        end
+      end
+      
+      # A list of rows, one per result, grouped by key. Metrics in each row are
+      # aggregated for all data grouped by that key either by page or property, as
+      # specified by the aggregation type parameter.
+      class SearchAnalyticsQueryResponse
+        include Google::Apis::Core::Hashable
+      
+        # How the results were aggregated.
+        # Corresponds to the JSON property `responseAggregationType`
+        # @return [String]
+        attr_accessor :response_aggregation_type
+      
+        # A list of rows grouped by the key values in the order given in the query.
+        # Corresponds to the JSON property `rows`
+        # @return [Array<Google::Apis::WebmastersV3::ApiDataRow>]
+        attr_accessor :rows
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @response_aggregation_type = args[:response_aggregation_type] unless args[:response_aggregation_type].nil?
+          @rows = args[:rows] unless args[:rows].nil?
+        end
+      end
+      
+      # List of sitemaps.
+      class ListSitemapsResponse
+        include Google::Apis::Core::Hashable
+      
+        # Contains detailed information about a specific URL submitted as a sitemap.
+        # Corresponds to the JSON property `sitemap`
+        # @return [Array<Google::Apis::WebmastersV3::WmxSitemap>]
+        attr_accessor :sitemap
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @sitemap = args[:sitemap] unless args[:sitemap].nil?
+        end
+      end
+      
+      # List of sites with access level information.
+      class ListSitesResponse
+        include Google::Apis::Core::Hashable
+      
+        # Contains permission level information about a Search Console site. For more
+        # information, see Permissions in Search Console.
+        # Corresponds to the JSON property `siteEntry`
+        # @return [Array<Google::Apis::WebmastersV3::WmxSite>]
+        attr_accessor :site_entry
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @site_entry = args[:site_entry] unless args[:site_entry].nil?
+        end
+      end
+      
+      # An entry in a URL crawl errors time series.
+      class UrlCrawlErrorCount
+        include Google::Apis::Core::Hashable
+      
+        # The error count at the given timestamp.
+        # Corresponds to the JSON property `count`
+        # @return [String]
+        attr_accessor :count
+      
+        # The date and time when the crawl attempt took place, in RFC 3339 format.
+        # Corresponds to the JSON property `timestamp`
+        # @return [DateTime]
+        attr_accessor :timestamp
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @count = args[:count] unless args[:count].nil?
+          @timestamp = args[:timestamp] unless args[:timestamp].nil?
+        end
+      end
+      
+      # Number of errors per day for a specific error type (defined by platform and
+      # category).
+      class UrlCrawlErrorCountsPerType
+        include Google::Apis::Core::Hashable
+      
+        # The crawl error type.
+        # Corresponds to the JSON property `category`
+        # @return [String]
+        attr_accessor :category
+      
+        # The error count entries time series.
+        # Corresponds to the JSON property `entries`
+        # @return [Array<Google::Apis::WebmastersV3::UrlCrawlErrorCount>]
+        attr_accessor :entries
+      
+        # The general type of Googlebot that made the request (see list of Googlebot
+        # user-agents for the user-agents used).
+        # Corresponds to the JSON property `platform`
+        # @return [String]
+        attr_accessor :platform
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @category = args[:category] unless args[:category].nil?
+          @entries = args[:entries] unless args[:entries].nil?
+          @platform = args[:platform] unless args[:platform].nil?
+        end
+      end
+      
+      # A time series of the number of URL crawl errors per error category and
+      # platform.
+      class QueryUrlCrawlErrorsCountsResponse
+        include Google::Apis::Core::Hashable
+      
+        # The time series of the number of URL crawl errors per error category and
+        # platform.
+        # Corresponds to the JSON property `countPerTypes`
+        # @return [Array<Google::Apis::WebmastersV3::UrlCrawlErrorCountsPerType>]
+        attr_accessor :count_per_types
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @count_per_types = args[:count_per_types] unless args[:count_per_types].nil?
+        end
+      end
+      
+      # Contains information about specific crawl errors.
+      class UrlCrawlErrorsSample
+        include Google::Apis::Core::Hashable
+      
+        # The time the error was first detected, in RFC 3339 format.
+        # Corresponds to the JSON property `first_detected`
+        # @return [DateTime]
+        attr_accessor :first_detected
+      
+        # The time when the URL was last crawled, in RFC 3339 format.
+        # Corresponds to the JSON property `last_crawled`
+        # @return [DateTime]
+        attr_accessor :last_crawled
+      
+        # The URL of an error, relative to the site.
+        # Corresponds to the JSON property `pageUrl`
+        # @return [String]
+        attr_accessor :page_url
+      
+        # The HTTP response code, if any.
+        # Corresponds to the JSON property `responseCode`
+        # @return [Fixnum]
+        attr_accessor :response_code
+      
+        # Additional details about the URL, set only when calling get().
+        # Corresponds to the JSON property `urlDetails`
+        # @return [Google::Apis::WebmastersV3::UrlSampleDetails]
+        attr_accessor :url_details
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @first_detected = args[:first_detected] unless args[:first_detected].nil?
+          @last_crawled = args[:last_crawled] unless args[:last_crawled].nil?
+          @page_url = args[:page_url] unless args[:page_url].nil?
+          @response_code = args[:response_code] unless args[:response_code].nil?
+          @url_details = args[:url_details] unless args[:url_details].nil?
+        end
+      end
+      
+      # List of crawl error samples.
+      class ListUrlCrawlErrorsSamplesResponse
+        include Google::Apis::Core::Hashable
+      
+        # Information about the sample URL and its crawl error.
+        # Corresponds to the JSON property `urlCrawlErrorSample`
+        # @return [Array<Google::Apis::WebmastersV3::UrlCrawlErrorsSample>]
+        attr_accessor :url_crawl_error_sample
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @url_crawl_error_sample = args[:url_crawl_error_sample] unless args[:url_crawl_error_sample].nil?
+        end
+      end
+      
+      # Additional details about the URL, set only when calling get().
+      class UrlSampleDetails
+        include Google::Apis::Core::Hashable
+      
+        # List of sitemaps pointing at this URL.
+        # Corresponds to the JSON property `containingSitemaps`
+        # @return [Array<String>]
+        attr_accessor :containing_sitemaps
+      
+        # A sample set of URLs linking to this URL.
+        # Corresponds to the JSON property `linkedFromUrls`
+        # @return [Array<String>]
+        attr_accessor :linked_from_urls
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @containing_sitemaps = args[:containing_sitemaps] unless args[:containing_sitemaps].nil?
+          @linked_from_urls = args[:linked_from_urls] unless args[:linked_from_urls].nil?
+        end
+      end
+      
+      # Contains permission level information about a Search Console site. For more
+      # information, see  Permissions in Search Console.
+      class WmxSite
+        include Google::Apis::Core::Hashable
+      
+        # The user's permission level for the site.
+        # Corresponds to the JSON property `permissionLevel`
+        # @return [String]
+        attr_accessor :permission_level
+      
+        # The URL of the site.
+        # Corresponds to the JSON property `siteUrl`
+        # @return [String]
+        attr_accessor :site_url
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @permission_level = args[:permission_level] unless args[:permission_level].nil?
+          @site_url = args[:site_url] unless args[:site_url].nil?
+        end
+      end
+      
+      # Contains detailed information about a specific URL submitted as a sitemap.
+      class WmxSitemap
+        include Google::Apis::Core::Hashable
+      
+        # The various content types in the sitemap.
+        # Corresponds to the JSON property `contents`
+        # @return [Array<Google::Apis::WebmastersV3::WmxSitemapContent>]
+        attr_accessor :contents
+      
+        # Number of errors in the sitemap. These are issues with the sitemap itself that
+        # need to be fixed before it can be processed correctly.
+        # Corresponds to the JSON property `errors`
+        # @return [String]
+        attr_accessor :errors
+      
+        # If true, the sitemap has not been processed.
+        # Corresponds to the JSON property `isPending`
+        # @return [Boolean]
+        attr_accessor :is_pending
+        alias_method :is_pending?, :is_pending
+      
+        # If true, the sitemap is a collection of sitemaps.
+        # Corresponds to the JSON property `isSitemapsIndex`
+        # @return [Boolean]
+        attr_accessor :is_sitemaps_index
+        alias_method :is_sitemaps_index?, :is_sitemaps_index
+      
+        # Date & time in which this sitemap was last downloaded. Date format is in RFC
+        # 3339 format (yyyy-mm-dd).
+        # Corresponds to the JSON property `lastDownloaded`
+        # @return [DateTime]
+        attr_accessor :last_downloaded
+      
+        # Date & time in which this sitemap was submitted. Date format is in RFC 3339
+        # format (yyyy-mm-dd).
+        # Corresponds to the JSON property `lastSubmitted`
+        # @return [DateTime]
+        attr_accessor :last_submitted
+      
+        # The url of the sitemap.
+        # Corresponds to the JSON property `path`
+        # @return [String]
+        attr_accessor :path
+      
+        # The type of the sitemap. For example: rssFeed.
+        # Corresponds to the JSON property `type`
+        # @return [String]
+        attr_accessor :type
+      
+        # Number of warnings for the sitemap. These are generally non-critical issues
+        # with URLs in the sitemaps.
+        # Corresponds to the JSON property `warnings`
+        # @return [String]
+        attr_accessor :warnings
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @contents = args[:contents] unless args[:contents].nil?
+          @errors = args[:errors] unless args[:errors].nil?
+          @is_pending = args[:is_pending] unless args[:is_pending].nil?
+          @is_sitemaps_index = args[:is_sitemaps_index] unless args[:is_sitemaps_index].nil?
+          @last_downloaded = args[:last_downloaded] unless args[:last_downloaded].nil?
+          @last_submitted = args[:last_submitted] unless args[:last_submitted].nil?
+          @path = args[:path] unless args[:path].nil?
+          @type = args[:type] unless args[:type].nil?
+          @warnings = args[:warnings] unless args[:warnings].nil?
+        end
+      end
+      
+      # Information about the various content types in the sitemap.
+      class WmxSitemapContent
+        include Google::Apis::Core::Hashable
+      
+        # The number of URLs from the sitemap that were indexed (of the content type).
+        # Corresponds to the JSON property `indexed`
+        # @return [String]
+        attr_accessor :indexed
+      
+        # The number of URLs in the sitemap (of the content type).
+        # Corresponds to the JSON property `submitted`
+        # @return [String]
+        attr_accessor :submitted
+      
+        # The specific type of content in this sitemap. For example: web.
+        # Corresponds to the JSON property `type`
+        # @return [String]
+        attr_accessor :type
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @indexed = args[:indexed] unless args[:indexed].nil?
+          @submitted = args[:submitted] unless args[:submitted].nil?
+          @type = args[:type] unless args[:type].nil?
+        end
+      end
+    end
+  end
+end