-
Notifications
You must be signed in to change notification settings - Fork 870
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Showing
8 changed files
with
360 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
# 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/indexing_v3/service.rb' | ||
require 'google/apis/indexing_v3/classes.rb' | ||
require 'google/apis/indexing_v3/representations.rb' | ||
|
||
module Google | ||
module Apis | ||
# Indexing API | ||
# | ||
# The Indexing API allows developers to share the life cycle of a Web Document | ||
# with Google. | ||
# | ||
# @see https://developers.google.com/search/apis/indexing-api/ | ||
module IndexingV3 | ||
VERSION = 'V3' | ||
REVISION = '20180621' | ||
end | ||
end | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,115 @@ | ||
# 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 IndexingV3 | ||
|
||
# Output for PublishUrlNotification | ||
class PublishUrlNotificationResponse | ||
include Google::Apis::Core::Hashable | ||
|
||
# Summary of the most recent Indexing API notifications successfully received, | ||
# for a given URL. | ||
# Corresponds to the JSON property `urlNotificationMetadata` | ||
# @return [Google::Apis::IndexingV3::UrlNotificationMetadata] | ||
attr_accessor :url_notification_metadata | ||
|
||
def initialize(**args) | ||
update!(**args) | ||
end | ||
|
||
# Update properties of this object | ||
def update!(**args) | ||
@url_notification_metadata = args[:url_notification_metadata] if args.key?(:url_notification_metadata) | ||
end | ||
end | ||
|
||
# `UrlNotification` is the resource used in all Indexing API calls. | ||
# It describes one event in the life cycle of a Web Document. | ||
class UrlNotification | ||
include Google::Apis::Core::Hashable | ||
|
||
# Creation timestamp for this notification. | ||
# Users should _not_ specify it, the field is ignored at the request time. | ||
# Corresponds to the JSON property `notifyTime` | ||
# @return [String] | ||
attr_accessor :notify_time | ||
|
||
# The URL life cycle event that Google is being notified about. | ||
# Corresponds to the JSON property `type` | ||
# @return [String] | ||
attr_accessor :type | ||
|
||
# The object of this notification. The URL must be owned by the publisher | ||
# of this notification and, in case of `URL_UPDATED` notifications, it _must_ | ||
# be crawlable by Google. | ||
# Corresponds to the JSON property `url` | ||
# @return [String] | ||
attr_accessor :url | ||
|
||
def initialize(**args) | ||
update!(**args) | ||
end | ||
|
||
# Update properties of this object | ||
def update!(**args) | ||
@notify_time = args[:notify_time] if args.key?(:notify_time) | ||
@type = args[:type] if args.key?(:type) | ||
@url = args[:url] if args.key?(:url) | ||
end | ||
end | ||
|
||
# Summary of the most recent Indexing API notifications successfully received, | ||
# for a given URL. | ||
class UrlNotificationMetadata | ||
include Google::Apis::Core::Hashable | ||
|
||
# `UrlNotification` is the resource used in all Indexing API calls. | ||
# It describes one event in the life cycle of a Web Document. | ||
# Corresponds to the JSON property `latestRemove` | ||
# @return [Google::Apis::IndexingV3::UrlNotification] | ||
attr_accessor :latest_remove | ||
|
||
# `UrlNotification` is the resource used in all Indexing API calls. | ||
# It describes one event in the life cycle of a Web Document. | ||
# Corresponds to the JSON property `latestUpdate` | ||
# @return [Google::Apis::IndexingV3::UrlNotification] | ||
attr_accessor :latest_update | ||
|
||
# URL to which this metadata refers. | ||
# Corresponds to the JSON property `url` | ||
# @return [String] | ||
attr_accessor :url | ||
|
||
def initialize(**args) | ||
update!(**args) | ||
end | ||
|
||
# Update properties of this object | ||
def update!(**args) | ||
@latest_remove = args[:latest_remove] if args.key?(:latest_remove) | ||
@latest_update = args[:latest_update] if args.key?(:latest_update) | ||
@url = args[:url] if args.key?(:url) | ||
end | ||
end | ||
end | ||
end | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,72 @@ | ||
# 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 IndexingV3 | ||
|
||
class PublishUrlNotificationResponse | ||
class Representation < Google::Apis::Core::JsonRepresentation; end | ||
|
||
include Google::Apis::Core::JsonObjectSupport | ||
end | ||
|
||
class UrlNotification | ||
class Representation < Google::Apis::Core::JsonRepresentation; end | ||
|
||
include Google::Apis::Core::JsonObjectSupport | ||
end | ||
|
||
class UrlNotificationMetadata | ||
class Representation < Google::Apis::Core::JsonRepresentation; end | ||
|
||
include Google::Apis::Core::JsonObjectSupport | ||
end | ||
|
||
class PublishUrlNotificationResponse | ||
# @private | ||
class Representation < Google::Apis::Core::JsonRepresentation | ||
property :url_notification_metadata, as: 'urlNotificationMetadata', class: Google::Apis::IndexingV3::UrlNotificationMetadata, decorator: Google::Apis::IndexingV3::UrlNotificationMetadata::Representation | ||
|
||
end | ||
end | ||
|
||
class UrlNotification | ||
# @private | ||
class Representation < Google::Apis::Core::JsonRepresentation | ||
property :notify_time, as: 'notifyTime' | ||
property :type, as: 'type' | ||
property :url, as: 'url' | ||
end | ||
end | ||
|
||
class UrlNotificationMetadata | ||
# @private | ||
class Representation < Google::Apis::Core::JsonRepresentation | ||
property :latest_remove, as: 'latestRemove', class: Google::Apis::IndexingV3::UrlNotification, decorator: Google::Apis::IndexingV3::UrlNotification::Representation | ||
|
||
property :latest_update, as: 'latestUpdate', class: Google::Apis::IndexingV3::UrlNotification, decorator: Google::Apis::IndexingV3::UrlNotification::Representation | ||
|
||
property :url, as: 'url' | ||
end | ||
end | ||
end | ||
end | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,122 @@ | ||
# 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 IndexingV3 | ||
# Indexing API | ||
# | ||
# The Indexing API allows developers to share the life cycle of a Web Document | ||
# with Google. | ||
# | ||
# @example | ||
# require 'google/apis/indexing_v3' | ||
# | ||
# Indexing = Google::Apis::IndexingV3 # Alias the module | ||
# service = Indexing::IndexingService.new | ||
# | ||
# @see https://developers.google.com/search/apis/indexing-api/ | ||
class IndexingService < 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. | ||
attr_accessor :quota_user | ||
|
||
def initialize | ||
super('https://indexing.googleapis.com/', '') | ||
@batch_path = 'batch' | ||
end | ||
|
||
# Gets metadata about a Web Document. This method can _only_ be used to query | ||
# URLs that were previously seen in successful Indexing API notifications. | ||
# Includes the latest `UrlNotification` received via this API. | ||
# @param [String] url | ||
# URL that is being queried. | ||
# @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. | ||
# @param [Google::Apis::RequestOptions] options | ||
# Request-specific options | ||
# | ||
# @yield [result, err] Result & error if block supplied | ||
# @yieldparam result [Google::Apis::IndexingV3::UrlNotificationMetadata] parsed result object | ||
# @yieldparam err [StandardError] error object if request failed | ||
# | ||
# @return [Google::Apis::IndexingV3::UrlNotificationMetadata] | ||
# | ||
# @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_url_notification_metadata(url: nil, fields: nil, quota_user: nil, options: nil, &block) | ||
command = make_simple_command(:get, 'v3/urlNotifications/metadata', options) | ||
command.response_representation = Google::Apis::IndexingV3::UrlNotificationMetadata::Representation | ||
command.response_class = Google::Apis::IndexingV3::UrlNotificationMetadata | ||
command.query['url'] = url unless url.nil? | ||
command.query['fields'] = fields unless fields.nil? | ||
command.query['quotaUser'] = quota_user unless quota_user.nil? | ||
execute_or_queue_command(command, &block) | ||
end | ||
|
||
# Notifies that a URL has been updated or deleted. | ||
# @param [Google::Apis::IndexingV3::UrlNotification] url_notification_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. | ||
# @param [Google::Apis::RequestOptions] options | ||
# Request-specific options | ||
# | ||
# @yield [result, err] Result & error if block supplied | ||
# @yieldparam result [Google::Apis::IndexingV3::PublishUrlNotificationResponse] parsed result object | ||
# @yieldparam err [StandardError] error object if request failed | ||
# | ||
# @return [Google::Apis::IndexingV3::PublishUrlNotificationResponse] | ||
# | ||
# @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 publish_url_notification(url_notification_object = nil, fields: nil, quota_user: nil, options: nil, &block) | ||
command = make_simple_command(:post, 'v3/urlNotifications:publish', options) | ||
command.request_representation = Google::Apis::IndexingV3::UrlNotification::Representation | ||
command.request_object = url_notification_object | ||
command.response_representation = Google::Apis::IndexingV3::PublishUrlNotificationResponse::Representation | ||
command.response_class = Google::Apis::IndexingV3::PublishUrlNotificationResponse | ||
command.query['fields'] = fields unless fields.nil? | ||
command.query['quotaUser'] = quota_user unless quota_user.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? | ||
end | ||
end | ||
end | ||
end | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters