Types for Cloud Talent Solution API Client#

class google.cloud.talent_v4beta1.types.Activity#

Resource that represents an individual or collaborative activity participated in by a candidate, for example, an open-source project, a class assignment, and so on.

display_name#

Activity display name. Number of characters allowed is 100.

description#

Activity description. Number of characters allowed is 100,000.

uri#

Activity URI. Number of characters allowed is 4,000.

create_date#

The first creation date of the activity.

update_date#

The last update date of the activity.

team_members#

A list of team members involved in this activity. Number of characters allowed is 100. The limitation for max number of team members is 50.

skills_used#

A list of skills used in this activity. The limitation for max number of skills used is 50.

activity_name_snippet#

Output only. Activity name snippet shows how the [display_nam e][google.cloud.talent.v4beta1.Activity.display_name] is related to a search query. It’s empty if the [display_name][g oogle.cloud.talent.v4beta1.Activity.display_name] isn’t related to the search query.

activity_description_snippet#

Output only. Activity description snippet shows how the [descr iption][google.cloud.talent.v4beta1.Activity.description] is related to a search query. It’s empty if the [description][goo gle.cloud.talent.v4beta1.Activity.description] isn’t related to the search query.

skills_used_snippet#

Output only. Skill used snippet shows how the corresponding [s kills_used][google.cloud.talent.v4beta1.Activity.skills_used ] are related to a search query. It’s empty if the corresponding [skills_used][google.cloud.talent.v4beta1.Activ ity.skills_used] are not related to the search query.

activity_description_snippet

Field google.cloud.talent.v4beta1.Activity.activity_description_snippet

activity_name_snippet

Field google.cloud.talent.v4beta1.Activity.activity_name_snippet

create_date

Field google.cloud.talent.v4beta1.Activity.create_date

description

Field google.cloud.talent.v4beta1.Activity.description

display_name

Field google.cloud.talent.v4beta1.Activity.display_name

skills_used

Field google.cloud.talent.v4beta1.Activity.skills_used

skills_used_snippet

Field google.cloud.talent.v4beta1.Activity.skills_used_snippet

team_members

Field google.cloud.talent.v4beta1.Activity.team_members

update_date

Field google.cloud.talent.v4beta1.Activity.update_date

uri

Field google.cloud.talent.v4beta1.Activity.uri

class google.cloud.talent_v4beta1.types.AdditionalContactInfo#

Resource that represents contact information other than phone, email, URI and addresses.

usage#

The usage of this contact method. For example, SCHOOL, WORK, PERSONAL.

name#

The name of the contact method. For example, “hangout”, “skype”. Number of characters allowed is 100.

contact_id#

The contact id. Number of characters allowed is 100.

contact_id

Field google.cloud.talent.v4beta1.AdditionalContactInfo.contact_id

name

Field google.cloud.talent.v4beta1.AdditionalContactInfo.name

usage

Field google.cloud.talent.v4beta1.AdditionalContactInfo.usage

class google.cloud.talent_v4beta1.types.Address#

Resource that represents a address.

usage#

The usage of the address. For example, SCHOOL, WORK, PERSONAL.

address#

The address of a person. It can be one of [unstructured_addre ss][google.cloud.talent.v4beta1.Address.unstructured_address] or [structured_address][google.cloud.talent.v4beta1.Address.s tructured_address].

unstructured_address#

Unstructured address. For example, “1600 Amphitheatre Pkwy, Mountain View, CA 94043”, “Sunnyvale, California”. Number of characters allowed is 100.

structured_address#

Structured address that contains street address, city, state, country, and so on.

current#

Indicates if it’s the person’s current address.

current

Field google.cloud.talent.v4beta1.Address.current

structured_address

Field google.cloud.talent.v4beta1.Address.structured_address

unstructured_address

Field google.cloud.talent.v4beta1.Address.unstructured_address

usage

Field google.cloud.talent.v4beta1.Address.usage

class google.cloud.talent_v4beta1.types.Any#
type_url#

Field google.protobuf.Any.type_url

value#

Field google.protobuf.Any.value

class google.cloud.talent_v4beta1.types.Application#

Resource that represents a job application record of a candidate.

name#

Required during application update. Resource name assigned to an application by the API. The format is “projects/{project_ id}/tenants/{tenant_id}/profiles/{profile_id}/applications/{ application_id}”. For example, “projects/foo/tenants/bar/profiles/baz/applications/qux”.

external_id#

Required. Client side application identifier, used to uniquely identify the application. The maximum number of allowed characters is 255.

profile#

Output only. Resource name of the candidate of this application. The format is “projects/{project_id}/tenants/{t enant_id}/profiles/{profile_id}”. For example, “projects/foo/tenants/bar/profiles/baz”.

job#

One of either a job or a company is required. Resource name of the job which the candidate applied for. The format is “projects/{project_id}/tenants/{tenant_id}/jobs/{job_id}”. For example, “projects/foo/tenants/bar/jobs/baz”.

company#

One of either a job or a company is required. Resource name of the company which the candidate applied for. The format is “projects/{project_id}/tenants/{tenant_id}/companies/{compan y_id}”. For example, “projects/foo/tenants/bar/companies/baz”.

application_date#

The application date.

stage#

Required. What is the most recent stage of the application (that is, new, screen, send cv, hired, finished work)? This field is intentionally not comprehensive of every possible status, but instead, represents statuses that would be used to indicate to the ML models good / bad matches.

state#

The application state.

interviews#

All interviews (screen, onsite, and so on) conducted as part of this application (includes details such as user conducting the interview, timestamp, feedback, and so on).

referral#

If the candidate is referred by a employee.

create_time#

Required. Reflects the time that the application was created.

update_time#

The last update timestamp.

outcome_notes#

Free text reason behind the recruitement outcome (for example, reason for withdraw / reject, reason for an unsuccessful finish, and so on). Number of characters allowed is 100.

outcome#

Outcome positiveness shows how positive the outcome is.

is_match#

Output only. Indicates whether this job application is a match to application related filters. This value is only applicable in profile search response.

job_title_snippet#

Output only. Job title snippet shows how the job title is related to a search query. It’s empty if the job title isn’t related to the search query.

application_date

Field google.cloud.talent.v4beta1.Application.application_date

company

Field google.cloud.talent.v4beta1.Application.company

create_time

Field google.cloud.talent.v4beta1.Application.create_time

external_id

Field google.cloud.talent.v4beta1.Application.external_id

interviews

Field google.cloud.talent.v4beta1.Application.interviews

is_match

Field google.cloud.talent.v4beta1.Application.is_match

job

Field google.cloud.talent.v4beta1.Application.job

job_title_snippet

Field google.cloud.talent.v4beta1.Application.job_title_snippet

name

Field google.cloud.talent.v4beta1.Application.name

outcome

Field google.cloud.talent.v4beta1.Application.outcome

outcome_notes

Field google.cloud.talent.v4beta1.Application.outcome_notes

profile

Field google.cloud.talent.v4beta1.Application.profile

referral

Field google.cloud.talent.v4beta1.Application.referral

stage

Field google.cloud.talent.v4beta1.Application.stage

state

Field google.cloud.talent.v4beta1.Application.state

update_time

Field google.cloud.talent.v4beta1.Application.update_time

class google.cloud.talent_v4beta1.types.ApplicationDateFilter#

Application Date Range Filter.

The API matches profiles with [Application.application_date][google.cloud.talent.v4beta1.Application.application_date] between start date and end date (both boundaries are inclusive). The filter is ignored if both [start_date][google.cloud.talent.v4beta1.ApplicationDateFilter.start_date] and [end_date][google.cloud.talent.v4beta1.ApplicationDateFilter.end_date] are missing.

start_date#

Start date. If it’s missing, The API matches profiles with application date not after the end date.

end_date#

End date. If it’s missing, The API matches profiles with application date not before the start date.

end_date

Field google.cloud.talent.v4beta1.ApplicationDateFilter.end_date

start_date

Field google.cloud.talent.v4beta1.ApplicationDateFilter.start_date

class google.cloud.talent_v4beta1.types.ApplicationJobFilter#

Filter on the job information of Application.

job_requisition_id#

The job requisition id in the application. The API does an exact match on the [Job.requisition_id][google.cloud.talent.v 4beta1.Job.requisition_id] of [Application.job][google.cloud.talent.v4beta1.Application.job] in profiles.

job_title#

The job title in the application. The API does an exact match on the [Job.title][google.cloud.talent.v4beta1.Job.title] of [Application.job][google.cloud.talent.v4beta1.Application.job] in profiles.

negated#

If true, the API excludes all profiles with any [Application.job][google.cloud.talent.v4beta1.Application.job] matching the filters.

job_requisition_id

Field google.cloud.talent.v4beta1.ApplicationJobFilter.job_requisition_id

job_title

Field google.cloud.talent.v4beta1.ApplicationJobFilter.job_title

negated

Field google.cloud.talent.v4beta1.ApplicationJobFilter.negated

class google.cloud.talent_v4beta1.types.ApplicationOutcomeNotesFilter#

Outcome Notes Filter.

outcome_notes#

Required. User entered or selected outcome reason. The API does an exact match on the [Application.outcome_notes][google .cloud.talent.v4beta1.Application.outcome_notes] in profiles.

negated#

If true, The API excludes all candidates with any [Application .outcome_notes][google.cloud.talent.v4beta1.Application.outco me_notes] matching the outcome reason specified in the filter.

negated

Field google.cloud.talent.v4beta1.ApplicationOutcomeNotesFilter.negated

outcome_notes

Field google.cloud.talent.v4beta1.ApplicationOutcomeNotesFilter.outcome_notes

class google.cloud.talent_v4beta1.types.AvailabilityFilter#

Filter on availability signals.

signal_type#

Required. Type of signal to apply filter on.

range#

Required. Range of times to filter candidate signals by.

required#

If multiple [AvailabilityFilter][google.cloud.talent.v4beta1.A vailabilityFilter] are provided, the default behavior is to OR all filters, but if this field is set to true, this particular [AvailabilityFilter][google.cloud.talent.v4beta1.AvailabilityF ilter] will be AND’ed against other [AvailabilityFilter][googl e.cloud.talent.v4beta1.AvailabilityFilter].

range

Field google.cloud.talent.v4beta1.AvailabilityFilter.range

required

Field google.cloud.talent.v4beta1.AvailabilityFilter.required

signal_type

Field google.cloud.talent.v4beta1.AvailabilityFilter.signal_type

class google.cloud.talent_v4beta1.types.AvailabilitySignal#

Candidate availability signal.

type#

Type of signal.

last_update_time#

Timestamp of when the given availability activity last happened.

filter_satisfied#

Indicates if the [last_update_time][google.cloud.talent.v4be ta1.AvailabilitySignal.last_update_time] is within [Availabi lityFilter.range][google.cloud.talent.v4beta1.AvailabilityFilt er.range]. Returned only in a search response when there is an [AvailabilityFilter][google.cloud.talent.v4beta1.Availabili tyFilter] in [ProfileQuery.availability_filters][google.cloud .talent.v4beta1.ProfileQuery.availability_filters] where [sig nal_type][google.cloud.talent.v4beta1.AvailabilityFilter.sign al_type] matches [type][google.cloud.talent.v4beta1.AvailabilitySignal.type].

filter_satisfied

Field google.cloud.talent.v4beta1.AvailabilitySignal.filter_satisfied

last_update_time

Field google.cloud.talent.v4beta1.AvailabilitySignal.last_update_time

type

Field google.cloud.talent.v4beta1.AvailabilitySignal.type

class google.cloud.talent_v4beta1.types.BatchCreateJobsRequest#

Request to create a batch of jobs.

parent#

Required. The resource name of the tenant under which the job is created. The format is “projects/{project_id}/tenants/{tenant_id}”. For example, “projects/foo/tenant/bar”. If tenant id is unspecified, a default tenant is created. For example, “projects/foo”.

jobs#

Required. The jobs to be created.

jobs

Field google.cloud.talent.v4beta1.BatchCreateJobsRequest.jobs

parent

Field google.cloud.talent.v4beta1.BatchCreateJobsRequest.parent

class google.cloud.talent_v4beta1.types.BatchDeleteJobsRequest#

Batch delete jobs request.

parent#

Required. The resource name of the tenant under which the job is created. The format is “projects/{project_id}/tenants/{tenant_id}”. For example, “projects/foo/tenant/bar”. If tenant id is unspecified, a default tenant is created. For example, “projects/foo”.

filter#

Required. The filter string specifies the jobs to be deleted. Supported operator: =, AND The fields eligible for filtering are: - companyName (Required) - requisitionId (Required) Sample Query: companyName = “projects/foo/companies/bar” AND requisitionId = “req-1”

filter

Field google.cloud.talent.v4beta1.BatchDeleteJobsRequest.filter

parent

Field google.cloud.talent.v4beta1.BatchDeleteJobsRequest.parent

class google.cloud.talent_v4beta1.types.BatchOperationMetadata#

Metadata used for long running operations returned by CTS batch APIs. It’s used to replace [google.longrunning.Operation.metadata][google.longrunning.Operation.metadata].

state#

The state of a long running operation.

state_description#

More detailed information about operation state.

success_count#

Count of successful item(s) inside an operation.

failure_count#

Count of failed item(s) inside an operation.

total_count#

Count of total item(s) inside an operation.

create_time#

The time when the batch operation is created.

update_time#

The time when the batch operation status is updated. The metadata and the [update_time][google.cloud.talent.v4beta1.Ba tchOperationMetadata.update_time] is refreshed every minute otherwise cached data is returned.

end_time#

The time when the batch operation is finished and [google.long running.Operation.done][google.longrunning.Operation.done] is set to true.

create_time

Field google.cloud.talent.v4beta1.BatchOperationMetadata.create_time

end_time

Field google.cloud.talent.v4beta1.BatchOperationMetadata.end_time

failure_count

Field google.cloud.talent.v4beta1.BatchOperationMetadata.failure_count

state

Field google.cloud.talent.v4beta1.BatchOperationMetadata.state

state_description

Field google.cloud.talent.v4beta1.BatchOperationMetadata.state_description

success_count

Field google.cloud.talent.v4beta1.BatchOperationMetadata.success_count

total_count

Field google.cloud.talent.v4beta1.BatchOperationMetadata.total_count

update_time

Field google.cloud.talent.v4beta1.BatchOperationMetadata.update_time

class google.cloud.talent_v4beta1.types.BatchUpdateJobsRequest#

Request to update a batch of jobs.

parent#

Required. The resource name of the tenant under which the job is created. The format is “projects/{project_id}/tenants/{tenant_id}”. For example, “projects/foo/tenant/bar”. If tenant id is unspecified, a default tenant is created. For example, “projects/foo”.

jobs#

The jobs to be updated.

update_mask#

Strongly recommended for the best service experience. Be aware that it will also increase latency when checking the status of a batch operation. If [update_mask][google.cloud.talent.v4be ta1.BatchUpdateJobsRequest.update_mask] is provided, only the specified fields in [Job][google.cloud.talent.v4beta1.Job] are updated. Otherwise all the fields are updated. A field mask to restrict the fields that are updated. Only top level fields of [Job][google.cloud.talent.v4beta1.Job] are supported. If [ update_mask][google.cloud.talent.v4beta1.BatchUpdateJobsReque st.update_mask] is provided, The [Job][google.cloud.talent.v4beta1.Job] inside [JobResult][goog le.cloud.talent.v4beta1.JobOperationResult.JobResult] will only contains fields that is updated, plus the Id of the Job. Otherwise, [Job][google.cloud.talent.v4beta1.Job] will include all fields, which can yield a very large response.

jobs

Field google.cloud.talent.v4beta1.BatchUpdateJobsRequest.jobs

parent

Field google.cloud.talent.v4beta1.BatchUpdateJobsRequest.parent

update_mask

Field google.cloud.talent.v4beta1.BatchUpdateJobsRequest.update_mask

class google.cloud.talent_v4beta1.types.BoolValue#
value#

Field google.protobuf.BoolValue.value

class google.cloud.talent_v4beta1.types.BytesValue#
value#

Field google.protobuf.BytesValue.value

class google.cloud.talent_v4beta1.types.CancelOperationRequest#
name#

Field google.longrunning.CancelOperationRequest.name

class google.cloud.talent_v4beta1.types.CandidateAvailabilityFilter#

Deprecated. Use AvailabilityFilter instead.

Filter on availability signals.

negated#

It is false by default. If true, API excludes all the potential available profiles.

negated

Field google.cloud.talent.v4beta1.CandidateAvailabilityFilter.negated

class google.cloud.talent_v4beta1.types.Certification#

Resource that represents a license or certification.

display_name#

Name of license or certification. Number of characters allowed is 100.

acquire_date#

Acquisition date or effective date of license or certification.

expire_date#

Expiration date of license of certification.

authority#

Authority of license, such as government. Number of characters allowed is 100.

description#

Description of license or certification. Number of characters allowed is 100,000.

acquire_date

Field google.cloud.talent.v4beta1.Certification.acquire_date

authority

Field google.cloud.talent.v4beta1.Certification.authority

description

Field google.cloud.talent.v4beta1.Certification.description

display_name

Field google.cloud.talent.v4beta1.Certification.display_name

expire_date

Field google.cloud.talent.v4beta1.Certification.expire_date

class google.cloud.talent_v4beta1.types.ClientEvent#

An event issued when an end user interacts with the application that implements Cloud Talent Solution. Providing this information improves the quality of results for the API clients, enabling the service to perform optimally. The number of events sent must be consistent with other calls, such as job searches, issued to the service by the client.

request_id#

Strongly recommended for the best service experience. A unique ID generated in the API responses. It can be found in [ ResponseMetadata.request_id][google.cloud.talent.v4beta1.Resp onseMetadata.request_id].

event_id#

Required. A unique identifier, generated by the client application.

create_time#

Required. The timestamp of the event.

event#

Required. The detail information of a specific event type.

job_event#

An event issued when a job seeker interacts with the application that implements Cloud Talent Solution.

profile_event#

An event issued when a profile searcher interacts with the application that implements Cloud Talent Solution.

event_notes#

Notes about the event provided by recruiters or other users, for example, feedback on why a profile was bookmarked.

create_time

Field google.cloud.talent.v4beta1.ClientEvent.create_time

event_id

Field google.cloud.talent.v4beta1.ClientEvent.event_id

event_notes

Field google.cloud.talent.v4beta1.ClientEvent.event_notes

job_event

Field google.cloud.talent.v4beta1.ClientEvent.job_event

profile_event

Field google.cloud.talent.v4beta1.ClientEvent.profile_event

request_id

Field google.cloud.talent.v4beta1.ClientEvent.request_id

class google.cloud.talent_v4beta1.types.CommuteFilter#

Parameters needed for commute search.

commute_method#

Required. The method of transportation to calculate the commute time for.

start_coordinates#

Required. The latitude and longitude of the location to calculate the commute time from.

travel_duration#

Required. The maximum travel time in seconds. The maximum allowed value is 3600s (one hour). Format is 123s.

allow_imprecise_addresses#

If true, jobs without street level addresses may also be returned. For city level addresses, the city center is used. For state and coarser level addresses, text matching is used. If this field is set to false or isn’t specified, only jobs that include street level addresses will be returned by commute search.

traffic_option#

Traffic factor to take into account while searching by commute.

road_traffic#

Specifies the traffic density to use when calculating commute time.

departure_time#

The departure time used to calculate traffic impact, represented as [google.type.TimeOfDay][google.type.TimeOfDay] in local time zone. Currently traffic model is restricted to hour level resolution.

allow_imprecise_addresses

Field google.cloud.talent.v4beta1.CommuteFilter.allow_imprecise_addresses

commute_method

Field google.cloud.talent.v4beta1.CommuteFilter.commute_method

departure_time

Field google.cloud.talent.v4beta1.CommuteFilter.departure_time

road_traffic

Field google.cloud.talent.v4beta1.CommuteFilter.road_traffic

start_coordinates

Field google.cloud.talent.v4beta1.CommuteFilter.start_coordinates

travel_duration

Field google.cloud.talent.v4beta1.CommuteFilter.travel_duration

class google.cloud.talent_v4beta1.types.Company#

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

