Method: projects.clientEvents.create

Stay organized with collections Save and categorize content based on your preferences.

Report events issued when end user interacts with customer's application that uses Cloud Talent Solution. You may inspect the created events in self service tools. Learn more about self service tools.

HTTP request

POST https://jobs.googleapis.com/v3/{parent=projects/*}/clientEvents

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Parent project name.

Request body

The request body contains data with the following structure:

JSON representation
{
  "clientEvent": {
    object (ClientEvent)
  }
}
Fields
clientEvent

object (ClientEvent)

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

Response body

If successful, the response body contains data with the following structure:

An event issued when an end user interacts with the application that implements Cloud Talent Solution. Providing this information improves the quality of search and recommendation 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.

JSON representation
{
  "requestId": string,
  "eventId": string,
  "parentEventId": string,
  "createTime": string,
  "extraInfo": {
    string: string,
    ...
  },
  "jobEvent": {
    object (JobEvent)
  }
}
Fields
requestId

string

Required. A unique ID generated in the API responses. It can be found in ResponseMetadata.request_id.

eventId

string

Required. A unique identifier, generated by the client application. This eventId is used to establish the relationship between different events (see parentEventId).

parentEventId

string

Optional. The eventId of an event that resulted in the current event. For example, a [Job view][JobEventType.VIEW] event usually follows a parent [impression][JobEventType.IMPRESSION] event: A job seeker first does a search where a list of jobs appears ([impression][JobEventType.IMPRESSION]). The job seeker then selects a result and views the description of a particular job ([Job view][JobEventType.VIEW]).

createTime

string (Timestamp format)

Required. The timestamp of the event.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

extraInfo

map (key: string, value: string)

Optional. Extra information about this event. Used for storing information with no matching field in [event][google.cloud.talent.v3.ClientEvent.event] payload, for example, user application specific context or details.

At most 20 keys are supported. The maximum total size of all keys and values is 2 KB.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

jobEvent

object (JobEvent)

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

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.

JobEvent

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

JSON representation
{
  "type": enum (JobEventType),
  "jobs": [
    string
  ]
}
Fields
type

enum (JobEventType)

Required. The type of the event (see JobEventType).

jobs[]

string

Required. The job name(s) associated with this event. For example, if this is an impression event, this field contains the identifiers of all jobs shown to the job seeker. If this was a view event, this field contains the identifier of the viewed job.

JobEventType

An enumeration of an event attributed to the behavior of the end user, such as a job seeker.

Enums
JOB_EVENT_TYPE_UNSPECIFIED The event is unspecified by other provided values.
IMPRESSION The job seeker or other entity interacting with the service has had a job rendered in their view, such as in a list of search results in a compressed or clipped format. This event is typically associated with the viewing of a jobs list on a single page by a job seeker.
VIEW The job seeker, or other entity interacting with the service, has viewed the details of a job, including the full description. This event doesn't apply to the viewing a snippet of a job appearing as a part of the job search results. Viewing a snippet is associated with an impression).
VIEW_REDIRECT The job seeker or other entity interacting with the service performed an action to view a job and was redirected to a different website for job.
APPLICATION_START The job seeker or other entity interacting with the service began the process or demonstrated the intention of applying for a job.
APPLICATION_FINISH The job seeker or other entity interacting with the service submitted an application for a job.
APPLICATION_QUICK_SUBMISSION The job seeker or other entity interacting with the service submitted an application for a job with a single click without entering information. If a job seeker performs this action, send only this event to the service. Do not also send JobEventType.APPLICATION_START or JobEventType.APPLICATION_FINISH events.
APPLICATION_REDIRECT The job seeker or other entity interacting with the service performed an action to apply to a job and was redirected to a different website to complete the application.
APPLICATION_COMPANY_SUBMIT This event should be used when a company submits an application on behalf of a job seeker. This event is intended for use by staffing agencies attempting to place candidates.
BOOKMARK The job seeker or other entity interacting with the service demonstrated an interest in a job by bookmarking or saving it.
NOTIFICATION The job seeker or other entity interacting with the service was sent a notification, such as an email alert or device notification, containing one or more jobs listings generated by the service.
HIRED The job seeker or other entity interacting with the service was employed by the hiring entity (employer). Send this event only if the job seeker was hired through an application that was initiated by a search conducted through the Cloud Talent Solution service.
SENT_CV A recruiter or staffing agency submitted an application on behalf of the candidate after interacting with the service to identify a suitable job posting.
INTERVIEW_GRANTED The entity interacting with the service (for example, the job seeker), was granted an initial interview by the hiring entity (employer). This event should only be sent if the job seeker was granted an interview as part of an application that was initiated by a search conducted through / recommendation provided by the Cloud Talent Solution service.
NOT_INTERESTED The job seeker or other entity interacting with the service showed no interest in the job.