Class: Google::Apis::IndexingV3::IndexingService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
generated/google/apis/indexing_v3/service.rb

Overview

Indexing API

Notifies Google when your web pages change.

Examples:

require 'google/apis/indexing_v3'

Indexing = Google::Apis::IndexingV3 # Alias the module
service = Indexing::IndexingService.new

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ IndexingService

Returns a new instance of IndexingService.



45
46
47
48
 
# File 'generated/google/apis/indexing_v3/service.rb', line 45

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.

Returns:

  • (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.



38
39
40
 
# File 'generated/google/apis/indexing_v3/service.rb', line 38

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.

Returns:

  • (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.



43
44
45
 
# File 'generated/google/apis/indexing_v3/service.rb', line 43

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.

Parameters:

  • url (String) (defaults to: nil) —

    URL that is being queried.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



72
73
74
75
76
77
78
79
80
 
# File 'generated/google/apis/indexing_v3/service.rb', line 72

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

#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.

Parameters:

  • url_notification_object (Google::Apis::IndexingV3::UrlNotification) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



101
102
103
104
105
106
107
108
109
110
 
# File 'generated/google/apis/indexing_v3/service.rb', line 101

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