| 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.jobs.html">jobs</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="#batchDelete">batchDelete(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">Deletes a list of Jobs by filter.</p> |
| 80 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 81 | <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] | 82 | <p class="firstline">Creates a new job.</p> |
| 83 | <p class="toc_element"> |
| 84 | <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> |
| 85 | <p class="firstline">Deletes the specified job.</p> |
| 86 | <p class="toc_element"> |
| 87 | <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| 88 | <p class="firstline">Retrieves the specified job, whose status is OPEN or recently EXPIRED</p> |
| 89 | <p class="toc_element"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 90 | <code><a href="#list">list(parent, jobView=None, pageToken=None, pageSize=None, filter=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 91 | <p class="firstline">Lists jobs by filter.</p> |
| 92 | <p class="toc_element"> |
| 93 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 94 | <p class="firstline">Retrieves the next page of results.</p> |
| 95 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 96 | <code><a href="#patch">patch(name, body=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 97 | <p class="firstline">Updates specified job.</p> |
| 98 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 99 | <code><a href="#search">search(parent, body=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 100 | <p class="firstline">Searches for jobs using the provided SearchJobsRequest.</p> |
| 101 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 102 | <code><a href="#searchForAlert">searchForAlert(parent, body=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 103 | <p class="firstline">Searches for jobs using the provided SearchJobsRequest.</p> |
| 104 | <p class="toc_element"> |
| 105 | <code><a href="#searchForAlert_next">searchForAlert_next(previous_request, previous_response)</a></code></p> |
| 106 | <p class="firstline">Retrieves the next page of results.</p> |
| 107 | <p class="toc_element"> |
| 108 | <code><a href="#search_next">search_next(previous_request, previous_response)</a></code></p> |
| 109 | <p class="firstline">Retrieves the next page of results.</p> |
| 110 | <h3>Method Details</h3> |
| 111 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 112 | <code class="details" id="batchDelete">batchDelete(parent, body=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 113 | <pre>Deletes a list of Jobs by filter. |
| 114 | |
| 115 | Args: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 116 | parent: string, Required. The resource name of the project under which the job is created. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 117 | |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 118 | The format is "projects/{project_id}", for example, |
| 119 | "projects/api-test-project". (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 120 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 121 | The object takes the form of: |
| 122 | |
| 123 | { # Input only. |
| 124 | # |
| 125 | # Batch delete jobs request. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 126 | "filter": "A String", # Required. The filter string specifies the jobs to be deleted. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 127 | # |
| 128 | # Supported operator: =, AND |
| 129 | # |
| 130 | # The fields eligible for filtering are: |
| 131 | # |
| 132 | # * `companyName` (Required) |
| 133 | # * `requisitionId` (Required) |
| 134 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 135 | # Sample Query: companyName = "projects/api-test-project/companies/123" AND |
| 136 | # requisitionId = "req-1" |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 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 | { # A generic empty message that you can re-use to avoid defining duplicated |
| 148 | # empty messages in your APIs. A typical example is to use it as the request |
| 149 | # or the response type of an API method. For instance: |
| 150 | # |
| 151 | # service Foo { |
| 152 | # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); |
| 153 | # } |
| 154 | # |
| 155 | # The JSON representation for `Empty` is empty JSON object `{}`. |
| 156 | }</pre> |
| 157 | </div> |
| 158 | |
| 159 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 160 | <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 161 | <pre>Creates a new job. |
| 162 | |
| 163 | Typically, the job becomes searchable within 10 seconds, but it may take |
| 164 | up to 5 minutes. |
| 165 | |
| 166 | Args: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 167 | parent: string, Required. The resource name of the project under which the job is created. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 168 | |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 169 | The format is "projects/{project_id}", for example, |
| 170 | "projects/api-test-project". (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 171 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 172 | The object takes the form of: |
| 173 | |
| 174 | { # Input only. |
| 175 | # |
| 176 | # Create job request. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 177 | "job": { # A Job resource represents a job posting (also referred to as a "job listing" # Required. The Job to be created. |
| 178 | # or "job requisition"). A job belongs to a Company, which is the hiring |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 179 | # entity responsible for the job. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 180 | "jobLevel": "A String", # Optional. The experience level associated with the job, such as "Entry Level". |
| 181 | "languageCode": "A String", # Optional. The language of the posting. This field is distinct from |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 182 | # any requirements for fluency that are associated with the job. |
| 183 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 184 | # Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn". |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 185 | # For more information, see |
| 186 | # [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 187 | # class="external" target="_blank" }. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 188 | # |
| 189 | # If this field is unspecified and Job.description is present, detected |
| 190 | # language code based on Job.description is assigned, otherwise |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 191 | # defaults to 'en_US'. |
| 192 | "postingUpdateTime": "A String", # Output only. The timestamp when this job posting was last updated. |
| 193 | "visibility": "A String", # Deprecated. The job is only visible to the owner. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 194 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 195 | # The visibility of the job. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 196 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 197 | # Defaults to Visibility.ACCOUNT_ONLY if not specified. |
| 198 | "name": "A String", # Required during job update. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 199 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 200 | # The resource name for the job. This is generated by the service when a |
| 201 | # job is created. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 202 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 203 | # The format is "projects/{project_id}/jobs/{job_id}", |
| 204 | # for example, "projects/api-test-project/jobs/1234". |
| 205 | # |
| 206 | # Use of this field in job queries and API calls is preferred over the use of |
| 207 | # requisition_id since this value is unique. |
| 208 | "jobBenefits": [ # Optional. The benefits included with the job. |
| 209 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 210 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 211 | "promotionValue": 42, # Optional. A promotion value of the job, as determined by the client. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 212 | # The value determines the sort order of the jobs returned when searching for |
| 213 | # jobs using the featured jobs search call, with higher promotional values |
| 214 | # being returned first and ties being resolved by relevance sort. Only the |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 215 | # jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 216 | # |
| 217 | # Default value is 0, and negative values are treated as 0. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 218 | "title": "A String", # Required. The title of the job, such as "Software Engineer" |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 219 | # |
| 220 | # The maximum number of allowed characters is 500. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 221 | "companyDisplayName": "A String", # Output only. Display name of the company listing the job. |
| 222 | "requisitionId": "A String", # Required. The requisition ID, also referred to as the posting ID, assigned by the |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 223 | # client to identify a job. This field is intended to be used by clients |
| 224 | # for client identification and tracking of postings. A job is not allowed |
| 225 | # to be created if there is another job with the same [company_name], |
| 226 | # language_code and requisition_id. |
| 227 | # |
| 228 | # The maximum number of allowed characters is 255. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 229 | "qualifications": "A String", # Optional. A description of the qualifications required to perform the |
| 230 | # job. The use of this field is recommended |
| 231 | # as an alternative to using the more general description field. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 232 | # |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 233 | # This field accepts and sanitizes HTML input, and also accepts |
| 234 | # bold, italic, ordered list, and unordered list markup tags. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 235 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 236 | # The maximum number of allowed characters is 10,000. |
| 237 | "processingOptions": { # Input only. # Optional. Options for job processing. |
| 238 | # |
| 239 | # Options for job processing. |
| 240 | "disableStreetAddressResolution": True or False, # Optional. If set to `true`, the service does not attempt to resolve a |
| 241 | # more precise address for the job. |
| 242 | "htmlSanitization": "A String", # Optional. Option for job HTML content sanitization. Applied fields are: |
| 243 | # |
| 244 | # * description |
| 245 | # * applicationInfo.instruction |
| 246 | # * incentives |
| 247 | # * qualifications |
| 248 | # * responsibilities |
| 249 | # |
| 250 | # HTML tags in these fields may be stripped if sanitiazation is not |
| 251 | # disabled. |
| 252 | # |
| 253 | # Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY. |
| 254 | }, |
| 255 | "jobEndTime": "A String", # Optional. The end timestamp of the job. Typically this field is used for contracting |
| 256 | # engagements. Invalid timestamps are ignored. |
| 257 | "derivedInfo": { # Output only. # Output only. Derived details about the job posting. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 258 | # |
| 259 | # Derived details about the job posting. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 260 | "jobCategories": [ # Job categories derived from Job.title and Job.description. |
| 261 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 262 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 263 | "locations": [ # Structured locations of the job, resolved from Job.addresses. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 264 | # |
| 265 | # locations are exactly matched to Job.addresses in the same |
| 266 | # order. |
| 267 | { # Output only. |
| 268 | # |
| 269 | # A resource that represents a location with full geographic information. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 270 | "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 271 | # of doubles representing degrees latitude and degrees longitude. Unless |
| 272 | # specified otherwise, this must conform to the |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 273 | # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 274 | # standard</a>. Values must be within normalized ranges. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 275 | "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. |
| 276 | "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 277 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 278 | "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 279 | # such as postal delivery and payments addresses. Given a postal address, |
| 280 | # a postal service can deliver items to a premises, P.O. Box, or other |
| 281 | # delivery location. |
| 282 | # Given a postal address, a postal service can deliver items to a premise, P.O. |
| 283 | # Box or similar. |
| 284 | # It is not intended to model geographical locations (roads, towns, |
| 285 | # mountains). |
| 286 | # |
| 287 | # In typical usage an address would be created via user input or from importing |
| 288 | # existing data, depending on the type of process. |
| 289 | # |
| 290 | # Advice on address input / editing: |
| 291 | # - Use an i18n-ready address widget such as |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 292 | # https://github.com/google/libaddressinput) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 293 | # - Users should not be presented with UI elements for input or editing of |
| 294 | # fields outside countries where that field is used. |
| 295 | # |
| 296 | # For more guidance on how to use this schema, please see: |
| 297 | # https://support.google.com/business/answer/6397478 |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 298 | "sublocality": "A String", # Optional. Sublocality of the address. |
| 299 | # For example, this can be neighborhoods, boroughs, districts. |
| 300 | "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is |
| 301 | # the latest revision. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 302 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 303 | # All new revisions **must** be backward compatible with old revisions. |
| 304 | "locality": "A String", # Optional. Generally refers to the city/town portion of the address. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 305 | # Examples: US city, IT comune, UK post town. |
| 306 | # In regions of the world where localities are not well defined or do not fit |
| 307 | # into this structure well, leave locality empty and use address_lines. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 308 | "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 309 | # addresses of a country or region. |
| 310 | # For example, this can be a state, a province, an oblast, or a prefecture. |
| 311 | # Specifically, for Spain this is the province and not the autonomous |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 312 | # community (e.g. "Barcelona" and not "Catalonia"). |
| 313 | # Many countries don't use an administrative area in postal addresses. E.g. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 314 | # in Switzerland this should be left unpopulated. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 315 | "organization": "A String", # Optional. The name of the organization at the address. |
| 316 | "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This |
| 317 | # is never inferred and it is up to the user to ensure the value is |
| 318 | # correct. See http://cldr.unicode.org/ and |
| 319 | # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html |
| 320 | # for details. Example: "CH" for Switzerland. |
| 321 | "addressLines": [ # Unstructured address lines describing the lower levels of an address. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 322 | # |
| 323 | # Because values in address_lines do not have type information and may |
| 324 | # sometimes contain multiple values in a single field (e.g. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 325 | # "Austin, TX"), it is important that the line order is clear. The order of |
| 326 | # address lines should be "envelope order" for the country/region of the |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 327 | # address. In places where this can vary (e.g. Japan), address_language is |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 328 | # used to make it explicit (e.g. "ja" for large-to-small ordering and |
| 329 | # "ja-Latn" or "en" for small-to-large). This way, the most specific line of |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 330 | # an address can be selected based on the language. |
| 331 | # |
| 332 | # The minimum permitted structural representation of an address consists |
| 333 | # of a region_code with all remaining information placed in the |
| 334 | # address_lines. It would be possible to format such an address very |
| 335 | # approximately without geocoding, but no semantic reasoning could be |
| 336 | # made about any of the address components until it was at least |
| 337 | # partially resolved. |
| 338 | # |
| 339 | # Creating an address only containing a region_code and address_lines, and |
| 340 | # then geocoding is the recommended way to handle completely unstructured |
| 341 | # addresses (as opposed to guessing which parts of the address should be |
| 342 | # localities or administrative areas). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 343 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 344 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 345 | "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 346 | # postal codes to be present, but where they are used, they may trigger |
| 347 | # additional validation with other parts of the address (e.g. state/zip |
| 348 | # validation in the U.S.A.). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 349 | "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if |
| 350 | # known). This is often the UI language of the input form or is expected |
| 351 | # to match one of the languages used in the address' country/region, or their |
| 352 | # transliterated equivalents. |
| 353 | # This can affect formatting in certain countries, but is not critical |
| 354 | # to the correctness of the data and will never affect any validation or |
| 355 | # other non-formatting related operations. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 356 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 357 | # If this value is not known, it should be omitted (rather than specifying a |
| 358 | # possibly incorrect default). |
| 359 | # |
| 360 | # Examples: "zh-Hant", "ja", "ja-Latn", "en". |
| 361 | "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used |
| 362 | # in most regions. Where it is used, the value is either a string like |
| 363 | # "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number |
| 364 | # alone, representing the "sector code" (Jamaica), "delivery area indicator" |
| 365 | # (Malawi) or "post office indicator" (e.g. Côte d'Ivoire). |
| 366 | "recipients": [ # Optional. The recipient at the address. |
| 367 | # This field may, under certain circumstances, contain multiline information. |
| 368 | # For example, it might contain "care of" information. |
| 369 | "A String", |
| 370 | ], |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 371 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 372 | "locationType": "A String", # The type of a location, which corresponds to the address lines field of |
| 373 | # PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of |
| 374 | # LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of |
| 375 | # LocationType#LOCALITY. |
| 376 | "radiusInMiles": 3.14, # Radius in miles of the job location. This value is derived from the |
| 377 | # location bounding box in which a circle with the specified radius |
| 378 | # centered from LatLng covers the area associated with the job location. |
| 379 | # For example, currently, "Mountain View, CA, USA" has a radius of |
| 380 | # 6.17 miles. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 381 | }, |
| 382 | ], |
| 383 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 384 | "employmentTypes": [ # Optional. The employment type(s) of a job, for example, |
| 385 | # full time or |
| 386 | # part time. |
| 387 | "A String", |
| 388 | ], |
| 389 | "incentives": "A String", # Optional. A description of bonus, commission, and other compensation |
| 390 | # incentives associated with the job not including salary or pay. |
| 391 | # |
| 392 | # The maximum number of allowed characters is 10,000. |
| 393 | "postingCreateTime": "A String", # Output only. The timestamp when this job posting was created. |
| 394 | "addresses": [ # Optional but strongly recommended for the best service experience. |
| 395 | # |
| 396 | # Location(s) where the employer is looking to hire for this job posting. |
| 397 | # |
| 398 | # Specifying the full street address(es) of the hiring location enables |
| 399 | # better API results, especially job searches by commute time. |
| 400 | # |
| 401 | # At most 50 locations are allowed for best search performance. If a job has |
| 402 | # more locations, it is suggested to split it into multiple jobs with unique |
| 403 | # requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as |
| 404 | # multiple jobs with the same company_name, language_code and |
| 405 | # requisition_id are not allowed. If the original requisition_id must |
| 406 | # be preserved, a custom field should be used for storage. It is also |
| 407 | # suggested to group the locations that close to each other in the same job |
| 408 | # for better search experience. |
| 409 | # |
| 410 | # The maximum number of allowed characters is 500. |
| 411 | "A String", |
| 412 | ], |
| 413 | "companyName": "A String", # Required. The resource name of the company listing the job, such as |
| 414 | # "projects/api-test-project/companies/foo". |
| 415 | "description": "A String", # Required. The description of the job, which typically includes a multi-paragraph |
| 416 | # description of the company and related information. Separate fields are |
| 417 | # provided on the job object for responsibilities, |
| 418 | # qualifications, and other job characteristics. Use of |
| 419 | # these separate job fields is recommended. |
| 420 | # |
| 421 | # This field accepts and sanitizes HTML input, and also accepts |
| 422 | # bold, italic, ordered list, and unordered list markup tags. |
| 423 | # |
| 424 | # The maximum number of allowed characters is 100,000. |
| 425 | "jobStartTime": "A String", # Optional. The start timestamp of the job in UTC time zone. Typically this field |
| 426 | # is used for contracting engagements. Invalid timestamps are ignored. |
| 427 | "degreeTypes": [ # Optional. The desired education degrees for the job, such as Bachelors, Masters. |
| 428 | "A String", |
| 429 | ], |
| 430 | "compensationInfo": { # Job compensation details. # Optional. Job compensation information. |
| 431 | "annualizedBaseCompensationRange": { # Compensation range. # Output only. Annualized base compensation range. Computed as |
| 432 | # base compensation entry's CompensationEntry.compensation times |
| 433 | # CompensationEntry.expected_units_per_year. |
| 434 | # |
| 435 | # See CompensationEntry for explanation on compensation annualization. |
| 436 | "maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set |
| 437 | # to a maximal compensation value and the currency code is set to |
| 438 | # match the currency code of |
| 439 | # min_compensation. |
| 440 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 441 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 442 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 443 | # If `units` is positive, `nanos` must be positive or zero. |
| 444 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 445 | # If `units` is negative, `nanos` must be negative or zero. |
| 446 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 447 | "units": "A String", # The whole units of the amount. |
| 448 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 449 | }, |
| 450 | "minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set |
| 451 | # to zero and the currency code is set to match the |
| 452 | # currency code of max_compensation. |
| 453 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 454 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 455 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 456 | # If `units` is positive, `nanos` must be positive or zero. |
| 457 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 458 | # If `units` is negative, `nanos` must be negative or zero. |
| 459 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 460 | "units": "A String", # The whole units of the amount. |
| 461 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 462 | }, |
| 463 | }, |
| 464 | "annualizedTotalCompensationRange": { # Compensation range. # Output only. Annualized total compensation range. Computed as |
| 465 | # all compensation entries' CompensationEntry.compensation times |
| 466 | # CompensationEntry.expected_units_per_year. |
| 467 | # |
| 468 | # See CompensationEntry for explanation on compensation annualization. |
| 469 | "maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set |
| 470 | # to a maximal compensation value and the currency code is set to |
| 471 | # match the currency code of |
| 472 | # min_compensation. |
| 473 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 474 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 475 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 476 | # If `units` is positive, `nanos` must be positive or zero. |
| 477 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 478 | # If `units` is negative, `nanos` must be negative or zero. |
| 479 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 480 | "units": "A String", # The whole units of the amount. |
| 481 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 482 | }, |
| 483 | "minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set |
| 484 | # to zero and the currency code is set to match the |
| 485 | # currency code of max_compensation. |
| 486 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 487 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 488 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 489 | # If `units` is positive, `nanos` must be positive or zero. |
| 490 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 491 | # If `units` is negative, `nanos` must be negative or zero. |
| 492 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 493 | "units": "A String", # The whole units of the amount. |
| 494 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 495 | }, |
| 496 | }, |
| 497 | "entries": [ # Optional. Job compensation information. |
| 498 | # |
| 499 | # At most one entry can be of type |
| 500 | # CompensationInfo.CompensationType.BASE, which is |
| 501 | # referred as ** base compensation entry ** for the job. |
| 502 | { # A compensation entry that represents one component of compensation, such |
| 503 | # as base pay, bonus, or other compensation type. |
| 504 | # |
| 505 | # Annualization: One compensation entry can be annualized if |
| 506 | # - it contains valid amount or range. |
| 507 | # - and its expected_units_per_year is set or can be derived. |
| 508 | # Its annualized range is determined as (amount or range) times |
| 509 | # expected_units_per_year. |
| 510 | "unit": "A String", # Optional. Frequency of the specified amount. |
| 511 | # |
| 512 | # Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED. |
| 513 | "amount": { # Represents an amount of money with its currency type. # Optional. Compensation amount. |
| 514 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 515 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 516 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 517 | # If `units` is positive, `nanos` must be positive or zero. |
| 518 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 519 | # If `units` is negative, `nanos` must be negative or zero. |
| 520 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 521 | "units": "A String", # The whole units of the amount. |
| 522 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 523 | }, |
| 524 | "type": "A String", # Optional. Compensation type. |
| 525 | # |
| 526 | # Default is CompensationUnit.COMPENSATION_TYPE_UNSPECIFIED. |
| 527 | "range": { # Compensation range. # Optional. Compensation range. |
| 528 | "maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set |
| 529 | # to a maximal compensation value and the currency code is set to |
| 530 | # match the currency code of |
| 531 | # min_compensation. |
| 532 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 533 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 534 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 535 | # If `units` is positive, `nanos` must be positive or zero. |
| 536 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 537 | # If `units` is negative, `nanos` must be negative or zero. |
| 538 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 539 | "units": "A String", # The whole units of the amount. |
| 540 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 541 | }, |
| 542 | "minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set |
| 543 | # to zero and the currency code is set to match the |
| 544 | # currency code of max_compensation. |
| 545 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 546 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 547 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 548 | # If `units` is positive, `nanos` must be positive or zero. |
| 549 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 550 | # If `units` is negative, `nanos` must be negative or zero. |
| 551 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 552 | "units": "A String", # The whole units of the amount. |
| 553 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 554 | }, |
| 555 | }, |
| 556 | "expectedUnitsPerYear": 3.14, # Optional. Expected number of units paid each year. If not specified, when |
| 557 | # Job.employment_types is FULLTIME, a default value is inferred |
| 558 | # based on unit. Default values: |
| 559 | # - HOURLY: 2080 |
| 560 | # - DAILY: 260 |
| 561 | # - WEEKLY: 52 |
| 562 | # - MONTHLY: 12 |
| 563 | # - ANNUAL: 1 |
| 564 | "description": "A String", # Optional. Compensation description. For example, could |
| 565 | # indicate equity terms or provide additional context to an estimated |
| 566 | # bonus. |
| 567 | }, |
| 568 | ], |
| 569 | }, |
| 570 | "responsibilities": "A String", # Optional. A description of job responsibilities. The use of this field is |
| 571 | # recommended as an alternative to using the more general description |
| 572 | # field. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 573 | # |
| 574 | # This field accepts and sanitizes HTML input, and also accepts |
| 575 | # bold, italic, ordered list, and unordered list markup tags. |
| 576 | # |
| 577 | # The maximum number of allowed characters is 10,000. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 578 | "department": "A String", # Optional. The department or functional area within the company with the open |
| 579 | # position. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 580 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 581 | # The maximum number of allowed characters is 255. |
| 582 | "applicationInfo": { # Application related details of a job posting. # Required. At least one field within ApplicationInfo must be specified. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 583 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 584 | # Job application information. |
| 585 | "uris": [ # Optional but at least one of uris, |
| 586 | # emails or instruction must be |
| 587 | # specified. |
| 588 | # |
| 589 | # Use this URI field to direct an applicant to a website, for example to |
| 590 | # link to an online application form. |
| 591 | # |
| 592 | # The maximum number of allowed characters for each entry is 2,000. |
| 593 | "A String", |
| 594 | ], |
| 595 | "emails": [ # Optional but at least one of uris, |
| 596 | # emails or instruction must be |
| 597 | # specified. |
| 598 | # |
| 599 | # Use this field to specify email address(es) to which resumes or |
| 600 | # applications can be sent. |
| 601 | # |
| 602 | # The maximum number of allowed characters for each entry is 255. |
| 603 | "A String", |
| 604 | ], |
| 605 | "instruction": "A String", # Optional but at least one of uris, |
| 606 | # emails or instruction must be |
| 607 | # specified. |
| 608 | # |
| 609 | # Use this field to provide instructions, such as "Mail your application |
| 610 | # to ...", that a candidate can follow to apply for the job. |
| 611 | # |
| 612 | # This field accepts and sanitizes HTML input, and also accepts |
| 613 | # bold, italic, ordered list, and unordered list markup tags. |
| 614 | # |
| 615 | # The maximum number of allowed characters is 3,000. |
| 616 | }, |
| 617 | "postingExpireTime": "A String", # Optional but strongly recommended for the best service |
| 618 | # experience. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 619 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 620 | # The expiration timestamp of the job. After this timestamp, the |
| 621 | # job is marked as expired, and it no longer appears in search results. The |
| 622 | # expired job can't be deleted or listed by the DeleteJob and |
| 623 | # ListJobs APIs, but it can be retrieved with the GetJob API or |
| 624 | # updated with the UpdateJob API. An expired job can be updated and |
| 625 | # opened again by using a future expiration timestamp. Updating an expired |
| 626 | # job fails if there is another existing open job with same company_name, |
| 627 | # language_code and requisition_id. |
| 628 | # |
| 629 | # The expired jobs are retained in our system for 90 days. However, the |
| 630 | # overall expired job count cannot exceed 3 times the maximum of open jobs |
| 631 | # count over the past week, otherwise jobs with earlier expire time are |
| 632 | # cleaned first. Expired jobs are no longer accessible after they are cleaned |
| 633 | # out. |
| 634 | # |
| 635 | # Invalid timestamps are ignored, and treated as expire time not provided. |
| 636 | # |
| 637 | # Timestamp before the instant request is made is considered valid, the job |
| 638 | # will be treated as expired immediately. |
| 639 | # |
| 640 | # If this value is not provided at the time of job creation or is invalid, |
| 641 | # the job posting expires after 30 days from the job's creation time. For |
| 642 | # example, if the job was created on 2017/01/01 13:00AM UTC with an |
| 643 | # unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC. |
| 644 | # |
| 645 | # If this value is not provided on job update, it depends on the field masks |
| 646 | # set by UpdateJobRequest.update_mask. If the field masks include |
| 647 | # expiry_time, or the masks are empty meaning that every field is |
| 648 | # updated, the job posting expires after 30 days from the job's last |
| 649 | # update time. Otherwise the expiration date isn't updated. |
| 650 | "postingRegion": "A String", # Optional. The job PostingRegion (for example, state, country) throughout which |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 651 | # the job is available. If this field is set, a |
| 652 | # LocationFilter in a search query within the job region |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 653 | # finds this job posting if an exact location match isn't specified. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 654 | # If this field is set to PostingRegion.NATION or |
| 655 | # PostingRegion.ADMINISTRATIVE_AREA, setting job Job.addresses |
| 656 | # to the same location level as this field is strongly recommended. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 657 | "postingPublishTime": "A String", # Optional. The timestamp this job posting was most recently published. The default |
| 658 | # value is the time the request arrives at the server. Invalid timestamps are |
| 659 | # ignored. |
| 660 | "customAttributes": { # Optional. A map of fields to hold both filterable and non-filterable custom job |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 661 | # attributes that are not covered by the provided structured fields. |
| 662 | # |
| 663 | # The keys of the map are strings up to 64 bytes and must match the |
| 664 | # pattern: a-zA-Z*. For example, key0LikeThis or |
| 665 | # KEY_1_LIKE_THIS. |
| 666 | # |
| 667 | # At most 100 filterable and at most 100 unfilterable keys are supported. |
| 668 | # For filterable `string_values`, across all keys at most 200 values are |
| 669 | # allowed, with each string no more than 255 characters. For unfilterable |
| 670 | # `string_values`, the maximum total size of `string_values` across all keys |
| 671 | # is 50KB. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 672 | "a_key": { # Custom attribute values that are either filterable or non-filterable. |
| 673 | "stringValues": [ # Optional but exactly one of string_values or long_values must |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 674 | # be specified. |
| 675 | # |
| 676 | # This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or |
| 677 | # `CASE_INSENSITIVE_MATCH`) search. |
| 678 | # For filterable `string_value`s, a maximum total number of 200 values |
| 679 | # is allowed, with each `string_value` has a byte size of no more than |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 680 | # 500B. For unfilterable `string_values`, the maximum total byte size of |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 681 | # unfilterable `string_values` is 50KB. |
| 682 | # |
| 683 | # Empty string is not allowed. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 684 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 685 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 686 | "filterable": True or False, # Optional. If the `filterable` flag is true, the custom field values may be used for |
| 687 | # custom attribute filters JobQuery.custom_attribute_filter. |
| 688 | # If false, these values may not be used for custom attribute filters. |
| 689 | # |
| 690 | # Default is false. |
| 691 | "longValues": [ # Optional but exactly one of string_values or long_values must |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 692 | # be specified. |
| 693 | # |
| 694 | # This field is used to perform number range search. |
| 695 | # (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`. |
| 696 | # |
| 697 | # Currently at most 1 long_values is supported. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 698 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 699 | ], |
| 700 | }, |
| 701 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 702 | }, |
| 703 | } |
| 704 | |
| 705 | x__xgafv: string, V1 error format. |
| 706 | Allowed values |
| 707 | 1 - v1 error format |
| 708 | 2 - v2 error format |
| 709 | |
| 710 | Returns: |
| 711 | An object of the form: |
| 712 | |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 713 | { # A Job resource represents a job posting (also referred to as a "job listing" |
| 714 | # or "job requisition"). A job belongs to a Company, which is the hiring |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 715 | # entity responsible for the job. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 716 | "jobLevel": "A String", # Optional. The experience level associated with the job, such as "Entry Level". |
| 717 | "languageCode": "A String", # Optional. The language of the posting. This field is distinct from |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 718 | # any requirements for fluency that are associated with the job. |
| 719 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 720 | # Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn". |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 721 | # For more information, see |
| 722 | # [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 723 | # class="external" target="_blank" }. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 724 | # |
| 725 | # If this field is unspecified and Job.description is present, detected |
| 726 | # language code based on Job.description is assigned, otherwise |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 727 | # defaults to 'en_US'. |
| 728 | "postingUpdateTime": "A String", # Output only. The timestamp when this job posting was last updated. |
| 729 | "visibility": "A String", # Deprecated. The job is only visible to the owner. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 730 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 731 | # The visibility of the job. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 732 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 733 | # Defaults to Visibility.ACCOUNT_ONLY if not specified. |
| 734 | "name": "A String", # Required during job update. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 735 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 736 | # The resource name for the job. This is generated by the service when a |
| 737 | # job is created. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 738 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 739 | # The format is "projects/{project_id}/jobs/{job_id}", |
| 740 | # for example, "projects/api-test-project/jobs/1234". |
| 741 | # |
| 742 | # Use of this field in job queries and API calls is preferred over the use of |
| 743 | # requisition_id since this value is unique. |
| 744 | "jobBenefits": [ # Optional. The benefits included with the job. |
| 745 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 746 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 747 | "promotionValue": 42, # Optional. A promotion value of the job, as determined by the client. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 748 | # The value determines the sort order of the jobs returned when searching for |
| 749 | # jobs using the featured jobs search call, with higher promotional values |
| 750 | # being returned first and ties being resolved by relevance sort. Only the |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 751 | # jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 752 | # |
| 753 | # Default value is 0, and negative values are treated as 0. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 754 | "title": "A String", # Required. The title of the job, such as "Software Engineer" |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 755 | # |
| 756 | # The maximum number of allowed characters is 500. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 757 | "companyDisplayName": "A String", # Output only. Display name of the company listing the job. |
| 758 | "requisitionId": "A String", # Required. The requisition ID, also referred to as the posting ID, assigned by the |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 759 | # client to identify a job. This field is intended to be used by clients |
| 760 | # for client identification and tracking of postings. A job is not allowed |
| 761 | # to be created if there is another job with the same [company_name], |
| 762 | # language_code and requisition_id. |
| 763 | # |
| 764 | # The maximum number of allowed characters is 255. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 765 | "qualifications": "A String", # Optional. A description of the qualifications required to perform the |
| 766 | # job. The use of this field is recommended |
| 767 | # as an alternative to using the more general description field. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 768 | # |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 769 | # This field accepts and sanitizes HTML input, and also accepts |
| 770 | # bold, italic, ordered list, and unordered list markup tags. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 771 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 772 | # The maximum number of allowed characters is 10,000. |
| 773 | "processingOptions": { # Input only. # Optional. Options for job processing. |
| 774 | # |
| 775 | # Options for job processing. |
| 776 | "disableStreetAddressResolution": True or False, # Optional. If set to `true`, the service does not attempt to resolve a |
| 777 | # more precise address for the job. |
| 778 | "htmlSanitization": "A String", # Optional. Option for job HTML content sanitization. Applied fields are: |
| 779 | # |
| 780 | # * description |
| 781 | # * applicationInfo.instruction |
| 782 | # * incentives |
| 783 | # * qualifications |
| 784 | # * responsibilities |
| 785 | # |
| 786 | # HTML tags in these fields may be stripped if sanitiazation is not |
| 787 | # disabled. |
| 788 | # |
| 789 | # Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY. |
| 790 | }, |
| 791 | "jobEndTime": "A String", # Optional. The end timestamp of the job. Typically this field is used for contracting |
| 792 | # engagements. Invalid timestamps are ignored. |
| 793 | "derivedInfo": { # Output only. # Output only. Derived details about the job posting. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 794 | # |
| 795 | # Derived details about the job posting. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 796 | "jobCategories": [ # Job categories derived from Job.title and Job.description. |
| 797 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 798 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 799 | "locations": [ # Structured locations of the job, resolved from Job.addresses. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 800 | # |
| 801 | # locations are exactly matched to Job.addresses in the same |
| 802 | # order. |
| 803 | { # Output only. |
| 804 | # |
| 805 | # A resource that represents a location with full geographic information. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 806 | "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 807 | # of doubles representing degrees latitude and degrees longitude. Unless |
| 808 | # specified otherwise, this must conform to the |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 809 | # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 810 | # standard</a>. Values must be within normalized ranges. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 811 | "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. |
| 812 | "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 813 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 814 | "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 815 | # such as postal delivery and payments addresses. Given a postal address, |
| 816 | # a postal service can deliver items to a premises, P.O. Box, or other |
| 817 | # delivery location. |
| 818 | # Given a postal address, a postal service can deliver items to a premise, P.O. |
| 819 | # Box or similar. |
| 820 | # It is not intended to model geographical locations (roads, towns, |
| 821 | # mountains). |
| 822 | # |
| 823 | # In typical usage an address would be created via user input or from importing |
| 824 | # existing data, depending on the type of process. |
| 825 | # |
| 826 | # Advice on address input / editing: |
| 827 | # - Use an i18n-ready address widget such as |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 828 | # https://github.com/google/libaddressinput) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 829 | # - Users should not be presented with UI elements for input or editing of |
| 830 | # fields outside countries where that field is used. |
| 831 | # |
| 832 | # For more guidance on how to use this schema, please see: |
| 833 | # https://support.google.com/business/answer/6397478 |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 834 | "sublocality": "A String", # Optional. Sublocality of the address. |
| 835 | # For example, this can be neighborhoods, boroughs, districts. |
| 836 | "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is |
| 837 | # the latest revision. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 838 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 839 | # All new revisions **must** be backward compatible with old revisions. |
| 840 | "locality": "A String", # Optional. Generally refers to the city/town portion of the address. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 841 | # Examples: US city, IT comune, UK post town. |
| 842 | # In regions of the world where localities are not well defined or do not fit |
| 843 | # into this structure well, leave locality empty and use address_lines. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 844 | "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 845 | # addresses of a country or region. |
| 846 | # For example, this can be a state, a province, an oblast, or a prefecture. |
| 847 | # Specifically, for Spain this is the province and not the autonomous |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 848 | # community (e.g. "Barcelona" and not "Catalonia"). |
| 849 | # Many countries don't use an administrative area in postal addresses. E.g. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 850 | # in Switzerland this should be left unpopulated. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 851 | "organization": "A String", # Optional. The name of the organization at the address. |
| 852 | "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This |
| 853 | # is never inferred and it is up to the user to ensure the value is |
| 854 | # correct. See http://cldr.unicode.org/ and |
| 855 | # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html |
| 856 | # for details. Example: "CH" for Switzerland. |
| 857 | "addressLines": [ # Unstructured address lines describing the lower levels of an address. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 858 | # |
| 859 | # Because values in address_lines do not have type information and may |
| 860 | # sometimes contain multiple values in a single field (e.g. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 861 | # "Austin, TX"), it is important that the line order is clear. The order of |
| 862 | # address lines should be "envelope order" for the country/region of the |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 863 | # address. In places where this can vary (e.g. Japan), address_language is |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 864 | # used to make it explicit (e.g. "ja" for large-to-small ordering and |
| 865 | # "ja-Latn" or "en" for small-to-large). This way, the most specific line of |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 866 | # an address can be selected based on the language. |
| 867 | # |
| 868 | # The minimum permitted structural representation of an address consists |
| 869 | # of a region_code with all remaining information placed in the |
| 870 | # address_lines. It would be possible to format such an address very |
| 871 | # approximately without geocoding, but no semantic reasoning could be |
| 872 | # made about any of the address components until it was at least |
| 873 | # partially resolved. |
| 874 | # |
| 875 | # Creating an address only containing a region_code and address_lines, and |
| 876 | # then geocoding is the recommended way to handle completely unstructured |
| 877 | # addresses (as opposed to guessing which parts of the address should be |
| 878 | # localities or administrative areas). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 879 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 880 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 881 | "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 882 | # postal codes to be present, but where they are used, they may trigger |
| 883 | # additional validation with other parts of the address (e.g. state/zip |
| 884 | # validation in the U.S.A.). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 885 | "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if |
| 886 | # known). This is often the UI language of the input form or is expected |
| 887 | # to match one of the languages used in the address' country/region, or their |
| 888 | # transliterated equivalents. |
| 889 | # This can affect formatting in certain countries, but is not critical |
| 890 | # to the correctness of the data and will never affect any validation or |
| 891 | # other non-formatting related operations. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 892 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 893 | # If this value is not known, it should be omitted (rather than specifying a |
| 894 | # possibly incorrect default). |
| 895 | # |
| 896 | # Examples: "zh-Hant", "ja", "ja-Latn", "en". |
| 897 | "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used |
| 898 | # in most regions. Where it is used, the value is either a string like |
| 899 | # "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number |
| 900 | # alone, representing the "sector code" (Jamaica), "delivery area indicator" |
| 901 | # (Malawi) or "post office indicator" (e.g. Côte d'Ivoire). |
| 902 | "recipients": [ # Optional. The recipient at the address. |
| 903 | # This field may, under certain circumstances, contain multiline information. |
| 904 | # For example, it might contain "care of" information. |
| 905 | "A String", |
| 906 | ], |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 907 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 908 | "locationType": "A String", # The type of a location, which corresponds to the address lines field of |
| 909 | # PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of |
| 910 | # LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of |
| 911 | # LocationType#LOCALITY. |
| 912 | "radiusInMiles": 3.14, # Radius in miles of the job location. This value is derived from the |
| 913 | # location bounding box in which a circle with the specified radius |
| 914 | # centered from LatLng covers the area associated with the job location. |
| 915 | # For example, currently, "Mountain View, CA, USA" has a radius of |
| 916 | # 6.17 miles. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 917 | }, |
| 918 | ], |
| 919 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 920 | "employmentTypes": [ # Optional. The employment type(s) of a job, for example, |
| 921 | # full time or |
| 922 | # part time. |
| 923 | "A String", |
| 924 | ], |
| 925 | "incentives": "A String", # Optional. A description of bonus, commission, and other compensation |
| 926 | # incentives associated with the job not including salary or pay. |
| 927 | # |
| 928 | # The maximum number of allowed characters is 10,000. |
| 929 | "postingCreateTime": "A String", # Output only. The timestamp when this job posting was created. |
| 930 | "addresses": [ # Optional but strongly recommended for the best service experience. |
| 931 | # |
| 932 | # Location(s) where the employer is looking to hire for this job posting. |
| 933 | # |
| 934 | # Specifying the full street address(es) of the hiring location enables |
| 935 | # better API results, especially job searches by commute time. |
| 936 | # |
| 937 | # At most 50 locations are allowed for best search performance. If a job has |
| 938 | # more locations, it is suggested to split it into multiple jobs with unique |
| 939 | # requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as |
| 940 | # multiple jobs with the same company_name, language_code and |
| 941 | # requisition_id are not allowed. If the original requisition_id must |
| 942 | # be preserved, a custom field should be used for storage. It is also |
| 943 | # suggested to group the locations that close to each other in the same job |
| 944 | # for better search experience. |
| 945 | # |
| 946 | # The maximum number of allowed characters is 500. |
| 947 | "A String", |
| 948 | ], |
| 949 | "companyName": "A String", # Required. The resource name of the company listing the job, such as |
| 950 | # "projects/api-test-project/companies/foo". |
| 951 | "description": "A String", # Required. The description of the job, which typically includes a multi-paragraph |
| 952 | # description of the company and related information. Separate fields are |
| 953 | # provided on the job object for responsibilities, |
| 954 | # qualifications, and other job characteristics. Use of |
| 955 | # these separate job fields is recommended. |
| 956 | # |
| 957 | # This field accepts and sanitizes HTML input, and also accepts |
| 958 | # bold, italic, ordered list, and unordered list markup tags. |
| 959 | # |
| 960 | # The maximum number of allowed characters is 100,000. |
| 961 | "jobStartTime": "A String", # Optional. The start timestamp of the job in UTC time zone. Typically this field |
| 962 | # is used for contracting engagements. Invalid timestamps are ignored. |
| 963 | "degreeTypes": [ # Optional. The desired education degrees for the job, such as Bachelors, Masters. |
| 964 | "A String", |
| 965 | ], |
| 966 | "compensationInfo": { # Job compensation details. # Optional. Job compensation information. |
| 967 | "annualizedBaseCompensationRange": { # Compensation range. # Output only. Annualized base compensation range. Computed as |
| 968 | # base compensation entry's CompensationEntry.compensation times |
| 969 | # CompensationEntry.expected_units_per_year. |
| 970 | # |
| 971 | # See CompensationEntry for explanation on compensation annualization. |
| 972 | "maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set |
| 973 | # to a maximal compensation value and the currency code is set to |
| 974 | # match the currency code of |
| 975 | # min_compensation. |
| 976 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 977 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 978 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 979 | # If `units` is positive, `nanos` must be positive or zero. |
| 980 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 981 | # If `units` is negative, `nanos` must be negative or zero. |
| 982 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 983 | "units": "A String", # The whole units of the amount. |
| 984 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 985 | }, |
| 986 | "minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set |
| 987 | # to zero and the currency code is set to match the |
| 988 | # currency code of max_compensation. |
| 989 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 990 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 991 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 992 | # If `units` is positive, `nanos` must be positive or zero. |
| 993 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 994 | # If `units` is negative, `nanos` must be negative or zero. |
| 995 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 996 | "units": "A String", # The whole units of the amount. |
| 997 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 998 | }, |
| 999 | }, |
| 1000 | "annualizedTotalCompensationRange": { # Compensation range. # Output only. Annualized total compensation range. Computed as |
| 1001 | # all compensation entries' CompensationEntry.compensation times |
| 1002 | # CompensationEntry.expected_units_per_year. |
| 1003 | # |
| 1004 | # See CompensationEntry for explanation on compensation annualization. |
| 1005 | "maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set |
| 1006 | # to a maximal compensation value and the currency code is set to |
| 1007 | # match the currency code of |
| 1008 | # min_compensation. |
| 1009 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 1010 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 1011 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 1012 | # If `units` is positive, `nanos` must be positive or zero. |
| 1013 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 1014 | # If `units` is negative, `nanos` must be negative or zero. |
| 1015 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 1016 | "units": "A String", # The whole units of the amount. |
| 1017 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 1018 | }, |
| 1019 | "minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set |
| 1020 | # to zero and the currency code is set to match the |
| 1021 | # currency code of max_compensation. |
| 1022 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 1023 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 1024 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 1025 | # If `units` is positive, `nanos` must be positive or zero. |
| 1026 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 1027 | # If `units` is negative, `nanos` must be negative or zero. |
| 1028 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 1029 | "units": "A String", # The whole units of the amount. |
| 1030 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 1031 | }, |
| 1032 | }, |
| 1033 | "entries": [ # Optional. Job compensation information. |
| 1034 | # |
| 1035 | # At most one entry can be of type |
| 1036 | # CompensationInfo.CompensationType.BASE, which is |
| 1037 | # referred as ** base compensation entry ** for the job. |
| 1038 | { # A compensation entry that represents one component of compensation, such |
| 1039 | # as base pay, bonus, or other compensation type. |
| 1040 | # |
| 1041 | # Annualization: One compensation entry can be annualized if |
| 1042 | # - it contains valid amount or range. |
| 1043 | # - and its expected_units_per_year is set or can be derived. |
| 1044 | # Its annualized range is determined as (amount or range) times |
| 1045 | # expected_units_per_year. |
| 1046 | "unit": "A String", # Optional. Frequency of the specified amount. |
| 1047 | # |
| 1048 | # Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED. |
| 1049 | "amount": { # Represents an amount of money with its currency type. # Optional. Compensation amount. |
| 1050 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 1051 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 1052 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 1053 | # If `units` is positive, `nanos` must be positive or zero. |
| 1054 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 1055 | # If `units` is negative, `nanos` must be negative or zero. |
| 1056 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 1057 | "units": "A String", # The whole units of the amount. |
| 1058 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 1059 | }, |
| 1060 | "type": "A String", # Optional. Compensation type. |
| 1061 | # |
| 1062 | # Default is CompensationUnit.COMPENSATION_TYPE_UNSPECIFIED. |
| 1063 | "range": { # Compensation range. # Optional. Compensation range. |
| 1064 | "maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set |
| 1065 | # to a maximal compensation value and the currency code is set to |
| 1066 | # match the currency code of |
| 1067 | # min_compensation. |
| 1068 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 1069 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 1070 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 1071 | # If `units` is positive, `nanos` must be positive or zero. |
| 1072 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 1073 | # If `units` is negative, `nanos` must be negative or zero. |
| 1074 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 1075 | "units": "A String", # The whole units of the amount. |
| 1076 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 1077 | }, |
| 1078 | "minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set |
| 1079 | # to zero and the currency code is set to match the |
| 1080 | # currency code of max_compensation. |
| 1081 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 1082 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 1083 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 1084 | # If `units` is positive, `nanos` must be positive or zero. |
| 1085 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 1086 | # If `units` is negative, `nanos` must be negative or zero. |
| 1087 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 1088 | "units": "A String", # The whole units of the amount. |
| 1089 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 1090 | }, |
| 1091 | }, |
| 1092 | "expectedUnitsPerYear": 3.14, # Optional. Expected number of units paid each year. If not specified, when |
| 1093 | # Job.employment_types is FULLTIME, a default value is inferred |
| 1094 | # based on unit. Default values: |
| 1095 | # - HOURLY: 2080 |
| 1096 | # - DAILY: 260 |
| 1097 | # - WEEKLY: 52 |
| 1098 | # - MONTHLY: 12 |
| 1099 | # - ANNUAL: 1 |
| 1100 | "description": "A String", # Optional. Compensation description. For example, could |
| 1101 | # indicate equity terms or provide additional context to an estimated |
| 1102 | # bonus. |
| 1103 | }, |
| 1104 | ], |
| 1105 | }, |
| 1106 | "responsibilities": "A String", # Optional. A description of job responsibilities. The use of this field is |
| 1107 | # recommended as an alternative to using the more general description |
| 1108 | # field. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1109 | # |
| 1110 | # This field accepts and sanitizes HTML input, and also accepts |
| 1111 | # bold, italic, ordered list, and unordered list markup tags. |
| 1112 | # |
| 1113 | # The maximum number of allowed characters is 10,000. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1114 | "department": "A String", # Optional. The department or functional area within the company with the open |
| 1115 | # position. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1116 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1117 | # The maximum number of allowed characters is 255. |
| 1118 | "applicationInfo": { # Application related details of a job posting. # Required. At least one field within ApplicationInfo must be specified. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1119 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1120 | # Job application information. |
| 1121 | "uris": [ # Optional but at least one of uris, |
| 1122 | # emails or instruction must be |
| 1123 | # specified. |
| 1124 | # |
| 1125 | # Use this URI field to direct an applicant to a website, for example to |
| 1126 | # link to an online application form. |
| 1127 | # |
| 1128 | # The maximum number of allowed characters for each entry is 2,000. |
| 1129 | "A String", |
| 1130 | ], |
| 1131 | "emails": [ # Optional but at least one of uris, |
| 1132 | # emails or instruction must be |
| 1133 | # specified. |
| 1134 | # |
| 1135 | # Use this field to specify email address(es) to which resumes or |
| 1136 | # applications can be sent. |
| 1137 | # |
| 1138 | # The maximum number of allowed characters for each entry is 255. |
| 1139 | "A String", |
| 1140 | ], |
| 1141 | "instruction": "A String", # Optional but at least one of uris, |
| 1142 | # emails or instruction must be |
| 1143 | # specified. |
| 1144 | # |
| 1145 | # Use this field to provide instructions, such as "Mail your application |
| 1146 | # to ...", that a candidate can follow to apply for the job. |
| 1147 | # |
| 1148 | # This field accepts and sanitizes HTML input, and also accepts |
| 1149 | # bold, italic, ordered list, and unordered list markup tags. |
| 1150 | # |
| 1151 | # The maximum number of allowed characters is 3,000. |
| 1152 | }, |
| 1153 | "postingExpireTime": "A String", # Optional but strongly recommended for the best service |
| 1154 | # experience. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1155 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1156 | # The expiration timestamp of the job. After this timestamp, the |
| 1157 | # job is marked as expired, and it no longer appears in search results. The |
| 1158 | # expired job can't be deleted or listed by the DeleteJob and |
| 1159 | # ListJobs APIs, but it can be retrieved with the GetJob API or |
| 1160 | # updated with the UpdateJob API. An expired job can be updated and |
| 1161 | # opened again by using a future expiration timestamp. Updating an expired |
| 1162 | # job fails if there is another existing open job with same company_name, |
| 1163 | # language_code and requisition_id. |
| 1164 | # |
| 1165 | # The expired jobs are retained in our system for 90 days. However, the |
| 1166 | # overall expired job count cannot exceed 3 times the maximum of open jobs |
| 1167 | # count over the past week, otherwise jobs with earlier expire time are |
| 1168 | # cleaned first. Expired jobs are no longer accessible after they are cleaned |
| 1169 | # out. |
| 1170 | # |
| 1171 | # Invalid timestamps are ignored, and treated as expire time not provided. |
| 1172 | # |
| 1173 | # Timestamp before the instant request is made is considered valid, the job |
| 1174 | # will be treated as expired immediately. |
| 1175 | # |
| 1176 | # If this value is not provided at the time of job creation or is invalid, |
| 1177 | # the job posting expires after 30 days from the job's creation time. For |
| 1178 | # example, if the job was created on 2017/01/01 13:00AM UTC with an |
| 1179 | # unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC. |
| 1180 | # |
| 1181 | # If this value is not provided on job update, it depends on the field masks |
| 1182 | # set by UpdateJobRequest.update_mask. If the field masks include |
| 1183 | # expiry_time, or the masks are empty meaning that every field is |
| 1184 | # updated, the job posting expires after 30 days from the job's last |
| 1185 | # update time. Otherwise the expiration date isn't updated. |
| 1186 | "postingRegion": "A String", # Optional. The job PostingRegion (for example, state, country) throughout which |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1187 | # the job is available. If this field is set, a |
| 1188 | # LocationFilter in a search query within the job region |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1189 | # finds this job posting if an exact location match isn't specified. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1190 | # If this field is set to PostingRegion.NATION or |
| 1191 | # PostingRegion.ADMINISTRATIVE_AREA, setting job Job.addresses |
| 1192 | # to the same location level as this field is strongly recommended. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1193 | "postingPublishTime": "A String", # Optional. The timestamp this job posting was most recently published. The default |
| 1194 | # value is the time the request arrives at the server. Invalid timestamps are |
| 1195 | # ignored. |
| 1196 | "customAttributes": { # Optional. A map of fields to hold both filterable and non-filterable custom job |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1197 | # attributes that are not covered by the provided structured fields. |
| 1198 | # |
| 1199 | # The keys of the map are strings up to 64 bytes and must match the |
| 1200 | # pattern: a-zA-Z*. For example, key0LikeThis or |
| 1201 | # KEY_1_LIKE_THIS. |
| 1202 | # |
| 1203 | # At most 100 filterable and at most 100 unfilterable keys are supported. |
| 1204 | # For filterable `string_values`, across all keys at most 200 values are |
| 1205 | # allowed, with each string no more than 255 characters. For unfilterable |
| 1206 | # `string_values`, the maximum total size of `string_values` across all keys |
| 1207 | # is 50KB. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1208 | "a_key": { # Custom attribute values that are either filterable or non-filterable. |
| 1209 | "stringValues": [ # Optional but exactly one of string_values or long_values must |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1210 | # be specified. |
| 1211 | # |
| 1212 | # This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or |
| 1213 | # `CASE_INSENSITIVE_MATCH`) search. |
| 1214 | # For filterable `string_value`s, a maximum total number of 200 values |
| 1215 | # is allowed, with each `string_value` has a byte size of no more than |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1216 | # 500B. For unfilterable `string_values`, the maximum total byte size of |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1217 | # unfilterable `string_values` is 50KB. |
| 1218 | # |
| 1219 | # Empty string is not allowed. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1220 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1221 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1222 | "filterable": True or False, # Optional. If the `filterable` flag is true, the custom field values may be used for |
| 1223 | # custom attribute filters JobQuery.custom_attribute_filter. |
| 1224 | # If false, these values may not be used for custom attribute filters. |
| 1225 | # |
| 1226 | # Default is false. |
| 1227 | "longValues": [ # Optional but exactly one of string_values or long_values must |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1228 | # be specified. |
| 1229 | # |
| 1230 | # This field is used to perform number range search. |
| 1231 | # (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`. |
| 1232 | # |
| 1233 | # Currently at most 1 long_values is supported. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1234 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1235 | ], |
| 1236 | }, |
| 1237 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1238 | }</pre> |
| 1239 | </div> |
| 1240 | |
| 1241 | <div class="method"> |
| 1242 | <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| 1243 | <pre>Deletes the specified job. |
| 1244 | |
| 1245 | Typically, the job becomes unsearchable within 10 seconds, but it may take |
| 1246 | up to 5 minutes. |
| 1247 | |
| 1248 | Args: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1249 | name: string, Required. The resource name of the job to be deleted. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1250 | |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1251 | The format is "projects/{project_id}/jobs/{job_id}", |
| 1252 | for example, "projects/api-test-project/jobs/1234". (required) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1253 | x__xgafv: string, V1 error format. |
| 1254 | Allowed values |
| 1255 | 1 - v1 error format |
| 1256 | 2 - v2 error format |
| 1257 | |
| 1258 | Returns: |
| 1259 | An object of the form: |
| 1260 | |
| 1261 | { # A generic empty message that you can re-use to avoid defining duplicated |
| 1262 | # empty messages in your APIs. A typical example is to use it as the request |
| 1263 | # or the response type of an API method. For instance: |
| 1264 | # |
| 1265 | # service Foo { |
| 1266 | # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); |
| 1267 | # } |
| 1268 | # |
| 1269 | # The JSON representation for `Empty` is empty JSON object `{}`. |
| 1270 | }</pre> |
| 1271 | </div> |
| 1272 | |
| 1273 | <div class="method"> |
| 1274 | <code class="details" id="get">get(name, x__xgafv=None)</code> |
| 1275 | <pre>Retrieves the specified job, whose status is OPEN or recently EXPIRED |
| 1276 | within the last 90 days. |
| 1277 | |
| 1278 | Args: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1279 | name: string, Required. The resource name of the job to retrieve. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1280 | |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1281 | The format is "projects/{project_id}/jobs/{job_id}", |
| 1282 | for example, "projects/api-test-project/jobs/1234". (required) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1283 | x__xgafv: string, V1 error format. |
| 1284 | Allowed values |
| 1285 | 1 - v1 error format |
| 1286 | 2 - v2 error format |
| 1287 | |
| 1288 | Returns: |
| 1289 | An object of the form: |
| 1290 | |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1291 | { # A Job resource represents a job posting (also referred to as a "job listing" |
| 1292 | # or "job requisition"). A job belongs to a Company, which is the hiring |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1293 | # entity responsible for the job. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1294 | "jobLevel": "A String", # Optional. The experience level associated with the job, such as "Entry Level". |
| 1295 | "languageCode": "A String", # Optional. The language of the posting. This field is distinct from |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1296 | # any requirements for fluency that are associated with the job. |
| 1297 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1298 | # Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn". |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1299 | # For more information, see |
| 1300 | # [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1301 | # class="external" target="_blank" }. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1302 | # |
| 1303 | # If this field is unspecified and Job.description is present, detected |
| 1304 | # language code based on Job.description is assigned, otherwise |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1305 | # defaults to 'en_US'. |
| 1306 | "postingUpdateTime": "A String", # Output only. The timestamp when this job posting was last updated. |
| 1307 | "visibility": "A String", # Deprecated. The job is only visible to the owner. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1308 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1309 | # The visibility of the job. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1310 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1311 | # Defaults to Visibility.ACCOUNT_ONLY if not specified. |
| 1312 | "name": "A String", # Required during job update. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1313 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1314 | # The resource name for the job. This is generated by the service when a |
| 1315 | # job is created. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1316 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1317 | # The format is "projects/{project_id}/jobs/{job_id}", |
| 1318 | # for example, "projects/api-test-project/jobs/1234". |
| 1319 | # |
| 1320 | # Use of this field in job queries and API calls is preferred over the use of |
| 1321 | # requisition_id since this value is unique. |
| 1322 | "jobBenefits": [ # Optional. The benefits included with the job. |
| 1323 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1324 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1325 | "promotionValue": 42, # Optional. A promotion value of the job, as determined by the client. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1326 | # The value determines the sort order of the jobs returned when searching for |
| 1327 | # jobs using the featured jobs search call, with higher promotional values |
| 1328 | # being returned first and ties being resolved by relevance sort. Only the |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1329 | # jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1330 | # |
| 1331 | # Default value is 0, and negative values are treated as 0. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1332 | "title": "A String", # Required. The title of the job, such as "Software Engineer" |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1333 | # |
| 1334 | # The maximum number of allowed characters is 500. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1335 | "companyDisplayName": "A String", # Output only. Display name of the company listing the job. |
| 1336 | "requisitionId": "A String", # Required. The requisition ID, also referred to as the posting ID, assigned by the |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1337 | # client to identify a job. This field is intended to be used by clients |
| 1338 | # for client identification and tracking of postings. A job is not allowed |
| 1339 | # to be created if there is another job with the same [company_name], |
| 1340 | # language_code and requisition_id. |
| 1341 | # |
| 1342 | # The maximum number of allowed characters is 255. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1343 | "qualifications": "A String", # Optional. A description of the qualifications required to perform the |
| 1344 | # job. The use of this field is recommended |
| 1345 | # as an alternative to using the more general description field. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1346 | # |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1347 | # This field accepts and sanitizes HTML input, and also accepts |
| 1348 | # bold, italic, ordered list, and unordered list markup tags. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1349 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1350 | # The maximum number of allowed characters is 10,000. |
| 1351 | "processingOptions": { # Input only. # Optional. Options for job processing. |
| 1352 | # |
| 1353 | # Options for job processing. |
| 1354 | "disableStreetAddressResolution": True or False, # Optional. If set to `true`, the service does not attempt to resolve a |
| 1355 | # more precise address for the job. |
| 1356 | "htmlSanitization": "A String", # Optional. Option for job HTML content sanitization. Applied fields are: |
| 1357 | # |
| 1358 | # * description |
| 1359 | # * applicationInfo.instruction |
| 1360 | # * incentives |
| 1361 | # * qualifications |
| 1362 | # * responsibilities |
| 1363 | # |
| 1364 | # HTML tags in these fields may be stripped if sanitiazation is not |
| 1365 | # disabled. |
| 1366 | # |
| 1367 | # Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY. |
| 1368 | }, |
| 1369 | "jobEndTime": "A String", # Optional. The end timestamp of the job. Typically this field is used for contracting |
| 1370 | # engagements. Invalid timestamps are ignored. |
| 1371 | "derivedInfo": { # Output only. # Output only. Derived details about the job posting. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1372 | # |
| 1373 | # Derived details about the job posting. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1374 | "jobCategories": [ # Job categories derived from Job.title and Job.description. |
| 1375 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1376 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1377 | "locations": [ # Structured locations of the job, resolved from Job.addresses. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1378 | # |
| 1379 | # locations are exactly matched to Job.addresses in the same |
| 1380 | # order. |
| 1381 | { # Output only. |
| 1382 | # |
| 1383 | # A resource that represents a location with full geographic information. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1384 | "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1385 | # of doubles representing degrees latitude and degrees longitude. Unless |
| 1386 | # specified otherwise, this must conform to the |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1387 | # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1388 | # standard</a>. Values must be within normalized ranges. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1389 | "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. |
| 1390 | "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1391 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1392 | "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1393 | # such as postal delivery and payments addresses. Given a postal address, |
| 1394 | # a postal service can deliver items to a premises, P.O. Box, or other |
| 1395 | # delivery location. |
| 1396 | # Given a postal address, a postal service can deliver items to a premise, P.O. |
| 1397 | # Box or similar. |
| 1398 | # It is not intended to model geographical locations (roads, towns, |
| 1399 | # mountains). |
| 1400 | # |
| 1401 | # In typical usage an address would be created via user input or from importing |
| 1402 | # existing data, depending on the type of process. |
| 1403 | # |
| 1404 | # Advice on address input / editing: |
| 1405 | # - Use an i18n-ready address widget such as |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1406 | # https://github.com/google/libaddressinput) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1407 | # - Users should not be presented with UI elements for input or editing of |
| 1408 | # fields outside countries where that field is used. |
| 1409 | # |
| 1410 | # For more guidance on how to use this schema, please see: |
| 1411 | # https://support.google.com/business/answer/6397478 |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1412 | "sublocality": "A String", # Optional. Sublocality of the address. |
| 1413 | # For example, this can be neighborhoods, boroughs, districts. |
| 1414 | "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is |
| 1415 | # the latest revision. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1416 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1417 | # All new revisions **must** be backward compatible with old revisions. |
| 1418 | "locality": "A String", # Optional. Generally refers to the city/town portion of the address. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1419 | # Examples: US city, IT comune, UK post town. |
| 1420 | # In regions of the world where localities are not well defined or do not fit |
| 1421 | # into this structure well, leave locality empty and use address_lines. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1422 | "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1423 | # addresses of a country or region. |
| 1424 | # For example, this can be a state, a province, an oblast, or a prefecture. |
| 1425 | # Specifically, for Spain this is the province and not the autonomous |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1426 | # community (e.g. "Barcelona" and not "Catalonia"). |
| 1427 | # Many countries don't use an administrative area in postal addresses. E.g. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1428 | # in Switzerland this should be left unpopulated. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1429 | "organization": "A String", # Optional. The name of the organization at the address. |
| 1430 | "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This |
| 1431 | # is never inferred and it is up to the user to ensure the value is |
| 1432 | # correct. See http://cldr.unicode.org/ and |
| 1433 | # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html |
| 1434 | # for details. Example: "CH" for Switzerland. |
| 1435 | "addressLines": [ # Unstructured address lines describing the lower levels of an address. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1436 | # |
| 1437 | # Because values in address_lines do not have type information and may |
| 1438 | # sometimes contain multiple values in a single field (e.g. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1439 | # "Austin, TX"), it is important that the line order is clear. The order of |
| 1440 | # address lines should be "envelope order" for the country/region of the |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1441 | # address. In places where this can vary (e.g. Japan), address_language is |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1442 | # used to make it explicit (e.g. "ja" for large-to-small ordering and |
| 1443 | # "ja-Latn" or "en" for small-to-large). This way, the most specific line of |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1444 | # an address can be selected based on the language. |
| 1445 | # |
| 1446 | # The minimum permitted structural representation of an address consists |
| 1447 | # of a region_code with all remaining information placed in the |
| 1448 | # address_lines. It would be possible to format such an address very |
| 1449 | # approximately without geocoding, but no semantic reasoning could be |
| 1450 | # made about any of the address components until it was at least |
| 1451 | # partially resolved. |
| 1452 | # |
| 1453 | # Creating an address only containing a region_code and address_lines, and |
| 1454 | # then geocoding is the recommended way to handle completely unstructured |
| 1455 | # addresses (as opposed to guessing which parts of the address should be |
| 1456 | # localities or administrative areas). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1457 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1458 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1459 | "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1460 | # postal codes to be present, but where they are used, they may trigger |
| 1461 | # additional validation with other parts of the address (e.g. state/zip |
| 1462 | # validation in the U.S.A.). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1463 | "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if |
| 1464 | # known). This is often the UI language of the input form or is expected |
| 1465 | # to match one of the languages used in the address' country/region, or their |
| 1466 | # transliterated equivalents. |
| 1467 | # This can affect formatting in certain countries, but is not critical |
| 1468 | # to the correctness of the data and will never affect any validation or |
| 1469 | # other non-formatting related operations. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1470 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1471 | # If this value is not known, it should be omitted (rather than specifying a |
| 1472 | # possibly incorrect default). |
| 1473 | # |
| 1474 | # Examples: "zh-Hant", "ja", "ja-Latn", "en". |
| 1475 | "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used |
| 1476 | # in most regions. Where it is used, the value is either a string like |
| 1477 | # "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number |
| 1478 | # alone, representing the "sector code" (Jamaica), "delivery area indicator" |
| 1479 | # (Malawi) or "post office indicator" (e.g. Côte d'Ivoire). |
| 1480 | "recipients": [ # Optional. The recipient at the address. |
| 1481 | # This field may, under certain circumstances, contain multiline information. |
| 1482 | # For example, it might contain "care of" information. |
| 1483 | "A String", |
| 1484 | ], |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1485 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1486 | "locationType": "A String", # The type of a location, which corresponds to the address lines field of |
| 1487 | # PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of |
| 1488 | # LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of |
| 1489 | # LocationType#LOCALITY. |
| 1490 | "radiusInMiles": 3.14, # Radius in miles of the job location. This value is derived from the |
| 1491 | # location bounding box in which a circle with the specified radius |
| 1492 | # centered from LatLng covers the area associated with the job location. |
| 1493 | # For example, currently, "Mountain View, CA, USA" has a radius of |
| 1494 | # 6.17 miles. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1495 | }, |
| 1496 | ], |
| 1497 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1498 | "employmentTypes": [ # Optional. The employment type(s) of a job, for example, |
| 1499 | # full time or |
| 1500 | # part time. |
| 1501 | "A String", |
| 1502 | ], |
| 1503 | "incentives": "A String", # Optional. A description of bonus, commission, and other compensation |
| 1504 | # incentives associated with the job not including salary or pay. |
| 1505 | # |
| 1506 | # The maximum number of allowed characters is 10,000. |
| 1507 | "postingCreateTime": "A String", # Output only. The timestamp when this job posting was created. |
| 1508 | "addresses": [ # Optional but strongly recommended for the best service experience. |
| 1509 | # |
| 1510 | # Location(s) where the employer is looking to hire for this job posting. |
| 1511 | # |
| 1512 | # Specifying the full street address(es) of the hiring location enables |
| 1513 | # better API results, especially job searches by commute time. |
| 1514 | # |
| 1515 | # At most 50 locations are allowed for best search performance. If a job has |
| 1516 | # more locations, it is suggested to split it into multiple jobs with unique |
| 1517 | # requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as |
| 1518 | # multiple jobs with the same company_name, language_code and |
| 1519 | # requisition_id are not allowed. If the original requisition_id must |
| 1520 | # be preserved, a custom field should be used for storage. It is also |
| 1521 | # suggested to group the locations that close to each other in the same job |
| 1522 | # for better search experience. |
| 1523 | # |
| 1524 | # The maximum number of allowed characters is 500. |
| 1525 | "A String", |
| 1526 | ], |
| 1527 | "companyName": "A String", # Required. The resource name of the company listing the job, such as |
| 1528 | # "projects/api-test-project/companies/foo". |
| 1529 | "description": "A String", # Required. The description of the job, which typically includes a multi-paragraph |
| 1530 | # description of the company and related information. Separate fields are |
| 1531 | # provided on the job object for responsibilities, |
| 1532 | # qualifications, and other job characteristics. Use of |
| 1533 | # these separate job fields is recommended. |
| 1534 | # |
| 1535 | # This field accepts and sanitizes HTML input, and also accepts |
| 1536 | # bold, italic, ordered list, and unordered list markup tags. |
| 1537 | # |
| 1538 | # The maximum number of allowed characters is 100,000. |
| 1539 | "jobStartTime": "A String", # Optional. The start timestamp of the job in UTC time zone. Typically this field |
| 1540 | # is used for contracting engagements. Invalid timestamps are ignored. |
| 1541 | "degreeTypes": [ # Optional. The desired education degrees for the job, such as Bachelors, Masters. |
| 1542 | "A String", |
| 1543 | ], |
| 1544 | "compensationInfo": { # Job compensation details. # Optional. Job compensation information. |
| 1545 | "annualizedBaseCompensationRange": { # Compensation range. # Output only. Annualized base compensation range. Computed as |
| 1546 | # base compensation entry's CompensationEntry.compensation times |
| 1547 | # CompensationEntry.expected_units_per_year. |
| 1548 | # |
| 1549 | # See CompensationEntry for explanation on compensation annualization. |
| 1550 | "maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set |
| 1551 | # to a maximal compensation value and the currency code is set to |
| 1552 | # match the currency code of |
| 1553 | # min_compensation. |
| 1554 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 1555 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 1556 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 1557 | # If `units` is positive, `nanos` must be positive or zero. |
| 1558 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 1559 | # If `units` is negative, `nanos` must be negative or zero. |
| 1560 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 1561 | "units": "A String", # The whole units of the amount. |
| 1562 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 1563 | }, |
| 1564 | "minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set |
| 1565 | # to zero and the currency code is set to match the |
| 1566 | # currency code of max_compensation. |
| 1567 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 1568 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 1569 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 1570 | # If `units` is positive, `nanos` must be positive or zero. |
| 1571 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 1572 | # If `units` is negative, `nanos` must be negative or zero. |
| 1573 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 1574 | "units": "A String", # The whole units of the amount. |
| 1575 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 1576 | }, |
| 1577 | }, |
| 1578 | "annualizedTotalCompensationRange": { # Compensation range. # Output only. Annualized total compensation range. Computed as |
| 1579 | # all compensation entries' CompensationEntry.compensation times |
| 1580 | # CompensationEntry.expected_units_per_year. |
| 1581 | # |
| 1582 | # See CompensationEntry for explanation on compensation annualization. |
| 1583 | "maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set |
| 1584 | # to a maximal compensation value and the currency code is set to |
| 1585 | # match the currency code of |
| 1586 | # min_compensation. |
| 1587 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 1588 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 1589 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 1590 | # If `units` is positive, `nanos` must be positive or zero. |
| 1591 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 1592 | # If `units` is negative, `nanos` must be negative or zero. |
| 1593 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 1594 | "units": "A String", # The whole units of the amount. |
| 1595 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 1596 | }, |
| 1597 | "minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set |
| 1598 | # to zero and the currency code is set to match the |
| 1599 | # currency code of max_compensation. |
| 1600 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 1601 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 1602 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 1603 | # If `units` is positive, `nanos` must be positive or zero. |
| 1604 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 1605 | # If `units` is negative, `nanos` must be negative or zero. |
| 1606 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 1607 | "units": "A String", # The whole units of the amount. |
| 1608 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 1609 | }, |
| 1610 | }, |
| 1611 | "entries": [ # Optional. Job compensation information. |
| 1612 | # |
| 1613 | # At most one entry can be of type |
| 1614 | # CompensationInfo.CompensationType.BASE, which is |
| 1615 | # referred as ** base compensation entry ** for the job. |
| 1616 | { # A compensation entry that represents one component of compensation, such |
| 1617 | # as base pay, bonus, or other compensation type. |
| 1618 | # |
| 1619 | # Annualization: One compensation entry can be annualized if |
| 1620 | # - it contains valid amount or range. |
| 1621 | # - and its expected_units_per_year is set or can be derived. |
| 1622 | # Its annualized range is determined as (amount or range) times |
| 1623 | # expected_units_per_year. |
| 1624 | "unit": "A String", # Optional. Frequency of the specified amount. |
| 1625 | # |
| 1626 | # Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED. |
| 1627 | "amount": { # Represents an amount of money with its currency type. # Optional. Compensation amount. |
| 1628 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 1629 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 1630 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 1631 | # If `units` is positive, `nanos` must be positive or zero. |
| 1632 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 1633 | # If `units` is negative, `nanos` must be negative or zero. |
| 1634 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 1635 | "units": "A String", # The whole units of the amount. |
| 1636 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 1637 | }, |
| 1638 | "type": "A String", # Optional. Compensation type. |
| 1639 | # |
| 1640 | # Default is CompensationUnit.COMPENSATION_TYPE_UNSPECIFIED. |
| 1641 | "range": { # Compensation range. # Optional. Compensation range. |
| 1642 | "maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set |
| 1643 | # to a maximal compensation value and the currency code is set to |
| 1644 | # match the currency code of |
| 1645 | # min_compensation. |
| 1646 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 1647 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 1648 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 1649 | # If `units` is positive, `nanos` must be positive or zero. |
| 1650 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 1651 | # If `units` is negative, `nanos` must be negative or zero. |
| 1652 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 1653 | "units": "A String", # The whole units of the amount. |
| 1654 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 1655 | }, |
| 1656 | "minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set |
| 1657 | # to zero and the currency code is set to match the |
| 1658 | # currency code of max_compensation. |
| 1659 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 1660 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 1661 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 1662 | # If `units` is positive, `nanos` must be positive or zero. |
| 1663 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 1664 | # If `units` is negative, `nanos` must be negative or zero. |
| 1665 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 1666 | "units": "A String", # The whole units of the amount. |
| 1667 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 1668 | }, |
| 1669 | }, |
| 1670 | "expectedUnitsPerYear": 3.14, # Optional. Expected number of units paid each year. If not specified, when |
| 1671 | # Job.employment_types is FULLTIME, a default value is inferred |
| 1672 | # based on unit. Default values: |
| 1673 | # - HOURLY: 2080 |
| 1674 | # - DAILY: 260 |
| 1675 | # - WEEKLY: 52 |
| 1676 | # - MONTHLY: 12 |
| 1677 | # - ANNUAL: 1 |
| 1678 | "description": "A String", # Optional. Compensation description. For example, could |
| 1679 | # indicate equity terms or provide additional context to an estimated |
| 1680 | # bonus. |
| 1681 | }, |
| 1682 | ], |
| 1683 | }, |
| 1684 | "responsibilities": "A String", # Optional. A description of job responsibilities. The use of this field is |
| 1685 | # recommended as an alternative to using the more general description |
| 1686 | # field. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1687 | # |
| 1688 | # This field accepts and sanitizes HTML input, and also accepts |
| 1689 | # bold, italic, ordered list, and unordered list markup tags. |
| 1690 | # |
| 1691 | # The maximum number of allowed characters is 10,000. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1692 | "department": "A String", # Optional. The department or functional area within the company with the open |
| 1693 | # position. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1694 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1695 | # The maximum number of allowed characters is 255. |
| 1696 | "applicationInfo": { # Application related details of a job posting. # Required. At least one field within ApplicationInfo must be specified. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1697 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1698 | # Job application information. |
| 1699 | "uris": [ # Optional but at least one of uris, |
| 1700 | # emails or instruction must be |
| 1701 | # specified. |
| 1702 | # |
| 1703 | # Use this URI field to direct an applicant to a website, for example to |
| 1704 | # link to an online application form. |
| 1705 | # |
| 1706 | # The maximum number of allowed characters for each entry is 2,000. |
| 1707 | "A String", |
| 1708 | ], |
| 1709 | "emails": [ # Optional but at least one of uris, |
| 1710 | # emails or instruction must be |
| 1711 | # specified. |
| 1712 | # |
| 1713 | # Use this field to specify email address(es) to which resumes or |
| 1714 | # applications can be sent. |
| 1715 | # |
| 1716 | # The maximum number of allowed characters for each entry is 255. |
| 1717 | "A String", |
| 1718 | ], |
| 1719 | "instruction": "A String", # Optional but at least one of uris, |
| 1720 | # emails or instruction must be |
| 1721 | # specified. |
| 1722 | # |
| 1723 | # Use this field to provide instructions, such as "Mail your application |
| 1724 | # to ...", that a candidate can follow to apply for the job. |
| 1725 | # |
| 1726 | # This field accepts and sanitizes HTML input, and also accepts |
| 1727 | # bold, italic, ordered list, and unordered list markup tags. |
| 1728 | # |
| 1729 | # The maximum number of allowed characters is 3,000. |
| 1730 | }, |
| 1731 | "postingExpireTime": "A String", # Optional but strongly recommended for the best service |
| 1732 | # experience. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1733 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1734 | # The expiration timestamp of the job. After this timestamp, the |
| 1735 | # job is marked as expired, and it no longer appears in search results. The |
| 1736 | # expired job can't be deleted or listed by the DeleteJob and |
| 1737 | # ListJobs APIs, but it can be retrieved with the GetJob API or |
| 1738 | # updated with the UpdateJob API. An expired job can be updated and |
| 1739 | # opened again by using a future expiration timestamp. Updating an expired |
| 1740 | # job fails if there is another existing open job with same company_name, |
| 1741 | # language_code and requisition_id. |
| 1742 | # |
| 1743 | # The expired jobs are retained in our system for 90 days. However, the |
| 1744 | # overall expired job count cannot exceed 3 times the maximum of open jobs |
| 1745 | # count over the past week, otherwise jobs with earlier expire time are |
| 1746 | # cleaned first. Expired jobs are no longer accessible after they are cleaned |
| 1747 | # out. |
| 1748 | # |
| 1749 | # Invalid timestamps are ignored, and treated as expire time not provided. |
| 1750 | # |
| 1751 | # Timestamp before the instant request is made is considered valid, the job |
| 1752 | # will be treated as expired immediately. |
| 1753 | # |
| 1754 | # If this value is not provided at the time of job creation or is invalid, |
| 1755 | # the job posting expires after 30 days from the job's creation time. For |
| 1756 | # example, if the job was created on 2017/01/01 13:00AM UTC with an |
| 1757 | # unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC. |
| 1758 | # |
| 1759 | # If this value is not provided on job update, it depends on the field masks |
| 1760 | # set by UpdateJobRequest.update_mask. If the field masks include |
| 1761 | # expiry_time, or the masks are empty meaning that every field is |
| 1762 | # updated, the job posting expires after 30 days from the job's last |
| 1763 | # update time. Otherwise the expiration date isn't updated. |
| 1764 | "postingRegion": "A String", # Optional. The job PostingRegion (for example, state, country) throughout which |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1765 | # the job is available. If this field is set, a |
| 1766 | # LocationFilter in a search query within the job region |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1767 | # finds this job posting if an exact location match isn't specified. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1768 | # If this field is set to PostingRegion.NATION or |
| 1769 | # PostingRegion.ADMINISTRATIVE_AREA, setting job Job.addresses |
| 1770 | # to the same location level as this field is strongly recommended. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1771 | "postingPublishTime": "A String", # Optional. The timestamp this job posting was most recently published. The default |
| 1772 | # value is the time the request arrives at the server. Invalid timestamps are |
| 1773 | # ignored. |
| 1774 | "customAttributes": { # Optional. A map of fields to hold both filterable and non-filterable custom job |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1775 | # attributes that are not covered by the provided structured fields. |
| 1776 | # |
| 1777 | # The keys of the map are strings up to 64 bytes and must match the |
| 1778 | # pattern: a-zA-Z*. For example, key0LikeThis or |
| 1779 | # KEY_1_LIKE_THIS. |
| 1780 | # |
| 1781 | # At most 100 filterable and at most 100 unfilterable keys are supported. |
| 1782 | # For filterable `string_values`, across all keys at most 200 values are |
| 1783 | # allowed, with each string no more than 255 characters. For unfilterable |
| 1784 | # `string_values`, the maximum total size of `string_values` across all keys |
| 1785 | # is 50KB. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1786 | "a_key": { # Custom attribute values that are either filterable or non-filterable. |
| 1787 | "stringValues": [ # Optional but exactly one of string_values or long_values must |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1788 | # be specified. |
| 1789 | # |
| 1790 | # This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or |
| 1791 | # `CASE_INSENSITIVE_MATCH`) search. |
| 1792 | # For filterable `string_value`s, a maximum total number of 200 values |
| 1793 | # is allowed, with each `string_value` has a byte size of no more than |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1794 | # 500B. For unfilterable `string_values`, the maximum total byte size of |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1795 | # unfilterable `string_values` is 50KB. |
| 1796 | # |
| 1797 | # Empty string is not allowed. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1798 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1799 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1800 | "filterable": True or False, # Optional. If the `filterable` flag is true, the custom field values may be used for |
| 1801 | # custom attribute filters JobQuery.custom_attribute_filter. |
| 1802 | # If false, these values may not be used for custom attribute filters. |
| 1803 | # |
| 1804 | # Default is false. |
| 1805 | "longValues": [ # Optional but exactly one of string_values or long_values must |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1806 | # be specified. |
| 1807 | # |
| 1808 | # This field is used to perform number range search. |
| 1809 | # (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`. |
| 1810 | # |
| 1811 | # Currently at most 1 long_values is supported. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1812 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1813 | ], |
| 1814 | }, |
| 1815 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1816 | }</pre> |
| 1817 | </div> |
| 1818 | |
| 1819 | <div class="method"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1820 | <code class="details" id="list">list(parent, jobView=None, pageToken=None, pageSize=None, filter=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1821 | <pre>Lists jobs by filter. |
| 1822 | |
| 1823 | Args: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1824 | parent: string, Required. The resource name of the project under which the job is created. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1825 | |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1826 | The format is "projects/{project_id}", for example, |
| 1827 | "projects/api-test-project". (required) |
| 1828 | jobView: string, Optional. The desired job attributes returned for jobs in the |
| 1829 | search response. Defaults to JobView.JOB_VIEW_FULL if no value is |
| 1830 | specified. |
| 1831 | pageToken: string, Optional. The starting point of a query result. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1832 | pageSize: integer, Optional. The maximum number of jobs to be returned per page of results. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1833 | |
| 1834 | If job_view is set to JobView.JOB_VIEW_ID_ONLY, the maximum allowed |
| 1835 | page size is 1000. Otherwise, the maximum allowed page size is 100. |
| 1836 | |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1837 | Default is 100 if empty or a number < 1 is specified. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1838 | filter: string, Required. The filter string specifies the jobs to be enumerated. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1839 | |
| 1840 | Supported operator: =, AND |
| 1841 | |
| 1842 | The fields eligible for filtering are: |
| 1843 | |
| 1844 | * `companyName` (Required) |
| 1845 | * `requisitionId` (Optional) |
| 1846 | |
| 1847 | Sample Query: |
| 1848 | |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1849 | * companyName = "projects/api-test-project/companies/123" |
| 1850 | * companyName = "projects/api-test-project/companies/123" AND requisitionId |
| 1851 | = "req-1" |
| 1852 | x__xgafv: string, V1 error format. |
| 1853 | Allowed values |
| 1854 | 1 - v1 error format |
| 1855 | 2 - v2 error format |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1856 | |
| 1857 | Returns: |
| 1858 | An object of the form: |
| 1859 | |
| 1860 | { # Output only. |
| 1861 | # |
| 1862 | # List jobs response. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1863 | "jobs": [ # The Jobs for a given company. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1864 | # |
| 1865 | # The maximum number of items returned is based on the limit field |
| 1866 | # provided in the request. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1867 | { # A Job resource represents a job posting (also referred to as a "job listing" |
| 1868 | # or "job requisition"). A job belongs to a Company, which is the hiring |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1869 | # entity responsible for the job. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1870 | "jobLevel": "A String", # Optional. The experience level associated with the job, such as "Entry Level". |
| 1871 | "languageCode": "A String", # Optional. The language of the posting. This field is distinct from |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1872 | # any requirements for fluency that are associated with the job. |
| 1873 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1874 | # Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn". |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1875 | # For more information, see |
| 1876 | # [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1877 | # class="external" target="_blank" }. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1878 | # |
| 1879 | # If this field is unspecified and Job.description is present, detected |
| 1880 | # language code based on Job.description is assigned, otherwise |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1881 | # defaults to 'en_US'. |
| 1882 | "postingUpdateTime": "A String", # Output only. The timestamp when this job posting was last updated. |
| 1883 | "visibility": "A String", # Deprecated. The job is only visible to the owner. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1884 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1885 | # The visibility of the job. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1886 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1887 | # Defaults to Visibility.ACCOUNT_ONLY if not specified. |
| 1888 | "name": "A String", # Required during job update. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1889 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1890 | # The resource name for the job. This is generated by the service when a |
| 1891 | # job is created. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1892 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1893 | # The format is "projects/{project_id}/jobs/{job_id}", |
| 1894 | # for example, "projects/api-test-project/jobs/1234". |
| 1895 | # |
| 1896 | # Use of this field in job queries and API calls is preferred over the use of |
| 1897 | # requisition_id since this value is unique. |
| 1898 | "jobBenefits": [ # Optional. The benefits included with the job. |
| 1899 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1900 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1901 | "promotionValue": 42, # Optional. A promotion value of the job, as determined by the client. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1902 | # The value determines the sort order of the jobs returned when searching for |
| 1903 | # jobs using the featured jobs search call, with higher promotional values |
| 1904 | # being returned first and ties being resolved by relevance sort. Only the |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1905 | # jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1906 | # |
| 1907 | # Default value is 0, and negative values are treated as 0. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1908 | "title": "A String", # Required. The title of the job, such as "Software Engineer" |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1909 | # |
| 1910 | # The maximum number of allowed characters is 500. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1911 | "companyDisplayName": "A String", # Output only. Display name of the company listing the job. |
| 1912 | "requisitionId": "A String", # Required. The requisition ID, also referred to as the posting ID, assigned by the |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1913 | # client to identify a job. This field is intended to be used by clients |
| 1914 | # for client identification and tracking of postings. A job is not allowed |
| 1915 | # to be created if there is another job with the same [company_name], |
| 1916 | # language_code and requisition_id. |
| 1917 | # |
| 1918 | # The maximum number of allowed characters is 255. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1919 | "qualifications": "A String", # Optional. A description of the qualifications required to perform the |
| 1920 | # job. The use of this field is recommended |
| 1921 | # as an alternative to using the more general description field. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1922 | # |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1923 | # This field accepts and sanitizes HTML input, and also accepts |
| 1924 | # bold, italic, ordered list, and unordered list markup tags. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1925 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1926 | # The maximum number of allowed characters is 10,000. |
| 1927 | "processingOptions": { # Input only. # Optional. Options for job processing. |
| 1928 | # |
| 1929 | # Options for job processing. |
| 1930 | "disableStreetAddressResolution": True or False, # Optional. If set to `true`, the service does not attempt to resolve a |
| 1931 | # more precise address for the job. |
| 1932 | "htmlSanitization": "A String", # Optional. Option for job HTML content sanitization. Applied fields are: |
| 1933 | # |
| 1934 | # * description |
| 1935 | # * applicationInfo.instruction |
| 1936 | # * incentives |
| 1937 | # * qualifications |
| 1938 | # * responsibilities |
| 1939 | # |
| 1940 | # HTML tags in these fields may be stripped if sanitiazation is not |
| 1941 | # disabled. |
| 1942 | # |
| 1943 | # Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY. |
| 1944 | }, |
| 1945 | "jobEndTime": "A String", # Optional. The end timestamp of the job. Typically this field is used for contracting |
| 1946 | # engagements. Invalid timestamps are ignored. |
| 1947 | "derivedInfo": { # Output only. # Output only. Derived details about the job posting. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1948 | # |
| 1949 | # Derived details about the job posting. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1950 | "jobCategories": [ # Job categories derived from Job.title and Job.description. |
| 1951 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1952 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1953 | "locations": [ # Structured locations of the job, resolved from Job.addresses. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1954 | # |
| 1955 | # locations are exactly matched to Job.addresses in the same |
| 1956 | # order. |
| 1957 | { # Output only. |
| 1958 | # |
| 1959 | # A resource that represents a location with full geographic information. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1960 | "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1961 | # of doubles representing degrees latitude and degrees longitude. Unless |
| 1962 | # specified otherwise, this must conform to the |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1963 | # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1964 | # standard</a>. Values must be within normalized ranges. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1965 | "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. |
| 1966 | "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1967 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1968 | "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1969 | # such as postal delivery and payments addresses. Given a postal address, |
| 1970 | # a postal service can deliver items to a premises, P.O. Box, or other |
| 1971 | # delivery location. |
| 1972 | # Given a postal address, a postal service can deliver items to a premise, P.O. |
| 1973 | # Box or similar. |
| 1974 | # It is not intended to model geographical locations (roads, towns, |
| 1975 | # mountains). |
| 1976 | # |
| 1977 | # In typical usage an address would be created via user input or from importing |
| 1978 | # existing data, depending on the type of process. |
| 1979 | # |
| 1980 | # Advice on address input / editing: |
| 1981 | # - Use an i18n-ready address widget such as |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1982 | # https://github.com/google/libaddressinput) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1983 | # - Users should not be presented with UI elements for input or editing of |
| 1984 | # fields outside countries where that field is used. |
| 1985 | # |
| 1986 | # For more guidance on how to use this schema, please see: |
| 1987 | # https://support.google.com/business/answer/6397478 |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1988 | "sublocality": "A String", # Optional. Sublocality of the address. |
| 1989 | # For example, this can be neighborhoods, boroughs, districts. |
| 1990 | "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is |
| 1991 | # the latest revision. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1992 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1993 | # All new revisions **must** be backward compatible with old revisions. |
| 1994 | "locality": "A String", # Optional. Generally refers to the city/town portion of the address. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1995 | # Examples: US city, IT comune, UK post town. |
| 1996 | # In regions of the world where localities are not well defined or do not fit |
| 1997 | # into this structure well, leave locality empty and use address_lines. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1998 | "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1999 | # addresses of a country or region. |
| 2000 | # For example, this can be a state, a province, an oblast, or a prefecture. |
| 2001 | # Specifically, for Spain this is the province and not the autonomous |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2002 | # community (e.g. "Barcelona" and not "Catalonia"). |
| 2003 | # Many countries don't use an administrative area in postal addresses. E.g. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2004 | # in Switzerland this should be left unpopulated. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2005 | "organization": "A String", # Optional. The name of the organization at the address. |
| 2006 | "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This |
| 2007 | # is never inferred and it is up to the user to ensure the value is |
| 2008 | # correct. See http://cldr.unicode.org/ and |
| 2009 | # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html |
| 2010 | # for details. Example: "CH" for Switzerland. |
| 2011 | "addressLines": [ # Unstructured address lines describing the lower levels of an address. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2012 | # |
| 2013 | # Because values in address_lines do not have type information and may |
| 2014 | # sometimes contain multiple values in a single field (e.g. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2015 | # "Austin, TX"), it is important that the line order is clear. The order of |
| 2016 | # address lines should be "envelope order" for the country/region of the |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2017 | # address. In places where this can vary (e.g. Japan), address_language is |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2018 | # used to make it explicit (e.g. "ja" for large-to-small ordering and |
| 2019 | # "ja-Latn" or "en" for small-to-large). This way, the most specific line of |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2020 | # an address can be selected based on the language. |
| 2021 | # |
| 2022 | # The minimum permitted structural representation of an address consists |
| 2023 | # of a region_code with all remaining information placed in the |
| 2024 | # address_lines. It would be possible to format such an address very |
| 2025 | # approximately without geocoding, but no semantic reasoning could be |
| 2026 | # made about any of the address components until it was at least |
| 2027 | # partially resolved. |
| 2028 | # |
| 2029 | # Creating an address only containing a region_code and address_lines, and |
| 2030 | # then geocoding is the recommended way to handle completely unstructured |
| 2031 | # addresses (as opposed to guessing which parts of the address should be |
| 2032 | # localities or administrative areas). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2033 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2034 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2035 | "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2036 | # postal codes to be present, but where they are used, they may trigger |
| 2037 | # additional validation with other parts of the address (e.g. state/zip |
| 2038 | # validation in the U.S.A.). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2039 | "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if |
| 2040 | # known). This is often the UI language of the input form or is expected |
| 2041 | # to match one of the languages used in the address' country/region, or their |
| 2042 | # transliterated equivalents. |
| 2043 | # This can affect formatting in certain countries, but is not critical |
| 2044 | # to the correctness of the data and will never affect any validation or |
| 2045 | # other non-formatting related operations. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2046 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2047 | # If this value is not known, it should be omitted (rather than specifying a |
| 2048 | # possibly incorrect default). |
| 2049 | # |
| 2050 | # Examples: "zh-Hant", "ja", "ja-Latn", "en". |
| 2051 | "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used |
| 2052 | # in most regions. Where it is used, the value is either a string like |
| 2053 | # "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number |
| 2054 | # alone, representing the "sector code" (Jamaica), "delivery area indicator" |
| 2055 | # (Malawi) or "post office indicator" (e.g. Côte d'Ivoire). |
| 2056 | "recipients": [ # Optional. The recipient at the address. |
| 2057 | # This field may, under certain circumstances, contain multiline information. |
| 2058 | # For example, it might contain "care of" information. |
| 2059 | "A String", |
| 2060 | ], |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2061 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2062 | "locationType": "A String", # The type of a location, which corresponds to the address lines field of |
| 2063 | # PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of |
| 2064 | # LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of |
| 2065 | # LocationType#LOCALITY. |
| 2066 | "radiusInMiles": 3.14, # Radius in miles of the job location. This value is derived from the |
| 2067 | # location bounding box in which a circle with the specified radius |
| 2068 | # centered from LatLng covers the area associated with the job location. |
| 2069 | # For example, currently, "Mountain View, CA, USA" has a radius of |
| 2070 | # 6.17 miles. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2071 | }, |
| 2072 | ], |
| 2073 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2074 | "employmentTypes": [ # Optional. The employment type(s) of a job, for example, |
| 2075 | # full time or |
| 2076 | # part time. |
| 2077 | "A String", |
| 2078 | ], |
| 2079 | "incentives": "A String", # Optional. A description of bonus, commission, and other compensation |
| 2080 | # incentives associated with the job not including salary or pay. |
| 2081 | # |
| 2082 | # The maximum number of allowed characters is 10,000. |
| 2083 | "postingCreateTime": "A String", # Output only. The timestamp when this job posting was created. |
| 2084 | "addresses": [ # Optional but strongly recommended for the best service experience. |
| 2085 | # |
| 2086 | # Location(s) where the employer is looking to hire for this job posting. |
| 2087 | # |
| 2088 | # Specifying the full street address(es) of the hiring location enables |
| 2089 | # better API results, especially job searches by commute time. |
| 2090 | # |
| 2091 | # At most 50 locations are allowed for best search performance. If a job has |
| 2092 | # more locations, it is suggested to split it into multiple jobs with unique |
| 2093 | # requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as |
| 2094 | # multiple jobs with the same company_name, language_code and |
| 2095 | # requisition_id are not allowed. If the original requisition_id must |
| 2096 | # be preserved, a custom field should be used for storage. It is also |
| 2097 | # suggested to group the locations that close to each other in the same job |
| 2098 | # for better search experience. |
| 2099 | # |
| 2100 | # The maximum number of allowed characters is 500. |
| 2101 | "A String", |
| 2102 | ], |
| 2103 | "companyName": "A String", # Required. The resource name of the company listing the job, such as |
| 2104 | # "projects/api-test-project/companies/foo". |
| 2105 | "description": "A String", # Required. The description of the job, which typically includes a multi-paragraph |
| 2106 | # description of the company and related information. Separate fields are |
| 2107 | # provided on the job object for responsibilities, |
| 2108 | # qualifications, and other job characteristics. Use of |
| 2109 | # these separate job fields is recommended. |
| 2110 | # |
| 2111 | # This field accepts and sanitizes HTML input, and also accepts |
| 2112 | # bold, italic, ordered list, and unordered list markup tags. |
| 2113 | # |
| 2114 | # The maximum number of allowed characters is 100,000. |
| 2115 | "jobStartTime": "A String", # Optional. The start timestamp of the job in UTC time zone. Typically this field |
| 2116 | # is used for contracting engagements. Invalid timestamps are ignored. |
| 2117 | "degreeTypes": [ # Optional. The desired education degrees for the job, such as Bachelors, Masters. |
| 2118 | "A String", |
| 2119 | ], |
| 2120 | "compensationInfo": { # Job compensation details. # Optional. Job compensation information. |
| 2121 | "annualizedBaseCompensationRange": { # Compensation range. # Output only. Annualized base compensation range. Computed as |
| 2122 | # base compensation entry's CompensationEntry.compensation times |
| 2123 | # CompensationEntry.expected_units_per_year. |
| 2124 | # |
| 2125 | # See CompensationEntry for explanation on compensation annualization. |
| 2126 | "maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set |
| 2127 | # to a maximal compensation value and the currency code is set to |
| 2128 | # match the currency code of |
| 2129 | # min_compensation. |
| 2130 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 2131 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 2132 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 2133 | # If `units` is positive, `nanos` must be positive or zero. |
| 2134 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 2135 | # If `units` is negative, `nanos` must be negative or zero. |
| 2136 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 2137 | "units": "A String", # The whole units of the amount. |
| 2138 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 2139 | }, |
| 2140 | "minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set |
| 2141 | # to zero and the currency code is set to match the |
| 2142 | # currency code of max_compensation. |
| 2143 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 2144 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 2145 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 2146 | # If `units` is positive, `nanos` must be positive or zero. |
| 2147 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 2148 | # If `units` is negative, `nanos` must be negative or zero. |
| 2149 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 2150 | "units": "A String", # The whole units of the amount. |
| 2151 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 2152 | }, |
| 2153 | }, |
| 2154 | "annualizedTotalCompensationRange": { # Compensation range. # Output only. Annualized total compensation range. Computed as |
| 2155 | # all compensation entries' CompensationEntry.compensation times |
| 2156 | # CompensationEntry.expected_units_per_year. |
| 2157 | # |
| 2158 | # See CompensationEntry for explanation on compensation annualization. |
| 2159 | "maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set |
| 2160 | # to a maximal compensation value and the currency code is set to |
| 2161 | # match the currency code of |
| 2162 | # min_compensation. |
| 2163 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 2164 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 2165 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 2166 | # If `units` is positive, `nanos` must be positive or zero. |
| 2167 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 2168 | # If `units` is negative, `nanos` must be negative or zero. |
| 2169 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 2170 | "units": "A String", # The whole units of the amount. |
| 2171 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 2172 | }, |
| 2173 | "minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set |
| 2174 | # to zero and the currency code is set to match the |
| 2175 | # currency code of max_compensation. |
| 2176 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 2177 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 2178 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 2179 | # If `units` is positive, `nanos` must be positive or zero. |
| 2180 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 2181 | # If `units` is negative, `nanos` must be negative or zero. |
| 2182 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 2183 | "units": "A String", # The whole units of the amount. |
| 2184 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 2185 | }, |
| 2186 | }, |
| 2187 | "entries": [ # Optional. Job compensation information. |
| 2188 | # |
| 2189 | # At most one entry can be of type |
| 2190 | # CompensationInfo.CompensationType.BASE, which is |
| 2191 | # referred as ** base compensation entry ** for the job. |
| 2192 | { # A compensation entry that represents one component of compensation, such |
| 2193 | # as base pay, bonus, or other compensation type. |
| 2194 | # |
| 2195 | # Annualization: One compensation entry can be annualized if |
| 2196 | # - it contains valid amount or range. |
| 2197 | # - and its expected_units_per_year is set or can be derived. |
| 2198 | # Its annualized range is determined as (amount or range) times |
| 2199 | # expected_units_per_year. |
| 2200 | "unit": "A String", # Optional. Frequency of the specified amount. |
| 2201 | # |
| 2202 | # Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED. |
| 2203 | "amount": { # Represents an amount of money with its currency type. # Optional. Compensation amount. |
| 2204 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 2205 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 2206 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 2207 | # If `units` is positive, `nanos` must be positive or zero. |
| 2208 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 2209 | # If `units` is negative, `nanos` must be negative or zero. |
| 2210 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 2211 | "units": "A String", # The whole units of the amount. |
| 2212 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 2213 | }, |
| 2214 | "type": "A String", # Optional. Compensation type. |
| 2215 | # |
| 2216 | # Default is CompensationUnit.COMPENSATION_TYPE_UNSPECIFIED. |
| 2217 | "range": { # Compensation range. # Optional. Compensation range. |
| 2218 | "maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set |
| 2219 | # to a maximal compensation value and the currency code is set to |
| 2220 | # match the currency code of |
| 2221 | # min_compensation. |
| 2222 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 2223 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 2224 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 2225 | # If `units` is positive, `nanos` must be positive or zero. |
| 2226 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 2227 | # If `units` is negative, `nanos` must be negative or zero. |
| 2228 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 2229 | "units": "A String", # The whole units of the amount. |
| 2230 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 2231 | }, |
| 2232 | "minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set |
| 2233 | # to zero and the currency code is set to match the |
| 2234 | # currency code of max_compensation. |
| 2235 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 2236 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 2237 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 2238 | # If `units` is positive, `nanos` must be positive or zero. |
| 2239 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 2240 | # If `units` is negative, `nanos` must be negative or zero. |
| 2241 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 2242 | "units": "A String", # The whole units of the amount. |
| 2243 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 2244 | }, |
| 2245 | }, |
| 2246 | "expectedUnitsPerYear": 3.14, # Optional. Expected number of units paid each year. If not specified, when |
| 2247 | # Job.employment_types is FULLTIME, a default value is inferred |
| 2248 | # based on unit. Default values: |
| 2249 | # - HOURLY: 2080 |
| 2250 | # - DAILY: 260 |
| 2251 | # - WEEKLY: 52 |
| 2252 | # - MONTHLY: 12 |
| 2253 | # - ANNUAL: 1 |
| 2254 | "description": "A String", # Optional. Compensation description. For example, could |
| 2255 | # indicate equity terms or provide additional context to an estimated |
| 2256 | # bonus. |
| 2257 | }, |
| 2258 | ], |
| 2259 | }, |
| 2260 | "responsibilities": "A String", # Optional. A description of job responsibilities. The use of this field is |
| 2261 | # recommended as an alternative to using the more general description |
| 2262 | # field. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2263 | # |
| 2264 | # This field accepts and sanitizes HTML input, and also accepts |
| 2265 | # bold, italic, ordered list, and unordered list markup tags. |
| 2266 | # |
| 2267 | # The maximum number of allowed characters is 10,000. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2268 | "department": "A String", # Optional. The department or functional area within the company with the open |
| 2269 | # position. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2270 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2271 | # The maximum number of allowed characters is 255. |
| 2272 | "applicationInfo": { # Application related details of a job posting. # Required. At least one field within ApplicationInfo must be specified. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2273 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2274 | # Job application information. |
| 2275 | "uris": [ # Optional but at least one of uris, |
| 2276 | # emails or instruction must be |
| 2277 | # specified. |
| 2278 | # |
| 2279 | # Use this URI field to direct an applicant to a website, for example to |
| 2280 | # link to an online application form. |
| 2281 | # |
| 2282 | # The maximum number of allowed characters for each entry is 2,000. |
| 2283 | "A String", |
| 2284 | ], |
| 2285 | "emails": [ # Optional but at least one of uris, |
| 2286 | # emails or instruction must be |
| 2287 | # specified. |
| 2288 | # |
| 2289 | # Use this field to specify email address(es) to which resumes or |
| 2290 | # applications can be sent. |
| 2291 | # |
| 2292 | # The maximum number of allowed characters for each entry is 255. |
| 2293 | "A String", |
| 2294 | ], |
| 2295 | "instruction": "A String", # Optional but at least one of uris, |
| 2296 | # emails or instruction must be |
| 2297 | # specified. |
| 2298 | # |
| 2299 | # Use this field to provide instructions, such as "Mail your application |
| 2300 | # to ...", that a candidate can follow to apply for the job. |
| 2301 | # |
| 2302 | # This field accepts and sanitizes HTML input, and also accepts |
| 2303 | # bold, italic, ordered list, and unordered list markup tags. |
| 2304 | # |
| 2305 | # The maximum number of allowed characters is 3,000. |
| 2306 | }, |
| 2307 | "postingExpireTime": "A String", # Optional but strongly recommended for the best service |
| 2308 | # experience. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2309 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2310 | # The expiration timestamp of the job. After this timestamp, the |
| 2311 | # job is marked as expired, and it no longer appears in search results. The |
| 2312 | # expired job can't be deleted or listed by the DeleteJob and |
| 2313 | # ListJobs APIs, but it can be retrieved with the GetJob API or |
| 2314 | # updated with the UpdateJob API. An expired job can be updated and |
| 2315 | # opened again by using a future expiration timestamp. Updating an expired |
| 2316 | # job fails if there is another existing open job with same company_name, |
| 2317 | # language_code and requisition_id. |
| 2318 | # |
| 2319 | # The expired jobs are retained in our system for 90 days. However, the |
| 2320 | # overall expired job count cannot exceed 3 times the maximum of open jobs |
| 2321 | # count over the past week, otherwise jobs with earlier expire time are |
| 2322 | # cleaned first. Expired jobs are no longer accessible after they are cleaned |
| 2323 | # out. |
| 2324 | # |
| 2325 | # Invalid timestamps are ignored, and treated as expire time not provided. |
| 2326 | # |
| 2327 | # Timestamp before the instant request is made is considered valid, the job |
| 2328 | # will be treated as expired immediately. |
| 2329 | # |
| 2330 | # If this value is not provided at the time of job creation or is invalid, |
| 2331 | # the job posting expires after 30 days from the job's creation time. For |
| 2332 | # example, if the job was created on 2017/01/01 13:00AM UTC with an |
| 2333 | # unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC. |
| 2334 | # |
| 2335 | # If this value is not provided on job update, it depends on the field masks |
| 2336 | # set by UpdateJobRequest.update_mask. If the field masks include |
| 2337 | # expiry_time, or the masks are empty meaning that every field is |
| 2338 | # updated, the job posting expires after 30 days from the job's last |
| 2339 | # update time. Otherwise the expiration date isn't updated. |
| 2340 | "postingRegion": "A String", # Optional. The job PostingRegion (for example, state, country) throughout which |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2341 | # the job is available. If this field is set, a |
| 2342 | # LocationFilter in a search query within the job region |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2343 | # finds this job posting if an exact location match isn't specified. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2344 | # If this field is set to PostingRegion.NATION or |
| 2345 | # PostingRegion.ADMINISTRATIVE_AREA, setting job Job.addresses |
| 2346 | # to the same location level as this field is strongly recommended. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2347 | "postingPublishTime": "A String", # Optional. The timestamp this job posting was most recently published. The default |
| 2348 | # value is the time the request arrives at the server. Invalid timestamps are |
| 2349 | # ignored. |
| 2350 | "customAttributes": { # Optional. A map of fields to hold both filterable and non-filterable custom job |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2351 | # attributes that are not covered by the provided structured fields. |
| 2352 | # |
| 2353 | # The keys of the map are strings up to 64 bytes and must match the |
| 2354 | # pattern: a-zA-Z*. For example, key0LikeThis or |
| 2355 | # KEY_1_LIKE_THIS. |
| 2356 | # |
| 2357 | # At most 100 filterable and at most 100 unfilterable keys are supported. |
| 2358 | # For filterable `string_values`, across all keys at most 200 values are |
| 2359 | # allowed, with each string no more than 255 characters. For unfilterable |
| 2360 | # `string_values`, the maximum total size of `string_values` across all keys |
| 2361 | # is 50KB. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2362 | "a_key": { # Custom attribute values that are either filterable or non-filterable. |
| 2363 | "stringValues": [ # Optional but exactly one of string_values or long_values must |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2364 | # be specified. |
| 2365 | # |
| 2366 | # This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or |
| 2367 | # `CASE_INSENSITIVE_MATCH`) search. |
| 2368 | # For filterable `string_value`s, a maximum total number of 200 values |
| 2369 | # is allowed, with each `string_value` has a byte size of no more than |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2370 | # 500B. For unfilterable `string_values`, the maximum total byte size of |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2371 | # unfilterable `string_values` is 50KB. |
| 2372 | # |
| 2373 | # Empty string is not allowed. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2374 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2375 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2376 | "filterable": True or False, # Optional. If the `filterable` flag is true, the custom field values may be used for |
| 2377 | # custom attribute filters JobQuery.custom_attribute_filter. |
| 2378 | # If false, these values may not be used for custom attribute filters. |
| 2379 | # |
| 2380 | # Default is false. |
| 2381 | "longValues": [ # Optional but exactly one of string_values or long_values must |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2382 | # be specified. |
| 2383 | # |
| 2384 | # This field is used to perform number range search. |
| 2385 | # (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`. |
| 2386 | # |
| 2387 | # Currently at most 1 long_values is supported. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2388 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2389 | ], |
| 2390 | }, |
| 2391 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2392 | }, |
| 2393 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2394 | "nextPageToken": "A String", # A token to retrieve the next page of results. |
| 2395 | "metadata": { # Output only. # Additional information for the API invocation, such as the request |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2396 | # tracking id. |
| 2397 | # |
| 2398 | # Additional information returned to client, such as debugging information. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2399 | "requestId": "A String", # A unique id associated with this call. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2400 | # This id is logged for tracking purposes. |
| 2401 | }, |
| 2402 | }</pre> |
| 2403 | </div> |
| 2404 | |
| 2405 | <div class="method"> |
| 2406 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 2407 | <pre>Retrieves the next page of results. |
| 2408 | |
| 2409 | Args: |
| 2410 | previous_request: The request for the previous page. (required) |
| 2411 | previous_response: The response from the request for the previous page. (required) |
| 2412 | |
| 2413 | Returns: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2414 | A request object that you can call 'execute()' on to request the next |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2415 | page. Returns None if there are no more items in the collection. |
| 2416 | </pre> |
| 2417 | </div> |
| 2418 | |
| 2419 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2420 | <code class="details" id="patch">patch(name, body=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2421 | <pre>Updates specified job. |
| 2422 | |
| 2423 | Typically, updated contents become visible in search results within 10 |
| 2424 | seconds, but it may take up to 5 minutes. |
| 2425 | |
| 2426 | Args: |
| 2427 | name: string, Required during job update. |
| 2428 | |
| 2429 | The resource name for the job. This is generated by the service when a |
| 2430 | job is created. |
| 2431 | |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2432 | The format is "projects/{project_id}/jobs/{job_id}", |
| 2433 | for example, "projects/api-test-project/jobs/1234". |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2434 | |
| 2435 | Use of this field in job queries and API calls is preferred over the use of |
| 2436 | requisition_id since this value is unique. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2437 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2438 | The object takes the form of: |
| 2439 | |
| 2440 | { # Input only. |
| 2441 | # |
| 2442 | # Update job request. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2443 | "job": { # A Job resource represents a job posting (also referred to as a "job listing" # Required. The Job to be updated. |
| 2444 | # or "job requisition"). A job belongs to a Company, which is the hiring |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2445 | # entity responsible for the job. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2446 | "jobLevel": "A String", # Optional. The experience level associated with the job, such as "Entry Level". |
| 2447 | "languageCode": "A String", # Optional. The language of the posting. This field is distinct from |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2448 | # any requirements for fluency that are associated with the job. |
| 2449 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2450 | # Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn". |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2451 | # For more information, see |
| 2452 | # [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2453 | # class="external" target="_blank" }. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2454 | # |
| 2455 | # If this field is unspecified and Job.description is present, detected |
| 2456 | # language code based on Job.description is assigned, otherwise |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2457 | # defaults to 'en_US'. |
| 2458 | "postingUpdateTime": "A String", # Output only. The timestamp when this job posting was last updated. |
| 2459 | "visibility": "A String", # Deprecated. The job is only visible to the owner. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2460 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2461 | # The visibility of the job. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2462 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2463 | # Defaults to Visibility.ACCOUNT_ONLY if not specified. |
| 2464 | "name": "A String", # Required during job update. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2465 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2466 | # The resource name for the job. This is generated by the service when a |
| 2467 | # job is created. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2468 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2469 | # The format is "projects/{project_id}/jobs/{job_id}", |
| 2470 | # for example, "projects/api-test-project/jobs/1234". |
| 2471 | # |
| 2472 | # Use of this field in job queries and API calls is preferred over the use of |
| 2473 | # requisition_id since this value is unique. |
| 2474 | "jobBenefits": [ # Optional. The benefits included with the job. |
| 2475 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2476 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2477 | "promotionValue": 42, # Optional. A promotion value of the job, as determined by the client. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2478 | # The value determines the sort order of the jobs returned when searching for |
| 2479 | # jobs using the featured jobs search call, with higher promotional values |
| 2480 | # being returned first and ties being resolved by relevance sort. Only the |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2481 | # jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2482 | # |
| 2483 | # Default value is 0, and negative values are treated as 0. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2484 | "title": "A String", # Required. The title of the job, such as "Software Engineer" |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2485 | # |
| 2486 | # The maximum number of allowed characters is 500. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2487 | "companyDisplayName": "A String", # Output only. Display name of the company listing the job. |
| 2488 | "requisitionId": "A String", # Required. The requisition ID, also referred to as the posting ID, assigned by the |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2489 | # client to identify a job. This field is intended to be used by clients |
| 2490 | # for client identification and tracking of postings. A job is not allowed |
| 2491 | # to be created if there is another job with the same [company_name], |
| 2492 | # language_code and requisition_id. |
| 2493 | # |
| 2494 | # The maximum number of allowed characters is 255. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2495 | "qualifications": "A String", # Optional. A description of the qualifications required to perform the |
| 2496 | # job. The use of this field is recommended |
| 2497 | # as an alternative to using the more general description field. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2498 | # |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2499 | # This field accepts and sanitizes HTML input, and also accepts |
| 2500 | # bold, italic, ordered list, and unordered list markup tags. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2501 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2502 | # The maximum number of allowed characters is 10,000. |
| 2503 | "processingOptions": { # Input only. # Optional. Options for job processing. |
| 2504 | # |
| 2505 | # Options for job processing. |
| 2506 | "disableStreetAddressResolution": True or False, # Optional. If set to `true`, the service does not attempt to resolve a |
| 2507 | # more precise address for the job. |
| 2508 | "htmlSanitization": "A String", # Optional. Option for job HTML content sanitization. Applied fields are: |
| 2509 | # |
| 2510 | # * description |
| 2511 | # * applicationInfo.instruction |
| 2512 | # * incentives |
| 2513 | # * qualifications |
| 2514 | # * responsibilities |
| 2515 | # |
| 2516 | # HTML tags in these fields may be stripped if sanitiazation is not |
| 2517 | # disabled. |
| 2518 | # |
| 2519 | # Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY. |
| 2520 | }, |
| 2521 | "jobEndTime": "A String", # Optional. The end timestamp of the job. Typically this field is used for contracting |
| 2522 | # engagements. Invalid timestamps are ignored. |
| 2523 | "derivedInfo": { # Output only. # Output only. Derived details about the job posting. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2524 | # |
| 2525 | # Derived details about the job posting. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2526 | "jobCategories": [ # Job categories derived from Job.title and Job.description. |
| 2527 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2528 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2529 | "locations": [ # Structured locations of the job, resolved from Job.addresses. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2530 | # |
| 2531 | # locations are exactly matched to Job.addresses in the same |
| 2532 | # order. |
| 2533 | { # Output only. |
| 2534 | # |
| 2535 | # A resource that represents a location with full geographic information. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2536 | "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2537 | # of doubles representing degrees latitude and degrees longitude. Unless |
| 2538 | # specified otherwise, this must conform to the |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2539 | # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2540 | # standard</a>. Values must be within normalized ranges. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2541 | "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. |
| 2542 | "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2543 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2544 | "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2545 | # such as postal delivery and payments addresses. Given a postal address, |
| 2546 | # a postal service can deliver items to a premises, P.O. Box, or other |
| 2547 | # delivery location. |
| 2548 | # Given a postal address, a postal service can deliver items to a premise, P.O. |
| 2549 | # Box or similar. |
| 2550 | # It is not intended to model geographical locations (roads, towns, |
| 2551 | # mountains). |
| 2552 | # |
| 2553 | # In typical usage an address would be created via user input or from importing |
| 2554 | # existing data, depending on the type of process. |
| 2555 | # |
| 2556 | # Advice on address input / editing: |
| 2557 | # - Use an i18n-ready address widget such as |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2558 | # https://github.com/google/libaddressinput) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2559 | # - Users should not be presented with UI elements for input or editing of |
| 2560 | # fields outside countries where that field is used. |
| 2561 | # |
| 2562 | # For more guidance on how to use this schema, please see: |
| 2563 | # https://support.google.com/business/answer/6397478 |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2564 | "sublocality": "A String", # Optional. Sublocality of the address. |
| 2565 | # For example, this can be neighborhoods, boroughs, districts. |
| 2566 | "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is |
| 2567 | # the latest revision. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2568 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2569 | # All new revisions **must** be backward compatible with old revisions. |
| 2570 | "locality": "A String", # Optional. Generally refers to the city/town portion of the address. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2571 | # Examples: US city, IT comune, UK post town. |
| 2572 | # In regions of the world where localities are not well defined or do not fit |
| 2573 | # into this structure well, leave locality empty and use address_lines. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2574 | "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2575 | # addresses of a country or region. |
| 2576 | # For example, this can be a state, a province, an oblast, or a prefecture. |
| 2577 | # Specifically, for Spain this is the province and not the autonomous |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2578 | # community (e.g. "Barcelona" and not "Catalonia"). |
| 2579 | # Many countries don't use an administrative area in postal addresses. E.g. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2580 | # in Switzerland this should be left unpopulated. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2581 | "organization": "A String", # Optional. The name of the organization at the address. |
| 2582 | "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This |
| 2583 | # is never inferred and it is up to the user to ensure the value is |
| 2584 | # correct. See http://cldr.unicode.org/ and |
| 2585 | # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html |
| 2586 | # for details. Example: "CH" for Switzerland. |
| 2587 | "addressLines": [ # Unstructured address lines describing the lower levels of an address. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2588 | # |
| 2589 | # Because values in address_lines do not have type information and may |
| 2590 | # sometimes contain multiple values in a single field (e.g. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2591 | # "Austin, TX"), it is important that the line order is clear. The order of |
| 2592 | # address lines should be "envelope order" for the country/region of the |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2593 | # address. In places where this can vary (e.g. Japan), address_language is |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2594 | # used to make it explicit (e.g. "ja" for large-to-small ordering and |
| 2595 | # "ja-Latn" or "en" for small-to-large). This way, the most specific line of |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2596 | # an address can be selected based on the language. |
| 2597 | # |
| 2598 | # The minimum permitted structural representation of an address consists |
| 2599 | # of a region_code with all remaining information placed in the |
| 2600 | # address_lines. It would be possible to format such an address very |
| 2601 | # approximately without geocoding, but no semantic reasoning could be |
| 2602 | # made about any of the address components until it was at least |
| 2603 | # partially resolved. |
| 2604 | # |
| 2605 | # Creating an address only containing a region_code and address_lines, and |
| 2606 | # then geocoding is the recommended way to handle completely unstructured |
| 2607 | # addresses (as opposed to guessing which parts of the address should be |
| 2608 | # localities or administrative areas). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2609 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2610 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2611 | "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2612 | # postal codes to be present, but where they are used, they may trigger |
| 2613 | # additional validation with other parts of the address (e.g. state/zip |
| 2614 | # validation in the U.S.A.). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2615 | "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if |
| 2616 | # known). This is often the UI language of the input form or is expected |
| 2617 | # to match one of the languages used in the address' country/region, or their |
| 2618 | # transliterated equivalents. |
| 2619 | # This can affect formatting in certain countries, but is not critical |
| 2620 | # to the correctness of the data and will never affect any validation or |
| 2621 | # other non-formatting related operations. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2622 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2623 | # If this value is not known, it should be omitted (rather than specifying a |
| 2624 | # possibly incorrect default). |
| 2625 | # |
| 2626 | # Examples: "zh-Hant", "ja", "ja-Latn", "en". |
| 2627 | "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used |
| 2628 | # in most regions. Where it is used, the value is either a string like |
| 2629 | # "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number |
| 2630 | # alone, representing the "sector code" (Jamaica), "delivery area indicator" |
| 2631 | # (Malawi) or "post office indicator" (e.g. Côte d'Ivoire). |
| 2632 | "recipients": [ # Optional. The recipient at the address. |
| 2633 | # This field may, under certain circumstances, contain multiline information. |
| 2634 | # For example, it might contain "care of" information. |
| 2635 | "A String", |
| 2636 | ], |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2637 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2638 | "locationType": "A String", # The type of a location, which corresponds to the address lines field of |
| 2639 | # PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of |
| 2640 | # LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of |
| 2641 | # LocationType#LOCALITY. |
| 2642 | "radiusInMiles": 3.14, # Radius in miles of the job location. This value is derived from the |
| 2643 | # location bounding box in which a circle with the specified radius |
| 2644 | # centered from LatLng covers the area associated with the job location. |
| 2645 | # For example, currently, "Mountain View, CA, USA" has a radius of |
| 2646 | # 6.17 miles. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2647 | }, |
| 2648 | ], |
| 2649 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2650 | "employmentTypes": [ # Optional. The employment type(s) of a job, for example, |
| 2651 | # full time or |
| 2652 | # part time. |
| 2653 | "A String", |
| 2654 | ], |
| 2655 | "incentives": "A String", # Optional. A description of bonus, commission, and other compensation |
| 2656 | # incentives associated with the job not including salary or pay. |
| 2657 | # |
| 2658 | # The maximum number of allowed characters is 10,000. |
| 2659 | "postingCreateTime": "A String", # Output only. The timestamp when this job posting was created. |
| 2660 | "addresses": [ # Optional but strongly recommended for the best service experience. |
| 2661 | # |
| 2662 | # Location(s) where the employer is looking to hire for this job posting. |
| 2663 | # |
| 2664 | # Specifying the full street address(es) of the hiring location enables |
| 2665 | # better API results, especially job searches by commute time. |
| 2666 | # |
| 2667 | # At most 50 locations are allowed for best search performance. If a job has |
| 2668 | # more locations, it is suggested to split it into multiple jobs with unique |
| 2669 | # requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as |
| 2670 | # multiple jobs with the same company_name, language_code and |
| 2671 | # requisition_id are not allowed. If the original requisition_id must |
| 2672 | # be preserved, a custom field should be used for storage. It is also |
| 2673 | # suggested to group the locations that close to each other in the same job |
| 2674 | # for better search experience. |
| 2675 | # |
| 2676 | # The maximum number of allowed characters is 500. |
| 2677 | "A String", |
| 2678 | ], |
| 2679 | "companyName": "A String", # Required. The resource name of the company listing the job, such as |
| 2680 | # "projects/api-test-project/companies/foo". |
| 2681 | "description": "A String", # Required. The description of the job, which typically includes a multi-paragraph |
| 2682 | # description of the company and related information. Separate fields are |
| 2683 | # provided on the job object for responsibilities, |
| 2684 | # qualifications, and other job characteristics. Use of |
| 2685 | # these separate job fields is recommended. |
| 2686 | # |
| 2687 | # This field accepts and sanitizes HTML input, and also accepts |
| 2688 | # bold, italic, ordered list, and unordered list markup tags. |
| 2689 | # |
| 2690 | # The maximum number of allowed characters is 100,000. |
| 2691 | "jobStartTime": "A String", # Optional. The start timestamp of the job in UTC time zone. Typically this field |
| 2692 | # is used for contracting engagements. Invalid timestamps are ignored. |
| 2693 | "degreeTypes": [ # Optional. The desired education degrees for the job, such as Bachelors, Masters. |
| 2694 | "A String", |
| 2695 | ], |
| 2696 | "compensationInfo": { # Job compensation details. # Optional. Job compensation information. |
| 2697 | "annualizedBaseCompensationRange": { # Compensation range. # Output only. Annualized base compensation range. Computed as |
| 2698 | # base compensation entry's CompensationEntry.compensation times |
| 2699 | # CompensationEntry.expected_units_per_year. |
| 2700 | # |
| 2701 | # See CompensationEntry for explanation on compensation annualization. |
| 2702 | "maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set |
| 2703 | # to a maximal compensation value and the currency code is set to |
| 2704 | # match the currency code of |
| 2705 | # min_compensation. |
| 2706 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 2707 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 2708 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 2709 | # If `units` is positive, `nanos` must be positive or zero. |
| 2710 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 2711 | # If `units` is negative, `nanos` must be negative or zero. |
| 2712 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 2713 | "units": "A String", # The whole units of the amount. |
| 2714 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 2715 | }, |
| 2716 | "minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set |
| 2717 | # to zero and the currency code is set to match the |
| 2718 | # currency code of max_compensation. |
| 2719 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 2720 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 2721 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 2722 | # If `units` is positive, `nanos` must be positive or zero. |
| 2723 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 2724 | # If `units` is negative, `nanos` must be negative or zero. |
| 2725 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 2726 | "units": "A String", # The whole units of the amount. |
| 2727 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 2728 | }, |
| 2729 | }, |
| 2730 | "annualizedTotalCompensationRange": { # Compensation range. # Output only. Annualized total compensation range. Computed as |
| 2731 | # all compensation entries' CompensationEntry.compensation times |
| 2732 | # CompensationEntry.expected_units_per_year. |
| 2733 | # |
| 2734 | # See CompensationEntry for explanation on compensation annualization. |
| 2735 | "maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set |
| 2736 | # to a maximal compensation value and the currency code is set to |
| 2737 | # match the currency code of |
| 2738 | # min_compensation. |
| 2739 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 2740 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 2741 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 2742 | # If `units` is positive, `nanos` must be positive or zero. |
| 2743 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 2744 | # If `units` is negative, `nanos` must be negative or zero. |
| 2745 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 2746 | "units": "A String", # The whole units of the amount. |
| 2747 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 2748 | }, |
| 2749 | "minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set |
| 2750 | # to zero and the currency code is set to match the |
| 2751 | # currency code of max_compensation. |
| 2752 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 2753 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 2754 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 2755 | # If `units` is positive, `nanos` must be positive or zero. |
| 2756 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 2757 | # If `units` is negative, `nanos` must be negative or zero. |
| 2758 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 2759 | "units": "A String", # The whole units of the amount. |
| 2760 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 2761 | }, |
| 2762 | }, |
| 2763 | "entries": [ # Optional. Job compensation information. |
| 2764 | # |
| 2765 | # At most one entry can be of type |
| 2766 | # CompensationInfo.CompensationType.BASE, which is |
| 2767 | # referred as ** base compensation entry ** for the job. |
| 2768 | { # A compensation entry that represents one component of compensation, such |
| 2769 | # as base pay, bonus, or other compensation type. |
| 2770 | # |
| 2771 | # Annualization: One compensation entry can be annualized if |
| 2772 | # - it contains valid amount or range. |
| 2773 | # - and its expected_units_per_year is set or can be derived. |
| 2774 | # Its annualized range is determined as (amount or range) times |
| 2775 | # expected_units_per_year. |
| 2776 | "unit": "A String", # Optional. Frequency of the specified amount. |
| 2777 | # |
| 2778 | # Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED. |
| 2779 | "amount": { # Represents an amount of money with its currency type. # Optional. Compensation amount. |
| 2780 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 2781 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 2782 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 2783 | # If `units` is positive, `nanos` must be positive or zero. |
| 2784 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 2785 | # If `units` is negative, `nanos` must be negative or zero. |
| 2786 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 2787 | "units": "A String", # The whole units of the amount. |
| 2788 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 2789 | }, |
| 2790 | "type": "A String", # Optional. Compensation type. |
| 2791 | # |
| 2792 | # Default is CompensationUnit.COMPENSATION_TYPE_UNSPECIFIED. |
| 2793 | "range": { # Compensation range. # Optional. Compensation range. |
| 2794 | "maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set |
| 2795 | # to a maximal compensation value and the currency code is set to |
| 2796 | # match the currency code of |
| 2797 | # min_compensation. |
| 2798 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 2799 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 2800 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 2801 | # If `units` is positive, `nanos` must be positive or zero. |
| 2802 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 2803 | # If `units` is negative, `nanos` must be negative or zero. |
| 2804 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 2805 | "units": "A String", # The whole units of the amount. |
| 2806 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 2807 | }, |
| 2808 | "minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set |
| 2809 | # to zero and the currency code is set to match the |
| 2810 | # currency code of max_compensation. |
| 2811 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 2812 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 2813 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 2814 | # If `units` is positive, `nanos` must be positive or zero. |
| 2815 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 2816 | # If `units` is negative, `nanos` must be negative or zero. |
| 2817 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 2818 | "units": "A String", # The whole units of the amount. |
| 2819 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 2820 | }, |
| 2821 | }, |
| 2822 | "expectedUnitsPerYear": 3.14, # Optional. Expected number of units paid each year. If not specified, when |
| 2823 | # Job.employment_types is FULLTIME, a default value is inferred |
| 2824 | # based on unit. Default values: |
| 2825 | # - HOURLY: 2080 |
| 2826 | # - DAILY: 260 |
| 2827 | # - WEEKLY: 52 |
| 2828 | # - MONTHLY: 12 |
| 2829 | # - ANNUAL: 1 |
| 2830 | "description": "A String", # Optional. Compensation description. For example, could |
| 2831 | # indicate equity terms or provide additional context to an estimated |
| 2832 | # bonus. |
| 2833 | }, |
| 2834 | ], |
| 2835 | }, |
| 2836 | "responsibilities": "A String", # Optional. A description of job responsibilities. The use of this field is |
| 2837 | # recommended as an alternative to using the more general description |
| 2838 | # field. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2839 | # |
| 2840 | # This field accepts and sanitizes HTML input, and also accepts |
| 2841 | # bold, italic, ordered list, and unordered list markup tags. |
| 2842 | # |
| 2843 | # The maximum number of allowed characters is 10,000. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2844 | "department": "A String", # Optional. The department or functional area within the company with the open |
| 2845 | # position. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2846 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2847 | # The maximum number of allowed characters is 255. |
| 2848 | "applicationInfo": { # Application related details of a job posting. # Required. At least one field within ApplicationInfo must be specified. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2849 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2850 | # Job application information. |
| 2851 | "uris": [ # Optional but at least one of uris, |
| 2852 | # emails or instruction must be |
| 2853 | # specified. |
| 2854 | # |
| 2855 | # Use this URI field to direct an applicant to a website, for example to |
| 2856 | # link to an online application form. |
| 2857 | # |
| 2858 | # The maximum number of allowed characters for each entry is 2,000. |
| 2859 | "A String", |
| 2860 | ], |
| 2861 | "emails": [ # Optional but at least one of uris, |
| 2862 | # emails or instruction must be |
| 2863 | # specified. |
| 2864 | # |
| 2865 | # Use this field to specify email address(es) to which resumes or |
| 2866 | # applications can be sent. |
| 2867 | # |
| 2868 | # The maximum number of allowed characters for each entry is 255. |
| 2869 | "A String", |
| 2870 | ], |
| 2871 | "instruction": "A String", # Optional but at least one of uris, |
| 2872 | # emails or instruction must be |
| 2873 | # specified. |
| 2874 | # |
| 2875 | # Use this field to provide instructions, such as "Mail your application |
| 2876 | # to ...", that a candidate can follow to apply for the job. |
| 2877 | # |
| 2878 | # This field accepts and sanitizes HTML input, and also accepts |
| 2879 | # bold, italic, ordered list, and unordered list markup tags. |
| 2880 | # |
| 2881 | # The maximum number of allowed characters is 3,000. |
| 2882 | }, |
| 2883 | "postingExpireTime": "A String", # Optional but strongly recommended for the best service |
| 2884 | # experience. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2885 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2886 | # The expiration timestamp of the job. After this timestamp, the |
| 2887 | # job is marked as expired, and it no longer appears in search results. The |
| 2888 | # expired job can't be deleted or listed by the DeleteJob and |
| 2889 | # ListJobs APIs, but it can be retrieved with the GetJob API or |
| 2890 | # updated with the UpdateJob API. An expired job can be updated and |
| 2891 | # opened again by using a future expiration timestamp. Updating an expired |
| 2892 | # job fails if there is another existing open job with same company_name, |
| 2893 | # language_code and requisition_id. |
| 2894 | # |
| 2895 | # The expired jobs are retained in our system for 90 days. However, the |
| 2896 | # overall expired job count cannot exceed 3 times the maximum of open jobs |
| 2897 | # count over the past week, otherwise jobs with earlier expire time are |
| 2898 | # cleaned first. Expired jobs are no longer accessible after they are cleaned |
| 2899 | # out. |
| 2900 | # |
| 2901 | # Invalid timestamps are ignored, and treated as expire time not provided. |
| 2902 | # |
| 2903 | # Timestamp before the instant request is made is considered valid, the job |
| 2904 | # will be treated as expired immediately. |
| 2905 | # |
| 2906 | # If this value is not provided at the time of job creation or is invalid, |
| 2907 | # the job posting expires after 30 days from the job's creation time. For |
| 2908 | # example, if the job was created on 2017/01/01 13:00AM UTC with an |
| 2909 | # unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC. |
| 2910 | # |
| 2911 | # If this value is not provided on job update, it depends on the field masks |
| 2912 | # set by UpdateJobRequest.update_mask. If the field masks include |
| 2913 | # expiry_time, or the masks are empty meaning that every field is |
| 2914 | # updated, the job posting expires after 30 days from the job's last |
| 2915 | # update time. Otherwise the expiration date isn't updated. |
| 2916 | "postingRegion": "A String", # Optional. The job PostingRegion (for example, state, country) throughout which |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2917 | # the job is available. If this field is set, a |
| 2918 | # LocationFilter in a search query within the job region |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2919 | # finds this job posting if an exact location match isn't specified. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2920 | # If this field is set to PostingRegion.NATION or |
| 2921 | # PostingRegion.ADMINISTRATIVE_AREA, setting job Job.addresses |
| 2922 | # to the same location level as this field is strongly recommended. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2923 | "postingPublishTime": "A String", # Optional. The timestamp this job posting was most recently published. The default |
| 2924 | # value is the time the request arrives at the server. Invalid timestamps are |
| 2925 | # ignored. |
| 2926 | "customAttributes": { # Optional. A map of fields to hold both filterable and non-filterable custom job |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2927 | # attributes that are not covered by the provided structured fields. |
| 2928 | # |
| 2929 | # The keys of the map are strings up to 64 bytes and must match the |
| 2930 | # pattern: a-zA-Z*. For example, key0LikeThis or |
| 2931 | # KEY_1_LIKE_THIS. |
| 2932 | # |
| 2933 | # At most 100 filterable and at most 100 unfilterable keys are supported. |
| 2934 | # For filterable `string_values`, across all keys at most 200 values are |
| 2935 | # allowed, with each string no more than 255 characters. For unfilterable |
| 2936 | # `string_values`, the maximum total size of `string_values` across all keys |
| 2937 | # is 50KB. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2938 | "a_key": { # Custom attribute values that are either filterable or non-filterable. |
| 2939 | "stringValues": [ # Optional but exactly one of string_values or long_values must |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2940 | # be specified. |
| 2941 | # |
| 2942 | # This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or |
| 2943 | # `CASE_INSENSITIVE_MATCH`) search. |
| 2944 | # For filterable `string_value`s, a maximum total number of 200 values |
| 2945 | # is allowed, with each `string_value` has a byte size of no more than |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2946 | # 500B. For unfilterable `string_values`, the maximum total byte size of |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2947 | # unfilterable `string_values` is 50KB. |
| 2948 | # |
| 2949 | # Empty string is not allowed. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2950 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2951 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2952 | "filterable": True or False, # Optional. If the `filterable` flag is true, the custom field values may be used for |
| 2953 | # custom attribute filters JobQuery.custom_attribute_filter. |
| 2954 | # If false, these values may not be used for custom attribute filters. |
| 2955 | # |
| 2956 | # Default is false. |
| 2957 | "longValues": [ # Optional but exactly one of string_values or long_values must |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2958 | # be specified. |
| 2959 | # |
| 2960 | # This field is used to perform number range search. |
| 2961 | # (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`. |
| 2962 | # |
| 2963 | # Currently at most 1 long_values is supported. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2964 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2965 | ], |
| 2966 | }, |
| 2967 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2968 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2969 | "updateMask": "A String", # Optional but strongly recommended to be provided for the best service |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2970 | # experience. |
| 2971 | # |
| 2972 | # If update_mask is provided, only the specified fields in |
| 2973 | # job are updated. Otherwise all the fields are updated. |
| 2974 | # |
| 2975 | # A field mask to restrict the fields that are updated. Only |
| 2976 | # top level fields of Job are supported. |
| 2977 | } |
| 2978 | |
| 2979 | x__xgafv: string, V1 error format. |
| 2980 | Allowed values |
| 2981 | 1 - v1 error format |
| 2982 | 2 - v2 error format |
| 2983 | |
| 2984 | Returns: |
| 2985 | An object of the form: |
| 2986 | |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2987 | { # A Job resource represents a job posting (also referred to as a "job listing" |
| 2988 | # or "job requisition"). A job belongs to a Company, which is the hiring |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2989 | # entity responsible for the job. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2990 | "jobLevel": "A String", # Optional. The experience level associated with the job, such as "Entry Level". |
| 2991 | "languageCode": "A String", # Optional. The language of the posting. This field is distinct from |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2992 | # any requirements for fluency that are associated with the job. |
| 2993 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2994 | # Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn". |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2995 | # For more information, see |
| 2996 | # [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2997 | # class="external" target="_blank" }. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2998 | # |
| 2999 | # If this field is unspecified and Job.description is present, detected |
| 3000 | # language code based on Job.description is assigned, otherwise |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3001 | # defaults to 'en_US'. |
| 3002 | "postingUpdateTime": "A String", # Output only. The timestamp when this job posting was last updated. |
| 3003 | "visibility": "A String", # Deprecated. The job is only visible to the owner. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3004 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3005 | # The visibility of the job. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3006 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3007 | # Defaults to Visibility.ACCOUNT_ONLY if not specified. |
| 3008 | "name": "A String", # Required during job update. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3009 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3010 | # The resource name for the job. This is generated by the service when a |
| 3011 | # job is created. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3012 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3013 | # The format is "projects/{project_id}/jobs/{job_id}", |
| 3014 | # for example, "projects/api-test-project/jobs/1234". |
| 3015 | # |
| 3016 | # Use of this field in job queries and API calls is preferred over the use of |
| 3017 | # requisition_id since this value is unique. |
| 3018 | "jobBenefits": [ # Optional. The benefits included with the job. |
| 3019 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3020 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3021 | "promotionValue": 42, # Optional. A promotion value of the job, as determined by the client. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3022 | # The value determines the sort order of the jobs returned when searching for |
| 3023 | # jobs using the featured jobs search call, with higher promotional values |
| 3024 | # being returned first and ties being resolved by relevance sort. Only the |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3025 | # jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3026 | # |
| 3027 | # Default value is 0, and negative values are treated as 0. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3028 | "title": "A String", # Required. The title of the job, such as "Software Engineer" |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3029 | # |
| 3030 | # The maximum number of allowed characters is 500. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3031 | "companyDisplayName": "A String", # Output only. Display name of the company listing the job. |
| 3032 | "requisitionId": "A String", # Required. The requisition ID, also referred to as the posting ID, assigned by the |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3033 | # client to identify a job. This field is intended to be used by clients |
| 3034 | # for client identification and tracking of postings. A job is not allowed |
| 3035 | # to be created if there is another job with the same [company_name], |
| 3036 | # language_code and requisition_id. |
| 3037 | # |
| 3038 | # The maximum number of allowed characters is 255. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3039 | "qualifications": "A String", # Optional. A description of the qualifications required to perform the |
| 3040 | # job. The use of this field is recommended |
| 3041 | # as an alternative to using the more general description field. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3042 | # |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3043 | # This field accepts and sanitizes HTML input, and also accepts |
| 3044 | # bold, italic, ordered list, and unordered list markup tags. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3045 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3046 | # The maximum number of allowed characters is 10,000. |
| 3047 | "processingOptions": { # Input only. # Optional. Options for job processing. |
| 3048 | # |
| 3049 | # Options for job processing. |
| 3050 | "disableStreetAddressResolution": True or False, # Optional. If set to `true`, the service does not attempt to resolve a |
| 3051 | # more precise address for the job. |
| 3052 | "htmlSanitization": "A String", # Optional. Option for job HTML content sanitization. Applied fields are: |
| 3053 | # |
| 3054 | # * description |
| 3055 | # * applicationInfo.instruction |
| 3056 | # * incentives |
| 3057 | # * qualifications |
| 3058 | # * responsibilities |
| 3059 | # |
| 3060 | # HTML tags in these fields may be stripped if sanitiazation is not |
| 3061 | # disabled. |
| 3062 | # |
| 3063 | # Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY. |
| 3064 | }, |
| 3065 | "jobEndTime": "A String", # Optional. The end timestamp of the job. Typically this field is used for contracting |
| 3066 | # engagements. Invalid timestamps are ignored. |
| 3067 | "derivedInfo": { # Output only. # Output only. Derived details about the job posting. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3068 | # |
| 3069 | # Derived details about the job posting. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3070 | "jobCategories": [ # Job categories derived from Job.title and Job.description. |
| 3071 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3072 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3073 | "locations": [ # Structured locations of the job, resolved from Job.addresses. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3074 | # |
| 3075 | # locations are exactly matched to Job.addresses in the same |
| 3076 | # order. |
| 3077 | { # Output only. |
| 3078 | # |
| 3079 | # A resource that represents a location with full geographic information. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3080 | "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3081 | # of doubles representing degrees latitude and degrees longitude. Unless |
| 3082 | # specified otherwise, this must conform to the |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3083 | # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3084 | # standard</a>. Values must be within normalized ranges. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3085 | "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. |
| 3086 | "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3087 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3088 | "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3089 | # such as postal delivery and payments addresses. Given a postal address, |
| 3090 | # a postal service can deliver items to a premises, P.O. Box, or other |
| 3091 | # delivery location. |
| 3092 | # Given a postal address, a postal service can deliver items to a premise, P.O. |
| 3093 | # Box or similar. |
| 3094 | # It is not intended to model geographical locations (roads, towns, |
| 3095 | # mountains). |
| 3096 | # |
| 3097 | # In typical usage an address would be created via user input or from importing |
| 3098 | # existing data, depending on the type of process. |
| 3099 | # |
| 3100 | # Advice on address input / editing: |
| 3101 | # - Use an i18n-ready address widget such as |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3102 | # https://github.com/google/libaddressinput) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3103 | # - Users should not be presented with UI elements for input or editing of |
| 3104 | # fields outside countries where that field is used. |
| 3105 | # |
| 3106 | # For more guidance on how to use this schema, please see: |
| 3107 | # https://support.google.com/business/answer/6397478 |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3108 | "sublocality": "A String", # Optional. Sublocality of the address. |
| 3109 | # For example, this can be neighborhoods, boroughs, districts. |
| 3110 | "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is |
| 3111 | # the latest revision. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3112 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3113 | # All new revisions **must** be backward compatible with old revisions. |
| 3114 | "locality": "A String", # Optional. Generally refers to the city/town portion of the address. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3115 | # Examples: US city, IT comune, UK post town. |
| 3116 | # In regions of the world where localities are not well defined or do not fit |
| 3117 | # into this structure well, leave locality empty and use address_lines. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3118 | "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3119 | # addresses of a country or region. |
| 3120 | # For example, this can be a state, a province, an oblast, or a prefecture. |
| 3121 | # Specifically, for Spain this is the province and not the autonomous |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3122 | # community (e.g. "Barcelona" and not "Catalonia"). |
| 3123 | # Many countries don't use an administrative area in postal addresses. E.g. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3124 | # in Switzerland this should be left unpopulated. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3125 | "organization": "A String", # Optional. The name of the organization at the address. |
| 3126 | "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This |
| 3127 | # is never inferred and it is up to the user to ensure the value is |
| 3128 | # correct. See http://cldr.unicode.org/ and |
| 3129 | # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html |
| 3130 | # for details. Example: "CH" for Switzerland. |
| 3131 | "addressLines": [ # Unstructured address lines describing the lower levels of an address. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3132 | # |
| 3133 | # Because values in address_lines do not have type information and may |
| 3134 | # sometimes contain multiple values in a single field (e.g. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3135 | # "Austin, TX"), it is important that the line order is clear. The order of |
| 3136 | # address lines should be "envelope order" for the country/region of the |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3137 | # address. In places where this can vary (e.g. Japan), address_language is |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3138 | # used to make it explicit (e.g. "ja" for large-to-small ordering and |
| 3139 | # "ja-Latn" or "en" for small-to-large). This way, the most specific line of |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3140 | # an address can be selected based on the language. |
| 3141 | # |
| 3142 | # The minimum permitted structural representation of an address consists |
| 3143 | # of a region_code with all remaining information placed in the |
| 3144 | # address_lines. It would be possible to format such an address very |
| 3145 | # approximately without geocoding, but no semantic reasoning could be |
| 3146 | # made about any of the address components until it was at least |
| 3147 | # partially resolved. |
| 3148 | # |
| 3149 | # Creating an address only containing a region_code and address_lines, and |
| 3150 | # then geocoding is the recommended way to handle completely unstructured |
| 3151 | # addresses (as opposed to guessing which parts of the address should be |
| 3152 | # localities or administrative areas). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3153 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3154 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3155 | "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3156 | # postal codes to be present, but where they are used, they may trigger |
| 3157 | # additional validation with other parts of the address (e.g. state/zip |
| 3158 | # validation in the U.S.A.). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3159 | "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if |
| 3160 | # known). This is often the UI language of the input form or is expected |
| 3161 | # to match one of the languages used in the address' country/region, or their |
| 3162 | # transliterated equivalents. |
| 3163 | # This can affect formatting in certain countries, but is not critical |
| 3164 | # to the correctness of the data and will never affect any validation or |
| 3165 | # other non-formatting related operations. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3166 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3167 | # If this value is not known, it should be omitted (rather than specifying a |
| 3168 | # possibly incorrect default). |
| 3169 | # |
| 3170 | # Examples: "zh-Hant", "ja", "ja-Latn", "en". |
| 3171 | "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used |
| 3172 | # in most regions. Where it is used, the value is either a string like |
| 3173 | # "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number |
| 3174 | # alone, representing the "sector code" (Jamaica), "delivery area indicator" |
| 3175 | # (Malawi) or "post office indicator" (e.g. Côte d'Ivoire). |
| 3176 | "recipients": [ # Optional. The recipient at the address. |
| 3177 | # This field may, under certain circumstances, contain multiline information. |
| 3178 | # For example, it might contain "care of" information. |
| 3179 | "A String", |
| 3180 | ], |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3181 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3182 | "locationType": "A String", # The type of a location, which corresponds to the address lines field of |
| 3183 | # PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of |
| 3184 | # LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of |
| 3185 | # LocationType#LOCALITY. |
| 3186 | "radiusInMiles": 3.14, # Radius in miles of the job location. This value is derived from the |
| 3187 | # location bounding box in which a circle with the specified radius |
| 3188 | # centered from LatLng covers the area associated with the job location. |
| 3189 | # For example, currently, "Mountain View, CA, USA" has a radius of |
| 3190 | # 6.17 miles. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3191 | }, |
| 3192 | ], |
| 3193 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3194 | "employmentTypes": [ # Optional. The employment type(s) of a job, for example, |
| 3195 | # full time or |
| 3196 | # part time. |
| 3197 | "A String", |
| 3198 | ], |
| 3199 | "incentives": "A String", # Optional. A description of bonus, commission, and other compensation |
| 3200 | # incentives associated with the job not including salary or pay. |
| 3201 | # |
| 3202 | # The maximum number of allowed characters is 10,000. |
| 3203 | "postingCreateTime": "A String", # Output only. The timestamp when this job posting was created. |
| 3204 | "addresses": [ # Optional but strongly recommended for the best service experience. |
| 3205 | # |
| 3206 | # Location(s) where the employer is looking to hire for this job posting. |
| 3207 | # |
| 3208 | # Specifying the full street address(es) of the hiring location enables |
| 3209 | # better API results, especially job searches by commute time. |
| 3210 | # |
| 3211 | # At most 50 locations are allowed for best search performance. If a job has |
| 3212 | # more locations, it is suggested to split it into multiple jobs with unique |
| 3213 | # requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as |
| 3214 | # multiple jobs with the same company_name, language_code and |
| 3215 | # requisition_id are not allowed. If the original requisition_id must |
| 3216 | # be preserved, a custom field should be used for storage. It is also |
| 3217 | # suggested to group the locations that close to each other in the same job |
| 3218 | # for better search experience. |
| 3219 | # |
| 3220 | # The maximum number of allowed characters is 500. |
| 3221 | "A String", |
| 3222 | ], |
| 3223 | "companyName": "A String", # Required. The resource name of the company listing the job, such as |
| 3224 | # "projects/api-test-project/companies/foo". |
| 3225 | "description": "A String", # Required. The description of the job, which typically includes a multi-paragraph |
| 3226 | # description of the company and related information. Separate fields are |
| 3227 | # provided on the job object for responsibilities, |
| 3228 | # qualifications, and other job characteristics. Use of |
| 3229 | # these separate job fields is recommended. |
| 3230 | # |
| 3231 | # This field accepts and sanitizes HTML input, and also accepts |
| 3232 | # bold, italic, ordered list, and unordered list markup tags. |
| 3233 | # |
| 3234 | # The maximum number of allowed characters is 100,000. |
| 3235 | "jobStartTime": "A String", # Optional. The start timestamp of the job in UTC time zone. Typically this field |
| 3236 | # is used for contracting engagements. Invalid timestamps are ignored. |
| 3237 | "degreeTypes": [ # Optional. The desired education degrees for the job, such as Bachelors, Masters. |
| 3238 | "A String", |
| 3239 | ], |
| 3240 | "compensationInfo": { # Job compensation details. # Optional. Job compensation information. |
| 3241 | "annualizedBaseCompensationRange": { # Compensation range. # Output only. Annualized base compensation range. Computed as |
| 3242 | # base compensation entry's CompensationEntry.compensation times |
| 3243 | # CompensationEntry.expected_units_per_year. |
| 3244 | # |
| 3245 | # See CompensationEntry for explanation on compensation annualization. |
| 3246 | "maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set |
| 3247 | # to a maximal compensation value and the currency code is set to |
| 3248 | # match the currency code of |
| 3249 | # min_compensation. |
| 3250 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 3251 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 3252 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 3253 | # If `units` is positive, `nanos` must be positive or zero. |
| 3254 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 3255 | # If `units` is negative, `nanos` must be negative or zero. |
| 3256 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 3257 | "units": "A String", # The whole units of the amount. |
| 3258 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 3259 | }, |
| 3260 | "minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set |
| 3261 | # to zero and the currency code is set to match the |
| 3262 | # currency code of max_compensation. |
| 3263 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 3264 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 3265 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 3266 | # If `units` is positive, `nanos` must be positive or zero. |
| 3267 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 3268 | # If `units` is negative, `nanos` must be negative or zero. |
| 3269 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 3270 | "units": "A String", # The whole units of the amount. |
| 3271 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 3272 | }, |
| 3273 | }, |
| 3274 | "annualizedTotalCompensationRange": { # Compensation range. # Output only. Annualized total compensation range. Computed as |
| 3275 | # all compensation entries' CompensationEntry.compensation times |
| 3276 | # CompensationEntry.expected_units_per_year. |
| 3277 | # |
| 3278 | # See CompensationEntry for explanation on compensation annualization. |
| 3279 | "maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set |
| 3280 | # to a maximal compensation value and the currency code is set to |
| 3281 | # match the currency code of |
| 3282 | # min_compensation. |
| 3283 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 3284 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 3285 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 3286 | # If `units` is positive, `nanos` must be positive or zero. |
| 3287 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 3288 | # If `units` is negative, `nanos` must be negative or zero. |
| 3289 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 3290 | "units": "A String", # The whole units of the amount. |
| 3291 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 3292 | }, |
| 3293 | "minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set |
| 3294 | # to zero and the currency code is set to match the |
| 3295 | # currency code of max_compensation. |
| 3296 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 3297 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 3298 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 3299 | # If `units` is positive, `nanos` must be positive or zero. |
| 3300 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 3301 | # If `units` is negative, `nanos` must be negative or zero. |
| 3302 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 3303 | "units": "A String", # The whole units of the amount. |
| 3304 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 3305 | }, |
| 3306 | }, |
| 3307 | "entries": [ # Optional. Job compensation information. |
| 3308 | # |
| 3309 | # At most one entry can be of type |
| 3310 | # CompensationInfo.CompensationType.BASE, which is |
| 3311 | # referred as ** base compensation entry ** for the job. |
| 3312 | { # A compensation entry that represents one component of compensation, such |
| 3313 | # as base pay, bonus, or other compensation type. |
| 3314 | # |
| 3315 | # Annualization: One compensation entry can be annualized if |
| 3316 | # - it contains valid amount or range. |
| 3317 | # - and its expected_units_per_year is set or can be derived. |
| 3318 | # Its annualized range is determined as (amount or range) times |
| 3319 | # expected_units_per_year. |
| 3320 | "unit": "A String", # Optional. Frequency of the specified amount. |
| 3321 | # |
| 3322 | # Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED. |
| 3323 | "amount": { # Represents an amount of money with its currency type. # Optional. Compensation amount. |
| 3324 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 3325 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 3326 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 3327 | # If `units` is positive, `nanos` must be positive or zero. |
| 3328 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 3329 | # If `units` is negative, `nanos` must be negative or zero. |
| 3330 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 3331 | "units": "A String", # The whole units of the amount. |
| 3332 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 3333 | }, |
| 3334 | "type": "A String", # Optional. Compensation type. |
| 3335 | # |
| 3336 | # Default is CompensationUnit.COMPENSATION_TYPE_UNSPECIFIED. |
| 3337 | "range": { # Compensation range. # Optional. Compensation range. |
| 3338 | "maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set |
| 3339 | # to a maximal compensation value and the currency code is set to |
| 3340 | # match the currency code of |
| 3341 | # min_compensation. |
| 3342 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 3343 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 3344 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 3345 | # If `units` is positive, `nanos` must be positive or zero. |
| 3346 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 3347 | # If `units` is negative, `nanos` must be negative or zero. |
| 3348 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 3349 | "units": "A String", # The whole units of the amount. |
| 3350 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 3351 | }, |
| 3352 | "minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set |
| 3353 | # to zero and the currency code is set to match the |
| 3354 | # currency code of max_compensation. |
| 3355 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 3356 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 3357 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 3358 | # If `units` is positive, `nanos` must be positive or zero. |
| 3359 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 3360 | # If `units` is negative, `nanos` must be negative or zero. |
| 3361 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 3362 | "units": "A String", # The whole units of the amount. |
| 3363 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 3364 | }, |
| 3365 | }, |
| 3366 | "expectedUnitsPerYear": 3.14, # Optional. Expected number of units paid each year. If not specified, when |
| 3367 | # Job.employment_types is FULLTIME, a default value is inferred |
| 3368 | # based on unit. Default values: |
| 3369 | # - HOURLY: 2080 |
| 3370 | # - DAILY: 260 |
| 3371 | # - WEEKLY: 52 |
| 3372 | # - MONTHLY: 12 |
| 3373 | # - ANNUAL: 1 |
| 3374 | "description": "A String", # Optional. Compensation description. For example, could |
| 3375 | # indicate equity terms or provide additional context to an estimated |
| 3376 | # bonus. |
| 3377 | }, |
| 3378 | ], |
| 3379 | }, |
| 3380 | "responsibilities": "A String", # Optional. A description of job responsibilities. The use of this field is |
| 3381 | # recommended as an alternative to using the more general description |
| 3382 | # field. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3383 | # |
| 3384 | # This field accepts and sanitizes HTML input, and also accepts |
| 3385 | # bold, italic, ordered list, and unordered list markup tags. |
| 3386 | # |
| 3387 | # The maximum number of allowed characters is 10,000. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3388 | "department": "A String", # Optional. The department or functional area within the company with the open |
| 3389 | # position. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3390 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3391 | # The maximum number of allowed characters is 255. |
| 3392 | "applicationInfo": { # Application related details of a job posting. # Required. At least one field within ApplicationInfo must be specified. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3393 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3394 | # Job application information. |
| 3395 | "uris": [ # Optional but at least one of uris, |
| 3396 | # emails or instruction must be |
| 3397 | # specified. |
| 3398 | # |
| 3399 | # Use this URI field to direct an applicant to a website, for example to |
| 3400 | # link to an online application form. |
| 3401 | # |
| 3402 | # The maximum number of allowed characters for each entry is 2,000. |
| 3403 | "A String", |
| 3404 | ], |
| 3405 | "emails": [ # Optional but at least one of uris, |
| 3406 | # emails or instruction must be |
| 3407 | # specified. |
| 3408 | # |
| 3409 | # Use this field to specify email address(es) to which resumes or |
| 3410 | # applications can be sent. |
| 3411 | # |
| 3412 | # The maximum number of allowed characters for each entry is 255. |
| 3413 | "A String", |
| 3414 | ], |
| 3415 | "instruction": "A String", # Optional but at least one of uris, |
| 3416 | # emails or instruction must be |
| 3417 | # specified. |
| 3418 | # |
| 3419 | # Use this field to provide instructions, such as "Mail your application |
| 3420 | # to ...", that a candidate can follow to apply for the job. |
| 3421 | # |
| 3422 | # This field accepts and sanitizes HTML input, and also accepts |
| 3423 | # bold, italic, ordered list, and unordered list markup tags. |
| 3424 | # |
| 3425 | # The maximum number of allowed characters is 3,000. |
| 3426 | }, |
| 3427 | "postingExpireTime": "A String", # Optional but strongly recommended for the best service |
| 3428 | # experience. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3429 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3430 | # The expiration timestamp of the job. After this timestamp, the |
| 3431 | # job is marked as expired, and it no longer appears in search results. The |
| 3432 | # expired job can't be deleted or listed by the DeleteJob and |
| 3433 | # ListJobs APIs, but it can be retrieved with the GetJob API or |
| 3434 | # updated with the UpdateJob API. An expired job can be updated and |
| 3435 | # opened again by using a future expiration timestamp. Updating an expired |
| 3436 | # job fails if there is another existing open job with same company_name, |
| 3437 | # language_code and requisition_id. |
| 3438 | # |
| 3439 | # The expired jobs are retained in our system for 90 days. However, the |
| 3440 | # overall expired job count cannot exceed 3 times the maximum of open jobs |
| 3441 | # count over the past week, otherwise jobs with earlier expire time are |
| 3442 | # cleaned first. Expired jobs are no longer accessible after they are cleaned |
| 3443 | # out. |
| 3444 | # |
| 3445 | # Invalid timestamps are ignored, and treated as expire time not provided. |
| 3446 | # |
| 3447 | # Timestamp before the instant request is made is considered valid, the job |
| 3448 | # will be treated as expired immediately. |
| 3449 | # |
| 3450 | # If this value is not provided at the time of job creation or is invalid, |
| 3451 | # the job posting expires after 30 days from the job's creation time. For |
| 3452 | # example, if the job was created on 2017/01/01 13:00AM UTC with an |
| 3453 | # unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC. |
| 3454 | # |
| 3455 | # If this value is not provided on job update, it depends on the field masks |
| 3456 | # set by UpdateJobRequest.update_mask. If the field masks include |
| 3457 | # expiry_time, or the masks are empty meaning that every field is |
| 3458 | # updated, the job posting expires after 30 days from the job's last |
| 3459 | # update time. Otherwise the expiration date isn't updated. |
| 3460 | "postingRegion": "A String", # Optional. The job PostingRegion (for example, state, country) throughout which |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3461 | # the job is available. If this field is set, a |
| 3462 | # LocationFilter in a search query within the job region |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3463 | # finds this job posting if an exact location match isn't specified. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3464 | # If this field is set to PostingRegion.NATION or |
| 3465 | # PostingRegion.ADMINISTRATIVE_AREA, setting job Job.addresses |
| 3466 | # to the same location level as this field is strongly recommended. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3467 | "postingPublishTime": "A String", # Optional. The timestamp this job posting was most recently published. The default |
| 3468 | # value is the time the request arrives at the server. Invalid timestamps are |
| 3469 | # ignored. |
| 3470 | "customAttributes": { # Optional. A map of fields to hold both filterable and non-filterable custom job |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3471 | # attributes that are not covered by the provided structured fields. |
| 3472 | # |
| 3473 | # The keys of the map are strings up to 64 bytes and must match the |
| 3474 | # pattern: a-zA-Z*. For example, key0LikeThis or |
| 3475 | # KEY_1_LIKE_THIS. |
| 3476 | # |
| 3477 | # At most 100 filterable and at most 100 unfilterable keys are supported. |
| 3478 | # For filterable `string_values`, across all keys at most 200 values are |
| 3479 | # allowed, with each string no more than 255 characters. For unfilterable |
| 3480 | # `string_values`, the maximum total size of `string_values` across all keys |
| 3481 | # is 50KB. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3482 | "a_key": { # Custom attribute values that are either filterable or non-filterable. |
| 3483 | "stringValues": [ # Optional but exactly one of string_values or long_values must |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3484 | # be specified. |
| 3485 | # |
| 3486 | # This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or |
| 3487 | # `CASE_INSENSITIVE_MATCH`) search. |
| 3488 | # For filterable `string_value`s, a maximum total number of 200 values |
| 3489 | # is allowed, with each `string_value` has a byte size of no more than |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3490 | # 500B. For unfilterable `string_values`, the maximum total byte size of |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3491 | # unfilterable `string_values` is 50KB. |
| 3492 | # |
| 3493 | # Empty string is not allowed. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3494 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3495 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3496 | "filterable": True or False, # Optional. If the `filterable` flag is true, the custom field values may be used for |
| 3497 | # custom attribute filters JobQuery.custom_attribute_filter. |
| 3498 | # If false, these values may not be used for custom attribute filters. |
| 3499 | # |
| 3500 | # Default is false. |
| 3501 | "longValues": [ # Optional but exactly one of string_values or long_values must |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3502 | # be specified. |
| 3503 | # |
| 3504 | # This field is used to perform number range search. |
| 3505 | # (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`. |
| 3506 | # |
| 3507 | # Currently at most 1 long_values is supported. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3508 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3509 | ], |
| 3510 | }, |
| 3511 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3512 | }</pre> |
| 3513 | </div> |
| 3514 | |
| 3515 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3516 | <code class="details" id="search">search(parent, body=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3517 | <pre>Searches for jobs using the provided SearchJobsRequest. |
| 3518 | |
| 3519 | This call constrains the visibility of jobs |
| 3520 | present in the database, and only returns jobs that the caller has |
| 3521 | permission to search against. |
| 3522 | |
| 3523 | Args: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3524 | parent: string, Required. The resource name of the project to search within. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3525 | |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3526 | The format is "projects/{project_id}", for example, |
| 3527 | "projects/api-test-project". (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3528 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3529 | The object takes the form of: |
| 3530 | |
| 3531 | { # Input only. |
| 3532 | # |
| 3533 | # The Request body of the `SearchJobs` call. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3534 | "pageSize": 42, # Optional. A limit on the number of jobs returned in the search results. |
| 3535 | # Increasing this value above the default value of 10 can increase search |
| 3536 | # response time. The value can be between 1 and 100. |
| 3537 | "histogramFacets": { # Input only. # Optional. Histogram requests for jobs matching JobQuery. |
| 3538 | # |
| 3539 | # Histogram facets to be specified in SearchJobsRequest. |
| 3540 | "customAttributeHistogramFacets": [ # Optional. Specifies the custom attributes histogram requests. |
| 3541 | # Duplicate values of CustomAttributeHistogramRequest.key are not |
| 3542 | # allowed. |
| 3543 | { # Custom attributes histogram request. An error is thrown if neither |
| 3544 | # string_value_histogram or long_value_histogram_bucketing_option has |
| 3545 | # been defined. |
| 3546 | "longValueHistogramBucketingOption": { # Input only. # Optional. Specifies buckets used to perform a range histogram on Job's |
| 3547 | # filterable long custom field values, or min/max value requirements. |
| 3548 | # |
| 3549 | # Use this field to specify bucketing option for the histogram search response. |
| 3550 | "requiresMinMax": True or False, # Optional. If set to true, the histogram result includes minimum/maximum |
| 3551 | # value of the numeric field. |
| 3552 | "bucketBounds": [ # Required. Two adjacent values form a histogram bucket. Values should be in |
| 3553 | # ascending order. For example, if [5, 10, 15] are provided, four buckets are |
| 3554 | # created: (-inf, 5), 5, 10), [10, 15), [15, inf). At most 20 |
| 3555 | # [buckets_bound is supported. |
| 3556 | 3.14, |
| 3557 | ], |
| 3558 | }, |
| 3559 | "key": "A String", # Required. Specifies the custom field key to perform a histogram on. If specified |
| 3560 | # without `long_value_histogram_bucketing_option`, histogram on string values |
| 3561 | # of the given `key` is triggered, otherwise histogram is performed on long |
| 3562 | # values. |
| 3563 | "stringValueHistogram": True or False, # Optional. If set to true, the response includes the histogram value for |
| 3564 | # each key as a string. |
| 3565 | }, |
| 3566 | ], |
| 3567 | "simpleHistogramFacets": [ # Optional. Specifies the simple type of histogram facets, for example, |
| 3568 | # `COMPANY_SIZE`, `EMPLOYMENT_TYPE` etc. |
| 3569 | "A String", |
| 3570 | ], |
| 3571 | "compensationHistogramFacets": [ # Optional. Specifies compensation field-based histogram requests. |
| 3572 | # Duplicate values of CompensationHistogramRequest.type are not allowed. |
| 3573 | { # Input only. |
| 3574 | # |
| 3575 | # Compensation based histogram request. |
| 3576 | "bucketingOption": { # Input only. # Required. Numeric histogram options, like buckets, whether include min or max value. |
| 3577 | # |
| 3578 | # Use this field to specify bucketing option for the histogram search response. |
| 3579 | "requiresMinMax": True or False, # Optional. If set to true, the histogram result includes minimum/maximum |
| 3580 | # value of the numeric field. |
| 3581 | "bucketBounds": [ # Required. Two adjacent values form a histogram bucket. Values should be in |
| 3582 | # ascending order. For example, if [5, 10, 15] are provided, four buckets are |
| 3583 | # created: (-inf, 5), 5, 10), [10, 15), [15, inf). At most 20 |
| 3584 | # [buckets_bound is supported. |
| 3585 | 3.14, |
| 3586 | ], |
| 3587 | }, |
| 3588 | "type": "A String", # Required. Type of the request, representing which field the histogramming should be |
| 3589 | # performed over. A single request can only specify one histogram of each |
| 3590 | # `CompensationHistogramRequestType`. |
| 3591 | }, |
| 3592 | ], |
| 3593 | }, |
| 3594 | "orderBy": "A String", # Optional. The criteria determining how search results are sorted. Default is |
| 3595 | # "relevance desc". |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3596 | # |
| 3597 | # Supported options are: |
| 3598 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3599 | # * `"relevance desc"`: By relevance descending, as determined by the API |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3600 | # algorithms. Relevance thresholding of query results is only available |
| 3601 | # with this ordering. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3602 | # * `"posting_publish_time desc"`: By Job.posting_publish_time |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3603 | # descending. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3604 | # * `"posting_update_time desc"`: By Job.posting_update_time |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3605 | # descending. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3606 | # * `"title"`: By Job.title ascending. |
| 3607 | # * `"title desc"`: By Job.title descending. |
| 3608 | # * `"annualized_base_compensation"`: By job's |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3609 | # CompensationInfo.annualized_base_compensation_range ascending. Jobs |
| 3610 | # whose annualized base compensation is unspecified are put at the end of |
| 3611 | # search results. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3612 | # * `"annualized_base_compensation desc"`: By job's |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3613 | # CompensationInfo.annualized_base_compensation_range descending. Jobs |
| 3614 | # whose annualized base compensation is unspecified are put at the end of |
| 3615 | # search results. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3616 | # * `"annualized_total_compensation"`: By job's |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3617 | # CompensationInfo.annualized_total_compensation_range ascending. Jobs |
| 3618 | # whose annualized base compensation is unspecified are put at the end of |
| 3619 | # search results. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3620 | # * `"annualized_total_compensation desc"`: By job's |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3621 | # CompensationInfo.annualized_total_compensation_range descending. Jobs |
| 3622 | # whose annualized base compensation is unspecified are put at the end of |
| 3623 | # search results. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3624 | "jobQuery": { # Input only. # Optional. Query used to search against jobs, such as keyword, location filters, etc. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3625 | # |
| 3626 | # The query required to perform a search query. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3627 | "queryLanguageCode": "A String", # The language code of query. For example, "en-US". This field helps to |
| 3628 | # better interpret the query. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3629 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3630 | # If a value isn't specified, the query language code is automatically |
| 3631 | # detected, which may not be accurate. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3632 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3633 | # Language code should be in BCP-47 format, such as "en-US" or "sr-Latn". |
| 3634 | # For more information, see |
| 3635 | # [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). |
| 3636 | "employmentTypes": [ # Optional. The employment type filter specifies the employment type of jobs to |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3637 | # search against, such as EmploymentType.FULL_TIME. |
| 3638 | # |
| 3639 | # If a value is not specified, jobs in the search results includes any |
| 3640 | # employment type. |
| 3641 | # |
| 3642 | # If multiple values are specified, jobs in the search results include |
| 3643 | # any of the specified employment types. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3644 | "A String", |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3645 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3646 | "customAttributeFilter": "A String", # Optional. This filter specifies a structured syntax to match against the |
| 3647 | # Job.custom_attributes marked as `filterable`. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3648 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3649 | # The syntax for this expression is a subset of SQL syntax. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3650 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3651 | # Supported operators are: `=`, `!=`, `<`, `<=`, `>`, and `>=` where the |
| 3652 | # left of the operator is a custom field key and the right of the operator |
| 3653 | # is a number or a quoted string. You must escape backslash (\\) and |
| 3654 | # quote (\") characters. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3655 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3656 | # Supported functions are `LOWER([field_name])` to |
| 3657 | # perform a case insensitive match and `EMPTY([field_name])` to filter on the |
| 3658 | # existence of a key. |
| 3659 | # |
| 3660 | # Boolean expressions (AND/OR/NOT) are supported up to 3 levels of |
| 3661 | # nesting (for example, "((A AND B AND C) OR NOT D) AND E"), a maximum of 100 |
| 3662 | # comparisons or functions are allowed in the expression. The expression |
| 3663 | # must be < 6000 bytes in length. |
| 3664 | # |
| 3665 | # Sample Query: |
| 3666 | # `(LOWER(driving_license)="class \"a\"" OR EMPTY(driving_license)) AND |
| 3667 | # driving_years > 10` |
| 3668 | "publishTimeRange": { # Message representing a period of time between two timestamps. # Optional. Jobs published within a range specified by this filter are searched |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3669 | # against. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3670 | "endTime": "A String", # End of the period. |
| 3671 | "startTime": "A String", # Begin of the period. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3672 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3673 | "locationFilters": [ # Optional. The location filter specifies geo-regions containing the jobs to |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3674 | # search against. See LocationFilter for more information. |
| 3675 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3676 | # If a location value isn't specified, jobs fitting the other search |
| 3677 | # criteria are retrieved regardless of where they're located. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3678 | # |
| 3679 | # If multiple values are specified, jobs are retrieved from any of the |
| 3680 | # specified locations. If different values are specified for the |
| 3681 | # LocationFilter.distance_in_miles parameter, the maximum provided |
| 3682 | # distance is used for all locations. |
| 3683 | # |
| 3684 | # At most 5 location filters are allowed. |
| 3685 | { # Input only. |
| 3686 | # |
| 3687 | # Geographic region of the search. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3688 | "telecommutePreference": "A String", # Optional. Allows the client to return jobs without a |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3689 | # set location, specifically, telecommuting jobs (telecommuting is considered |
| 3690 | # by the service as a special location. |
| 3691 | # Job.posting_region indicates if a job permits telecommuting. |
| 3692 | # If this field is set to TelecommutePreference.TELECOMMUTE_ALLOWED, |
| 3693 | # telecommuting jobs are searched, and address and lat_lng are |
| 3694 | # ignored. If not set or set to |
| 3695 | # TelecommutePreference.TELECOMMUTE_EXCLUDED, telecommute job are not |
| 3696 | # searched. |
| 3697 | # |
| 3698 | # This filter can be used by itself to search exclusively for telecommuting |
| 3699 | # jobs, or it can be combined with another location |
| 3700 | # filter to search for a combination of job locations, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3701 | # such as "Mountain View" or "telecommuting" jobs. However, when used in |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3702 | # combination with other location filters, telecommuting jobs can be |
| 3703 | # treated as less relevant than other jobs in the search response. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3704 | "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # Optional. The latitude and longitude of the geographic center from which to |
| 3705 | # search. This field's ignored if `address` is provided. |
| 3706 | # of doubles representing degrees latitude and degrees longitude. Unless |
| 3707 | # specified otherwise, this must conform to the |
| 3708 | # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 |
| 3709 | # standard</a>. Values must be within normalized ranges. |
| 3710 | "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. |
| 3711 | "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. |
| 3712 | }, |
| 3713 | "regionCode": "A String", # Optional. CLDR region code of the country/region of the address. This is used |
| 3714 | # to address ambiguity of the user-input location, for example, "Liverpool" |
| 3715 | # against "Liverpool, NY, US" or "Liverpool, UK". |
| 3716 | # |
| 3717 | # Set this field if all the jobs to search against are from a same region, |
| 3718 | # or jobs are world-wide, but the job seeker is from a specific region. |
| 3719 | # |
| 3720 | # See http://cldr.unicode.org/ and |
| 3721 | # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html |
| 3722 | # for details. Example: "CH" for Switzerland. |
| 3723 | "address": "A String", # Optional. The address name, such as "Mountain View" or "Bay Area". |
| 3724 | "distanceInMiles": 3.14, # Optional. The distance_in_miles is applied when the location being searched for is |
| 3725 | # identified as a city or smaller. When the location being searched for is a |
| 3726 | # state or larger, this field is ignored. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3727 | }, |
| 3728 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3729 | "languageCodes": [ # Optional. This filter specifies the locale of jobs to search against, |
| 3730 | # for example, "en-US". |
| 3731 | # |
| 3732 | # If a value isn't specified, the search results can contain jobs in any |
| 3733 | # locale. |
| 3734 | # |
| 3735 | # |
| 3736 | # Language codes should be in BCP-47 format, such as "en-US" or "sr-Latn". |
| 3737 | # For more information, see |
| 3738 | # [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). |
| 3739 | # |
| 3740 | # At most 10 language code filters are allowed. |
| 3741 | "A String", |
| 3742 | ], |
| 3743 | "commuteFilter": { # Input only. # Optional. Allows filtering jobs by commute time with different travel methods (for |
| 3744 | # example, driving or public transit). Note: This only works with COMMUTE |
| 3745 | # MODE. When specified, [JobQuery.location_filters] is |
| 3746 | # ignored. |
| 3747 | # |
| 3748 | # Currently we don't support sorting by commute time. |
| 3749 | # |
| 3750 | # Parameters needed for commute search. |
| 3751 | "roadTraffic": "A String", # Optional. Specifies the traffic density to use when calculating commute time. |
| 3752 | "allowImpreciseAddresses": True or False, # Optional. If true, jobs without "precise" addresses (street level addresses or GPS |
| 3753 | # coordinates) might also be returned. For city and coarser level addresses, |
| 3754 | # text matching is used. If this field is set to false or is not specified, |
| 3755 | # only jobs that include precise addresses are returned by Commute |
| 3756 | # Search. |
| 3757 | # |
| 3758 | # Note: If `allow_imprecise_addresses` is set to true, Commute Search is not |
| 3759 | # able to calculate accurate commute times to jobs with city level and |
| 3760 | # coarser address information. Jobs with imprecise addresses will return a |
| 3761 | # `travel_duration` time of 0 regardless of distance from the job seeker. |
| 3762 | "departureTime": { # Represents a time of day. The date and time zone are either not significant # Optional. The departure time used to calculate traffic impact, represented as |
| 3763 | # google.type.TimeOfDay in local time zone. |
| 3764 | # |
| 3765 | # Currently traffic model is restricted to hour level resolution. |
| 3766 | # or are specified elsewhere. An API may choose to allow leap seconds. Related |
| 3767 | # types are google.type.Date and `google.protobuf.Timestamp`. |
| 3768 | "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose |
| 3769 | # to allow the value "24:00:00" for scenarios like business closing time. |
| 3770 | "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
| 3771 | "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may |
| 3772 | # allow the value 60 if it allows leap-seconds. |
| 3773 | "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. |
| 3774 | }, |
| 3775 | "travelDuration": "A String", # Required. The maximum travel time in seconds. The maximum allowed value is `3600s` |
| 3776 | # (one hour). Format is `123s`. |
| 3777 | "startCoordinates": { # An object representing a latitude/longitude pair. This is expressed as a pair # Required. The latitude and longitude of the location from which to calculate the |
| 3778 | # commute time. |
| 3779 | # of doubles representing degrees latitude and degrees longitude. Unless |
| 3780 | # specified otherwise, this must conform to the |
| 3781 | # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 |
| 3782 | # standard</a>. Values must be within normalized ranges. |
| 3783 | "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. |
| 3784 | "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. |
| 3785 | }, |
| 3786 | "commuteMethod": "A String", # Required. The method of transportation for which to calculate the commute time. |
| 3787 | }, |
| 3788 | "query": "A String", # Optional. The query string that matches against the job title, description, and |
| 3789 | # location fields. |
| 3790 | # |
| 3791 | # The maximum number of allowed characters is 255. |
| 3792 | "compensationFilter": { # Input only. # Optional. This search filter is applied only to |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3793 | # Job.compensation_info. For example, if the filter is specified |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3794 | # as "Hourly job with per-hour compensation > $15", only jobs meeting |
| 3795 | # these criteria are searched. If a filter isn't defined, all open jobs |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3796 | # are searched. |
| 3797 | # |
| 3798 | # Filter on job compensation type and amount. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3799 | "type": "A String", # Required. Type of filter. |
| 3800 | "includeJobsWithUnspecifiedCompensationRange": True or False, # Optional. If set to true, jobs with unspecified compensation range fields are |
| 3801 | # included. |
| 3802 | "units": [ # Required. Specify desired `base compensation entry's` |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3803 | # CompensationInfo.CompensationUnit. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3804 | "A String", |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3805 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3806 | "range": { # Compensation range. # Optional. Compensation range. |
| 3807 | "maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3808 | # to a maximal compensation value and the currency code is set to |
| 3809 | # match the currency code of |
| 3810 | # min_compensation. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3811 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 3812 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3813 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 3814 | # If `units` is positive, `nanos` must be positive or zero. |
| 3815 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 3816 | # If `units` is negative, `nanos` must be negative or zero. |
| 3817 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3818 | "units": "A String", # The whole units of the amount. |
| 3819 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 3820 | }, |
| 3821 | "minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set |
| 3822 | # to zero and the currency code is set to match the |
| 3823 | # currency code of max_compensation. |
| 3824 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 3825 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 3826 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 3827 | # If `units` is positive, `nanos` must be positive or zero. |
| 3828 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 3829 | # If `units` is negative, `nanos` must be negative or zero. |
| 3830 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 3831 | "units": "A String", # The whole units of the amount. |
| 3832 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3833 | }, |
| 3834 | }, |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3835 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3836 | "companyDisplayNames": [ # Optional. This filter specifies the exact company display |
| 3837 | # name of the jobs to search against. |
| 3838 | # |
| 3839 | # If a value isn't specified, jobs within the search results are |
| 3840 | # associated with any company. |
| 3841 | # |
| 3842 | # If multiple values are specified, jobs within the search results may be |
| 3843 | # associated with any of the specified companies. |
| 3844 | # |
| 3845 | # At most 20 company display name filters are allowed. |
| 3846 | "A String", |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3847 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3848 | "disableSpellCheck": True or False, # Optional. This flag controls the spell-check feature. If false, the |
| 3849 | # service attempts to correct a misspelled query, |
| 3850 | # for example, "enginee" is corrected to "engineer". |
| 3851 | # |
| 3852 | # Defaults to false: a spell check is performed. |
| 3853 | "jobCategories": [ # Optional. The category filter specifies the categories of jobs to search against. |
| 3854 | # See Category for more information. |
| 3855 | # |
| 3856 | # If a value is not specified, jobs from any category are searched against. |
| 3857 | # |
| 3858 | # If multiple values are specified, jobs from any of the specified |
| 3859 | # categories are searched against. |
| 3860 | "A String", |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3861 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3862 | "companyNames": [ # Optional. This filter specifies the company entities to search against. |
| 3863 | # |
| 3864 | # If a value isn't specified, jobs are searched for against all |
| 3865 | # companies. |
| 3866 | # |
| 3867 | # If multiple values are specified, jobs are searched against the |
| 3868 | # companies specified. |
| 3869 | # |
| 3870 | # The format is "projects/{project_id}/companies/{company_id}", for example, |
| 3871 | # "projects/api-test-project/companies/foo". |
| 3872 | # |
| 3873 | # At most 20 company filters are allowed. |
| 3874 | "A String", |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3875 | ], |
| 3876 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3877 | "jobView": "A String", # Optional. The desired job attributes returned for jobs in the |
| 3878 | # search response. Defaults to JobView.SMALL if no value is specified. |
| 3879 | "requirePreciseResultSize": True or False, # Optional. Controls if the search job request requires the return of a precise |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3880 | # count of the first 300 results. Setting this to `true` ensures |
| 3881 | # consistency in the number of results per page. Best practice is to set this |
| 3882 | # value to true if a client allows users to jump directly to a |
| 3883 | # non-sequential search results page. |
| 3884 | # |
| 3885 | # Enabling this flag may adversely impact performance. |
| 3886 | # |
| 3887 | # Defaults to false. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3888 | "pageToken": "A String", # Optional. The token specifying the current offset within |
| 3889 | # search results. See SearchJobsResponse.next_page_token for |
| 3890 | # an explanation of how to obtain the next set of query results. |
| 3891 | "diversificationLevel": "A String", # Optional. Controls whether highly similar jobs are returned next to each other in |
| 3892 | # the search results. Jobs are identified as highly similar based on |
| 3893 | # their titles, job categories, and locations. Highly similar results are |
| 3894 | # clustered so that only one representative job of the cluster is |
| 3895 | # displayed to the job seeker higher up in the results, with the other jobs |
| 3896 | # being displayed lower down in the results. |
| 3897 | # |
| 3898 | # Defaults to DiversificationLevel.SIMPLE if no value |
| 3899 | # is specified. |
| 3900 | "searchMode": "A String", # Optional. Mode of a search. |
| 3901 | # |
| 3902 | # Defaults to SearchMode.JOB_SEARCH. |
| 3903 | "requestMetadata": { # Input only. # Required. The meta information collected about the job searcher, used to improve the |
| 3904 | # search quality of the service. The identifiers (such as `user_id`) are |
| 3905 | # provided by users, and must be unique and consistent. |
| 3906 | # |
| 3907 | # Meta information related to the job searcher or entity |
| 3908 | # conducting the job search. This information is used to improve the |
| 3909 | # performance of the service. |
| 3910 | "domain": "A String", # Required. The client-defined scope or source of the service call, which typically |
| 3911 | # is the domain on |
| 3912 | # which the service has been implemented and is currently being run. |
| 3913 | # |
| 3914 | # For example, if the service is being run by client <em>Foo, Inc.</em>, on |
| 3915 | # job board www.foo.com and career site www.bar.com, then this field is |
| 3916 | # set to "foo.com" for use on the job board, and "bar.com" for use on the |
| 3917 | # career site. |
| 3918 | # |
| 3919 | # If this field isn't available for some reason, send "UNKNOWN". |
| 3920 | # Any improvements to the model for a particular tenant site rely on this |
| 3921 | # field being set correctly to a domain. |
| 3922 | # |
| 3923 | # The maximum number of allowed characters is 255. |
| 3924 | "userId": "A String", # Required. A unique user identification string, as determined by the client. |
| 3925 | # To have the strongest positive impact on search quality |
| 3926 | # make sure the client-level is unique. |
| 3927 | # Obfuscate this field for privacy concerns before |
| 3928 | # providing it to the service. |
| 3929 | # |
| 3930 | # If this field is not available for some reason, send "UNKNOWN". Note |
| 3931 | # that any improvements to the model for a particular tenant |
| 3932 | # site, rely on this field being set correctly to a unique user_id. |
| 3933 | # |
| 3934 | # The maximum number of allowed characters is 255. |
| 3935 | "deviceInfo": { # Device information collected from the job seeker, candidate, or # Optional. The type of device used by the job seeker at the time of the call to the |
| 3936 | # service. |
| 3937 | # other entity conducting the job search. Providing this information improves |
| 3938 | # the quality of the search results across devices. |
| 3939 | "deviceType": "A String", # Optional. Type of the device. |
| 3940 | "id": "A String", # Optional. A device-specific ID. The ID must be a unique identifier that |
| 3941 | # distinguishes the device from other devices. |
| 3942 | }, |
| 3943 | "sessionId": "A String", # Required. A unique session identification string. A session is defined as the |
| 3944 | # duration of an end user's interaction with the service over a certain |
| 3945 | # period. |
| 3946 | # Obfuscate this field for privacy concerns before |
| 3947 | # providing it to the service. |
| 3948 | # |
| 3949 | # If this field is not available for some reason, send "UNKNOWN". Note |
| 3950 | # that any improvements to the model for a particular tenant |
| 3951 | # site, rely on this field being set correctly to some unique session_id. |
| 3952 | # |
| 3953 | # The maximum number of allowed characters is 255. |
| 3954 | }, |
| 3955 | "disableKeywordMatch": True or False, # Optional. Controls whether to disable exact keyword match on Job.job_title, |
| 3956 | # Job.description, Job.company_display_name, Job.locations, |
| 3957 | # Job.qualifications. When disable keyword match is turned off, a |
| 3958 | # keyword match returns jobs that do not match given category filters when |
| 3959 | # there are matching keywords. For example, the query "program manager," a |
| 3960 | # result is returned even if the job posting has the title "software |
| 3961 | # developer," which does not fall into "program manager" ontology, but does |
| 3962 | # have "program manager" appearing in its description. |
| 3963 | # |
| 3964 | # For queries like "cloud" that does not contain title or |
| 3965 | # location specific ontology, jobs with "cloud" keyword matches are returned |
| 3966 | # regardless of this flag's value. |
| 3967 | # |
| 3968 | # Please use Company.keyword_searchable_custom_fields or |
| 3969 | # Company.keyword_searchable_custom_attributes if company specific |
| 3970 | # globally matched custom field/attribute string values is needed. Enabling |
| 3971 | # keyword match improves recall of subsequent search requests. |
| 3972 | # |
| 3973 | # Defaults to false. |
| 3974 | "enableBroadening": True or False, # Optional. Controls whether to broaden the search when it produces sparse results. |
| 3975 | # Broadened queries append results to the end of the matching results |
| 3976 | # list. |
| 3977 | # |
| 3978 | # Defaults to false. |
| 3979 | "offset": 42, # Optional. An integer that specifies the current offset (that is, starting result |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3980 | # location, amongst the jobs deemed by the API as relevant) in search |
| 3981 | # results. This field is only considered if page_token is unset. |
| 3982 | # |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3983 | # The maximum allowed value is 5000. Otherwise an error is thrown. |
| 3984 | # |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3985 | # For example, 0 means to return results starting from the first matching |
| 3986 | # job, and 10 means to return from the 11th job. This can be used for |
| 3987 | # pagination, (for example, pageSize = 10 and offset = 10 means to return |
| 3988 | # from the second page). |
| 3989 | } |
| 3990 | |
| 3991 | x__xgafv: string, V1 error format. |
| 3992 | Allowed values |
| 3993 | 1 - v1 error format |
| 3994 | 2 - v2 error format |
| 3995 | |
| 3996 | Returns: |
| 3997 | An object of the form: |
| 3998 | |
| 3999 | { # Output only. |
| 4000 | # |
| 4001 | # Response for SearchJob method. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4002 | "locationFilters": [ # The location filters that the service applied to the specified query. If |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4003 | # any filters are lat-lng based, the JobLocation.location_type is |
| 4004 | # JobLocation.LocationType#LOCATION_TYPE_UNSPECIFIED. |
| 4005 | { # Output only. |
| 4006 | # |
| 4007 | # A resource that represents a location with full geographic information. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4008 | "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4009 | # of doubles representing degrees latitude and degrees longitude. Unless |
| 4010 | # specified otherwise, this must conform to the |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4011 | # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4012 | # standard</a>. Values must be within normalized ranges. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4013 | "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. |
| 4014 | "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4015 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4016 | "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4017 | # such as postal delivery and payments addresses. Given a postal address, |
| 4018 | # a postal service can deliver items to a premises, P.O. Box, or other |
| 4019 | # delivery location. |
| 4020 | # Given a postal address, a postal service can deliver items to a premise, P.O. |
| 4021 | # Box or similar. |
| 4022 | # It is not intended to model geographical locations (roads, towns, |
| 4023 | # mountains). |
| 4024 | # |
| 4025 | # In typical usage an address would be created via user input or from importing |
| 4026 | # existing data, depending on the type of process. |
| 4027 | # |
| 4028 | # Advice on address input / editing: |
| 4029 | # - Use an i18n-ready address widget such as |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4030 | # https://github.com/google/libaddressinput) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4031 | # - Users should not be presented with UI elements for input or editing of |
| 4032 | # fields outside countries where that field is used. |
| 4033 | # |
| 4034 | # For more guidance on how to use this schema, please see: |
| 4035 | # https://support.google.com/business/answer/6397478 |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4036 | "sublocality": "A String", # Optional. Sublocality of the address. |
| 4037 | # For example, this can be neighborhoods, boroughs, districts. |
| 4038 | "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is |
| 4039 | # the latest revision. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4040 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4041 | # All new revisions **must** be backward compatible with old revisions. |
| 4042 | "locality": "A String", # Optional. Generally refers to the city/town portion of the address. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4043 | # Examples: US city, IT comune, UK post town. |
| 4044 | # In regions of the world where localities are not well defined or do not fit |
| 4045 | # into this structure well, leave locality empty and use address_lines. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4046 | "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4047 | # addresses of a country or region. |
| 4048 | # For example, this can be a state, a province, an oblast, or a prefecture. |
| 4049 | # Specifically, for Spain this is the province and not the autonomous |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4050 | # community (e.g. "Barcelona" and not "Catalonia"). |
| 4051 | # Many countries don't use an administrative area in postal addresses. E.g. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4052 | # in Switzerland this should be left unpopulated. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4053 | "organization": "A String", # Optional. The name of the organization at the address. |
| 4054 | "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This |
| 4055 | # is never inferred and it is up to the user to ensure the value is |
| 4056 | # correct. See http://cldr.unicode.org/ and |
| 4057 | # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html |
| 4058 | # for details. Example: "CH" for Switzerland. |
| 4059 | "addressLines": [ # Unstructured address lines describing the lower levels of an address. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4060 | # |
| 4061 | # Because values in address_lines do not have type information and may |
| 4062 | # sometimes contain multiple values in a single field (e.g. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4063 | # "Austin, TX"), it is important that the line order is clear. The order of |
| 4064 | # address lines should be "envelope order" for the country/region of the |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4065 | # address. In places where this can vary (e.g. Japan), address_language is |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4066 | # used to make it explicit (e.g. "ja" for large-to-small ordering and |
| 4067 | # "ja-Latn" or "en" for small-to-large). This way, the most specific line of |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4068 | # an address can be selected based on the language. |
| 4069 | # |
| 4070 | # The minimum permitted structural representation of an address consists |
| 4071 | # of a region_code with all remaining information placed in the |
| 4072 | # address_lines. It would be possible to format such an address very |
| 4073 | # approximately without geocoding, but no semantic reasoning could be |
| 4074 | # made about any of the address components until it was at least |
| 4075 | # partially resolved. |
| 4076 | # |
| 4077 | # Creating an address only containing a region_code and address_lines, and |
| 4078 | # then geocoding is the recommended way to handle completely unstructured |
| 4079 | # addresses (as opposed to guessing which parts of the address should be |
| 4080 | # localities or administrative areas). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4081 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4082 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4083 | "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4084 | # postal codes to be present, but where they are used, they may trigger |
| 4085 | # additional validation with other parts of the address (e.g. state/zip |
| 4086 | # validation in the U.S.A.). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4087 | "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if |
| 4088 | # known). This is often the UI language of the input form or is expected |
| 4089 | # to match one of the languages used in the address' country/region, or their |
| 4090 | # transliterated equivalents. |
| 4091 | # This can affect formatting in certain countries, but is not critical |
| 4092 | # to the correctness of the data and will never affect any validation or |
| 4093 | # other non-formatting related operations. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4094 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4095 | # If this value is not known, it should be omitted (rather than specifying a |
| 4096 | # possibly incorrect default). |
| 4097 | # |
| 4098 | # Examples: "zh-Hant", "ja", "ja-Latn", "en". |
| 4099 | "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used |
| 4100 | # in most regions. Where it is used, the value is either a string like |
| 4101 | # "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number |
| 4102 | # alone, representing the "sector code" (Jamaica), "delivery area indicator" |
| 4103 | # (Malawi) or "post office indicator" (e.g. Côte d'Ivoire). |
| 4104 | "recipients": [ # Optional. The recipient at the address. |
| 4105 | # This field may, under certain circumstances, contain multiline information. |
| 4106 | # For example, it might contain "care of" information. |
| 4107 | "A String", |
| 4108 | ], |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4109 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4110 | "locationType": "A String", # The type of a location, which corresponds to the address lines field of |
| 4111 | # PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of |
| 4112 | # LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of |
| 4113 | # LocationType#LOCALITY. |
| 4114 | "radiusInMiles": 3.14, # Radius in miles of the job location. This value is derived from the |
| 4115 | # location bounding box in which a circle with the specified radius |
| 4116 | # centered from LatLng covers the area associated with the job location. |
| 4117 | # For example, currently, "Mountain View, CA, USA" has a radius of |
| 4118 | # 6.17 miles. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4119 | }, |
| 4120 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4121 | "histogramResults": { # Output only. # The histogram results that match specified |
| 4122 | # SearchJobsRequest.histogram_facets. |
| 4123 | # |
| 4124 | # Histogram results that match HistogramFacets specified in |
| 4125 | # SearchJobsRequest. |
| 4126 | "compensationHistogramResults": [ # Specifies compensation field-based histogram results that match |
| 4127 | # HistogramFacets.compensation_histogram_requests. |
| 4128 | { # Output only. |
| 4129 | # |
| 4130 | # Compensation based histogram result. |
| 4131 | "result": { # Output only. # Histogram result. |
| 4132 | # |
| 4133 | # Custom numeric bucketing result. |
| 4134 | "counts": [ # Count within each bucket. Its size is the length of |
| 4135 | # NumericBucketingOption.bucket_bounds plus 1. |
| 4136 | { # Represents count of jobs within one bucket. |
| 4137 | "range": { # Represents starting and ending value of a range in double. # Bucket range on which histogram was performed for the numeric field, |
| 4138 | # that is, the count represents number of jobs in this range. |
| 4139 | "to": 3.14, # Ending value of the bucket range. |
| 4140 | "from": 3.14, # Starting value of the bucket range. |
| 4141 | }, |
| 4142 | "count": 42, # Number of jobs whose numeric field value fall into `range`. |
| 4143 | }, |
| 4144 | ], |
| 4145 | "minValue": 3.14, # Stores the minimum value of the numeric field. Will be populated only if |
| 4146 | # [NumericBucketingOption.requires_min_max] is set to true. |
| 4147 | "maxValue": 3.14, # Stores the maximum value of the numeric field. Is populated only if |
| 4148 | # [NumericBucketingOption.requires_min_max] is set to true. |
| 4149 | }, |
| 4150 | "type": "A String", # Type of the request, corresponding to |
| 4151 | # CompensationHistogramRequest.type. |
| 4152 | }, |
| 4153 | ], |
| 4154 | "customAttributeHistogramResults": [ # Specifies histogram results for custom attributes that match |
| 4155 | # HistogramFacets.custom_attribute_histogram_facets. |
| 4156 | { # Output only. |
| 4157 | # |
| 4158 | # Custom attribute histogram result. |
| 4159 | "longValueHistogramResult": { # Output only. # Stores bucketed histogram counting result or min/max values for |
| 4160 | # custom attribute long values associated with `key`. |
| 4161 | # |
| 4162 | # Custom numeric bucketing result. |
| 4163 | "counts": [ # Count within each bucket. Its size is the length of |
| 4164 | # NumericBucketingOption.bucket_bounds plus 1. |
| 4165 | { # Represents count of jobs within one bucket. |
| 4166 | "range": { # Represents starting and ending value of a range in double. # Bucket range on which histogram was performed for the numeric field, |
| 4167 | # that is, the count represents number of jobs in this range. |
| 4168 | "to": 3.14, # Ending value of the bucket range. |
| 4169 | "from": 3.14, # Starting value of the bucket range. |
| 4170 | }, |
| 4171 | "count": 42, # Number of jobs whose numeric field value fall into `range`. |
| 4172 | }, |
| 4173 | ], |
| 4174 | "minValue": 3.14, # Stores the minimum value of the numeric field. Will be populated only if |
| 4175 | # [NumericBucketingOption.requires_min_max] is set to true. |
| 4176 | "maxValue": 3.14, # Stores the maximum value of the numeric field. Is populated only if |
| 4177 | # [NumericBucketingOption.requires_min_max] is set to true. |
| 4178 | }, |
| 4179 | "stringValueHistogramResult": { # Stores a map from the values of string custom field associated |
| 4180 | # with `key` to the number of jobs with that value in this histogram result. |
| 4181 | "a_key": 42, |
| 4182 | }, |
| 4183 | "key": "A String", # Stores the key of custom attribute the histogram is performed on. |
| 4184 | }, |
| 4185 | ], |
| 4186 | "simpleHistogramResults": [ # Specifies histogram results that matches |
| 4187 | # HistogramFacets.simple_histogram_facets. |
| 4188 | { # Output only. |
| 4189 | # |
| 4190 | # Result of a histogram call. The response contains the histogram map for the |
| 4191 | # search type specified by HistogramResult.field. |
| 4192 | # The response is a map of each filter value to the corresponding count of |
| 4193 | # jobs for that filter. |
| 4194 | "values": { # A map from the values of field to the number of jobs with that value |
| 4195 | # in this search result. |
| 4196 | # |
| 4197 | # Key: search type (filter names, such as the companyName). |
| 4198 | # |
| 4199 | # Values: the count of jobs that match the filter for this search. |
| 4200 | "a_key": 42, |
| 4201 | }, |
| 4202 | "searchType": "A String", # The Histogram search filters. |
| 4203 | }, |
| 4204 | ], |
| 4205 | }, |
| 4206 | "metadata": { # Output only. # Additional information for the API invocation, such as the request |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4207 | # tracking id. |
| 4208 | # |
| 4209 | # Additional information returned to client, such as debugging information. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4210 | "requestId": "A String", # A unique id associated with this call. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4211 | # This id is logged for tracking purposes. |
| 4212 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4213 | "matchingJobs": [ # The Job entities that match the specified SearchJobsRequest. |
| 4214 | { # Output only. |
| 4215 | # |
| 4216 | # Job entry with metadata inside SearchJobsResponse. |
| 4217 | "searchTextSnippet": "A String", # Contains snippets of text from the Job.description and similar |
| 4218 | # fields that most closely match a search query's keywords, if available. |
| 4219 | # All HTML tags in the original fields are stripped when returned in this |
| 4220 | # field, and matching query keywords are enclosed in HTML bold tags. |
| 4221 | "jobTitleSnippet": "A String", # Contains snippets of text from the Job.job_title field most |
| 4222 | # closely matching a search query's keywords, if available. The matching |
| 4223 | # query keywords are enclosed in HTML bold tags. |
| 4224 | "jobSummary": "A String", # A summary of the job with core information that's displayed on the search |
| 4225 | # results listing page. |
| 4226 | "commuteInfo": { # Output only. # Commute information which is generated based on specified |
| 4227 | # CommuteFilter. |
| 4228 | # |
| 4229 | # Commute details related to this job. |
| 4230 | "travelDuration": "A String", # The number of seconds required to travel to the job location from the |
| 4231 | # query location. A duration of 0 seconds indicates that the job is not |
| 4232 | # reachable within the requested duration, but was returned as part of an |
| 4233 | # expanded query. |
| 4234 | "jobLocation": { # Output only. # Location used as the destination in the commute calculation. |
| 4235 | # |
| 4236 | # A resource that represents a location with full geographic information. |
| 4237 | "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair. |
| 4238 | # of doubles representing degrees latitude and degrees longitude. Unless |
| 4239 | # specified otherwise, this must conform to the |
| 4240 | # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 |
| 4241 | # standard</a>. Values must be within normalized ranges. |
| 4242 | "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. |
| 4243 | "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. |
| 4244 | }, |
| 4245 | "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information, |
| 4246 | # such as postal delivery and payments addresses. Given a postal address, |
| 4247 | # a postal service can deliver items to a premises, P.O. Box, or other |
| 4248 | # delivery location. |
| 4249 | # Given a postal address, a postal service can deliver items to a premise, P.O. |
| 4250 | # Box or similar. |
| 4251 | # It is not intended to model geographical locations (roads, towns, |
| 4252 | # mountains). |
| 4253 | # |
| 4254 | # In typical usage an address would be created via user input or from importing |
| 4255 | # existing data, depending on the type of process. |
| 4256 | # |
| 4257 | # Advice on address input / editing: |
| 4258 | # - Use an i18n-ready address widget such as |
| 4259 | # https://github.com/google/libaddressinput) |
| 4260 | # - Users should not be presented with UI elements for input or editing of |
| 4261 | # fields outside countries where that field is used. |
| 4262 | # |
| 4263 | # For more guidance on how to use this schema, please see: |
| 4264 | # https://support.google.com/business/answer/6397478 |
| 4265 | "sublocality": "A String", # Optional. Sublocality of the address. |
| 4266 | # For example, this can be neighborhoods, boroughs, districts. |
| 4267 | "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is |
| 4268 | # the latest revision. |
| 4269 | # |
| 4270 | # All new revisions **must** be backward compatible with old revisions. |
| 4271 | "locality": "A String", # Optional. Generally refers to the city/town portion of the address. |
| 4272 | # Examples: US city, IT comune, UK post town. |
| 4273 | # In regions of the world where localities are not well defined or do not fit |
| 4274 | # into this structure well, leave locality empty and use address_lines. |
| 4275 | "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal |
| 4276 | # addresses of a country or region. |
| 4277 | # For example, this can be a state, a province, an oblast, or a prefecture. |
| 4278 | # Specifically, for Spain this is the province and not the autonomous |
| 4279 | # community (e.g. "Barcelona" and not "Catalonia"). |
| 4280 | # Many countries don't use an administrative area in postal addresses. E.g. |
| 4281 | # in Switzerland this should be left unpopulated. |
| 4282 | "organization": "A String", # Optional. The name of the organization at the address. |
| 4283 | "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This |
| 4284 | # is never inferred and it is up to the user to ensure the value is |
| 4285 | # correct. See http://cldr.unicode.org/ and |
| 4286 | # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html |
| 4287 | # for details. Example: "CH" for Switzerland. |
| 4288 | "addressLines": [ # Unstructured address lines describing the lower levels of an address. |
| 4289 | # |
| 4290 | # Because values in address_lines do not have type information and may |
| 4291 | # sometimes contain multiple values in a single field (e.g. |
| 4292 | # "Austin, TX"), it is important that the line order is clear. The order of |
| 4293 | # address lines should be "envelope order" for the country/region of the |
| 4294 | # address. In places where this can vary (e.g. Japan), address_language is |
| 4295 | # used to make it explicit (e.g. "ja" for large-to-small ordering and |
| 4296 | # "ja-Latn" or "en" for small-to-large). This way, the most specific line of |
| 4297 | # an address can be selected based on the language. |
| 4298 | # |
| 4299 | # The minimum permitted structural representation of an address consists |
| 4300 | # of a region_code with all remaining information placed in the |
| 4301 | # address_lines. It would be possible to format such an address very |
| 4302 | # approximately without geocoding, but no semantic reasoning could be |
| 4303 | # made about any of the address components until it was at least |
| 4304 | # partially resolved. |
| 4305 | # |
| 4306 | # Creating an address only containing a region_code and address_lines, and |
| 4307 | # then geocoding is the recommended way to handle completely unstructured |
| 4308 | # addresses (as opposed to guessing which parts of the address should be |
| 4309 | # localities or administrative areas). |
| 4310 | "A String", |
| 4311 | ], |
| 4312 | "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require |
| 4313 | # postal codes to be present, but where they are used, they may trigger |
| 4314 | # additional validation with other parts of the address (e.g. state/zip |
| 4315 | # validation in the U.S.A.). |
| 4316 | "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if |
| 4317 | # known). This is often the UI language of the input form or is expected |
| 4318 | # to match one of the languages used in the address' country/region, or their |
| 4319 | # transliterated equivalents. |
| 4320 | # This can affect formatting in certain countries, but is not critical |
| 4321 | # to the correctness of the data and will never affect any validation or |
| 4322 | # other non-formatting related operations. |
| 4323 | # |
| 4324 | # If this value is not known, it should be omitted (rather than specifying a |
| 4325 | # possibly incorrect default). |
| 4326 | # |
| 4327 | # Examples: "zh-Hant", "ja", "ja-Latn", "en". |
| 4328 | "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used |
| 4329 | # in most regions. Where it is used, the value is either a string like |
| 4330 | # "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number |
| 4331 | # alone, representing the "sector code" (Jamaica), "delivery area indicator" |
| 4332 | # (Malawi) or "post office indicator" (e.g. Côte d'Ivoire). |
| 4333 | "recipients": [ # Optional. The recipient at the address. |
| 4334 | # This field may, under certain circumstances, contain multiline information. |
| 4335 | # For example, it might contain "care of" information. |
| 4336 | "A String", |
| 4337 | ], |
| 4338 | }, |
| 4339 | "locationType": "A String", # The type of a location, which corresponds to the address lines field of |
| 4340 | # PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of |
| 4341 | # LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of |
| 4342 | # LocationType#LOCALITY. |
| 4343 | "radiusInMiles": 3.14, # Radius in miles of the job location. This value is derived from the |
| 4344 | # location bounding box in which a circle with the specified radius |
| 4345 | # centered from LatLng covers the area associated with the job location. |
| 4346 | # For example, currently, "Mountain View, CA, USA" has a radius of |
| 4347 | # 6.17 miles. |
| 4348 | }, |
| 4349 | }, |
| 4350 | "job": { # A Job resource represents a job posting (also referred to as a "job listing" # Job resource that matches the specified SearchJobsRequest. |
| 4351 | # or "job requisition"). A job belongs to a Company, which is the hiring |
| 4352 | # entity responsible for the job. |
| 4353 | "jobLevel": "A String", # Optional. The experience level associated with the job, such as "Entry Level". |
| 4354 | "languageCode": "A String", # Optional. The language of the posting. This field is distinct from |
| 4355 | # any requirements for fluency that are associated with the job. |
| 4356 | # |
| 4357 | # Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn". |
| 4358 | # For more information, see |
| 4359 | # [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){: |
| 4360 | # class="external" target="_blank" }. |
| 4361 | # |
| 4362 | # If this field is unspecified and Job.description is present, detected |
| 4363 | # language code based on Job.description is assigned, otherwise |
| 4364 | # defaults to 'en_US'. |
| 4365 | "postingUpdateTime": "A String", # Output only. The timestamp when this job posting was last updated. |
| 4366 | "visibility": "A String", # Deprecated. The job is only visible to the owner. |
| 4367 | # |
| 4368 | # The visibility of the job. |
| 4369 | # |
| 4370 | # Defaults to Visibility.ACCOUNT_ONLY if not specified. |
| 4371 | "name": "A String", # Required during job update. |
| 4372 | # |
| 4373 | # The resource name for the job. This is generated by the service when a |
| 4374 | # job is created. |
| 4375 | # |
| 4376 | # The format is "projects/{project_id}/jobs/{job_id}", |
| 4377 | # for example, "projects/api-test-project/jobs/1234". |
| 4378 | # |
| 4379 | # Use of this field in job queries and API calls is preferred over the use of |
| 4380 | # requisition_id since this value is unique. |
| 4381 | "jobBenefits": [ # Optional. The benefits included with the job. |
| 4382 | "A String", |
| 4383 | ], |
| 4384 | "promotionValue": 42, # Optional. A promotion value of the job, as determined by the client. |
| 4385 | # The value determines the sort order of the jobs returned when searching for |
| 4386 | # jobs using the featured jobs search call, with higher promotional values |
| 4387 | # being returned first and ties being resolved by relevance sort. Only the |
| 4388 | # jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH. |
| 4389 | # |
| 4390 | # Default value is 0, and negative values are treated as 0. |
| 4391 | "title": "A String", # Required. The title of the job, such as "Software Engineer" |
| 4392 | # |
| 4393 | # The maximum number of allowed characters is 500. |
| 4394 | "companyDisplayName": "A String", # Output only. Display name of the company listing the job. |
| 4395 | "requisitionId": "A String", # Required. The requisition ID, also referred to as the posting ID, assigned by the |
| 4396 | # client to identify a job. This field is intended to be used by clients |
| 4397 | # for client identification and tracking of postings. A job is not allowed |
| 4398 | # to be created if there is another job with the same [company_name], |
| 4399 | # language_code and requisition_id. |
| 4400 | # |
| 4401 | # The maximum number of allowed characters is 255. |
| 4402 | "qualifications": "A String", # Optional. A description of the qualifications required to perform the |
| 4403 | # job. The use of this field is recommended |
| 4404 | # as an alternative to using the more general description field. |
| 4405 | # |
| 4406 | # This field accepts and sanitizes HTML input, and also accepts |
| 4407 | # bold, italic, ordered list, and unordered list markup tags. |
| 4408 | # |
| 4409 | # The maximum number of allowed characters is 10,000. |
| 4410 | "processingOptions": { # Input only. # Optional. Options for job processing. |
| 4411 | # |
| 4412 | # Options for job processing. |
| 4413 | "disableStreetAddressResolution": True or False, # Optional. If set to `true`, the service does not attempt to resolve a |
| 4414 | # more precise address for the job. |
| 4415 | "htmlSanitization": "A String", # Optional. Option for job HTML content sanitization. Applied fields are: |
| 4416 | # |
| 4417 | # * description |
| 4418 | # * applicationInfo.instruction |
| 4419 | # * incentives |
| 4420 | # * qualifications |
| 4421 | # * responsibilities |
| 4422 | # |
| 4423 | # HTML tags in these fields may be stripped if sanitiazation is not |
| 4424 | # disabled. |
| 4425 | # |
| 4426 | # Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY. |
| 4427 | }, |
| 4428 | "jobEndTime": "A String", # Optional. The end timestamp of the job. Typically this field is used for contracting |
| 4429 | # engagements. Invalid timestamps are ignored. |
| 4430 | "derivedInfo": { # Output only. # Output only. Derived details about the job posting. |
| 4431 | # |
| 4432 | # Derived details about the job posting. |
| 4433 | "jobCategories": [ # Job categories derived from Job.title and Job.description. |
| 4434 | "A String", |
| 4435 | ], |
| 4436 | "locations": [ # Structured locations of the job, resolved from Job.addresses. |
| 4437 | # |
| 4438 | # locations are exactly matched to Job.addresses in the same |
| 4439 | # order. |
| 4440 | { # Output only. |
| 4441 | # |
| 4442 | # A resource that represents a location with full geographic information. |
| 4443 | "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair. |
| 4444 | # of doubles representing degrees latitude and degrees longitude. Unless |
| 4445 | # specified otherwise, this must conform to the |
| 4446 | # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 |
| 4447 | # standard</a>. Values must be within normalized ranges. |
| 4448 | "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. |
| 4449 | "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. |
| 4450 | }, |
| 4451 | "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information, |
| 4452 | # such as postal delivery and payments addresses. Given a postal address, |
| 4453 | # a postal service can deliver items to a premises, P.O. Box, or other |
| 4454 | # delivery location. |
| 4455 | # Given a postal address, a postal service can deliver items to a premise, P.O. |
| 4456 | # Box or similar. |
| 4457 | # It is not intended to model geographical locations (roads, towns, |
| 4458 | # mountains). |
| 4459 | # |
| 4460 | # In typical usage an address would be created via user input or from importing |
| 4461 | # existing data, depending on the type of process. |
| 4462 | # |
| 4463 | # Advice on address input / editing: |
| 4464 | # - Use an i18n-ready address widget such as |
| 4465 | # https://github.com/google/libaddressinput) |
| 4466 | # - Users should not be presented with UI elements for input or editing of |
| 4467 | # fields outside countries where that field is used. |
| 4468 | # |
| 4469 | # For more guidance on how to use this schema, please see: |
| 4470 | # https://support.google.com/business/answer/6397478 |
| 4471 | "sublocality": "A String", # Optional. Sublocality of the address. |
| 4472 | # For example, this can be neighborhoods, boroughs, districts. |
| 4473 | "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is |
| 4474 | # the latest revision. |
| 4475 | # |
| 4476 | # All new revisions **must** be backward compatible with old revisions. |
| 4477 | "locality": "A String", # Optional. Generally refers to the city/town portion of the address. |
| 4478 | # Examples: US city, IT comune, UK post town. |
| 4479 | # In regions of the world where localities are not well defined or do not fit |
| 4480 | # into this structure well, leave locality empty and use address_lines. |
| 4481 | "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal |
| 4482 | # addresses of a country or region. |
| 4483 | # For example, this can be a state, a province, an oblast, or a prefecture. |
| 4484 | # Specifically, for Spain this is the province and not the autonomous |
| 4485 | # community (e.g. "Barcelona" and not "Catalonia"). |
| 4486 | # Many countries don't use an administrative area in postal addresses. E.g. |
| 4487 | # in Switzerland this should be left unpopulated. |
| 4488 | "organization": "A String", # Optional. The name of the organization at the address. |
| 4489 | "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This |
| 4490 | # is never inferred and it is up to the user to ensure the value is |
| 4491 | # correct. See http://cldr.unicode.org/ and |
| 4492 | # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html |
| 4493 | # for details. Example: "CH" for Switzerland. |
| 4494 | "addressLines": [ # Unstructured address lines describing the lower levels of an address. |
| 4495 | # |
| 4496 | # Because values in address_lines do not have type information and may |
| 4497 | # sometimes contain multiple values in a single field (e.g. |
| 4498 | # "Austin, TX"), it is important that the line order is clear. The order of |
| 4499 | # address lines should be "envelope order" for the country/region of the |
| 4500 | # address. In places where this can vary (e.g. Japan), address_language is |
| 4501 | # used to make it explicit (e.g. "ja" for large-to-small ordering and |
| 4502 | # "ja-Latn" or "en" for small-to-large). This way, the most specific line of |
| 4503 | # an address can be selected based on the language. |
| 4504 | # |
| 4505 | # The minimum permitted structural representation of an address consists |
| 4506 | # of a region_code with all remaining information placed in the |
| 4507 | # address_lines. It would be possible to format such an address very |
| 4508 | # approximately without geocoding, but no semantic reasoning could be |
| 4509 | # made about any of the address components until it was at least |
| 4510 | # partially resolved. |
| 4511 | # |
| 4512 | # Creating an address only containing a region_code and address_lines, and |
| 4513 | # then geocoding is the recommended way to handle completely unstructured |
| 4514 | # addresses (as opposed to guessing which parts of the address should be |
| 4515 | # localities or administrative areas). |
| 4516 | "A String", |
| 4517 | ], |
| 4518 | "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require |
| 4519 | # postal codes to be present, but where they are used, they may trigger |
| 4520 | # additional validation with other parts of the address (e.g. state/zip |
| 4521 | # validation in the U.S.A.). |
| 4522 | "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if |
| 4523 | # known). This is often the UI language of the input form or is expected |
| 4524 | # to match one of the languages used in the address' country/region, or their |
| 4525 | # transliterated equivalents. |
| 4526 | # This can affect formatting in certain countries, but is not critical |
| 4527 | # to the correctness of the data and will never affect any validation or |
| 4528 | # other non-formatting related operations. |
| 4529 | # |
| 4530 | # If this value is not known, it should be omitted (rather than specifying a |
| 4531 | # possibly incorrect default). |
| 4532 | # |
| 4533 | # Examples: "zh-Hant", "ja", "ja-Latn", "en". |
| 4534 | "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used |
| 4535 | # in most regions. Where it is used, the value is either a string like |
| 4536 | # "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number |
| 4537 | # alone, representing the "sector code" (Jamaica), "delivery area indicator" |
| 4538 | # (Malawi) or "post office indicator" (e.g. Côte d'Ivoire). |
| 4539 | "recipients": [ # Optional. The recipient at the address. |
| 4540 | # This field may, under certain circumstances, contain multiline information. |
| 4541 | # For example, it might contain "care of" information. |
| 4542 | "A String", |
| 4543 | ], |
| 4544 | }, |
| 4545 | "locationType": "A String", # The type of a location, which corresponds to the address lines field of |
| 4546 | # PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of |
| 4547 | # LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of |
| 4548 | # LocationType#LOCALITY. |
| 4549 | "radiusInMiles": 3.14, # Radius in miles of the job location. This value is derived from the |
| 4550 | # location bounding box in which a circle with the specified radius |
| 4551 | # centered from LatLng covers the area associated with the job location. |
| 4552 | # For example, currently, "Mountain View, CA, USA" has a radius of |
| 4553 | # 6.17 miles. |
| 4554 | }, |
| 4555 | ], |
| 4556 | }, |
| 4557 | "employmentTypes": [ # Optional. The employment type(s) of a job, for example, |
| 4558 | # full time or |
| 4559 | # part time. |
| 4560 | "A String", |
| 4561 | ], |
| 4562 | "incentives": "A String", # Optional. A description of bonus, commission, and other compensation |
| 4563 | # incentives associated with the job not including salary or pay. |
| 4564 | # |
| 4565 | # The maximum number of allowed characters is 10,000. |
| 4566 | "postingCreateTime": "A String", # Output only. The timestamp when this job posting was created. |
| 4567 | "addresses": [ # Optional but strongly recommended for the best service experience. |
| 4568 | # |
| 4569 | # Location(s) where the employer is looking to hire for this job posting. |
| 4570 | # |
| 4571 | # Specifying the full street address(es) of the hiring location enables |
| 4572 | # better API results, especially job searches by commute time. |
| 4573 | # |
| 4574 | # At most 50 locations are allowed for best search performance. If a job has |
| 4575 | # more locations, it is suggested to split it into multiple jobs with unique |
| 4576 | # requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as |
| 4577 | # multiple jobs with the same company_name, language_code and |
| 4578 | # requisition_id are not allowed. If the original requisition_id must |
| 4579 | # be preserved, a custom field should be used for storage. It is also |
| 4580 | # suggested to group the locations that close to each other in the same job |
| 4581 | # for better search experience. |
| 4582 | # |
| 4583 | # The maximum number of allowed characters is 500. |
| 4584 | "A String", |
| 4585 | ], |
| 4586 | "companyName": "A String", # Required. The resource name of the company listing the job, such as |
| 4587 | # "projects/api-test-project/companies/foo". |
| 4588 | "description": "A String", # Required. The description of the job, which typically includes a multi-paragraph |
| 4589 | # description of the company and related information. Separate fields are |
| 4590 | # provided on the job object for responsibilities, |
| 4591 | # qualifications, and other job characteristics. Use of |
| 4592 | # these separate job fields is recommended. |
| 4593 | # |
| 4594 | # This field accepts and sanitizes HTML input, and also accepts |
| 4595 | # bold, italic, ordered list, and unordered list markup tags. |
| 4596 | # |
| 4597 | # The maximum number of allowed characters is 100,000. |
| 4598 | "jobStartTime": "A String", # Optional. The start timestamp of the job in UTC time zone. Typically this field |
| 4599 | # is used for contracting engagements. Invalid timestamps are ignored. |
| 4600 | "degreeTypes": [ # Optional. The desired education degrees for the job, such as Bachelors, Masters. |
| 4601 | "A String", |
| 4602 | ], |
| 4603 | "compensationInfo": { # Job compensation details. # Optional. Job compensation information. |
| 4604 | "annualizedBaseCompensationRange": { # Compensation range. # Output only. Annualized base compensation range. Computed as |
| 4605 | # base compensation entry's CompensationEntry.compensation times |
| 4606 | # CompensationEntry.expected_units_per_year. |
| 4607 | # |
| 4608 | # See CompensationEntry for explanation on compensation annualization. |
| 4609 | "maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set |
| 4610 | # to a maximal compensation value and the currency code is set to |
| 4611 | # match the currency code of |
| 4612 | # min_compensation. |
| 4613 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 4614 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 4615 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 4616 | # If `units` is positive, `nanos` must be positive or zero. |
| 4617 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 4618 | # If `units` is negative, `nanos` must be negative or zero. |
| 4619 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 4620 | "units": "A String", # The whole units of the amount. |
| 4621 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 4622 | }, |
| 4623 | "minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set |
| 4624 | # to zero and the currency code is set to match the |
| 4625 | # currency code of max_compensation. |
| 4626 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 4627 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 4628 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 4629 | # If `units` is positive, `nanos` must be positive or zero. |
| 4630 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 4631 | # If `units` is negative, `nanos` must be negative or zero. |
| 4632 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 4633 | "units": "A String", # The whole units of the amount. |
| 4634 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 4635 | }, |
| 4636 | }, |
| 4637 | "annualizedTotalCompensationRange": { # Compensation range. # Output only. Annualized total compensation range. Computed as |
| 4638 | # all compensation entries' CompensationEntry.compensation times |
| 4639 | # CompensationEntry.expected_units_per_year. |
| 4640 | # |
| 4641 | # See CompensationEntry for explanation on compensation annualization. |
| 4642 | "maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set |
| 4643 | # to a maximal compensation value and the currency code is set to |
| 4644 | # match the currency code of |
| 4645 | # min_compensation. |
| 4646 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 4647 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 4648 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 4649 | # If `units` is positive, `nanos` must be positive or zero. |
| 4650 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 4651 | # If `units` is negative, `nanos` must be negative or zero. |
| 4652 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 4653 | "units": "A String", # The whole units of the amount. |
| 4654 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 4655 | }, |
| 4656 | "minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set |
| 4657 | # to zero and the currency code is set to match the |
| 4658 | # currency code of max_compensation. |
| 4659 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 4660 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 4661 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 4662 | # If `units` is positive, `nanos` must be positive or zero. |
| 4663 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 4664 | # If `units` is negative, `nanos` must be negative or zero. |
| 4665 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 4666 | "units": "A String", # The whole units of the amount. |
| 4667 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 4668 | }, |
| 4669 | }, |
| 4670 | "entries": [ # Optional. Job compensation information. |
| 4671 | # |
| 4672 | # At most one entry can be of type |
| 4673 | # CompensationInfo.CompensationType.BASE, which is |
| 4674 | # referred as ** base compensation entry ** for the job. |
| 4675 | { # A compensation entry that represents one component of compensation, such |
| 4676 | # as base pay, bonus, or other compensation type. |
| 4677 | # |
| 4678 | # Annualization: One compensation entry can be annualized if |
| 4679 | # - it contains valid amount or range. |
| 4680 | # - and its expected_units_per_year is set or can be derived. |
| 4681 | # Its annualized range is determined as (amount or range) times |
| 4682 | # expected_units_per_year. |
| 4683 | "unit": "A String", # Optional. Frequency of the specified amount. |
| 4684 | # |
| 4685 | # Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED. |
| 4686 | "amount": { # Represents an amount of money with its currency type. # Optional. Compensation amount. |
| 4687 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 4688 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 4689 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 4690 | # If `units` is positive, `nanos` must be positive or zero. |
| 4691 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 4692 | # If `units` is negative, `nanos` must be negative or zero. |
| 4693 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 4694 | "units": "A String", # The whole units of the amount. |
| 4695 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 4696 | }, |
| 4697 | "type": "A String", # Optional. Compensation type. |
| 4698 | # |
| 4699 | # Default is CompensationUnit.COMPENSATION_TYPE_UNSPECIFIED. |
| 4700 | "range": { # Compensation range. # Optional. Compensation range. |
| 4701 | "maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set |
| 4702 | # to a maximal compensation value and the currency code is set to |
| 4703 | # match the currency code of |
| 4704 | # min_compensation. |
| 4705 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 4706 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 4707 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 4708 | # If `units` is positive, `nanos` must be positive or zero. |
| 4709 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 4710 | # If `units` is negative, `nanos` must be negative or zero. |
| 4711 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 4712 | "units": "A String", # The whole units of the amount. |
| 4713 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 4714 | }, |
| 4715 | "minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set |
| 4716 | # to zero and the currency code is set to match the |
| 4717 | # currency code of max_compensation. |
| 4718 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 4719 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 4720 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 4721 | # If `units` is positive, `nanos` must be positive or zero. |
| 4722 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 4723 | # If `units` is negative, `nanos` must be negative or zero. |
| 4724 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 4725 | "units": "A String", # The whole units of the amount. |
| 4726 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 4727 | }, |
| 4728 | }, |
| 4729 | "expectedUnitsPerYear": 3.14, # Optional. Expected number of units paid each year. If not specified, when |
| 4730 | # Job.employment_types is FULLTIME, a default value is inferred |
| 4731 | # based on unit. Default values: |
| 4732 | # - HOURLY: 2080 |
| 4733 | # - DAILY: 260 |
| 4734 | # - WEEKLY: 52 |
| 4735 | # - MONTHLY: 12 |
| 4736 | # - ANNUAL: 1 |
| 4737 | "description": "A String", # Optional. Compensation description. For example, could |
| 4738 | # indicate equity terms or provide additional context to an estimated |
| 4739 | # bonus. |
| 4740 | }, |
| 4741 | ], |
| 4742 | }, |
| 4743 | "responsibilities": "A String", # Optional. A description of job responsibilities. The use of this field is |
| 4744 | # recommended as an alternative to using the more general description |
| 4745 | # field. |
| 4746 | # |
| 4747 | # This field accepts and sanitizes HTML input, and also accepts |
| 4748 | # bold, italic, ordered list, and unordered list markup tags. |
| 4749 | # |
| 4750 | # The maximum number of allowed characters is 10,000. |
| 4751 | "department": "A String", # Optional. The department or functional area within the company with the open |
| 4752 | # position. |
| 4753 | # |
| 4754 | # The maximum number of allowed characters is 255. |
| 4755 | "applicationInfo": { # Application related details of a job posting. # Required. At least one field within ApplicationInfo must be specified. |
| 4756 | # |
| 4757 | # Job application information. |
| 4758 | "uris": [ # Optional but at least one of uris, |
| 4759 | # emails or instruction must be |
| 4760 | # specified. |
| 4761 | # |
| 4762 | # Use this URI field to direct an applicant to a website, for example to |
| 4763 | # link to an online application form. |
| 4764 | # |
| 4765 | # The maximum number of allowed characters for each entry is 2,000. |
| 4766 | "A String", |
| 4767 | ], |
| 4768 | "emails": [ # Optional but at least one of uris, |
| 4769 | # emails or instruction must be |
| 4770 | # specified. |
| 4771 | # |
| 4772 | # Use this field to specify email address(es) to which resumes or |
| 4773 | # applications can be sent. |
| 4774 | # |
| 4775 | # The maximum number of allowed characters for each entry is 255. |
| 4776 | "A String", |
| 4777 | ], |
| 4778 | "instruction": "A String", # Optional but at least one of uris, |
| 4779 | # emails or instruction must be |
| 4780 | # specified. |
| 4781 | # |
| 4782 | # Use this field to provide instructions, such as "Mail your application |
| 4783 | # to ...", that a candidate can follow to apply for the job. |
| 4784 | # |
| 4785 | # This field accepts and sanitizes HTML input, and also accepts |
| 4786 | # bold, italic, ordered list, and unordered list markup tags. |
| 4787 | # |
| 4788 | # The maximum number of allowed characters is 3,000. |
| 4789 | }, |
| 4790 | "postingExpireTime": "A String", # Optional but strongly recommended for the best service |
| 4791 | # experience. |
| 4792 | # |
| 4793 | # The expiration timestamp of the job. After this timestamp, the |
| 4794 | # job is marked as expired, and it no longer appears in search results. The |
| 4795 | # expired job can't be deleted or listed by the DeleteJob and |
| 4796 | # ListJobs APIs, but it can be retrieved with the GetJob API or |
| 4797 | # updated with the UpdateJob API. An expired job can be updated and |
| 4798 | # opened again by using a future expiration timestamp. Updating an expired |
| 4799 | # job fails if there is another existing open job with same company_name, |
| 4800 | # language_code and requisition_id. |
| 4801 | # |
| 4802 | # The expired jobs are retained in our system for 90 days. However, the |
| 4803 | # overall expired job count cannot exceed 3 times the maximum of open jobs |
| 4804 | # count over the past week, otherwise jobs with earlier expire time are |
| 4805 | # cleaned first. Expired jobs are no longer accessible after they are cleaned |
| 4806 | # out. |
| 4807 | # |
| 4808 | # Invalid timestamps are ignored, and treated as expire time not provided. |
| 4809 | # |
| 4810 | # Timestamp before the instant request is made is considered valid, the job |
| 4811 | # will be treated as expired immediately. |
| 4812 | # |
| 4813 | # If this value is not provided at the time of job creation or is invalid, |
| 4814 | # the job posting expires after 30 days from the job's creation time. For |
| 4815 | # example, if the job was created on 2017/01/01 13:00AM UTC with an |
| 4816 | # unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC. |
| 4817 | # |
| 4818 | # If this value is not provided on job update, it depends on the field masks |
| 4819 | # set by UpdateJobRequest.update_mask. If the field masks include |
| 4820 | # expiry_time, or the masks are empty meaning that every field is |
| 4821 | # updated, the job posting expires after 30 days from the job's last |
| 4822 | # update time. Otherwise the expiration date isn't updated. |
| 4823 | "postingRegion": "A String", # Optional. The job PostingRegion (for example, state, country) throughout which |
| 4824 | # the job is available. If this field is set, a |
| 4825 | # LocationFilter in a search query within the job region |
| 4826 | # finds this job posting if an exact location match isn't specified. |
| 4827 | # If this field is set to PostingRegion.NATION or |
| 4828 | # PostingRegion.ADMINISTRATIVE_AREA, setting job Job.addresses |
| 4829 | # to the same location level as this field is strongly recommended. |
| 4830 | "postingPublishTime": "A String", # Optional. The timestamp this job posting was most recently published. The default |
| 4831 | # value is the time the request arrives at the server. Invalid timestamps are |
| 4832 | # ignored. |
| 4833 | "customAttributes": { # Optional. A map of fields to hold both filterable and non-filterable custom job |
| 4834 | # attributes that are not covered by the provided structured fields. |
| 4835 | # |
| 4836 | # The keys of the map are strings up to 64 bytes and must match the |
| 4837 | # pattern: a-zA-Z*. For example, key0LikeThis or |
| 4838 | # KEY_1_LIKE_THIS. |
| 4839 | # |
| 4840 | # At most 100 filterable and at most 100 unfilterable keys are supported. |
| 4841 | # For filterable `string_values`, across all keys at most 200 values are |
| 4842 | # allowed, with each string no more than 255 characters. For unfilterable |
| 4843 | # `string_values`, the maximum total size of `string_values` across all keys |
| 4844 | # is 50KB. |
| 4845 | "a_key": { # Custom attribute values that are either filterable or non-filterable. |
| 4846 | "stringValues": [ # Optional but exactly one of string_values or long_values must |
| 4847 | # be specified. |
| 4848 | # |
| 4849 | # This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or |
| 4850 | # `CASE_INSENSITIVE_MATCH`) search. |
| 4851 | # For filterable `string_value`s, a maximum total number of 200 values |
| 4852 | # is allowed, with each `string_value` has a byte size of no more than |
| 4853 | # 500B. For unfilterable `string_values`, the maximum total byte size of |
| 4854 | # unfilterable `string_values` is 50KB. |
| 4855 | # |
| 4856 | # Empty string is not allowed. |
| 4857 | "A String", |
| 4858 | ], |
| 4859 | "filterable": True or False, # Optional. If the `filterable` flag is true, the custom field values may be used for |
| 4860 | # custom attribute filters JobQuery.custom_attribute_filter. |
| 4861 | # If false, these values may not be used for custom attribute filters. |
| 4862 | # |
| 4863 | # Default is false. |
| 4864 | "longValues": [ # Optional but exactly one of string_values or long_values must |
| 4865 | # be specified. |
| 4866 | # |
| 4867 | # This field is used to perform number range search. |
| 4868 | # (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`. |
| 4869 | # |
| 4870 | # Currently at most 1 long_values is supported. |
| 4871 | "A String", |
| 4872 | ], |
| 4873 | }, |
| 4874 | }, |
| 4875 | }, |
| 4876 | }, |
| 4877 | ], |
| 4878 | "nextPageToken": "A String", # The token that specifies the starting position of the next page of results. |
| 4879 | # This field is empty if there are no more results. |
| 4880 | "spellCorrection": { # Output only. # The spell checking result, and correction. |
| 4881 | # |
| 4882 | # Spell check result. |
| 4883 | "corrected": True or False, # Indicates if the query was corrected by the spell checker. |
| 4884 | "correctedText": "A String", # Correction output consisting of the corrected keyword string. |
| 4885 | }, |
| 4886 | "estimatedTotalSize": 42, # An estimation of the number of jobs that match the specified query. |
| 4887 | # |
| 4888 | # This number is not guaranteed to be accurate. For accurate results, |
| 4889 | # see enable_precise_result_size. |
| 4890 | "broadenedQueryJobsCount": 42, # If query broadening is enabled, we may append additional results from the |
| 4891 | # broadened query. This number indicates how many of the jobs returned in the |
| 4892 | # jobs field are from the broadened query. These results are always at the |
| 4893 | # end of the jobs list. In particular, a value of 0, or if the field isn't |
| 4894 | # set, all the jobs in the jobs list are from the original |
| 4895 | # (without broadening) query. If this field is non-zero, subsequent requests |
| 4896 | # with offset after this result set should contain all broadened results. |
| 4897 | "totalSize": 42, # The precise result count, which is available only if the client set |
| 4898 | # enable_precise_result_size to `true`, or if the response |
| 4899 | # is the last page of results. Otherwise, the value is `-1`. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4900 | }</pre> |
| 4901 | </div> |
| 4902 | |
| 4903 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4904 | <code class="details" id="searchForAlert">searchForAlert(parent, body=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4905 | <pre>Searches for jobs using the provided SearchJobsRequest. |
| 4906 | |
| 4907 | This API call is intended for the use case of targeting passive job |
| 4908 | seekers (for example, job seekers who have signed up to receive email |
| 4909 | alerts about potential job opportunities), and has different algorithmic |
| 4910 | adjustments that are targeted to passive job seekers. |
| 4911 | |
| 4912 | This call constrains the visibility of jobs |
| 4913 | present in the database, and only returns jobs the caller has |
| 4914 | permission to search against. |
| 4915 | |
| 4916 | Args: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4917 | parent: string, Required. The resource name of the project to search within. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4918 | |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4919 | The format is "projects/{project_id}", for example, |
| 4920 | "projects/api-test-project". (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4921 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4922 | The object takes the form of: |
| 4923 | |
| 4924 | { # Input only. |
| 4925 | # |
| 4926 | # The Request body of the `SearchJobs` call. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4927 | "pageSize": 42, # Optional. A limit on the number of jobs returned in the search results. |
| 4928 | # Increasing this value above the default value of 10 can increase search |
| 4929 | # response time. The value can be between 1 and 100. |
| 4930 | "histogramFacets": { # Input only. # Optional. Histogram requests for jobs matching JobQuery. |
| 4931 | # |
| 4932 | # Histogram facets to be specified in SearchJobsRequest. |
| 4933 | "customAttributeHistogramFacets": [ # Optional. Specifies the custom attributes histogram requests. |
| 4934 | # Duplicate values of CustomAttributeHistogramRequest.key are not |
| 4935 | # allowed. |
| 4936 | { # Custom attributes histogram request. An error is thrown if neither |
| 4937 | # string_value_histogram or long_value_histogram_bucketing_option has |
| 4938 | # been defined. |
| 4939 | "longValueHistogramBucketingOption": { # Input only. # Optional. Specifies buckets used to perform a range histogram on Job's |
| 4940 | # filterable long custom field values, or min/max value requirements. |
| 4941 | # |
| 4942 | # Use this field to specify bucketing option for the histogram search response. |
| 4943 | "requiresMinMax": True or False, # Optional. If set to true, the histogram result includes minimum/maximum |
| 4944 | # value of the numeric field. |
| 4945 | "bucketBounds": [ # Required. Two adjacent values form a histogram bucket. Values should be in |
| 4946 | # ascending order. For example, if [5, 10, 15] are provided, four buckets are |
| 4947 | # created: (-inf, 5), 5, 10), [10, 15), [15, inf). At most 20 |
| 4948 | # [buckets_bound is supported. |
| 4949 | 3.14, |
| 4950 | ], |
| 4951 | }, |
| 4952 | "key": "A String", # Required. Specifies the custom field key to perform a histogram on. If specified |
| 4953 | # without `long_value_histogram_bucketing_option`, histogram on string values |
| 4954 | # of the given `key` is triggered, otherwise histogram is performed on long |
| 4955 | # values. |
| 4956 | "stringValueHistogram": True or False, # Optional. If set to true, the response includes the histogram value for |
| 4957 | # each key as a string. |
| 4958 | }, |
| 4959 | ], |
| 4960 | "simpleHistogramFacets": [ # Optional. Specifies the simple type of histogram facets, for example, |
| 4961 | # `COMPANY_SIZE`, `EMPLOYMENT_TYPE` etc. |
| 4962 | "A String", |
| 4963 | ], |
| 4964 | "compensationHistogramFacets": [ # Optional. Specifies compensation field-based histogram requests. |
| 4965 | # Duplicate values of CompensationHistogramRequest.type are not allowed. |
| 4966 | { # Input only. |
| 4967 | # |
| 4968 | # Compensation based histogram request. |
| 4969 | "bucketingOption": { # Input only. # Required. Numeric histogram options, like buckets, whether include min or max value. |
| 4970 | # |
| 4971 | # Use this field to specify bucketing option for the histogram search response. |
| 4972 | "requiresMinMax": True or False, # Optional. If set to true, the histogram result includes minimum/maximum |
| 4973 | # value of the numeric field. |
| 4974 | "bucketBounds": [ # Required. Two adjacent values form a histogram bucket. Values should be in |
| 4975 | # ascending order. For example, if [5, 10, 15] are provided, four buckets are |
| 4976 | # created: (-inf, 5), 5, 10), [10, 15), [15, inf). At most 20 |
| 4977 | # [buckets_bound is supported. |
| 4978 | 3.14, |
| 4979 | ], |
| 4980 | }, |
| 4981 | "type": "A String", # Required. Type of the request, representing which field the histogramming should be |
| 4982 | # performed over. A single request can only specify one histogram of each |
| 4983 | # `CompensationHistogramRequestType`. |
| 4984 | }, |
| 4985 | ], |
| 4986 | }, |
| 4987 | "orderBy": "A String", # Optional. The criteria determining how search results are sorted. Default is |
| 4988 | # "relevance desc". |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4989 | # |
| 4990 | # Supported options are: |
| 4991 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4992 | # * `"relevance desc"`: By relevance descending, as determined by the API |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4993 | # algorithms. Relevance thresholding of query results is only available |
| 4994 | # with this ordering. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4995 | # * `"posting_publish_time desc"`: By Job.posting_publish_time |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4996 | # descending. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4997 | # * `"posting_update_time desc"`: By Job.posting_update_time |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4998 | # descending. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4999 | # * `"title"`: By Job.title ascending. |
| 5000 | # * `"title desc"`: By Job.title descending. |
| 5001 | # * `"annualized_base_compensation"`: By job's |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 5002 | # CompensationInfo.annualized_base_compensation_range ascending. Jobs |
| 5003 | # whose annualized base compensation is unspecified are put at the end of |
| 5004 | # search results. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5005 | # * `"annualized_base_compensation desc"`: By job's |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 5006 | # CompensationInfo.annualized_base_compensation_range descending. Jobs |
| 5007 | # whose annualized base compensation is unspecified are put at the end of |
| 5008 | # search results. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5009 | # * `"annualized_total_compensation"`: By job's |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 5010 | # CompensationInfo.annualized_total_compensation_range ascending. Jobs |
| 5011 | # whose annualized base compensation is unspecified are put at the end of |
| 5012 | # search results. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5013 | # * `"annualized_total_compensation desc"`: By job's |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 5014 | # CompensationInfo.annualized_total_compensation_range descending. Jobs |
| 5015 | # whose annualized base compensation is unspecified are put at the end of |
| 5016 | # search results. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5017 | "jobQuery": { # Input only. # Optional. Query used to search against jobs, such as keyword, location filters, etc. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 5018 | # |
| 5019 | # The query required to perform a search query. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5020 | "queryLanguageCode": "A String", # The language code of query. For example, "en-US". This field helps to |
| 5021 | # better interpret the query. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 5022 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5023 | # If a value isn't specified, the query language code is automatically |
| 5024 | # detected, which may not be accurate. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 5025 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5026 | # Language code should be in BCP-47 format, such as "en-US" or "sr-Latn". |
| 5027 | # For more information, see |
| 5028 | # [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). |
| 5029 | "employmentTypes": [ # Optional. The employment type filter specifies the employment type of jobs to |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 5030 | # search against, such as EmploymentType.FULL_TIME. |
| 5031 | # |
| 5032 | # If a value is not specified, jobs in the search results includes any |
| 5033 | # employment type. |
| 5034 | # |
| 5035 | # If multiple values are specified, jobs in the search results include |
| 5036 | # any of the specified employment types. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5037 | "A String", |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 5038 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5039 | "customAttributeFilter": "A String", # Optional. This filter specifies a structured syntax to match against the |
| 5040 | # Job.custom_attributes marked as `filterable`. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 5041 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5042 | # The syntax for this expression is a subset of SQL syntax. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 5043 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5044 | # Supported operators are: `=`, `!=`, `<`, `<=`, `>`, and `>=` where the |
| 5045 | # left of the operator is a custom field key and the right of the operator |
| 5046 | # is a number or a quoted string. You must escape backslash (\\) and |
| 5047 | # quote (\") characters. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 5048 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5049 | # Supported functions are `LOWER([field_name])` to |
| 5050 | # perform a case insensitive match and `EMPTY([field_name])` to filter on the |
| 5051 | # existence of a key. |
| 5052 | # |
| 5053 | # Boolean expressions (AND/OR/NOT) are supported up to 3 levels of |
| 5054 | # nesting (for example, "((A AND B AND C) OR NOT D) AND E"), a maximum of 100 |
| 5055 | # comparisons or functions are allowed in the expression. The expression |
| 5056 | # must be < 6000 bytes in length. |
| 5057 | # |
| 5058 | # Sample Query: |
| 5059 | # `(LOWER(driving_license)="class \"a\"" OR EMPTY(driving_license)) AND |
| 5060 | # driving_years > 10` |
| 5061 | "publishTimeRange": { # Message representing a period of time between two timestamps. # Optional. Jobs published within a range specified by this filter are searched |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 5062 | # against. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5063 | "endTime": "A String", # End of the period. |
| 5064 | "startTime": "A String", # Begin of the period. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 5065 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5066 | "locationFilters": [ # Optional. The location filter specifies geo-regions containing the jobs to |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 5067 | # search against. See LocationFilter for more information. |
| 5068 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5069 | # If a location value isn't specified, jobs fitting the other search |
| 5070 | # criteria are retrieved regardless of where they're located. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 5071 | # |
| 5072 | # If multiple values are specified, jobs are retrieved from any of the |
| 5073 | # specified locations. If different values are specified for the |
| 5074 | # LocationFilter.distance_in_miles parameter, the maximum provided |
| 5075 | # distance is used for all locations. |
| 5076 | # |
| 5077 | # At most 5 location filters are allowed. |
| 5078 | { # Input only. |
| 5079 | # |
| 5080 | # Geographic region of the search. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5081 | "telecommutePreference": "A String", # Optional. Allows the client to return jobs without a |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 5082 | # set location, specifically, telecommuting jobs (telecommuting is considered |
| 5083 | # by the service as a special location. |
| 5084 | # Job.posting_region indicates if a job permits telecommuting. |
| 5085 | # If this field is set to TelecommutePreference.TELECOMMUTE_ALLOWED, |
| 5086 | # telecommuting jobs are searched, and address and lat_lng are |
| 5087 | # ignored. If not set or set to |
| 5088 | # TelecommutePreference.TELECOMMUTE_EXCLUDED, telecommute job are not |
| 5089 | # searched. |
| 5090 | # |
| 5091 | # This filter can be used by itself to search exclusively for telecommuting |
| 5092 | # jobs, or it can be combined with another location |
| 5093 | # filter to search for a combination of job locations, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5094 | # such as "Mountain View" or "telecommuting" jobs. However, when used in |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 5095 | # combination with other location filters, telecommuting jobs can be |
| 5096 | # treated as less relevant than other jobs in the search response. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5097 | "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # Optional. The latitude and longitude of the geographic center from which to |
| 5098 | # search. This field's ignored if `address` is provided. |
| 5099 | # of doubles representing degrees latitude and degrees longitude. Unless |
| 5100 | # specified otherwise, this must conform to the |
| 5101 | # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 |
| 5102 | # standard</a>. Values must be within normalized ranges. |
| 5103 | "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. |
| 5104 | "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. |
| 5105 | }, |
| 5106 | "regionCode": "A String", # Optional. CLDR region code of the country/region of the address. This is used |
| 5107 | # to address ambiguity of the user-input location, for example, "Liverpool" |
| 5108 | # against "Liverpool, NY, US" or "Liverpool, UK". |
| 5109 | # |
| 5110 | # Set this field if all the jobs to search against are from a same region, |
| 5111 | # or jobs are world-wide, but the job seeker is from a specific region. |
| 5112 | # |
| 5113 | # See http://cldr.unicode.org/ and |
| 5114 | # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html |
| 5115 | # for details. Example: "CH" for Switzerland. |
| 5116 | "address": "A String", # Optional. The address name, such as "Mountain View" or "Bay Area". |
| 5117 | "distanceInMiles": 3.14, # Optional. The distance_in_miles is applied when the location being searched for is |
| 5118 | # identified as a city or smaller. When the location being searched for is a |
| 5119 | # state or larger, this field is ignored. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 5120 | }, |
| 5121 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5122 | "languageCodes": [ # Optional. This filter specifies the locale of jobs to search against, |
| 5123 | # for example, "en-US". |
| 5124 | # |
| 5125 | # If a value isn't specified, the search results can contain jobs in any |
| 5126 | # locale. |
| 5127 | # |
| 5128 | # |
| 5129 | # Language codes should be in BCP-47 format, such as "en-US" or "sr-Latn". |
| 5130 | # For more information, see |
| 5131 | # [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). |
| 5132 | # |
| 5133 | # At most 10 language code filters are allowed. |
| 5134 | "A String", |
| 5135 | ], |
| 5136 | "commuteFilter": { # Input only. # Optional. Allows filtering jobs by commute time with different travel methods (for |
| 5137 | # example, driving or public transit). Note: This only works with COMMUTE |
| 5138 | # MODE. When specified, [JobQuery.location_filters] is |
| 5139 | # ignored. |
| 5140 | # |
| 5141 | # Currently we don't support sorting by commute time. |
| 5142 | # |
| 5143 | # Parameters needed for commute search. |
| 5144 | "roadTraffic": "A String", # Optional. Specifies the traffic density to use when calculating commute time. |
| 5145 | "allowImpreciseAddresses": True or False, # Optional. If true, jobs without "precise" addresses (street level addresses or GPS |
| 5146 | # coordinates) might also be returned. For city and coarser level addresses, |
| 5147 | # text matching is used. If this field is set to false or is not specified, |
| 5148 | # only jobs that include precise addresses are returned by Commute |
| 5149 | # Search. |
| 5150 | # |
| 5151 | # Note: If `allow_imprecise_addresses` is set to true, Commute Search is not |
| 5152 | # able to calculate accurate commute times to jobs with city level and |
| 5153 | # coarser address information. Jobs with imprecise addresses will return a |
| 5154 | # `travel_duration` time of 0 regardless of distance from the job seeker. |
| 5155 | "departureTime": { # Represents a time of day. The date and time zone are either not significant # Optional. The departure time used to calculate traffic impact, represented as |
| 5156 | # google.type.TimeOfDay in local time zone. |
| 5157 | # |
| 5158 | # Currently traffic model is restricted to hour level resolution. |
| 5159 | # or are specified elsewhere. An API may choose to allow leap seconds. Related |
| 5160 | # types are google.type.Date and `google.protobuf.Timestamp`. |
| 5161 | "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose |
| 5162 | # to allow the value "24:00:00" for scenarios like business closing time. |
| 5163 | "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
| 5164 | "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may |
| 5165 | # allow the value 60 if it allows leap-seconds. |
| 5166 | "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. |
| 5167 | }, |
| 5168 | "travelDuration": "A String", # Required. The maximum travel time in seconds. The maximum allowed value is `3600s` |
| 5169 | # (one hour). Format is `123s`. |
| 5170 | "startCoordinates": { # An object representing a latitude/longitude pair. This is expressed as a pair # Required. The latitude and longitude of the location from which to calculate the |
| 5171 | # commute time. |
| 5172 | # of doubles representing degrees latitude and degrees longitude. Unless |
| 5173 | # specified otherwise, this must conform to the |
| 5174 | # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 |
| 5175 | # standard</a>. Values must be within normalized ranges. |
| 5176 | "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. |
| 5177 | "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. |
| 5178 | }, |
| 5179 | "commuteMethod": "A String", # Required. The method of transportation for which to calculate the commute time. |
| 5180 | }, |
| 5181 | "query": "A String", # Optional. The query string that matches against the job title, description, and |
| 5182 | # location fields. |
| 5183 | # |
| 5184 | # The maximum number of allowed characters is 255. |
| 5185 | "compensationFilter": { # Input only. # Optional. This search filter is applied only to |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 5186 | # Job.compensation_info. For example, if the filter is specified |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5187 | # as "Hourly job with per-hour compensation > $15", only jobs meeting |
| 5188 | # these criteria are searched. If a filter isn't defined, all open jobs |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 5189 | # are searched. |
| 5190 | # |
| 5191 | # Filter on job compensation type and amount. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5192 | "type": "A String", # Required. Type of filter. |
| 5193 | "includeJobsWithUnspecifiedCompensationRange": True or False, # Optional. If set to true, jobs with unspecified compensation range fields are |
| 5194 | # included. |
| 5195 | "units": [ # Required. Specify desired `base compensation entry's` |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 5196 | # CompensationInfo.CompensationUnit. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5197 | "A String", |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 5198 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5199 | "range": { # Compensation range. # Optional. Compensation range. |
| 5200 | "maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 5201 | # to a maximal compensation value and the currency code is set to |
| 5202 | # match the currency code of |
| 5203 | # min_compensation. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5204 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 5205 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 5206 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 5207 | # If `units` is positive, `nanos` must be positive or zero. |
| 5208 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 5209 | # If `units` is negative, `nanos` must be negative or zero. |
| 5210 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5211 | "units": "A String", # The whole units of the amount. |
| 5212 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 5213 | }, |
| 5214 | "minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set |
| 5215 | # to zero and the currency code is set to match the |
| 5216 | # currency code of max_compensation. |
| 5217 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 5218 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 5219 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 5220 | # If `units` is positive, `nanos` must be positive or zero. |
| 5221 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 5222 | # If `units` is negative, `nanos` must be negative or zero. |
| 5223 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 5224 | "units": "A String", # The whole units of the amount. |
| 5225 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 5226 | }, |
| 5227 | }, |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 5228 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5229 | "companyDisplayNames": [ # Optional. This filter specifies the exact company display |
| 5230 | # name of the jobs to search against. |
| 5231 | # |
| 5232 | # If a value isn't specified, jobs within the search results are |
| 5233 | # associated with any company. |
| 5234 | # |
| 5235 | # If multiple values are specified, jobs within the search results may be |
| 5236 | # associated with any of the specified companies. |
| 5237 | # |
| 5238 | # At most 20 company display name filters are allowed. |
| 5239 | "A String", |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 5240 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5241 | "disableSpellCheck": True or False, # Optional. This flag controls the spell-check feature. If false, the |
| 5242 | # service attempts to correct a misspelled query, |
| 5243 | # for example, "enginee" is corrected to "engineer". |
| 5244 | # |
| 5245 | # Defaults to false: a spell check is performed. |
| 5246 | "jobCategories": [ # Optional. The category filter specifies the categories of jobs to search against. |
| 5247 | # See Category for more information. |
| 5248 | # |
| 5249 | # If a value is not specified, jobs from any category are searched against. |
| 5250 | # |
| 5251 | # If multiple values are specified, jobs from any of the specified |
| 5252 | # categories are searched against. |
| 5253 | "A String", |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 5254 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5255 | "companyNames": [ # Optional. This filter specifies the company entities to search against. |
| 5256 | # |
| 5257 | # If a value isn't specified, jobs are searched for against all |
| 5258 | # companies. |
| 5259 | # |
| 5260 | # If multiple values are specified, jobs are searched against the |
| 5261 | # companies specified. |
| 5262 | # |
| 5263 | # The format is "projects/{project_id}/companies/{company_id}", for example, |
| 5264 | # "projects/api-test-project/companies/foo". |
| 5265 | # |
| 5266 | # At most 20 company filters are allowed. |
| 5267 | "A String", |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 5268 | ], |
| 5269 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5270 | "jobView": "A String", # Optional. The desired job attributes returned for jobs in the |
| 5271 | # search response. Defaults to JobView.SMALL if no value is specified. |
| 5272 | "requirePreciseResultSize": True or False, # Optional. Controls if the search job request requires the return of a precise |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 5273 | # count of the first 300 results. Setting this to `true` ensures |
| 5274 | # consistency in the number of results per page. Best practice is to set this |
| 5275 | # value to true if a client allows users to jump directly to a |
| 5276 | # non-sequential search results page. |
| 5277 | # |
| 5278 | # Enabling this flag may adversely impact performance. |
| 5279 | # |
| 5280 | # Defaults to false. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5281 | "pageToken": "A String", # Optional. The token specifying the current offset within |
| 5282 | # search results. See SearchJobsResponse.next_page_token for |
| 5283 | # an explanation of how to obtain the next set of query results. |
| 5284 | "diversificationLevel": "A String", # Optional. Controls whether highly similar jobs are returned next to each other in |
| 5285 | # the search results. Jobs are identified as highly similar based on |
| 5286 | # their titles, job categories, and locations. Highly similar results are |
| 5287 | # clustered so that only one representative job of the cluster is |
| 5288 | # displayed to the job seeker higher up in the results, with the other jobs |
| 5289 | # being displayed lower down in the results. |
| 5290 | # |
| 5291 | # Defaults to DiversificationLevel.SIMPLE if no value |
| 5292 | # is specified. |
| 5293 | "searchMode": "A String", # Optional. Mode of a search. |
| 5294 | # |
| 5295 | # Defaults to SearchMode.JOB_SEARCH. |
| 5296 | "requestMetadata": { # Input only. # Required. The meta information collected about the job searcher, used to improve the |
| 5297 | # search quality of the service. The identifiers (such as `user_id`) are |
| 5298 | # provided by users, and must be unique and consistent. |
| 5299 | # |
| 5300 | # Meta information related to the job searcher or entity |
| 5301 | # conducting the job search. This information is used to improve the |
| 5302 | # performance of the service. |
| 5303 | "domain": "A String", # Required. The client-defined scope or source of the service call, which typically |
| 5304 | # is the domain on |
| 5305 | # which the service has been implemented and is currently being run. |
| 5306 | # |
| 5307 | # For example, if the service is being run by client <em>Foo, Inc.</em>, on |
| 5308 | # job board www.foo.com and career site www.bar.com, then this field is |
| 5309 | # set to "foo.com" for use on the job board, and "bar.com" for use on the |
| 5310 | # career site. |
| 5311 | # |
| 5312 | # If this field isn't available for some reason, send "UNKNOWN". |
| 5313 | # Any improvements to the model for a particular tenant site rely on this |
| 5314 | # field being set correctly to a domain. |
| 5315 | # |
| 5316 | # The maximum number of allowed characters is 255. |
| 5317 | "userId": "A String", # Required. A unique user identification string, as determined by the client. |
| 5318 | # To have the strongest positive impact on search quality |
| 5319 | # make sure the client-level is unique. |
| 5320 | # Obfuscate this field for privacy concerns before |
| 5321 | # providing it to the service. |
| 5322 | # |
| 5323 | # If this field is not available for some reason, send "UNKNOWN". Note |
| 5324 | # that any improvements to the model for a particular tenant |
| 5325 | # site, rely on this field being set correctly to a unique user_id. |
| 5326 | # |
| 5327 | # The maximum number of allowed characters is 255. |
| 5328 | "deviceInfo": { # Device information collected from the job seeker, candidate, or # Optional. The type of device used by the job seeker at the time of the call to the |
| 5329 | # service. |
| 5330 | # other entity conducting the job search. Providing this information improves |
| 5331 | # the quality of the search results across devices. |
| 5332 | "deviceType": "A String", # Optional. Type of the device. |
| 5333 | "id": "A String", # Optional. A device-specific ID. The ID must be a unique identifier that |
| 5334 | # distinguishes the device from other devices. |
| 5335 | }, |
| 5336 | "sessionId": "A String", # Required. A unique session identification string. A session is defined as the |
| 5337 | # duration of an end user's interaction with the service over a certain |
| 5338 | # period. |
| 5339 | # Obfuscate this field for privacy concerns before |
| 5340 | # providing it to the service. |
| 5341 | # |
| 5342 | # If this field is not available for some reason, send "UNKNOWN". Note |
| 5343 | # that any improvements to the model for a particular tenant |
| 5344 | # site, rely on this field being set correctly to some unique session_id. |
| 5345 | # |
| 5346 | # The maximum number of allowed characters is 255. |
| 5347 | }, |
| 5348 | "disableKeywordMatch": True or False, # Optional. Controls whether to disable exact keyword match on Job.job_title, |
| 5349 | # Job.description, Job.company_display_name, Job.locations, |
| 5350 | # Job.qualifications. When disable keyword match is turned off, a |
| 5351 | # keyword match returns jobs that do not match given category filters when |
| 5352 | # there are matching keywords. For example, the query "program manager," a |
| 5353 | # result is returned even if the job posting has the title "software |
| 5354 | # developer," which does not fall into "program manager" ontology, but does |
| 5355 | # have "program manager" appearing in its description. |
| 5356 | # |
| 5357 | # For queries like "cloud" that does not contain title or |
| 5358 | # location specific ontology, jobs with "cloud" keyword matches are returned |
| 5359 | # regardless of this flag's value. |
| 5360 | # |
| 5361 | # Please use Company.keyword_searchable_custom_fields or |
| 5362 | # Company.keyword_searchable_custom_attributes if company specific |
| 5363 | # globally matched custom field/attribute string values is needed. Enabling |
| 5364 | # keyword match improves recall of subsequent search requests. |
| 5365 | # |
| 5366 | # Defaults to false. |
| 5367 | "enableBroadening": True or False, # Optional. Controls whether to broaden the search when it produces sparse results. |
| 5368 | # Broadened queries append results to the end of the matching results |
| 5369 | # list. |
| 5370 | # |
| 5371 | # Defaults to false. |
| 5372 | "offset": 42, # Optional. An integer that specifies the current offset (that is, starting result |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 5373 | # location, amongst the jobs deemed by the API as relevant) in search |
| 5374 | # results. This field is only considered if page_token is unset. |
| 5375 | # |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 5376 | # The maximum allowed value is 5000. Otherwise an error is thrown. |
| 5377 | # |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 5378 | # For example, 0 means to return results starting from the first matching |
| 5379 | # job, and 10 means to return from the 11th job. This can be used for |
| 5380 | # pagination, (for example, pageSize = 10 and offset = 10 means to return |
| 5381 | # from the second page). |
| 5382 | } |
| 5383 | |
| 5384 | x__xgafv: string, V1 error format. |
| 5385 | Allowed values |
| 5386 | 1 - v1 error format |
| 5387 | 2 - v2 error format |
| 5388 | |
| 5389 | Returns: |
| 5390 | An object of the form: |
| 5391 | |
| 5392 | { # Output only. |
| 5393 | # |
| 5394 | # Response for SearchJob method. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5395 | "locationFilters": [ # The location filters that the service applied to the specified query. If |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 5396 | # any filters are lat-lng based, the JobLocation.location_type is |
| 5397 | # JobLocation.LocationType#LOCATION_TYPE_UNSPECIFIED. |
| 5398 | { # Output only. |
| 5399 | # |
| 5400 | # A resource that represents a location with full geographic information. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5401 | "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 5402 | # of doubles representing degrees latitude and degrees longitude. Unless |
| 5403 | # specified otherwise, this must conform to the |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5404 | # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 5405 | # standard</a>. Values must be within normalized ranges. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5406 | "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. |
| 5407 | "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 5408 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5409 | "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 5410 | # such as postal delivery and payments addresses. Given a postal address, |
| 5411 | # a postal service can deliver items to a premises, P.O. Box, or other |
| 5412 | # delivery location. |
| 5413 | # Given a postal address, a postal service can deliver items to a premise, P.O. |
| 5414 | # Box or similar. |
| 5415 | # It is not intended to model geographical locations (roads, towns, |
| 5416 | # mountains). |
| 5417 | # |
| 5418 | # In typical usage an address would be created via user input or from importing |
| 5419 | # existing data, depending on the type of process. |
| 5420 | # |
| 5421 | # Advice on address input / editing: |
| 5422 | # - Use an i18n-ready address widget such as |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 5423 | # https://github.com/google/libaddressinput) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 5424 | # - Users should not be presented with UI elements for input or editing of |
| 5425 | # fields outside countries where that field is used. |
| 5426 | # |
| 5427 | # For more guidance on how to use this schema, please see: |
| 5428 | # https://support.google.com/business/answer/6397478 |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5429 | "sublocality": "A String", # Optional. Sublocality of the address. |
| 5430 | # For example, this can be neighborhoods, boroughs, districts. |
| 5431 | "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is |
| 5432 | # the latest revision. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 5433 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5434 | # All new revisions **must** be backward compatible with old revisions. |
| 5435 | "locality": "A String", # Optional. Generally refers to the city/town portion of the address. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 5436 | # Examples: US city, IT comune, UK post town. |
| 5437 | # In regions of the world where localities are not well defined or do not fit |
| 5438 | # into this structure well, leave locality empty and use address_lines. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5439 | "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 5440 | # addresses of a country or region. |
| 5441 | # For example, this can be a state, a province, an oblast, or a prefecture. |
| 5442 | # Specifically, for Spain this is the province and not the autonomous |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5443 | # community (e.g. "Barcelona" and not "Catalonia"). |
| 5444 | # Many countries don't use an administrative area in postal addresses. E.g. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 5445 | # in Switzerland this should be left unpopulated. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5446 | "organization": "A String", # Optional. The name of the organization at the address. |
| 5447 | "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This |
| 5448 | # is never inferred and it is up to the user to ensure the value is |
| 5449 | # correct. See http://cldr.unicode.org/ and |
| 5450 | # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html |
| 5451 | # for details. Example: "CH" for Switzerland. |
| 5452 | "addressLines": [ # Unstructured address lines describing the lower levels of an address. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 5453 | # |
| 5454 | # Because values in address_lines do not have type information and may |
| 5455 | # sometimes contain multiple values in a single field (e.g. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5456 | # "Austin, TX"), it is important that the line order is clear. The order of |
| 5457 | # address lines should be "envelope order" for the country/region of the |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 5458 | # address. In places where this can vary (e.g. Japan), address_language is |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5459 | # used to make it explicit (e.g. "ja" for large-to-small ordering and |
| 5460 | # "ja-Latn" or "en" for small-to-large). This way, the most specific line of |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 5461 | # an address can be selected based on the language. |
| 5462 | # |
| 5463 | # The minimum permitted structural representation of an address consists |
| 5464 | # of a region_code with all remaining information placed in the |
| 5465 | # address_lines. It would be possible to format such an address very |
| 5466 | # approximately without geocoding, but no semantic reasoning could be |
| 5467 | # made about any of the address components until it was at least |
| 5468 | # partially resolved. |
| 5469 | # |
| 5470 | # Creating an address only containing a region_code and address_lines, and |
| 5471 | # then geocoding is the recommended way to handle completely unstructured |
| 5472 | # addresses (as opposed to guessing which parts of the address should be |
| 5473 | # localities or administrative areas). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5474 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 5475 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5476 | "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 5477 | # postal codes to be present, but where they are used, they may trigger |
| 5478 | # additional validation with other parts of the address (e.g. state/zip |
| 5479 | # validation in the U.S.A.). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5480 | "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if |
| 5481 | # known). This is often the UI language of the input form or is expected |
| 5482 | # to match one of the languages used in the address' country/region, or their |
| 5483 | # transliterated equivalents. |
| 5484 | # This can affect formatting in certain countries, but is not critical |
| 5485 | # to the correctness of the data and will never affect any validation or |
| 5486 | # other non-formatting related operations. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 5487 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5488 | # If this value is not known, it should be omitted (rather than specifying a |
| 5489 | # possibly incorrect default). |
| 5490 | # |
| 5491 | # Examples: "zh-Hant", "ja", "ja-Latn", "en". |
| 5492 | "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used |
| 5493 | # in most regions. Where it is used, the value is either a string like |
| 5494 | # "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number |
| 5495 | # alone, representing the "sector code" (Jamaica), "delivery area indicator" |
| 5496 | # (Malawi) or "post office indicator" (e.g. Côte d'Ivoire). |
| 5497 | "recipients": [ # Optional. The recipient at the address. |
| 5498 | # This field may, under certain circumstances, contain multiline information. |
| 5499 | # For example, it might contain "care of" information. |
| 5500 | "A String", |
| 5501 | ], |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 5502 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5503 | "locationType": "A String", # The type of a location, which corresponds to the address lines field of |
| 5504 | # PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of |
| 5505 | # LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of |
| 5506 | # LocationType#LOCALITY. |
| 5507 | "radiusInMiles": 3.14, # Radius in miles of the job location. This value is derived from the |
| 5508 | # location bounding box in which a circle with the specified radius |
| 5509 | # centered from LatLng covers the area associated with the job location. |
| 5510 | # For example, currently, "Mountain View, CA, USA" has a radius of |
| 5511 | # 6.17 miles. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 5512 | }, |
| 5513 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5514 | "histogramResults": { # Output only. # The histogram results that match specified |
| 5515 | # SearchJobsRequest.histogram_facets. |
| 5516 | # |
| 5517 | # Histogram results that match HistogramFacets specified in |
| 5518 | # SearchJobsRequest. |
| 5519 | "compensationHistogramResults": [ # Specifies compensation field-based histogram results that match |
| 5520 | # HistogramFacets.compensation_histogram_requests. |
| 5521 | { # Output only. |
| 5522 | # |
| 5523 | # Compensation based histogram result. |
| 5524 | "result": { # Output only. # Histogram result. |
| 5525 | # |
| 5526 | # Custom numeric bucketing result. |
| 5527 | "counts": [ # Count within each bucket. Its size is the length of |
| 5528 | # NumericBucketingOption.bucket_bounds plus 1. |
| 5529 | { # Represents count of jobs within one bucket. |
| 5530 | "range": { # Represents starting and ending value of a range in double. # Bucket range on which histogram was performed for the numeric field, |
| 5531 | # that is, the count represents number of jobs in this range. |
| 5532 | "to": 3.14, # Ending value of the bucket range. |
| 5533 | "from": 3.14, # Starting value of the bucket range. |
| 5534 | }, |
| 5535 | "count": 42, # Number of jobs whose numeric field value fall into `range`. |
| 5536 | }, |
| 5537 | ], |
| 5538 | "minValue": 3.14, # Stores the minimum value of the numeric field. Will be populated only if |
| 5539 | # [NumericBucketingOption.requires_min_max] is set to true. |
| 5540 | "maxValue": 3.14, # Stores the maximum value of the numeric field. Is populated only if |
| 5541 | # [NumericBucketingOption.requires_min_max] is set to true. |
| 5542 | }, |
| 5543 | "type": "A String", # Type of the request, corresponding to |
| 5544 | # CompensationHistogramRequest.type. |
| 5545 | }, |
| 5546 | ], |
| 5547 | "customAttributeHistogramResults": [ # Specifies histogram results for custom attributes that match |
| 5548 | # HistogramFacets.custom_attribute_histogram_facets. |
| 5549 | { # Output only. |
| 5550 | # |
| 5551 | # Custom attribute histogram result. |
| 5552 | "longValueHistogramResult": { # Output only. # Stores bucketed histogram counting result or min/max values for |
| 5553 | # custom attribute long values associated with `key`. |
| 5554 | # |
| 5555 | # Custom numeric bucketing result. |
| 5556 | "counts": [ # Count within each bucket. Its size is the length of |
| 5557 | # NumericBucketingOption.bucket_bounds plus 1. |
| 5558 | { # Represents count of jobs within one bucket. |
| 5559 | "range": { # Represents starting and ending value of a range in double. # Bucket range on which histogram was performed for the numeric field, |
| 5560 | # that is, the count represents number of jobs in this range. |
| 5561 | "to": 3.14, # Ending value of the bucket range. |
| 5562 | "from": 3.14, # Starting value of the bucket range. |
| 5563 | }, |
| 5564 | "count": 42, # Number of jobs whose numeric field value fall into `range`. |
| 5565 | }, |
| 5566 | ], |
| 5567 | "minValue": 3.14, # Stores the minimum value of the numeric field. Will be populated only if |
| 5568 | # [NumericBucketingOption.requires_min_max] is set to true. |
| 5569 | "maxValue": 3.14, # Stores the maximum value of the numeric field. Is populated only if |
| 5570 | # [NumericBucketingOption.requires_min_max] is set to true. |
| 5571 | }, |
| 5572 | "stringValueHistogramResult": { # Stores a map from the values of string custom field associated |
| 5573 | # with `key` to the number of jobs with that value in this histogram result. |
| 5574 | "a_key": 42, |
| 5575 | }, |
| 5576 | "key": "A String", # Stores the key of custom attribute the histogram is performed on. |
| 5577 | }, |
| 5578 | ], |
| 5579 | "simpleHistogramResults": [ # Specifies histogram results that matches |
| 5580 | # HistogramFacets.simple_histogram_facets. |
| 5581 | { # Output only. |
| 5582 | # |
| 5583 | # Result of a histogram call. The response contains the histogram map for the |
| 5584 | # search type specified by HistogramResult.field. |
| 5585 | # The response is a map of each filter value to the corresponding count of |
| 5586 | # jobs for that filter. |
| 5587 | "values": { # A map from the values of field to the number of jobs with that value |
| 5588 | # in this search result. |
| 5589 | # |
| 5590 | # Key: search type (filter names, such as the companyName). |
| 5591 | # |
| 5592 | # Values: the count of jobs that match the filter for this search. |
| 5593 | "a_key": 42, |
| 5594 | }, |
| 5595 | "searchType": "A String", # The Histogram search filters. |
| 5596 | }, |
| 5597 | ], |
| 5598 | }, |
| 5599 | "metadata": { # Output only. # Additional information for the API invocation, such as the request |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 5600 | # tracking id. |
| 5601 | # |
| 5602 | # Additional information returned to client, such as debugging information. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5603 | "requestId": "A String", # A unique id associated with this call. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 5604 | # This id is logged for tracking purposes. |
| 5605 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5606 | "matchingJobs": [ # The Job entities that match the specified SearchJobsRequest. |
| 5607 | { # Output only. |
| 5608 | # |
| 5609 | # Job entry with metadata inside SearchJobsResponse. |
| 5610 | "searchTextSnippet": "A String", # Contains snippets of text from the Job.description and similar |
| 5611 | # fields that most closely match a search query's keywords, if available. |
| 5612 | # All HTML tags in the original fields are stripped when returned in this |
| 5613 | # field, and matching query keywords are enclosed in HTML bold tags. |
| 5614 | "jobTitleSnippet": "A String", # Contains snippets of text from the Job.job_title field most |
| 5615 | # closely matching a search query's keywords, if available. The matching |
| 5616 | # query keywords are enclosed in HTML bold tags. |
| 5617 | "jobSummary": "A String", # A summary of the job with core information that's displayed on the search |
| 5618 | # results listing page. |
| 5619 | "commuteInfo": { # Output only. # Commute information which is generated based on specified |
| 5620 | # CommuteFilter. |
| 5621 | # |
| 5622 | # Commute details related to this job. |
| 5623 | "travelDuration": "A String", # The number of seconds required to travel to the job location from the |
| 5624 | # query location. A duration of 0 seconds indicates that the job is not |
| 5625 | # reachable within the requested duration, but was returned as part of an |
| 5626 | # expanded query. |
| 5627 | "jobLocation": { # Output only. # Location used as the destination in the commute calculation. |
| 5628 | # |
| 5629 | # A resource that represents a location with full geographic information. |
| 5630 | "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair. |
| 5631 | # of doubles representing degrees latitude and degrees longitude. Unless |
| 5632 | # specified otherwise, this must conform to the |
| 5633 | # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 |
| 5634 | # standard</a>. Values must be within normalized ranges. |
| 5635 | "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. |
| 5636 | "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. |
| 5637 | }, |
| 5638 | "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information, |
| 5639 | # such as postal delivery and payments addresses. Given a postal address, |
| 5640 | # a postal service can deliver items to a premises, P.O. Box, or other |
| 5641 | # delivery location. |
| 5642 | # Given a postal address, a postal service can deliver items to a premise, P.O. |
| 5643 | # Box or similar. |
| 5644 | # It is not intended to model geographical locations (roads, towns, |
| 5645 | # mountains). |
| 5646 | # |
| 5647 | # In typical usage an address would be created via user input or from importing |
| 5648 | # existing data, depending on the type of process. |
| 5649 | # |
| 5650 | # Advice on address input / editing: |
| 5651 | # - Use an i18n-ready address widget such as |
| 5652 | # https://github.com/google/libaddressinput) |
| 5653 | # - Users should not be presented with UI elements for input or editing of |
| 5654 | # fields outside countries where that field is used. |
| 5655 | # |
| 5656 | # For more guidance on how to use this schema, please see: |
| 5657 | # https://support.google.com/business/answer/6397478 |
| 5658 | "sublocality": "A String", # Optional. Sublocality of the address. |
| 5659 | # For example, this can be neighborhoods, boroughs, districts. |
| 5660 | "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is |
| 5661 | # the latest revision. |
| 5662 | # |
| 5663 | # All new revisions **must** be backward compatible with old revisions. |
| 5664 | "locality": "A String", # Optional. Generally refers to the city/town portion of the address. |
| 5665 | # Examples: US city, IT comune, UK post town. |
| 5666 | # In regions of the world where localities are not well defined or do not fit |
| 5667 | # into this structure well, leave locality empty and use address_lines. |
| 5668 | "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal |
| 5669 | # addresses of a country or region. |
| 5670 | # For example, this can be a state, a province, an oblast, or a prefecture. |
| 5671 | # Specifically, for Spain this is the province and not the autonomous |
| 5672 | # community (e.g. "Barcelona" and not "Catalonia"). |
| 5673 | # Many countries don't use an administrative area in postal addresses. E.g. |
| 5674 | # in Switzerland this should be left unpopulated. |
| 5675 | "organization": "A String", # Optional. The name of the organization at the address. |
| 5676 | "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This |
| 5677 | # is never inferred and it is up to the user to ensure the value is |
| 5678 | # correct. See http://cldr.unicode.org/ and |
| 5679 | # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html |
| 5680 | # for details. Example: "CH" for Switzerland. |
| 5681 | "addressLines": [ # Unstructured address lines describing the lower levels of an address. |
| 5682 | # |
| 5683 | # Because values in address_lines do not have type information and may |
| 5684 | # sometimes contain multiple values in a single field (e.g. |
| 5685 | # "Austin, TX"), it is important that the line order is clear. The order of |
| 5686 | # address lines should be "envelope order" for the country/region of the |
| 5687 | # address. In places where this can vary (e.g. Japan), address_language is |
| 5688 | # used to make it explicit (e.g. "ja" for large-to-small ordering and |
| 5689 | # "ja-Latn" or "en" for small-to-large). This way, the most specific line of |
| 5690 | # an address can be selected based on the language. |
| 5691 | # |
| 5692 | # The minimum permitted structural representation of an address consists |
| 5693 | # of a region_code with all remaining information placed in the |
| 5694 | # address_lines. It would be possible to format such an address very |
| 5695 | # approximately without geocoding, but no semantic reasoning could be |
| 5696 | # made about any of the address components until it was at least |
| 5697 | # partially resolved. |
| 5698 | # |
| 5699 | # Creating an address only containing a region_code and address_lines, and |
| 5700 | # then geocoding is the recommended way to handle completely unstructured |
| 5701 | # addresses (as opposed to guessing which parts of the address should be |
| 5702 | # localities or administrative areas). |
| 5703 | "A String", |
| 5704 | ], |
| 5705 | "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require |
| 5706 | # postal codes to be present, but where they are used, they may trigger |
| 5707 | # additional validation with other parts of the address (e.g. state/zip |
| 5708 | # validation in the U.S.A.). |
| 5709 | "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if |
| 5710 | # known). This is often the UI language of the input form or is expected |
| 5711 | # to match one of the languages used in the address' country/region, or their |
| 5712 | # transliterated equivalents. |
| 5713 | # This can affect formatting in certain countries, but is not critical |
| 5714 | # to the correctness of the data and will never affect any validation or |
| 5715 | # other non-formatting related operations. |
| 5716 | # |
| 5717 | # If this value is not known, it should be omitted (rather than specifying a |
| 5718 | # possibly incorrect default). |
| 5719 | # |
| 5720 | # Examples: "zh-Hant", "ja", "ja-Latn", "en". |
| 5721 | "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used |
| 5722 | # in most regions. Where it is used, the value is either a string like |
| 5723 | # "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number |
| 5724 | # alone, representing the "sector code" (Jamaica), "delivery area indicator" |
| 5725 | # (Malawi) or "post office indicator" (e.g. Côte d'Ivoire). |
| 5726 | "recipients": [ # Optional. The recipient at the address. |
| 5727 | # This field may, under certain circumstances, contain multiline information. |
| 5728 | # For example, it might contain "care of" information. |
| 5729 | "A String", |
| 5730 | ], |
| 5731 | }, |
| 5732 | "locationType": "A String", # The type of a location, which corresponds to the address lines field of |
| 5733 | # PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of |
| 5734 | # LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of |
| 5735 | # LocationType#LOCALITY. |
| 5736 | "radiusInMiles": 3.14, # Radius in miles of the job location. This value is derived from the |
| 5737 | # location bounding box in which a circle with the specified radius |
| 5738 | # centered from LatLng covers the area associated with the job location. |
| 5739 | # For example, currently, "Mountain View, CA, USA" has a radius of |
| 5740 | # 6.17 miles. |
| 5741 | }, |
| 5742 | }, |
| 5743 | "job": { # A Job resource represents a job posting (also referred to as a "job listing" # Job resource that matches the specified SearchJobsRequest. |
| 5744 | # or "job requisition"). A job belongs to a Company, which is the hiring |
| 5745 | # entity responsible for the job. |
| 5746 | "jobLevel": "A String", # Optional. The experience level associated with the job, such as "Entry Level". |
| 5747 | "languageCode": "A String", # Optional. The language of the posting. This field is distinct from |
| 5748 | # any requirements for fluency that are associated with the job. |
| 5749 | # |
| 5750 | # Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn". |
| 5751 | # For more information, see |
| 5752 | # [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){: |
| 5753 | # class="external" target="_blank" }. |
| 5754 | # |
| 5755 | # If this field is unspecified and Job.description is present, detected |
| 5756 | # language code based on Job.description is assigned, otherwise |
| 5757 | # defaults to 'en_US'. |
| 5758 | "postingUpdateTime": "A String", # Output only. The timestamp when this job posting was last updated. |
| 5759 | "visibility": "A String", # Deprecated. The job is only visible to the owner. |
| 5760 | # |
| 5761 | # The visibility of the job. |
| 5762 | # |
| 5763 | # Defaults to Visibility.ACCOUNT_ONLY if not specified. |
| 5764 | "name": "A String", # Required during job update. |
| 5765 | # |
| 5766 | # The resource name for the job. This is generated by the service when a |
| 5767 | # job is created. |
| 5768 | # |
| 5769 | # The format is "projects/{project_id}/jobs/{job_id}", |
| 5770 | # for example, "projects/api-test-project/jobs/1234". |
| 5771 | # |
| 5772 | # Use of this field in job queries and API calls is preferred over the use of |
| 5773 | # requisition_id since this value is unique. |
| 5774 | "jobBenefits": [ # Optional. The benefits included with the job. |
| 5775 | "A String", |
| 5776 | ], |
| 5777 | "promotionValue": 42, # Optional. A promotion value of the job, as determined by the client. |
| 5778 | # The value determines the sort order of the jobs returned when searching for |
| 5779 | # jobs using the featured jobs search call, with higher promotional values |
| 5780 | # being returned first and ties being resolved by relevance sort. Only the |
| 5781 | # jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH. |
| 5782 | # |
| 5783 | # Default value is 0, and negative values are treated as 0. |
| 5784 | "title": "A String", # Required. The title of the job, such as "Software Engineer" |
| 5785 | # |
| 5786 | # The maximum number of allowed characters is 500. |
| 5787 | "companyDisplayName": "A String", # Output only. Display name of the company listing the job. |
| 5788 | "requisitionId": "A String", # Required. The requisition ID, also referred to as the posting ID, assigned by the |
| 5789 | # client to identify a job. This field is intended to be used by clients |
| 5790 | # for client identification and tracking of postings. A job is not allowed |
| 5791 | # to be created if there is another job with the same [company_name], |
| 5792 | # language_code and requisition_id. |
| 5793 | # |
| 5794 | # The maximum number of allowed characters is 255. |
| 5795 | "qualifications": "A String", # Optional. A description of the qualifications required to perform the |
| 5796 | # job. The use of this field is recommended |
| 5797 | # as an alternative to using the more general description field. |
| 5798 | # |
| 5799 | # This field accepts and sanitizes HTML input, and also accepts |
| 5800 | # bold, italic, ordered list, and unordered list markup tags. |
| 5801 | # |
| 5802 | # The maximum number of allowed characters is 10,000. |
| 5803 | "processingOptions": { # Input only. # Optional. Options for job processing. |
| 5804 | # |
| 5805 | # Options for job processing. |
| 5806 | "disableStreetAddressResolution": True or False, # Optional. If set to `true`, the service does not attempt to resolve a |
| 5807 | # more precise address for the job. |
| 5808 | "htmlSanitization": "A String", # Optional. Option for job HTML content sanitization. Applied fields are: |
| 5809 | # |
| 5810 | # * description |
| 5811 | # * applicationInfo.instruction |
| 5812 | # * incentives |
| 5813 | # * qualifications |
| 5814 | # * responsibilities |
| 5815 | # |
| 5816 | # HTML tags in these fields may be stripped if sanitiazation is not |
| 5817 | # disabled. |
| 5818 | # |
| 5819 | # Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY. |
| 5820 | }, |
| 5821 | "jobEndTime": "A String", # Optional. The end timestamp of the job. Typically this field is used for contracting |
| 5822 | # engagements. Invalid timestamps are ignored. |
| 5823 | "derivedInfo": { # Output only. # Output only. Derived details about the job posting. |
| 5824 | # |
| 5825 | # Derived details about the job posting. |
| 5826 | "jobCategories": [ # Job categories derived from Job.title and Job.description. |
| 5827 | "A String", |
| 5828 | ], |
| 5829 | "locations": [ # Structured locations of the job, resolved from Job.addresses. |
| 5830 | # |
| 5831 | # locations are exactly matched to Job.addresses in the same |
| 5832 | # order. |
| 5833 | { # Output only. |
| 5834 | # |
| 5835 | # A resource that represents a location with full geographic information. |
| 5836 | "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair. |
| 5837 | # of doubles representing degrees latitude and degrees longitude. Unless |
| 5838 | # specified otherwise, this must conform to the |
| 5839 | # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 |
| 5840 | # standard</a>. Values must be within normalized ranges. |
| 5841 | "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. |
| 5842 | "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. |
| 5843 | }, |
| 5844 | "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information, |
| 5845 | # such as postal delivery and payments addresses. Given a postal address, |
| 5846 | # a postal service can deliver items to a premises, P.O. Box, or other |
| 5847 | # delivery location. |
| 5848 | # Given a postal address, a postal service can deliver items to a premise, P.O. |
| 5849 | # Box or similar. |
| 5850 | # It is not intended to model geographical locations (roads, towns, |
| 5851 | # mountains). |
| 5852 | # |
| 5853 | # In typical usage an address would be created via user input or from importing |
| 5854 | # existing data, depending on the type of process. |
| 5855 | # |
| 5856 | # Advice on address input / editing: |
| 5857 | # - Use an i18n-ready address widget such as |
| 5858 | # https://github.com/google/libaddressinput) |
| 5859 | # - Users should not be presented with UI elements for input or editing of |
| 5860 | # fields outside countries where that field is used. |
| 5861 | # |
| 5862 | # For more guidance on how to use this schema, please see: |
| 5863 | # https://support.google.com/business/answer/6397478 |
| 5864 | "sublocality": "A String", # Optional. Sublocality of the address. |
| 5865 | # For example, this can be neighborhoods, boroughs, districts. |
| 5866 | "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is |
| 5867 | # the latest revision. |
| 5868 | # |
| 5869 | # All new revisions **must** be backward compatible with old revisions. |
| 5870 | "locality": "A String", # Optional. Generally refers to the city/town portion of the address. |
| 5871 | # Examples: US city, IT comune, UK post town. |
| 5872 | # In regions of the world where localities are not well defined or do not fit |
| 5873 | # into this structure well, leave locality empty and use address_lines. |
| 5874 | "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal |
| 5875 | # addresses of a country or region. |
| 5876 | # For example, this can be a state, a province, an oblast, or a prefecture. |
| 5877 | # Specifically, for Spain this is the province and not the autonomous |
| 5878 | # community (e.g. "Barcelona" and not "Catalonia"). |
| 5879 | # Many countries don't use an administrative area in postal addresses. E.g. |
| 5880 | # in Switzerland this should be left unpopulated. |
| 5881 | "organization": "A String", # Optional. The name of the organization at the address. |
| 5882 | "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This |
| 5883 | # is never inferred and it is up to the user to ensure the value is |
| 5884 | # correct. See http://cldr.unicode.org/ and |
| 5885 | # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html |
| 5886 | # for details. Example: "CH" for Switzerland. |
| 5887 | "addressLines": [ # Unstructured address lines describing the lower levels of an address. |
| 5888 | # |
| 5889 | # Because values in address_lines do not have type information and may |
| 5890 | # sometimes contain multiple values in a single field (e.g. |
| 5891 | # "Austin, TX"), it is important that the line order is clear. The order of |
| 5892 | # address lines should be "envelope order" for the country/region of the |
| 5893 | # address. In places where this can vary (e.g. Japan), address_language is |
| 5894 | # used to make it explicit (e.g. "ja" for large-to-small ordering and |
| 5895 | # "ja-Latn" or "en" for small-to-large). This way, the most specific line of |
| 5896 | # an address can be selected based on the language. |
| 5897 | # |
| 5898 | # The minimum permitted structural representation of an address consists |
| 5899 | # of a region_code with all remaining information placed in the |
| 5900 | # address_lines. It would be possible to format such an address very |
| 5901 | # approximately without geocoding, but no semantic reasoning could be |
| 5902 | # made about any of the address components until it was at least |
| 5903 | # partially resolved. |
| 5904 | # |
| 5905 | # Creating an address only containing a region_code and address_lines, and |
| 5906 | # then geocoding is the recommended way to handle completely unstructured |
| 5907 | # addresses (as opposed to guessing which parts of the address should be |
| 5908 | # localities or administrative areas). |
| 5909 | "A String", |
| 5910 | ], |
| 5911 | "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require |
| 5912 | # postal codes to be present, but where they are used, they may trigger |
| 5913 | # additional validation with other parts of the address (e.g. state/zip |
| 5914 | # validation in the U.S.A.). |
| 5915 | "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if |
| 5916 | # known). This is often the UI language of the input form or is expected |
| 5917 | # to match one of the languages used in the address' country/region, or their |
| 5918 | # transliterated equivalents. |
| 5919 | # This can affect formatting in certain countries, but is not critical |
| 5920 | # to the correctness of the data and will never affect any validation or |
| 5921 | # other non-formatting related operations. |
| 5922 | # |
| 5923 | # If this value is not known, it should be omitted (rather than specifying a |
| 5924 | # possibly incorrect default). |
| 5925 | # |
| 5926 | # Examples: "zh-Hant", "ja", "ja-Latn", "en". |
| 5927 | "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used |
| 5928 | # in most regions. Where it is used, the value is either a string like |
| 5929 | # "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number |
| 5930 | # alone, representing the "sector code" (Jamaica), "delivery area indicator" |
| 5931 | # (Malawi) or "post office indicator" (e.g. Côte d'Ivoire). |
| 5932 | "recipients": [ # Optional. The recipient at the address. |
| 5933 | # This field may, under certain circumstances, contain multiline information. |
| 5934 | # For example, it might contain "care of" information. |
| 5935 | "A String", |
| 5936 | ], |
| 5937 | }, |
| 5938 | "locationType": "A String", # The type of a location, which corresponds to the address lines field of |
| 5939 | # PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of |
| 5940 | # LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of |
| 5941 | # LocationType#LOCALITY. |
| 5942 | "radiusInMiles": 3.14, # Radius in miles of the job location. This value is derived from the |
| 5943 | # location bounding box in which a circle with the specified radius |
| 5944 | # centered from LatLng covers the area associated with the job location. |
| 5945 | # For example, currently, "Mountain View, CA, USA" has a radius of |
| 5946 | # 6.17 miles. |
| 5947 | }, |
| 5948 | ], |
| 5949 | }, |
| 5950 | "employmentTypes": [ # Optional. The employment type(s) of a job, for example, |
| 5951 | # full time or |
| 5952 | # part time. |
| 5953 | "A String", |
| 5954 | ], |
| 5955 | "incentives": "A String", # Optional. A description of bonus, commission, and other compensation |
| 5956 | # incentives associated with the job not including salary or pay. |
| 5957 | # |
| 5958 | # The maximum number of allowed characters is 10,000. |
| 5959 | "postingCreateTime": "A String", # Output only. The timestamp when this job posting was created. |
| 5960 | "addresses": [ # Optional but strongly recommended for the best service experience. |
| 5961 | # |
| 5962 | # Location(s) where the employer is looking to hire for this job posting. |
| 5963 | # |
| 5964 | # Specifying the full street address(es) of the hiring location enables |
| 5965 | # better API results, especially job searches by commute time. |
| 5966 | # |
| 5967 | # At most 50 locations are allowed for best search performance. If a job has |
| 5968 | # more locations, it is suggested to split it into multiple jobs with unique |
| 5969 | # requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as |
| 5970 | # multiple jobs with the same company_name, language_code and |
| 5971 | # requisition_id are not allowed. If the original requisition_id must |
| 5972 | # be preserved, a custom field should be used for storage. It is also |
| 5973 | # suggested to group the locations that close to each other in the same job |
| 5974 | # for better search experience. |
| 5975 | # |
| 5976 | # The maximum number of allowed characters is 500. |
| 5977 | "A String", |
| 5978 | ], |
| 5979 | "companyName": "A String", # Required. The resource name of the company listing the job, such as |
| 5980 | # "projects/api-test-project/companies/foo". |
| 5981 | "description": "A String", # Required. The description of the job, which typically includes a multi-paragraph |
| 5982 | # description of the company and related information. Separate fields are |
| 5983 | # provided on the job object for responsibilities, |
| 5984 | # qualifications, and other job characteristics. Use of |
| 5985 | # these separate job fields is recommended. |
| 5986 | # |
| 5987 | # This field accepts and sanitizes HTML input, and also accepts |
| 5988 | # bold, italic, ordered list, and unordered list markup tags. |
| 5989 | # |
| 5990 | # The maximum number of allowed characters is 100,000. |
| 5991 | "jobStartTime": "A String", # Optional. The start timestamp of the job in UTC time zone. Typically this field |
| 5992 | # is used for contracting engagements. Invalid timestamps are ignored. |
| 5993 | "degreeTypes": [ # Optional. The desired education degrees for the job, such as Bachelors, Masters. |
| 5994 | "A String", |
| 5995 | ], |
| 5996 | "compensationInfo": { # Job compensation details. # Optional. Job compensation information. |
| 5997 | "annualizedBaseCompensationRange": { # Compensation range. # Output only. Annualized base compensation range. Computed as |
| 5998 | # base compensation entry's CompensationEntry.compensation times |
| 5999 | # CompensationEntry.expected_units_per_year. |
| 6000 | # |
| 6001 | # See CompensationEntry for explanation on compensation annualization. |
| 6002 | "maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set |
| 6003 | # to a maximal compensation value and the currency code is set to |
| 6004 | # match the currency code of |
| 6005 | # min_compensation. |
| 6006 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 6007 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 6008 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 6009 | # If `units` is positive, `nanos` must be positive or zero. |
| 6010 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 6011 | # If `units` is negative, `nanos` must be negative or zero. |
| 6012 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 6013 | "units": "A String", # The whole units of the amount. |
| 6014 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 6015 | }, |
| 6016 | "minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set |
| 6017 | # to zero and the currency code is set to match the |
| 6018 | # currency code of max_compensation. |
| 6019 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 6020 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 6021 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 6022 | # If `units` is positive, `nanos` must be positive or zero. |
| 6023 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 6024 | # If `units` is negative, `nanos` must be negative or zero. |
| 6025 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 6026 | "units": "A String", # The whole units of the amount. |
| 6027 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 6028 | }, |
| 6029 | }, |
| 6030 | "annualizedTotalCompensationRange": { # Compensation range. # Output only. Annualized total compensation range. Computed as |
| 6031 | # all compensation entries' CompensationEntry.compensation times |
| 6032 | # CompensationEntry.expected_units_per_year. |
| 6033 | # |
| 6034 | # See CompensationEntry for explanation on compensation annualization. |
| 6035 | "maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set |
| 6036 | # to a maximal compensation value and the currency code is set to |
| 6037 | # match the currency code of |
| 6038 | # min_compensation. |
| 6039 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 6040 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 6041 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 6042 | # If `units` is positive, `nanos` must be positive or zero. |
| 6043 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 6044 | # If `units` is negative, `nanos` must be negative or zero. |
| 6045 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 6046 | "units": "A String", # The whole units of the amount. |
| 6047 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 6048 | }, |
| 6049 | "minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set |
| 6050 | # to zero and the currency code is set to match the |
| 6051 | # currency code of max_compensation. |
| 6052 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 6053 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 6054 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 6055 | # If `units` is positive, `nanos` must be positive or zero. |
| 6056 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 6057 | # If `units` is negative, `nanos` must be negative or zero. |
| 6058 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 6059 | "units": "A String", # The whole units of the amount. |
| 6060 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 6061 | }, |
| 6062 | }, |
| 6063 | "entries": [ # Optional. Job compensation information. |
| 6064 | # |
| 6065 | # At most one entry can be of type |
| 6066 | # CompensationInfo.CompensationType.BASE, which is |
| 6067 | # referred as ** base compensation entry ** for the job. |
| 6068 | { # A compensation entry that represents one component of compensation, such |
| 6069 | # as base pay, bonus, or other compensation type. |
| 6070 | # |
| 6071 | # Annualization: One compensation entry can be annualized if |
| 6072 | # - it contains valid amount or range. |
| 6073 | # - and its expected_units_per_year is set or can be derived. |
| 6074 | # Its annualized range is determined as (amount or range) times |
| 6075 | # expected_units_per_year. |
| 6076 | "unit": "A String", # Optional. Frequency of the specified amount. |
| 6077 | # |
| 6078 | # Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED. |
| 6079 | "amount": { # Represents an amount of money with its currency type. # Optional. Compensation amount. |
| 6080 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 6081 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 6082 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 6083 | # If `units` is positive, `nanos` must be positive or zero. |
| 6084 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 6085 | # If `units` is negative, `nanos` must be negative or zero. |
| 6086 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 6087 | "units": "A String", # The whole units of the amount. |
| 6088 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 6089 | }, |
| 6090 | "type": "A String", # Optional. Compensation type. |
| 6091 | # |
| 6092 | # Default is CompensationUnit.COMPENSATION_TYPE_UNSPECIFIED. |
| 6093 | "range": { # Compensation range. # Optional. Compensation range. |
| 6094 | "maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set |
| 6095 | # to a maximal compensation value and the currency code is set to |
| 6096 | # match the currency code of |
| 6097 | # min_compensation. |
| 6098 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 6099 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 6100 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 6101 | # If `units` is positive, `nanos` must be positive or zero. |
| 6102 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 6103 | # If `units` is negative, `nanos` must be negative or zero. |
| 6104 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 6105 | "units": "A String", # The whole units of the amount. |
| 6106 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 6107 | }, |
| 6108 | "minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set |
| 6109 | # to zero and the currency code is set to match the |
| 6110 | # currency code of max_compensation. |
| 6111 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 6112 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 6113 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 6114 | # If `units` is positive, `nanos` must be positive or zero. |
| 6115 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 6116 | # If `units` is negative, `nanos` must be negative or zero. |
| 6117 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 6118 | "units": "A String", # The whole units of the amount. |
| 6119 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 6120 | }, |
| 6121 | }, |
| 6122 | "expectedUnitsPerYear": 3.14, # Optional. Expected number of units paid each year. If not specified, when |
| 6123 | # Job.employment_types is FULLTIME, a default value is inferred |
| 6124 | # based on unit. Default values: |
| 6125 | # - HOURLY: 2080 |
| 6126 | # - DAILY: 260 |
| 6127 | # - WEEKLY: 52 |
| 6128 | # - MONTHLY: 12 |
| 6129 | # - ANNUAL: 1 |
| 6130 | "description": "A String", # Optional. Compensation description. For example, could |
| 6131 | # indicate equity terms or provide additional context to an estimated |
| 6132 | # bonus. |
| 6133 | }, |
| 6134 | ], |
| 6135 | }, |
| 6136 | "responsibilities": "A String", # Optional. A description of job responsibilities. The use of this field is |
| 6137 | # recommended as an alternative to using the more general description |
| 6138 | # field. |
| 6139 | # |
| 6140 | # This field accepts and sanitizes HTML input, and also accepts |
| 6141 | # bold, italic, ordered list, and unordered list markup tags. |
| 6142 | # |
| 6143 | # The maximum number of allowed characters is 10,000. |
| 6144 | "department": "A String", # Optional. The department or functional area within the company with the open |
| 6145 | # position. |
| 6146 | # |
| 6147 | # The maximum number of allowed characters is 255. |
| 6148 | "applicationInfo": { # Application related details of a job posting. # Required. At least one field within ApplicationInfo must be specified. |
| 6149 | # |
| 6150 | # Job application information. |
| 6151 | "uris": [ # Optional but at least one of uris, |
| 6152 | # emails or instruction must be |
| 6153 | # specified. |
| 6154 | # |
| 6155 | # Use this URI field to direct an applicant to a website, for example to |
| 6156 | # link to an online application form. |
| 6157 | # |
| 6158 | # The maximum number of allowed characters for each entry is 2,000. |
| 6159 | "A String", |
| 6160 | ], |
| 6161 | "emails": [ # Optional but at least one of uris, |
| 6162 | # emails or instruction must be |
| 6163 | # specified. |
| 6164 | # |
| 6165 | # Use this field to specify email address(es) to which resumes or |
| 6166 | # applications can be sent. |
| 6167 | # |
| 6168 | # The maximum number of allowed characters for each entry is 255. |
| 6169 | "A String", |
| 6170 | ], |
| 6171 | "instruction": "A String", # Optional but at least one of uris, |
| 6172 | # emails or instruction must be |
| 6173 | # specified. |
| 6174 | # |
| 6175 | # Use this field to provide instructions, such as "Mail your application |
| 6176 | # to ...", that a candidate can follow to apply for the job. |
| 6177 | # |
| 6178 | # This field accepts and sanitizes HTML input, and also accepts |
| 6179 | # bold, italic, ordered list, and unordered list markup tags. |
| 6180 | # |
| 6181 | # The maximum number of allowed characters is 3,000. |
| 6182 | }, |
| 6183 | "postingExpireTime": "A String", # Optional but strongly recommended for the best service |
| 6184 | # experience. |
| 6185 | # |
| 6186 | # The expiration timestamp of the job. After this timestamp, the |
| 6187 | # job is marked as expired, and it no longer appears in search results. The |
| 6188 | # expired job can't be deleted or listed by the DeleteJob and |
| 6189 | # ListJobs APIs, but it can be retrieved with the GetJob API or |
| 6190 | # updated with the UpdateJob API. An expired job can be updated and |
| 6191 | # opened again by using a future expiration timestamp. Updating an expired |
| 6192 | # job fails if there is another existing open job with same company_name, |
| 6193 | # language_code and requisition_id. |
| 6194 | # |
| 6195 | # The expired jobs are retained in our system for 90 days. However, the |
| 6196 | # overall expired job count cannot exceed 3 times the maximum of open jobs |
| 6197 | # count over the past week, otherwise jobs with earlier expire time are |
| 6198 | # cleaned first. Expired jobs are no longer accessible after they are cleaned |
| 6199 | # out. |
| 6200 | # |
| 6201 | # Invalid timestamps are ignored, and treated as expire time not provided. |
| 6202 | # |
| 6203 | # Timestamp before the instant request is made is considered valid, the job |
| 6204 | # will be treated as expired immediately. |
| 6205 | # |
| 6206 | # If this value is not provided at the time of job creation or is invalid, |
| 6207 | # the job posting expires after 30 days from the job's creation time. For |
| 6208 | # example, if the job was created on 2017/01/01 13:00AM UTC with an |
| 6209 | # unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC. |
| 6210 | # |
| 6211 | # If this value is not provided on job update, it depends on the field masks |
| 6212 | # set by UpdateJobRequest.update_mask. If the field masks include |
| 6213 | # expiry_time, or the masks are empty meaning that every field is |
| 6214 | # updated, the job posting expires after 30 days from the job's last |
| 6215 | # update time. Otherwise the expiration date isn't updated. |
| 6216 | "postingRegion": "A String", # Optional. The job PostingRegion (for example, state, country) throughout which |
| 6217 | # the job is available. If this field is set, a |
| 6218 | # LocationFilter in a search query within the job region |
| 6219 | # finds this job posting if an exact location match isn't specified. |
| 6220 | # If this field is set to PostingRegion.NATION or |
| 6221 | # PostingRegion.ADMINISTRATIVE_AREA, setting job Job.addresses |
| 6222 | # to the same location level as this field is strongly recommended. |
| 6223 | "postingPublishTime": "A String", # Optional. The timestamp this job posting was most recently published. The default |
| 6224 | # value is the time the request arrives at the server. Invalid timestamps are |
| 6225 | # ignored. |
| 6226 | "customAttributes": { # Optional. A map of fields to hold both filterable and non-filterable custom job |
| 6227 | # attributes that are not covered by the provided structured fields. |
| 6228 | # |
| 6229 | # The keys of the map are strings up to 64 bytes and must match the |
| 6230 | # pattern: a-zA-Z*. For example, key0LikeThis or |
| 6231 | # KEY_1_LIKE_THIS. |
| 6232 | # |
| 6233 | # At most 100 filterable and at most 100 unfilterable keys are supported. |
| 6234 | # For filterable `string_values`, across all keys at most 200 values are |
| 6235 | # allowed, with each string no more than 255 characters. For unfilterable |
| 6236 | # `string_values`, the maximum total size of `string_values` across all keys |
| 6237 | # is 50KB. |
| 6238 | "a_key": { # Custom attribute values that are either filterable or non-filterable. |
| 6239 | "stringValues": [ # Optional but exactly one of string_values or long_values must |
| 6240 | # be specified. |
| 6241 | # |
| 6242 | # This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or |
| 6243 | # `CASE_INSENSITIVE_MATCH`) search. |
| 6244 | # For filterable `string_value`s, a maximum total number of 200 values |
| 6245 | # is allowed, with each `string_value` has a byte size of no more than |
| 6246 | # 500B. For unfilterable `string_values`, the maximum total byte size of |
| 6247 | # unfilterable `string_values` is 50KB. |
| 6248 | # |
| 6249 | # Empty string is not allowed. |
| 6250 | "A String", |
| 6251 | ], |
| 6252 | "filterable": True or False, # Optional. If the `filterable` flag is true, the custom field values may be used for |
| 6253 | # custom attribute filters JobQuery.custom_attribute_filter. |
| 6254 | # If false, these values may not be used for custom attribute filters. |
| 6255 | # |
| 6256 | # Default is false. |
| 6257 | "longValues": [ # Optional but exactly one of string_values or long_values must |
| 6258 | # be specified. |
| 6259 | # |
| 6260 | # This field is used to perform number range search. |
| 6261 | # (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`. |
| 6262 | # |
| 6263 | # Currently at most 1 long_values is supported. |
| 6264 | "A String", |
| 6265 | ], |
| 6266 | }, |
| 6267 | }, |
| 6268 | }, |
| 6269 | }, |
| 6270 | ], |
| 6271 | "nextPageToken": "A String", # The token that specifies the starting position of the next page of results. |
| 6272 | # This field is empty if there are no more results. |
| 6273 | "spellCorrection": { # Output only. # The spell checking result, and correction. |
| 6274 | # |
| 6275 | # Spell check result. |
| 6276 | "corrected": True or False, # Indicates if the query was corrected by the spell checker. |
| 6277 | "correctedText": "A String", # Correction output consisting of the corrected keyword string. |
| 6278 | }, |
| 6279 | "estimatedTotalSize": 42, # An estimation of the number of jobs that match the specified query. |
| 6280 | # |
| 6281 | # This number is not guaranteed to be accurate. For accurate results, |
| 6282 | # see enable_precise_result_size. |
| 6283 | "broadenedQueryJobsCount": 42, # If query broadening is enabled, we may append additional results from the |
| 6284 | # broadened query. This number indicates how many of the jobs returned in the |
| 6285 | # jobs field are from the broadened query. These results are always at the |
| 6286 | # end of the jobs list. In particular, a value of 0, or if the field isn't |
| 6287 | # set, all the jobs in the jobs list are from the original |
| 6288 | # (without broadening) query. If this field is non-zero, subsequent requests |
| 6289 | # with offset after this result set should contain all broadened results. |
| 6290 | "totalSize": 42, # The precise result count, which is available only if the client set |
| 6291 | # enable_precise_result_size to `true`, or if the response |
| 6292 | # is the last page of results. Otherwise, the value is `-1`. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 6293 | }</pre> |
| 6294 | </div> |
| 6295 | |
| 6296 | <div class="method"> |
| 6297 | <code class="details" id="searchForAlert_next">searchForAlert_next(previous_request, previous_response)</code> |
| 6298 | <pre>Retrieves the next page of results. |
| 6299 | |
| 6300 | Args: |
| 6301 | previous_request: The request for the previous page. (required) |
| 6302 | previous_response: The response from the request for the previous page. (required) |
| 6303 | |
| 6304 | Returns: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 6305 | A request object that you can call 'execute()' on to request the next |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 6306 | page. Returns None if there are no more items in the collection. |
| 6307 | </pre> |
| 6308 | </div> |
| 6309 | |
| 6310 | <div class="method"> |
| 6311 | <code class="details" id="search_next">search_next(previous_request, previous_response)</code> |
| 6312 | <pre>Retrieves the next page of results. |
| 6313 | |
| 6314 | Args: |
| 6315 | previous_request: The request for the previous page. (required) |
| 6316 | previous_response: The response from the request for the previous page. (required) |
| 6317 | |
| 6318 | Returns: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 6319 | A request object that you can call 'execute()' on to request the next |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 6320 | page. Returns None if there are no more items in the collection. |
| 6321 | </pre> |
| 6322 | </div> |
| 6323 | |
| 6324 | </body></html> |