lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/event.rb in google-cloud-talent-0.3.0 vs lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/event.rb in google-cloud-talent-0.4.0

- old
+ new

@@ -17,61 +17,66 @@ module Cloud module Talent module V4beta1 # 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 + # 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. # @!attribute [rw] request_id # @return [String] - # Required. + # Optional but highly recommended. # # A unique ID generated in the API responses. It can be found in # {Google::Cloud::Talent::V4beta1::ResponseMetadata#request_id ResponseMetadata#request_id}. # @!attribute [rw] event_id # @return [String] - # Required. - # - # A unique identifier, generated by the client application. + # Required. A unique identifier, generated by the client application. # @!attribute [rw] create_time # @return [Google::Protobuf::Timestamp] - # Required. - # - # The timestamp of the event. + # Required. The timestamp of the event. # @!attribute [rw] job_event # @return [Google::Cloud::Talent::V4beta1::JobEvent] # An event issued when a job seeker interacts with the application that # implements Cloud Talent Solution. # @!attribute [rw] profile_event # @return [Google::Cloud::Talent::V4beta1::ProfileEvent] # An event issued when a profile searcher interacts with the application # that implements Cloud Talent Solution. # @!attribute [rw] event_notes # @return [String] - # Optional. - # - # Notes about the event provided by recruiters or other users, for example, - # feedback on why a profile was bookmarked. + # Optional. Notes about the event provided by recruiters or other users, for + # example, feedback on why a profile was bookmarked. class ClientEvent; end # An event issued when a job seeker interacts with the application that # implements Cloud Talent Solution. # @!attribute [rw] type # @return [Google::Cloud::Talent::V4beta1::JobEvent::JobEventType] - # Required. - # - # The type of the event (see {Google::Cloud::Talent::V4beta1::JobEvent::JobEventType JobEventType}). + # Required. The type of the event (see + # {Google::Cloud::Talent::V4beta1::JobEvent::JobEventType JobEventType}). # @!attribute [rw] jobs # @return [Array<String>] - # Required. + # Required. The {Google::Cloud::Talent::V4beta1::Job#name job name(s)} + # associated with this event. For example, if this is an + # {Google::Cloud::Talent::V4beta1::JobEvent::JobEventType::IMPRESSION impression} + # event, this field contains the identifiers of all jobs shown to the job + # seeker. If this was a + # {Google::Cloud::Talent::V4beta1::JobEvent::JobEventType::VIEW view} event, this + # field contains the identifier of the viewed job. # - # The {Google::Cloud::Talent::V4beta1::Job#name job name(s)} associated with this event. - # For example, if this is an {Google::Cloud::Talent::V4beta1::JobEvent::JobEventType::IMPRESSION impression} event, - # this field contains the identifiers of all jobs shown to the job seeker. - # If this was a {Google::Cloud::Talent::V4beta1::JobEvent::JobEventType::VIEW 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/api-test-project/tenants/foo/jobs/1234". + # @!attribute [rw] profile + # @return [String] + # Optional. The {Google::Cloud::Talent::V4beta1::Profile#name profile name} + # associated with this client event. + # + # The format is + # "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}", + # for example, "projects/api-test-project/tenants/foo/profiles/bar". class JobEvent # An enumeration of an event attributed to the behavior of the end user, # such as a job seeker. module JobEventType # The event is unspecified by other provided values. @@ -105,11 +110,13 @@ # 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 - # {Google::Cloud::Talent::V4beta1::JobEvent::JobEventType::APPLICATION_START JobEventType::APPLICATION_START} or {Google::Cloud::Talent::V4beta1::JobEvent::JobEventType::APPLICATION_FINISH JobEventType::APPLICATION_FINISH} + # {Google::Cloud::Talent::V4beta1::JobEvent::JobEventType::APPLICATION_START JobEventType::APPLICATION_START} + # or + # {Google::Cloud::Talent::V4beta1::JobEvent::JobEventType::APPLICATION_FINISH JobEventType::APPLICATION_FINISH} # events. APPLICATION_QUICK_SUBMISSION = 6 # The job seeker or other entity interacting with the service # performed an action to apply to a job and was redirected to a different @@ -125,12 +132,16 @@ # The job seeker, or other entity interacting with the service, performs an # action with a single click from the search results page to apply to a job # (without viewing the details of the job posting), and is redirected # to a different website to complete the application. If a candidate # performs this action, send only this event to the service. Do not also - # send {Google::Cloud::Talent::V4beta1::JobEvent::JobEventType::APPLICATION_START JobEventType::APPLICATION_START}, - # {Google::Cloud::Talent::V4beta1::JobEvent::JobEventType::APPLICATION_FINISH JobEventType::APPLICATION_FINISH} or {Google::Cloud::Talent::V4beta1::JobEvent::JobEventType::VIEW JobEventType::VIEW} events. + # send + # {Google::Cloud::Talent::V4beta1::JobEvent::JobEventType::APPLICATION_START JobEventType::APPLICATION_START}, + # {Google::Cloud::Talent::V4beta1::JobEvent::JobEventType::APPLICATION_FINISH JobEventType::APPLICATION_FINISH} + # or + # {Google::Cloud::Talent::V4beta1::JobEvent::JobEventType::VIEW JobEventType::VIEW} + # events. APPLICATION_REDIRECT_FROM_SEARCH = 9 # 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. @@ -161,47 +172,116 @@ # 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. INTERVIEW_GRANTED = 15 - - # The job seeker or other entity interacting with the service showed - # no interest in the job. - NOT_INTERESTED = 16 end end # An event issued when a profile searcher interacts with the application # that implements Cloud Talent Solution. # @!attribute [rw] type # @return [Google::Cloud::Talent::V4beta1::ProfileEvent::ProfileEventType] - # Required. - # - # Type of event. + # Required. Type of event. # @!attribute [rw] profiles # @return [Array<String>] - # Required. + # Required. The {Google::Cloud::Talent::V4beta1::Profile#name profile name(s)} + # associated with this client event. # - # The {Google::Cloud::Talent::V4beta1::Profile#name profile name(s)} associated with this client event. + # The format is + # "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}", + # for example, "projects/api-test-project/tenants/foo/profiles/bar". # @!attribute [rw] jobs # @return [Array<String>] - # Optional. + # Optional. The {Google::Cloud::Talent::V4beta1::Job#name job name(s)} + # associated with this client event. Leave it empty if the event isn't + # associated with a job. # - # The job ID associated with this client event if there is one. Leave it - # empty if the event isn't associated with a job. - # - # The job ID should be consistent with the - # {JobApplication#job#requisition_id} in the profile. + # The format is + # "projects/{project_id}/tenants/{tenant_id}/jobs/{job_id}", for + # example, "projects/api-test-project/tenants/foo/jobs/1234". class ProfileEvent # The enum represents types of client events for a candidate profile. module ProfileEventType # Default value. PROFILE_EVENT_TYPE_UNSPECIFIED = 0 - # The profile is displayed. + # Send this event when a + # {Google::Cloud::Talent::V4beta1::ProfileEvent#profiles ProfileEvent#profiles} + # meets all of the following criteria: + # * Was sent as a part of a result set for a CTS API call. + # * Was rendered in the end user's UI (that is, the + # {Google::Cloud::Talent::V4beta1::ProfileEvent#recruiter ProfileEvent#recruiter}). + # * That UI rendering was displayed in the end user's viewport for >=3 + # seconds. + # + # In other words, send this event when the end user of the CTS service + # actually saw a resulting profile in their viewport. + # + # To understand how to use this event, consider an example: + # + # * The customer's UI for interacting with CTS + # result sets is accessed by the end user through a web browser. + # * The UI calls for a page size of 15 candidates (that is, 15 candidates + # are rendered on each page of results). + # * However, the UI design calls for only 5 candidates to be shown at any + # given time in the viewport (that is, the end user can only see 5 results + # at any given time and needs to scroll up or down to view all 15 results). + # + # To render each page of results, the customer will send a + # request to CTS with a page size = 15. + # + # * User loads page #1 of results. + # * User scrolls down to expose results #1 - #5 and dwells on this view for + # 30 seconds. + # * Send an IMPRESSION event for result 1, 2, 3, 4, 5. + # * User scrolls down a bit, exposing results #2 - #6 in the viewport and + # dwells on this view for 5 minutes. + # * Send an IMPRESSION event for result 6. + # * User scrolls to the bottom of the page, with results #7 - #15 shown in + # the viewport for ~5 seconds each. + # * Specifically, NO IMPRESSION events are sent for result 7, 8, 9, 10, 11, + # 12, 13, 14, 15. + # * User clicks to the next page and loads page #2 of results. + # * Within 2 seconds, user scrolls to expose results #20 - #24 in the + # viewport and dwells on this view for 20 mins. + # * Send an IMPRESSION event for result 20, 21, 22, 23, 24 + # * User closes their browser window. IMPRESSION = 1 - # The profile is viewed. + # The VIEW event allows CTS to understand if a candidate's profile was + # viewed by an end user (that is, recruiter) of the system for >=3 seconds. + # This is critical to tracking product metrics and should be sent for every + # profile VIEW that happens in the customer's system. + # + # VIEW events should be sent whether an end user views a candidate's + # profile as a result of seeing that profile in the result set of a + # CTS API request or whether the end user + # views the profile for some other reason (that is, clicks to the + # candidate's profile in the ATS, and so on). + # + # For a VIEW that happens as a result of seeing the profile in + # a CTS API request's result set, the + # {Google::Cloud::Talent::V4beta1::ClientEvent#request_id ClientEvent#request_id} + # should be populated. If the VIEW happens for some other reason, the + # [requestId] should not be populated. + # + # This event requires a valid recruiter and one valid ID in profiles. + # + # To understand how to use this event, consider 2 examples in which a VIEW + # event should be sent: + # * End user makes a request to the CTS API for a result set. + # * Results for the request are shown to the end user. + # * End user clicks on one of the candidates that are shown as part of the + # results. + # * A VIEW event with the + # {Google::Cloud::Talent::V4beta1::ClientEvent#request_id ClientEvent#request_id} + # of the API call in the first step of this example is sent. + # + # * End user browses to a candidate's profile in the ATS. + # * A VIEW event without a + # {Google::Cloud::Talent::V4beta1::ClientEvent#request_id ClientEvent#request_id} + # is sent. VIEW = 2 # The profile is bookmarked. BOOKMARK = 3 end \ No newline at end of file