Class: Google::Apis::IndexingV3::IndexingService
- Inherits:
-
Core::BaseService
- Object
- Core::BaseService
- Google::Apis::IndexingV3::IndexingService
- Defined in:
- generated/google/apis/indexing_v3/service.rb
Overview
Indexing API
The Indexing API allows developers to share the life cycle of a Web Document with Google.
Instance Attribute Summary collapse
-
#key ⇒ String
API key.
-
#quota_user ⇒ String
Available to use for quota purposes for server-side applications.
Attributes inherited from Core::BaseService
#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path
Instance Method Summary collapse
-
#get_url_notification_metadata(url: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IndexingV3::UrlNotificationMetadata
Gets metadata about a Web Document.
-
#initialize ⇒ IndexingService
constructor
A new instance of IndexingService.
-
#publish_url_notification(url_notification_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IndexingV3::PublishUrlNotificationResponse
Notifies that a URL has been updated or deleted.
Methods inherited from Core::BaseService
#batch, #batch_upload, #fetch_all, #http
Methods included from Core::Logging
Constructor Details
#initialize ⇒ IndexingService
Returns a new instance of IndexingService
46 47 48 49 |
# File 'generated/google/apis/indexing_v3/service.rb', line 46 def initialize super('https://indexing.googleapis.com/', '') @batch_path = 'batch' end |
Instance Attribute Details
#key ⇒ String
Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
39 40 41 |
# File 'generated/google/apis/indexing_v3/service.rb', line 39 def key @key end |
#quota_user ⇒ String
Returns 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.
44 45 46 |
# File 'generated/google/apis/indexing_v3/service.rb', line 44 def quota_user @quota_user end |
Instance Method Details
#get_url_notification_metadata(url: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IndexingV3::UrlNotificationMetadata
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.
73 74 75 76 77 78 79 80 81 |
# File 'generated/google/apis/indexing_v3/service.rb', line 73 def (url: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v3/urlNotifications/metadata', ) 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 |
#publish_url_notification(url_notification_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IndexingV3::PublishUrlNotificationResponse
Notifies that a URL has been updated or deleted.
102 103 104 105 106 107 108 109 110 111 |
# File 'generated/google/apis/indexing_v3/service.rb', line 102 def publish_url_notification(url_notification_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v3/urlNotifications:publish', ) 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 |