google-cloud-talent 0.10.0 → 1.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (80) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +2 -1
  3. data/AUTHENTICATION.md +51 -59
  4. data/LICENSE.md +201 -0
  5. data/MIGRATING.md +347 -0
  6. data/README.md +97 -27
  7. data/lib/{google/cloud/talent/v4beta1/doc/google/protobuf/empty.rb → google-cloud-talent.rb} +4 -14
  8. data/lib/google/cloud/talent.rb +203 -453
  9. data/lib/google/cloud/talent/version.rb +6 -2
  10. metadata +76 -111
  11. data/LICENSE +0 -201
  12. data/lib/google/cloud/talent/v4beta1.rb +0 -543
  13. data/lib/google/cloud/talent/v4beta1/application_pb.rb +0 -63
  14. data/lib/google/cloud/talent/v4beta1/application_service_client.rb +0 -527
  15. data/lib/google/cloud/talent/v4beta1/application_service_client_config.json +0 -51
  16. data/lib/google/cloud/talent/v4beta1/application_service_pb.rb +0 -55
  17. data/lib/google/cloud/talent/v4beta1/application_service_services_pb.rb +0 -55
  18. data/lib/google/cloud/talent/v4beta1/batch_pb.rb +0 -18
  19. data/lib/google/cloud/talent/v4beta1/common_pb.rb +0 -341
  20. data/lib/google/cloud/talent/v4beta1/company_pb.rb +0 -41
  21. data/lib/google/cloud/talent/v4beta1/company_service_client.rb +0 -536
  22. data/lib/google/cloud/talent/v4beta1/company_service_client_config.json +0 -51
  23. data/lib/google/cloud/talent/v4beta1/company_service_pb.rb +0 -56
  24. data/lib/google/cloud/talent/v4beta1/company_service_services_pb.rb +0 -55
  25. data/lib/google/cloud/talent/v4beta1/completion_client.rb +0 -344
  26. data/lib/google/cloud/talent/v4beta1/completion_client_config.json +0 -31
  27. data/lib/google/cloud/talent/v4beta1/completion_service_pb.rb +0 -56
  28. data/lib/google/cloud/talent/v4beta1/completion_service_services_pb.rb +0 -47
  29. data/lib/google/cloud/talent/v4beta1/credentials.rb +0 -42
  30. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/application.rb +0 -162
  31. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/application_service.rb +0 -100
  32. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/common.rb +0 -1057
  33. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/company.rb +0 -107
  34. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/company_service.rb +0 -116
  35. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/completion_service.rb +0 -130
  36. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/event.rb +0 -224
  37. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/event_service.rb +0 -36
  38. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/filters.rb +0 -763
  39. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/histogram.rb +0 -50
  40. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/job.rb +0 -331
  41. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/job_service.rb +0 -694
  42. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/profile.rb +0 -750
  43. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/profile_service.rb +0 -361
  44. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/tenant.rb +0 -70
  45. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/tenant_service.rb +0 -96
  46. data/lib/google/cloud/talent/v4beta1/doc/google/longrunning/operations.rb +0 -51
  47. data/lib/google/cloud/talent/v4beta1/doc/google/protobuf/any.rb +0 -131
  48. data/lib/google/cloud/talent/v4beta1/doc/google/protobuf/duration.rb +0 -91
  49. data/lib/google/cloud/talent/v4beta1/doc/google/protobuf/field_mask.rb +0 -222
  50. data/lib/google/cloud/talent/v4beta1/doc/google/protobuf/timestamp.rb +0 -113
  51. data/lib/google/cloud/talent/v4beta1/doc/google/protobuf/wrappers.rb +0 -34
  52. data/lib/google/cloud/talent/v4beta1/doc/google/rpc/status.rb +0 -39
  53. data/lib/google/cloud/talent/v4beta1/doc/google/type/date.rb +0 -43
  54. data/lib/google/cloud/talent/v4beta1/doc/google/type/latlng.rb +0 -31
  55. data/lib/google/cloud/talent/v4beta1/doc/google/type/money.rb +0 -36
  56. data/lib/google/cloud/talent/v4beta1/doc/google/type/postal_address.rb +0 -128
  57. data/lib/google/cloud/talent/v4beta1/doc/google/type/timeofday.rb +0 -37
  58. data/lib/google/cloud/talent/v4beta1/event_pb.rb +0 -69
  59. data/lib/google/cloud/talent/v4beta1/event_service_client.rb +0 -271
  60. data/lib/google/cloud/talent/v4beta1/event_service_client_config.json +0 -31
  61. data/lib/google/cloud/talent/v4beta1/event_service_pb.rb +0 -27
  62. data/lib/google/cloud/talent/v4beta1/event_service_services_pb.rb +0 -52
  63. data/lib/google/cloud/talent/v4beta1/filters_pb.rb +0 -187
  64. data/lib/google/cloud/talent/v4beta1/helpers.rb +0 -179
  65. data/lib/google/cloud/talent/v4beta1/histogram_pb.rb +0 -27
  66. data/lib/google/cloud/talent/v4beta1/job_pb.rb +0 -72
  67. data/lib/google/cloud/talent/v4beta1/job_service_client.rb +0 -1521
  68. data/lib/google/cloud/talent/v4beta1/job_service_client_config.json +0 -76
  69. data/lib/google/cloud/talent/v4beta1/job_service_pb.rb +0 -166
  70. data/lib/google/cloud/talent/v4beta1/job_service_services_pb.rb +0 -87
  71. data/lib/google/cloud/talent/v4beta1/profile_pb.rb +0 -213
  72. data/lib/google/cloud/talent/v4beta1/profile_service_client.rb +0 -765
  73. data/lib/google/cloud/talent/v4beta1/profile_service_client_config.json +0 -56
  74. data/lib/google/cloud/talent/v4beta1/profile_service_pb.rb +0 -91
  75. data/lib/google/cloud/talent/v4beta1/profile_service_services_pb.rb +0 -64
  76. data/lib/google/cloud/talent/v4beta1/tenant_pb.rb +0 -34
  77. data/lib/google/cloud/talent/v4beta1/tenant_service_client.rb +0 -474
  78. data/lib/google/cloud/talent/v4beta1/tenant_service_client_config.json +0 -51
  79. data/lib/google/cloud/talent/v4beta1/tenant_service_pb.rb +0 -55
  80. data/lib/google/cloud/talent/v4beta1/tenant_service_services_pb.rb +0 -54
