Method: projects.tenants.profiles.patch

Updates the specified profile and returns the updated result.

HTTP request

PATCH https://jobs.googleapis.com/v4beta1/{profile.name=projects/*/tenants/*/profiles/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
profile.name

string

Required during profile update.

Resource name assigned to a profile by the API.

The format is "projects/{project_id}/tenants/{tenantId}/profiles/{profile_id}", for example, "projects/api-test-project/tenants/foo/profiles/bar".

Request body

The request body contains data with the following structure:

JSON representation
{
  "profile": {
    "name": string,
    "externalId": string,
    "source": string,
    "uri": string,
    "groupId": string,
    "isHirable": boolean,
    "createTime": string,
    "updateTime": string,
    "resume": {
      object (Resume)
    },
    "personNames": [
      {

        // Union field person_name can be only one of the following:

        // End of list of possible types for union field person_name.
      }
    ],
    "addresses": [
      {

        // Union field address can be only one of the following:

        // End of list of possible types for union field address.
      }
    ],
    "emailAddresses": [
      {
        object (Email)
      }
    ],
    "phoneNumbers": [
      {
        object (Phone)
      }
    ],
    "personalUris": [
      {
        object (PersonalUri)
      }
    ],
    "additionalContactInfo": [
      {
        object (AdditionalContactInfo)
      }
    ],
    "employmentRecords": [
      {
        object (EmploymentRecord)
      }
    ],
    "educationRecords": [
      {

        // Union field degree can be only one of the following:

        // End of list of possible types for union field degree.
      }
    ],
    "skills": [
      {
        object (Skill)
      }
    ],
    "activities": [
      {
        object (Activity)
      }
    ],
    "publications": [
      {
        object (Publication)
      }
    ],
    "patents": [
      {
        object (Patent)
      }
    ],
    "certifications": [
      {
        object (Certification)
      }
    ],
    "applications": [
      string
    ],
    "assignments": [
      string
    ],
    "featureControlFlags": [
      string
    ],
    "customAttributes": {
      object
    },
    "processed": boolean,
    "keywordSnippet": string,
    "derivedAddresses": [
      {
        object (Location)
      }
    ]
  },
  "updateMask": string
}
Fields
profile.externalId

string

Optional. Profile's id in client system if available. This value is not required to be unique to each profile. However, providing unique values makes it easier to specify individual profiles when filing support tickets.

The maximum number of bytes allowed is 100.

profile.source

string

Optional. 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.

profile.uri

string

Optional. The URI set by clients that links to this profile's client-side copy.

The maximum number of bytes allowed is 4000.

profile.groupId

string

Optional. 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 groupId, and assign it when the second profile is created, indicating these two profiles are referring to the same candidate.

profile.isHirable

boolean

Optional. Indicates the hirable status of the candidate.

profile.createTime

string (Timestamp format)

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

profile.updateTime

string (Timestamp format)

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

profile.resume

object (Resume)

Optional. The resume representing this profile.

profile.personNames[]

object (PersonName)

Optional. The names of the candidate this profile references.

Currently only one person name is supported.

profile.addresses[]

object (Address)

Optional. 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 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 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 is PERSONAL and Address.current is true. 2. Address.usage is PERSONAL and Address.current is false or not set. 3. Address.usage is CONTACT_INFO_USAGE_UNSPECIFIED and Address.current is true. 4. Address.usage is CONTACT_INFO_USAGE_UNSPECIFIED and Address.current is false or not set.

profile.emailAddresses[]

object (Email)

Optional. The candidate's email addresses.

profile.phoneNumbers[]

object (Phone)

Optional. The candidate's phone number(s).

profile.personalUris[]

object (PersonalUri)

Optional. The candidate's personal URIs.

profile.additionalContactInfo[]

object (AdditionalContactInfo)

Optional. Available contact information besides addresses, emailAddresses, phoneNumbers and personalUris. For example, Hang-out, Skype.

profile.employmentRecords[]

object (EmploymentRecord)

Optional. 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 for the current employment if possible. If not, it's inferred from user inputs.

The limitation for max number of employment records is 100.

profile.educationRecords[]

object (EducationRecord)

Optional. 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 for the current education if possible. If not, it's inferred from user inputs.

The limitation for max number of education records is 100.

profile.skills[]

object (Skill)

Optional. 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.

profile.activities[]

object (Activity)

Optional. The individual or collaborative activities which the candidate has participated in, for example, open-source projects, class assignments that aren't listed in employmentRecords.

The limitation for max number of activities is 50.

profile.publications[]

object (Publication)

Optional. The publications published by the candidate.

The limitation for max number of publications is 50.

profile.patents[]

object (Patent)

Optional. The patents acquired by the candidate.

profile.certifications[]

object (Certification)

Optional. The certifications acquired by the candidate.

profile.applications[]

string

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

profile.assignments[]

string

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

profile.customAttributes

map (key: string, value: object (CustomAttribute))

Optional. 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 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.

profile.processed

boolean

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.

profile.keywordSnippet

string

Output only. Keyword snippet shows how the search result is related to a search query. This is only returned in SearchProfilesResponse.

profile.derivedAddresses[]

object (Location)

Output only. Derived locations of the profile, resolved from Profile.addresses.

derivedAddresses are exactly matched to Profile.addresses in the same order.

updateMask

string (FieldMask format)

Optional. A field mask to specify the profile fields to update.

A full update is performed if it is unset.

Valid values are:

  • externalId
  • source
  • uri
  • isHirable
  • createTime
  • updateTime
  • resume
  • personNames
  • addresses
  • emailAddresses
  • phoneNumbers
  • personalUris
  • additionalContactInfo
  • employmentRecords
  • educationRecords
  • skills
  • activities
  • publications
  • patents
  • certifications
  • recruitingNotes
  • customAttributes
  • groupId
  • externalSystem
  • sourceNote
  • primaryResponsibilities
  • citizenships
  • workAuthorizations
  • employeeTypes
  • languageCode
  • qualificationSummary
  • allowedContactTypes
  • preferredContactTypes
  • contactAvailability
  • languageFluencies
  • workPreference
  • industryExperiences
  • workEnvironmentExperiences
  • workAvailability
  • securityClearances
  • references
  • assessments
  • interviews

A comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Response body

If successful, the response body contains an instance of Profile.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/jobs
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

Try it!

Var denne siden nyttig? Si fra hva du synes:

Send tilbakemelding om ...

Job search documentation
Trenger du hjelp? Gå til brukerstøttesiden vår.