name#

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/{tenan t_id}/companies/{company_id}”, for example, “projects/foo/tenants/bar/companies/baz”. If tenant id is unspecified, the default tenant is used. For example, “projects/foo/companies/bar”.

display_name#

Required. The display name of the company, for example, “Google LLC”.

external_id#

Required. Client side company identifier, used to uniquely identify the company. The maximum number of allowed characters is 255.

size#

The employer’s company size.

headquarters_address#

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.headquarte rs_location][google.cloud.talent.v4beta1.Company.DerivedInfo. headquarters_location].

hiring_agency#

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

eeo_text#

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.

website_uri#

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.

career_site_uri#

The URI to employer’s career site or careers page on the employer’s web site, for example, “https://careers.google.com”.

image_uri#

A URI that hosts the employer’s company logo.

keyword_searchable_job_custom_attributes#

A list of keys of filterable [Job.custom_attributes][google.c loud.talent.v4beta1.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.

derived_info#

Output only. Derived details about the company.

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.

class DerivedInfo#

Derived details about the company.

headquarters_location#

A structured headquarters location of the company, resolved from [Company.headquarters_address][google.cloud.talent.v4bet a1.Company.headquarters_address] if provided.

headquarters_location

Field google.cloud.talent.v4beta1.Company.DerivedInfo.headquarters_location

career_site_uri

Field google.cloud.talent.v4beta1.Company.career_site_uri

derived_info

Field google.cloud.talent.v4beta1.Company.derived_info

display_name

Field google.cloud.talent.v4beta1.Company.display_name

eeo_text

Field google.cloud.talent.v4beta1.Company.eeo_text

external_id

Field google.cloud.talent.v4beta1.Company.external_id

headquarters_address

Field google.cloud.talent.v4beta1.Company.headquarters_address

hiring_agency

Field google.cloud.talent.v4beta1.Company.hiring_agency

image_uri

Field google.cloud.talent.v4beta1.Company.image_uri

keyword_searchable_job_custom_attributes

Field google.cloud.talent.v4beta1.Company.keyword_searchable_job_custom_attributes

name

Field google.cloud.talent.v4beta1.Company.name

size

Field google.cloud.talent.v4beta1.Company.size

suspended

Field google.cloud.talent.v4beta1.Company.suspended

website_uri

Field google.cloud.talent.v4beta1.Company.website_uri

class google.cloud.talent_v4beta1.types.CompensationFilter#

Filter on job compensation type and amount.

type#

Required. Type of filter.

units#

Required. Specify desired base compensation entry's [Compe nsationInfo.CompensationUnit][google.cloud.talent.v4beta1.Comp ensationInfo.CompensationUnit].

range#

Compensation range.

include_jobs_with_unspecified_compensation_range#

If set to true, jobs with unspecified compensation range fields are included.

include_jobs_with_unspecified_compensation_range

Field google.cloud.talent.v4beta1.CompensationFilter.include_jobs_with_unspecified_compensation_range

range

Field google.cloud.talent.v4beta1.CompensationFilter.range

type

Field google.cloud.talent.v4beta1.CompensationFilter.type

units

Field google.cloud.talent.v4beta1.CompensationFilter.units

class google.cloud.talent_v4beta1.types.CompensationInfo#

Job compensation details.

entries#

Job compensation information. At most one entry can be of type [CompensationInfo.CompensationType.BASE][google.cloud.tal ent.v4beta1.CompensationInfo.CompensationType.BASE], which is referred as base compensation entry for the job.

annualized_base_compensation_range#

Output only. Annualized base compensation range. Computed as base compensation entry’s [CompensationEntry.amount][google.cl oud.talent.v4beta1.CompensationInfo.CompensationEntry.amount] times [CompensationEntry.expected_units_per_year][google.cl oud.talent.v4beta1.CompensationInfo.CompensationEntry.expected _units_per_year]. See [CompensationEntry][google.cloud.tal ent.v4beta1.CompensationInfo.CompensationEntry] for explanation on compensation annualization.

annualized_total_compensation_range#

Output only. Annualized total compensation range. Computed as all compensation entries’ [CompensationEntry.amount][google.cl oud.talent.v4beta1.CompensationInfo.CompensationEntry.amount] times [CompensationEntry.expected_units_per_year][google.cl oud.talent.v4beta1.CompensationInfo.CompensationEntry.expected _units_per_year]. See [CompensationEntry][google.cloud.tal ent.v4beta1.CompensationInfo.CompensationEntry] for explanation on compensation annualization.

class CompensationEntry#

A compensation entry that represents one component of compensation, such as base pay, bonus, or other compensation type.

Annualization: One compensation entry can be annualized if - it contains valid [amount][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.amount] or [range][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.range]. - and its [expected_units_per_year][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.expected_units_per_year] is set or can be derived. Its annualized range is determined as ([amount][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.amount] or [range][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.range]) times [expected_units_per_year][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.expected_units_per_year].

type#

Compensation type. Default is [CompensationType.COMPENSATION _TYPE_UNSPECIFIED][google.cloud.talent.v4beta1.CompensationIn fo.CompensationType.COMPENSATION_TYPE_UNSPECIFIED].

unit#

Frequency of the specified amount. Default is [CompensationUn it.COMPENSATION_UNIT_UNSPECIFIED][google.cloud.talent.v4beta 1.CompensationInfo.CompensationUnit.COMPENSATION_UNIT_UNSPEC IFIED].

compensation_amount#

Compensation amount. It could be a fixed amount or a floating range.

amount#

Compensation amount.

range#

Compensation range.

description#

Compensation description. For example, could indicate equity terms or provide additional context to an estimated bonus.

expected_units_per_year#

Expected number of units paid each year. If not specified, when [Job.employment_types][google.cloud.talent.v4beta1.Job.e mployment_types] is FULLTIME, a default value is inferred based on [unit][google.cloud.talent.v4beta1.CompensationInfo.C ompensationEntry.unit]. Default values: - HOURLY: 2080 - DAILY: 260 - WEEKLY: 52 - MONTHLY: 12 - ANNUAL: 1

amount

Field google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.amount

description

Field google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.description

expected_units_per_year

Field google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.expected_units_per_year

range

Field google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.range

type

Field google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.type

unit

Field google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.unit

class CompensationRange#

Compensation range.

max_compensation#

The maximum amount of compensation. If left empty, the value is set to a maximal compensation value and the currency code is set to match the [currency code][google.type.Money.currency_code] of min_compensation.

min_compensation#

The minimum amount of compensation. If left empty, the value is set to zero and the currency code is set to match the [currency code][google.type.Money.currency_code] of max_compensation.

max_compensation

Field google.cloud.talent.v4beta1.CompensationInfo.CompensationRange.max_compensation

min_compensation

Field google.cloud.talent.v4beta1.CompensationInfo.CompensationRange.min_compensation

annualized_base_compensation_range

Field google.cloud.talent.v4beta1.CompensationInfo.annualized_base_compensation_range

annualized_total_compensation_range

Field google.cloud.talent.v4beta1.CompensationInfo.annualized_total_compensation_range

entries

Field google.cloud.talent.v4beta1.CompensationInfo.entries

class google.cloud.talent_v4beta1.types.CompleteQueryRequest#

Auto-complete parameters.

parent#

Required. Resource name of tenant the completion is performed within. The format is “projects/{project_id}/tenants/{tenant_id}”, for example, “projects/foo/tenant/bar”. If tenant id is unspecified, the default tenant is used, for example, “projects/foo”.

query#

Required. The query used to generate suggestions. The maximum number of allowed characters is 255.

language_codes#

The list of languages of the query. This is the BCP-47 language code, such as “en-US” or “sr-Latn”. For more information, see Tags for Identifying Languages. For [CompletionType.J OB_TITLE][google.cloud.talent.v4beta1.CompleteQueryRequest.Co mpletionType.JOB_TITLE] type, only open jobs with the same [l anguage_codes][google.cloud.talent.v4beta1.CompleteQueryReque st.language_codes] are returned. For [CompletionType.COMPANY _NAME][google.cloud.talent.v4beta1.CompleteQueryRequest.Compl etionType.COMPANY_NAME] type, only companies having open jobs with the same [language_codes][google.cloud.talent.v4beta1.Co mpleteQueryRequest.language_codes] are returned. For [Comple tionType.COMBINED][google.cloud.talent.v4beta1.CompleteQueryRe quest.CompletionType.COMBINED] type, only open jobs with the same [language_codes][google.cloud.talent.v4beta1.CompleteQue ryRequest.language_codes] or companies having open jobs with the same [language_codes][google.cloud.talent.v4beta1.Complet eQueryRequest.language_codes] are returned. The maximum number of allowed characters is 255.

page_size#

Required. Completion result count. The maximum allowed page size is 10.

company#

If provided, restricts completion to specified company. The format is “projects/{project_id}/tenants/{tenant_id}/compani es/{company_id}”, for example, “projects/foo/tenants/bar/companies/baz”. If tenant id is unspecified, the default tenant is used, for example, “projects/foo”.

scope#

The scope of the completion. The defaults is [CompletionScope. PUBLIC][google.cloud.talent.v4beta1.CompleteQueryRequest.Compl etionScope.PUBLIC].

type#

The completion topic. The default is [CompletionType.COMBINED] [google.cloud.talent.v4beta1.CompleteQueryRequest.CompletionTy pe.COMBINED].

company

Field google.cloud.talent.v4beta1.CompleteQueryRequest.company

language_codes

Field google.cloud.talent.v4beta1.CompleteQueryRequest.language_codes

page_size

Field google.cloud.talent.v4beta1.CompleteQueryRequest.page_size

parent

Field google.cloud.talent.v4beta1.CompleteQueryRequest.parent

query

Field google.cloud.talent.v4beta1.CompleteQueryRequest.query

scope

Field google.cloud.talent.v4beta1.CompleteQueryRequest.scope

type

Field google.cloud.talent.v4beta1.CompleteQueryRequest.type

class google.cloud.talent_v4beta1.types.CompleteQueryResponse#

Response of auto-complete query.

completion_results#

Results of the matching job/company candidates.

metadata#

Additional information for the API invocation, such as the request tracking id.

class CompletionResult#

Resource that represents completion results.

suggestion#

The suggestion for the query.

type#

The completion topic.

image_uri#

The URI of the company image for [COMPANY_NAME][google.cloud. talent.v4beta1.CompleteQueryRequest.CompletionType.COMPANY_NA ME].

image_uri

Field google.cloud.talent.v4beta1.CompleteQueryResponse.CompletionResult.image_uri

suggestion

Field google.cloud.talent.v4beta1.CompleteQueryResponse.CompletionResult.suggestion

type

Field google.cloud.talent.v4beta1.CompleteQueryResponse.CompletionResult.type

completion_results

Field google.cloud.talent.v4beta1.CompleteQueryResponse.completion_results

metadata

Field google.cloud.talent.v4beta1.CompleteQueryResponse.metadata

class google.cloud.talent_v4beta1.types.CreateApplicationRequest#

The Request of the CreateApplication method.

parent#

Required. Resource name of the profile under which the application is created. The format is “projects/{project_id} /tenants/{tenant_id}/profiles/{profile_id}”. For example, “projects/foo/tenants/bar/profiles/baz”.

application#

Required. The application to be created.

application

Field google.cloud.talent.v4beta1.CreateApplicationRequest.application

parent

Field google.cloud.talent.v4beta1.CreateApplicationRequest.parent

class google.cloud.talent_v4beta1.types.CreateClientEventRequest#

The report event request.

parent#

Required. Resource name of the tenant under which the event is created. The format is “projects/{project_id}/tenants/{tenant_id}”, for example, “projects/foo/tenant/bar”. If tenant id is unspecified, a default tenant is created, for example, “projects/foo”.

client_event#

Required. Events issued when end user interacts with customer’s application that uses Cloud Talent Solution.

client_event

Field google.cloud.talent.v4beta1.CreateClientEventRequest.client_event

parent

Field google.cloud.talent.v4beta1.CreateClientEventRequest.parent

class google.cloud.talent_v4beta1.types.CreateCompanyRequest#

The Request of the CreateCompany method.

parent#

Required. Resource name of the tenant under which the company is created. The format is “projects/{project_id}/tenants/{tenant_id}”, for example, “projects/foo/tenant/bar”. If tenant id is unspecified, a default tenant is created, for example, “projects/foo”.

company#

Required. The company to be created.

company

Field google.cloud.talent.v4beta1.CreateCompanyRequest.company

parent

Field google.cloud.talent.v4beta1.CreateCompanyRequest.parent

class google.cloud.talent_v4beta1.types.CreateJobRequest#

Create job request.

parent#

Required. The resource name of the tenant under which the job is created. The format is “projects/{project_id}/tenants/{tenant_id}”. For example, “projects/foo/tenant/bar”. If tenant id is unspecified a default tenant is created. For example, “projects/foo”.

job#

Required. The Job to be created.

job

Field google.cloud.talent.v4beta1.CreateJobRequest.job

parent

Field google.cloud.talent.v4beta1.CreateJobRequest.parent

class google.cloud.talent_v4beta1.types.CreateProfileRequest#

Create profile request.

parent#

Required. The name of the tenant this profile belongs to. The format is “projects/{project_id}/tenants/{tenant_id}”. For example, “projects/foo/tenants/bar”.

profile#

Required. The profile to be created.

parent

Field google.cloud.talent.v4beta1.CreateProfileRequest.parent

profile

Field google.cloud.talent.v4beta1.CreateProfileRequest.profile

class google.cloud.talent_v4beta1.types.CreateTenantRequest#

The Request of the CreateTenant method.

parent#

Required. Resource name of the project under which the tenant is created. The format is “projects/{project_id}”, for example, “projects/foo”.

tenant#

Required. The tenant to be created.

parent

Field google.cloud.talent.v4beta1.CreateTenantRequest.parent

tenant

Field google.cloud.talent.v4beta1.CreateTenantRequest.tenant

class google.cloud.talent_v4beta1.types.CustomAttribute#

Custom attribute values that are either filterable or non-filterable.

string_values#

Exactly one of [string_values][google.cloud.talent.v4beta1.Cu stomAttribute.string_values] or [long_values][google.cloud.t alent.v4beta1.CustomAttribute.long_values] must be specified. This field is used to perform a string match (CASE_SENSITIVE_MATCH or CASE_INSENSITIVE_MATCH) search. For filterable string_values, a maximum total number of 200 values is allowed, with each string_value has a byte size of no more than 500B. For unfilterable string_values, the maximum total byte size of unfilterable string_values is 50KB. Empty string isn’t allowed.

long_values#

Exactly one of [string_values][google.cloud.talent.v4beta1.Cu stomAttribute.string_values] or [long_values][google.cloud.t alent.v4beta1.CustomAttribute.long_values] must be specified. This field is used to perform number range search. (EQ, GT, GE, LE, LT) over filterable long_value. Currently at most 1 [long_values][google.clo ud.talent.v4beta1.CustomAttribute.long_values] is supported.

filterable#

If the filterable flag is true, custom field values are searchable. If false, values are not searchable. Default is false.

filterable

Field google.cloud.talent.v4beta1.CustomAttribute.filterable

long_values

Field google.cloud.talent.v4beta1.CustomAttribute.long_values

string_values

Field google.cloud.talent.v4beta1.CustomAttribute.string_values

class google.cloud.talent_v4beta1.types.Date#
day#

Field google.type.Date.day

month#

Field google.type.Date.month

year#

Field google.type.Date.year

class google.cloud.talent_v4beta1.types.Degree#

Resource that represents a degree pursuing or acquired by a candidate.

degree_type#

ISCED degree type.

degree_name#

Full Degree name. For example, “B.S.”, “Master of Arts”, and so on. Number of characters allowed is 100.

fields_of_study#

Fields of study for the degree. For example, “Computer science”, “engineering”. Number of characters allowed is 100.

degree_name

Field google.cloud.talent.v4beta1.Degree.degree_name

degree_type

Field google.cloud.talent.v4beta1.Degree.degree_type

fields_of_study

Field google.cloud.talent.v4beta1.Degree.fields_of_study

class google.cloud.talent_v4beta1.types.DeleteApplicationRequest#

Request to delete a application.

name#

Required. The resource name of the application to be deleted. The format is “projects/{project_id}/tenants/{tenant_id}/pro files/{profile_id}/applications/{application_id}”. For example, “projects/foo/tenants/bar/profiles/baz/applications/qux”.

name

Field google.cloud.talent.v4beta1.DeleteApplicationRequest.name

class google.cloud.talent_v4beta1.types.DeleteCompanyRequest#

Request to delete a company.

name#

Required. The resource name of the company to be deleted. The format is “projects/{project_id}/tenants/{tenant_id}/compani es/{company_id}”, for example, “projects/foo/tenants/bar/companies/baz”. If tenant id is unspecified, the default tenant is used, for example, “projects/foo/companies/bar”.

name

Field google.cloud.talent.v4beta1.DeleteCompanyRequest.name

class google.cloud.talent_v4beta1.types.DeleteJobRequest#

Delete job request.

name#

Required. The resource name of the job to be deleted. The format is “projects/{project_id}/tenants/{tenant_id}/jobs/{job_id}”. For example, “projects/foo/tenants/bar/jobs/baz”. If tenant id is unspecified, the default tenant is used. For example, “projects/foo/jobs/bar”.

name

Field google.cloud.talent.v4beta1.DeleteJobRequest.name

class google.cloud.talent_v4beta1.types.DeleteOperationRequest#
name#

Field google.longrunning.DeleteOperationRequest.name

class google.cloud.talent_v4beta1.types.DeleteProfileRequest#

Delete profile request.

name#

Required. Resource name of the profile to be deleted. The format is “projects/{project_id}/tenants/{tenant_id}/profile s/{profile_id}”. For example, “projects/foo/tenants/bar/profiles/baz”.

name

Field google.cloud.talent.v4beta1.DeleteProfileRequest.name

class google.cloud.talent_v4beta1.types.DeleteTenantRequest#

Request to delete a tenant.

name#

Required. The resource name of the tenant to be deleted. The format is “projects/{project_id}/tenants/{tenant_id}”, for example, “projects/foo/tenants/bar”.

name

Field google.cloud.talent.v4beta1.DeleteTenantRequest.name

class google.cloud.talent_v4beta1.types.DeviceInfo#

Device information collected from the job seeker, candidate, or other entity conducting the job search. Providing this information improves the quality of the search results across devices.

device_type#

Type of the device.

id#

A device-specific ID. The ID must be a unique identifier that distinguishes the device from other devices.

device_type

Field google.cloud.talent.v4beta1.DeviceInfo.device_type

id

Field google.cloud.talent.v4beta1.DeviceInfo.id

class google.cloud.talent_v4beta1.types.DoubleValue#
value#

Field google.protobuf.DoubleValue.value

class google.cloud.talent_v4beta1.types.Duration#
nanos#

Field google.protobuf.Duration.nanos

seconds#

Field google.protobuf.Duration.seconds

class google.cloud.talent_v4beta1.types.EducationFilter#

Education filter of the search.

school#

The school name. For example “MIT”, “University of California, Berkeley”.

field_of_study#

The field of study. This is to search against value provided in [Degree.fields_of_study][google.cloud.talent.v4beta1.Degr ee.fields_of_study]. For example “Computer Science”, “Mathematics”.

degree_type#

Education degree in ISCED code. Each value in degree covers a specific level of education, without any expansion to upper nor lower levels of education degree.

negated#

Whether to apply negation to the filter so profiles matching the filter is excluded.

degree_type

Field google.cloud.talent.v4beta1.EducationFilter.degree_type

field_of_study

Field google.cloud.talent.v4beta1.EducationFilter.field_of_study

negated

Field google.cloud.talent.v4beta1.EducationFilter.negated

school

Field google.cloud.talent.v4beta1.EducationFilter.school

class google.cloud.talent_v4beta1.types.EducationRecord#

Resource that represents an education record of a candidate.

start_date#

The start date of the education.

end_date#

The end date of the education.

expected_graduation_date#

The expected graduation date if currently pursuing a degree.

school_name#

The name of the school or institution. For example, “Stanford University”, “UC Berkeley”, and so on. Number of characters allowed is 250.

address#

The physical address of the education institution.

degree#

The degree information. It can be one of [degree_description] [google.cloud.talent.v4beta1.EducationRecord.degree_descripti on] or [structured_degree][google.cloud.talent.v4beta1.Educat ionRecord.structured_degree].

degree_description#

The full description of the degree. For example, “Master of Science in Computer Science”, “B.S in Math”. Number of characters allowed is 100.

structured_degree#

The structured notation of the degree.

description#

The description of the education. Number of characters allowed is 100,000.

is_current#

If this education is current.

school_name_snippet#

Output only. The school name snippet shows how the [school_na me][google.cloud.talent.v4beta1.EducationRecord.school_name] is related to a search query in search result. It’s empty if the [school_name][google.cloud.talent.v4beta1.EducationRecord .school_name] isn’t related to the search query.

degree_snippet#

Output only. The job description snippet shows how the [Degree][google.cloud.talent.v4beta1.Degree] is related to a search query in search result. It’s empty if the [Degree][google.cloud.talent.v4beta1.Degree] isn’t related to the search query.

address

Field google.cloud.talent.v4beta1.EducationRecord.address

degree_description

Field google.cloud.talent.v4beta1.EducationRecord.degree_description

degree_snippet

Field google.cloud.talent.v4beta1.EducationRecord.degree_snippet

description

Field google.cloud.talent.v4beta1.EducationRecord.description

end_date

Field google.cloud.talent.v4beta1.EducationRecord.end_date

expected_graduation_date

Field google.cloud.talent.v4beta1.EducationRecord.expected_graduation_date

is_current

Field google.cloud.talent.v4beta1.EducationRecord.is_current

school_name

Field google.cloud.talent.v4beta1.EducationRecord.school_name

school_name_snippet

Field google.cloud.talent.v4beta1.EducationRecord.school_name_snippet

start_date

Field google.cloud.talent.v4beta1.EducationRecord.start_date

structured_degree

Field google.cloud.talent.v4beta1.EducationRecord.structured_degree

class google.cloud.talent_v4beta1.types.Email#

Resource that represents a person’s email address.

usage#

The usage of the email address. For example, SCHOOL, WORK, PERSONAL.

email_address#

Email address. Number of characters allowed is 4,000.

email_address

Field google.cloud.talent.v4beta1.Email.email_address

usage

Field google.cloud.talent.v4beta1.Email.usage

class google.cloud.talent_v4beta1.types.EmployerFilter#

Employer filter of the search.

employer#

Required. The name of the employer, for example “Google”, “Alphabet”.

mode#

Define set of [EmploymentRecord][google.cloud.talent.v4beta1.E mploymentRecord]s to search against. Defaults to [EmployerFil terMode.ALL_EMPLOYMENT_RECORDS][google.cloud.talent.v4beta1. EmployerFilter.EmployerFilterMode.ALL_EMPLOYMENT_RECORDS].

negated#

Whether to apply negation to the filter so profiles matching the filter is excluded.

employer

Field google.cloud.talent.v4beta1.EmployerFilter.employer

mode

Field google.cloud.talent.v4beta1.EmployerFilter.mode

negated

Field google.cloud.talent.v4beta1.EmployerFilter.negated

class google.cloud.talent_v4beta1.types.EmploymentRecord#

Resource that represents an employment record of a candidate.

start_date#

Start date of the employment.

end_date#

End date of the employment.

employer_name#

The name of the employer company/organization. For example, “Google”, “Alphabet”, and so on. Number of characters allowed is 250.

division_name#

The division name of the employment. For example, division, department, client, and so on. Number of characters allowed is 100.

address#

The physical address of the employer.

job_title#

The job title of the employment. For example, “Software Engineer”, “Data Scientist”, and so on. Number of characters allowed is 250.

job_description#

The description of job content. Number of characters allowed is 100,000.

is_supervisor#

If the jobs is a supervisor position.

is_self_employed#

If this employment is self-employed.

is_current#

If this employment is current.

job_title_snippet#

Output only. The job title snippet shows how the [job_title][ google.cloud.talent.v4beta1.EmploymentRecord.job_title] is related to a search query. It’s empty if the [job_title][goog le.cloud.talent.v4beta1.EmploymentRecord.job_title] isn’t related to the search query.

job_description_snippet#

Output only. The job description snippet shows how the [job_d escription][google.cloud.talent.v4beta1.EmploymentRecord.job_ description] is related to a search query. It’s empty if the [ job_description][google.cloud.talent.v4beta1.EmploymentRecord .job_description] isn’t related to the search query.

employer_name_snippet#

Output only. The employer name snippet shows how the [employer _name][google.cloud.talent.v4beta1.EmploymentRecord.employer _name] is related to a search query. It’s empty if the [employ er_name][google.cloud.talent.v4beta1.EmploymentRecord.employe r_name] isn’t related to the search query.

address

Field google.cloud.talent.v4beta1.EmploymentRecord.address

division_name

Field google.cloud.talent.v4beta1.EmploymentRecord.division_name

employer_name

Field google.cloud.talent.v4beta1.EmploymentRecord.employer_name

employer_name_snippet

Field google.cloud.talent.v4beta1.EmploymentRecord.employer_name_snippet

end_date

Field google.cloud.talent.v4beta1.EmploymentRecord.end_date

is_current

Field google.cloud.talent.v4beta1.EmploymentRecord.is_current

is_self_employed

Field google.cloud.talent.v4beta1.EmploymentRecord.is_self_employed

is_supervisor

Field google.cloud.talent.v4beta1.EmploymentRecord.is_supervisor

job_description

Field google.cloud.talent.v4beta1.EmploymentRecord.job_description

job_description_snippet

Field google.cloud.talent.v4beta1.EmploymentRecord.job_description_snippet

job_title

Field google.cloud.talent.v4beta1.EmploymentRecord.job_title

job_title_snippet

Field google.cloud.talent.v4beta1.EmploymentRecord.job_title_snippet

start_date

Field google.cloud.talent.v4beta1.EmploymentRecord.start_date

class google.cloud.talent_v4beta1.types.Empty#
class google.cloud.talent_v4beta1.types.FieldMask#
paths#

Field google.protobuf.FieldMask.paths

class google.cloud.talent_v4beta1.types.FloatValue#
value#

Field google.protobuf.FloatValue.value

class google.cloud.talent_v4beta1.types.GetApplicationRequest#

Request for getting a application by name.

name#

Required. The resource name of the application to be retrieved. The format is “projects/{project_id}/tenants/{ten ant_id}/profiles/{profile_id}/applications/{application_id} “. For example, “projects/foo/tenants/bar/profiles/baz/applications/qux”.

name

Field google.cloud.talent.v4beta1.GetApplicationRequest.name

class google.cloud.talent_v4beta1.types.GetCompanyRequest#

Request for getting a company by name.

name#

Required. The resource name of the company to be retrieved. The format is “projects/{project_id}/tenants/{tenant_id}/com panies/{company_id}”, for example, “projects/api-test- project/tenants/foo/companies/bar”. If tenant id is unspecified, the default tenant is used, for example, “projects/api-test-project/companies/bar”.

name

Field google.cloud.talent.v4beta1.GetCompanyRequest.name

class google.cloud.talent_v4beta1.types.GetJobRequest#

Get job request.

name#

Required. The resource name of the job to retrieve. The format is “projects/{project_id}/tenants/{tenant_id}/jobs/{job_id}”. For example, “projects/foo/tenants/bar/jobs/baz”. If tenant id is unspecified, the default tenant is used. For example, “projects/foo/jobs/bar”.

name

Field google.cloud.talent.v4beta1.GetJobRequest.name

class google.cloud.talent_v4beta1.types.GetOperationRequest#
name#

Field google.longrunning.GetOperationRequest.name

class google.cloud.talent_v4beta1.types.GetProfileRequest#

Get profile request.

name#

Required. Resource name of the profile to get. The format is “projects/{project_id}/tenants/{tenant_id}/profiles/{profile _id}”. For example, “projects/foo/tenants/bar/profiles/baz”.

name

Field google.cloud.talent.v4beta1.GetProfileRequest.name

class google.cloud.talent_v4beta1.types.GetTenantRequest#

Request for getting a tenant by name.

name#

Required. The resource name of the tenant to be retrieved. The format is “projects/{project_id}/tenants/{tenant_id}”, for example, “projects/foo/tenants/bar”.

name

Field google.cloud.talent.v4beta1.GetTenantRequest.name

class google.cloud.talent_v4beta1.types.HistogramQuery#

The histogram request.

histogram_query#

An expression specifies a histogram request against matching resources (for example, jobs, profiles) for searches. See [Se archJobsRequest.histogram_queries][google.cloud.talent.v4beta 1.SearchJobsRequest.histogram_queries] and [SearchProfilesReq uest.histogram_queries][google.cloud.talent.v4beta1.SearchPro filesRequest.histogram_queries] for details about syntax.

histogram_query

Field google.cloud.talent.v4beta1.HistogramQuery.histogram_query

class google.cloud.talent_v4beta1.types.HistogramQueryResult#

Histogram result that matches [HistogramQuery][google.cloud.talent.v4beta1.HistogramQuery] specified in searches.

histogram_query#

Requested histogram expression.

histogram#

A map from the values of the facet associated with distinct values to the number of matching entries with corresponding value. The key format is: - (for string histogram) string values stored in the field. - (for named numeric bucket) name specified in bucket() function, like for bucket(0, MAX, "non-negative"), the key will be non-negative. - (for anonymous numeric bucket) range formatted as <low>-<high>, for example, 0-1000, MIN-0, and 0-MAX.

class HistogramEntry#
key#

Field google.cloud.talent.v4beta1.HistogramQueryResult.HistogramEntry.key

value#

Field google.cloud.talent.v4beta1.HistogramQueryResult.HistogramEntry.value

histogram

Field google.cloud.talent.v4beta1.HistogramQueryResult.histogram

histogram_query

Field google.cloud.talent.v4beta1.HistogramQueryResult.histogram_query

class google.cloud.talent_v4beta1.types.Int32Value#
value#

Field google.protobuf.Int32Value.value

class google.cloud.talent_v4beta1.types.Int64Value#
value#

Field google.protobuf.Int64Value.value

class google.cloud.talent_v4beta1.types.Interview#

Details of an interview.

rating#

The rating on this interview.

outcome#

Required. The overall decision resulting from this interview (positive, negative, nuetral).

outcome

Field google.cloud.talent.v4beta1.Interview.outcome

rating

Field google.cloud.talent.v4beta1.Interview.rating

class google.cloud.talent_v4beta1.types.Job#

A Job resource represents a job posting (also referred to as a “job listing” or “job requisition”). A job belongs to a [Company][google.cloud.talent.v4beta1.Company], which is the hiring entity responsible for the job.

name#

Required during job update. The resource name for the job. This is generated by the service when a job is created. The format is “projects/{project_id}/tenants/{tenant_id}/jobs/{job_id}”. For example, “projects/foo/tenants/bar/jobs/baz”. If tenant id is unspecified, the default tenant is used. For example, “projects/foo/jobs/bar”. Use of this field in job queries and API calls is preferred over the use of [requisition_id][googl e.cloud.talent.v4beta1.Job.requisition_id] since this value is unique.

company#

Required. The resource name of the company listing the job. The format is “projects/{project_id}/tenants/{tenant_id}/com panies/{company_id}”. For example, “projects/foo/tenants/bar/companies/baz”. If tenant id is unspecified, the default tenant is used. For example, “projects/foo/companies/bar”.

requisition_id#

Required. The requisition ID, also referred to as the posting ID, is assigned by the client to identify a job. This field is intended to be used by clients for client identification and tracking of postings. A job isn’t allowed to be created if there is another job with the same [company][google.cloud.talent.v4beta1.Job.name], [language_co de][google.cloud.talent.v4beta1.Job.language_code] and [requi sition_id][google.cloud.talent.v4beta1.Job.requisition_id]. The maximum number of allowed characters is 255.

title#

Required. The title of the job, such as “Software Engineer” The maximum number of allowed characters is 500.

description#

Required. The description of the job, which typically includes a multi-paragraph description of the company and related information. Separate fields are provided on the job object for [responsibilities][google.cloud.talent.v4beta1.Job.respons ibilities], [qualifications][google.cloud.talent.v4beta1.Job.q ualifications], and other job characteristics. Use of these separate job fields is recommended. This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags. The maximum number of allowed characters is 100,000.

addresses#

Strongly recommended for the best service experience. Location(s) where the employer is looking to hire for this job posting. Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time. At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique [requisit ion_id][google.cloud.talent.v4beta1.Job.requisition_id]s (e.g. ‘ReqA’ becomes ‘ReqA-1’, ‘ReqA-2’, and so on.) as multiple jobs with the same [company][google.cloud.talent.v4beta1.Job.company], [language _code][google.cloud.talent.v4beta1.Job.language_code] and [re quisition_id][google.cloud.talent.v4beta1.Job.requisition_id ] are not allowed. If the original [requisition_id][google.cl oud.talent.v4beta1.Job.requisition_id] must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience. The maximum number of allowed characters is 500.

application_info#

Job application information.

job_benefits#

The benefits included with the job.

compensation_info#

Job compensation information (a.k.a. “pay rate”) i.e., the compensation that will paid to the employee.

custom_attributes#

A map of fields to hold both filterable and non-filterable custom job attributes that are not covered by the provided structured fields. The keys of the map are strings up to 64 bytes and must match the pattern: [a-zA-Z][a-zA-Z0-9_]*. For example, key0LikeThis or KEY_1_LIKE_THIS. At most 100 filterable and at most 100 unfilterable keys are supported. For filterable string_values, across all keys at most 200 values are allowed, with each string no more than 255 characters. For unfilterable string_values, the maximum total size of string_values across all keys is 50KB.

degree_types#

The desired education degrees for the job, such as Bachelors, Masters.

department#

The department or functional area within the company with the open position. The maximum number of allowed characters is 255.

employment_types#

The employment type(s) of a job, for example, [full time][google.cloud.talent.v4beta1.EmploymentType.FULL_TIME] or [part time][google.cloud.talent.v4beta1.EmploymentType.PART_TIME].

incentives#

A description of bonus, commission, and other compensation incentives associated with the job not including salary or pay. The maximum number of allowed characters is 10,000.

language_code#

The language of the posting. This field is distinct from any requirements for fluency that are associated with the job. Language codes must be in BCP-47 format, such as “en-US” or “sr-Latn”. For more information, see Tags for Identifying Languages{: class=”external” target=”_blank” }. If this field is unspecified and [Job.description][google.cloud.talent.v4beta1.Job.description] is present, detected language code based on [Job.description][google.cloud.talent.v4beta1.Job.description] is assigned, otherwise defaults to ‘en_US’.

job_level#

The experience level associated with the job, such as “Entry Level”.

promotion_value#

A promotion value of the job, as determined by the client. The value determines the sort order of the jobs returned when searching for jobs using the featured jobs search call, with higher promotional values being returned first and ties being resolved by relevance sort. Only the jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH. Default value is 0, and negative values are treated as 0.

qualifications#

A description of the qualifications required to perform the job. The use of this field is recommended as an alternative to using the more general [description][google.cloud.talent.v4beta1.Job.description] field. This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags. The maximum number of allowed characters is 10,000.

responsibilities#

A description of job responsibilities. The use of this field is recommended as an alternative to using the more general [description][google.cloud.talent.v4beta1.Job.description] field. This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags. The maximum number of allowed characters is 10,000.

posting_region#

The job [PostingRegion][google.cloud.talent.v4beta1.PostingRegion] (for example, state, country) throughout which the job is available. If this field is set, a [LocationFilter][google.cloud.talent.v4beta1.LocationFilter] in a search query within the job region finds this job posting if an exact location match isn’t specified. If this field is set to [PostingRegion.NATION][google.cloud.talent.v4beta1.Post ingRegion.NATION] or [PostingRegion.ADMINISTRATIVE_AREA][goog le.cloud.talent.v4beta1.PostingRegion.ADMINISTRATIVE_AREA], setting job [Job.addresses][google.cloud.talent.v4beta1.Job.addresses] to the same location level as this field is strongly recommended.

visibility#

Deprecated. The job is only visible to the owner. The visibility of the job. Defaults to [Visibility.ACCOUNT_ONLY] [google.cloud.talent.v4beta1.Visibility.ACCOUNT_ONLY] if not specified.

job_start_time#

The start timestamp of the job in UTC time zone. Typically this field is used for contracting engagements. Invalid timestamps are ignored.

job_end_time#

The end timestamp of the job. Typically this field is used for contracting engagements. Invalid timestamps are ignored.

posting_publish_time#

The timestamp this job posting was most recently published. The default value is the time the request arrives at the server. Invalid timestamps are ignored.

posting_expire_time#

Strongly recommended for the best service experience. The expiration timestamp of the job. After this timestamp, the job is marked as expired, and it no longer appears in search results. The expired job can’t be listed by the [ListJobs][google.cloud.talent.v4beta1.JobService.ListJobs] API, but it can be retrieved with the [GetJob][google.cloud.talent.v4beta1.JobService.GetJob] API or updated with the [UpdateJob][google.cloud.talent.v4beta1.JobService.UpdateJob] API or deleted with the [DeleteJob][google.cloud.talent.v4beta1.JobService.DeleteJob] API. An expired job can be updated and opened again by using a future expiration timestamp. Updating an expired job fails if there is another existing open job with same [company][google.cloud.talent.v4beta1.Job.company], [language _code][google.cloud.talent.v4beta1.Job.language_code] and [re quisition_id][google.cloud.talent.v4beta1.Job.requisition_id ]. The expired jobs are retained in our system for 90 days. However, the overall expired job count cannot exceed 3 times the maximum number of open jobs over previous 7 days. If this threshold is exceeded, expired jobs are cleaned out in order of earliest expire time. Expired jobs are no longer accessible after they are cleaned out. Invalid timestamps are ignored, and treated as expire time not provided. If the timestamp is before the instant request is made, the job is treated as expired immediately on creation. This kind of job can not be updated. And when creating a job with past timestamp, the [pos ting_publish_time][google.cloud.talent.v4beta1.Job.posting_ publish_time] must be set before [posting_expire_time][goog le.cloud.talent.v4beta1.Job.posting_expire_time]. The purpose of this feature is to allow other objects, such as [Application][google.cloud.talent.v4beta1.Application], to refer a job that didn’t exist in the system prior to becoming expired. If you want to modify a job that was expired on creation, delete it and create a new one. If this value isn’t provided at the time of job creation or is invalid, the job posting expires after 30 days from the job’s creation time. For example, if the job was created on 2017/01/01 13:00AM UTC with an unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC. If this value isn’t provided on job update, it depends on the field masks set by [UpdateJobRequest .update_mask][google.cloud.talent.v4beta1.UpdateJobRequest.up date_mask]. If the field masks include [job_end_time][googl e.cloud.talent.v4beta1.Job.job_end_time], or the masks are empty meaning that every field is updated, the job posting expires after 30 days from the job’s last update time. Otherwise the expiration date isn’t updated.

posting_create_time#

Output only. The timestamp when this job posting was created.

posting_update_time#

Output only. The timestamp when this job posting was last updated.

company_display_name#

Output only. Display name of the company listing the job.

derived_info#

Output only. Derived details about the job posting.

processing_options#

Options for job processing.

class ApplicationInfo#

Application related details of a job posting.

emails#

Use this field to specify email address(es) to which resumes or applications can be sent. The maximum number of allowed characters for each entry is 255.

instruction#

Use this field to provide instructions, such as “Mail your application to …”, that a candidate can follow to apply for the job. This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags. The maximum number of allowed characters is 3,000.

uris#

Use this URI field to direct an applicant to a website, for example to link to an online application form. The maximum number of allowed characters for each entry is 2,000.

emails

Field google.cloud.talent.v4beta1.Job.ApplicationInfo.emails

instruction

Field google.cloud.talent.v4beta1.Job.ApplicationInfo.instruction

uris

Field google.cloud.talent.v4beta1.Job.ApplicationInfo.uris

class CustomAttributesEntry#
key#

Field google.cloud.talent.v4beta1.Job.CustomAttributesEntry.key

value#

Field google.cloud.talent.v4beta1.Job.CustomAttributesEntry.value

class DerivedInfo#

Derived details about the job posting.

locations#

Structured locations of the job, resolved from [Job.addresses][google.cloud.talent.v4beta1.Job.addresses]. [ locations][google.cloud.talent.v4beta1.Job.DerivedInfo.locatio ns] are exactly matched to [Job.addresses][google.cloud.talent.v4beta1.Job.addresses] in the same order.

job_categories#

Job categories derived from [Job.title][google.cloud.talent.v4beta1.Job.title] and [Job.de scription][google.cloud.talent.v4beta1.Job.description].

job_categories

Field google.cloud.talent.v4beta1.Job.DerivedInfo.job_categories

locations

Field google.cloud.talent.v4beta1.Job.DerivedInfo.locations

class ProcessingOptions#

Options for job processing.

disable_street_address_resolution#

If set to true, the service does not attempt to resolve a more precise address for the job.

html_sanitization#

Option for job HTML content sanitization. Applied fields are: - description - applicationInfo.instruction - incentives - qualifications - responsibilities HTML tags in these fields may be stripped if sanitiazation isn’t disabled. Defaults to [HtmlSanitization.SIMPLE_FORMATTING_ONLY][google.cloud.talen t.v4beta1.HtmlSanitization.SIMPLE_FORMATTING_ONLY].

disable_street_address_resolution

Field google.cloud.talent.v4beta1.Job.ProcessingOptions.disable_street_address_resolution

html_sanitization

Field google.cloud.talent.v4beta1.Job.ProcessingOptions.html_sanitization

addresses

Field google.cloud.talent.v4beta1.Job.addresses

application_info

Field google.cloud.talent.v4beta1.Job.application_info

company

Field google.cloud.talent.v4beta1.Job.company

company_display_name

Field google.cloud.talent.v4beta1.Job.company_display_name

compensation_info

Field google.cloud.talent.v4beta1.Job.compensation_info

custom_attributes

Field google.cloud.talent.v4beta1.Job.custom_attributes

degree_types

Field google.cloud.talent.v4beta1.Job.degree_types

department

Field google.cloud.talent.v4beta1.Job.department

derived_info

Field google.cloud.talent.v4beta1.Job.derived_info

description

Field google.cloud.talent.v4beta1.Job.description

employment_types

Field google.cloud.talent.v4beta1.Job.employment_types

incentives

Field google.cloud.talent.v4beta1.Job.incentives

job_benefits

Field google.cloud.talent.v4beta1.Job.job_benefits

job_end_time

Field google.cloud.talent.v4beta1.Job.job_end_time

job_level

Field google.cloud.talent.v4beta1.Job.job_level

job_start_time

Field google.cloud.talent.v4beta1.Job.job_start_time

language_code

Field google.cloud.talent.v4beta1.Job.language_code

name

Field google.cloud.talent.v4beta1.Job.name

posting_create_time

Field google.cloud.talent.v4beta1.Job.posting_create_time

posting_expire_time

Field google.cloud.talent.v4beta1.Job.posting_expire_time

posting_publish_time

Field google.cloud.talent.v4beta1.Job.posting_publish_time

posting_region

Field google.cloud.talent.v4beta1.Job.posting_region

posting_update_time

Field google.cloud.talent.v4beta1.Job.posting_update_time

processing_options

Field google.cloud.talent.v4beta1.Job.processing_options

promotion_value

Field google.cloud.talent.v4beta1.Job.promotion_value

qualifications

Field google.cloud.talent.v4beta1.Job.qualifications

requisition_id

Field google.cloud.talent.v4beta1.Job.requisition_id

responsibilities

Field google.cloud.talent.v4beta1.Job.responsibilities

title

Field google.cloud.talent.v4beta1.Job.title

visibility

Field google.cloud.talent.v4beta1.Job.visibility

class google.cloud.talent_v4beta1.types.JobEvent#

An event issued when a job seeker interacts with the application that implements Cloud Talent Solution.

type#

Required. The type of the event (see [JobEventType][google.clo ud.talent.v4beta1.JobEvent.JobEventType]).

jobs#

Required. The [job name(s)][google.cloud.talent.v4beta1.Job.name] associated with this event. For example, if this is an [impression][google.clo ud.talent.v4beta1.JobEvent.JobEventType.IMPRESSION] event, this field contains the identifiers of all jobs shown to the job seeker. If this was a [view][google.cloud.talent.v4beta1.JobEvent.JobEventType.VIEW] event, this field contains the identifier of the viewed job. The format is “projects/{project_id}/tenants/{tenant_id}/jobs/{job_id}”, for example, “projects/foo/tenants/bar/jobs/baz”.

profile#

The [profile name][google.cloud.talent.v4beta1.Profile.name] associated with this client event. The format is “projects/{p roject_id}/tenants/{tenant_id}/profiles/{profile_id}”, for example, “projects/foo/tenants/bar/profiles/baz”.

jobs

Field google.cloud.talent.v4beta1.JobEvent.jobs

profile

Field google.cloud.talent.v4beta1.JobEvent.profile

type

Field google.cloud.talent.v4beta1.JobEvent.type

class google.cloud.talent_v4beta1.types.JobOperationResult#

The result of [JobService.BatchCreateJobs][google.cloud.talent.v4beta1.JobService.BatchCreateJobs] or [JobService.BatchUpdateJobs][google.cloud.talent.v4beta1.JobService.BatchUpdateJobs] APIs. It’s used to replace [google.longrunning.Operation.response][google.longrunning.Operation.response] in case of success.

job_results#

List of job mutation results from a batch mutate operation. It can change until operation status is FINISHED, FAILED or CANCELLED.

class JobResult#

Mutation result of a job.

job#

Here [Job][google.cloud.talent.v4beta1.Job] only contains basic information including [name][google.cloud.talent.v4beta1.Job.name], [company][google.cloud.talent.v4beta1.Job.company], [language _code][google.cloud.talent.v4beta1.Job.language_code] and [re quisition_id][google.cloud.talent.v4beta1.Job.requisition_id ], use getJob method to retrieve detailed information of the created/updated job.

status#

The status of the job processed. This field is populated if the processing of the [job][google.cloud.talent.v4beta1.JobOpe rationResult.JobResult.job] fails.

job

Field google.cloud.talent.v4beta1.JobOperationResult.JobResult.job

status

Field google.cloud.talent.v4beta1.JobOperationResult.JobResult.status

job_results

Field google.cloud.talent.v4beta1.JobOperationResult.job_results

class google.cloud.talent_v4beta1.types.JobQuery#

The query required to perform a search query.

query#

The query string that matches against the job title, description, and location fields. The maximum number of allowed characters is 255.

companies#

This filter specifies the company entities to search against. If a value isn’t specified, jobs are searched for against all companies. If multiple values are specified, jobs are searched against the companies specified. The format is “proj ects/{project_id}/tenants/{tenant_id}/companies/{company_id }”. For example, “projects/foo/tenants/bar/companies/baz”. If tenant id is unspecified, the default tenant is used. For example, “projects/foo/companies/bar”. At most 20 company filters are allowed.

location_filters#

The location filter specifies geo-regions containing the jobs to search against. See [LocationFilter][google.cloud.talent.v4beta1.LocationFilter] for more information. If a location value isn’t specified, jobs fitting the other search criteria are retrieved regardless of where they’re located. If multiple values are specified, jobs are retrieved from any of the specified locations. If different values are specified for the [Location Filter.distance_in_miles][google.cloud.talent.v4beta1.Locati onFilter.distance_in_miles] parameter, the maximum provided distance is used for all locations. At most 5 location filters are allowed.

job_categories#

The category filter specifies the categories of jobs to search against. See [JobCategory][google.cloud.talent.v4beta1.JobCategory] for more information. If a value isn’t specified, jobs from any category are searched against. If multiple values are specified, jobs from any of the specified categories are searched against.

commute_filter#

Allows filtering jobs by commute time with different travel methods (for example, driving or public transit). Note: This only works when you specify a [CommuteMethod][google.cloud.talent.v4beta1.CommuteMethod]. In this case, [location_filters][google.cloud.talent.v4beta1.Job Query.location_filters] is ignored. Currently we don’t support sorting by commute time.

company_display_names#

This filter specifies the exact company [Company.display_name ][google.cloud.talent.v4beta1.Company.display_name] of the jobs to search against. If a value isn’t specified, jobs within the search results are associated with any company. If multiple values are specified, jobs within the search results may be associated with any of the specified companies. At most 20 company display name filters are allowed.

compensation_filter#

This search filter is applied only to [Job.compensation_info] [google.cloud.talent.v4beta1.Job.compensation_info]. For example, if the filter is specified as “Hourly job with per- hour compensation > $15”, only jobs meeting these criteria are searched. If a filter isn’t defined, all open jobs are searched.

custom_attribute_filter#

This filter specifies a structured syntax to match against the [Job.custom_attributes][google.cloud.talent.v4beta1.Job.custo m_attributes] marked as filterable. The syntax for this expression is a subset of SQL syntax. Supported operators are: =, !=, <, <=, >, and >= where the left of the operator is a custom field key and the right of the operator is a number or a quoted string. You must escape backslash () and quote (“) characters. Supported functions are LOWER([field_name]) to perform a case insensitive match and EMPTY([field_name]) to filter on the existence of a key. Boolean expressions (AND/OR/NOT) are supported up to 3 levels of nesting (for example, “((A AND B AND C) OR NOT D) AND E”), a maximum of 100 comparisons or functions are allowed in the expression. The expression must be < 6000 bytes in length. Sample Query: (LOWER(driving_license)="class "a"" OR EMPTY(driving_license)) AND driving_years > 10

disable_spell_check#

This flag controls the spell-check feature. If false, the service attempts to correct a misspelled query, for example, “enginee” is corrected to “engineer”. Defaults to false: a spell check is performed.

employment_types#

The employment type filter specifies the employment type of jobs to search against, such as [EmploymentType.FULL_TIME][go ogle.cloud.talent.v4beta1.EmploymentType.FULL_TIME]. If a value isn’t specified, jobs in the search results includes any employment type. If multiple values are specified, jobs in the search results include any of the specified employment types.

language_codes#

This filter specifies the locale of jobs to search against, for example, “en-US”. If a value isn’t specified, the search results can contain jobs in any locale. Language codes should be in BCP-47 format, such as “en-US” or “sr-Latn”. For more information, see Tags for Identifying Languages. At most 10 language code filters are allowed.

publish_time_range#

Jobs published within a range specified by this filter are searched against.

excluded_jobs#

This filter specifies a list of job names to be excluded during search. At most 400 excluded job names are allowed.

commute_filter

Field google.cloud.talent.v4beta1.JobQuery.commute_filter

companies

Field google.cloud.talent.v4beta1.JobQuery.companies

company_display_names

Field google.cloud.talent.v4beta1.JobQuery.company_display_names

compensation_filter

Field google.cloud.talent.v4beta1.JobQuery.compensation_filter

custom_attribute_filter

Field google.cloud.talent.v4beta1.JobQuery.custom_attribute_filter

disable_spell_check

Field google.cloud.talent.v4beta1.JobQuery.disable_spell_check

employment_types

Field google.cloud.talent.v4beta1.JobQuery.employment_types

excluded_jobs

Field google.cloud.talent.v4beta1.JobQuery.excluded_jobs

job_categories

Field google.cloud.talent.v4beta1.JobQuery.job_categories

language_codes

Field google.cloud.talent.v4beta1.JobQuery.language_codes

location_filters

Field google.cloud.talent.v4beta1.JobQuery.location_filters

publish_time_range

Field google.cloud.talent.v4beta1.JobQuery.publish_time_range

query

Field google.cloud.talent.v4beta1.JobQuery.query

class google.cloud.talent_v4beta1.types.JobTitleFilter#

Job title of the search.

job_title#

Required. The job title. For example, “Software engineer”, or “Product manager”.

negated#

Whether to apply negation to the filter so profiles matching the filter are excluded.

job_title

Field google.cloud.talent.v4beta1.JobTitleFilter.job_title

negated

Field google.cloud.talent.v4beta1.JobTitleFilter.negated

class google.cloud.talent_v4beta1.types.LatLng#
latitude#

Field google.type.LatLng.latitude

longitude#

Field google.type.LatLng.longitude

class google.cloud.talent_v4beta1.types.ListApplicationsRequest#

List applications for which the client has ACL visibility.

parent#

Required. Resource name of the profile under which the application is created. The format is “projects/{project_id} /tenants/{tenant_id}/profiles/{profile_id}”, for example, “projects/foo/tenants/bar/profiles/baz”.

page_token#

The starting indicator from which to return results.

page_size#

The maximum number of applications to be returned, at most 100. Default is 100 if a non-positive number is provided.

page_size

Field google.cloud.talent.v4beta1.ListApplicationsRequest.page_size

page_token

Field google.cloud.talent.v4beta1.ListApplicationsRequest.page_token

parent

Field google.cloud.talent.v4beta1.ListApplicationsRequest.parent

class google.cloud.talent_v4beta1.types.ListApplicationsResponse#

The List applications response object.

applications#

Applications for the current client.

next_page_token#

A token to retrieve the next page of results.

metadata#

Additional information for the API invocation, such as the request tracking id.

applications

Field google.cloud.talent.v4beta1.ListApplicationsResponse.applications

metadata

Field google.cloud.talent.v4beta1.ListApplicationsResponse.metadata

next_page_token

Field google.cloud.talent.v4beta1.ListApplicationsResponse.next_page_token

class google.cloud.talent_v4beta1.types.ListCompaniesRequest#

List companies for which the client has ACL visibility.

parent#

Required. Resource name of the tenant under which the company is created. The format is “projects/{project_id}/tenants/{tenant_id}”, for example, “projects/foo/tenant/bar”. If tenant id is unspecified, the default tenant will be used, for example, “projects/foo”.

page_token#

The starting indicator from which to return results.

page_size#

The maximum number of companies to be returned, at most 100. Default is 100 if a non-positive number is provided.

require_open_jobs#

Set to true if the companies requested must have open jobs. Defaults to false. If true, at most [page_size][google.cloud .talent.v4beta1.ListCompaniesRequest.page_size] of companies are fetched, among which only those with open jobs are returned.

page_size

Field google.cloud.talent.v4beta1.ListCompaniesRequest.page_size

page_token

Field google.cloud.talent.v4beta1.ListCompaniesRequest.page_token

parent

Field google.cloud.talent.v4beta1.ListCompaniesRequest.parent

require_open_jobs

Field google.cloud.talent.v4beta1.ListCompaniesRequest.require_open_jobs

class google.cloud.talent_v4beta1.types.ListCompaniesResponse#

The List companies response object.

companies#

Companies for the current client.

next_page_token#

A token to retrieve the next page of results.

metadata#

Additional information for the API invocation, such as the request tracking id.

companies

Field google.cloud.talent.v4beta1.ListCompaniesResponse.companies

metadata

Field google.cloud.talent.v4beta1.ListCompaniesResponse.metadata

next_page_token

Field google.cloud.talent.v4beta1.ListCompaniesResponse.next_page_token

class google.cloud.talent_v4beta1.types.ListJobsRequest#

List jobs request.

parent#

Required. The resource name of the tenant under which the job is created. The format is “projects/{project_id}/tenants/{tenant_id}”. For example, “projects/foo/tenant/bar”. If tenant id is unspecified, a default tenant is created. For example, “projects/foo”.

filter#

Required. The filter string specifies the jobs to be enumerated. Supported operator: =, AND The fields eligible for filtering are: - companyName (Required) - requisitionId - status Available values: OPEN, EXPIRED, ALL. Defaults to OPEN if no value is specified. Sample Query: - companyName = “projects/foo/tenants/bar/companies/baz” - companyName = “projects/foo/tenants/bar/companies/baz” AND requisitionId = “req-1” - companyName = “projects/foo/tenants/bar/companies/baz” AND status = “EXPIRED”

page_token#

The starting point of a query result.

page_size#

The maximum number of jobs to be returned per page of results. If [job_view][google.cloud.talent.v4beta1.ListJobsRequest.job _view] is set to [JobView.JOB_VIEW_ID_ONLY][google.cloud.t alent.v4beta1.JobView.JOB_VIEW_ID_ONLY], the maximum allowed page size is 1000. Otherwise, the maximum allowed page size is 100. Default is 100 if empty or a number < 1 is specified.

job_view#

The desired job attributes returned for jobs in the search response. Defaults to [JobView.JOB_VIEW_FULL][google.cloud.t alent.v4beta1.JobView.JOB_VIEW_FULL] if no value is specified.

filter

Field google.cloud.talent.v4beta1.ListJobsRequest.filter

job_view

Field google.cloud.talent.v4beta1.ListJobsRequest.job_view

page_size

Field google.cloud.talent.v4beta1.ListJobsRequest.page_size

page_token

Field google.cloud.talent.v4beta1.ListJobsRequest.page_token

parent

Field google.cloud.talent.v4beta1.ListJobsRequest.parent

class google.cloud.talent_v4beta1.types.ListJobsResponse#

List jobs response.

jobs#

The Jobs for a given company. The maximum number of items returned is based on the limit field provided in the request.

next_page_token#

A token to retrieve the next page of results.

metadata#

Additional information for the API invocation, such as the request tracking id.

jobs

Field google.cloud.talent.v4beta1.ListJobsResponse.jobs

metadata

Field google.cloud.talent.v4beta1.ListJobsResponse.metadata

next_page_token

Field google.cloud.talent.v4beta1.ListJobsResponse.next_page_token

class google.cloud.talent_v4beta1.types.ListOperationsRequest#
filter#

Field google.longrunning.ListOperationsRequest.filter

name#

Field google.longrunning.ListOperationsRequest.name

page_size#

Field google.longrunning.ListOperationsRequest.page_size

page_token#

Field google.longrunning.ListOperationsRequest.page_token

class google.cloud.talent_v4beta1.types.ListOperationsResponse#
next_page_token#

Field google.longrunning.ListOperationsResponse.next_page_token

operations#

Field google.longrunning.ListOperationsResponse.operations

class google.cloud.talent_v4beta1.types.ListProfilesRequest#

List profiles request.

parent#

Required. The resource name of the tenant under which the profile is created. The format is “projects/{project_id}/tenants/{tenant_id}”. For example, “projects/foo/tenants/bar”.

filter#

The filter string specifies the profiles to be enumerated. Supported operator: =, AND The field(s) eligible for filtering are: - externalId - groupId externalId and groupId cannot be specified at the same time. If both externalId and groupId are provided, the API will return a bad request error. Sample Query: - externalId = “externalId-1” - groupId = “groupId-1”

page_token#

The token that specifies the current offset (that is, starting result). Please set the value to [ListProfilesResponse.next_ page_token][google.cloud.talent.v4beta1.ListProfilesResponse. next_page_token] to continue the list.

page_size#

The maximum number of profiles to be returned, at most 100. Default is 100 unless a positive number smaller than 100 is specified.

read_mask#

A field mask to specify the profile fields to be listed in response. All fields are listed if it is unset. Valid values are: - name

filter

Field google.cloud.talent.v4beta1.ListProfilesRequest.filter

page_size

Field google.cloud.talent.v4beta1.ListProfilesRequest.page_size

page_token

Field google.cloud.talent.v4beta1.ListProfilesRequest.page_token

parent

Field google.cloud.talent.v4beta1.ListProfilesRequest.parent

read_mask

Field google.cloud.talent.v4beta1.ListProfilesRequest.read_mask

class google.cloud.talent_v4beta1.types.ListProfilesResponse#

The List profiles response object.

profiles#

Profiles for the specific tenant.

next_page_token#

A token to retrieve the next page of results. This is empty if there are no more results.

next_page_token

Field google.cloud.talent.v4beta1.ListProfilesResponse.next_page_token

profiles

Field google.cloud.talent.v4beta1.ListProfilesResponse.profiles

class google.cloud.talent_v4beta1.types.ListTenantsRequest#

List tenants for which the client has ACL visibility.

parent#

Required. Resource name of the project under which the tenant is created. The format is “projects/{project_id}”, for example, “projects/foo”.

page_token#

The starting indicator from which to return results.

page_size#

The maximum number of tenants to be returned, at most 100. Default is 100 if a non-positive number is provided.

page_size

Field google.cloud.talent.v4beta1.ListTenantsRequest.page_size

page_token

Field google.cloud.talent.v4beta1.ListTenantsRequest.page_token

parent

Field google.cloud.talent.v4beta1.ListTenantsRequest.parent

class google.cloud.talent_v4beta1.types.ListTenantsResponse#

The List tenants response object.

tenants#

Tenants for the current client.

next_page_token#

A token to retrieve the next page of results.

metadata#

Additional information for the API invocation, such as the request tracking id.

metadata

Field google.cloud.talent.v4beta1.ListTenantsResponse.metadata

next_page_token

Field google.cloud.talent.v4beta1.ListTenantsResponse.next_page_token

tenants

Field google.cloud.talent.v4beta1.ListTenantsResponse.tenants

class google.cloud.talent_v4beta1.types.Location#

A resource that represents a location with full geographic information.

location_type#

The type of a location, which corresponds to the address lines field of [google.type.PostalAddress][google.type.PostalAddress]. For example, “Downtown, Atlanta, GA, USA” has a type of [LocationT ype.NEIGHBORHOOD][google.cloud.talent.v4beta1.Location.Locatio nType.NEIGHBORHOOD], and “Kansas City, KS, USA” has a type of [LocationType.LOCALITY][google.cloud.talent.v4beta1.Location.L ocationType.LOCALITY].

postal_address#

Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location.

lat_lng#

An object representing a latitude/longitude pair.

radius_miles#

Radius in miles of the job location. This value is derived from the location bounding box in which a circle with the specified radius centered from [google.type.LatLng][google.type.LatLng] covers the area associated with the job location. For example, currently, “Mountain View, CA, USA” has a radius of 6.17 miles.

lat_lng

Field google.cloud.talent.v4beta1.Location.lat_lng

location_type

Field google.cloud.talent.v4beta1.Location.location_type

postal_address

Field google.cloud.talent.v4beta1.Location.postal_address

radius_miles

Field google.cloud.talent.v4beta1.Location.radius_miles

class google.cloud.talent_v4beta1.types.LocationFilter#

Geographic region of the search.

address#

The address name, such as “Mountain View” or “Bay Area”.

region_code#

CLDR region code of the country/region of the address. This is used to address ambiguity of the user-input location, for example, “Liverpool” against “Liverpool, NY, US” or “Liverpool, UK”. Set this field to bias location resolution toward a specific country or territory. If this field is not set, application behavior is biased toward the United States by default. See http://cldr.unicode.org/ and http://www.unico de.org/cldr/charts/30/supplemental/territory_information.html for details. Example: “CH” for Switzerland. Note that this filter is not applicable for Profile Search related queries.

lat_lng#

The latitude and longitude of the geographic center to search from. This field is ignored if address is provided.

distance_in_miles#

The distance_in_miles is applied when the location being searched for is identified as a city or smaller. This field is ignored if the location being searched for is a state or larger.

telecommute_preference#

Allows the client to return jobs without a set location, specifically, telecommuting jobs (telecommuting is considered by the service as a special location. [Job.posting_region][go ogle.cloud.talent.v4beta1.Job.posting_region] indicates if a job permits telecommuting. If this field is set to [Telecommut ePreference.TELECOMMUTE_ALLOWED][google.cloud.talent.v4beta1. LocationFilter.TelecommutePreference.TELECOMMUTE_ALLOWED], telecommuting jobs are searched, and [address][google.cloud.talent.v4beta1.LocationFilter.address] and [lat_lng][google.cloud.talent.v4beta1.LocationFilter.lat _lng] are ignored. If not set or set to [TelecommutePreference .TELECOMMUTE_EXCLUDED][google.cloud.talent.v4beta1.LocationFi lter.TelecommutePreference.TELECOMMUTE_EXCLUDED], telecommute job are not searched. This filter can be used by itself to search exclusively for telecommuting jobs, or it can be combined with another location filter to search for a combination of job locations, such as “Mountain View” or “telecommuting” jobs. However, when used in combination with other location filters, telecommuting jobs can be treated as less relevant than other jobs in the search response. This field is only used for job search requests.

negated#

Whether to apply negation to the filter so profiles matching the filter are excluded. Currently only supported in profile search.

address

Field google.cloud.talent.v4beta1.LocationFilter.address

distance_in_miles

Field google.cloud.talent.v4beta1.LocationFilter.distance_in_miles

lat_lng

Field google.cloud.talent.v4beta1.LocationFilter.lat_lng

negated

Field google.cloud.talent.v4beta1.LocationFilter.negated

region_code

Field google.cloud.talent.v4beta1.LocationFilter.region_code

telecommute_preference

Field google.cloud.talent.v4beta1.LocationFilter.telecommute_preference

class google.cloud.talent_v4beta1.types.Money#
currency_code#

Field google.type.Money.currency_code

nanos#

Field google.type.Money.nanos

units#

Field google.type.Money.units

class google.cloud.talent_v4beta1.types.Operation#
deserialize()#

Creates new method instance from given serialized data.

done#

Field google.longrunning.Operation.done

error#

Field google.longrunning.Operation.error

metadata#

Field google.longrunning.Operation.metadata

name#

Field google.longrunning.Operation.name

response#

Field google.longrunning.Operation.response

class google.cloud.talent_v4beta1.types.OperationInfo#
metadata_type#

Field google.longrunning.OperationInfo.metadata_type

response_type#

Field google.longrunning.OperationInfo.response_type

class google.cloud.talent_v4beta1.types.Patent#

Resource that represents the patent acquired by a candidate.

display_name#

Name of the patent. Number of characters allowed is 100.

inventors#

A list of inventors’ names. Number of characters allowed for each is 100.

patent_status#

The status of the patent. Number of characters allowed is 100.

patent_status_date#

The date the last time the status of the patent was checked.

patent_filing_date#

The date that the patent was filed.

patent_office#

The name of the patent office. Number of characters allowed is 100.

patent_number#

The number of the patent. Number of characters allowed is 100.

patent_description#

The description of the patent. Number of characters allowed is 100,000.

skills_used#

The skills used in this patent.

display_name

Field google.cloud.talent.v4beta1.Patent.display_name

inventors

Field google.cloud.talent.v4beta1.Patent.inventors

patent_description

Field google.cloud.talent.v4beta1.Patent.patent_description

patent_filing_date

Field google.cloud.talent.v4beta1.Patent.patent_filing_date

patent_number

Field google.cloud.talent.v4beta1.Patent.patent_number

patent_office

Field google.cloud.talent.v4beta1.Patent.patent_office

patent_status

Field google.cloud.talent.v4beta1.Patent.patent_status

patent_status_date

Field google.cloud.talent.v4beta1.Patent.patent_status_date

skills_used

Field google.cloud.talent.v4beta1.Patent.skills_used

class google.cloud.talent_v4beta1.types.PersonName#

Resource that represents the name of a person.

person_name#

The name of a person. It can be one of [formatted_name][googl e.cloud.talent.v4beta1.PersonName.formatted_name] or [structu red_name][google.cloud.talent.v4beta1.PersonName.structured_ name].

formatted_name#

A string represents a person’s full name. For example, “Dr. John Smith”. Number of characters allowed is 100.

structured_name#

A person’s name in a structured way (last name, first name, suffix, and so on.)

preferred_name#

Preferred name for the person. This field is ignored if [struc tured_name][google.cloud.talent.v4beta1.PersonName.structured _name] is provided. Number of characters allowed is 100.

class PersonStructuredName#

Resource that represents a person’s structured name.

given_name#

Given/first name. It’s derived from [formatted_name][google. cloud.talent.v4beta1.PersonName.formatted_name] if not provided. Number of characters allowed is 100.

preferred_name#

Preferred given/first name or nickname. Number of characters allowed is 100.

middle_initial#

Middle initial. It’s derived from [formatted_name][google.cl oud.talent.v4beta1.PersonName.formatted_name] if not provided. Number of characters allowed is 20.

family_name#

Family/last name. It’s derived from [formatted_name][google. cloud.talent.v4beta1.PersonName.formatted_name] if not provided. Number of characters allowed is 100.

suffixes#

Suffixes. Number of characters allowed is 20.

prefixes#

Prefixes. Number of characters allowed is 20.

family_name

Field google.cloud.talent.v4beta1.PersonName.PersonStructuredName.family_name

given_name

Field google.cloud.talent.v4beta1.PersonName.PersonStructuredName.given_name

middle_initial

Field google.cloud.talent.v4beta1.PersonName.PersonStructuredName.middle_initial

preferred_name

Field google.cloud.talent.v4beta1.PersonName.PersonStructuredName.preferred_name

prefixes

Field google.cloud.talent.v4beta1.PersonName.PersonStructuredName.prefixes

suffixes

Field google.cloud.talent.v4beta1.PersonName.PersonStructuredName.suffixes

formatted_name

Field google.cloud.talent.v4beta1.PersonName.formatted_name

preferred_name

Field google.cloud.talent.v4beta1.PersonName.preferred_name

structured_name

Field google.cloud.talent.v4beta1.PersonName.structured_name

class google.cloud.talent_v4beta1.types.PersonNameFilter#

Filter on person name.

person_name#

Required. The person name. For example, “John Smith”. Can be any combination of [PersonName.structured_name.given_name][], [PersonName.structured_name.middle_initial][], [PersonName.structured_name.family_name][], and [PersonName. formatted_name][google.cloud.talent.v4beta1.PersonName.format ted_name].

person_name

Field google.cloud.talent.v4beta1.PersonNameFilter.person_name

class google.cloud.talent_v4beta1.types.PersonalUri#

Resource that represents a valid URI for a personal use.

uri#

The personal URI. Number of characters allowed is 4,000.

uri

Field google.cloud.talent.v4beta1.PersonalUri.uri

class google.cloud.talent_v4beta1.types.Phone#

Resource that represents a person’s telephone number.

usage#

The usage of the phone. For example, SCHOOL, WORK, PERSONAL.

type#

The phone type. For example, LANDLINE, MOBILE, FAX.

number#

Phone number. Any phone formats are supported and only exact matches are performed on searches. For example, if a phone number in profile is provided in the format of “(xxx)xxx- xxxx”, in profile searches the same phone format has to be provided. Number of characters allowed is 20.

when_available#

When this number is available. Any descriptive string is expected. Number of characters allowed is 100.

number

Field google.cloud.talent.v4beta1.Phone.number

type

Field google.cloud.talent.v4beta1.Phone.type

usage

Field google.cloud.talent.v4beta1.Phone.usage

when_available

Field google.cloud.talent.v4beta1.Phone.when_available

class google.cloud.talent_v4beta1.types.PostalAddress#
address_lines#

Field google.type.PostalAddress.address_lines

administrative_area#

Field google.type.PostalAddress.administrative_area

language_code#

Field google.type.PostalAddress.language_code

locality#

Field google.type.PostalAddress.locality

organization#

Field google.type.PostalAddress.organization

postal_code#

Field google.type.PostalAddress.postal_code

recipients#

Field google.type.PostalAddress.recipients

region_code#

Field google.type.PostalAddress.region_code

revision#

Field google.type.PostalAddress.revision

sorting_code#

Field google.type.PostalAddress.sorting_code

sublocality#

Field google.type.PostalAddress.sublocality

class google.cloud.talent_v4beta1.types.Profile#

A resource that represents the profile for a job candidate (also referred to as a “single-source profile”).

name#

Required during profile update. Resource name assigned to a profile by the API. The format is “projects/{project_id}/ten ants/{tenant_id}/profiles/{profile_id}”, for example, “projects/foo/tenants/bar/profiles/baz”.

external_id#

Profile’s id in client system, if available. This value is unique for each profile inside a tenant. An error is thrown if another profile with the same external_id is created. The maximum number of bytes allowed is 100.

source#

The source description indicating where the profile is acquired. For example, if a candidate profile is acquired from a resume, the user can input “resume” here to indicate the source. The maximum number of bytes allowed is 100.

uri#

The URI set by clients that links to this profile’s client- side copy. The maximum number of bytes allowed is 4000.

group_id#

The cluster id of the profile to associate with other profile(s) for the same candidate. This field should be generated by the customer. If a value is not provided, a random UUID is assigned to this field of the profile. This is used to link multiple profiles to the same candidate. For example, a client has a candidate with two profiles, where one was created recently and the other one was created 5 years ago. These two profiles may be very different. The clients can create the first profile and get a generated [group_id][google.cloud.talent.v4beta1.Profile.group_id], and assign it when the second profile is created, indicating these two profiles are referring to the same candidate.

is_hirable#

Indicates the hirable status of the candidate.

create_time#

The timestamp when the profile was first created at this source.

update_time#

The timestamp when the profile was last updated at this source.

candidate_update_time#

The timestamp when the profile was last updated as a result of a direct or indirect action by a candidate. These actions include: - Direct actions such as the candidate submitting a new resume as part of a job application to the agency, using a self-service tool such as a website to update their profile, and so on. - Indirect actions by the candidate such as uploading a resume to a job board that is collected by the agency through a feed, providing a resume to a recruiter who then uploads it into the ATS, and so on. - Updates made to the candidate’s profile by the recruiter as a result of interacting with the candidate (for example adding a skill or work preference, and so on). Changes to [recruiting_notes][google.cloud.talent.v4beta1.Profile.recrui ting_notes] are specifically excluded from this action type. Note: [candidate_update_time][google.cloud.talent.v4b eta1.Profile.candidate_update_time] must be greater than or equal to [resume_update_time][google.cloud.talent.v4beta1.Pr ofile.resume_update_time] or an error is thrown.

resume_update_time#

The timestamp when the candidate’s resume was added or updated on the candidate’s profile. Whether that resume was directly uploaded by a candidate, pulled from a 3rd party job board feed, added by a recruiter, and so on. If this field is updated, it’s expected that [resume][google.cloud.talent.v4beta1.Profile.resume] is provided in the create or update calls.

resume#

The resume representing this profile.

person_names#

The names of the candidate this profile references. Currently only one person name is supported.

addresses#

The candidate’s postal addresses. It’s highly recommended to input this information as accurately as possible to help improve search quality. Here are some recommendations: - Provide [Address.usage][google.cloud.talent.v4beta1.Address.usage] if possible, especially if the address is PERSONAL. During a search only personal addresses are considered. If there is no such address, all addresses with unspecified usage are assumed to be personal. - Provide [Address.current][google.cloud.talent.v4beta1.Address.current] for the current address if possible. During a search, only current addresses are considered. If there is no such address, all addresses are assumed to be current. When displaying a candidate’s addresses, it is sometimes desirable to limit the number of addresses shown. In these cases we recommend that you display the addresses in the following order of priority: 1. [Address.usage][google.cloud.talent.v4beta1.Address.usage] is PERSONAL and [Address.current][google.cloud.talent.v4beta1.Address.current] is true. 2. [Address.usage][google.cloud.talent.v4beta1.Address.usage] is PERSONAL and [Address.current][google.cloud.talent.v4beta1.Address.current] is false or not set. 3. [Address.usage][google.cloud.talent.v4beta1.Address.usage] is CONTACT_INFO_USAGE_UNSPECIFIED and [Address.current][google.cloud.talent.v4beta1.Address.current] is true. 4. [Address.usage][google.cloud.talent.v4beta1.Address.usage] is CONTACT_INFO_USAGE_UNSPECIFIED and [Address.current][google.cloud.talent.v4beta1.Address.current] is false or not set.

email_addresses#

The candidate’s email addresses.

phone_numbers#

The candidate’s phone number(s).

personal_uris#

The candidate’s personal URIs.

additional_contact_info#

Available contact information besides [addresses][google.cloud.talent.v4beta1.Profile.addresses], [e mail_addresses][google.cloud.talent.v4beta1.Profile.email_ad dresses], [phone_numbers][google.cloud.talent.v4beta1.Profile .phone_numbers] and [personal_uris][google.cloud.talent.v4be ta1.Profile.personal_uris]. For example, Hang-out, Skype.

employment_records#

The employment history records of the candidate. It’s highly recommended to input this information as accurately as possible to help improve search quality. Here are some recommendations: - Specify the start and end dates of the employment records. - List different employment types separately, no matter how minor the change is. For example, only job title is changed from “software engineer” to “senior software engineer”. - Provide [EmploymentRecord.is _current][google.cloud.talent.v4beta1.EmploymentRecord.is_cu rrent] for the current employment if possible. If not, it’s inferred from user inputs. The limitation for max number of employment records is 100.

education_records#

The education history record of the candidate. It’s highly recommended to input this information as accurately as possible to help improve search quality. Here are some recommendations: - Specify the start and end dates of the education records. - List each education type separately, no matter how minor the change is. For example, the profile contains the education experience from the same school but different degrees. - Provide [EducationRecord.is_current] [google.cloud.talent.v4beta1.EducationRecord.is_current] for the current education if possible. If not, it’s inferred from user inputs. The limitation for max number of education records is 100.

skills#

The skill set of the candidate. It’s highly recommended to provide as much information as possible to help improve the search quality. The limitation for max number of skills is 500.

activities#

The individual or collaborative activities which the candidate has participated in, for example, open-source projects, class assignments that aren’t listed in [employment_records][google .cloud.talent.v4beta1.Profile.employment_records]. The limitation for max number of activities is 50.

publications#

The publications published by the candidate. The limitation for max number of publications is 50.

patents#

The patents acquired by the candidate.

certifications#

The certifications acquired by the candidate.

applications#

Output only. The resource names of the candidate’s applications.

assignments#

Output only. The resource names of the candidate’s assignments.

custom_attributes#

A map of fields to hold both filterable and non-filterable custom profile attributes that aren’t covered by the provided structured fields. See [CustomAttribute][google.cloud.talent.v4beta1.CustomAttribute] for more details. At most 100 filterable and at most 100 unfilterable keys are supported. If limit is exceeded, an error is thrown. Custom attributes are unfilterable by default. These are filterable when the filterable flag is set to true. Numeric custom attributes: each key can only map to one numeric value, otherwise an error is thrown. Client can also filter on numeric custom attributes using ‘>’, ‘<’ or ‘=’ operators. String custom attributes: each key can map up to 50 string values. For filterable string value, each value has a byte size of no more than 256B. For unfilterable string values, the maximum byte size of a single key is 64B. An error is thrown for any request exceeding the limit. The maximum total byte size is 10KB.

processed#

Output only. Indicates if a summarized profile was created as part of the profile creation API call. This flag does not indicate whether a profile is searchable or not.

keyword_snippet#

Output only. Keyword snippet shows how the search result is related to a search query. This is only returned in [SearchPro filesResponse][google.cloud.talent.v4beta1.SearchProfilesRespo nse].

availability_signals#

Output only. Candidate’s availability signals.

derived_addresses#

Output only. Derived locations of the profile, resolved from [ Profile.addresses][google.cloud.talent.v4beta1.Profile.address es]. [derived_addresses][google.cloud.talent.v4beta1.Profile .derived_addresses] are exactly matched to [Profile.addresses ][google.cloud.talent.v4beta1.Profile.addresses] in the same order.

class CustomAttributesEntry#
key#

Field google.cloud.talent.v4beta1.Profile.CustomAttributesEntry.key

value#

Field google.cloud.talent.v4beta1.Profile.CustomAttributesEntry.value

activities

Field google.cloud.talent.v4beta1.Profile.activities

additional_contact_info

Field google.cloud.talent.v4beta1.Profile.additional_contact_info

addresses

Field google.cloud.talent.v4beta1.Profile.addresses

applications

Field google.cloud.talent.v4beta1.Profile.applications

assignments

Field google.cloud.talent.v4beta1.Profile.assignments

availability_signals

Field google.cloud.talent.v4beta1.Profile.availability_signals

candidate_update_time

Field google.cloud.talent.v4beta1.Profile.candidate_update_time

certifications

Field google.cloud.talent.v4beta1.Profile.certifications

create_time

Field google.cloud.talent.v4beta1.Profile.create_time

custom_attributes

Field google.cloud.talent.v4beta1.Profile.custom_attributes

derived_addresses

Field google.cloud.talent.v4beta1.Profile.derived_addresses

education_records

Field google.cloud.talent.v4beta1.Profile.education_records

email_addresses

Field google.cloud.talent.v4beta1.Profile.email_addresses

employment_records

Field google.cloud.talent.v4beta1.Profile.employment_records

external_id

Field google.cloud.talent.v4beta1.Profile.external_id

group_id

Field google.cloud.talent.v4beta1.Profile.group_id

is_hirable

Field google.cloud.talent.v4beta1.Profile.is_hirable

keyword_snippet

Field google.cloud.talent.v4beta1.Profile.keyword_snippet

name

Field google.cloud.talent.v4beta1.Profile.name

patents

Field google.cloud.talent.v4beta1.Profile.patents

person_names

Field google.cloud.talent.v4beta1.Profile.person_names

personal_uris

Field google.cloud.talent.v4beta1.Profile.personal_uris

phone_numbers

Field google.cloud.talent.v4beta1.Profile.phone_numbers

processed

Field google.cloud.talent.v4beta1.Profile.processed

publications

Field google.cloud.talent.v4beta1.Profile.publications

resume

Field google.cloud.talent.v4beta1.Profile.resume

resume_update_time

Field google.cloud.talent.v4beta1.Profile.resume_update_time

skills

Field google.cloud.talent.v4beta1.Profile.skills

source

Field google.cloud.talent.v4beta1.Profile.source

update_time

Field google.cloud.talent.v4beta1.Profile.update_time

uri

Field google.cloud.talent.v4beta1.Profile.uri

class google.cloud.talent_v4beta1.types.ProfileEvent#

An event issued when a profile searcher interacts with the application that implements Cloud Talent Solution.

type#

Required. Type of event.

profiles#

Required. The [profile name(s)][google.cloud.talent.v4beta1.Profile.name] associated with this client event. The format is “projects/{project_id} /tenants/{tenant_id}/profiles/{profile_id}”, for example, “projects/foo/tenants/bar/profiles/baz”.

jobs#

The [job name(s)][google.cloud.talent.v4beta1.Job.name] associated with this client event. Leave it empty if the event isn’t associated with a job. The format is “projects/{project_id}/tenants/{tenant_id}/jobs/{job_id}”, for example, “projects/foo/tenants/bar/jobs/baz”.

jobs

Field google.cloud.talent.v4beta1.ProfileEvent.jobs

profiles

Field google.cloud.talent.v4beta1.ProfileEvent.profiles

type

Field google.cloud.talent.v4beta1.ProfileEvent.type

class google.cloud.talent_v4beta1.types.ProfileQuery#

Filters to apply when performing the search query.

query#

Keywords to match any text fields of profiles. For example, “software engineer in Palo Alto”.

location_filters#

The location filter specifies geo-regions containing the profiles to search against. One of [LocationFilter.address][g oogle.cloud.talent.v4beta1.LocationFilter.address] or [Locatio nFilter.lat_lng][google.cloud.talent.v4beta1.LocationFilter.l at_lng] must be provided or an error is thrown. If both [Loca tionFilter.address][google.cloud.talent.v4beta1.LocationFilter .address] and [LocationFilter.lat_lng][google.cloud.talent.v4 beta1.LocationFilter.lat_lng] are provided, an error is thrown. The following logic is used to determine which locations in the profile to filter against: 1. All of the profile’s geocoded [Profile.addresses][google.cloud.talent.v4b eta1.Profile.addresses] where [Address.usage][google.cloud.talent.v4beta1.Address.usage] is PERSONAL and [Address.current][google.cloud.talent.v4beta1.Address.current] is true. 2. If the above set of locations is empty, all of the profile’s geocoded [Profile.addresses][google.cloud.talent.v4b eta1.Profile.addresses] where [Address.usage][google.cloud.talent.v4beta1.Address.usage] is CONTACT_INFO_USAGE_UNSPECIFIED and [Address.current][google.cloud.talent.v4beta1.Address.current] is true. 3. If the above set of locations is empty, all of the profile’s geocoded [Profile.addresses][google.cloud.talent.v4b eta1.Profile.addresses] where [Address.usage][google.cloud.talent.v4beta1.Address.usage] is PERSONAL or CONTACT_INFO_USAGE_UNSPECIFIED and [Address.current][google.cloud.talent.v4beta1.Address.current] is not set. This means that any profiles without any [Profile .addresses][google.cloud.talent.v4beta1.Profile.addresses] that match any of the above criteria will not be included in a search with location filter. Furthermore, any [Profile.address es][google.cloud.talent.v4beta1.Profile.addresses] where [Address.usage][google.cloud.talent.v4beta1.Address.usage] is WORK or SCHOOL or where [Address.current][google.cloud.talent.v4beta1.Address.current] is false are not considered for location filter. If a location filter isn’t specified, profiles fitting the other search criteria are retrieved regardless of where they’re located. If [LocationFilter.negated][google.cloud.talent.v4be ta1.LocationFilter.negated] is specified, the result doesn’t contain profiles from that location. If [LocationFilter.addre ss][google.cloud.talent.v4beta1.LocationFilter.address] is provided, the [LocationType][google.cloud.talent.v4beta1.Locat ion.LocationType], center point (latitude and longitude), and radius are automatically detected by the Google Maps Geocoding API and included as well. If [LocationFilter.address][google.c loud.talent.v4beta1.LocationFilter.address] cannot be geocoded, the filter falls back to keyword search. If the detected [LocationType][google.cloud.talent.v4beta1.Location.L ocationType] is [LocationType.SUB_ADMINISTRATIVE_AREA][googl e.cloud.talent.v4beta1.Location.LocationType.SUB_ADMINISTRATI VE_AREA], [LocationType.ADMINISTRATIVE_AREA][google.cloud.ta lent.v4beta1.Location.LocationType.ADMINISTRATIVE_AREA], or [ LocationType.COUNTRY][google.cloud.talent.v4beta1.Location.Loc ationType.COUNTRY], the filter is performed against the detected location name (using exact text matching). Otherwise, the filter is performed against the detected center point and a radius of detected location radius + [LocationFilter.distanc e_in_miles][google.cloud.talent.v4beta1.LocationFilter.dista nce_in_miles]. If [LocationFilter.address][google.cloud.tal ent.v4beta1.LocationFilter.address] is provided, [LocationFilt er.distance_in_miles][google.cloud.talent.v4beta1.LocationFi lter.distance_in_miles] is the additional radius on top of the radius of the location geocoded from [LocationFilter.addre ss][google.cloud.talent.v4beta1.LocationFilter.address]. If [L ocationFilter.lat_lng][google.cloud.talent.v4beta1.LocationFi lter.lat_lng] is provided, [LocationFilter.distance_in_mile s][google.cloud.talent.v4beta1.LocationFilter.distance_in_mi les] is the only radius that is used. [LocationFilter.distanc e_in_miles][google.cloud.talent.v4beta1.LocationFilter.dista nce_in_miles] is 10 by default. Note that the value of [Loca tionFilter.distance_in_miles][google.cloud.talent.v4beta1.Lo cationFilter.distance_in_miles] is 0 if it is unset, so the server does not differentiate [LocationFilter.distance_in_mi les][google.cloud.talent.v4beta1.LocationFilter.distance_in_ miles] that is explicitly set to 0 and [LocationFilter.distanc e_in_miles][google.cloud.talent.v4beta1.LocationFilter.dista nce_in_miles] that is not set. Which means that if [Location Filter.distance_in_miles][google.cloud.talent.v4beta1.Locati onFilter.distance_in_miles] is explicitly set to 0, the server will use the default value of [LocationFilter.distance _in_miles][google.cloud.talent.v4beta1.LocationFilter.distanc e_in_miles] which is 10. To work around this and effectively set [LocationFilter.distance_in_miles][google.cloud.talent.v 4beta1.LocationFilter.distance_in_miles] to 0, we recommend setting [LocationFilter.distance_in_miles][google.cloud.tale nt.v4beta1.LocationFilter.distance_in_miles] to a very small decimal number (such as 0.00001). If [LocationFilter.distance _in_miles][google.cloud.talent.v4beta1.LocationFilter.distan ce_in_miles] is negative, an error is thrown.

job_title_filters#

Job title filter specifies job titles of profiles to match on. If a job title isn’t specified, profiles with any titles are retrieved. If multiple values are specified, profiles are retrieved with any of the specified job titles. If [JobTitleF ilter.negated][google.cloud.talent.v4beta1.JobTitleFilter.nega ted] is specified, the result won’t contain profiles with the job titles. For example, search for profiles with a job title “Product Manager”.

employer_filters#

Employer filter specifies employers of profiles to match on. If an employer filter isn’t specified, profiles with any employers are retrieved. If multiple employer filters are specified, profiles with any matching employers are retrieved. If [EmployerFilter.negated][google.cloud.talent.v4beta1.Employ erFilter.negated] is specified, the result won’t contain profiles that match the employers. For example, search for profiles that have working experience at “Google LLC”.

education_filters#

Education filter specifies education of profiles to match on. If an education filter isn’t specified, profiles with any education are retrieved. If multiple education filters are specified, profiles that match any education filters are retrieved. If [EducationFilter.negated][google.cloud.talent.v 4beta1.EducationFilter.negated] is specified, the result won’t contain profiles that match the educations. For example, search for profiles with a master degree.

skill_filters#

Skill filter specifies skill of profiles to match on. If a skill filter isn’t specified, profiles with any skills are retrieved. If multiple skill filters are specified, profiles that match any skill filters are retrieved. If [SkillFilter.n egated][google.cloud.talent.v4beta1.SkillFilter.negated] is specified, the result won’t contain profiles that match the skills. For example, search for profiles that have “Java” and “Python” in skill list.

work_experience_filter#

Work experience filter specifies the total working experience of profiles to match on. If a work experience filter isn’t specified, profiles with any professional experience are retrieved. If multiple work experience filters are specified, profiles that match any work experience filters are retrieved. For example, search for profiles with 10 years of work experience.

time_filters#

Time filter specifies the create/update timestamp of the profiles to match on. For example, search for profiles created since “2018-1-1”.

hirable_filter#

The hirable filter specifies the profile’s hirable status to match on.

application_date_filters#

The application date filters specify application date ranges to match on.

application_outcome_notes_filters#

The application outcome notes filters specify the notes for the outcome of the job application.

application_job_filters#

The application job filters specify the job applied for in the application.

custom_attribute_filter#

This filter specifies a structured syntax to match against the [Profile.custom_attributes][google.cloud.talent.v4beta1.Profi le.custom_attributes] that are marked as filterable. The syntax for this expression is a subset of Google SQL syntax. String custom attributes: supported operators are =, != where the left of the operator is a custom field key and the right of the operator is a string (surrounded by quotes) value. Numeric custom attributes: Supported operators are ‘>’, ‘<’ or ‘=’ operators where the left of the operator is a custom field key and the right of the operator is a numeric value. Supported functions are LOWER() to perform case insensitive match and EMPTY() to filter on the existence of a key. Boolean expressions (AND/OR/NOT) are supported up to 3 levels of nesting (for example “((A AND B AND C) OR NOT D) AND E”), and there can be a maximum of 50 comparisons/functions in the expression. The expression must be < 2000 characters in length. Sample Query: (key1 = “TEST” OR LOWER(key1)=”test” OR NOT EMPTY(key1))

candidate_availability_filter#

Deprecated. Use availability_filters instead. The candidate availability filter which filters based on availability signals. Signal 1: Number of days since most recent job application. See [Availability.JobApplicationAvailabilitySigna l][google.cloud.talent.v4beta1.Availability.JobApplicationAvai labilitySignal] for the details of this signal. Signal 2: Number of days since last profile update. See [Availability.Pr ofileUpdateAvailabilitySignal][google.cloud.talent.v4beta1.Ava ilability.ProfileUpdateAvailabilitySignal] for the details of this signal. The candidate availability filter helps a recruiter understand if a specific candidate is likely to be actively seeking new job opportunities based on an aggregated set of signals. Specifically, the intent is NOT to indicate the candidate’s potential qualification / interest / close ability for a specific job.

availability_filters#

The availability filter which filters based on [Profile.availa bility_signals][google.cloud.talent.v4beta1.Profile.availabil ity_signals]. The availability filter helps a recruiter understand if a specific candidate is likely to be actively seeking new job opportunities based on an aggregated set of signals. Specifically, the intent is NOT to indicate the candidate’s potential qualification / interest / close ability for a specific job. There can be at most one [AvailabilityFil ter][google.cloud.talent.v4beta1.AvailabilityFilter] per [sign al_type][google.cloud.talent.v4beta1.AvailabilityFilter.signa l_type]. If there are multiple [AvailabilityFilter][google.cl oud.talent.v4beta1.AvailabilityFilter] for a [signal_type][go ogle.cloud.talent.v4beta1.AvailabilityFilter.signal_type], an error is thrown.

person_name_filters#

Person name filter specifies person name of profiles to match on. If multiple person name filters are specified, profiles that match any person name filters are retrieved. For example, search for profiles of candidates with name “John Smith”.

application_date_filters

Field google.cloud.talent.v4beta1.ProfileQuery.application_date_filters

application_job_filters

Field google.cloud.talent.v4beta1.ProfileQuery.application_job_filters

application_outcome_notes_filters

Field google.cloud.talent.v4beta1.ProfileQuery.application_outcome_notes_filters

availability_filters

Field google.cloud.talent.v4beta1.ProfileQuery.availability_filters

candidate_availability_filter

Field google.cloud.talent.v4beta1.ProfileQuery.candidate_availability_filter

custom_attribute_filter

Field google.cloud.talent.v4beta1.ProfileQuery.custom_attribute_filter

education_filters

Field google.cloud.talent.v4beta1.ProfileQuery.education_filters

employer_filters

Field google.cloud.talent.v4beta1.ProfileQuery.employer_filters

hirable_filter

Field google.cloud.talent.v4beta1.ProfileQuery.hirable_filter

job_title_filters

Field google.cloud.talent.v4beta1.ProfileQuery.job_title_filters

location_filters

Field google.cloud.talent.v4beta1.ProfileQuery.location_filters

person_name_filters

Field google.cloud.talent.v4beta1.ProfileQuery.person_name_filters

query

Field google.cloud.talent.v4beta1.ProfileQuery.query

skill_filters

Field google.cloud.talent.v4beta1.ProfileQuery.skill_filters

time_filters

Field google.cloud.talent.v4beta1.ProfileQuery.time_filters

work_experience_filter

Field google.cloud.talent.v4beta1.ProfileQuery.work_experience_filter

class google.cloud.talent_v4beta1.types.Publication#

Resource that represents a publication resource of a candidate.

authors#

A list of author names. Number of characters allowed is 100.

title#

The title of the publication. Number of characters allowed is 100.

description#

The description of the publication. Number of characters allowed is 100,000.

journal#

The journal name of the publication. Number of characters allowed is 100.

volume#

Volume number. Number of characters allowed is 100.

publisher#

The publisher of the journal. Number of characters allowed is 100.

publication_date#

The publication date.

publication_type#

The publication type. Number of characters allowed is 100.

isbn#

ISBN number. Number of characters allowed is 100.

authors

Field google.cloud.talent.v4beta1.Publication.authors

description

Field google.cloud.talent.v4beta1.Publication.description

isbn

Field google.cloud.talent.v4beta1.Publication.isbn

journal

Field google.cloud.talent.v4beta1.Publication.journal

publication_date

Field google.cloud.talent.v4beta1.Publication.publication_date

publication_type

Field google.cloud.talent.v4beta1.Publication.publication_type

publisher

Field google.cloud.talent.v4beta1.Publication.publisher

title

Field google.cloud.talent.v4beta1.Publication.title

volume

Field google.cloud.talent.v4beta1.Publication.volume

class google.cloud.talent_v4beta1.types.Rating#

The details of the score received for an assessment or interview.

overall#

Overall score.

min#

The minimum value for the score.

max#

The maximum value for the score.

interval#

The steps within the score (for example, interval = 1 max = 5 min = 1 indicates that the score can be 1, 2, 3, 4, or 5)

interval

Field google.cloud.talent.v4beta1.Rating.interval

max

Field google.cloud.talent.v4beta1.Rating.max

min

Field google.cloud.talent.v4beta1.Rating.min

overall

Field google.cloud.talent.v4beta1.Rating.overall

class google.cloud.talent_v4beta1.types.RequestMetadata#

Meta information related to the job searcher or entity conducting the job search. This information is used to improve the performance of the service.

domain#

Required if [allow_missing_ids][google.cloud.talent.v4beta1. RequestMetadata.allow_missing_ids] is unset or false. The client-defined scope or source of the service call, which typically is the domain on which the service has been implemented and is currently being run. For example, if the service is being run by client Foo, Inc., on job board www.foo.com and career site www.bar.com, then this field is set to “foo.com” for use on the job board, and “bar.com” for use on the career site. Note that any improvements to the model for a particular tenant site rely on this field being set correctly to a unique domain. The maximum number of allowed characters is 255.

session_id#

Required if [allow_missing_ids][google.cloud.talent.v4beta1. RequestMetadata.allow_missing_ids] is unset or false. A unique session identification string. A session is defined as the duration of an end user’s interaction with the service over a certain period. Obfuscate this field for privacy concerns before providing it to the service. Note that any improvements to the model for a particular tenant site rely on this field being set correctly to a unique session ID. The maximum number of allowed characters is 255.

user_id#

Required if [allow_missing_ids][google.cloud.talent.v4beta1. RequestMetadata.allow_missing_ids] is unset or false. A unique user identification string, as determined by the client. To have the strongest positive impact on search quality make sure the client-level is unique. Obfuscate this field for privacy concerns before providing it to the service. Note that any improvements to the model for a particular tenant site rely on this field being set correctly to a unique user ID. The maximum number of allowed characters is 255.

allow_missing_ids#

Only set when any of [domain][google.cloud.talent.v4beta1.RequestMetadata.domain], [session_id][google.cloud.talent.v4beta1.RequestMetadata.sess ion_id] and [user_id][google.cloud.talent.v4beta1.RequestMet adata.user_id] isn’t available for some reason. It is highly recommended not to set this field and provide accurate [domain][google.cloud.talent.v4beta1.RequestMetadata.domain], [session_id][google.cloud.talent.v4beta1.RequestMetadata.sess ion_id] and [user_id][google.cloud.talent.v4beta1.RequestMet adata.user_id] for the best service experience.

device_info#

The type of device used by the job seeker at the time of the call to the service.

allow_missing_ids

Field google.cloud.talent.v4beta1.RequestMetadata.allow_missing_ids

device_info

Field google.cloud.talent.v4beta1.RequestMetadata.device_info

domain

Field google.cloud.talent.v4beta1.RequestMetadata.domain

session_id

Field google.cloud.talent.v4beta1.RequestMetadata.session_id

user_id

Field google.cloud.talent.v4beta1.RequestMetadata.user_id

class google.cloud.talent_v4beta1.types.ResponseMetadata#

Additional information returned to client, such as debugging information.

request_id#

A unique id associated with this call. This id is logged for tracking purposes.

request_id

Field google.cloud.talent.v4beta1.ResponseMetadata.request_id

class google.cloud.talent_v4beta1.types.Resume#

Resource that represents a resume.

structured_resume#

Users can create a profile with only this field field, if [res ume_type][google.cloud.talent.v4beta1.Resume.resume_type] is [HRXML][google.cloud.talent.v4beta1.Resume.ResumeType.HRXML]. For example, the API parses this field and creates a profile with all structured fields populated. [EmploymentRecord][googl e.cloud.talent.v4beta1.EmploymentRecord], [EducationRecord][go ogle.cloud.talent.v4beta1.EducationRecord], and so on. An error is thrown if this field cannot be parsed. Note that the use of the functionality offered by this field to extract data from resumes is an Alpha feature and as such is not covered by any SLA.

resume_type#

The format of [structured_resume][google.cloud.talent.v4beta1 .Resume.structured_resume].

resume_type

Field google.cloud.talent.v4beta1.Resume.resume_type

structured_resume

Field google.cloud.talent.v4beta1.Resume.structured_resume

class google.cloud.talent_v4beta1.types.SearchJobsRequest#

The Request body of the SearchJobs call.

parent#

Required. The resource name of the tenant to search within. The format is “projects/{project_id}/tenants/{tenant_id}”. For example, “projects/foo/tenant/bar”. If tenant id is unspecified, a default tenant is created. For example, “projects/foo”.

search_mode#

Mode of a search. Defaults to [SearchMode.JOB_SEARCH][google .cloud.talent.v4beta1.SearchJobsRequest.SearchMode.JOB_SEARCH ].

request_metadata#

Required. The meta information collected about the job searcher, used to improve the search quality of the service. The identifiers (such as user_id) are provided by users, and must be unique and consistent.

job_query#

Query used to search against jobs, such as keyword, location filters, etc.

enable_broadening#

Controls whether to broaden the search when it produces sparse results. Broadened queries append results to the end of the matching results list. Defaults to false.

require_precise_result_size#

Controls if the search job request requires the return of a precise count of the first 300 results. Setting this to true ensures consistency in the number of results per page. Best practice is to set this value to true if a client allows users to jump directly to a non-sequential search results page. Enabling this flag may adversely impact performance. Defaults to false.

histogram_queries#

An expression specifies a histogram request against matching jobs. Expression syntax is an aggregation function call with histogram facets and other options. Available aggregation function calls are: * count(string_histogram_facet): Count the number of matching entities, for each distinct attribute value. * count(numeric_histogram_facet, list of buckets): Count the number of matching entities within each bucket. Data types: - Histogram facet: facet names with format [a-zA-Z][a-zA-Z0-9_]+. - String: string like “any string with backslash escape for quote(“).” - Number: whole number and floating point number like 10, -1 and -0.01. - List: list of elements with comma(,) separator surrounded by square brackets, for example, [1, 2, 3] and [“one”, “two”, “three”]. Built-in constants: - MIN (minimum number similar to java Double.MIN_VALUE) - MAX (maximum number similar to java Double.MAX_VALUE) Built-in functions: - bucket(start, end[, label]): bucket built-in function creates a bucket with range of [start, end). Note that the end is exclusive, for example, bucket(1, MAX, “positive number”) or bucket(1, 10). Job histogram facets: - company_display_name: histogram by [Job.company_display_name][google.cloud.tale nt.v4beta1.Job.company_display_name]. - employment_type: histogram by [Job.employment_types][google.cloud.talent.v4 beta1.Job.employment_types], for example, “FULL_TIME”, “PART_TIME”. - company_size: histogram by [CompanySize][google.cloud.talent.v4beta1.CompanySize], for example, “SMALL”, “MEDIUM”, “BIG”. - publish_time_in_month: histogram by the [Job.posting_pu blish_time][google.cloud.talent.v4beta1.Job.posting_publish _time] in months. Must specify list of numeric buckets in spec. - publish_time_in_year: histogram by the [Job.pos ting_publish_time][google.cloud.talent.v4beta1.Job.posting_ publish_time] in years. Must specify list of numeric buckets in spec. - degree_types: histogram by the [Job.de gree_types][google.cloud.talent.v4beta1.Job.degree_types], for example, “Bachelors”, “Masters”. - job_level: histogram by the [Job.job_level][google.cloud.talent.v4beta1.Job.job_level], for example, “Entry Level”. - country: histogram by the country code of jobs, for example, “US”, “FR”. - admin1: histogram by the admin1 code of jobs, which is a global placeholder referring to the state, province, or the particular term a country uses to define the geographic structure below the country level, for example, “CA”, “IL”. - city: histogram by a combination of the “city name, admin1 code”. For example, “Mountain View, CA”, “New York, NY”. - admin1_country: histogram by a combination of the “admin1 code, country”, for example, “CA, US”, “IL, US”. - city_coordinate: histogram by the city center’s GPS coordinates (latitude and longitude), for example, 37.4038522,-122.0987765. Since the coordinates of a city center can change, customers may need to refresh them periodically. - locale: histogram by the [Job.language_co de][google.cloud.talent.v4beta1.Job.language_code], for example, “en-US”, “fr-FR”. - language: histogram by the language subtag of the [Job.language_code][google.cloud.ta lent.v4beta1.Job.language_code], for example, “en”, “fr”. - category: histogram by the [JobCategory][google.cloud.talent.v4beta1.JobCategory], for example, “COMPUTER_AND_IT”, “HEALTHCARE”. - base_compensation_unit: histogram by the [CompensationInf o.CompensationUnit][google.cloud.talent.v4beta1.CompensationIn fo.CompensationUnit] of base salary, for example, “WEEKLY”, “MONTHLY”. - base_compensation: histogram by the base salary. Must specify list of numeric buckets to group results by. - annualized_base_compensation: histogram by the base annualized salary. Must specify list of numeric buckets to group results by. - annualized_total_compensation: histogram by the total annualized salary. Must specify list of numeric buckets to group results by. - string_custom_attribute: histogram by string [Job.custom_attributes][google.cloud.talent.v4beta1 .Job.custom_attributes]. Values can be accessed via square bracket notations like string_custom_attribute[“key1”]. - numeric_custom_attribute: histogram by numeric [Job.custo m_attributes][google.cloud.talent.v4beta1.Job.custom_attribu tes]. Values can be accessed via square bracket notations like numeric_custom_attribute[“key1”]. Must specify list of numeric buckets to group results by. Example expressions: - count(admin1) - count(base_compensation, [bucket(1000, 10000), bucket(10000, 100000), bucket(100000, MAX)]) - count(string_custom_attribute["some-string-custom- attribute"]) - count(numeric_custom_attribute["some- numeric-custom-attribute"],   [bucket(MIN, 0, "negative"), bucket(0, MAX, "non-negative"])

job_view#

The desired job attributes returned for jobs in the search response. Defaults to [JobView.JOB_VIEW_SMALL][google.cloud. talent.v4beta1.JobView.JOB_VIEW_SMALL] if no value is specified.

offset#

An integer that specifies the current offset (that is, starting result location, amongst the jobs deemed by the API as relevant) in search results. This field is only considered if [page_token][google.cloud.talent.v4beta1.SearchJobsRequest .page_token] is unset. For example, 0 means to return results starting from the first matching job, and 10 means to return from the 11th job. This can be used for pagination, (for example, pageSize = 10 and offset = 10 means to return from the second page).

page_size#

A limit on the number of jobs returned in the search results. Increasing this value above the default value of 10 can increase search response time. The value can be between 1 and 100.

page_token#

The token specifying the current offset within search results. See [SearchJobsResponse.next_page_token][google.cloud.talent .v4beta1.SearchJobsResponse.next_page_token] for an explanation of how to obtain the next set of query results.

order_by#

The criteria determining how search results are sorted. Default is "relevance desc". Supported options are: - "relevance desc": By relevance descending, as determined by the API algorithms. Relevance thresholding of query results is only available with this ordering. - "posting_publish_time desc": By [Job.posting_publish_ time][google.cloud.talent.v4beta1.Job.posting_publish_time] descending. - "posting_update_time desc": By [Job.post ing_update_time][google.cloud.talent.v4beta1.Job.posting_up date_time] descending. - "title": By [Job.title][google.cloud.talent.v4beta1.Job.title] ascending. - "title desc": By [Job.title][google.cloud.talent.v4beta1.Job.title] descending. - "annualized_base_compensation": By job’s [Compensati onInfo.annualized_base_compensation_range][google.cloud.tal ent.v4beta1.CompensationInfo.annualized_base_compensation_r ange] ascending. Jobs whose annualized base compensation is unspecified are put at the end of search results. - "annualized_base_compensation desc": By job’s [Compensa tionInfo.annualized_base_compensation_range][google.cloud.t alent.v4beta1.CompensationInfo.annualized_base_compensation _range] descending. Jobs whose annualized base compensation is unspecified are put at the end of search results. - "annualized_total_compensation": By job’s [Compensation Info.annualized_total_compensation_range][google.cloud.tale nt.v4beta1.CompensationInfo.annualized_total_compensation_r ange] ascending. Jobs whose annualized base compensation is unspecified are put at the end of search results. - "annualized_total_compensation desc": By job’s [Compens ationInfo.annualized_total_compensation_range][google.cloud .talent.v4beta1.CompensationInfo.annualized_total_compensati on_range] descending. Jobs whose annualized base compensation is unspecified are put at the end of search results. - "custom_ranking desc": By the relevance score adjusted to the [SearchJobsRequest.CustomRankingInfo.rankin g_expression][google.cloud.talent.v4beta1.SearchJobsRequest.C ustomRankingInfo.ranking_expression] with weight factor assigned by [SearchJobsRequest.CustomRankingInfo.importance _level][google.cloud.talent.v4beta1.SearchJobsRequest.CustomR ankingInfo.importance_level] in descending order. - Location sorting: Use the special syntax to order jobs by distance: "distance_from('Hawaii')": Order by distance from Hawaii. "distance_from(19.89, 155.5)": Order by distance from a coordinate. "distance_from('Hawaii'), distance_from('Puerto Rico')": Order by multiple locations. See details below. "distance_from('Hawaii'), distance_from(19.89, 155.5)": Order by multiple locations. See details below. The string can have a maximum of 256 characters. When multiple distance centers are provided, a job that is close to any of the distance centers would have a high rank. When a job has multiple locations, the job location closest to one of the distance centers will be used. Jobs that don’t have locations will be ranked at the bottom. Distance is calculated with a precision of 11.3 meters (37.4 feet). Diversification strategy is still applied unless explicitly disabled in [diversification_level][google.cloud.talent.v4beta1.SearchJob sRequest.diversification_level].

diversification_level#

Controls whether highly similar jobs are returned next to each other in the search results. Jobs are identified as highly similar based on their titles, job categories, and locations. Highly similar results are clustered so that only one representative job of the cluster is displayed to the job seeker higher up in the results, with the other jobs being displayed lower down in the results. Defaults to [Diversifica tionLevel.SIMPLE][google.cloud.talent.v4beta1.SearchJobsReques t.DiversificationLevel.SIMPLE] if no value is specified.

custom_ranking_info#

Controls over how job documents get ranked on top of existing relevance score (determined by API algorithm).

disable_keyword_match#

Controls whether to disable exact keyword match on [Job.title][google.cloud.talent.v4beta1.Job.title], [Job.descr iption][google.cloud.talent.v4beta1.Job.description], [Job.com pany_display_name][google.cloud.talent.v4beta1.Job.company_ display_name], [Job.addresses][google.cloud.talent.v4beta1.Job.addresses], [J ob.qualifications][google.cloud.talent.v4beta1.Job.qualificati ons]. When disable keyword match is turned off, a keyword match returns jobs that do not match given category filters when there are matching keywords. For example, for the query “program manager,” a result is returned even if the job posting has the title “software developer,” which doesn’t fall into “program manager” ontology, but does have “program manager” appearing in its description. For queries like “cloud” that don’t contain title or location specific ontology, jobs with “cloud” keyword matches are returned regardless of this flag’s value. Use [Company.keyword_search able_job_custom_attributes][google.cloud.talent.v4beta1.Com pany.keyword_searchable_job_custom_attributes] if company- specific globally matched custom field/attribute string values are needed. Enabling keyword match improves recall of subsequent search requests. Defaults to false.

class CustomRankingInfo#

Custom ranking information for [SearchJobsRequest][google.cloud.talent.v4beta1.SearchJobsRequest].

importance_level#

Required. Controls over how important the score of [CustomRank ingInfo.ranking_expression][google.cloud.talent.v4beta1.Searc hJobsRequest.CustomRankingInfo.ranking_expression] gets applied to job’s final ranking position. An error is thrown if not specified.

ranking_expression#

Required. Controls over how job documents get ranked on top of existing relevance score (determined by API algorithm). The product of ranking expression and relevance score is used to determine job’s final ranking position. The syntax for this expression is a subset of Google SQL syntax. Supported operators are: +, -, *, /, where the left and right side of the operator is either a numeric [Job.custom_attributes][goog le.cloud.talent.v4beta1.Job.custom_attributes] key, integer/double value or an expression that can be evaluated to a number. Parenthesis are supported to adjust calculation precedence. The expression must be < 100 characters in length. Sample ranking expression (year + 25) * 0.25 - (freshness / 0.5)

importance_level

Field google.cloud.talent.v4beta1.SearchJobsRequest.CustomRankingInfo.importance_level

ranking_expression

Field google.cloud.talent.v4beta1.SearchJobsRequest.CustomRankingInfo.ranking_expression

custom_ranking_info

Field google.cloud.talent.v4beta1.SearchJobsRequest.custom_ranking_info

disable_keyword_match

Field google.cloud.talent.v4beta1.SearchJobsRequest.disable_keyword_match

diversification_level

Field google.cloud.talent.v4beta1.SearchJobsRequest.diversification_level

enable_broadening

Field google.cloud.talent.v4beta1.SearchJobsRequest.enable_broadening

histogram_queries

Field google.cloud.talent.v4beta1.SearchJobsRequest.histogram_queries

job_query

Field google.cloud.talent.v4beta1.SearchJobsRequest.job_query

job_view

Field google.cloud.talent.v4beta1.SearchJobsRequest.job_view

offset

Field google.cloud.talent.v4beta1.SearchJobsRequest.offset

order_by

Field google.cloud.talent.v4beta1.SearchJobsRequest.order_by

page_size

Field google.cloud.talent.v4beta1.SearchJobsRequest.page_size

page_token

Field google.cloud.talent.v4beta1.SearchJobsRequest.page_token

parent

Field google.cloud.talent.v4beta1.SearchJobsRequest.parent

request_metadata

Field google.cloud.talent.v4beta1.SearchJobsRequest.request_metadata

require_precise_result_size

Field google.cloud.talent.v4beta1.SearchJobsRequest.require_precise_result_size

search_mode

Field google.cloud.talent.v4beta1.SearchJobsRequest.search_mode

class google.cloud.talent_v4beta1.types.SearchJobsResponse#

Response for SearchJob method.

matching_jobs#

The Job entities that match the specified [SearchJobsRequest][ google.cloud.talent.v4beta1.SearchJobsRequest].

histogram_query_results#

The histogram results that match with specified [SearchJobsReq uest.histogram_queries][google.cloud.talent.v4beta1.SearchJob sRequest.histogram_queries].

next_page_token#

The token that specifies the starting position of the next page of results. This field is empty if there are no more results.

location_filters#

The location filters that the service applied to the specified query. If any filters are lat-lng based, the [Location.locatio n_type][google.cloud.talent.v4beta1.Location.location_type] is [Location.LocationType.LOCATION_TYPE_UNSPECIFIED][google. cloud.talent.v4beta1.Location.LocationType.LOCATION_TYPE_UNS PECIFIED].

estimated_total_size#

An estimation of the number of jobs that match the specified query. This number isn’t guaranteed to be accurate. For accurate results, see [SearchJobsRequest.require_precise_res ult_size][google.cloud.talent.v4beta1.SearchJobsRequest.requi re_precise_result_size].

total_size#

The precise result count, which is available only if the client set [SearchJobsRequest.require_precise_result_size][ google.cloud.talent.v4beta1.SearchJobsRequest.require_precise _result_size] to true, or if the response is the last page of results. Otherwise, the value is -1.

metadata#

Additional information for the API invocation, such as the request tracking id.

broadened_query_jobs_count#

If query broadening is enabled, we may append additional results from the broadened query. This number indicates how many of the jobs returned in the jobs field are from the broadened query. These results are always at the end of the jobs list. In particular, a value of 0, or if the field isn’t set, all the jobs in the jobs list are from the original (without broadening) query. If this field is non-zero, subsequent requests with offset after this result set should contain all broadened results.

spell_correction#

The spell checking result, and correction.

class CommuteInfo#

Commute details related to this job.

job_location#

Location used as the destination in the commute calculation.

travel_duration#

The number of seconds required to travel to the job location from the query location. A duration of 0 seconds indicates that the job isn’t reachable within the requested duration, but was returned as part of an expanded query.

job_location

Field google.cloud.talent.v4beta1.SearchJobsResponse.CommuteInfo.job_location

travel_duration

Field google.cloud.talent.v4beta1.SearchJobsResponse.CommuteInfo.travel_duration

class MatchingJob#

Job entry with metadata inside [SearchJobsResponse][google.cloud.talent.v4beta1.SearchJobsResponse].

job#

Job resource that matches the specified [SearchJobsRequest][go ogle.cloud.talent.v4beta1.SearchJobsRequest].

job_summary#

A summary of the job with core information that’s displayed on the search results listing page.

job_title_snippet#

Contains snippets of text from the [Job.title][google.cloud.talent.v4beta1.Job.title] field most closely matching a search query’s keywords, if available. The matching query keywords are enclosed in HTML bold tags.

search_text_snippet#

Contains snippets of text from the [Job.description][google.cloud.talent.v4beta1.Job.description] and similar fields that most closely match a search query’s keywords, if available. All HTML tags in the original fields are stripped when returned in this field, and matching query keywords are enclosed in HTML bold tags.

commute_info#

Commute information which is generated based on specified [CommuteFilter][google.cloud.talent.v4beta1.CommuteFilter].

commute_info

Field google.cloud.talent.v4beta1.SearchJobsResponse.MatchingJob.commute_info

job

Field google.cloud.talent.v4beta1.SearchJobsResponse.MatchingJob.job

job_summary

Field google.cloud.talent.v4beta1.SearchJobsResponse.MatchingJob.job_summary

job_title_snippet

Field google.cloud.talent.v4beta1.SearchJobsResponse.MatchingJob.job_title_snippet

search_text_snippet

Field google.cloud.talent.v4beta1.SearchJobsResponse.MatchingJob.search_text_snippet

broadened_query_jobs_count

Field google.cloud.talent.v4beta1.SearchJobsResponse.broadened_query_jobs_count

estimated_total_size

Field google.cloud.talent.v4beta1.SearchJobsResponse.estimated_total_size

histogram_query_results

Field google.cloud.talent.v4beta1.SearchJobsResponse.histogram_query_results

location_filters

Field google.cloud.talent.v4beta1.SearchJobsResponse.location_filters

matching_jobs

Field google.cloud.talent.v4beta1.SearchJobsResponse.matching_jobs

metadata

Field google.cloud.talent.v4beta1.SearchJobsResponse.metadata

next_page_token

Field google.cloud.talent.v4beta1.SearchJobsResponse.next_page_token

spell_correction

Field google.cloud.talent.v4beta1.SearchJobsResponse.spell_correction

total_size

Field google.cloud.talent.v4beta1.SearchJobsResponse.total_size

class google.cloud.talent_v4beta1.types.SearchProfilesRequest#

The request body of the SearchProfiles call.

parent#

Required. The resource name of the tenant to search within. The format is “projects/{project_id}/tenants/{tenant_id}”. For example, “projects/foo/tenants/bar”.

request_metadata#

Required. The meta information collected about the profile search user. This is used to improve the search quality of the service. These values are provided by users, and must be precise and consistent.

profile_query#

Search query to execute. See [ProfileQuery][google.cloud.talent.v4beta1.ProfileQuery] for more details.

page_size#

A limit on the number of profiles returned in the search results. A value above the default value 10 can increase search response time. The maximum value allowed is 100. Otherwise an error is thrown.

page_token#

The pageToken, similar to offset enables users of the API to paginate through the search results. To retrieve the first page of results, set the pageToken to empty. The search response includes a [nextPageToken][google.cloud.talent.v4beta 1.SearchProfilesResponse.next_page_token] field that can be used to populate the pageToken field for the next page of results. Using pageToken instead of offset increases the performance of the API, especially compared to larger offset values.

offset#

An integer that specifies the current offset (that is, starting result) in search results. This field is only considered if [page_token][google.cloud.talent.v4beta1.Search ProfilesRequest.page_token] is unset. The maximum allowed value is 5000. Otherwise an error is thrown. For example, 0 means to search from the first profile, and 10 means to search from the 11th profile. This can be used for pagination, for example pageSize = 10 and offset = 10 means to search from the second page.

disable_spell_check#

This flag controls the spell-check feature. If false, the service attempts to correct a misspelled query. For example, “enginee” is corrected to “engineer”.

order_by#

The criteria that determines how search results are sorted. Defaults is “relevance desc” if no value is specified. Supported options are: - “relevance desc”: By descending relevance, as determined by the API algorithms. - “update_date desc”: Sort by [Profile.update_time][google. cloud.talent.v4beta1.Profile.update_time] in descending order (recently updated profiles first). - “create_date desc”: Sort by [Profile.create_time][google.cloud.talent.v 4beta1.Profile.create_time] in descending order (recently created profiles first). - “first_name”: Sort by [PersonN ame.PersonStructuredName.given_name][google.cloud.talent.v4be ta1.PersonName.PersonStructuredName.given_name] in ascending order. - “first_name desc”: Sort by [PersonName .PersonStructuredName.given_name][google.cloud.talent.v4beta1 .PersonName.PersonStructuredName.given_name] in descending order. - “last_name”: Sort by [PersonName.PersonStructure dName.family_name][google.cloud.talent.v4beta1.PersonName.Per sonStructuredName.family_name] in ascending order. - “last_name desc”: Sort by [PersonName.PersonStructuredName .family_name][google.cloud.talent.v4beta1.PersonName.PersonSt ructuredName.family_name] in ascending order.

case_sensitive_sort#

When sort by field is based on alphabetical order, sort values case sensitively (based on ASCII) when the value is set to true. Default value is case in-sensitive sort (false).

histogram_queries#

A list of expressions specifies histogram requests against matching profiles for [SearchProfilesRequest][google.cloud.tal ent.v4beta1.SearchProfilesRequest]. The expression syntax looks like a function definition with parameters. Function syntax: function_name(histogram_facet[, list of buckets]) Data types: - Histogram facet: facet names with format [a-zA-Z][a-zA-Z0-9_]+. - String: string like “any string with backslash escape for quote(“).” - Number: whole number and floating point number like 10, -1 and -0.01. - List: list of elements with comma(,) separator surrounded by square brackets. For example, [1, 2, 3] and [“one”, “two”, “three”]. Built-in constants: - MIN (minimum number similar to java Double.MIN_VALUE) - MAX (maximum number similar to java Double.MAX_VALUE) Built-in functions: - bucket(start, end[, label]) Bucket build-in function creates a bucket with range of [start, end). Note that the end is exclusive. For example, bucket(1, MAX, “positive number”) or bucket(1, 10). Histogram Facets: - admin1: Admin1 is a global placeholder for referring to state, province, or the particular term a country uses to define the geographic structure below the country level. Examples include states codes such as “CA”, “IL”, “NY”, and provinces, such as “BC”. - locality: Locality is a global placeholder for referring to city, town, or the particular term a country uses to define the geographic structure below the admin1 level. Examples include city names such as “Mountain View” and “New York”. - extended_locality: Extended locality is concatenated version of admin1 and locality with comma separator. For example, “Mountain View, CA” and “New York, NY”. - postal_code: Postal code of profile which follows locale code. - country: Country code (ISO-3166-1 alpha-2 code) of profile, such as US, JP, GB. - job_title: Normalized job titles specified in EmploymentHistory. - company_name: Normalized company name of profiles to match on. - institution: The school name. For example, “MIT”, “University of California, Berkeley” - degree: Highest education degree in ISCED code. Each value in degree covers a specific level of education, without any expansion to upper nor lower levels of education degree. - experience_in_months: experience in months. 0 means 0 month to 1 month (exclusive). - application_date: The application date specifies application start dates. See [ApplicationDateFilter][google.cloud.talent.v4beta1.Applicatio nDateFilter] for more details. - application_outcome_notes: The application outcome reason specifies the reasons behind the outcome of the job application. See [ApplicationOutcomeNotesFilter][google.clo ud.talent.v4beta1.ApplicationOutcomeNotesFilter] for more details. - application_job_title: The application job title specifies the job applied for in the application. See [A pplicationJobFilter][google.cloud.talent.v4beta1.ApplicationJo bFilter] for more details. - hirable_status: Hirable status specifies the profile’s hirable status. - string_custom_attribute: String custom attributes. Values can be accessed via square bracket notation like string_custom_attribute[“key1”]. - numeric_custom_attribute: Numeric custom attributes. Values can be accessed via square bracket notation like numeric_custom_attribute[“key1”]. Example expressions: - count(admin1) - count(experience_in_months, [bucket(0, 12, “1 year”), bucket(12, 36, “1-3 years”), bucket(36, MAX, “3+ years”)]) - count(string_custom_attribute[“assigned_recruiter”]) - count(numeric_custom_attribute[“favorite_number”], [bucket(MIN, 0, “negative”), bucket(0, MAX, “non- negative”)])

result_set_id#

An id that uniquely identifies the result set of a [SearchProf iles][google.cloud.talent.v4beta1.ProfileService.SearchProfile s] call. The id should be retrieved from the [SearchProfilesRe sponse][google.cloud.talent.v4beta1.SearchProfilesResponse] message returned from a previous invocation of [SearchProfiles ][google.cloud.talent.v4beta1.ProfileService.SearchProfiles]. A result set is an ordered list of search results. If this field is not set, a new result set is computed based on the [p rofile_query][google.cloud.talent.v4beta1.SearchProfilesReque st.profile_query]. A new [result_set_id][google.cloud.talen t.v4beta1.SearchProfilesRequest.result_set_id] is returned as a handle to access this result set. If this field is set, the service will ignore the resource and [profile_query][goog le.cloud.talent.v4beta1.SearchProfilesRequest.profile_query] values, and simply retrieve a page of results from the corresponding result set. In this case, one and only one of [p age_token][google.cloud.talent.v4beta1.SearchProfilesRequest. page_token] or [offset][google.cloud.talent.v4beta1.SearchPro filesRequest.offset] must be set. A typical use case is to invoke [SearchProfilesRequest][google.cloud.talent.v4beta1.Sea rchProfilesRequest] without this field, then use the resulting [result_set_id][google.cloud.talent.v4beta1.SearchProfilesRe quest.result_set_id] in [SearchProfilesResponse][google.clou d.talent.v4beta1.SearchProfilesResponse] to page through the results.

This flag is used to indicate whether the service will attempt to understand synonyms and terms related to the search query or treat the query “as is” when it generates a set of results. By default this flag is set to false, thus allowing expanded results to also be returned. For example a search for “software engineer” might also return candidates who have experience in jobs similar to software engineer positions. By setting this flag to true, the service will only attempt to deliver candidates has software engineer in his/her global fields by treating “software engineer” as a keyword. It is recommended to provide a feature in the UI (such as a checkbox) to allow recruiters to set this flag to true if they intend to search for longer boolean strings.

case_sensitive_sort

Field google.cloud.talent.v4beta1.SearchProfilesRequest.case_sensitive_sort

disable_spell_check

Field google.cloud.talent.v4beta1.SearchProfilesRequest.disable_spell_check

histogram_queries

Field google.cloud.talent.v4beta1.SearchProfilesRequest.histogram_queries

offset

Field google.cloud.talent.v4beta1.SearchProfilesRequest.offset

order_by

Field google.cloud.talent.v4beta1.SearchProfilesRequest.order_by

page_size

Field google.cloud.talent.v4beta1.SearchProfilesRequest.page_size

page_token

Field google.cloud.talent.v4beta1.SearchProfilesRequest.page_token

parent

Field google.cloud.talent.v4beta1.SearchProfilesRequest.parent

profile_query

Field google.cloud.talent.v4beta1.SearchProfilesRequest.profile_query

request_metadata

Field google.cloud.talent.v4beta1.SearchProfilesRequest.request_metadata

result_set_id

Field google.cloud.talent.v4beta1.SearchProfilesRequest.result_set_id

strict_keywords_search

Field google.cloud.talent.v4beta1.SearchProfilesRequest.strict_keywords_search

class google.cloud.talent_v4beta1.types.SearchProfilesResponse#

Response of SearchProfiles method.

estimated_total_size#

An estimation of the number of profiles that match the specified query. This number isn’t guaranteed to be accurate.

spell_correction#

The spell checking result, and correction.

metadata#

Additional information for the API invocation, such as the request tracking id.

next_page_token#

A token to retrieve the next page of results. This is empty if there are no more results.

histogram_query_results#

The histogram results that match with specified [SearchProfile sRequest.histogram_queries][google.cloud.talent.v4beta1.Searc hProfilesRequest.histogram_queries].

summarized_profiles#

The profile entities that match the specified [SearchProfilesR equest][google.cloud.talent.v4beta1.SearchProfilesRequest].

result_set_id#

An id that uniquely identifies the result set of a [SearchProf iles][google.cloud.talent.v4beta1.ProfileService.SearchProfile s] call for consistent results.

estimated_total_size

Field google.cloud.talent.v4beta1.SearchProfilesResponse.estimated_total_size

histogram_query_results

Field google.cloud.talent.v4beta1.SearchProfilesResponse.histogram_query_results

metadata

Field google.cloud.talent.v4beta1.SearchProfilesResponse.metadata

next_page_token

Field google.cloud.talent.v4beta1.SearchProfilesResponse.next_page_token

result_set_id

Field google.cloud.talent.v4beta1.SearchProfilesResponse.result_set_id

spell_correction

Field google.cloud.talent.v4beta1.SearchProfilesResponse.spell_correction

summarized_profiles

Field google.cloud.talent.v4beta1.SearchProfilesResponse.summarized_profiles

class google.cloud.talent_v4beta1.types.Skill#

Resource that represents a skill of a candidate.

display_name#

Skill display name. For example, “Java”, “Python”. Number of characters allowed is 100.

last_used_date#

The last time this skill was used.

level#

Skill proficiency level which indicates how proficient the candidate is at this skill.

context#

A paragraph describes context of this skill. Number of characters allowed is 100,000.

skill_name_snippet#

Output only. Skill name snippet shows how the [display_name][ google.cloud.talent.v4beta1.Skill.display_name] is related to a search query. It’s empty if the [display_name][google.cloud .talent.v4beta1.Skill.display_name] isn’t related to the search query.

context

Field google.cloud.talent.v4beta1.Skill.context

display_name

Field google.cloud.talent.v4beta1.Skill.display_name

last_used_date

Field google.cloud.talent.v4beta1.Skill.last_used_date

level

Field google.cloud.talent.v4beta1.Skill.level

skill_name_snippet

Field google.cloud.talent.v4beta1.Skill.skill_name_snippet

class google.cloud.talent_v4beta1.types.SkillFilter#

Skill filter of the search.

skill#

Required. The skill name. For example, “java”, “j2ee”, and so on.

negated#

Whether to apply negation to the filter so profiles matching the filter are excluded.

negated

Field google.cloud.talent.v4beta1.SkillFilter.negated

skill

Field google.cloud.talent.v4beta1.SkillFilter.skill

class google.cloud.talent_v4beta1.types.SpellingCorrection#

Spell check result.

corrected#

Indicates if the query was corrected by the spell checker.

corrected_text#

Correction output consisting of the corrected keyword string.

corrected_html#

Corrected output with html tags to highlight the corrected words. Corrected words are called out with the “…” html tags. For example, the user input query is “software enginear”, where the second word, “enginear,” is incorrect. It should be “engineer”. When spelling correction is enabled, this value is “software engineer”.

corrected

Field google.cloud.talent.v4beta1.SpellingCorrection.corrected

corrected_html

Field google.cloud.talent.v4beta1.SpellingCorrection.corrected_html

corrected_text

Field google.cloud.talent.v4beta1.SpellingCorrection.corrected_text

class google.cloud.talent_v4beta1.types.Status#
code#

Field google.rpc.Status.code

details#

Field google.rpc.Status.details

message#

Field google.rpc.Status.message

class google.cloud.talent_v4beta1.types.StringValue#
value#

Field google.protobuf.StringValue.value

class google.cloud.talent_v4beta1.types.SummarizedProfile#

Profile entry with metadata inside [SearchProfilesResponse][google.cloud.talent.v4beta1.SearchProfilesResponse].

profiles#

A list of profiles that are linked by [Profile.group_id][goog le.cloud.talent.v4beta1.Profile.group_id].

summary#

A profile summary shows the profile summary and how the profile matches the search query. In profile summary, the profiles with the same [Profile.group_id][google.cloud.talent .v4beta1.Profile.group_id] are merged together. Among profiles, same education/employment records may be slightly different but they are merged into one with best efforts. For example, in one profile the school name is “UC Berkeley” and the field study is “Computer Science” and in another one the school name is “University of California at Berkeley” and the field study is “CS”. The API merges these two inputs into one and selects one value for each field. For example, the school name in summary is set to “University of California at Berkeley” and the field of study is set to “Computer Science”.

profiles

Field google.cloud.talent.v4beta1.SummarizedProfile.profiles

summary

Field google.cloud.talent.v4beta1.SummarizedProfile.summary

class google.cloud.talent_v4beta1.types.Tenant#

A Tenant resource represents a tenant in the service. A tenant is a group or entity that shares common access with specific privileges for resources like profiles. Customer may create multiple tenants to provide data isolation for different groups.

name#

Required during tenant update. The resource name for a tenant. This is generated by the service when a tenant is created. The format is “projects/{project_id}/tenants/{tenant_id}”, for example, “projects/foo/tenants/bar”.

external_id#

Required. Client side tenant identifier, used to uniquely identify the tenant. The maximum number of allowed characters is 255.

usage_type#

Indicates whether data owned by this tenant may be used to provide product improvements across other tenants. Defaults behavior is [DataUsageType.ISOLATED][google.cloud.talent.v4bet a1.Tenant.DataUsageType.ISOLATED] if it’s unset.

keyword_searchable_profile_custom_attributes#

A list of keys of filterable [Profile.custom_attributes][goog le.cloud.talent.v4beta1.Profile.custom_attributes], whose corresponding string_values are used in keyword searches. Profiles 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 must be surrounded by quotes.

external_id

Field google.cloud.talent.v4beta1.Tenant.external_id

keyword_searchable_profile_custom_attributes

Field google.cloud.talent.v4beta1.Tenant.keyword_searchable_profile_custom_attributes

name

Field google.cloud.talent.v4beta1.Tenant.name

usage_type

Field google.cloud.talent.v4beta1.Tenant.usage_type

class google.cloud.talent_v4beta1.types.TimeFilter#

Filter on create timestamp or update timestamp of profiles.

start_time#

Start timestamp, matching profiles with the start time. If this field missing, The API matches profiles with create / update timestamp before the end timestamp.

end_time#

End timestamp, matching profiles with the end time. If this field missing, The API matches profiles with create / update timestamp after the start timestamp.

time_field#

Specifies which time field to filter profiles. Defaults to [T imeField.CREATE_TIME][google.cloud.talent.v4beta1.TimeFilter. TimeField.CREATE_TIME].

end_time

Field google.cloud.talent.v4beta1.TimeFilter.end_time

start_time

Field google.cloud.talent.v4beta1.TimeFilter.start_time

time_field

Field google.cloud.talent.v4beta1.TimeFilter.time_field

class google.cloud.talent_v4beta1.types.TimeOfDay#
hours#

Field google.type.TimeOfDay.hours

minutes#

Field google.type.TimeOfDay.minutes

nanos#

Field google.type.TimeOfDay.nanos

seconds#

Field google.type.TimeOfDay.seconds

class google.cloud.talent_v4beta1.types.Timestamp#
nanos#

Field google.protobuf.Timestamp.nanos

seconds#

Field google.protobuf.Timestamp.seconds

class google.cloud.talent_v4beta1.types.TimestampRange#

Message representing a period of time between two timestamps.

start_time#

Begin of the period (inclusive).

end_time#

End of the period (exclusive).

end_time

Field google.cloud.talent.v4beta1.TimestampRange.end_time

start_time

Field google.cloud.talent.v4beta1.TimestampRange.start_time

class google.cloud.talent_v4beta1.types.UInt32Value#
value#

Field google.protobuf.UInt32Value.value

class google.cloud.talent_v4beta1.types.UInt64Value#
value#

Field google.protobuf.UInt64Value.value

class google.cloud.talent_v4beta1.types.UpdateApplicationRequest#

Request for updating a specified application.

application#

Required. The application resource to replace the current resource in the system.

update_mask#

Strongly recommended for the best service experience. If [upd ate_mask][google.cloud.talent.v4beta1.UpdateApplicationReques t.update_mask] is provided, only the specified fields in [app lication][google.cloud.talent.v4beta1.UpdateApplicationRequest .application] are updated. Otherwise all the fields are updated. A field mask to specify the application fields to be updated. Only top level fields of [Application][google.cloud.talent.v4beta1.Application] are supported.

application

Field google.cloud.talent.v4beta1.UpdateApplicationRequest.application

update_mask

Field google.cloud.talent.v4beta1.UpdateApplicationRequest.update_mask

class google.cloud.talent_v4beta1.types.UpdateCompanyRequest#

Request for updating a specified company.

company#

Required. The company resource to replace the current resource in the system.

update_mask#

Strongly recommended for the best service experience. If [upd ate_mask][google.cloud.talent.v4beta1.UpdateCompanyRequest.up date_mask] is provided, only the specified fields in [company ][google.cloud.talent.v4beta1.UpdateCompanyRequest.company] are updated. Otherwise all the fields are updated. A field mask to specify the company fields to be updated. Only top level fields of [Company][google.cloud.talent.v4beta1.Company] are supported.

company

Field google.cloud.talent.v4beta1.UpdateCompanyRequest.company

update_mask

Field google.cloud.talent.v4beta1.UpdateCompanyRequest.update_mask

class google.cloud.talent_v4beta1.types.UpdateJobRequest#

Update job request.

job#

Required. The Job to be updated.

update_mask#

Strongly recommended for the best service experience. If [upd ate_mask][google.cloud.talent.v4beta1.UpdateJobRequest.update _mask] is provided, only the specified fields in [job][google.cloud.talent.v4beta1.UpdateJobRequest.job] are updated. Otherwise all the fields are updated. A field mask to restrict the fields that are updated. Only top level fields of [Job][google.cloud.talent.v4beta1.Job] are supported.

job

Field google.cloud.talent.v4beta1.UpdateJobRequest.job

update_mask

Field google.cloud.talent.v4beta1.UpdateJobRequest.update_mask

class google.cloud.talent_v4beta1.types.UpdateProfileRequest#

Update profile request

profile#

Required. Profile to be updated.

update_mask#

A field mask to specify the profile fields to update. A full update is performed if it is unset. Valid values are: - external_id - source - source_types - uri - is_hirable - create_time - update_time - candidate_update_time - resume_update_time - resume - person_names - addresses - email_addresses - phone_numbers - personal_uris - additional_contact_info - employment_records - education_records - skills - activities - publications - patents - certifications - recruiting_notes - custom_attributes - group_id - external_system - source_note - primary_responsibilities - citizenships - work_authorizations - employee_types - language_code - qualification_summary - allowed_contact_types - preferred_contact_types - contact_availability - language_fluencies - work_preference - industry_experiences - work_environment_experiences - work_availability - security_clearances - references - assessments - interviews

profile

Field google.cloud.talent.v4beta1.UpdateProfileRequest.profile

update_mask

Field google.cloud.talent.v4beta1.UpdateProfileRequest.update_mask

class google.cloud.talent_v4beta1.types.UpdateTenantRequest#

Request for updating a specified tenant.

tenant#

Required. The tenant resource to replace the current resource in the system.

update_mask#

Strongly recommended for the best service experience. If [upd ate_mask][google.cloud.talent.v4beta1.UpdateTenantRequest.upd ate_mask] is provided, only the specified fields in [tenant][ google.cloud.talent.v4beta1.UpdateTenantRequest.tenant] are updated. Otherwise all the fields are updated. A field mask to specify the tenant fields to be updated. Only top level fields of [Tenant][google.cloud.talent.v4beta1.Tenant] are supported.

tenant

Field google.cloud.talent.v4beta1.UpdateTenantRequest.tenant

update_mask

Field google.cloud.talent.v4beta1.UpdateTenantRequest.update_mask

class google.cloud.talent_v4beta1.types.WorkExperienceFilter#

Work experience filter.

This filter is used to search for profiles with working experience length between [min_experience][google.cloud.talent.v4beta1.WorkExperienceFilter.min_experience] and [max_experience][google.cloud.talent.v4beta1.WorkExperienceFilter.max_experience].

min_experience#

The minimum duration of the work experience (inclusive).

max_experience#

The maximum duration of the work experience (exclusive).

max_experience

Field google.cloud.talent.v4beta1.WorkExperienceFilter.max_experience

min_experience

Field google.cloud.talent.v4beta1.WorkExperienceFilter.min_experience