google-cloud-talent 0.3.0 → 0.4.0

data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/company.rb

@@ -35,72 +35,54 @@ module Google
         #     example, "projects/api-test-project/companies/bar".
         # @!attribute [rw] display_name
         #   @return [String]
-        #     Required.
-        #
-        #     The display name of the company, for example, "Google, LLC".
+        #     Required. The display name of the company, for example, "Google, LLC".
         # @!attribute [rw] external_id
         #   @return [String]
-        #     Required.
-        #
-        #     Client side company identifier, used to uniquely identify the
+        #     Required. Client side company identifier, used to uniquely identify the
         #     company.
         #
         #     The maximum number of allowed characters is 255.
         # @!attribute [rw] size
         #   @return [Google::Cloud::Talent::V4beta1::CompanySize]
-        #     Optional.
-        #
-        #     The employer's company size.
+        #     Optional. The employer's company size.
         # @!attribute [rw] headquarters_address
         #   @return [String]
-        #     Optional.
-        #
-        #     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 {Google::Cloud::Talent::V4beta1::Company::DerivedInfo#headquarters_location DerivedInfo#headquarters_location}.
+        #     Optional. 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
+        #     {Google::Cloud::Talent::V4beta1::Company::DerivedInfo#headquarters_location DerivedInfo#headquarters_location}.
         # @!attribute [rw] hiring_agency
         #   @return [true, false]
-        #     Optional.
-        #
-        #     Set to true if it is the hiring agency that post jobs for other
+        #     Optional. Set to true if it is the hiring agency that post jobs for other
         #     employers.
         #
         #     Defaults to false if not provided.
         # @!attribute [rw] eeo_text
         #   @return [String]
-        #     Optional.
-        #
-        #     Equal Employment Opportunity legal disclaimer text to be
+        #     Optional. 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.
         # @!attribute [rw] website_uri
         #   @return [String]
-        #     Optional.
-        #
-        #     The URI representing the company's primary web site or home page,
+        #     Optional. 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.
         # @!attribute [rw] career_site_uri
         #   @return [String]
-        #     Optional.
-        #
-        #     The URI to employer's career site or careers page on the employer's web
-        #     site, for example, "https://careers.google.com".
+        #     Optional. The URI to employer's career site or careers page on the
+        #     employer's web site, for example, "https://careers.google.com".
         # @!attribute [rw] image_uri
         #   @return [String]
-        #     Optional.
-        #
-        #     A URI that hosts the employer's company logo.
+        #     Optional. A URI that hosts the employer's company logo.
         # @!attribute [rw] keyword_searchable_job_custom_attributes
         #   @return [Array<String>]
-        #     Optional.
-        #
-        #     A list of keys of filterable {Google::Cloud::Talent::V4beta1::Job#custom_attributes Job#custom_attributes}, whose
-        #     corresponding `string_values` are used in keyword searches. Jobs with
+        #     Optional. A list of keys of filterable
+        #     {Google::Cloud::Talent::V4beta1::Job#custom_attributes 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,
@@ -118,7 +100,8 @@ module Google
           # @!attribute [rw] headquarters_location
           #   @return [Google::Cloud::Talent::V4beta1::Location]
           #     A structured headquarters location of the company, resolved from
-          #     {Company#hq_location} if provided.
+          #     {Google::Cloud::Talent::V4beta1::Company#headquarters_address Company#headquarters_address}
+          #     if provided.
           class DerivedInfo; end
         end
       end

data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/company_service.rb

@@ -20,9 +20,7 @@ module Google
         # The Request of the CreateCompany method.
         # @!attribute [rw] parent
         #   @return [String]
-        #     Required.
-        #
-        #     Resource name of the tenant under which the company is created.
+        #     Required. Resource name of the tenant under which the company is created.
         #
         #     The format is "projects/{project_id}/tenants/{tenant_id}", for example,
         #     "projects/api-test-project/tenant/foo".
@@ -31,17 +29,13 @@ module Google
         #     example, "projects/api-test-project".
         # @!attribute [rw] company
         #   @return [Google::Cloud::Talent::V4beta1::Company]
-        #     Required.
-        #
-        #     The company to be created.
+        #     Required. The company to be created.
         class CreateCompanyRequest; end
 
         # Request for getting a company by name.
         # @!attribute [rw] name
         #   @return [String]
-        #     Required.
-        #
-        #     The resource name of the company to be retrieved.
+        #     Required. The resource name of the company to be retrieved.
         #
         #     The format is
         #     "projects/{project_id}/tenants/{tenant_id}/companies/{company_id}", for
@@ -54,27 +48,28 @@ module Google
         # Request for updating a specified company.
         # @!attribute [rw] company
         #   @return [Google::Cloud::Talent::V4beta1::Company]
