Class: Google::Apis::JobsV2::Company

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/jobs_v2/classes.rb,
generated/google/apis/jobs_v2/representations.rb,
generated/google/apis/jobs_v2/representations.rb

Overview

A Company resource represents a company in the service. A company is the entity that owns job listings, that is, the hiring entity responsible for employing applicants for the job position.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Company

Returns a new instance of Company



359
360
361
# File 'generated/google/apis/jobs_v2/classes.rb', line 359

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

Optional. The URL to employer's career site or careers page on the employer's web site. Corresponds to the JSON property careerPageLink

Returns:

  • (String)


211
212
213
# File 'generated/google/apis/jobs_v2/classes.rb', line 211

def career_page_link
  @career_page_link
end

#company_info_sourcesArray<Google::Apis::JobsV2::CompanyInfoSource>

Optional. Identifiers external to the application that help to further identify the employer. Corresponds to the JSON property companyInfoSources



218
219
220
# File 'generated/google/apis/jobs_v2/classes.rb', line 218

def company_info_sources
  @company_info_sources
end

#company_sizeString

Optional. The employer's company size. Corresponds to the JSON property companySize

Returns:

  • (String)


224
225
226
# File 'generated/google/apis/jobs_v2/classes.rb', line 224

def company_size
  @company_size
end

#disable_location_optimizationBoolean Also known as: disable_location_optimization?

Deprecated. Do not use this field. Optional. This field is no longer used. Any value set to it is ignored. Corresponds to the JSON property disableLocationOptimization

Returns:

  • (Boolean)


231
232
233
# File 'generated/google/apis/jobs_v2/classes.rb', line 231

def disable_location_optimization
  @disable_location_optimization
end

#display_nameString

Required. The name of the employer to be displayed with the job, for example, "Google, LLC.". Corresponds to the JSON property displayName

Returns:

  • (String)


239
240
241
# File 'generated/google/apis/jobs_v2/classes.rb', line 239

def display_name
  @display_name
end

#distributor_billing_company_idString

Optional. The unique company identifier provided by the client to identify an employer for billing purposes. Recommended practice is to use the distributor_company_id. Defaults to same value as distributor_company_id when a value is not provided. Corresponds to the JSON property distributorBillingCompanyId

Returns:

  • (String)


249
250
251
# File 'generated/google/apis/jobs_v2/classes.rb', line 249

def distributor_billing_company_id
  @distributor_billing_company_id
end

#distributor_company_idString

Required. A client's company identifier, used to uniquely identify the company. If an employer has a subsidiary or sub-brand, such as "Alphabet" and "Google", which the client wishes to use as the company displayed on the job. Best practice is to create a distinct company identifier for each distinct brand displayed. The maximum number of allowed characters is 255. Corresponds to the JSON property distributorCompanyId

Returns:

  • (String)


260
261
262
# File 'generated/google/apis/jobs_v2/classes.rb', line 260

def distributor_company_id
  @distributor_company_id
end

#eeo_textString

Optional. Equal Employment Opportunity legal disclaimer text to be associated with all jobs, and typically to be displayed in all roles. The maximum number of allowed characters is 500. Corresponds to the JSON property eeoText

Returns:

  • (String)


269
270
271
# File 'generated/google/apis/jobs_v2/classes.rb', line 269

def eeo_text
  @eeo_text
end

#hiring_agencyBoolean Also known as: hiring_agency?

Optional. Set to true if it is the hiring agency that post jobs for other employers. Defaults to false if not provided. Corresponds to the JSON property hiringAgency

Returns:

  • (Boolean)


277
278
279
# File 'generated/google/apis/jobs_v2/classes.rb', line 277

def hiring_agency
  @hiring_agency
end

#hq_locationString

Optional. The street address of the company's main headquarters, which may be different from the job location. The service attempts to geolocate the provided address, and populates a more specific location wherever possible in structured_company_hq_location. Corresponds to the JSON property hqLocation

Returns:

  • (String)


287
288
289
# File 'generated/google/apis/jobs_v2/classes.rb', line 287

def hq_location
  @hq_location
end

#image_urlString

Optional. A URL that hosts the employer's company logo. If provided, the logo image should be squared at 80x80 pixels. The url must be a Google Photos or Google Album url. Only images in these Google sub-domains are accepted. Corresponds to the JSON property imageUrl

Returns:

  • (String)


296
297
298
# File 'generated/google/apis/jobs_v2/classes.rb', line 296

def image_url
  @image_url
