Class: Google::Apis::AddressvalidationV1::AddressValidationService

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

Overview

Address Validation API

The Address Validation API allows developers to verify the accuracy of addresses. Given an address, it returns information about the correctness of the components of the parsed address, a geocode, and a verdict on the deliverability of the parsed address.

Examples:

require 'google/apis/addressvalidation_v1'

Addressvalidation = Google::Apis::AddressvalidationV1 # Alias the module
service = Addressvalidation::AddressValidationService.new

See Also:

Constant Summary collapse

DEFAULT_ENDPOINT_TEMPLATE = 
"https://addressvalidation.$UNIVERSE_DOMAIN$/"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ AddressValidationService

Returns a new instance of AddressValidationService.



50
51
52
53
54
55
 
# File 'lib/google/apis/addressvalidation_v1/service.rb', line 50

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, '',
        client_name: 'google-apis-addressvalidation_v1',
        client_version: Google::Apis::AddressvalidationV1::GEM_VERSION)
  @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.



43
44
45
 
# File 'lib/google/apis/addressvalidation_v1/service.rb', line 43

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.



48
49
50
 
# File 'lib/google/apis/addressvalidation_v1/service.rb', line 48

def quota_user
  @quota_user
end

Instance Method Details

#provide_validation_feedback(google_maps_addressvalidation_v1_provide_validation_feedback_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AddressvalidationV1::GoogleMapsAddressvalidationV1ProvideValidationFeedbackResponse

Feedback about the outcome of the sequence of validation attempts. This should be the last call made after a sequence of validation calls for the same address, and should be called once the transaction is concluded. This should only be sent once for the sequence of ValidateAddress requests needed to validate an address fully.

Parameters:

  • google_maps_addressvalidation_v1_provide_validation_feedback_request_object (Google::Apis::AddressvalidationV1::GoogleMapsAddressvalidationV1ProvideValidationFeedbackRequest) (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



80
81
82
83
84
85
86
87
88
89
 
# File 'lib/google/apis/addressvalidation_v1/service.rb', line 80

def provide_validation_feedback(google_maps_addressvalidation_v1_provide_validation_feedback_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1:provideValidationFeedback', options)
  command.request_representation = Google::Apis::AddressvalidationV1::GoogleMapsAddressvalidationV1ProvideValidationFeedbackRequest::Representation
  command.request_object = google_maps_addressvalidation_v1_provide_validation_feedback_request_object
  command.response_representation = Google::Apis::AddressvalidationV1::GoogleMapsAddressvalidationV1ProvideValidationFeedbackResponse::Representation
  command.response_class = Google::Apis::AddressvalidationV1::GoogleMapsAddressvalidationV1ProvideValidationFeedbackResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#validate_address(google_maps_addressvalidation_v1_validate_address_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AddressvalidationV1::GoogleMapsAddressvalidationV1ValidateAddressResponse

Validates an address.

Parameters:

  • google_maps_addressvalidation_v1_validate_address_request_object (Google::Apis::AddressvalidationV1::GoogleMapsAddressvalidationV1ValidateAddressRequest) (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



110
111
112
113
114
115
116
117
118
119
 
# File 'lib/google/apis/addressvalidation_v1/service.rb', line 110

def validate_address(google_maps_addressvalidation_v1_validate_address_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1:validateAddress', options)
  command.request_representation = Google::Apis::AddressvalidationV1::GoogleMapsAddressvalidationV1ValidateAddressRequest::Representation
  command.request_object = google_maps_addressvalidation_v1_validate_address_request_object
  command.response_representation = Google::Apis::AddressvalidationV1::GoogleMapsAddressvalidationV1ValidateAddressResponse::Representation
  command.response_class = Google::Apis::AddressvalidationV1::GoogleMapsAddressvalidationV1ValidateAddressResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end