Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -249,8 +249,8 @@ def create_application(
If a dict is provided, it must be of the same form as the protobuf
message :class:`~google.cloud.talent_v4beta1.types.Application`
retry (Optional[google.api_core.retry.Retry]): A retry object used
to retry requests. If ``None`` is specified, requests will not
be retried.
to retry requests. If ``None`` is specified, requests will
be retried using a default configuration.
timeout (Optional[float]): The amount of time, in seconds, to wait
for the request to complete. Note that if ``retry`` is
specified, the timeout applies to each individual attempt.
Expand Down Expand Up @@ -325,8 +325,8 @@ def get_application(
for example,
"projects/test-project/tenants/test-tenant/profiles/test-profile/applications/test-application".
retry (Optional[google.api_core.retry.Retry]): A retry object used
to retry requests. If ``None`` is specified, requests will not
be retried.
to retry requests. If ``None`` is specified, requests will
be retried using a default configuration.
timeout (Optional[float]): The amount of time, in seconds, to wait
for the request to complete. Note that if ``retry`` is
specified, the timeout applies to each individual attempt.
Expand Down Expand Up @@ -410,8 +410,8 @@ def update_application(
If a dict is provided, it must be of the same form as the protobuf
message :class:`~google.cloud.talent_v4beta1.types.FieldMask`
retry (Optional[google.api_core.retry.Retry]): A retry object used
to retry requests. If ``None`` is specified, requests will not
be retried.
to retry requests. If ``None`` is specified, requests will
be retried using a default configuration.
timeout (Optional[float]): The amount of time, in seconds, to wait
for the request to complete. Note that if ``retry`` is
specified, the timeout applies to each individual attempt.
Expand Down Expand Up @@ -486,8 +486,8 @@ def delete_application(
for example,
"projects/test-project/tenants/test-tenant/profiles/test-profile/applications/test-application".
retry (Optional[google.api_core.retry.Retry]): A retry object used
to retry requests. If ``None`` is specified, requests will not
be retried.
to retry requests. If ``None`` is specified, requests will
be retried using a default configuration.
timeout (Optional[float]): The amount of time, in seconds, to wait
for the request to complete. Note that if ``retry`` is
specified, the timeout applies to each individual attempt.
Expand Down Expand Up @@ -576,8 +576,8 @@ def list_applications(
streaming is performed per-page, this determines the maximum number
of resources in a page.
retry (Optional[google.api_core.retry.Retry]): A retry object used
to retry requests. If ``None`` is specified, requests will not
be retried.
to retry requests. If ``None`` is specified, requests will
be retried using a default configuration.
timeout (Optional[float]): The amount of time, in seconds, to wait
for the request to complete. Note that if ``retry`` is
specified, the timeout applies to each individual attempt.
Expand Down
20 changes: 10 additions & 10 deletions talent/google/cloud/talent_v4beta1/gapic/company_service_client.py
Original file line number Diff line number Diff line change
Expand Up @@ -258,8 +258,8 @@ def create_company(
If a dict is provided, it must be of the same form as the protobuf
message :class:`~google.cloud.talent_v4beta1.types.Company`
retry (Optional[google.api_core.retry.Retry]): A retry object used
to retry requests. If ``None`` is specified, requests will not
be retried.
to retry requests. If ``None`` is specified, requests will
be retried using a default configuration.
timeout (Optional[float]): The amount of time, in seconds, to wait
for the request to complete. Note that if ``retry`` is
specified, the timeout applies to each individual attempt.
Expand Down Expand Up @@ -336,8 +336,8 @@ def get_company(
Tenant id is optional and the default tenant is used if unspecified, for
example, "projects/api-test-project/companies/bar".
retry (Optional[google.api_core.retry.Retry]): A retry object used
to retry requests. If ``None`` is specified, requests will not
be retried.
to retry requests. If ``None`` is specified, requests will
be retried using a default configuration.
timeout (Optional[float]): The amount of time, in seconds, to wait
for the request to complete. Note that if ``retry`` is
specified, the timeout applies to each individual attempt.
Expand Down Expand Up @@ -421,8 +421,8 @@ def update_company(
If a dict is provided, it must be of the same form as the protobuf
message :class:`~google.cloud.talent_v4beta1.types.FieldMask`
retry (Optional[google.api_core.retry.Retry]): A retry object used
to retry requests. If ``None`` is specified, requests will not
be retried.
to retry requests. If ``None`` is specified, requests will
be retried using a default configuration.
timeout (Optional[float]): The amount of time, in seconds, to wait
for the request to complete. Note that if ``retry`` is
specified, the timeout applies to each individual attempt.
Expand Down Expand Up @@ -500,8 +500,8 @@ def delete_company(
Tenant id is optional and the default tenant is used if unspecified, for
example, "projects/api-test-project/companies/bar".
retry (Optional[google.api_core.retry.Retry]): A retry object used
to retry requests. If ``None`` is specified, requests will not
be retried.
to retry requests. If ``None`` is specified, requests will
be retried using a default configuration.
timeout (Optional[float]): The amount of time, in seconds, to wait
for the request to complete. Note that if ``retry`` is
specified, the timeout applies to each individual attempt.
Expand Down Expand Up @@ -598,8 +598,8 @@ def list_companies(
If true, at most ``page_size`` of companies are fetched, among which
only those with open jobs are returned.
retry (Optional[google.api_core.retry.Retry]): A retry object used
to retry requests. If ``None`` is specified, requests will not
be retried.
to retry requests. If ``None`` is specified, requests will
be retried using a default configuration.
timeout (Optional[float]): The amount of time, in seconds, to wait
for the request to complete. Note that if ``retry`` is
specified, the timeout applies to each individual attempt.
Expand Down
4 changes: 2 additions & 2 deletions talent/google/cloud/talent_v4beta1/gapic/completion_client.py
Original file line number Diff line number Diff line change
Expand Up @@ -295,8 +295,8 @@ def complete_query(
type_ (~google.cloud.talent_v4beta1.types.CompletionType): Optional. The completion topic. The default is
``CompletionType.COMBINED``.
retry (Optional[google.api_core.retry.Retry]): A retry object used
to retry requests. If ``None`` is specified, requests will not
be retried.
to retry requests. If ``None`` is specified, requests will
be retried using a default configuration.
timeout (Optional[float]): The amount of time, in seconds, to wait
for the request to complete. Note that if ``retry`` is
specified, the timeout applies to each individual attempt.
Expand Down
87 changes: 13 additions & 74 deletions talent/google/cloud/talent_v4beta1/gapic/enums.py
Original file line number Diff line number Diff line change
Expand Up @@ -925,82 +925,21 @@ class ProfileEventType(enum.IntEnum):

Attributes:
PROFILE_EVENT_TYPE_UNSPECIFIED (int): Default value.
IMPRESSION (int): Send this event when a ``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
``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.
VIEW (int): 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 ``ClientEvent.request_id`` should be
populated. If the VIEW happens for some other reason, the ``request_id``
should not be populated.
IMPRESSION (int): Send this event when a ``ProfileEvent.profiles`` was sent as a part of a
result set for a CTS API call and was rendered in the end user's UI
(that is, the ``ProfileEvent.recruiter``).
VIEW (int): The VIEW event records the action of a candidate's profile being viewed
by an end user. This is critical to tracking product metrics and should
be sent for every profile VIEW that happens in your system, whether the
event is associated with an API call (for example, a recruiter making a
request for a result set and clicking on a profile) or not (a recruiter
using the system to view profile details without making a request).

For a VIEW events associated with API calls, the
``ClientEvent.request_id`` should be populated. If the VIEW is not
associated with an API call, ``request_id`` 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 ``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 ``ClientEvent.request_id`` is sent.
BOOKMARK (int): The profile is bookmarked.
"""

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -250,8 +250,8 @@ def create_client_event(
If a dict is provided, it must be of the same form as the protobuf
message :class:`~google.cloud.talent_v4beta1.types.ClientEvent`
retry (Optional[google.api_core.retry.Retry]): A retry object used
to retry requests. If ``None`` is specified, requests will not
be retried.
to retry requests. If ``None`` is specified, requests will
be retried using a default configuration.
timeout (Optional[float]): The amount of time, in seconds, to wait
for the request to complete. Note that if ``retry`` is
specified, the timeout applies to each individual attempt.
Expand Down
Loading