end

#keyword_searchable_custom_attributesArray<String>

Optional. A list of keys of filterable Job.custom_attributes, whose corresponding string_values are used in keyword search. Jobs with string_values under these specified field keys are returned if any of the values matches the search keyword. Custom field values with parenthesis, brackets and special symbols might not be properly searchable, and those keyword queries need to be surrounded by quotes. Corresponds to the JSON property keywordSearchableCustomAttributes

Returns:

  • (Array<String>)


307
308
309
# File 'generated/google/apis/jobs_v2/classes.rb', line 307

def keyword_searchable_custom_attributes
  @keyword_searchable_custom_attributes
end

#keyword_searchable_custom_fieldsArray<Fixnum>

Deprecated. Use keyword_searchable_custom_attributes instead. Optional. A list of filterable custom fields that should be used in keyword search. The jobs of this company are returned if any of these custom fields matches the search keyword. Custom field values with parenthesis, brackets and special symbols might not be properly searchable, and those keyword queries need to be surrounded by quotes. Corresponds to the JSON property keywordSearchableCustomFields

Returns:

  • (Array<Fixnum>)


318
319
320
# File 'generated/google/apis/jobs_v2/classes.rb', line 318

def keyword_searchable_custom_fields
  @keyword_searchable_custom_fields
end

#nameString

Required during company update. The resource name for a company. This is generated by the service when a company is created, for example, "companies/0000aaaa-1111-bbbb-2222-cccc3333dddd". Corresponds to the JSON property name

Returns:

  • (String)


326
327
328
# File 'generated/google/apis/jobs_v2/classes.rb', line 326

def name
  @name
end

#structured_company_hq_locationGoogle::Apis::JobsV2::JobLocation

Output only. A resource that represents a location with full geographic information. Corresponds to the JSON property structuredCompanyHqLocation



333
334
335
# File 'generated/google/apis/jobs_v2/classes.rb', line 333

def structured_company_hq_location
  @structured_company_hq_location
end

#suspendedBoolean Also known as: suspended?

Output only. Indicates whether a company is flagged to be suspended from public availability by the service when job content appears suspicious, abusive, or spammy. Corresponds to the JSON property suspended

Returns:

  • (Boolean)


341
342
343
# File 'generated/google/apis/jobs_v2/classes.rb', line 341

def suspended
  @suspended
end

#titleString

Deprecated. Use display_name instead. Required. The name of the employer to be displayed with the job, for example, "Google, LLC.". Corresponds to the JSON property title

Returns:

  • (String)


350
351
352
# File 'generated/google/apis/jobs_v2/classes.rb', line 350

def title
  @title
end

#websiteString

Optional. The URL representing the company's primary web site or home page, such as, "www.google.com". Corresponds to the JSON property website

Returns:

  • (String)


357
358
359
# File 'generated/google/apis/jobs_v2/classes.rb', line 357

def website
  @website
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
# File 'generated/google/apis/jobs_v2/classes.rb', line 364

def update!(**args)
  @career_page_link = args[:career_page_link] if args.key?(:career_page_link)
  @company_info_sources = args[:company_info_sources] if args.key?(:company_info_sources)
  @company_size = args[:company_size] if args.key?(:company_size)
  @disable_location_optimization = args[:disable_location_optimization] if args.key?(:disable_location_optimization)
  @display_name = args[:display_name] if args.key?(:display_name)
  @distributor_billing_company_id = args[:distributor_billing_company_id] if args.key?(:distributor_billing_company_id)
  @distributor_company_id = args[:distributor_company_id] if args.key?(:distributor_company_id)
  @eeo_text = args[:eeo_text] if args.key?(:eeo_text)
  @hiring_agency = args[:hiring_agency] if args.key?(:hiring_agency)
  @hq_location = args[:hq_location] if args.key?(:hq_location)
  @image_url = args[:image_url] if args.key?(:image_url)
  @keyword_searchable_custom_attributes = args[:keyword_searchable_custom_attributes] if args.key?(:keyword_searchable_custom_attributes)
  @keyword_searchable_custom_fields = args[:keyword_searchable_custom_fields] if args.key?(:keyword_searchable_custom_fields)
  @name = args[:name] if args.key?(:name)
  @structured_company_hq_location = args[:structured_company_hq_location] if args.key?(:structured_company_hq_location)
  @suspended = args[:suspended] if args.key?(:suspended)
  @title = args[:title] if args.key?(:title)
  @website = args[:website] if args.key?(:website)
end