Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 715bd7f9ca9a324a05ee05a6476af383e54930f9 / . / docs / dyn / jobs_v3.projects.clientEvents.html
blob: a7ac89362f23143649b7c2d23d127b27d7b479d7 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1<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">
78 <code><a href="#create">create(parent, body, x__xgafv=None)</a></code></p>
79<p class="firstline">Report events issued when end user interacts with customer's application</p>
80<h3>Method Details</h3>
81<div class="method">
82 <code class="details" id="create">create(parent, body, x__xgafv=None)</code>
83 <pre>Report events issued when end user interacts with customer's application
84that uses Cloud Talent Solution. You may inspect the created events in
85[self service
86tools](https://console.cloud.google.com/talent-solution/overview).
87[Learn
88more](https://cloud.google.com/talent-solution/docs/management-tools)
89about self service tools.
90
91Args:
92 parent: string, Parent project name. (required)
93 body: object, The request body. (required)
94 The object takes the form of:
95
96{ # The report event request.
97 "clientEvent": { # An event issued when an end user interacts with the application that # Required.
98 #
99 # Events issued when end user interacts with customer's application that
100 # uses Cloud Talent Solution.
101 # implements Cloud Talent Solution. Providing this information improves the
102 # quality of search and recommendation for the API clients, enabling the
103 # service to perform optimally. The number of events sent must be consistent
104 # with other calls, such as job searches, issued to the service by the client.
105 "eventId": "A String", # Required.
106 #
107 # A unique identifier, generated by the client application. This `event_id`
108 # is used to establish the relationship between different events
109 # (see parent_event_id).
110 "parentEventId": "A String", # Optional.
111 #
112 # The event_id of an event that resulted in the current event. For example, a
113 # Job view event usually follows a parent
114 # impression event: A job seeker first does a
115 # search where a list of jobs appears
116 # (impression). The job seeker then selects a
117 # result and views the description of a particular job (Job
118 # view).
119 "extraInfo": { # Optional.
120 #
121 # Extra information about this event. Used for storing information with no
122 # matching field in event payload, for example, user application specific
123 # context or details.
124 #
125 # At most 20 keys are supported. The maximum total size of all keys and
126 # values is 2 KB.
127 "a_key": "A String",
128 },
129 "jobEvent": { # An event issued when a job seeker interacts with the application that # A event issued when a job seeker interacts with the application that
130 # implements Cloud Talent Solution.
131 # implements Cloud Talent Solution.
132 "type": "A String", # Required.
133 #
134 # The type of the event (see JobEventType).
135 "jobs": [ # Required.
136 #
137 # The job name(s) associated with this event.
138 # For example, if this is an impression event,
139 # this field contains the identifiers of all jobs shown to the job seeker.
140 # If this was a view event, this field contains the
141 # identifier of the viewed job.
142 "A String",
143 ],
144 },
145 "requestId": "A String", # Required.
146 #
147 # A unique ID generated in the API responses. It can be found in
148 # ResponseMetadata.request_id.
149 "createTime": "A String", # Required.
150 #
151 # The timestamp of the event.
152 },
153 }
154
155 x__xgafv: string, V1 error format.
156 Allowed values
157 1 - v1 error format
158 2 - v2 error format
159
160Returns:
161 An object of the form:
162
163 { # An event issued when an end user interacts with the application that
164 # implements Cloud Talent Solution. Providing this information improves the
165 # quality of search and recommendation for the API clients, enabling the
166 # service to perform optimally. The number of events sent must be consistent
167 # with other calls, such as job searches, issued to the service by the client.
168 "eventId": "A String", # Required.
169 #
170 # A unique identifier, generated by the client application. This `event_id`
171 # is used to establish the relationship between different events
172 # (see parent_event_id).
173 "parentEventId": "A String", # Optional.
174 #
175 # The event_id of an event that resulted in the current event. For example, a
176 # Job view event usually follows a parent
177 # impression event: A job seeker first does a
178 # search where a list of jobs appears
179 # (impression). The job seeker then selects a
180 # result and views the description of a particular job (Job
181 # view).
182 "extraInfo": { # Optional.
183 #
184 # Extra information about this event. Used for storing information with no
185 # matching field in event payload, for example, user application specific
186 # context or details.
187 #
188 # At most 20 keys are supported. The maximum total size of all keys and
189 # values is 2 KB.
190 "a_key": "A String",
191 },
192 "jobEvent": { # An event issued when a job seeker interacts with the application that # A event issued when a job seeker interacts with the application that
193 # implements Cloud Talent Solution.
194 # implements Cloud Talent Solution.
195 "type": "A String", # Required.
196 #
197 # The type of the event (see JobEventType).
198 "jobs": [ # Required.
199 #
200 # The job name(s) associated with this event.
201 # For example, if this is an impression event,
202 # this field contains the identifiers of all jobs shown to the job seeker.
203 # If this was a view event, this field contains the
204 # identifier of the viewed job.
205 "A String",
206 ],
207 },
208 "requestId": "A String", # Required.
209 #
210 # A unique ID generated in the API responses. It can be found in
211 # ResponseMetadata.request_id.
212 "createTime": "A String", # Required.
213 #
214 # The timestamp of the event.
215 }</pre>
216</div>
217
218</body></html>