Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / jobs_v3.projects.clientEvents.html
blob: 4d35da9a07ba454a58d766be17f2b437d1fdfcfc [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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]78 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]82 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]93 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]94 The object takes the form of:
95
96{ # The report event request.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]97 "clientEvent": { # An event issued when an end user interacts with the application that # Required. Events issued when end user interacts with customer's application that
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]98 # uses Cloud Talent Solution.
99 # implements Cloud Talent Solution. Providing this information improves the
100 # quality of search and recommendation for the API clients, enabling the
101 # service to perform optimally. The number of events sent must be consistent
102 # with other calls, such as job searches, issued to the service by the client.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]103 "eventId": "A String", # Required. A unique identifier, generated by the client application. This `event_id`
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]104 # is used to establish the relationship between different events
105 # (see parent_event_id).
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]106 "parentEventId": "A String", # Optional. The event_id of an event that resulted in the current event. For example, a
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]107 # Job view event usually follows a parent
108 # impression event: A job seeker first does a
109 # search where a list of jobs appears
110 # (impression). The job seeker then selects a
111 # result and views the description of a particular job (Job
112 # view).
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]113 "extraInfo": { # Optional. Extra information about this event. Used for storing information with no
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]114 # matching field in event payload, for example, user application specific
115 # context or details.
116 #
117 # At most 20 keys are supported. The maximum total size of all keys and
118 # values is 2 KB.
119 "a_key": "A String",
120 },
121 "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
122 # implements Cloud Talent Solution.
123 # implements Cloud Talent Solution.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]124 "jobs": [ # Required. The job name(s) associated with this event.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]125 # For example, if this is an impression event,
126 # this field contains the identifiers of all jobs shown to the job seeker.
127 # If this was a view event, this field contains the
128 # identifier of the viewed job.
129 "A String",
130 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]131 "type": "A String", # Required. The type of the event (see JobEventType).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]132 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]133 "requestId": "A String", # Required. A unique ID generated in the API responses. It can be found in
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]134 # ResponseMetadata.request_id.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]135 "createTime": "A String", # Required. The timestamp of the event.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]136 },
137 }
138
139 x__xgafv: string, V1 error format.
140 Allowed values
141 1 - v1 error format
142 2 - v2 error format
143
144Returns:
145 An object of the form:
146
147 { # An event issued when an end user interacts with the application that
148 # implements Cloud Talent Solution. Providing this information improves the
149 # quality of search and recommendation for the API clients, enabling the
150 # service to perform optimally. The number of events sent must be consistent
151 # with other calls, such as job searches, issued to the service by the client.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]152 "eventId": "A String", # Required. A unique identifier, generated by the client application. This `event_id`
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]153 # is used to establish the relationship between different events
154 # (see parent_event_id).
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]155 "parentEventId": "A String", # Optional. The event_id of an event that resulted in the current event. For example, a
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]156 # Job view event usually follows a parent
157 # impression event: A job seeker first does a
158 # search where a list of jobs appears
159 # (impression). The job seeker then selects a
160 # result and views the description of a particular job (Job
161 # view).
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]162 "extraInfo": { # Optional. Extra information about this event. Used for storing information with no
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]163 # matching field in event payload, for example, user application specific
164 # context or details.
165 #
166 # At most 20 keys are supported. The maximum total size of all keys and
167 # values is 2 KB.
168 "a_key": "A String",
169 },
170 "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
171 # implements Cloud Talent Solution.
172 # implements Cloud Talent Solution.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]173 "jobs": [ # Required. The job name(s) associated with this event.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]174 # For example, if this is an impression event,
175 # this field contains the identifiers of all jobs shown to the job seeker.
176 # If this was a view event, this field contains the
177 # identifier of the viewed job.
178 "A String",
179 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]180 "type": "A String", # Required. The type of the event (see JobEventType).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]181 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]182 "requestId": "A String", # Required. A unique ID generated in the API responses. It can be found in
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]183 # ResponseMetadata.request_id.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]184 "createTime": "A String", # Required. The timestamp of the event.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]185 }</pre>
186</div>
187
188</body></html>