@@ -1,107 +0,0 @@
1
- # Copyright 2020 Google LLC
2
- #
3
- # Licensed under the Apache License, Version 2.0 (the "License");
4
- # you may not use this file except in compliance with the License.
5
- # You may obtain a copy of the License at
6
- #
7
- # https://www.apache.org/licenses/LICENSE-2.0
8
- #
9
- # Unless required by applicable law or agreed to in writing, software
10
- # distributed under the License is distributed on an "AS IS" BASIS,
11
- # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
- # See the License for the specific language governing permissions and
13
- # limitations under the License.
14
-
15
-
16
- module Google
17
- module Cloud
18
- module Talent
19
- module V4beta1
20
- # A Company resource represents a company in the service. A company is the
21
- # entity that owns job postings, that is, the hiring entity responsible for
22
- # employing applicants for the job position.
23
- # @!attribute [rw] name
24
- # @return [String]
25
- # Required during company update.
26
- #
27
- # The resource name for a company. This is generated by the service when a
28
- # company is created.
29
- #
30
- # The format is
31
- # "projects/{project_id}/tenants/{tenant_id}/companies/{company_id}", for
32
- # example, "projects/foo/tenants/bar/companies/baz".
33
- #
34
- # If tenant id is unspecified, the default tenant is used. For
35
- # example, "projects/foo/companies/bar".
36
- # @!attribute [rw] display_name
37
- # @return [String]
38
- # Required. The display name of the company, for example, "Google LLC".
39
- # @!attribute [rw] external_id
40
- # @return [String]
41
- # Required. Client side company identifier, used to uniquely identify the
42
- # company.
43
- #
44
- # The maximum number of allowed characters is 255.
45
- # @!attribute [rw] size
46
- # @return [Google::Cloud::Talent::V4beta1::CompanySize]
47
- # The employer's company size.
48
- # @!attribute [rw] headquarters_address
49
- # @return [String]
50
- # The street address of the company's main headquarters, which may be
51
- # different from the job location. The service attempts
52
- # to geolocate the provided address, and populates a more specific
53
- # location wherever possible in {Google::Cloud::Talent::V4beta1::Company::DerivedInfo#headquarters_location DerivedInfo#headquarters_location}.
54
- # @!attribute [rw] hiring_agency
55
- # @return [true, false]
56
- # Set to true if it is the hiring agency that post jobs for other
57
- # employers.
58
- #
59
- # Defaults to false if not provided.
60
- # @!attribute [rw] eeo_text
61
- # @return [String]
62
- # Equal Employment Opportunity legal disclaimer text to be
63
- # associated with all jobs, and typically to be displayed in all
64
- # roles.
65
- #
66
- # The maximum number of allowed characters is 500.
67
- # @!attribute [rw] website_uri
68
- # @return [String]
69
- # The URI representing the company's primary web site or home page,
70
- # for example, "https://www.google.com".
71
- #
72
- # The maximum number of allowed characters is 255.
73
- # @!attribute [rw] career_site_uri
74
- # @return [String]
75
- # The URI to employer's career site or careers page on the employer's web
76
- # site, for example, "https://careers.google.com".
77
- # @!attribute [rw] image_uri
78
- # @return [String]
79
- # A URI that hosts the employer's company logo.
80
- # @!attribute [rw] keyword_searchable_job_custom_attributes
81
- # @return [Array<String>]
82
- # A list of keys of filterable {Google::Cloud::Talent::V4beta1::Job#custom_attributes Job#custom_attributes}, whose
83
- # corresponding `string_values` are used in keyword searches. Jobs with
84
- # `string_values` under these specified field keys are returned if any
85
- # of the values match the search keyword. Custom field values with
86
- # parenthesis, brackets and special symbols are not searchable as-is,
87
- # and those keyword queries must be surrounded by quotes.
88
- # @!attribute [rw] derived_info
89
- # @return [Google::Cloud::Talent::V4beta1::Company::DerivedInfo]
90
- # Output only. Derived details about the company.
91
- # @!attribute [rw] suspended
92
- # @return [true, false]
93
- # Output only. Indicates whether a company is flagged to be suspended from
94
- # public availability by the service when job content appears suspicious,
95
- # abusive, or spammy.
96
- class Company
97
- # Derived details about the company.
98
- # @!attribute [rw] headquarters_location
99
- # @return [Google::Cloud::Talent::V4beta1::Location]
100
- # A structured headquarters location of the company, resolved from
101
- # {Google::Cloud::Talent::V4beta1::Company#headquarters_address Company#headquarters_address} if provided.
102
- class DerivedInfo; end
103
- end
104
- end
105
- end
106
- end
107
- end
@@ -1,116 +0,0 @@
1
- # Copyright 2020 Google LLC
2
- #
3
- # Licensed under the Apache License, Version 2.0 (the "License");
4
- # you may not use this file except in compliance with the License.
5
- # You may obtain a copy of the License at
6
- #
7
- # https://www.apache.org/licenses/LICENSE-2.0
8
- #
9
- # Unless required by applicable law or agreed to in writing, software
10
- # distributed under the License is distributed on an "AS IS" BASIS,
11
- # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
- # See the License for the specific language governing permissions and
13
- # limitations under the License.
14
-
15
-
16
- module Google
17
- module Cloud
18
- module Talent
19
- module V4beta1
20
- # The Request of the CreateCompany method.
21
- # @!attribute [rw] parent
22
- # @return [String]
23
- # Required. Resource name of the tenant under which the company is created.
24
- #
25
- # The format is "projects/{project_id}/tenants/{tenant_id}", for example,
26
- # "projects/foo/tenant/bar". If tenant id is unspecified, a default tenant
27
- # is created, for example, "projects/foo".
28
- # @!attribute [rw] company
29
- # @return [Google::Cloud::Talent::V4beta1::Company]
30
- # Required. The company to be created.
31
- class CreateCompanyRequest; end
32
-
33
- # Request for getting a company by name.
34
- # @!attribute [rw] name
35
- # @return [String]
36
- # Required. The resource name of the company to be retrieved.
37
- #
38
- # The format is
39
- # "projects/{project_id}/tenants/{tenant_id}/companies/{company_id}", for
40
- # example, "projects/api-test-project/tenants/foo/companies/bar".
41
- #
42
- # If tenant id is unspecified, the default tenant is used, for
43
- # example, "projects/api-test-project/companies/bar".
44
- class GetCompanyRequest; end
45
-
46
- # Request for updating a specified company.
47
- # @!attribute [rw] company
48
- # @return [Google::Cloud::Talent::V4beta1::Company]
49
- # Required. The company resource to replace the current resource in the system.
50
- # @!attribute [rw] update_mask
51
- # @return [Google::Protobuf::FieldMask]
52
- # Strongly recommended for the best service experience.
53
- #
54
- # If {Google::Cloud::Talent::V4beta1::UpdateCompanyRequest#update_mask update_mask} is provided, only the specified fields in
55
- # {Google::Cloud::Talent::V4beta1::UpdateCompanyRequest#company company} are updated. Otherwise all the fields are updated.
56
- #
57
- # A field mask to specify the company fields to be updated. Only
58
- # top level fields of {Google::Cloud::Talent::V4beta1::Company Company} are supported.
59
- class UpdateCompanyRequest; end
60
-
61
- # Request to delete a company.
62
- # @!attribute [rw] name
63
- # @return [String]
64
- # Required. The resource name of the company to be deleted.
65
- #
66
- # The format is
67
- # "projects/{project_id}/tenants/{tenant_id}/companies/{company_id}", for
68
- # example, "projects/foo/tenants/bar/companies/baz".
69
- #
70
- # If tenant id is unspecified, the default tenant is used, for
71
- # example, "projects/foo/companies/bar".
72
- class DeleteCompanyRequest; end
73
-
74
- # List companies for which the client has ACL visibility.
75
- # @!attribute [rw] parent
76
- # @return [String]
77
- # Required. Resource name of the tenant under which the company is created.
78
- #
79
- # The format is "projects/{project_id}/tenants/{tenant_id}", for example,
80
- # "projects/foo/tenant/bar".
81
- #
82
- # If tenant id is unspecified, the default tenant will be used, for
83
- # example, "projects/foo".
84
- # @!attribute [rw] page_token
85
- # @return [String]
86
- # The starting indicator from which to return results.
87
- # @!attribute [rw] page_size
88
- # @return [Integer]
89
- # The maximum number of companies to be returned, at most 100.
90
- # Default is 100 if a non-positive number is provided.
91
- # @!attribute [rw] require_open_jobs
92
- # @return [true, false]
93
- # Set to true if the companies requested must have open jobs.
94
- #
95
- # Defaults to false.
96
- #
97
- # If true, at most {Google::Cloud::Talent::V4beta1::ListCompaniesRequest#page_size page_size} of companies are fetched, among which
98
- # only those with open jobs are returned.
99
- class ListCompaniesRequest; end
100
-
101
- # The List companies response object.
102
- # @!attribute [rw] companies
103
- # @return [Array<Google::Cloud::Talent::V4beta1::Company>]
104
- # Companies for the current client.
105
- # @!attribute [rw] next_page_token
106
- # @return [String]
107
- # A token to retrieve the next page of results.
108
- # @!attribute [rw] metadata
109
- # @return [Google::Cloud::Talent::V4beta1::ResponseMetadata]
110
- # Additional information for the API invocation, such as the request
111
- # tracking id.
112
- class ListCompaniesResponse; end
113
- end
114
- end
115
- end
116
- end
@@ -1,130 +0,0 @@
1
- # Copyright 2020 Google LLC
2
- #
3
- # Licensed under the Apache License, Version 2.0 (the "License");
4
- # you may not use this file except in compliance with the License.
5
- # You may obtain a copy of the License at
6
- #
7
- # https://www.apache.org/licenses/LICENSE-2.0
8
- #
9
- # Unless required by applicable law or agreed to in writing, software
10
- # distributed under the License is distributed on an "AS IS" BASIS,
11
- # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
- # See the License for the specific language governing permissions and
13
- # limitations under the License.
14
-
15
-
16
- module Google
17
- module Cloud
18
- module Talent
19
- module V4beta1
20
- # Auto-complete parameters.
21
- # @!attribute [rw] parent
22
- # @return [String]
23
- # Required. Resource name of tenant the completion is performed within.
24
- #
25
- # The format is "projects/{project_id}/tenants/{tenant_id}", for example,
26
- # "projects/foo/tenant/bar".
27
- #
28
- # If tenant id is unspecified, the default tenant is used, for
29
- # example, "projects/foo".
30
- # @!attribute [rw] query
31
- # @return [String]
32
- # Required. The query used to generate suggestions.
33
- #
34
- # The maximum number of allowed characters is 255.
35
- # @!attribute [rw] language_codes
36
- # @return [Array<String>]
37
- # The list of languages of the query. This is
38
- # the BCP-47 language code, such as "en-US" or "sr-Latn".
39
- # For more information, see
40
- # [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).
41
- #
42
- # The maximum number of allowed characters is 255.
43
- # @!attribute [rw] page_size
44
- # @return [Integer]
45
- # Required. Completion result count.
46
- #
47
- # The maximum allowed page size is 10.
48
- # @!attribute [rw] company
49
- # @return [String]
50
- # If provided, restricts completion to specified company.
51
- #
52
- # The format is
53
- # "projects/{project_id}/tenants/{tenant_id}/companies/{company_id}", for
54
- # example, "projects/foo/tenants/bar/companies/baz".
55
- #
56
- # If tenant id is unspecified, the default tenant is used, for
57
- # example, "projects/foo".
58
- # @!attribute [rw] scope
59
- # @return [Google::Cloud::Talent::V4beta1::CompleteQueryRequest::CompletionScope]
60
- # The scope of the completion. The defaults is {Google::Cloud::Talent::V4beta1::CompleteQueryRequest::CompletionScope::PUBLIC CompletionScope::PUBLIC}.
61
- # @!attribute [rw] type
62
- # @return [Google::Cloud::Talent::V4beta1::CompleteQueryRequest::CompletionType]
63
- # The completion topic. The default is {Google::Cloud::Talent::V4beta1::CompleteQueryRequest::CompletionType::COMBINED CompletionType::COMBINED}.
64
- class CompleteQueryRequest
65
- # Enum to specify the scope of completion.
66
- module CompletionScope
67
- # Default value.
68
- COMPLETION_SCOPE_UNSPECIFIED = 0
69
-
70
- # Suggestions are based only on the data provided by the client.
71
- TENANT = 1
72
-
73
- # Suggestions are based on all jobs data in the system that's visible to
74
- # the client
75
- PUBLIC = 2
76
- end
77
-
78
- # Enum to specify auto-completion topics.
79
- module CompletionType
80
- # Default value.
81
- COMPLETION_TYPE_UNSPECIFIED = 0
82
-
83
- # Suggest job titles for jobs autocomplete.
84
- #
85
- # For {Google::Cloud::Talent::V4beta1::CompleteQueryRequest::CompletionType::JOB_TITLE CompletionType::JOB_TITLE} type, only open jobs with the same
86
- # {Google::Cloud::Talent::V4beta1::CompleteQueryRequest#language_codes language_codes} are returned.
87
- JOB_TITLE = 1
88
-
89
- # Suggest company names for jobs autocomplete.
90
- #
91
- # For {Google::Cloud::Talent::V4beta1::CompleteQueryRequest::CompletionType::COMPANY_NAME CompletionType::COMPANY_NAME} type,
92
- # only companies having open jobs with the same {Google::Cloud::Talent::V4beta1::CompleteQueryRequest#language_codes language_codes} are
93
- # returned.
94
- COMPANY_NAME = 2
95
-
96
- # Suggest both job titles and company names for jobs autocomplete.
97
- #
98
- # For {Google::Cloud::Talent::V4beta1::CompleteQueryRequest::CompletionType::COMBINED CompletionType::COMBINED} type, only open jobs with the same
99
- # {Google::Cloud::Talent::V4beta1::CompleteQueryRequest#language_codes language_codes} or companies having open jobs with the same
100
- # {Google::Cloud::Talent::V4beta1::CompleteQueryRequest#language_codes language_codes} are returned.
101
- COMBINED = 3
102
- end
103
- end
104
-
105
- # Response of auto-complete query.
106
- # @!attribute [rw] completion_results
107
- # @return [Array<Google::Cloud::Talent::V4beta1::CompleteQueryResponse::CompletionResult>]
108
- # Results of the matching job/company candidates.
109
- # @!attribute [rw] metadata
110
- # @return [Google::Cloud::Talent::V4beta1::ResponseMetadata]
111
- # Additional information for the API invocation, such as the request
112
- # tracking id.
113
- class CompleteQueryResponse
114
- # Resource that represents completion results.
115
- # @!attribute [rw] suggestion
116
- # @return [String]
117
- # The suggestion for the query.
118
- # @!attribute [rw] type
119
- # @return [Google::Cloud::Talent::V4beta1::CompleteQueryRequest::CompletionType]
120
- # The completion topic.
121
- # @!attribute [rw] image_uri
122
- # @return [String]
123
- # The URI of the company image for
124
- # {Google::Cloud::Talent::V4beta1::CompleteQueryRequest::CompletionType::COMPANY_NAME COMPANY_NAME}.
125
- class CompletionResult; end
126
- end
127
- end
128
- end
129
- end
130
- end
@@ -1,224 +0,0 @@
1
- # Copyright 2020 Google LLC
2
- #
3
- # Licensed under the Apache License, Version 2.0 (the "License");
4
- # you may not use this file except in compliance with the License.
5
- # You may obtain a copy of the License at
6
- #
7
- # https://www.apache.org/licenses/LICENSE-2.0
8
- #
9
- # Unless required by applicable law or agreed to in writing, software
10
- # distributed under the License is distributed on an "AS IS" BASIS,
11
- # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
- # See the License for the specific language governing permissions and
13
- # limitations under the License.
14
-
15
-
16
- module Google
17
- module Cloud
18
- module Talent
19
- module V4beta1
20
- # An event issued when an end user interacts with the application that
21
- # implements Cloud Talent Solution. Providing this information improves the
22
- # quality of results for the API clients, enabling the
23
- # service to perform optimally. The number of events sent must be consistent
24
- # with other calls, such as job searches, issued to the service by the client.
25
- # @!attribute [rw] request_id
26
- # @return [String]
27
- # Strongly recommended for the best service experience.
28
- #
29
- # A unique ID generated in the API responses. It can be found in
30
- # {Google::Cloud::Talent::V4beta1::ResponseMetadata#request_id ResponseMetadata#request_id}.
31
- # @!attribute [rw] event_id
32
- # @return [String]
33
- # Required. A unique identifier, generated by the client application.
34
- # @!attribute [rw] create_time
35
- # @return [Google::Protobuf::Timestamp]
36
- # Required. The timestamp of the event.
37
- # @!attribute [rw] job_event
38
- # @return [Google::Cloud::Talent::V4beta1::JobEvent]
39
- # An event issued when a job seeker interacts with the application that
40
- # implements Cloud Talent Solution.
41
- # @!attribute [rw] profile_event
42
- # @return [Google::Cloud::Talent::V4beta1::ProfileEvent]
43
- # An event issued when a profile searcher interacts with the application
44
- # that implements Cloud Talent Solution.
45
- # @!attribute [rw] event_notes
46
- # @return [String]
47
- # Notes about the event provided by recruiters or other users, for example,
48
- # feedback on why a profile was bookmarked.
49
- class ClientEvent; end
50
-
51
- # An event issued when a job seeker interacts with the application that
52
- # implements Cloud Talent Solution.
53
- # @!attribute [rw] type
54
- # @return [Google::Cloud::Talent::V4beta1::JobEvent::JobEventType]
55
- # Required. The type of the event (see {Google::Cloud::Talent::V4beta1::JobEvent::JobEventType JobEventType}).
56
- # @!attribute [rw] jobs
57
- # @return [Array<String>]
58
- # Required. The {Google::Cloud::Talent::V4beta1::Job#name job name(s)} associated with this event.
59
- # For example, if this is an {Google::Cloud::Talent::V4beta1::JobEvent::JobEventType::IMPRESSION impression} event,
60
- # this field contains the identifiers of all jobs shown to the job seeker.
61
- # If this was a {Google::Cloud::Talent::V4beta1::JobEvent::JobEventType::VIEW view} event, this field contains the
62
- # identifier of the viewed job.
63
- #
64
- # The format is
65
- # "projects/{project_id}/tenants/{tenant_id}/jobs/{job_id}", for
66
- # example, "projects/foo/tenants/bar/jobs/baz".
67
- # @!attribute [rw] profile
68
- # @return [String]
69
- # The {Google::Cloud::Talent::V4beta1::Profile#name profile name} associated with this client event.
70
- #
71
- # The format is
72
- # "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}",
73
- # for example, "projects/foo/tenants/bar/profiles/baz".
74
- class JobEvent
75
- # An enumeration of an event attributed to the behavior of the end user,
76
- # such as a job seeker.
77
- module JobEventType
78
- # The event is unspecified by other provided values.
79
- JOB_EVENT_TYPE_UNSPECIFIED = 0
80
-
81
- # The job seeker or other entity interacting with the service has
82
- # had a job rendered in their view, such as in a list of search results in
83
- # a compressed or clipped format. This event is typically associated with
84
- # the viewing of a jobs list on a single page by a job seeker.
85
- IMPRESSION = 1
86
-
87
- # The job seeker, or other entity interacting with the service, has
88
- # viewed the details of a job, including the full description. This
89
- # event doesn't apply to the viewing a snippet of a job appearing as a
90
- # part of the job search results. Viewing a snippet is associated with an
91
- # {Google::Cloud::Talent::V4beta1::JobEvent::JobEventType::IMPRESSION impression}).
92
- VIEW = 2
93
-
94
- # The job seeker or other entity interacting with the service
95
- # performed an action to view a job and was redirected to a different
96
- # website for job.
97
- VIEW_REDIRECT = 3
98
-
99
- # The job seeker or other entity interacting with the service
100
- # began the process or demonstrated the intention of applying for a job.
101
- APPLICATION_START = 4
102
-
103
- # The job seeker or other entity interacting with the service
104
- # submitted an application for a job.
105
- APPLICATION_FINISH = 5
106
-
107
- # The job seeker or other entity interacting with the service
108
- # submitted an application for a job with a single click without
109
- # entering information. If a job seeker performs this action, send only
110
- # this event to the service. Do not also send
111
- # {Google::Cloud::Talent::V4beta1::JobEvent::JobEventType::APPLICATION_START JobEventType::APPLICATION_START} or {Google::Cloud::Talent::V4beta1::JobEvent::JobEventType::APPLICATION_FINISH JobEventType::APPLICATION_FINISH}
112
- # events.
113
- APPLICATION_QUICK_SUBMISSION = 6
114
-
115
- # The job seeker or other entity interacting with the service
116
- # performed an action to apply to a job and was redirected to a different
117
- # website to complete the application.
118
- APPLICATION_REDIRECT = 7
119
-
120
- # The job seeker or other entity interacting with the service began the
121
- # process or demonstrated the intention of applying for a job from the
122
- # search results page without viewing the details of the job posting.
123
- # If sending this event, JobEventType.VIEW event shouldn't be sent.
124
- APPLICATION_START_FROM_SEARCH = 8
125
-
126
- # The job seeker, or other entity interacting with the service, performs an
127
- # action with a single click from the search results page to apply to a job
128
- # (without viewing the details of the job posting), and is redirected
129
- # to a different website to complete the application. If a candidate
130
- # performs this action, send only this event to the service. Do not also
131
- # send {Google::Cloud::Talent::V4beta1::JobEvent::JobEventType::APPLICATION_START JobEventType::APPLICATION_START},
132
- # {Google::Cloud::Talent::V4beta1::JobEvent::JobEventType::APPLICATION_FINISH JobEventType::APPLICATION_FINISH} or {Google::Cloud::Talent::V4beta1::JobEvent::JobEventType::VIEW JobEventType::VIEW} events.
133
- APPLICATION_REDIRECT_FROM_SEARCH = 9
134
-
135
- # This event should be used when a company submits an application
136
- # on behalf of a job seeker. This event is intended for use by staffing
137
- # agencies attempting to place candidates.
138
- APPLICATION_COMPANY_SUBMIT = 10
139
-
140
- # The job seeker or other entity interacting with the service demonstrated
141
- # an interest in a job by bookmarking or saving it.
142
- BOOKMARK = 11
143
-
144
- # The job seeker or other entity interacting with the service was
145
- # sent a notification, such as an email alert or device notification,
146
- # containing one or more jobs listings generated by the service.
147
- NOTIFICATION = 12
148
-
149
- # The job seeker or other entity interacting with the service was
150
- # employed by the hiring entity (employer). Send this event
151
- # only if the job seeker was hired through an application that was
152
- # initiated by a search conducted through the Cloud Talent Solution
153
- # service.
154
- HIRED = 13
155
-
156
- # A recruiter or staffing agency submitted an application on behalf of the
157
- # candidate after interacting with the service to identify a suitable job
158
- # posting.
159
- SENT_CV = 14
160
-
161
- # The entity interacting with the service (for example, the job seeker),
162
- # was granted an initial interview by the hiring entity (employer). This
163
- # event should only be sent if the job seeker was granted an interview as
164
- # part of an application that was initiated by a search conducted through /
165
- # recommendation provided by the Cloud Talent Solution service.
166
- INTERVIEW_GRANTED = 15
167
- end
168
- end
169
-
170
- # An event issued when a profile searcher interacts with the application
171
- # that implements Cloud Talent Solution.
172
- # @!attribute [rw] type
173
- # @return [Google::Cloud::Talent::V4beta1::ProfileEvent::ProfileEventType]
174
- # Required. Type of event.
175
- # @!attribute [rw] profiles
176
- # @return [Array<String>]
177
- # Required. The {Google::Cloud::Talent::V4beta1::Profile#name profile name(s)} associated with this client event.
178
- #
179
- # The format is
180
- # "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}",
181
- # for example, "projects/foo/tenants/bar/profiles/baz".
182
- # @!attribute [rw] jobs
183
- # @return [Array<String>]
184
- # The {Google::Cloud::Talent::V4beta1::Job#name job name(s)} associated with this client event. Leave it
185
- # empty if the event isn't associated with a job.
186
- #
187
- # The format is
188
- # "projects/{project_id}/tenants/{tenant_id}/jobs/{job_id}", for
189
- # example, "projects/foo/tenants/bar/jobs/baz".
190
- class ProfileEvent
191
- # The enum represents types of client events for a candidate profile.
192
- module ProfileEventType
193
- # Default value.
194
- PROFILE_EVENT_TYPE_UNSPECIFIED = 0
195
-
196
- # Send this event when a {Google::Cloud::Talent::V4beta1::ProfileEvent#profiles ProfileEvent#profiles} was sent as a part of
197
- # a result set for a CTS API call and was rendered in the end user's UI
198
- # (that is, the {Google::Cloud::Talent::V4beta1::ProfileEvent#recruiter ProfileEvent#recruiter}).
199
- IMPRESSION = 1
200
-
201
- # The VIEW event records the action of a candidate's profile being
202
- # viewed by an end user. This is critical to tracking product metrics and
203
- # should be sent for every profile VIEW that happens in your system,
204
- # whether the event is associated with an API call (for example, a
205
- # recruiter making a request for a result set and clicking on a profile)
206
- # or not (a recruiter using the system to view profile details without
207
- # making a request).
208
- #
209
- # For a VIEW events associated with API calls, the
210
- # {Google::Cloud::Talent::V4beta1::ClientEvent#request_id ClientEvent#request_id} should be populated. If the VIEW is not
211
- # associated with an API call, {Google::Cloud::Talent::V4beta1::ClientEvent#request_id request_id} should
212
- # not be populated.
213
- #
214
- # This event requires a valid recruiter and one valid ID in profiles.
215
- VIEW = 2
216
-
217
- # The profile is bookmarked.
218
- BOOKMARK = 3
219
- end
220
- end
221
- end
222
- end
223
- end
224
- end