Class: Google::Type::PostalAddress

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/type/postal_address.rb

Overview

Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains).

In typical usage an address would be created via user input or from importing existing data, depending on the type of process.

Advice on address input / editing:

  • Use an i18n-ready address widget such as https://github.com/google/libaddressinput)
    • Users should not be presented with UI elements for input or editing of fields outside countries where that field is used.

For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478

Instance Attribute Summary collapse

Instance Attribute Details

#address_lines ⇒ ::Array<::String> 



130
131
132
133
 
# File 'proto_docs/google/type/postal_address.rb', line 130

class PostalAddress
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#administrative_area ⇒ ::String 



130
131
132
133
 
# File 'proto_docs/google/type/postal_address.rb', line 130

class PostalAddress
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#language_code ⇒ ::String 



130
131
132
133
 
# File 'proto_docs/google/type/postal_address.rb', line 130

class PostalAddress
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#locality ⇒ ::String 



130
131
132
133
 
# File 'proto_docs/google/type/postal_address.rb', line 130

class PostalAddress
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#organization ⇒ ::String 



130
131
132
133
 
# File 'proto_docs/google/type/postal_address.rb', line 130

class PostalAddress
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#postal_code ⇒ ::String 



130
131
132
133
 
# File 'proto_docs/google/type/postal_address.rb', line 130

class PostalAddress
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#recipients ⇒ ::Array<::String> 



130
131
132
133
 
# File 'proto_docs/google/type/postal_address.rb', line 130

class PostalAddress
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#region_code ⇒ ::String 



130
131
132
133
 
# File 'proto_docs/google/type/postal_address.rb', line 130

class PostalAddress
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#revision ⇒ ::Integer 



130
131
132
133
 
# File 'proto_docs/google/type/postal_address.rb', line 130

class PostalAddress
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#sorting_code ⇒ ::String 



130
131
132
133
 
# File 'proto_docs/google/type/postal_address.rb', line 130

class PostalAddress
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#sublocality ⇒ ::String 



130
131
132
133
 
# File 'proto_docs/google/type/postal_address.rb', line 130

class PostalAddress
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end