blob: 5eff35240953673447288dedab3c77e2a0ff93e2 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="jobs_v3.html">Cloud Talent Solution API</a> . <a href="jobs_v3.projects.html">projects</a> . <a href="jobs_v3.projects.clientEvents.html">clientEvents</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070078 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070081 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070082<p class="firstline">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](https://console.cloud.google.com/talent-solution/overview). [Learn more](https://cloud.google.com/talent-solution/docs/management-tools) about self service tools.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070083<h3>Method Details</h3>
84<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070085 <code class="details" id="close">close()</code>
86 <pre>Close httplib2 connections.</pre>
87</div>
88
89<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -070090 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070091 <pre>Report events issued when end user interacts with customer&#x27;s application that uses Cloud Talent Solution. You may inspect the created events in [self service tools](https://console.cloud.google.com/talent-solution/overview). [Learn more](https://cloud.google.com/talent-solution/docs/management-tools) about self service tools.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070092
93Args:
94 parent: string, Parent project name. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -070095 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070096 The object takes the form of:
97
98{ # The report event request.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -080099 &quot;clientEvent&quot;: { # 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. # Required. Events issued when end user interacts with customer&#x27;s application that uses Cloud Talent Solution.
100 &quot;createTime&quot;: &quot;A String&quot;, # Required. The timestamp of the event.
101 &quot;eventId&quot;: &quot;A String&quot;, # Required. A unique identifier, generated by the client application. This `event_id` is used to establish the relationship between different events (see parent_event_id).
102 &quot;extraInfo&quot;: { # Optional. Extra information about this event. Used for storing information with no matching field in 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.
103 &quot;a_key&quot;: &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700104 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800105 &quot;jobEvent&quot;: { # An event issued when a job seeker interacts with the application that implements Cloud Talent Solution. # A event issued when a job seeker interacts with the application that implements Cloud Talent Solution.
106 &quot;jobs&quot;: [ # 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.
107 &quot;A String&quot;,
108 ],
109 &quot;type&quot;: &quot;A String&quot;, # Required. The type of the event (see JobEventType).
110 },
111 &quot;parentEventId&quot;: &quot;A String&quot;, # Optional. The event_id of an event that resulted in the current event. For example, a Job view event usually follows a parent impression event: A job seeker first does a search where a list of jobs appears (impression). The job seeker then selects a result and views the description of a particular job (Job view).
112 &quot;requestId&quot;: &quot;A String&quot;, # Required. A unique ID generated in the API responses. It can be found in ResponseMetadata.request_id.
113 },
114}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700115
116 x__xgafv: string, V1 error format.
117 Allowed values
118 1 - v1 error format
119 2 - v2 error format
120
121Returns:
122 An object of the form:
123
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700124 { # 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.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800125 &quot;createTime&quot;: &quot;A String&quot;, # Required. The timestamp of the event.
126 &quot;eventId&quot;: &quot;A String&quot;, # Required. A unique identifier, generated by the client application. This `event_id` is used to establish the relationship between different events (see parent_event_id).
127 &quot;extraInfo&quot;: { # Optional. Extra information about this event. Used for storing information with no matching field in 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.
128 &quot;a_key&quot;: &quot;A String&quot;,
129 },
130 &quot;jobEvent&quot;: { # An event issued when a job seeker interacts with the application that implements Cloud Talent Solution. # A event issued when a job seeker interacts with the application that implements Cloud Talent Solution.
131 &quot;jobs&quot;: [ # 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.
132 &quot;A String&quot;,
133 ],
134 &quot;type&quot;: &quot;A String&quot;, # Required. The type of the event (see JobEventType).
135 },
136 &quot;parentEventId&quot;: &quot;A String&quot;, # Optional. The event_id of an event that resulted in the current event. For example, a Job view event usually follows a parent impression event: A job seeker first does a search where a list of jobs appears (impression). The job seeker then selects a result and views the description of a particular job (Job view).
137 &quot;requestId&quot;: &quot;A String&quot;, # Required. A unique ID generated in the API responses. It can be found in ResponseMetadata.request_id.
138}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700139</div>
140
141</body></html>