-        #     Required.
-        #
-        #     The company resource to replace the current resource in the system.
+        #     Required. The company resource to replace the current resource in the
+        #     system.
         # @!attribute [rw] update_mask
         #   @return [Google::Protobuf::FieldMask]
         #     Optional but strongly recommended for the best service
         #     experience.
         #
-        #     If {Google::Cloud::Talent::V4beta1::UpdateCompanyRequest#update_mask update_mask} is provided, only the specified fields in
-        #     {Google::Cloud::Talent::V4beta1::UpdateCompanyRequest#company company} are updated. Otherwise all the fields are updated.
+        #     If
+        #     {Google::Cloud::Talent::V4beta1::UpdateCompanyRequest#update_mask update_mask}
+        #     is provided, only the specified fields in
+        #     {Google::Cloud::Talent::V4beta1::UpdateCompanyRequest#company 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 {Google::Cloud::Talent::V4beta1::Company Company} are supported.
+        #     top level fields of {Google::Cloud::Talent::V4beta1::Company Company} are
+        #     supported.
         class UpdateCompanyRequest; end
 
         # Request to delete a company.
         # @!attribute [rw] name
         #   @return [String]
-        #     Required.
-        #
-        #     The resource name of the company to be deleted.
+        #     Required. The resource name of the company to be deleted.
         #
         #     The format is
         #     "projects/{project_id}/tenants/{tenant_id}/companies/{company_id}", for
@@ -87,9 +82,7 @@ module Google
         # List companies for which the client has ACL visibility.
         # @!attribute [rw] parent
         #   @return [String]
-        #     Required.
-        #
-        #     Resource name of the tenant under which the company is created.
+        #     Required. Resource name of the tenant under which the company is created.
         #
         #     The format is "projects/{project_id}/tenants/{tenant_id}", for example,
         #     "projects/api-test-project/tenant/foo".
@@ -98,25 +91,20 @@ module Google
         #     example, "projects/api-test-project".
         # @!attribute [rw] page_token
         #   @return [String]
-        #     Optional.
-        #
-        #     The starting indicator from which to return results.
+        #     Optional. The starting indicator from which to return results.
         # @!attribute [rw] page_size
         #   @return [Integer]
-        #     Optional.
-        #
-        #     The maximum number of companies to be returned, at most 100.
+        #     Optional. The maximum number of companies to be returned, at most 100.
         #     Default is 100 if a non-positive number is provided.
         # @!attribute [rw] require_open_jobs
         #   @return [true, false]
-        #     Optional.
-        #
-        #     Set to true if the companies requested must have open jobs.
+        #     Optional. Set to true if the companies requested must have open jobs.
         #
         #     Defaults to false.
         #
-        #     If true, at most {Google::Cloud::Talent::V4beta1::ListCompaniesRequest#page_size page_size} of companies are fetched, among which
-        #     only those with open jobs are returned.
+        #     If true, at most
+        #     {Google::Cloud::Talent::V4beta1::ListCompaniesRequest#page_size page_size} of
+        #     companies are fetched, among which only those with open jobs are returned.
         class ListCompaniesRequest; end
 
         # Output only.

data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/completion_service.rb

@@ -22,9 +22,7 @@ module Google
         # Auto-complete parameters.
         # @!attribute [rw] parent
         #   @return [String]
-        #     Required.
-        #
-        #     Resource name of tenant the completion is performed within.
+        #     Required. Resource name of tenant the completion is performed within.
         #
         #     The format is "projects/{project_id}/tenants/{tenant_id}", for example,
         #     "projects/api-test-project/tenant/foo".
@@ -33,44 +31,45 @@ module Google
         #     example, "projects/api-test-project".
         # @!attribute [rw] query
         #   @return [String]
-        #     Required.
-        #
-        #     The query used to generate suggestions.
+        #     Required. The query used to generate suggestions.
         #
         #     The maximum number of allowed characters is 255.
         # @!attribute [rw] language_codes
         #   @return [Array<String>]
-        #     Optional.
-        #
-        #     The list of languages of the query. This is
+        #     Optional. 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](https://tools.ietf.org/html/bcp47).
         #
