We’ve made the difficult decision to sunset Hire by Google on September 1, 2020. Learn more.

REST Resource: tenants.jobs

Resource: Job

A job in Hire.

JSON representation
{
  "name": string,
  "requisitionId": string,
  "createTime": string,
  "creatingUser": string,
  "title": string,
  "department": string,
  "employmentType": enum (EmploymentType),
  "timeCommitment": enum (TimeCommitment),
  "description": string,
  "hiringManagers": [
    string
  ],
  "recruiters": [
    string
  ],
  "coordinators": [
    string
  ],
  "state": enum (State),
  "publishState": enum (PublishState),
  "compensationInfo": {
    object (CompensationInfo)
  },
  "location": {
    object (Location)
  },
  "customFields": {
    object
  }
}
Fields
name

string

Output only. Required during jobs.patch.

The resource name of this Job. This is generated by the service when a job is created. Job name takes the form of "tenants/*/jobs/*".

requisitionId

string

Output only. Can be set on jobs.create.

Id used to link data with external systems.

createTime

string (Timestamp format)

Output only. Date the job was created or the date specified when importing this job.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

creatingUser

string

Optional. Resource name of the user that created the job. It must have the format of "tenants/*/users/*".

title

string

Required. The human readable job title.

department

string

Optional. Name of the department which the job is under.

employmentType

enum (EmploymentType)

Optional. Type of job.

timeCommitment

enum (TimeCommitment)

Optional. Time commitment level for the job.

description

string

Optional. Description of the job.

hiringManagers[]

string

List of resource names of the hiring managers for this job. They must have the format of "tenants/*/users/*".

recruiters[]

string

List of resource names of the recruiters for this job. They must have the format of "tenants/*/users/*".

coordinators[]

string

List of resource names of the coordinators for this job. They must have the format of "tenants/*/users/*".

state

enum (State)

Output only. Job state.

The set of available job states differ depending on job request approvals.

If job request approvals is off, then state can be Job.State.OPEN or Job.State.CLOSED, and all jobs can be edited.

If job request approvals is on, then all states are available. In Job.State.CLOSED, Job.State.DRAFT, and Job.State.APPROVAL_REJECTED states, the job can be edited. In Job.State.OPEN and Job.State.PENDING_APPROVAL states, no job fields can be edited.

Job req approvals can be toggled by a Hire admin at Admin > Approvals.

publishState

enum (PublishState)

Output Only.

Publish state of the job.

compensationInfo

object (CompensationInfo)

Optional. Compensation info for the job.

location

object (Location)

Optional. Location of the job.

customFields

object (Struct format)

Optional. Mapping of CustomFieldSpec name to value for all custom fields for this job.

EmploymentType

Specifies the type of a particular job.

Enums
EMPLOYMENT_TYPE_UNSPECIFIED Job is for an unspecified position type.
PERMANENT Job is for a permanent position.
CONTRACT Job is for a contractor position.
CONTRACT_TO_PERMANENT Contracting position looking to move to permanent.
INTERNSHIP Job is for an internship position.

TimeCommitment

Time commitment levels for a job.

Enums
TIME_COMMITMENT_UNSPECIFIED Time commitment level for job is unspecified.
FULL_TIME Full time position.
PART_TIME Part time position.

State

Job state.

Enums
STATE_UNSPECIFIED Job state is unspecified.
OPEN

Job is open and can be published.

If job req approvals are enabled, then the job is also approved.

CLOSED Job has been closed and is no longer accepting job applicants.
DRAFT

Only available if the tenant has job req approvals enabled.

Job is currently in draft state.

PENDING_APPROVAL

Only available if the tenant has job req approvals enabled.

The job has a pending approval request. When it has been approved, the Job.State will become OPEN. If it is rejected, the Job.State will become APPROVAL_REJECTED. If the request is canceled, the Job.State will become DRAFT.

APPROVAL_REJECTED

Only available if the tenant has job req approvals enabled.

One of more of the job approvers has rejected the previously PENDING_APPROVAL job.

PublishState

Job publish state.

Enums
PUBLISH_STATE_UNSPECIFIED Job publish state is unspecified.
NOT_PUBLISHED Only viewable internally, cannot be seen by job applicants.
PUBLISHED Job has been published and can be viewed externally and applied to by job applicants.

CompensationInfo

Compensation information.

JSON representation
{
  "frequency": enum (CompensationFrequency),
  "candidateVisible": boolean,

  // Union field compensation_amount can be only one of the following:
  "amount": {
    object (Money)
  },
  "range": {
    object (CompensationRange)
  }
  // End of list of possible types for union field compensation_amount.
}
Fields
frequency

enum (CompensationFrequency)

Optional. Compensation frequency.

candidateVisible

boolean

Optional. Indicates if compensation information is available to candidates.

Union field compensation_amount. Optional.

Compensation amount. It could be a fixed amount or a floating range. compensation_amount can be only one of the following:

amount

object (Money)

Optional. Compensation amount.

range

object (CompensationRange)

Optional. Compensation range.

CompensationRange

Compensation range.

JSON representation
{
  "minimum": {
    object (Money)
  },
  "maximum": {
    object (Money)
  }
}
Fields
minimum

object (Money)

Optional. Minimum compensation offered.

maximum

object (Money)

Optional. Maximum compensation offered.

CompensationFrequency

The frequency at which this job pays the compensation amount.

Enums
COMPENSATION_FREQUENCY_UNSPECIFIED Unspecified compensation frequency.
ANNUAL Compensation is calculated on an annual basis.
HOURLY Compensation is calculated on an hourly basis.

Location

Describes a Google Places API location with a unique place identifier and a structured addresses that will provide the written address.

JSON representation
{
  "placeId": string,
  "postalAddress": {
    object (PostalAddress)
  }
}
Fields
placeId

string

Optional. The placeId provided by Google Places API to uniquely identify a location.

postalAddress

object (PostalAddress)

Output only. Structured address, validated as real address.

Methods

create

Create a job in Hire.

delete

Delete a job in Hire.

get

Get a job in Hire.

list

List the jobs in Hire.

patch

Updates a job in Hire.