Skip to main content

companies

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

Overview​

Namecompanies
TypeResource
Idgoogle.jobs.companies

Fields​

The following fields are returned by SELECT queries:

Successful response

NameDatatypeDescription
namestringRequired 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".
careerSiteUristringThe URI to employer's career site or careers page on the employer's web site, for example, "https://careers.google.com".
derivedInfoobjectOutput only. Derived details about the company. (id: CompanyDerivedInfo)
displayNamestringRequired. The display name of the company, for example, "Google LLC".
eeoTextstringEqual 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.
externalIdstringRequired. Client side company identifier, used to uniquely identify the company. The maximum number of allowed characters is 255.
headquartersAddressstringThe 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.
hiringAgencybooleanSet to true if it is the hiring agency that post jobs for other employers. Defaults to false if not provided.
imageUristringA URI that hosts the employer's company logo.
keywordSearchableJobCustomAttributesarrayThis 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.
sizestringThe employer's company size.
suspendedbooleanOutput only. Indicates whether a company is flagged to be suspended from public availability by the service when job content appears suspicious, abusive, or spammy.
websiteUristringThe 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​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectprojectsId, tenantsId, companiesIdRetrieves specified company.
listselectprojectsId, tenantsIdpageToken, pageSize, requireOpenJobsLists all companies associated with the project.
createinsertprojectsId, tenantsIdCreates a new company entity.
patchupdateprojectsId, tenantsId, companiesIdupdateMaskUpdates specified company.
deletedeleteprojectsId, tenantsId, companiesIdDeletes specified company. Prerequisite: The company has no jobs associated with it.

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
companiesIdstring
projectsIdstring
tenantsIdstring
pageSizeinteger (int32)
pageTokenstring
requireOpenJobsboolean
updateMaskstring (google-fieldmask)

SELECT examples​

Retrieves specified company.

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

INSERT examples​

Creates a new company entity.

INSERT INTO google.jobs.companies (
data__name,
data__displayName,
data__externalId,
data__size,
data__headquartersAddress,
data__hiringAgency,
data__eeoText,
data__websiteUri,
data__careerSiteUri,
data__imageUri,
data__keywordSearchableJobCustomAttributes,
projectsId,
tenantsId
)
SELECT 
'{{ name }}',
'{{ displayName }}',
'{{ externalId }}',
'{{ size }}',
'{{ headquartersAddress }}',
{{ hiringAgency }},
'{{ eeoText }}',
'{{ websiteUri }}',
'{{ careerSiteUri }}',
'{{ imageUri }}',
'{{ keywordSearchableJobCustomAttributes }}',
'{{ projectsId }}',
'{{ tenantsId }}'
RETURNING
name,
careerSiteUri,
derivedInfo,
displayName,
eeoText,
externalId,
headquartersAddress,
hiringAgency,
imageUri,
keywordSearchableJobCustomAttributes,
size,
suspended,
websiteUri
;

UPDATE examples​

Updates specified company.

UPDATE google.jobs.companies
SET 
data__name = '{{ name }}',
data__displayName = '{{ displayName }}',
data__externalId = '{{ externalId }}',
data__size = '{{ size }}',
data__headquartersAddress = '{{ headquartersAddress }}',
data__hiringAgency = {{ hiringAgency }},
data__eeoText = '{{ eeoText }}',
data__websiteUri = '{{ websiteUri }}',
data__careerSiteUri = '{{ careerSiteUri }}',
data__imageUri = '{{ imageUri }}',
data__keywordSearchableJobCustomAttributes = '{{ keywordSearchableJobCustomAttributes }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND tenantsId = '{{ tenantsId }}' --required
AND companiesId = '{{ companiesId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
careerSiteUri,
derivedInfo,
displayName,
eeoText,
externalId,
headquartersAddress,
hiringAgency,
imageUri,
keywordSearchableJobCustomAttributes,
size,
suspended,
websiteUri;

DELETE examples​

Deletes specified company. Prerequisite: The company has no jobs associated with it.

DELETE FROM google.jobs.companies
WHERE projectsId = '{{ projectsId }}' --required
AND tenantsId = '{{ tenantsId }}' --required
AND companiesId = '{{ companiesId }}' --required;