-        #     For {Google::Cloud::Talent::V4beta1::CompleteQueryRequest::CompletionType::JOB_TITLE CompletionType::JOB_TITLE} type, only open jobs with the same
-        #     {Google::Cloud::Talent::V4beta1::CompleteQueryRequest#language_codes language_codes} are returned.
-        #
-        #     For {Google::Cloud::Talent::V4beta1::CompleteQueryRequest::CompletionType::COMPANY_NAME CompletionType::COMPANY_NAME} type,
-        #     only companies having open jobs with the same {Google::Cloud::Talent::V4beta1::CompleteQueryRequest#language_codes language_codes} are
-        #     returned.
-        #
-        #     For {Google::Cloud::Talent::V4beta1::CompleteQueryRequest::CompletionType::COMBINED CompletionType::COMBINED} type, only open jobs with the same
-        #     {Google::Cloud::Talent::V4beta1::CompleteQueryRequest#language_codes language_codes} or companies having open jobs with the same
-        #     {Google::Cloud::Talent::V4beta1::CompleteQueryRequest#language_codes language_codes} are returned.
+        #     For
+        #     {Google::Cloud::Talent::V4beta1::CompleteQueryRequest::CompletionType::JOB_TITLE CompletionType::JOB_TITLE}
+        #     type, only open jobs with the same
+        #     {Google::Cloud::Talent::V4beta1::CompleteQueryRequest#language_codes language_codes}
+        #     are returned.
+        #
+        #     For
+        #     {Google::Cloud::Talent::V4beta1::CompleteQueryRequest::CompletionType::COMPANY_NAME CompletionType::COMPANY_NAME}
+        #     type, only companies having open jobs with the same
+        #     {Google::Cloud::Talent::V4beta1::CompleteQueryRequest#language_codes language_codes}
+        #     are returned.
+        #
+        #     For
+        #     {Google::Cloud::Talent::V4beta1::CompleteQueryRequest::CompletionType::COMBINED CompletionType::COMBINED}
+        #     type, only open jobs with the same
+        #     {Google::Cloud::Talent::V4beta1::CompleteQueryRequest#language_codes language_codes}
+        #     or companies having open jobs with the same
+        #     {Google::Cloud::Talent::V4beta1::CompleteQueryRequest#language_codes language_codes}
+        #     are returned.
         #
         #     The maximum number of allowed characters is 255.
         # @!attribute [rw] page_size
         #   @return [Integer]
-        #     Required.
-        #
-        #     Completion result count.
+        #     Required. Completion result count.
         #
         #     The maximum allowed page size is 10.
         # @!attribute [rw] company
         #   @return [String]
-        #     Optional.
-        #
-        #     If provided, restricts completion to specified company.
+        #     Optional. If provided, restricts completion to specified company.
         #
         #     The format is
         #     "projects/{project_id}/tenants/{tenant_id}/companies/{company_id}", for
@@ -80,14 +79,12 @@ module Google
         #     example, "projects/api-test-project/companies/bar".
         # @!attribute [rw] scope
         #   @return [Google::Cloud::Talent::V4beta1::CompleteQueryRequest::CompletionScope]
-        #     Optional.
-        #
-        #     The scope of the completion. The defaults is {Google::Cloud::Talent::V4beta1::CompleteQueryRequest::CompletionScope::PUBLIC CompletionScope::PUBLIC}.
+        #     Optional. The scope of the completion. The defaults is
+        #     {Google::Cloud::Talent::V4beta1::CompleteQueryRequest::CompletionScope::PUBLIC CompletionScope::PUBLIC}.
         # @!attribute [rw] type
         #   @return [Google::Cloud::Talent::V4beta1::CompleteQueryRequest::CompletionType]
-        #     Optional.
-        #
-        #     The completion topic. The default is {Google::Cloud::Talent::V4beta1::CompleteQueryRequest::CompletionType::COMBINED CompletionType::COMBINED}.
+        #     Optional. The completion topic. The default is
+        #     {Google::Cloud::Talent::V4beta1::CompleteQueryRequest::CompletionType::COMBINED CompletionType::COMBINED}.
         class CompleteQueryRequest
           # Enum to specify the scope of completion.
           module CompletionScope
@@ -140,7 +137,8 @@ module Google
           #     The completion topic.
           # @!attribute [rw] image_uri
           #   @return [String]
-          #     The URI of the company image for {CompletionType::COMPANY_NAME}.
+          #     The URI of the company image for
+          #     {Google::Cloud::Talent::V4beta1::CompleteQueryRequest::CompletionType::COMPANY_NAME COMPANY_NAME}.
           class CompletionResult; end
         end
       end

data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/event.rb

@@ -19,25 +19,21 @@ module Google
       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
@@ -48,28 +44,37 @@ module Google
         #     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 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 {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}/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.
@@ -107,7 +112,9 @@ module Google
             # 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
 
@@ -127,8 +134,12 @@ module Google
             # (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
@@ -163,10 +174,6 @@ module Google
             # 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
 
@@ -174,33 +181,106 @@ module Google
         # 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.
-        #
-        #     The job ID associated with this client event if there is one. Leave it
-        #     empty if the event isn't associated with a job.
+        #     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 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.