Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, 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 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, 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'Meara | dd49464 | 2020-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 Kim | 715bd7f | 2019-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'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 82 | <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 83 | <pre>Report events issued when end user interacts with customer's application |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 84 | that uses Cloud Talent Solution. You may inspect the created events in |
| 85 | [self service |
| 86 | tools](https://console.cloud.google.com/talent-solution/overview). |
| 87 | [Learn |
| 88 | more](https://cloud.google.com/talent-solution/docs/management-tools) |
| 89 | about self service tools. |
| 90 | |
| 91 | Args: |
| 92 | parent: string, Parent project name. (required) |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 93 | body: object, The request body. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 94 | The object takes the form of: |
| 95 | |
| 96 | { # The report event request. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -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 Kim | 715bd7f | 2019-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. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 103 | "eventId": "A String", # Required. A unique identifier, generated by the client application. This `event_id` |
| 104 | # is used to establish the relationship between different events |
| 105 | # (see parent_event_id). |
| 106 | "extraInfo": { # Optional. Extra information about this event. Used for storing information with no |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 107 | # matching field in event payload, for example, user application specific |
| 108 | # context or details. |
| 109 | # |
| 110 | # At most 20 keys are supported. The maximum total size of all keys and |
| 111 | # values is 2 KB. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 112 | "a_key": "A String", |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 113 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 114 | "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 |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 115 | # implements Cloud Talent Solution. |
| 116 | # implements Cloud Talent Solution. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 117 | "jobs": [ # Required. The job name(s) associated with this event. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 118 | # For example, if this is an impression event, |
| 119 | # this field contains the identifiers of all jobs shown to the job seeker. |
| 120 | # If this was a view event, this field contains the |
| 121 | # identifier of the viewed job. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 122 | "A String", |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 123 | ], |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 124 | "type": "A String", # Required. The type of the event (see JobEventType). |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 125 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 126 | "requestId": "A String", # Required. A unique ID generated in the API responses. It can be found in |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 127 | # ResponseMetadata.request_id. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 128 | "createTime": "A String", # Required. The timestamp of the event. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 129 | "parentEventId": "A String", # Optional. The event_id of an event that resulted in the current event. For example, a |
| 130 | # Job view event usually follows a parent |
| 131 | # impression event: A job seeker first does a |
| 132 | # search where a list of jobs appears |
| 133 | # (impression). The job seeker then selects a |
| 134 | # result and views the description of a particular job (Job |
| 135 | # view). |
Bu Sun Kim | 715bd7f | 2019-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 | |
| 144 | Returns: |
| 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. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 152 | "eventId": "A String", # Required. A unique identifier, generated by the client application. This `event_id` |
| 153 | # is used to establish the relationship between different events |
| 154 | # (see parent_event_id). |
| 155 | "extraInfo": { # Optional. Extra information about this event. Used for storing information with no |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 156 | # matching field in event payload, for example, user application specific |
| 157 | # context or details. |
| 158 | # |
| 159 | # At most 20 keys are supported. The maximum total size of all keys and |
| 160 | # values is 2 KB. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 161 | "a_key": "A String", |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 162 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 163 | "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 |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 164 | # implements Cloud Talent Solution. |
| 165 | # implements Cloud Talent Solution. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 166 | "jobs": [ # Required. The job name(s) associated with this event. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 167 | # For example, if this is an impression event, |
| 168 | # this field contains the identifiers of all jobs shown to the job seeker. |
| 169 | # If this was a view event, this field contains the |
| 170 | # identifier of the viewed job. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 171 | "A String", |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 172 | ], |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 173 | "type": "A String", # Required. The type of the event (see JobEventType). |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 174 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 175 | "requestId": "A String", # Required. A unique ID generated in the API responses. It can be found in |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 176 | # ResponseMetadata.request_id. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 177 | "createTime": "A String", # Required. The timestamp of the event. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 178 | "parentEventId": "A String", # Optional. The event_id of an event that resulted in the current event. For example, a |
| 179 | # Job view event usually follows a parent |
| 180 | # impression event: A job seeker first does a |
| 181 | # search where a list of jobs appears |
| 182 | # (impression). The job seeker then selects a |
| 183 | # result and views the description of a particular job (Job |
| 184 | # view). |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 185 | }</pre> |
| 186 | </div> |
| 187 | |
| 188 | </body></html> |