companies

Creates, updates, deletes, gets or lists a companies resource.

Overview

Name	companies
Type	Resource
Id	google.jobs.companies

Fields

Name	Datatype	Description
name	string	Required during company update. The resource name for a company. This is generated by the service when a company is created. The format is "projects/{project_id}/tenants/{tenant_id}/companies/{company_id}", for example, "projects/foo/tenants/bar/companies/baz".
careerSiteUri	string	The URI to employer's career site or careers page on the employer's web site, for example, "https://careers.google.com".
derivedInfo	object	Derived details about the company.
displayName	string	Required. The display name of the company, for example, "Google LLC".
eeoText	string	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.
externalId	string	Required. Client side company identifier, used to uniquely identify the company. The maximum number of allowed characters is 255.
headquartersAddress	string	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 DerivedInfo.headquarters_location.
hiringAgency	boolean	Set to true if it is the hiring agency that post jobs for other employers. Defaults to false if not provided.
imageUri	string	A URI that hosts the employer's company logo.
keywordSearchableJobCustomAttributes	array	This field is deprecated. Please set the searchability of the custom attribute in the Job.custom_attributes going forward. A list of keys of filterable Job.custom_attributes, whose corresponding string_values are used in keyword searches. Jobs with string_values under these specified field keys are returned if any of the values match the search keyword. Custom field values with parenthesis, brackets and special symbols are not searchable as-is, and those keyword queries must be surrounded by quotes.
size	string	The employer's company size.
suspended	boolean	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.
websiteUri	string	The URI representing the company's primary web site or home page, for example, "https://www.google.com". The maximum number of allowed characters is 255.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	companiesId, projectsId, tenantsId	Retrieves specified company.
list	SELECT	projectsId, tenantsId	Lists all companies associated with the project.
create	INSERT	projectsId, tenantsId	Creates a new company entity.
delete	DELETE	companiesId, projectsId, tenantsId	Deletes specified company. Prerequisite: The company has no jobs associated with it.
patch	UPDATE	companiesId, projectsId, tenantsId	Updates specified company.

SELECT examples

Lists all companies associated with the project.

SELECT
name,
careerSiteUri,
derivedInfo,
displayName,
eeoText,
externalId,
headquartersAddress,
hiringAgency,
imageUri,
keywordSearchableJobCustomAttributes,
size,
suspended,
websiteUri
FROM google.jobs.companies
WHERE projectsId = '{{ projectsId }}'
AND tenantsId = '{{ tenantsId }}';

INSERT example

Use the following StackQL query and manifest file to create a new companies resource.

All Properties

/*+ create */
INSERT INTO google.jobs.companies (
projectsId,
tenantsId,
name,
displayName,
externalId,
size,
headquartersAddress,
hiringAgency,
eeoText,
websiteUri,
careerSiteUri,
imageUri,
keywordSearchableJobCustomAttributes
)
SELECT 
'{{ projectsId }}',
'{{ tenantsId }}',
'{{ name }}',
'{{ displayName }}',
'{{ externalId }}',
'{{ size }}',
'{{ headquartersAddress }}',
{{ hiringAgency }},
'{{ eeoText }}',
'{{ websiteUri }}',
'{{ careerSiteUri }}',
'{{ imageUri }}',
'{{ keywordSearchableJobCustomAttributes }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: name
      value: string
    - name: displayName
      value: string
    - name: externalId
      value: string
    - name: size
      value: string
    - name: headquartersAddress
      value: string
    - name: hiringAgency
      value: boolean
    - name: eeoText
      value: string
    - name: websiteUri
      value: string
    - name: careerSiteUri
      value: string
    - name: imageUri
      value: string
    - name: keywordSearchableJobCustomAttributes
      value:
        - string
    - name: derivedInfo
      value:
        - name: headquartersLocation
          value:
            - name: locationType
              value: string
            - name: postalAddress
              value:
                - name: revision
                  value: integer
                - name: regionCode
                  value: string
                - name: languageCode
                  value: string
                - name: postalCode
                  value: string
                - name: sortingCode
                  value: string
                - name: administrativeArea
                  value: string
                - name: locality
                  value: string
                - name: sublocality
                  value: string
                - name: addressLines
                  value:
                    - string
                - name: recipients
                  value:
                    - string
                - name: organization
                  value: string
            - name: latLng
              value:
                - name: latitude
                  value: number
                - name: longitude
                  value: number
            - name: radiusMiles
              value: number
    - name: suspended
      value: boolean

UPDATE example

Updates a companies resource.

/*+ update */
UPDATE google.jobs.companies
SET 
name = '{{ name }}',
displayName = '{{ displayName }}',
externalId = '{{ externalId }}',
size = '{{ size }}',
headquartersAddress = '{{ headquartersAddress }}',
hiringAgency = true|false,
eeoText = '{{ eeoText }}',
websiteUri = '{{ websiteUri }}',
careerSiteUri = '{{ careerSiteUri }}',
imageUri = '{{ imageUri }}',
keywordSearchableJobCustomAttributes = '{{ keywordSearchableJobCustomAttributes }}'
WHERE 
companiesId = '{{ companiesId }}'
AND projectsId = '{{ projectsId }}'
AND tenantsId = '{{ tenantsId }}';

DELETE example

Deletes the specified companies resource.

/*+ delete */
DELETE FROM google.jobs.companies
WHERE companiesId = '{{ companiesId }}'
AND projectsId = '{{ projectsId }}'
AND tenantsId = '{{ tenantsId }}';