Class: Google::Apis::CivicinfoV2::CivicInfoService

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

Overview

Google Civic Information API

Provides polling places, early vote locations, contest data, election officials, and government representatives for U.S. residential addresses.

Examples:

require 'google/apis/civicinfo_v2'

Civicinfo = Google::Apis::CivicinfoV2 # Alias the module
service = Civicinfo::CivicInfoService.new

See Also:

Constant Summary collapse

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ CivicInfoService

Returns a new instance of CivicInfoService.



48
49
50
51
52
53
 
# File 'lib/google/apis/civicinfo_v2/service.rb', line 48

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, '',
        client_name: 'google-apis-civicinfo_v2',
        client_version: Google::Apis::CivicinfoV2::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.



41
42
43
 
# File 'lib/google/apis/civicinfo_v2/service.rb', line 41

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.



46
47
48
 
# File 'lib/google/apis/civicinfo_v2/service.rb', line 46

def quota_user
  @quota_user
end

Instance Method Details

#query_division_division_by_address(address: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CivicinfoV2::DivisionByAddressResponse

Lookup OCDIDs and names for divisions related to an address.

Parameters:

  • address (String) (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



74
75
76
77
78
79
80
81
82
 
# File 'lib/google/apis/civicinfo_v2/service.rb', line 74

def query_division_division_by_address(address: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'civicinfo/v2/divisionsByAddress', options)
  command.response_representation = Google::Apis::CivicinfoV2::DivisionByAddressResponse::Representation
  command.response_class = Google::Apis::CivicinfoV2::DivisionByAddressResponse
  command.query['address'] = address unless address.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#query_election(production_data_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CivicinfoV2::QueryElectionsResponse

List of available elections to query.

Parameters:

  • production_data_only (Boolean) (defaults to: nil) —

    Whether to include data that has not been allowlisted yet

  • 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



137
138
139
140
141
142
143
144
145
 
# File 'lib/google/apis/civicinfo_v2/service.rb', line 137

def query_election(production_data_only: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'civicinfo/v2/elections', options)
  command.response_representation = Google::Apis::CivicinfoV2::QueryElectionsResponse::Representation
  command.response_class = Google::Apis::CivicinfoV2::QueryElectionsResponse
  command.query['productionDataOnly'] = production_data_only unless production_data_only.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#query_voter_info(address: nil, election_id: nil, official_only: nil, production_data_only: nil, return_all_available_data: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CivicinfoV2::VoterInfoResponse

Looks up information relevant to a voter based on the voter's registered address.

Parameters:

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

    The registered address of the voter to look up.

  • election_id (Fixnum) (defaults to: nil) —

    The unique ID of the election to look up. A list of election IDs can be obtained at https://www.googleapis.com/civicinfo/`version`/elections. If no election ID is specified in the query and there is more than one election with data for the given voter, the additional elections are provided in the otherElections response field.

  • official_only (Boolean) (defaults to: nil) —

    If set to true, only data from official state sources will be returned.

  • production_data_only (Boolean) (defaults to: nil) —

    Whether to include data that has not been vetted yet. Should only be made available to internal IPs or trusted partners. This is a non-discoverable parameter in the One Platform API config.

  • return_all_available_data (Boolean) (defaults to: nil) —

    If set to true, the query will return the success code and include any partial information when it is unable to determine a matching address or unable to determine the election for electionId=0 queries.

  • 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



184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/google/apis/civicinfo_v2/service.rb', line 184

def query_voter_info(address: nil, election_id: nil, official_only: nil, production_data_only: nil, return_all_available_data: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'civicinfo/v2/voterinfo', options)
  command.response_representation = Google::Apis::CivicinfoV2::VoterInfoResponse::Representation
  command.response_class = Google::Apis::CivicinfoV2::VoterInfoResponse
  command.query['address'] = address unless address.nil?
  command.query['electionId'] = election_id unless election_id.nil?
  command.query['officialOnly'] = official_only unless official_only.nil?
  command.query['productionDataOnly'] = production_data_only unless production_data_only.nil?
  command.query['returnAllAvailableData'] = return_all_available_data unless return_all_available_data.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#representative_info_by_address(address: nil, include_offices: nil, levels: nil, roles: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CivicinfoV2::RepresentativeInfoResponse

Looks up political geography and representative information for a single address.

Parameters:

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

    The address to look up. May only be specified if the field ocdId is not given in the URL

  • include_offices (Boolean) (defaults to: nil) —

    Whether to return information about offices and officials. If false, only the top-level district information will be returned.

  • levels (Array<String>, String) (defaults to: nil) —

    A list of office levels to filter by. Only offices that serve at least one of these levels will be returned. Divisions that don't contain a matching office will not be returned.

  • roles (Array<String>, String) (defaults to: nil) —

    A list of office roles to filter by. Only offices fulfilling one of these roles will be returned. Divisions that don't contain a matching office will not be returned.

  • 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



231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/google/apis/civicinfo_v2/service.rb', line 231

def representative_info_by_address(address: nil, include_offices: nil, levels: nil, roles: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'civicinfo/v2/representatives', options)
  command.response_representation = Google::Apis::CivicinfoV2::RepresentativeInfoResponse::Representation
  command.response_class = Google::Apis::CivicinfoV2::RepresentativeInfoResponse
  command.query['address'] = address unless address.nil?
  command.query['includeOffices'] = include_offices unless include_offices.nil?
  command.query['levels'] = levels unless levels.nil?
  command.query['roles'] = roles unless roles.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#representative_info_by_division(ocd_id, levels: nil, recursive: nil, roles: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CivicinfoV2::RepresentativeInfoData

Looks up representative information for a single geographic division.

Parameters:

  • ocd_id (String) —

    The Open Civic Data division identifier of the division to look up.

  • levels (Array<String>, String) (defaults to: nil) —

    A list of office levels to filter by. Only offices that serve at least one of these levels will be returned. Divisions that don't contain a matching office will not be returned.

  • recursive (Boolean) (defaults to: nil) —

    If true, information about all divisions contained in the division requested will be included as well. For example, if querying ocd-division/country:us/ district:dc, this would also return all DC's wards and ANCs.

  • roles (Array<String>, String) (defaults to: nil) —

    A list of office roles to filter by. Only offices fulfilling one of these roles will be returned. Divisions that don't contain a matching office will not be returned.

  • 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



276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/google/apis/civicinfo_v2/service.rb', line 276

def representative_info_by_division(ocd_id, levels: nil, recursive: nil, roles: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'civicinfo/v2/representatives/{ocdId}', options)
  command.response_representation = Google::Apis::CivicinfoV2::RepresentativeInfoData::Representation
  command.response_class = Google::Apis::CivicinfoV2::RepresentativeInfoData
  command.params['ocdId'] = ocd_id unless ocd_id.nil?
  command.query['levels'] = levels unless levels.nil?
  command.query['recursive'] = recursive unless recursive.nil?
  command.query['roles'] = roles unless roles.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#search_divisions(query: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CivicinfoV2::SearchDivisionResponse

Searches for political divisions by their natural name or OCD ID.

Parameters:

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

    The search query. Queries can cover any parts of a OCD ID or a human readable division name. All words given in the query are treated as required patterns. In addition to that, most query operators of the Apache Lucene library are supported. See http://lucene.apache.org/core/2_9_4/queryparsersyntax.html

  • 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



107
108
109
110
111
112
113
114
115
 
# File 'lib/google/apis/civicinfo_v2/service.rb', line 107

def search_divisions(query: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'civicinfo/v2/divisions', options)
  command.response_representation = Google::Apis::CivicinfoV2::SearchDivisionResponse::Representation
  command.response_class = Google::Apis::CivicinfoV2::SearchDivisionResponse
  command.query['query'] = query unless query.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end