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

Inherits:
Google::Apis::Core::BaseService show all
Defined in:
generated/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:

Instance Attribute Summary collapse

Attributes inherited from Google::Apis::Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Google::Apis::Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Google::Apis::Core::Logging

#logger

Constructor Details

#initializeCivicInfoService


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

def initialize
  super('https://www.googleapis.com/', 'civicinfo/v2/')
  @batch_path = 'batch/civicinfo/v2'
end

Instance Attribute Details

#keyString


39
40
41
# File 'generated/google/apis/civicinfo_v2/service.rb', line 39

def key
  @key
end

#quota_userString


44
45
46
# File 'generated/google/apis/civicinfo_v2/service.rb', line 44

def quota_user
  @quota_user
end

#user_ipString


48
49
50
# File 'generated/google/apis/civicinfo_v2/service.rb', line 48

def user_ip
  @user_ip
end

Instance Method Details

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

List of available elections to query.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


115
116
117
118
119
120
121
122
123
124
125
# File 'generated/google/apis/civicinfo_v2/service.rb', line 115

def query_election(elections_query_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'elections', options)
  command.request_representation = Google::Apis::CivicinfoV2::ElectionsQueryRequest::Representation
  command.request_object = elections_query_request_object
  command.response_representation = Google::Apis::CivicinfoV2::QueryElectionsResponse::Representation
  command.response_class = Google::Apis::CivicinfoV2::QueryElectionsResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

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

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
# File 'generated/google/apis/civicinfo_v2/service.rb', line 163

def query_voter_info(address, voter_info_request_object = nil, election_id: nil, official_only: nil, return_all_available_data: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'voterinfo', options)
  command.request_representation = Google::Apis::CivicinfoV2::VoterInfoRequest::Representation
  command.request_object = voter_info_request_object
  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['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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

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

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
# File 'generated/google/apis/civicinfo_v2/service.rb', line 215

def representative_info_by_address(representative_info_request_object = nil, address: nil, include_offices: nil, levels: nil, roles: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'representatives', options)
  command.request_representation = Google::Apis::CivicinfoV2::RepresentativeInfoRequest::Representation
  command.request_object = representative_info_request_object
  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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Looks up representative information for a single geographic division.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
# File 'generated/google/apis/civicinfo_v2/service.rb', line 266

def representative_info_by_division(ocd_id, division_representative_info_request_object = nil, levels: nil, recursive: nil, roles: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'representatives/{ocdId}', options)
  command.request_representation = Google::Apis::CivicinfoV2::DivisionRepresentativeInfoRequest::Representation
  command.request_object = division_representative_info_request_object
  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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

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

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


81
82
83
84
85
86
87
88
89
90
91
92
# File 'generated/google/apis/civicinfo_v2/service.rb', line 81

def search_divisions(division_search_request_object = nil, query: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'divisions', options)
  command.request_representation = Google::Apis::CivicinfoV2::DivisionSearchRequest::Representation
  command.request_object = division_search_request_object
  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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end