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_v2.html">Cloud Talent Solution API</a> . <a href="jobs_v2.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(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 Job postings 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(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"> |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 84 | <code><a href="#delete">delete(name, disableFastProcess=None, x__xgafv=None)</a></code></p> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 85 | <p class="firstline">Deletes the specified job.</p> |
| 86 | <p class="toc_element"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 87 | <code><a href="#deleteByFilter">deleteByFilter(body=None, x__xgafv=None)</a></code></p> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 88 | <p class="firstline">Deprecated. Use BatchDeleteJobs instead.</p> |
| 89 | <p class="toc_element"> |
| 90 | <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| 91 | <p class="firstline">Retrieves the specified job, whose status is OPEN or recently EXPIRED</p> |
| 92 | <p class="toc_element"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 93 | <code><a href="#histogram">histogram(body=None, x__xgafv=None)</a></code></p> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 94 | <p class="firstline">Deprecated. Use SearchJobsRequest.histogram_facets instead to make</p> |
| 95 | <p class="toc_element"> |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 96 | <code><a href="#list">list(filter=None, pageToken=None, pageSize=None, idsOnly=None, x__xgafv=None)</a></code></p> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 97 | <p class="firstline">Lists jobs by filter.</p> |
| 98 | <p class="toc_element"> |
| 99 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 100 | <p class="firstline">Retrieves the next page of results.</p> |
| 101 | <p class="toc_element"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 102 | <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] | 103 | <p class="firstline">Updates specified job.</p> |
| 104 | <p class="toc_element"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 105 | <code><a href="#search">search(body=None, x__xgafv=None)</a></code></p> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 106 | <p class="firstline">Searches for jobs using the provided SearchJobsRequest.</p> |
| 107 | <p class="toc_element"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 108 | <code><a href="#searchForAlert">searchForAlert(body=None, x__xgafv=None)</a></code></p> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 109 | <p class="firstline">Searches for jobs using the provided SearchJobsRequest.</p> |
| 110 | <p class="toc_element"> |
| 111 | <code><a href="#searchForAlert_next">searchForAlert_next(previous_request, previous_response)</a></code></p> |
| 112 | <p class="firstline">Retrieves the next page of results.</p> |
| 113 | <p class="toc_element"> |
| 114 | <code><a href="#search_next">search_next(previous_request, previous_response)</a></code></p> |
| 115 | <p class="firstline">Retrieves the next page of results.</p> |
| 116 | <h3>Method Details</h3> |
| 117 | <div class="method"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 118 | <code class="details" id="batchDelete">batchDelete(body=None, x__xgafv=None)</code> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 119 | <pre>Deletes a list of Job postings by filter. |
| 120 | |
| 121 | Args: |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 122 | body: object, The request body. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 123 | The object takes the form of: |
| 124 | |
| 125 | { # Input only. |
| 126 | # |
| 127 | # Batch delete jobs request. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 128 | "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] | 129 | # |
| 130 | # Supported operator: =, AND |
| 131 | # |
| 132 | # The fields eligible for filtering are: |
| 133 | # |
| 134 | # * `companyName` (Required) |
| 135 | # * `requisitionId` (Required) |
| 136 | # |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 137 | # Sample Query: companyName = "companies/123" AND requisitionId = "req-1" |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 138 | } |
| 139 | |
| 140 | x__xgafv: string, V1 error format. |
| 141 | Allowed values |
| 142 | 1 - v1 error format |
| 143 | 2 - v2 error format |
| 144 | |
| 145 | Returns: |
| 146 | An object of the form: |
| 147 | |
| 148 | { # A generic empty message that you can re-use to avoid defining duplicated |
| 149 | # empty messages in your APIs. A typical example is to use it as the request |
| 150 | # or the response type of an API method. For instance: |
| 151 | # |
| 152 | # service Foo { |
| 153 | # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); |
| 154 | # } |
| 155 | # |
| 156 | # The JSON representation for `Empty` is empty JSON object `{}`. |
| 157 | }</pre> |
| 158 | </div> |
| 159 | |
| 160 | <div class="method"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 161 | <code class="details" id="create">create(body=None, x__xgafv=None)</code> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 162 | <pre>Creates a new job. |
| 163 | |
| 164 | Typically, the job becomes searchable within 10 seconds, but it may take |
| 165 | up to 5 minutes. |
| 166 | |
| 167 | Args: |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 168 | body: object, The request body. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 169 | The object takes the form of: |
| 170 | |
| 171 | { # Input only. |
| 172 | # |
| 173 | # Create job request. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 174 | "job": { # A Job resource represents a job posting (also referred to as a "job listing" # Required. The Job to be created. |
| 175 | # 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] | 176 | # entity responsible for the job. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 177 | "languageCode": "A String", # Optional. The language of the posting. This field is distinct from |
| 178 | # any requirements for fluency that are associated with the job. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 179 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 180 | # Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn". |
| 181 | # For more information, see |
| 182 | # [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){: |
| 183 | # class="external" target="_blank" }. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 184 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 185 | # If this field is unspecified and Job.description is present, detected |
| 186 | # language code based on Job.description is assigned, otherwise |
| 187 | # defaults to 'en_US'. |
| 188 | "educationLevels": [ # Optional. The desired education level for the job, such as |
| 189 | # "Bachelors", "Masters", "Doctorate". |
| 190 | "A String", |
| 191 | ], |
| 192 | "description": "A String", # Required. The description of the job, which typically includes a multi-paragraph |
| 193 | # description of the company and related information. Separate fields are |
| 194 | # provided on the job object for responsibilities, |
| 195 | # qualifications, and other job characteristics. Use of |
| 196 | # these separate job fields is recommended. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 197 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 198 | # This field accepts and sanitizes HTML input, and also accepts |
| 199 | # bold, italic, ordered list, and unordered list markup tags. |
| 200 | # |
| 201 | # The maximum number of allowed characters is 100,000. |
| 202 | "updateTime": "A String", # Output only. The timestamp when this job was last updated. |
| 203 | "promotionValue": 42, # Optional. A promotion value of the job, as determined by the client. |
| 204 | # The value determines the sort order of the jobs returned when searching for |
| 205 | # jobs using the featured jobs search call, with higher promotional values |
| 206 | # being returned first and ties being resolved by relevance sort. Only the |
| 207 | # jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH. |
| 208 | # |
| 209 | # Default value is 0, and negative values are treated as 0. |
| 210 | "qualifications": "A String", # Optional. A description of the qualifications required to perform the |
| 211 | # job. The use of this field is recommended |
| 212 | # as an alternative to using the more general description field. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 213 | # |
| 214 | # This field accepts and sanitizes HTML input, and also accepts |
| 215 | # bold, italic, ordered list, and unordered list markup tags. |
| 216 | # |
| 217 | # The maximum number of allowed characters is 10,000. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 218 | "customAttributes": { # Optional. A map of fields to hold both filterable and non-filterable custom job |
| 219 | # attributes that are not covered by the provided structured fields. |
| 220 | # |
| 221 | # This field is a more general combination of the deprecated id-based |
| 222 | # filterable_custom_fields and string-based |
| 223 | # non_filterable_custom_fields. |
| 224 | # |
| 225 | # The keys of the map are strings up to 64 bytes and must match the |
| 226 | # pattern: a-zA-Z*. |
| 227 | # |
| 228 | # At most 100 filterable and at most 100 unfilterable keys are supported. |
| 229 | # For filterable `string_values`, across all keys at most 200 values are |
| 230 | # allowed, with each string no more than 255 characters. For unfilterable |
| 231 | # `string_values`, the maximum total size of `string_values` across all keys |
| 232 | # is 50KB. |
| 233 | "a_key": { # Custom attribute values that are either filterable or non-filterable. |
| 234 | "longValue": "A String", # Optional but at least one of string_values or long_value must |
| 235 | # be specified. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 236 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 237 | # This field is used to perform number range search. |
| 238 | # (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`. For |
| 239 | # `long_value`, a value between Long.MIN and Long.MAX is allowed. |
| 240 | "filterable": True or False, # Optional. If the `filterable` flag is true, custom field values are searchable. |
| 241 | # If false, values are not searchable. |
| 242 | # |
| 243 | # Default is false. |
| 244 | "stringValues": { # Represents array of string values. # Optional but at least one of string_values or long_value must |
| 245 | # be specified. |
| 246 | # |
| 247 | # This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or |
| 248 | # `CASE_INSENSITIVE_MATCH`) search. |
| 249 | # For filterable `string_values`, a maximum total number of 200 values |
| 250 | # is allowed, with each `string_value` has a byte size of no more than |
| 251 | # 255B. For unfilterable `string_values`, the maximum total byte size of |
| 252 | # unfilterable `string_values` is 50KB. |
| 253 | # |
| 254 | # Empty strings are not allowed. |
| 255 | "values": [ # Required. String values. |
| 256 | "A String", |
| 257 | ], |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 258 | }, |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 259 | }, |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 260 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 261 | "applicationUrls": [ # Optional but at least one of application_urls, |
| 262 | # application_email_list or application_instruction must be |
| 263 | # specified. |
| 264 | # |
| 265 | # Use this URL field to direct an applicant to a website, for example to |
| 266 | # link to an online application form. |
| 267 | # |
| 268 | # The maximum number of allowed characters is 2,000. |
| 269 | "A String", |
| 270 | ], |
| 271 | "requisitionId": "A String", # Required. The requisition ID, also referred to as the posting ID, assigned by the |
| 272 | # client to identify a job. This field is intended to be used by clients |
| 273 | # for client identification and tracking of listings. A job is not allowed |
| 274 | # to be created if there is another job with the same requisition_id, |
| 275 | # company_name and language_code. |
| 276 | # |
| 277 | # The maximum number of allowed characters is 255. |
| 278 | "jobLocations": [ # Output only. Structured locations of the job, resolved from locations. |
| 279 | { # Output only. |
| 280 | # |
| 281 | # A resource that represents a location with full geographic |
| 282 | # information. |
| 283 | "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair. |
| 284 | # of doubles representing degrees latitude and degrees longitude. Unless |
| 285 | # specified otherwise, this must conform to the |
| 286 | # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 |
| 287 | # standard</a>. Values must be within normalized ranges. |
| 288 | "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. |
| 289 | "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. |
| 290 | }, |
| 291 | "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information, |
| 292 | # such as postal delivery and payments addresses. Given a postal address, |
| 293 | # a postal service can deliver items to a premises, P.O. Box, or other |
| 294 | # delivery location. |
| 295 | # Given a postal address, a postal service can deliver items to a premise, P.O. |
| 296 | # Box or similar. |
| 297 | # It is not intended to model geographical locations (roads, towns, |
| 298 | # mountains). |
| 299 | # |
| 300 | # In typical usage an address would be created via user input or from importing |
| 301 | # existing data, depending on the type of process. |
| 302 | # |
| 303 | # Advice on address input / editing: |
| 304 | # - Use an i18n-ready address widget such as |
| 305 | # https://github.com/google/libaddressinput) |
| 306 | # - Users should not be presented with UI elements for input or editing of |
| 307 | # fields outside countries where that field is used. |
| 308 | # |
| 309 | # For more guidance on how to use this schema, please see: |
| 310 | # https://support.google.com/business/answer/6397478 |
| 311 | "sublocality": "A String", # Optional. Sublocality of the address. |
| 312 | # For example, this can be neighborhoods, boroughs, districts. |
| 313 | "recipients": [ # Optional. The recipient at the address. |
| 314 | # This field may, under certain circumstances, contain multiline information. |
| 315 | # For example, it might contain "care of" information. |
| 316 | "A String", |
| 317 | ], |
| 318 | "locality": "A String", # Optional. Generally refers to the city/town portion of the address. |
| 319 | # Examples: US city, IT comune, UK post town. |
| 320 | # In regions of the world where localities are not well defined or do not fit |
| 321 | # into this structure well, leave locality empty and use address_lines. |
| 322 | "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This |
| 323 | # is never inferred and it is up to the user to ensure the value is |
| 324 | # correct. See http://cldr.unicode.org/ and |
| 325 | # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html |
| 326 | # for details. Example: "CH" for Switzerland. |
| 327 | "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if |
| 328 | # known). This is often the UI language of the input form or is expected |
| 329 | # to match one of the languages used in the address' country/region, or their |
| 330 | # transliterated equivalents. |
| 331 | # This can affect formatting in certain countries, but is not critical |
| 332 | # to the correctness of the data and will never affect any validation or |
| 333 | # other non-formatting related operations. |
| 334 | # |
| 335 | # If this value is not known, it should be omitted (rather than specifying a |
| 336 | # possibly incorrect default). |
| 337 | # |
| 338 | # Examples: "zh-Hant", "ja", "ja-Latn", "en". |
| 339 | "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require |
| 340 | # postal codes to be present, but where they are used, they may trigger |
| 341 | # additional validation with other parts of the address (e.g. state/zip |
| 342 | # validation in the U.S.A.). |
| 343 | "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal |
| 344 | # addresses of a country or region. |
| 345 | # For example, this can be a state, a province, an oblast, or a prefecture. |
| 346 | # Specifically, for Spain this is the province and not the autonomous |
| 347 | # community (e.g. "Barcelona" and not "Catalonia"). |
| 348 | # Many countries don't use an administrative area in postal addresses. E.g. |
| 349 | # in Switzerland this should be left unpopulated. |
| 350 | "addressLines": [ # Unstructured address lines describing the lower levels of an address. |
| 351 | # |
| 352 | # Because values in address_lines do not have type information and may |
| 353 | # sometimes contain multiple values in a single field (e.g. |
| 354 | # "Austin, TX"), it is important that the line order is clear. The order of |
| 355 | # address lines should be "envelope order" for the country/region of the |
| 356 | # address. In places where this can vary (e.g. Japan), address_language is |
| 357 | # used to make it explicit (e.g. "ja" for large-to-small ordering and |
| 358 | # "ja-Latn" or "en" for small-to-large). This way, the most specific line of |
| 359 | # an address can be selected based on the language. |
| 360 | # |
| 361 | # The minimum permitted structural representation of an address consists |
| 362 | # of a region_code with all remaining information placed in the |
| 363 | # address_lines. It would be possible to format such an address very |
| 364 | # approximately without geocoding, but no semantic reasoning could be |
| 365 | # made about any of the address components until it was at least |
| 366 | # partially resolved. |
| 367 | # |
| 368 | # Creating an address only containing a region_code and address_lines, and |
| 369 | # then geocoding is the recommended way to handle completely unstructured |
| 370 | # addresses (as opposed to guessing which parts of the address should be |
| 371 | # localities or administrative areas). |
| 372 | "A String", |
| 373 | ], |
| 374 | "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used |
| 375 | # in most regions. Where it is used, the value is either a string like |
| 376 | # "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number |
| 377 | # alone, representing the "sector code" (Jamaica), "delivery area indicator" |
| 378 | # (Malawi) or "post office indicator" (e.g. Côte d'Ivoire). |
| 379 | "organization": "A String", # Optional. The name of the organization at the address. |
| 380 | "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is |
| 381 | # the latest revision. |
| 382 | # |
| 383 | # All new revisions **must** be backward compatible with old revisions. |
| 384 | }, |
| 385 | "locationType": "A String", # The type of a location, which corresponds to the address lines field of |
| 386 | # PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of |
| 387 | # LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of |
| 388 | # LocationType#LOCALITY. |
| 389 | "radiusMeters": 3.14, # Radius in meters of the job location. This value is derived from the |
| 390 | # location bounding box in which a circle with the specified radius |
| 391 | # centered from LatLng coves the area associated with the job location. |
| 392 | # For example, currently, "Mountain View, CA, USA" has a radius of |
| 393 | # 7885.79 meters. |
| 394 | }, |
| 395 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 396 | "expireTime": "A String", # Optional but strongly recommended for the best service |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 397 | # experience. |
| 398 | # |
| 399 | # The expiration timestamp of the job. After this timestamp, the |
| 400 | # job is marked as expired, and it no longer appears in search results. The |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 401 | # expired job can't be deleted or listed by the DeleteJob and |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 402 | # ListJobs APIs, but it can be retrieved with the GetJob API or |
| 403 | # updated with the UpdateJob API. An expired job can be updated and |
| 404 | # opened again by using a future expiration timestamp. Updating an expired |
| 405 | # job fails if there is another existing open job with same |
| 406 | # requisition_id, company_name and language_code. |
| 407 | # |
| 408 | # The expired jobs are retained in our system for 90 days. However, the |
| 409 | # overall expired job count cannot exceed 3 times the maximum of open jobs |
| 410 | # count over the past week, otherwise jobs with earlier expire time are |
| 411 | # cleaned first. Expired jobs are no longer accessible after they are cleaned |
| 412 | # out. |
| 413 | # The format of this field is RFC 3339 date strings. Example: |
| 414 | # 2000-01-01T00:00:00.999999999Z |
| 415 | # See |
| 416 | # [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt). |
| 417 | # |
| 418 | # A valid date range is between 1970-01-01T00:00:00.0Z and |
| 419 | # 2100-12-31T23:59:59.999Z. Invalid dates are ignored and treated as expire |
| 420 | # time not provided. |
| 421 | # |
| 422 | # If this value is not provided at the time of job creation or is invalid, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 423 | # the job posting expires after 30 days from the job's creation time. For |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 424 | # example, if the job was created on 2017/01/01 13:00AM UTC with an |
| 425 | # unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC. |
| 426 | # |
| 427 | # If this value is not provided but expiry_date is, expiry_date is |
| 428 | # used. |
| 429 | # |
| 430 | # If this value is not provided on job update, it depends on the field masks |
| 431 | # set by UpdateJobRequest.update_job_fields. If the field masks include |
| 432 | # expiry_time, or the masks are empty meaning that every field is |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 433 | # updated, the job posting expires after 30 days from the job's last |
| 434 | # update time. Otherwise the expiration date isn't updated. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 435 | "name": "A String", # Required during job update. |
| 436 | # |
| 437 | # Resource name assigned to a job by the API, for example, "/jobs/foo". Use |
| 438 | # of this field in job queries and API calls is preferred over the use of |
| 439 | # requisition_id since this value is unique. |
| 440 | "jobTitle": "A String", # Required. The title of the job, such as "Software Engineer" |
| 441 | # |
| 442 | # The maximum number of allowed characters is 500. |
| 443 | "referenceUrl": "A String", # Output only. The URL of a web page that displays job details. |
| 444 | "responsibilities": "A String", # Optional. A description of job responsibilities. The use of this field is |
| 445 | # recommended as an alternative to using the more general description |
| 446 | # field. |
| 447 | # |
| 448 | # This field accepts and sanitizes HTML input, and also accepts |
| 449 | # bold, italic, ordered list, and unordered list markup tags. |
| 450 | # |
| 451 | # The maximum number of allowed characters is 10,000. |
| 452 | "distributorCompanyId": "A String", # Optional but one of company_name or distributor_company_id must be |
| 453 | # provided. |
| 454 | # |
| 455 | # A unique company identifier used by job distributors to identify an |
| 456 | # employer's company entity. company_name takes precedence over |
| 457 | # this field, and is the recommended field to use to identify companies. |
| 458 | # |
| 459 | # The maximum number of allowed characters is 255. |
| 460 | "publishDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Optional. The date this job was most recently published in UTC format. The default |
| 461 | # value is the time the request arrives at the server. |
| 462 | # and time zone are either specified elsewhere or are not significant. The date |
| 463 | # is relative to the Proleptic Gregorian Calendar. This can represent: |
| 464 | # |
| 465 | # * A full date, with non-zero year, month and day values |
| 466 | # * A month and day value, with a zero year, e.g. an anniversary |
| 467 | # * A year on its own, with zero month and day values |
| 468 | # * A year and month value, with a zero day, e.g. a credit card expiration date |
| 469 | # |
| 470 | # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. |
| 471 | "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| 472 | # a year. |
| 473 | "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| 474 | # if specifying a year by itself or a year and month where the day is not |
| 475 | # significant. |
| 476 | "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| 477 | # month and day. |
| 478 | }, |
| 479 | "applicationInstruction": "A String", # Optional but at least one of application_urls, |
| 480 | # application_email_list or application_instruction must be |
| 481 | # specified. |
| 482 | # |
| 483 | # Use this field to provide instructions, such as "Mail your application |
| 484 | # to ...", that a candidate can follow to apply for the job. |
| 485 | # |
| 486 | # This field accepts and sanitizes HTML input, and also accepts |
| 487 | # bold, italic, ordered list, and unordered list markup tags. |
| 488 | # |
| 489 | # The maximum number of allowed characters is 3,000. |
| 490 | "extendedCompensationInfo": { # Deprecated. Use CompensationInfo. # Deprecated. Always use compensation_info. |
| 491 | # |
| 492 | # Optional. |
| 493 | # |
| 494 | # Job compensation information. |
| 495 | # |
| 496 | # This field replaces compensation_info. Only |
| 497 | # CompensationInfo.entries or extended_compensation_info can be set, |
| 498 | # otherwise an exception is thrown. |
| 499 | # |
| 500 | # Describes job compensation. |
| 501 | "annualizedBaseCompensationRange": { # Deprecated. See CompensationInfo. # Output only. Annualized base compensation range. |
| 502 | # |
| 503 | # Compensation range. |
| 504 | "max": { # Deprecated. See CompensationInfo. # Required. Maximum value. |
| 505 | # |
| 506 | # Decimal number. |
| 507 | "micros": 42, # Micro (10^-6) units. |
| 508 | # The value must be between -999,999 and +999,999 inclusive. |
| 509 | # If `units` is positive, `micros` must be positive or zero. |
| 510 | # If `units` is zero, `micros` can be positive, zero, or negative. |
| 511 | # If `units` is negative, `micros` must be negative or zero. |
| 512 | # For example -1.75 is represented as `units`=-1 and `micros`=-750,000. |
| 513 | "units": "A String", # Whole units. |
| 514 | }, |
| 515 | "min": { # Deprecated. See CompensationInfo. # Required. Minimum value. |
| 516 | # |
| 517 | # Decimal number. |
| 518 | "micros": 42, # Micro (10^-6) units. |
| 519 | # The value must be between -999,999 and +999,999 inclusive. |
| 520 | # If `units` is positive, `micros` must be positive or zero. |
| 521 | # If `units` is zero, `micros` can be positive, zero, or negative. |
| 522 | # If `units` is negative, `micros` must be negative or zero. |
| 523 | # For example -1.75 is represented as `units`=-1 and `micros`=-750,000. |
| 524 | "units": "A String", # Whole units. |
| 525 | }, |
| 526 | }, |
| 527 | "annualizedTotalCompensationUnspecified": True or False, # Output only. Indicates annualized total compensation range cannot be derived, due to |
| 528 | # the job's all CompensationEntry cannot be annualized. |
| 529 | # See CompensationEntry for explanation on annualization and base |
| 530 | # compensation entry. |
| 531 | "currency": "A String", # Optional. A 3-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) |
| 532 | # currency code. |
| 533 | "annualizedBaseCompensationUnspecified": True or False, # Output only. Indicates annualized base compensation range cannot be derived, due to |
| 534 | # the job's base compensation entry cannot be annualized. |
| 535 | # See CompensationEntry for explanation on annualization and base |
| 536 | # compensation entry. |
| 537 | "entries": [ # Optional. Job compensation information. |
| 538 | # |
| 539 | # At most one entry can be of type |
| 540 | # ExtendedCompensationInfo.CompensationType.BASE, which is |
| 541 | # referred as ** base compensation entry ** for the job. |
| 542 | { # Deprecated. See CompensationInfo. |
| 543 | # |
| 544 | # A compensation entry that represents one component of compensation, such |
| 545 | # as base pay, bonus, or other compensation type. |
| 546 | # |
| 547 | # Annualization: One compensation entry can be annualized if |
| 548 | # - it contains valid amount or range. |
| 549 | # - and its expected_units_per_year is set or can be derived. |
| 550 | # Its annualized range is determined as (amount or range) times |
| 551 | # expected_units_per_year. |
| 552 | "range": { # Deprecated. See CompensationInfo. # Optional. Compensation range. |
| 553 | # |
| 554 | # Compensation range. |
| 555 | "max": { # Deprecated. See CompensationInfo. # Required. Maximum value. |
| 556 | # |
| 557 | # Decimal number. |
| 558 | "micros": 42, # Micro (10^-6) units. |
| 559 | # The value must be between -999,999 and +999,999 inclusive. |
| 560 | # If `units` is positive, `micros` must be positive or zero. |
| 561 | # If `units` is zero, `micros` can be positive, zero, or negative. |
| 562 | # If `units` is negative, `micros` must be negative or zero. |
| 563 | # For example -1.75 is represented as `units`=-1 and `micros`=-750,000. |
| 564 | "units": "A String", # Whole units. |
| 565 | }, |
| 566 | "min": { # Deprecated. See CompensationInfo. # Required. Minimum value. |
| 567 | # |
| 568 | # Decimal number. |
| 569 | "micros": 42, # Micro (10^-6) units. |
| 570 | # The value must be between -999,999 and +999,999 inclusive. |
| 571 | # If `units` is positive, `micros` must be positive or zero. |
| 572 | # If `units` is zero, `micros` can be positive, zero, or negative. |
| 573 | # If `units` is negative, `micros` must be negative or zero. |
| 574 | # For example -1.75 is represented as `units`=-1 and `micros`=-750,000. |
| 575 | "units": "A String", # Whole units. |
| 576 | }, |
| 577 | }, |
| 578 | "expectedUnitsPerYear": { # Deprecated. See CompensationInfo. # Optional. Expected number of units paid each year. If not specified, when |
| 579 | # Job.employment_types is FULLTIME, a default value is inferred |
| 580 | # based on unit. Default values: |
| 581 | # - HOURLY: 2080 |
| 582 | # - DAILY: 260 |
| 583 | # - WEEKLY: 52 |
| 584 | # - MONTHLY: 12 |
| 585 | # - ANNUAL: 1 |
| 586 | # |
| 587 | # Decimal number. |
| 588 | "micros": 42, # Micro (10^-6) units. |
| 589 | # The value must be between -999,999 and +999,999 inclusive. |
| 590 | # If `units` is positive, `micros` must be positive or zero. |
| 591 | # If `units` is zero, `micros` can be positive, zero, or negative. |
| 592 | # If `units` is negative, `micros` must be negative or zero. |
| 593 | # For example -1.75 is represented as `units`=-1 and `micros`=-750,000. |
| 594 | "units": "A String", # Whole units. |
| 595 | }, |
| 596 | "amount": { # Deprecated. See CompensationInfo. # Optional. Monetary amount. |
| 597 | # |
| 598 | # Decimal number. |
| 599 | "micros": 42, # Micro (10^-6) units. |
| 600 | # The value must be between -999,999 and +999,999 inclusive. |
| 601 | # If `units` is positive, `micros` must be positive or zero. |
| 602 | # If `units` is zero, `micros` can be positive, zero, or negative. |
| 603 | # If `units` is negative, `micros` must be negative or zero. |
| 604 | # For example -1.75 is represented as `units`=-1 and `micros`=-750,000. |
| 605 | "units": "A String", # Whole units. |
| 606 | }, |
| 607 | "description": "A String", # Optional. Compensation description. |
| 608 | "unspecified": True or False, # Optional. Indicates compensation amount and range are unset. |
| 609 | "unit": "A String", # Optional. Frequency of the specified amount. |
| 610 | # |
| 611 | # Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED. |
| 612 | "type": "A String", # Required. Compensation type. |
| 613 | }, |
| 614 | ], |
| 615 | "annualizedTotalCompensationRange": { # Deprecated. See CompensationInfo. # Output only. Annualized total compensation range. |
| 616 | # |
| 617 | # Compensation range. |
| 618 | "max": { # Deprecated. See CompensationInfo. # Required. Maximum value. |
| 619 | # |
| 620 | # Decimal number. |
| 621 | "micros": 42, # Micro (10^-6) units. |
| 622 | # The value must be between -999,999 and +999,999 inclusive. |
| 623 | # If `units` is positive, `micros` must be positive or zero. |
| 624 | # If `units` is zero, `micros` can be positive, zero, or negative. |
| 625 | # If `units` is negative, `micros` must be negative or zero. |
| 626 | # For example -1.75 is represented as `units`=-1 and `micros`=-750,000. |
| 627 | "units": "A String", # Whole units. |
| 628 | }, |
| 629 | "min": { # Deprecated. See CompensationInfo. # Required. Minimum value. |
| 630 | # |
| 631 | # Decimal number. |
| 632 | "micros": 42, # Micro (10^-6) units. |
| 633 | # The value must be between -999,999 and +999,999 inclusive. |
| 634 | # If `units` is positive, `micros` must be positive or zero. |
| 635 | # If `units` is zero, `micros` can be positive, zero, or negative. |
| 636 | # If `units` is negative, `micros` must be negative or zero. |
| 637 | # For example -1.75 is represented as `units`=-1 and `micros`=-750,000. |
| 638 | "units": "A String", # Whole units. |
| 639 | }, |
| 640 | }, |
| 641 | }, |
| 642 | "startDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Optional. The start date of the job in UTC time zone. Typically this field |
| 643 | # is used for contracting engagements. |
| 644 | # Dates prior to 1970/1/1 and invalid date formats are ignored. |
| 645 | # and time zone are either specified elsewhere or are not significant. The date |
| 646 | # is relative to the Proleptic Gregorian Calendar. This can represent: |
| 647 | # |
| 648 | # * A full date, with non-zero year, month and day values |
| 649 | # * A month and day value, with a zero year, e.g. an anniversary |
| 650 | # * A year on its own, with zero month and day values |
| 651 | # * A year and month value, with a zero day, e.g. a credit card expiration date |
| 652 | # |
| 653 | # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. |
| 654 | "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| 655 | # a year. |
| 656 | "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| 657 | # if specifying a year by itself or a year and month where the day is not |
| 658 | # significant. |
| 659 | "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| 660 | # month and day. |
| 661 | }, |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 662 | "department": "A String", # Optional. The department or functional area within the company with the open |
| 663 | # position. |
| 664 | # |
| 665 | # The maximum number of allowed characters is 255. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 666 | "applicationEmailList": [ # Optional but at least one of application_urls, |
| 667 | # application_email_list or application_instruction must be |
| 668 | # specified. |
| 669 | # |
| 670 | # Use this field to specify email address(es) to which resumes or |
| 671 | # applications can be sent. |
| 672 | # |
| 673 | # The maximum number of allowed characters is 255. |
| 674 | "A String", |
| 675 | ], |
| 676 | "companyTitle": "A String", # Deprecated. Use company_display_name instead. |
| 677 | # |
| 678 | # Output only. |
| 679 | # |
| 680 | # The name of the company listing the job. |
| 681 | "level": "A String", # Optional. The experience level associated with the job, such as "Entry Level". |
| 682 | "filterableCustomFields": { # Deprecated. Use custom_attributes instead. |
| 683 | # |
| 684 | # Optional. |
| 685 | # |
| 686 | # A map of fields to hold filterable custom job attributes not captured by |
| 687 | # the standard fields such as job_title, company_name, or |
| 688 | # level. These custom fields store arbitrary |
| 689 | # string values, and can be used for purposes not covered by |
| 690 | # the structured fields. For the best search experience, use of the |
| 691 | # structured rather than custom fields is recommended. |
| 692 | # |
| 693 | # Data stored in these custom fields fields are indexed and |
| 694 | # searched against by keyword searches (see |
| 695 | # SearchJobsRequest.custom_field_filters][]). |
| 696 | # |
| 697 | # The map key must be a number between 1-20. If an invalid key is |
| 698 | # provided on job create or update, an error is returned. |
| 699 | "a_key": { # Resource that represents the custom data not captured by the standard fields. |
| 700 | "values": [ # Optional. The values of the custom data. |
| 701 | "A String", |
| 702 | ], |
| 703 | }, |
| 704 | }, |
| 705 | "compensationInfo": { # Job compensation details. # Optional. Job compensation information. |
| 706 | "entries": [ # Optional. Job compensation information. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 707 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 708 | # At most one entry can be of type |
| 709 | # CompensationInfo.CompensationType.BASE, which is |
| 710 | # referred as ** base compensation entry ** for the job. |
| 711 | { # A compensation entry that represents one component of compensation, such |
| 712 | # as base pay, bonus, or other compensation type. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 713 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 714 | # Annualization: One compensation entry can be annualized if |
| 715 | # - it contains valid amount or range. |
| 716 | # - and its expected_units_per_year is set or can be derived. |
| 717 | # Its annualized range is determined as (amount or range) times |
| 718 | # expected_units_per_year. |
| 719 | "amount": { # Represents an amount of money with its currency type. # Optional. Compensation amount. |
| 720 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 721 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 722 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 723 | # If `units` is positive, `nanos` must be positive or zero. |
| 724 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 725 | # If `units` is negative, `nanos` must be negative or zero. |
| 726 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 727 | "units": "A String", # The whole units of the amount. |
| 728 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 729 | }, |
| 730 | "description": "A String", # Optional. Compensation description. For example, could |
| 731 | # indicate equity terms or provide additional context to an estimated |
| 732 | # bonus. |
| 733 | "expectedUnitsPerYear": 3.14, # Optional. Expected number of units paid each year. If not specified, when |
| 734 | # Job.employment_types is FULLTIME, a default value is inferred |
| 735 | # based on unit. Default values: |
| 736 | # - HOURLY: 2080 |
| 737 | # - DAILY: 260 |
| 738 | # - WEEKLY: 52 |
| 739 | # - MONTHLY: 12 |
| 740 | # - ANNUAL: 1 |
| 741 | "range": { # Compensation range. # Optional. Compensation range. |
| 742 | "min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set |
| 743 | # to zero and the currency code is set to match the |
| 744 | # currency code of max_compensation. |
| 745 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 746 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 747 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 748 | # If `units` is positive, `nanos` must be positive or zero. |
| 749 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 750 | # If `units` is negative, `nanos` must be negative or zero. |
| 751 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 752 | "units": "A String", # The whole units of the amount. |
| 753 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 754 | }, |
| 755 | "max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set |
| 756 | # to a maximal compensation value and the currency code is set to |
| 757 | # match the currency code of |
| 758 | # min_compensation. |
| 759 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 760 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 761 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 762 | # If `units` is positive, `nanos` must be positive or zero. |
| 763 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 764 | # If `units` is negative, `nanos` must be negative or zero. |
| 765 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 766 | "units": "A String", # The whole units of the amount. |
| 767 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 768 | }, |
| 769 | }, |
| 770 | "type": "A String", # Required. Compensation type. |
| 771 | "unit": "A String", # Optional. Frequency of the specified amount. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 772 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 773 | # Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 774 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 775 | ], |
| 776 | "annualizedBaseCompensationRange": { # Compensation range. # Output only. Annualized base compensation range. Computed as |
| 777 | # base compensation entry's CompensationEntry.compensation times |
| 778 | # CompensationEntry.expected_units_per_year. |
| 779 | # |
| 780 | # See CompensationEntry for explanation on compensation annualization. |
| 781 | "min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set |
| 782 | # to zero and the currency code is set to match the |
| 783 | # currency code of max_compensation. |
| 784 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 785 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 786 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 787 | # If `units` is positive, `nanos` must be positive or zero. |
| 788 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 789 | # If `units` is negative, `nanos` must be negative or zero. |
| 790 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 791 | "units": "A String", # The whole units of the amount. |
| 792 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 793 | }, |
| 794 | "max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set |
| 795 | # to a maximal compensation value and the currency code is set to |
| 796 | # match the currency code of |
| 797 | # min_compensation. |
| 798 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 799 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 800 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 801 | # If `units` is positive, `nanos` must be positive or zero. |
| 802 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 803 | # If `units` is negative, `nanos` must be negative or zero. |
| 804 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 805 | "units": "A String", # The whole units of the amount. |
| 806 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 807 | }, |
| 808 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 809 | "amount": { # Represents an amount of money with its currency type. # Deprecated. Use entries instead. |
| 810 | # |
| 811 | # Optional. |
| 812 | # |
| 813 | # The amount of compensation or pay for the job. |
| 814 | # As an alternative, compensation_amount_min and |
| 815 | # compensation_amount_max may be used to define a range of |
| 816 | # compensation. |
| 817 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 818 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 819 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 820 | # If `units` is positive, `nanos` must be positive or zero. |
| 821 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 822 | # If `units` is negative, `nanos` must be negative or zero. |
| 823 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 824 | "units": "A String", # The whole units of the amount. |
| 825 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 826 | }, |
| 827 | "max": { # Represents an amount of money with its currency type. # Deprecated. Use entries instead. |
| 828 | # |
| 829 | # Optional. |
| 830 | # |
| 831 | # An upper bound on a range for compensation or pay for the job. |
| 832 | # The currency type is specified in compensation_amount. |
| 833 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 834 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 835 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 836 | # If `units` is positive, `nanos` must be positive or zero. |
| 837 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 838 | # If `units` is negative, `nanos` must be negative or zero. |
| 839 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 840 | "units": "A String", # The whole units of the amount. |
| 841 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 842 | }, |
| 843 | "type": "A String", # Deprecated. Use entries instead. |
| 844 | # |
| 845 | # Optional. |
| 846 | # |
| 847 | # Type of job compensation. |
| 848 | "min": { # Represents an amount of money with its currency type. # Deprecated. Use entries instead. |
| 849 | # |
| 850 | # Optional. |
| 851 | # |
| 852 | # A lower bound on a range for compensation or pay for the job. |
| 853 | # The currency type is specified in compensation_amount. |
| 854 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 855 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 856 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 857 | # If `units` is positive, `nanos` must be positive or zero. |
| 858 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 859 | # If `units` is negative, `nanos` must be negative or zero. |
| 860 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 861 | "units": "A String", # The whole units of the amount. |
| 862 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 863 | }, |
| 864 | "annualizedTotalCompensationRange": { # Compensation range. # Output only. Annualized total compensation range. Computed as |
| 865 | # all compensation entries' CompensationEntry.compensation times |
| 866 | # CompensationEntry.expected_units_per_year. |
| 867 | # |
| 868 | # See CompensationEntry for explanation on compensation annualization. |
| 869 | "min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set |
| 870 | # to zero and the currency code is set to match the |
| 871 | # currency code of max_compensation. |
| 872 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 873 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 874 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 875 | # If `units` is positive, `nanos` must be positive or zero. |
| 876 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 877 | # If `units` is negative, `nanos` must be negative or zero. |
| 878 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 879 | "units": "A String", # The whole units of the amount. |
| 880 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 881 | }, |
| 882 | "max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set |
| 883 | # to a maximal compensation value and the currency code is set to |
| 884 | # match the currency code of |
| 885 | # min_compensation. |
| 886 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 887 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 888 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 889 | # If `units` is positive, `nanos` must be positive or zero. |
| 890 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 891 | # If `units` is negative, `nanos` must be negative or zero. |
| 892 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 893 | "units": "A String", # The whole units of the amount. |
| 894 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 895 | }, |
| 896 | }, |
| 897 | }, |
| 898 | "region": "A String", # Optional. The job Region (for example, state, country) throughout which the job |
| 899 | # is available. If this field is set, a |
| 900 | # LocationFilter in a search query within the job region |
| 901 | # finds this job if an exact location match is not specified. |
| 902 | # If this field is set, setting job locations |
| 903 | # to the same location level as this field is strongly recommended. |
| 904 | "createTime": "A String", # Output only. The timestamp when this job was created. |
| 905 | "incentives": "A String", # Optional. A description of bonus, commission, and other compensation |
| 906 | # incentives associated with the job not including salary or pay. |
| 907 | # |
| 908 | # The maximum number of allowed characters is 10,000. |
| 909 | "companyDisplayName": "A String", # Output only. The name of the company listing the job. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 910 | "unindexedCustomFields": { # Deprecated. Use custom_attributes instead. |
| 911 | # |
| 912 | # Optional. |
| 913 | # |
| 914 | # A map of fields to hold non-filterable custom job attributes, similar to |
| 915 | # filterable_custom_fields. These fields are distinct in that the data |
| 916 | # in these fields are not indexed. Therefore, the client cannot search |
| 917 | # against them, nor can the client use them to list jobs. |
| 918 | # |
| 919 | # The key of the map can be any valid string. |
| 920 | "a_key": { # Resource that represents the custom data not captured by the standard fields. |
| 921 | "values": [ # Optional. The values of the custom data. |
| 922 | "A String", |
| 923 | ], |
| 924 | }, |
| 925 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 926 | "visibility": "A String", # Optional. The visibility of the job. |
| 927 | # Defaults to JobVisibility.PRIVATE if not specified. |
| 928 | # Currently only JobVisibility.PRIVATE is supported. |
| 929 | "employmentTypes": [ # Optional. The employment type(s) of a job, for example, |
| 930 | # full time or |
| 931 | # part time. |
| 932 | "A String", |
| 933 | ], |
| 934 | "benefits": [ # Optional. The benefits included with the job. |
| 935 | "A String", |
| 936 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 937 | "expiryDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Deprecated. Use expire_time instead. |
| 938 | # |
| 939 | # Optional but strongly recommended to be provided for the best service |
| 940 | # experience. |
| 941 | # |
| 942 | # The expiration date of the job in UTC time. After 12 am on this date, the |
| 943 | # job is marked as expired, and it no longer appears in search results. |
| 944 | # The expired job can't be deleted or listed by the DeleteJob and |
| 945 | # ListJobs APIs, but it can be retrieved with the GetJob API or |
| 946 | # updated with the UpdateJob API. An expired job can be updated and |
| 947 | # opened again by using a future expiration date. It can also remain expired. |
| 948 | # Updating an expired job to be open fails if there is another existing open |
| 949 | # job with same requisition_id, company_name and language_code. |
| 950 | # |
| 951 | # The expired jobs are retained in our system for 90 days. However, the |
| 952 | # overall expired job count cannot exceed 3 times the maximum of open jobs |
| 953 | # count over the past week, otherwise jobs with earlier expire time are |
| 954 | # removed first. Expired jobs are no longer accessible after they are cleaned |
| 955 | # out. |
| 956 | # |
| 957 | # A valid date range is between 1970/1/1 and 2100/12/31. Invalid dates are |
| 958 | # ignored and treated as expiry date not provided. |
| 959 | # |
| 960 | # If this value is not provided on job creation or is invalid, the job |
| 961 | # posting expires after 30 days from the job's creation time. For example, if |
| 962 | # the job was created on 2017/01/01 13:00AM UTC with an unspecified |
| 963 | # expiration date, the job expires after 2017/01/31 13:00AM UTC. |
| 964 | # |
| 965 | # If this value is not provided on job update, it depends on the field masks |
| 966 | # set by UpdateJobRequest.update_job_fields. If the field masks include |
| 967 | # expiry_date, or the masks are empty meaning that every field is |
| 968 | # updated, the job expires after 30 days from the job's last update time. |
| 969 | # Otherwise the expiration date isn't updated. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 970 | # and time zone are either specified elsewhere or are not significant. The date |
| 971 | # is relative to the Proleptic Gregorian Calendar. This can represent: |
| 972 | # |
| 973 | # * A full date, with non-zero year, month and day values |
| 974 | # * A month and day value, with a zero year, e.g. an anniversary |
| 975 | # * A year on its own, with zero month and day values |
| 976 | # * A year and month value, with a zero day, e.g. a credit card expiration date |
| 977 | # |
| 978 | # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 979 | "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| 980 | # a year. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 981 | "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 982 | # if specifying a year by itself or a year and month where the day is not |
| 983 | # significant. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 984 | "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| 985 | # month and day. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 986 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 987 | "companyName": "A String", # Optional but one of company_name or distributor_company_id must be |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 988 | # provided. |
| 989 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 990 | # The resource name of the company listing the job, such as |
| 991 | # /companies/foo. This field takes precedence over the |
| 992 | # distributor-assigned company identifier, distributor_company_id. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 993 | "locations": [ # Optional but strongly recommended for the best service experience. |
| 994 | # |
| 995 | # Location(s) where the emploeyer is looking to hire for this job posting. |
| 996 | # |
| 997 | # Specifying the full street address(es) of the hiring location enables |
| 998 | # better API results, especially job searches by commute time. |
| 999 | # |
| 1000 | # At most 50 locations are allowed for best search performance. If a job has |
| 1001 | # more locations, it is suggested to split it into multiple jobs with unique |
| 1002 | # requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as |
| 1003 | # multiple jobs with the same requisition_id, company_name and |
| 1004 | # language_code are not allowed. If the original requisition_id must |
| 1005 | # be preserved, a custom field should be used for storage. It is also |
| 1006 | # suggested to group the locations that close to each other in the same job |
| 1007 | # for better search experience. |
| 1008 | # |
| 1009 | # The maximum number of allowed characters is 500. |
| 1010 | "A String", |
| 1011 | ], |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1012 | "endDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Optional. The end date of the job in UTC time zone. Typically this field |
| 1013 | # is used for contracting engagements. |
| 1014 | # Dates prior to 1970/1/1 and invalid date formats are ignored. |
| 1015 | # and time zone are either specified elsewhere or are not significant. The date |
| 1016 | # is relative to the Proleptic Gregorian Calendar. This can represent: |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1017 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1018 | # * A full date, with non-zero year, month and day values |
| 1019 | # * A month and day value, with a zero year, e.g. an anniversary |
| 1020 | # * A year on its own, with zero month and day values |
| 1021 | # * A year and month value, with a zero day, e.g. a credit card expiration date |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1022 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1023 | # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. |
| 1024 | "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| 1025 | # a year. |
| 1026 | "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| 1027 | # if specifying a year by itself or a year and month where the day is not |
| 1028 | # significant. |
| 1029 | "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| 1030 | # month and day. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1031 | }, |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1032 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1033 | "disableStreetAddressResolution": True or False, # Deprecated. Please use processing_options. This flag is ignored if |
| 1034 | # processing_options is set. |
| 1035 | # |
| 1036 | # Optional. |
| 1037 | # |
| 1038 | # If set to `true`, the service does not attempt to resolve a |
| 1039 | # more precise address for the job. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1040 | "processingOptions": { # Input only. # Optional. Options for job processing. |
| 1041 | # |
| 1042 | # Options for job processing. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1043 | "disableStreetAddressResolution": True or False, # Optional. If set to `true`, the service does not attempt to resolve a |
| 1044 | # more precise address for the job. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1045 | "htmlSanitization": "A String", # Optional. Option for job HTML content sanitization. Applied fields are: |
| 1046 | # |
| 1047 | # * description |
| 1048 | # * applicationInstruction |
| 1049 | # * incentives |
| 1050 | # * qualifications |
| 1051 | # * responsibilities |
| 1052 | # |
| 1053 | # HTML tags in these fields may be stripped if sanitiazation is not disabled. |
| 1054 | # |
| 1055 | # Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1056 | }, |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1057 | } |
| 1058 | |
| 1059 | x__xgafv: string, V1 error format. |
| 1060 | Allowed values |
| 1061 | 1 - v1 error format |
| 1062 | 2 - v2 error format |
| 1063 | |
| 1064 | Returns: |
| 1065 | An object of the form: |
| 1066 | |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1067 | { # A Job resource represents a job posting (also referred to as a "job listing" |
| 1068 | # 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] | 1069 | # entity responsible for the job. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1070 | "languageCode": "A String", # Optional. The language of the posting. This field is distinct from |
| 1071 | # any requirements for fluency that are associated with the job. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1072 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1073 | # Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn". |
| 1074 | # For more information, see |
| 1075 | # [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){: |
| 1076 | # class="external" target="_blank" }. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1077 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1078 | # If this field is unspecified and Job.description is present, detected |
| 1079 | # language code based on Job.description is assigned, otherwise |
| 1080 | # defaults to 'en_US'. |
| 1081 | "educationLevels": [ # Optional. The desired education level for the job, such as |
| 1082 | # "Bachelors", "Masters", "Doctorate". |
| 1083 | "A String", |
| 1084 | ], |
| 1085 | "description": "A String", # Required. The description of the job, which typically includes a multi-paragraph |
| 1086 | # description of the company and related information. Separate fields are |
| 1087 | # provided on the job object for responsibilities, |
| 1088 | # qualifications, and other job characteristics. Use of |
| 1089 | # these separate job fields is recommended. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1090 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1091 | # This field accepts and sanitizes HTML input, and also accepts |
| 1092 | # bold, italic, ordered list, and unordered list markup tags. |
| 1093 | # |
| 1094 | # The maximum number of allowed characters is 100,000. |
| 1095 | "updateTime": "A String", # Output only. The timestamp when this job was last updated. |
| 1096 | "promotionValue": 42, # Optional. A promotion value of the job, as determined by the client. |
| 1097 | # The value determines the sort order of the jobs returned when searching for |
| 1098 | # jobs using the featured jobs search call, with higher promotional values |
| 1099 | # being returned first and ties being resolved by relevance sort. Only the |
| 1100 | # jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH. |
| 1101 | # |
| 1102 | # Default value is 0, and negative values are treated as 0. |
| 1103 | "qualifications": "A String", # Optional. A description of the qualifications required to perform the |
| 1104 | # job. The use of this field is recommended |
| 1105 | # as an alternative to using the more general description field. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1106 | # |
| 1107 | # This field accepts and sanitizes HTML input, and also accepts |
| 1108 | # bold, italic, ordered list, and unordered list markup tags. |
| 1109 | # |
| 1110 | # The maximum number of allowed characters is 10,000. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1111 | "customAttributes": { # Optional. A map of fields to hold both filterable and non-filterable custom job |
| 1112 | # attributes that are not covered by the provided structured fields. |
| 1113 | # |
| 1114 | # This field is a more general combination of the deprecated id-based |
| 1115 | # filterable_custom_fields and string-based |
| 1116 | # non_filterable_custom_fields. |
| 1117 | # |
| 1118 | # The keys of the map are strings up to 64 bytes and must match the |
| 1119 | # pattern: a-zA-Z*. |
| 1120 | # |
| 1121 | # At most 100 filterable and at most 100 unfilterable keys are supported. |
| 1122 | # For filterable `string_values`, across all keys at most 200 values are |
| 1123 | # allowed, with each string no more than 255 characters. For unfilterable |
| 1124 | # `string_values`, the maximum total size of `string_values` across all keys |
| 1125 | # is 50KB. |
| 1126 | "a_key": { # Custom attribute values that are either filterable or non-filterable. |
| 1127 | "longValue": "A String", # Optional but at least one of string_values or long_value must |
| 1128 | # be specified. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1129 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1130 | # This field is used to perform number range search. |
| 1131 | # (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`. For |
| 1132 | # `long_value`, a value between Long.MIN and Long.MAX is allowed. |
| 1133 | "filterable": True or False, # Optional. If the `filterable` flag is true, custom field values are searchable. |
| 1134 | # If false, values are not searchable. |
| 1135 | # |
| 1136 | # Default is false. |
| 1137 | "stringValues": { # Represents array of string values. # Optional but at least one of string_values or long_value must |
| 1138 | # be specified. |
| 1139 | # |
| 1140 | # This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or |
| 1141 | # `CASE_INSENSITIVE_MATCH`) search. |
| 1142 | # For filterable `string_values`, a maximum total number of 200 values |
| 1143 | # is allowed, with each `string_value` has a byte size of no more than |
| 1144 | # 255B. For unfilterable `string_values`, the maximum total byte size of |
| 1145 | # unfilterable `string_values` is 50KB. |
| 1146 | # |
| 1147 | # Empty strings are not allowed. |
| 1148 | "values": [ # Required. String values. |
| 1149 | "A String", |
| 1150 | ], |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1151 | }, |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1152 | }, |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1153 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1154 | "applicationUrls": [ # Optional but at least one of application_urls, |
| 1155 | # application_email_list or application_instruction must be |
| 1156 | # specified. |
| 1157 | # |
| 1158 | # Use this URL field to direct an applicant to a website, for example to |
| 1159 | # link to an online application form. |
| 1160 | # |
| 1161 | # The maximum number of allowed characters is 2,000. |
| 1162 | "A String", |
| 1163 | ], |
| 1164 | "requisitionId": "A String", # Required. The requisition ID, also referred to as the posting ID, assigned by the |
| 1165 | # client to identify a job. This field is intended to be used by clients |
| 1166 | # for client identification and tracking of listings. A job is not allowed |
| 1167 | # to be created if there is another job with the same requisition_id, |
| 1168 | # company_name and language_code. |
| 1169 | # |
| 1170 | # The maximum number of allowed characters is 255. |
| 1171 | "jobLocations": [ # Output only. Structured locations of the job, resolved from locations. |
| 1172 | { # Output only. |
| 1173 | # |
| 1174 | # A resource that represents a location with full geographic |
| 1175 | # information. |
| 1176 | "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair. |
| 1177 | # of doubles representing degrees latitude and degrees longitude. Unless |
| 1178 | # specified otherwise, this must conform to the |
| 1179 | # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 |
| 1180 | # standard</a>. Values must be within normalized ranges. |
| 1181 | "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. |
| 1182 | "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. |
| 1183 | }, |
| 1184 | "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information, |
| 1185 | # such as postal delivery and payments addresses. Given a postal address, |
| 1186 | # a postal service can deliver items to a premises, P.O. Box, or other |
| 1187 | # delivery location. |
| 1188 | # Given a postal address, a postal service can deliver items to a premise, P.O. |
| 1189 | # Box or similar. |
| 1190 | # It is not intended to model geographical locations (roads, towns, |
| 1191 | # mountains). |
| 1192 | # |
| 1193 | # In typical usage an address would be created via user input or from importing |
| 1194 | # existing data, depending on the type of process. |
| 1195 | # |
| 1196 | # Advice on address input / editing: |
| 1197 | # - Use an i18n-ready address widget such as |
| 1198 | # https://github.com/google/libaddressinput) |
| 1199 | # - Users should not be presented with UI elements for input or editing of |
| 1200 | # fields outside countries where that field is used. |
| 1201 | # |
| 1202 | # For more guidance on how to use this schema, please see: |
| 1203 | # https://support.google.com/business/answer/6397478 |
| 1204 | "sublocality": "A String", # Optional. Sublocality of the address. |
| 1205 | # For example, this can be neighborhoods, boroughs, districts. |
| 1206 | "recipients": [ # Optional. The recipient at the address. |
| 1207 | # This field may, under certain circumstances, contain multiline information. |
| 1208 | # For example, it might contain "care of" information. |
| 1209 | "A String", |
| 1210 | ], |
| 1211 | "locality": "A String", # Optional. Generally refers to the city/town portion of the address. |
| 1212 | # Examples: US city, IT comune, UK post town. |
| 1213 | # In regions of the world where localities are not well defined or do not fit |
| 1214 | # into this structure well, leave locality empty and use address_lines. |
| 1215 | "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This |
| 1216 | # is never inferred and it is up to the user to ensure the value is |
| 1217 | # correct. See http://cldr.unicode.org/ and |
| 1218 | # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html |
| 1219 | # for details. Example: "CH" for Switzerland. |
| 1220 | "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if |
| 1221 | # known). This is often the UI language of the input form or is expected |
| 1222 | # to match one of the languages used in the address' country/region, or their |
| 1223 | # transliterated equivalents. |
| 1224 | # This can affect formatting in certain countries, but is not critical |
| 1225 | # to the correctness of the data and will never affect any validation or |
| 1226 | # other non-formatting related operations. |
| 1227 | # |
| 1228 | # If this value is not known, it should be omitted (rather than specifying a |
| 1229 | # possibly incorrect default). |
| 1230 | # |
| 1231 | # Examples: "zh-Hant", "ja", "ja-Latn", "en". |
| 1232 | "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require |
| 1233 | # postal codes to be present, but where they are used, they may trigger |
| 1234 | # additional validation with other parts of the address (e.g. state/zip |
| 1235 | # validation in the U.S.A.). |
| 1236 | "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal |
| 1237 | # addresses of a country or region. |
| 1238 | # For example, this can be a state, a province, an oblast, or a prefecture. |
| 1239 | # Specifically, for Spain this is the province and not the autonomous |
| 1240 | # community (e.g. "Barcelona" and not "Catalonia"). |
| 1241 | # Many countries don't use an administrative area in postal addresses. E.g. |
| 1242 | # in Switzerland this should be left unpopulated. |
| 1243 | "addressLines": [ # Unstructured address lines describing the lower levels of an address. |
| 1244 | # |
| 1245 | # Because values in address_lines do not have type information and may |
| 1246 | # sometimes contain multiple values in a single field (e.g. |
| 1247 | # "Austin, TX"), it is important that the line order is clear. The order of |
| 1248 | # address lines should be "envelope order" for the country/region of the |
| 1249 | # address. In places where this can vary (e.g. Japan), address_language is |
| 1250 | # used to make it explicit (e.g. "ja" for large-to-small ordering and |
| 1251 | # "ja-Latn" or "en" for small-to-large). This way, the most specific line of |
| 1252 | # an address can be selected based on the language. |
| 1253 | # |
| 1254 | # The minimum permitted structural representation of an address consists |
| 1255 | # of a region_code with all remaining information placed in the |
| 1256 | # address_lines. It would be possible to format such an address very |
| 1257 | # approximately without geocoding, but no semantic reasoning could be |
| 1258 | # made about any of the address components until it was at least |
| 1259 | # partially resolved. |
| 1260 | # |
| 1261 | # Creating an address only containing a region_code and address_lines, and |
| 1262 | # then geocoding is the recommended way to handle completely unstructured |
| 1263 | # addresses (as opposed to guessing which parts of the address should be |
| 1264 | # localities or administrative areas). |
| 1265 | "A String", |
| 1266 | ], |
| 1267 | "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used |
| 1268 | # in most regions. Where it is used, the value is either a string like |
| 1269 | # "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number |
| 1270 | # alone, representing the "sector code" (Jamaica), "delivery area indicator" |
| 1271 | # (Malawi) or "post office indicator" (e.g. Côte d'Ivoire). |
| 1272 | "organization": "A String", # Optional. The name of the organization at the address. |
| 1273 | "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is |
| 1274 | # the latest revision. |
| 1275 | # |
| 1276 | # All new revisions **must** be backward compatible with old revisions. |
| 1277 | }, |
| 1278 | "locationType": "A String", # The type of a location, which corresponds to the address lines field of |
| 1279 | # PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of |
| 1280 | # LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of |
| 1281 | # LocationType#LOCALITY. |
| 1282 | "radiusMeters": 3.14, # Radius in meters of the job location. This value is derived from the |
| 1283 | # location bounding box in which a circle with the specified radius |
| 1284 | # centered from LatLng coves the area associated with the job location. |
| 1285 | # For example, currently, "Mountain View, CA, USA" has a radius of |
| 1286 | # 7885.79 meters. |
| 1287 | }, |
| 1288 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1289 | "expireTime": "A String", # Optional but strongly recommended for the best service |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1290 | # experience. |
| 1291 | # |
| 1292 | # The expiration timestamp of the job. After this timestamp, the |
| 1293 | # job is marked as expired, and it no longer appears in search results. The |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1294 | # expired job can't be deleted or listed by the DeleteJob and |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1295 | # ListJobs APIs, but it can be retrieved with the GetJob API or |
| 1296 | # updated with the UpdateJob API. An expired job can be updated and |
| 1297 | # opened again by using a future expiration timestamp. Updating an expired |
| 1298 | # job fails if there is another existing open job with same |
| 1299 | # requisition_id, company_name and language_code. |
| 1300 | # |
| 1301 | # The expired jobs are retained in our system for 90 days. However, the |
| 1302 | # overall expired job count cannot exceed 3 times the maximum of open jobs |
| 1303 | # count over the past week, otherwise jobs with earlier expire time are |
| 1304 | # cleaned first. Expired jobs are no longer accessible after they are cleaned |
| 1305 | # out. |
| 1306 | # The format of this field is RFC 3339 date strings. Example: |
| 1307 | # 2000-01-01T00:00:00.999999999Z |
| 1308 | # See |
| 1309 | # [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt). |
| 1310 | # |
| 1311 | # A valid date range is between 1970-01-01T00:00:00.0Z and |
| 1312 | # 2100-12-31T23:59:59.999Z. Invalid dates are ignored and treated as expire |
| 1313 | # time not provided. |
| 1314 | # |
| 1315 | # If this value is not provided at the time of job creation or is invalid, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1316 | # the job posting expires after 30 days from the job's creation time. For |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1317 | # example, if the job was created on 2017/01/01 13:00AM UTC with an |
| 1318 | # unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC. |
| 1319 | # |
| 1320 | # If this value is not provided but expiry_date is, expiry_date is |
| 1321 | # used. |
| 1322 | # |
| 1323 | # If this value is not provided on job update, it depends on the field masks |
| 1324 | # set by UpdateJobRequest.update_job_fields. If the field masks include |
| 1325 | # expiry_time, or the masks are empty meaning that every field is |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1326 | # updated, the job posting expires after 30 days from the job's last |
| 1327 | # update time. Otherwise the expiration date isn't updated. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1328 | "name": "A String", # Required during job update. |
| 1329 | # |
| 1330 | # Resource name assigned to a job by the API, for example, "/jobs/foo". Use |
| 1331 | # of this field in job queries and API calls is preferred over the use of |
| 1332 | # requisition_id since this value is unique. |
| 1333 | "jobTitle": "A String", # Required. The title of the job, such as "Software Engineer" |
| 1334 | # |
| 1335 | # The maximum number of allowed characters is 500. |
| 1336 | "referenceUrl": "A String", # Output only. The URL of a web page that displays job details. |
| 1337 | "responsibilities": "A String", # Optional. A description of job responsibilities. The use of this field is |
| 1338 | # recommended as an alternative to using the more general description |
| 1339 | # field. |
| 1340 | # |
| 1341 | # This field accepts and sanitizes HTML input, and also accepts |
| 1342 | # bold, italic, ordered list, and unordered list markup tags. |
| 1343 | # |
| 1344 | # The maximum number of allowed characters is 10,000. |
| 1345 | "distributorCompanyId": "A String", # Optional but one of company_name or distributor_company_id must be |
| 1346 | # provided. |
| 1347 | # |
| 1348 | # A unique company identifier used by job distributors to identify an |
| 1349 | # employer's company entity. company_name takes precedence over |
| 1350 | # this field, and is the recommended field to use to identify companies. |
| 1351 | # |
| 1352 | # The maximum number of allowed characters is 255. |
| 1353 | "publishDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Optional. The date this job was most recently published in UTC format. The default |
| 1354 | # value is the time the request arrives at the server. |
| 1355 | # and time zone are either specified elsewhere or are not significant. The date |
| 1356 | # is relative to the Proleptic Gregorian Calendar. This can represent: |
| 1357 | # |
| 1358 | # * A full date, with non-zero year, month and day values |
| 1359 | # * A month and day value, with a zero year, e.g. an anniversary |
| 1360 | # * A year on its own, with zero month and day values |
| 1361 | # * A year and month value, with a zero day, e.g. a credit card expiration date |
| 1362 | # |
| 1363 | # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. |
| 1364 | "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| 1365 | # a year. |
| 1366 | "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| 1367 | # if specifying a year by itself or a year and month where the day is not |
| 1368 | # significant. |
| 1369 | "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| 1370 | # month and day. |
| 1371 | }, |
| 1372 | "applicationInstruction": "A String", # Optional but at least one of application_urls, |
| 1373 | # application_email_list or application_instruction must be |
| 1374 | # specified. |
| 1375 | # |
| 1376 | # Use this field to provide instructions, such as "Mail your application |
| 1377 | # to ...", that a candidate can follow to apply for the job. |
| 1378 | # |
| 1379 | # This field accepts and sanitizes HTML input, and also accepts |
| 1380 | # bold, italic, ordered list, and unordered list markup tags. |
| 1381 | # |
| 1382 | # The maximum number of allowed characters is 3,000. |
| 1383 | "extendedCompensationInfo": { # Deprecated. Use CompensationInfo. # Deprecated. Always use compensation_info. |
| 1384 | # |
| 1385 | # Optional. |
| 1386 | # |
| 1387 | # Job compensation information. |
| 1388 | # |
| 1389 | # This field replaces compensation_info. Only |
| 1390 | # CompensationInfo.entries or extended_compensation_info can be set, |
| 1391 | # otherwise an exception is thrown. |
| 1392 | # |
| 1393 | # Describes job compensation. |
| 1394 | "annualizedBaseCompensationRange": { # Deprecated. See CompensationInfo. # Output only. Annualized base compensation range. |
| 1395 | # |
| 1396 | # Compensation range. |
| 1397 | "max": { # Deprecated. See CompensationInfo. # Required. Maximum value. |
| 1398 | # |
| 1399 | # Decimal number. |
| 1400 | "micros": 42, # Micro (10^-6) units. |
| 1401 | # The value must be between -999,999 and +999,999 inclusive. |
| 1402 | # If `units` is positive, `micros` must be positive or zero. |
| 1403 | # If `units` is zero, `micros` can be positive, zero, or negative. |
| 1404 | # If `units` is negative, `micros` must be negative or zero. |
| 1405 | # For example -1.75 is represented as `units`=-1 and `micros`=-750,000. |
| 1406 | "units": "A String", # Whole units. |
| 1407 | }, |
| 1408 | "min": { # Deprecated. See CompensationInfo. # Required. Minimum value. |
| 1409 | # |
| 1410 | # Decimal number. |
| 1411 | "micros": 42, # Micro (10^-6) units. |
| 1412 | # The value must be between -999,999 and +999,999 inclusive. |
| 1413 | # If `units` is positive, `micros` must be positive or zero. |
| 1414 | # If `units` is zero, `micros` can be positive, zero, or negative. |
| 1415 | # If `units` is negative, `micros` must be negative or zero. |
| 1416 | # For example -1.75 is represented as `units`=-1 and `micros`=-750,000. |
| 1417 | "units": "A String", # Whole units. |
| 1418 | }, |
| 1419 | }, |
| 1420 | "annualizedTotalCompensationUnspecified": True or False, # Output only. Indicates annualized total compensation range cannot be derived, due to |
| 1421 | # the job's all CompensationEntry cannot be annualized. |
| 1422 | # See CompensationEntry for explanation on annualization and base |
| 1423 | # compensation entry. |
| 1424 | "currency": "A String", # Optional. A 3-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) |
| 1425 | # currency code. |
| 1426 | "annualizedBaseCompensationUnspecified": True or False, # Output only. Indicates annualized base compensation range cannot be derived, due to |
| 1427 | # the job's base compensation entry cannot be annualized. |
| 1428 | # See CompensationEntry for explanation on annualization and base |
| 1429 | # compensation entry. |
| 1430 | "entries": [ # Optional. Job compensation information. |
| 1431 | # |
| 1432 | # At most one entry can be of type |
| 1433 | # ExtendedCompensationInfo.CompensationType.BASE, which is |
| 1434 | # referred as ** base compensation entry ** for the job. |
| 1435 | { # Deprecated. See CompensationInfo. |
| 1436 | # |
| 1437 | # A compensation entry that represents one component of compensation, such |
| 1438 | # as base pay, bonus, or other compensation type. |
| 1439 | # |
| 1440 | # Annualization: One compensation entry can be annualized if |
| 1441 | # - it contains valid amount or range. |
| 1442 | # - and its expected_units_per_year is set or can be derived. |
| 1443 | # Its annualized range is determined as (amount or range) times |
| 1444 | # expected_units_per_year. |
| 1445 | "range": { # Deprecated. See CompensationInfo. # Optional. Compensation range. |
| 1446 | # |
| 1447 | # Compensation range. |
| 1448 | "max": { # Deprecated. See CompensationInfo. # Required. Maximum value. |
| 1449 | # |
| 1450 | # Decimal number. |
| 1451 | "micros": 42, # Micro (10^-6) units. |
| 1452 | # The value must be between -999,999 and +999,999 inclusive. |
| 1453 | # If `units` is positive, `micros` must be positive or zero. |
| 1454 | # If `units` is zero, `micros` can be positive, zero, or negative. |
| 1455 | # If `units` is negative, `micros` must be negative or zero. |
| 1456 | # For example -1.75 is represented as `units`=-1 and `micros`=-750,000. |
| 1457 | "units": "A String", # Whole units. |
| 1458 | }, |
| 1459 | "min": { # Deprecated. See CompensationInfo. # Required. Minimum value. |
| 1460 | # |
| 1461 | # Decimal number. |
| 1462 | "micros": 42, # Micro (10^-6) units. |
| 1463 | # The value must be between -999,999 and +999,999 inclusive. |
| 1464 | # If `units` is positive, `micros` must be positive or zero. |
| 1465 | # If `units` is zero, `micros` can be positive, zero, or negative. |
| 1466 | # If `units` is negative, `micros` must be negative or zero. |
| 1467 | # For example -1.75 is represented as `units`=-1 and `micros`=-750,000. |
| 1468 | "units": "A String", # Whole units. |
| 1469 | }, |
| 1470 | }, |
| 1471 | "expectedUnitsPerYear": { # Deprecated. See CompensationInfo. # Optional. Expected number of units paid each year. If not specified, when |
| 1472 | # Job.employment_types is FULLTIME, a default value is inferred |
| 1473 | # based on unit. Default values: |
| 1474 | # - HOURLY: 2080 |
| 1475 | # - DAILY: 260 |
| 1476 | # - WEEKLY: 52 |
| 1477 | # - MONTHLY: 12 |
| 1478 | # - ANNUAL: 1 |
| 1479 | # |
| 1480 | # Decimal number. |
| 1481 | "micros": 42, # Micro (10^-6) units. |
| 1482 | # The value must be between -999,999 and +999,999 inclusive. |
| 1483 | # If `units` is positive, `micros` must be positive or zero. |
| 1484 | # If `units` is zero, `micros` can be positive, zero, or negative. |
| 1485 | # If `units` is negative, `micros` must be negative or zero. |
| 1486 | # For example -1.75 is represented as `units`=-1 and `micros`=-750,000. |
| 1487 | "units": "A String", # Whole units. |
| 1488 | }, |
| 1489 | "amount": { # Deprecated. See CompensationInfo. # Optional. Monetary amount. |
| 1490 | # |
| 1491 | # Decimal number. |
| 1492 | "micros": 42, # Micro (10^-6) units. |
| 1493 | # The value must be between -999,999 and +999,999 inclusive. |
| 1494 | # If `units` is positive, `micros` must be positive or zero. |
| 1495 | # If `units` is zero, `micros` can be positive, zero, or negative. |
| 1496 | # If `units` is negative, `micros` must be negative or zero. |
| 1497 | # For example -1.75 is represented as `units`=-1 and `micros`=-750,000. |
| 1498 | "units": "A String", # Whole units. |
| 1499 | }, |
| 1500 | "description": "A String", # Optional. Compensation description. |
| 1501 | "unspecified": True or False, # Optional. Indicates compensation amount and range are unset. |
| 1502 | "unit": "A String", # Optional. Frequency of the specified amount. |
| 1503 | # |
| 1504 | # Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED. |
| 1505 | "type": "A String", # Required. Compensation type. |
| 1506 | }, |
| 1507 | ], |
| 1508 | "annualizedTotalCompensationRange": { # Deprecated. See CompensationInfo. # Output only. Annualized total compensation range. |
| 1509 | # |
| 1510 | # Compensation range. |
| 1511 | "max": { # Deprecated. See CompensationInfo. # Required. Maximum value. |
| 1512 | # |
| 1513 | # Decimal number. |
| 1514 | "micros": 42, # Micro (10^-6) units. |
| 1515 | # The value must be between -999,999 and +999,999 inclusive. |
| 1516 | # If `units` is positive, `micros` must be positive or zero. |
| 1517 | # If `units` is zero, `micros` can be positive, zero, or negative. |
| 1518 | # If `units` is negative, `micros` must be negative or zero. |
| 1519 | # For example -1.75 is represented as `units`=-1 and `micros`=-750,000. |
| 1520 | "units": "A String", # Whole units. |
| 1521 | }, |
| 1522 | "min": { # Deprecated. See CompensationInfo. # Required. Minimum value. |
| 1523 | # |
| 1524 | # Decimal number. |
| 1525 | "micros": 42, # Micro (10^-6) units. |
| 1526 | # The value must be between -999,999 and +999,999 inclusive. |
| 1527 | # If `units` is positive, `micros` must be positive or zero. |
| 1528 | # If `units` is zero, `micros` can be positive, zero, or negative. |
| 1529 | # If `units` is negative, `micros` must be negative or zero. |
| 1530 | # For example -1.75 is represented as `units`=-1 and `micros`=-750,000. |
| 1531 | "units": "A String", # Whole units. |
| 1532 | }, |
| 1533 | }, |
| 1534 | }, |
| 1535 | "startDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Optional. The start date of the job in UTC time zone. Typically this field |
| 1536 | # is used for contracting engagements. |
| 1537 | # Dates prior to 1970/1/1 and invalid date formats are ignored. |
| 1538 | # and time zone are either specified elsewhere or are not significant. The date |
| 1539 | # is relative to the Proleptic Gregorian Calendar. This can represent: |
| 1540 | # |
| 1541 | # * A full date, with non-zero year, month and day values |
| 1542 | # * A month and day value, with a zero year, e.g. an anniversary |
| 1543 | # * A year on its own, with zero month and day values |
| 1544 | # * A year and month value, with a zero day, e.g. a credit card expiration date |
| 1545 | # |
| 1546 | # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. |
| 1547 | "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| 1548 | # a year. |
| 1549 | "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| 1550 | # if specifying a year by itself or a year and month where the day is not |
| 1551 | # significant. |
| 1552 | "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| 1553 | # month and day. |
| 1554 | }, |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1555 | "department": "A String", # Optional. The department or functional area within the company with the open |
| 1556 | # position. |
| 1557 | # |
| 1558 | # The maximum number of allowed characters is 255. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1559 | "applicationEmailList": [ # Optional but at least one of application_urls, |
| 1560 | # application_email_list or application_instruction must be |
| 1561 | # specified. |
| 1562 | # |
| 1563 | # Use this field to specify email address(es) to which resumes or |
| 1564 | # applications can be sent. |
| 1565 | # |
| 1566 | # The maximum number of allowed characters is 255. |
| 1567 | "A String", |
| 1568 | ], |
| 1569 | "companyTitle": "A String", # Deprecated. Use company_display_name instead. |
| 1570 | # |
| 1571 | # Output only. |
| 1572 | # |
| 1573 | # The name of the company listing the job. |
| 1574 | "level": "A String", # Optional. The experience level associated with the job, such as "Entry Level". |
| 1575 | "filterableCustomFields": { # Deprecated. Use custom_attributes instead. |
| 1576 | # |
| 1577 | # Optional. |
| 1578 | # |
| 1579 | # A map of fields to hold filterable custom job attributes not captured by |
| 1580 | # the standard fields such as job_title, company_name, or |
| 1581 | # level. These custom fields store arbitrary |
| 1582 | # string values, and can be used for purposes not covered by |
| 1583 | # the structured fields. For the best search experience, use of the |
| 1584 | # structured rather than custom fields is recommended. |
| 1585 | # |
| 1586 | # Data stored in these custom fields fields are indexed and |
| 1587 | # searched against by keyword searches (see |
| 1588 | # SearchJobsRequest.custom_field_filters][]). |
| 1589 | # |
| 1590 | # The map key must be a number between 1-20. If an invalid key is |
| 1591 | # provided on job create or update, an error is returned. |
| 1592 | "a_key": { # Resource that represents the custom data not captured by the standard fields. |
| 1593 | "values": [ # Optional. The values of the custom data. |
| 1594 | "A String", |
| 1595 | ], |
| 1596 | }, |
| 1597 | }, |
| 1598 | "compensationInfo": { # Job compensation details. # Optional. Job compensation information. |
| 1599 | "entries": [ # Optional. Job compensation information. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1600 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1601 | # At most one entry can be of type |
| 1602 | # CompensationInfo.CompensationType.BASE, which is |
| 1603 | # referred as ** base compensation entry ** for the job. |
| 1604 | { # A compensation entry that represents one component of compensation, such |
| 1605 | # as base pay, bonus, or other compensation type. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1606 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1607 | # Annualization: One compensation entry can be annualized if |
| 1608 | # - it contains valid amount or range. |
| 1609 | # - and its expected_units_per_year is set or can be derived. |
| 1610 | # Its annualized range is determined as (amount or range) times |
| 1611 | # expected_units_per_year. |
| 1612 | "amount": { # Represents an amount of money with its currency type. # Optional. Compensation amount. |
| 1613 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 1614 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 1615 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 1616 | # If `units` is positive, `nanos` must be positive or zero. |
| 1617 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 1618 | # If `units` is negative, `nanos` must be negative or zero. |
| 1619 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 1620 | "units": "A String", # The whole units of the amount. |
| 1621 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 1622 | }, |
| 1623 | "description": "A String", # Optional. Compensation description. For example, could |
| 1624 | # indicate equity terms or provide additional context to an estimated |
| 1625 | # bonus. |
| 1626 | "expectedUnitsPerYear": 3.14, # Optional. Expected number of units paid each year. If not specified, when |
| 1627 | # Job.employment_types is FULLTIME, a default value is inferred |
| 1628 | # based on unit. Default values: |
| 1629 | # - HOURLY: 2080 |
| 1630 | # - DAILY: 260 |
| 1631 | # - WEEKLY: 52 |
| 1632 | # - MONTHLY: 12 |
| 1633 | # - ANNUAL: 1 |
| 1634 | "range": { # Compensation range. # Optional. Compensation range. |
| 1635 | "min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set |
| 1636 | # to zero and the currency code is set to match the |
| 1637 | # currency code of max_compensation. |
| 1638 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 1639 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 1640 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 1641 | # If `units` is positive, `nanos` must be positive or zero. |
| 1642 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 1643 | # If `units` is negative, `nanos` must be negative or zero. |
| 1644 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 1645 | "units": "A String", # The whole units of the amount. |
| 1646 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 1647 | }, |
| 1648 | "max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set |
| 1649 | # to a maximal compensation value and the currency code is set to |
| 1650 | # match the currency code of |
| 1651 | # min_compensation. |
| 1652 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 1653 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 1654 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 1655 | # If `units` is positive, `nanos` must be positive or zero. |
| 1656 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 1657 | # If `units` is negative, `nanos` must be negative or zero. |
| 1658 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 1659 | "units": "A String", # The whole units of the amount. |
| 1660 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 1661 | }, |
| 1662 | }, |
| 1663 | "type": "A String", # Required. Compensation type. |
| 1664 | "unit": "A String", # Optional. Frequency of the specified amount. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1665 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1666 | # Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1667 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1668 | ], |
| 1669 | "annualizedBaseCompensationRange": { # Compensation range. # Output only. Annualized base compensation range. Computed as |
| 1670 | # base compensation entry's CompensationEntry.compensation times |
| 1671 | # CompensationEntry.expected_units_per_year. |
| 1672 | # |
| 1673 | # See CompensationEntry for explanation on compensation annualization. |
| 1674 | "min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set |
| 1675 | # to zero and the currency code is set to match the |
| 1676 | # currency code of max_compensation. |
| 1677 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 1678 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 1679 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 1680 | # If `units` is positive, `nanos` must be positive or zero. |
| 1681 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 1682 | # If `units` is negative, `nanos` must be negative or zero. |
| 1683 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 1684 | "units": "A String", # The whole units of the amount. |
| 1685 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 1686 | }, |
| 1687 | "max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set |
| 1688 | # to a maximal compensation value and the currency code is set to |
| 1689 | # match the currency code of |
| 1690 | # min_compensation. |
| 1691 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 1692 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 1693 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 1694 | # If `units` is positive, `nanos` must be positive or zero. |
| 1695 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 1696 | # If `units` is negative, `nanos` must be negative or zero. |
| 1697 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 1698 | "units": "A String", # The whole units of the amount. |
| 1699 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1700 | }, |
| 1701 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1702 | "amount": { # Represents an amount of money with its currency type. # Deprecated. Use entries instead. |
| 1703 | # |
| 1704 | # Optional. |
| 1705 | # |
| 1706 | # The amount of compensation or pay for the job. |
| 1707 | # As an alternative, compensation_amount_min and |
| 1708 | # compensation_amount_max may be used to define a range of |
| 1709 | # compensation. |
| 1710 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 1711 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 1712 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 1713 | # If `units` is positive, `nanos` must be positive or zero. |
| 1714 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 1715 | # If `units` is negative, `nanos` must be negative or zero. |
| 1716 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 1717 | "units": "A String", # The whole units of the amount. |
| 1718 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 1719 | }, |
| 1720 | "max": { # Represents an amount of money with its currency type. # Deprecated. Use entries instead. |
| 1721 | # |
| 1722 | # Optional. |
| 1723 | # |
| 1724 | # An upper bound on a range for compensation or pay for the job. |
| 1725 | # The currency type is specified in compensation_amount. |
| 1726 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 1727 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 1728 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 1729 | # If `units` is positive, `nanos` must be positive or zero. |
| 1730 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 1731 | # If `units` is negative, `nanos` must be negative or zero. |
| 1732 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 1733 | "units": "A String", # The whole units of the amount. |
| 1734 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 1735 | }, |
| 1736 | "type": "A String", # Deprecated. Use entries instead. |
| 1737 | # |
| 1738 | # Optional. |
| 1739 | # |
| 1740 | # Type of job compensation. |
| 1741 | "min": { # Represents an amount of money with its currency type. # Deprecated. Use entries instead. |
| 1742 | # |
| 1743 | # Optional. |
| 1744 | # |
| 1745 | # A lower bound on a range for compensation or pay for the job. |
| 1746 | # The currency type is specified in compensation_amount. |
| 1747 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 1748 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 1749 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 1750 | # If `units` is positive, `nanos` must be positive or zero. |
| 1751 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 1752 | # If `units` is negative, `nanos` must be negative or zero. |
| 1753 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 1754 | "units": "A String", # The whole units of the amount. |
| 1755 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 1756 | }, |
| 1757 | "annualizedTotalCompensationRange": { # Compensation range. # Output only. Annualized total compensation range. Computed as |
| 1758 | # all compensation entries' CompensationEntry.compensation times |
| 1759 | # CompensationEntry.expected_units_per_year. |
| 1760 | # |
| 1761 | # See CompensationEntry for explanation on compensation annualization. |
| 1762 | "min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set |
| 1763 | # to zero and the currency code is set to match the |
| 1764 | # currency code of max_compensation. |
| 1765 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 1766 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 1767 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 1768 | # If `units` is positive, `nanos` must be positive or zero. |
| 1769 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 1770 | # If `units` is negative, `nanos` must be negative or zero. |
| 1771 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 1772 | "units": "A String", # The whole units of the amount. |
| 1773 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 1774 | }, |
| 1775 | "max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set |
| 1776 | # to a maximal compensation value and the currency code is set to |
| 1777 | # match the currency code of |
| 1778 | # min_compensation. |
| 1779 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 1780 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 1781 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 1782 | # If `units` is positive, `nanos` must be positive or zero. |
| 1783 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 1784 | # If `units` is negative, `nanos` must be negative or zero. |
| 1785 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 1786 | "units": "A String", # The whole units of the amount. |
| 1787 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 1788 | }, |
| 1789 | }, |
| 1790 | }, |
| 1791 | "region": "A String", # Optional. The job Region (for example, state, country) throughout which the job |
| 1792 | # is available. If this field is set, a |
| 1793 | # LocationFilter in a search query within the job region |
| 1794 | # finds this job if an exact location match is not specified. |
| 1795 | # If this field is set, setting job locations |
| 1796 | # to the same location level as this field is strongly recommended. |
| 1797 | "createTime": "A String", # Output only. The timestamp when this job was created. |
| 1798 | "incentives": "A String", # Optional. A description of bonus, commission, and other compensation |
| 1799 | # incentives associated with the job not including salary or pay. |
| 1800 | # |
| 1801 | # The maximum number of allowed characters is 10,000. |
| 1802 | "companyDisplayName": "A String", # Output only. The name of the company listing the job. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1803 | "unindexedCustomFields": { # Deprecated. Use custom_attributes instead. |
| 1804 | # |
| 1805 | # Optional. |
| 1806 | # |
| 1807 | # A map of fields to hold non-filterable custom job attributes, similar to |
| 1808 | # filterable_custom_fields. These fields are distinct in that the data |
| 1809 | # in these fields are not indexed. Therefore, the client cannot search |
| 1810 | # against them, nor can the client use them to list jobs. |
| 1811 | # |
| 1812 | # The key of the map can be any valid string. |
| 1813 | "a_key": { # Resource that represents the custom data not captured by the standard fields. |
| 1814 | "values": [ # Optional. The values of the custom data. |
| 1815 | "A String", |
| 1816 | ], |
| 1817 | }, |
| 1818 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1819 | "visibility": "A String", # Optional. The visibility of the job. |
| 1820 | # Defaults to JobVisibility.PRIVATE if not specified. |
| 1821 | # Currently only JobVisibility.PRIVATE is supported. |
| 1822 | "employmentTypes": [ # Optional. The employment type(s) of a job, for example, |
| 1823 | # full time or |
| 1824 | # part time. |
| 1825 | "A String", |
| 1826 | ], |
| 1827 | "benefits": [ # Optional. The benefits included with the job. |
| 1828 | "A String", |
| 1829 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1830 | "expiryDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Deprecated. Use expire_time instead. |
| 1831 | # |
| 1832 | # Optional but strongly recommended to be provided for the best service |
| 1833 | # experience. |
| 1834 | # |
| 1835 | # The expiration date of the job in UTC time. After 12 am on this date, the |
| 1836 | # job is marked as expired, and it no longer appears in search results. |
| 1837 | # The expired job can't be deleted or listed by the DeleteJob and |
| 1838 | # ListJobs APIs, but it can be retrieved with the GetJob API or |
| 1839 | # updated with the UpdateJob API. An expired job can be updated and |
| 1840 | # opened again by using a future expiration date. It can also remain expired. |
| 1841 | # Updating an expired job to be open fails if there is another existing open |
| 1842 | # job with same requisition_id, company_name and language_code. |
| 1843 | # |
| 1844 | # The expired jobs are retained in our system for 90 days. However, the |
| 1845 | # overall expired job count cannot exceed 3 times the maximum of open jobs |
| 1846 | # count over the past week, otherwise jobs with earlier expire time are |
| 1847 | # removed first. Expired jobs are no longer accessible after they are cleaned |
| 1848 | # out. |
| 1849 | # |
| 1850 | # A valid date range is between 1970/1/1 and 2100/12/31. Invalid dates are |
| 1851 | # ignored and treated as expiry date not provided. |
| 1852 | # |
| 1853 | # If this value is not provided on job creation or is invalid, the job |
| 1854 | # posting expires after 30 days from the job's creation time. For example, if |
| 1855 | # the job was created on 2017/01/01 13:00AM UTC with an unspecified |
| 1856 | # expiration date, the job expires after 2017/01/31 13:00AM UTC. |
| 1857 | # |
| 1858 | # If this value is not provided on job update, it depends on the field masks |
| 1859 | # set by UpdateJobRequest.update_job_fields. If the field masks include |
| 1860 | # expiry_date, or the masks are empty meaning that every field is |
| 1861 | # updated, the job expires after 30 days from the job's last update time. |
| 1862 | # Otherwise the expiration date isn't updated. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1863 | # and time zone are either specified elsewhere or are not significant. The date |
| 1864 | # is relative to the Proleptic Gregorian Calendar. This can represent: |
| 1865 | # |
| 1866 | # * A full date, with non-zero year, month and day values |
| 1867 | # * A month and day value, with a zero year, e.g. an anniversary |
| 1868 | # * A year on its own, with zero month and day values |
| 1869 | # * A year and month value, with a zero day, e.g. a credit card expiration date |
| 1870 | # |
| 1871 | # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1872 | "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| 1873 | # a year. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1874 | "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1875 | # if specifying a year by itself or a year and month where the day is not |
| 1876 | # significant. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1877 | "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| 1878 | # month and day. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1879 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1880 | "companyName": "A String", # Optional but one of company_name or distributor_company_id must be |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1881 | # provided. |
| 1882 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1883 | # The resource name of the company listing the job, such as |
| 1884 | # /companies/foo. This field takes precedence over the |
| 1885 | # distributor-assigned company identifier, distributor_company_id. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1886 | "locations": [ # Optional but strongly recommended for the best service experience. |
| 1887 | # |
| 1888 | # Location(s) where the emploeyer is looking to hire for this job posting. |
| 1889 | # |
| 1890 | # Specifying the full street address(es) of the hiring location enables |
| 1891 | # better API results, especially job searches by commute time. |
| 1892 | # |
| 1893 | # At most 50 locations are allowed for best search performance. If a job has |
| 1894 | # more locations, it is suggested to split it into multiple jobs with unique |
| 1895 | # requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as |
| 1896 | # multiple jobs with the same requisition_id, company_name and |
| 1897 | # language_code are not allowed. If the original requisition_id must |
| 1898 | # be preserved, a custom field should be used for storage. It is also |
| 1899 | # suggested to group the locations that close to each other in the same job |
| 1900 | # for better search experience. |
| 1901 | # |
| 1902 | # The maximum number of allowed characters is 500. |
| 1903 | "A String", |
| 1904 | ], |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1905 | "endDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Optional. The end date of the job in UTC time zone. Typically this field |
| 1906 | # is used for contracting engagements. |
| 1907 | # Dates prior to 1970/1/1 and invalid date formats are ignored. |
| 1908 | # and time zone are either specified elsewhere or are not significant. The date |
| 1909 | # is relative to the Proleptic Gregorian Calendar. This can represent: |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1910 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1911 | # * A full date, with non-zero year, month and day values |
| 1912 | # * A month and day value, with a zero year, e.g. an anniversary |
| 1913 | # * A year on its own, with zero month and day values |
| 1914 | # * A year and month value, with a zero day, e.g. a credit card expiration date |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1915 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1916 | # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. |
| 1917 | "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| 1918 | # a year. |
| 1919 | "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| 1920 | # if specifying a year by itself or a year and month where the day is not |
| 1921 | # significant. |
| 1922 | "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| 1923 | # month and day. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1924 | }, |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1925 | }</pre> |
| 1926 | </div> |
| 1927 | |
| 1928 | <div class="method"> |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1929 | <code class="details" id="delete">delete(name, disableFastProcess=None, x__xgafv=None)</code> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1930 | <pre>Deletes the specified job. |
| 1931 | |
| 1932 | Typically, the job becomes unsearchable within 10 seconds, but it may take |
| 1933 | up to 5 minutes. |
| 1934 | |
| 1935 | Args: |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1936 | name: string, Required. The resource name of the job to be deleted, such as "jobs/11111111". (required) |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1937 | disableFastProcess: boolean, Deprecated. This field is not working anymore. |
| 1938 | |
| 1939 | Optional. |
| 1940 | |
| 1941 | If set to true, this call waits for all processing steps to complete |
| 1942 | before the job is cleaned up. Otherwise, the call returns while some |
| 1943 | steps are still taking place asynchronously, hence faster. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1944 | x__xgafv: string, V1 error format. |
| 1945 | Allowed values |
| 1946 | 1 - v1 error format |
| 1947 | 2 - v2 error format |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1948 | |
| 1949 | Returns: |
| 1950 | An object of the form: |
| 1951 | |
| 1952 | { # A generic empty message that you can re-use to avoid defining duplicated |
| 1953 | # empty messages in your APIs. A typical example is to use it as the request |
| 1954 | # or the response type of an API method. For instance: |
| 1955 | # |
| 1956 | # service Foo { |
| 1957 | # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); |
| 1958 | # } |
| 1959 | # |
| 1960 | # The JSON representation for `Empty` is empty JSON object `{}`. |
| 1961 | }</pre> |
| 1962 | </div> |
| 1963 | |
| 1964 | <div class="method"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1965 | <code class="details" id="deleteByFilter">deleteByFilter(body=None, x__xgafv=None)</code> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1966 | <pre>Deprecated. Use BatchDeleteJobs instead. |
| 1967 | |
| 1968 | Deletes the specified job by filter. You can specify whether to |
| 1969 | synchronously wait for validation, indexing, and general processing to be |
| 1970 | completed before the response is returned. |
| 1971 | |
| 1972 | Args: |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1973 | body: object, The request body. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1974 | The object takes the form of: |
| 1975 | |
| 1976 | { # Deprecated. Use BatchDeleteJobsRequest instead. |
| 1977 | # |
| 1978 | # Input only. |
| 1979 | # |
| 1980 | # Delete job by filter request. |
| 1981 | # |
| 1982 | # The job typically becomes unsearchable within 10 seconds, but it may take |
| 1983 | # up to 5 minutes. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1984 | "filter": { # Deprecated. Use BatchDeleteJobsRequest instead. # Required. Restrictions on the scope of the delete request. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1985 | # |
| 1986 | # Input only. |
| 1987 | # |
| 1988 | # Filter for jobs to be deleted. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1989 | "requisitionId": "A String", # Required. The requisition ID (or posting ID) assigned by the client to identify a |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1990 | # job. This is intended for client identification and tracking of |
| 1991 | # listings. |
| 1992 | # name takes precedence over this field |
| 1993 | # The maximum number of allowed characters is 225. |
| 1994 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1995 | "disableFastProcess": True or False, # Optional. If set to true, this call waits for all processing steps to complete |
| 1996 | # before the job is cleaned up. Otherwise, the call returns while some |
| 1997 | # steps are still taking place asynchronously, hence faster. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1998 | } |
| 1999 | |
| 2000 | x__xgafv: string, V1 error format. |
| 2001 | Allowed values |
| 2002 | 1 - v1 error format |
| 2003 | 2 - v2 error format |
| 2004 | |
| 2005 | Returns: |
| 2006 | An object of the form: |
| 2007 | |
| 2008 | { # A generic empty message that you can re-use to avoid defining duplicated |
| 2009 | # empty messages in your APIs. A typical example is to use it as the request |
| 2010 | # or the response type of an API method. For instance: |
| 2011 | # |
| 2012 | # service Foo { |
| 2013 | # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); |
| 2014 | # } |
| 2015 | # |
| 2016 | # The JSON representation for `Empty` is empty JSON object `{}`. |
| 2017 | }</pre> |
| 2018 | </div> |
| 2019 | |
| 2020 | <div class="method"> |
| 2021 | <code class="details" id="get">get(name, x__xgafv=None)</code> |
| 2022 | <pre>Retrieves the specified job, whose status is OPEN or recently EXPIRED |
| 2023 | within the last 90 days. |
| 2024 | |
| 2025 | Args: |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2026 | name: string, Required. The resource name of the job to retrieve, such as "jobs/11111111". (required) |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2027 | x__xgafv: string, V1 error format. |
| 2028 | Allowed values |
| 2029 | 1 - v1 error format |
| 2030 | 2 - v2 error format |
| 2031 | |
| 2032 | Returns: |
| 2033 | An object of the form: |
| 2034 | |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2035 | { # A Job resource represents a job posting (also referred to as a "job listing" |
| 2036 | # 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] | 2037 | # entity responsible for the job. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2038 | "languageCode": "A String", # Optional. The language of the posting. This field is distinct from |
| 2039 | # any requirements for fluency that are associated with the job. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2040 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2041 | # Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn". |
| 2042 | # For more information, see |
| 2043 | # [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){: |
| 2044 | # class="external" target="_blank" }. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2045 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2046 | # If this field is unspecified and Job.description is present, detected |
| 2047 | # language code based on Job.description is assigned, otherwise |
| 2048 | # defaults to 'en_US'. |
| 2049 | "educationLevels": [ # Optional. The desired education level for the job, such as |
| 2050 | # "Bachelors", "Masters", "Doctorate". |
| 2051 | "A String", |
| 2052 | ], |
| 2053 | "description": "A String", # Required. The description of the job, which typically includes a multi-paragraph |
| 2054 | # description of the company and related information. Separate fields are |
| 2055 | # provided on the job object for responsibilities, |
| 2056 | # qualifications, and other job characteristics. Use of |
| 2057 | # these separate job fields is recommended. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2058 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2059 | # This field accepts and sanitizes HTML input, and also accepts |
| 2060 | # bold, italic, ordered list, and unordered list markup tags. |
| 2061 | # |
| 2062 | # The maximum number of allowed characters is 100,000. |
| 2063 | "updateTime": "A String", # Output only. The timestamp when this job was last updated. |
| 2064 | "promotionValue": 42, # Optional. A promotion value of the job, as determined by the client. |
| 2065 | # The value determines the sort order of the jobs returned when searching for |
| 2066 | # jobs using the featured jobs search call, with higher promotional values |
| 2067 | # being returned first and ties being resolved by relevance sort. Only the |
| 2068 | # jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH. |
| 2069 | # |
| 2070 | # Default value is 0, and negative values are treated as 0. |
| 2071 | "qualifications": "A String", # Optional. A description of the qualifications required to perform the |
| 2072 | # job. The use of this field is recommended |
| 2073 | # as an alternative to using the more general description field. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2074 | # |
| 2075 | # This field accepts and sanitizes HTML input, and also accepts |
| 2076 | # bold, italic, ordered list, and unordered list markup tags. |
| 2077 | # |
| 2078 | # The maximum number of allowed characters is 10,000. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2079 | "customAttributes": { # Optional. A map of fields to hold both filterable and non-filterable custom job |
| 2080 | # attributes that are not covered by the provided structured fields. |
| 2081 | # |
| 2082 | # This field is a more general combination of the deprecated id-based |
| 2083 | # filterable_custom_fields and string-based |
| 2084 | # non_filterable_custom_fields. |
| 2085 | # |
| 2086 | # The keys of the map are strings up to 64 bytes and must match the |
| 2087 | # pattern: a-zA-Z*. |
| 2088 | # |
| 2089 | # At most 100 filterable and at most 100 unfilterable keys are supported. |
| 2090 | # For filterable `string_values`, across all keys at most 200 values are |
| 2091 | # allowed, with each string no more than 255 characters. For unfilterable |
| 2092 | # `string_values`, the maximum total size of `string_values` across all keys |
| 2093 | # is 50KB. |
| 2094 | "a_key": { # Custom attribute values that are either filterable or non-filterable. |
| 2095 | "longValue": "A String", # Optional but at least one of string_values or long_value must |
| 2096 | # be specified. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2097 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2098 | # This field is used to perform number range search. |
| 2099 | # (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`. For |
| 2100 | # `long_value`, a value between Long.MIN and Long.MAX is allowed. |
| 2101 | "filterable": True or False, # Optional. If the `filterable` flag is true, custom field values are searchable. |
| 2102 | # If false, values are not searchable. |
| 2103 | # |
| 2104 | # Default is false. |
| 2105 | "stringValues": { # Represents array of string values. # Optional but at least one of string_values or long_value must |
| 2106 | # be specified. |
| 2107 | # |
| 2108 | # This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or |
| 2109 | # `CASE_INSENSITIVE_MATCH`) search. |
| 2110 | # For filterable `string_values`, a maximum total number of 200 values |
| 2111 | # is allowed, with each `string_value` has a byte size of no more than |
| 2112 | # 255B. For unfilterable `string_values`, the maximum total byte size of |
| 2113 | # unfilterable `string_values` is 50KB. |
| 2114 | # |
| 2115 | # Empty strings are not allowed. |
| 2116 | "values": [ # Required. String values. |
| 2117 | "A String", |
| 2118 | ], |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2119 | }, |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2120 | }, |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2121 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2122 | "applicationUrls": [ # Optional but at least one of application_urls, |
| 2123 | # application_email_list or application_instruction must be |
| 2124 | # specified. |
| 2125 | # |
| 2126 | # Use this URL field to direct an applicant to a website, for example to |
| 2127 | # link to an online application form. |
| 2128 | # |
| 2129 | # The maximum number of allowed characters is 2,000. |
| 2130 | "A String", |
| 2131 | ], |
| 2132 | "requisitionId": "A String", # Required. The requisition ID, also referred to as the posting ID, assigned by the |
| 2133 | # client to identify a job. This field is intended to be used by clients |
| 2134 | # for client identification and tracking of listings. A job is not allowed |
| 2135 | # to be created if there is another job with the same requisition_id, |
| 2136 | # company_name and language_code. |
| 2137 | # |
| 2138 | # The maximum number of allowed characters is 255. |
| 2139 | "jobLocations": [ # Output only. Structured locations of the job, resolved from locations. |
| 2140 | { # Output only. |
| 2141 | # |
| 2142 | # A resource that represents a location with full geographic |
| 2143 | # information. |
| 2144 | "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair. |
| 2145 | # of doubles representing degrees latitude and degrees longitude. Unless |
| 2146 | # specified otherwise, this must conform to the |
| 2147 | # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 |
| 2148 | # standard</a>. Values must be within normalized ranges. |
| 2149 | "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. |
| 2150 | "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. |
| 2151 | }, |
| 2152 | "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information, |
| 2153 | # such as postal delivery and payments addresses. Given a postal address, |
| 2154 | # a postal service can deliver items to a premises, P.O. Box, or other |
| 2155 | # delivery location. |
| 2156 | # Given a postal address, a postal service can deliver items to a premise, P.O. |
| 2157 | # Box or similar. |
| 2158 | # It is not intended to model geographical locations (roads, towns, |
| 2159 | # mountains). |
| 2160 | # |
| 2161 | # In typical usage an address would be created via user input or from importing |
| 2162 | # existing data, depending on the type of process. |
| 2163 | # |
| 2164 | # Advice on address input / editing: |
| 2165 | # - Use an i18n-ready address widget such as |
| 2166 | # https://github.com/google/libaddressinput) |
| 2167 | # - Users should not be presented with UI elements for input or editing of |
| 2168 | # fields outside countries where that field is used. |
| 2169 | # |
| 2170 | # For more guidance on how to use this schema, please see: |
| 2171 | # https://support.google.com/business/answer/6397478 |
| 2172 | "sublocality": "A String", # Optional. Sublocality of the address. |
| 2173 | # For example, this can be neighborhoods, boroughs, districts. |
| 2174 | "recipients": [ # Optional. The recipient at the address. |
| 2175 | # This field may, under certain circumstances, contain multiline information. |
| 2176 | # For example, it might contain "care of" information. |
| 2177 | "A String", |
| 2178 | ], |
| 2179 | "locality": "A String", # Optional. Generally refers to the city/town portion of the address. |
| 2180 | # Examples: US city, IT comune, UK post town. |
| 2181 | # In regions of the world where localities are not well defined or do not fit |
| 2182 | # into this structure well, leave locality empty and use address_lines. |
| 2183 | "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This |
| 2184 | # is never inferred and it is up to the user to ensure the value is |
| 2185 | # correct. See http://cldr.unicode.org/ and |
| 2186 | # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html |
| 2187 | # for details. Example: "CH" for Switzerland. |
| 2188 | "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if |
| 2189 | # known). This is often the UI language of the input form or is expected |
| 2190 | # to match one of the languages used in the address' country/region, or their |
| 2191 | # transliterated equivalents. |
| 2192 | # This can affect formatting in certain countries, but is not critical |
| 2193 | # to the correctness of the data and will never affect any validation or |
| 2194 | # other non-formatting related operations. |
| 2195 | # |
| 2196 | # If this value is not known, it should be omitted (rather than specifying a |
| 2197 | # possibly incorrect default). |
| 2198 | # |
| 2199 | # Examples: "zh-Hant", "ja", "ja-Latn", "en". |
| 2200 | "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require |
| 2201 | # postal codes to be present, but where they are used, they may trigger |
| 2202 | # additional validation with other parts of the address (e.g. state/zip |
| 2203 | # validation in the U.S.A.). |
| 2204 | "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal |
| 2205 | # addresses of a country or region. |
| 2206 | # For example, this can be a state, a province, an oblast, or a prefecture. |
| 2207 | # Specifically, for Spain this is the province and not the autonomous |
| 2208 | # community (e.g. "Barcelona" and not "Catalonia"). |
| 2209 | # Many countries don't use an administrative area in postal addresses. E.g. |
| 2210 | # in Switzerland this should be left unpopulated. |
| 2211 | "addressLines": [ # Unstructured address lines describing the lower levels of an address. |
| 2212 | # |
| 2213 | # Because values in address_lines do not have type information and may |
| 2214 | # sometimes contain multiple values in a single field (e.g. |
| 2215 | # "Austin, TX"), it is important that the line order is clear. The order of |
| 2216 | # address lines should be "envelope order" for the country/region of the |
| 2217 | # address. In places where this can vary (e.g. Japan), address_language is |
| 2218 | # used to make it explicit (e.g. "ja" for large-to-small ordering and |
| 2219 | # "ja-Latn" or "en" for small-to-large). This way, the most specific line of |
| 2220 | # an address can be selected based on the language. |
| 2221 | # |
| 2222 | # The minimum permitted structural representation of an address consists |
| 2223 | # of a region_code with all remaining information placed in the |
| 2224 | # address_lines. It would be possible to format such an address very |
| 2225 | # approximately without geocoding, but no semantic reasoning could be |
| 2226 | # made about any of the address components until it was at least |
| 2227 | # partially resolved. |
| 2228 | # |
| 2229 | # Creating an address only containing a region_code and address_lines, and |
| 2230 | # then geocoding is the recommended way to handle completely unstructured |
| 2231 | # addresses (as opposed to guessing which parts of the address should be |
| 2232 | # localities or administrative areas). |
| 2233 | "A String", |
| 2234 | ], |
| 2235 | "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used |
| 2236 | # in most regions. Where it is used, the value is either a string like |
| 2237 | # "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number |
| 2238 | # alone, representing the "sector code" (Jamaica), "delivery area indicator" |
| 2239 | # (Malawi) or "post office indicator" (e.g. Côte d'Ivoire). |
| 2240 | "organization": "A String", # Optional. The name of the organization at the address. |
| 2241 | "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is |
| 2242 | # the latest revision. |
| 2243 | # |
| 2244 | # All new revisions **must** be backward compatible with old revisions. |
| 2245 | }, |
| 2246 | "locationType": "A String", # The type of a location, which corresponds to the address lines field of |
| 2247 | # PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of |
| 2248 | # LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of |
| 2249 | # LocationType#LOCALITY. |
| 2250 | "radiusMeters": 3.14, # Radius in meters of the job location. This value is derived from the |
| 2251 | # location bounding box in which a circle with the specified radius |
| 2252 | # centered from LatLng coves the area associated with the job location. |
| 2253 | # For example, currently, "Mountain View, CA, USA" has a radius of |
| 2254 | # 7885.79 meters. |
| 2255 | }, |
| 2256 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2257 | "expireTime": "A String", # Optional but strongly recommended for the best service |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2258 | # experience. |
| 2259 | # |
| 2260 | # The expiration timestamp of the job. After this timestamp, the |
| 2261 | # job is marked as expired, and it no longer appears in search results. The |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2262 | # expired job can't be deleted or listed by the DeleteJob and |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2263 | # ListJobs APIs, but it can be retrieved with the GetJob API or |
| 2264 | # updated with the UpdateJob API. An expired job can be updated and |
| 2265 | # opened again by using a future expiration timestamp. Updating an expired |
| 2266 | # job fails if there is another existing open job with same |
| 2267 | # requisition_id, company_name and language_code. |
| 2268 | # |
| 2269 | # The expired jobs are retained in our system for 90 days. However, the |
| 2270 | # overall expired job count cannot exceed 3 times the maximum of open jobs |
| 2271 | # count over the past week, otherwise jobs with earlier expire time are |
| 2272 | # cleaned first. Expired jobs are no longer accessible after they are cleaned |
| 2273 | # out. |
| 2274 | # The format of this field is RFC 3339 date strings. Example: |
| 2275 | # 2000-01-01T00:00:00.999999999Z |
| 2276 | # See |
| 2277 | # [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt). |
| 2278 | # |
| 2279 | # A valid date range is between 1970-01-01T00:00:00.0Z and |
| 2280 | # 2100-12-31T23:59:59.999Z. Invalid dates are ignored and treated as expire |
| 2281 | # time not provided. |
| 2282 | # |
| 2283 | # If this value is not provided at the time of job creation or is invalid, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2284 | # the job posting expires after 30 days from the job's creation time. For |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2285 | # example, if the job was created on 2017/01/01 13:00AM UTC with an |
| 2286 | # unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC. |
| 2287 | # |
| 2288 | # If this value is not provided but expiry_date is, expiry_date is |
| 2289 | # used. |
| 2290 | # |
| 2291 | # If this value is not provided on job update, it depends on the field masks |
| 2292 | # set by UpdateJobRequest.update_job_fields. If the field masks include |
| 2293 | # expiry_time, or the masks are empty meaning that every field is |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2294 | # updated, the job posting expires after 30 days from the job's last |
| 2295 | # update time. Otherwise the expiration date isn't updated. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2296 | "name": "A String", # Required during job update. |
| 2297 | # |
| 2298 | # Resource name assigned to a job by the API, for example, "/jobs/foo". Use |
| 2299 | # of this field in job queries and API calls is preferred over the use of |
| 2300 | # requisition_id since this value is unique. |
| 2301 | "jobTitle": "A String", # Required. The title of the job, such as "Software Engineer" |
| 2302 | # |
| 2303 | # The maximum number of allowed characters is 500. |
| 2304 | "referenceUrl": "A String", # Output only. The URL of a web page that displays job details. |
| 2305 | "responsibilities": "A String", # Optional. A description of job responsibilities. The use of this field is |
| 2306 | # recommended as an alternative to using the more general description |
| 2307 | # field. |
| 2308 | # |
| 2309 | # This field accepts and sanitizes HTML input, and also accepts |
| 2310 | # bold, italic, ordered list, and unordered list markup tags. |
| 2311 | # |
| 2312 | # The maximum number of allowed characters is 10,000. |
| 2313 | "distributorCompanyId": "A String", # Optional but one of company_name or distributor_company_id must be |
| 2314 | # provided. |
| 2315 | # |
| 2316 | # A unique company identifier used by job distributors to identify an |
| 2317 | # employer's company entity. company_name takes precedence over |
| 2318 | # this field, and is the recommended field to use to identify companies. |
| 2319 | # |
| 2320 | # The maximum number of allowed characters is 255. |
| 2321 | "publishDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Optional. The date this job was most recently published in UTC format. The default |
| 2322 | # value is the time the request arrives at the server. |
| 2323 | # and time zone are either specified elsewhere or are not significant. The date |
| 2324 | # is relative to the Proleptic Gregorian Calendar. This can represent: |
| 2325 | # |
| 2326 | # * A full date, with non-zero year, month and day values |
| 2327 | # * A month and day value, with a zero year, e.g. an anniversary |
| 2328 | # * A year on its own, with zero month and day values |
| 2329 | # * A year and month value, with a zero day, e.g. a credit card expiration date |
| 2330 | # |
| 2331 | # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. |
| 2332 | "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| 2333 | # a year. |
| 2334 | "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| 2335 | # if specifying a year by itself or a year and month where the day is not |
| 2336 | # significant. |
| 2337 | "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| 2338 | # month and day. |
| 2339 | }, |
| 2340 | "applicationInstruction": "A String", # Optional but at least one of application_urls, |
| 2341 | # application_email_list or application_instruction must be |
| 2342 | # specified. |
| 2343 | # |
| 2344 | # Use this field to provide instructions, such as "Mail your application |
| 2345 | # to ...", that a candidate can follow to apply for the job. |
| 2346 | # |
| 2347 | # This field accepts and sanitizes HTML input, and also accepts |
| 2348 | # bold, italic, ordered list, and unordered list markup tags. |
| 2349 | # |
| 2350 | # The maximum number of allowed characters is 3,000. |
| 2351 | "extendedCompensationInfo": { # Deprecated. Use CompensationInfo. # Deprecated. Always use compensation_info. |
| 2352 | # |
| 2353 | # Optional. |
| 2354 | # |
| 2355 | # Job compensation information. |
| 2356 | # |
| 2357 | # This field replaces compensation_info. Only |
| 2358 | # CompensationInfo.entries or extended_compensation_info can be set, |
| 2359 | # otherwise an exception is thrown. |
| 2360 | # |
| 2361 | # Describes job compensation. |
| 2362 | "annualizedBaseCompensationRange": { # Deprecated. See CompensationInfo. # Output only. Annualized base compensation range. |
| 2363 | # |
| 2364 | # Compensation range. |
| 2365 | "max": { # Deprecated. See CompensationInfo. # Required. Maximum value. |
| 2366 | # |
| 2367 | # Decimal number. |
| 2368 | "micros": 42, # Micro (10^-6) units. |
| 2369 | # The value must be between -999,999 and +999,999 inclusive. |
| 2370 | # If `units` is positive, `micros` must be positive or zero. |
| 2371 | # If `units` is zero, `micros` can be positive, zero, or negative. |
| 2372 | # If `units` is negative, `micros` must be negative or zero. |
| 2373 | # For example -1.75 is represented as `units`=-1 and `micros`=-750,000. |
| 2374 | "units": "A String", # Whole units. |
| 2375 | }, |
| 2376 | "min": { # Deprecated. See CompensationInfo. # Required. Minimum value. |
| 2377 | # |
| 2378 | # Decimal number. |
| 2379 | "micros": 42, # Micro (10^-6) units. |
| 2380 | # The value must be between -999,999 and +999,999 inclusive. |
| 2381 | # If `units` is positive, `micros` must be positive or zero. |
| 2382 | # If `units` is zero, `micros` can be positive, zero, or negative. |
| 2383 | # If `units` is negative, `micros` must be negative or zero. |
| 2384 | # For example -1.75 is represented as `units`=-1 and `micros`=-750,000. |
| 2385 | "units": "A String", # Whole units. |
| 2386 | }, |
| 2387 | }, |
| 2388 | "annualizedTotalCompensationUnspecified": True or False, # Output only. Indicates annualized total compensation range cannot be derived, due to |
| 2389 | # the job's all CompensationEntry cannot be annualized. |
| 2390 | # See CompensationEntry for explanation on annualization and base |
| 2391 | # compensation entry. |
| 2392 | "currency": "A String", # Optional. A 3-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) |
| 2393 | # currency code. |
| 2394 | "annualizedBaseCompensationUnspecified": True or False, # Output only. Indicates annualized base compensation range cannot be derived, due to |
| 2395 | # the job's base compensation entry cannot be annualized. |
| 2396 | # See CompensationEntry for explanation on annualization and base |
| 2397 | # compensation entry. |
| 2398 | "entries": [ # Optional. Job compensation information. |
| 2399 | # |
| 2400 | # At most one entry can be of type |
| 2401 | # ExtendedCompensationInfo.CompensationType.BASE, which is |
| 2402 | # referred as ** base compensation entry ** for the job. |
| 2403 | { # Deprecated. See CompensationInfo. |
| 2404 | # |
| 2405 | # A compensation entry that represents one component of compensation, such |
| 2406 | # as base pay, bonus, or other compensation type. |
| 2407 | # |
| 2408 | # Annualization: One compensation entry can be annualized if |
| 2409 | # - it contains valid amount or range. |
| 2410 | # - and its expected_units_per_year is set or can be derived. |
| 2411 | # Its annualized range is determined as (amount or range) times |
| 2412 | # expected_units_per_year. |
| 2413 | "range": { # Deprecated. See CompensationInfo. # Optional. Compensation range. |
| 2414 | # |
| 2415 | # Compensation range. |
| 2416 | "max": { # Deprecated. See CompensationInfo. # Required. Maximum value. |
| 2417 | # |
| 2418 | # Decimal number. |
| 2419 | "micros": 42, # Micro (10^-6) units. |
| 2420 | # The value must be between -999,999 and +999,999 inclusive. |
| 2421 | # If `units` is positive, `micros` must be positive or zero. |
| 2422 | # If `units` is zero, `micros` can be positive, zero, or negative. |
| 2423 | # If `units` is negative, `micros` must be negative or zero. |
| 2424 | # For example -1.75 is represented as `units`=-1 and `micros`=-750,000. |
| 2425 | "units": "A String", # Whole units. |
| 2426 | }, |
| 2427 | "min": { # Deprecated. See CompensationInfo. # Required. Minimum value. |
| 2428 | # |
| 2429 | # Decimal number. |
| 2430 | "micros": 42, # Micro (10^-6) units. |
| 2431 | # The value must be between -999,999 and +999,999 inclusive. |
| 2432 | # If `units` is positive, `micros` must be positive or zero. |
| 2433 | # If `units` is zero, `micros` can be positive, zero, or negative. |
| 2434 | # If `units` is negative, `micros` must be negative or zero. |
| 2435 | # For example -1.75 is represented as `units`=-1 and `micros`=-750,000. |
| 2436 | "units": "A String", # Whole units. |
| 2437 | }, |
| 2438 | }, |
| 2439 | "expectedUnitsPerYear": { # Deprecated. See CompensationInfo. # Optional. Expected number of units paid each year. If not specified, when |
| 2440 | # Job.employment_types is FULLTIME, a default value is inferred |
| 2441 | # based on unit. Default values: |
| 2442 | # - HOURLY: 2080 |
| 2443 | # - DAILY: 260 |
| 2444 | # - WEEKLY: 52 |
| 2445 | # - MONTHLY: 12 |
| 2446 | # - ANNUAL: 1 |
| 2447 | # |
| 2448 | # Decimal number. |
| 2449 | "micros": 42, # Micro (10^-6) units. |
| 2450 | # The value must be between -999,999 and +999,999 inclusive. |
| 2451 | # If `units` is positive, `micros` must be positive or zero. |
| 2452 | # If `units` is zero, `micros` can be positive, zero, or negative. |
| 2453 | # If `units` is negative, `micros` must be negative or zero. |
| 2454 | # For example -1.75 is represented as `units`=-1 and `micros`=-750,000. |
| 2455 | "units": "A String", # Whole units. |
| 2456 | }, |
| 2457 | "amount": { # Deprecated. See CompensationInfo. # Optional. Monetary amount. |
| 2458 | # |
| 2459 | # Decimal number. |
| 2460 | "micros": 42, # Micro (10^-6) units. |
| 2461 | # The value must be between -999,999 and +999,999 inclusive. |
| 2462 | # If `units` is positive, `micros` must be positive or zero. |
| 2463 | # If `units` is zero, `micros` can be positive, zero, or negative. |
| 2464 | # If `units` is negative, `micros` must be negative or zero. |
| 2465 | # For example -1.75 is represented as `units`=-1 and `micros`=-750,000. |
| 2466 | "units": "A String", # Whole units. |
| 2467 | }, |
| 2468 | "description": "A String", # Optional. Compensation description. |
| 2469 | "unspecified": True or False, # Optional. Indicates compensation amount and range are unset. |
| 2470 | "unit": "A String", # Optional. Frequency of the specified amount. |
| 2471 | # |
| 2472 | # Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED. |
| 2473 | "type": "A String", # Required. Compensation type. |
| 2474 | }, |
| 2475 | ], |
| 2476 | "annualizedTotalCompensationRange": { # Deprecated. See CompensationInfo. # Output only. Annualized total compensation range. |
| 2477 | # |
| 2478 | # Compensation range. |
| 2479 | "max": { # Deprecated. See CompensationInfo. # Required. Maximum value. |
| 2480 | # |
| 2481 | # Decimal number. |
| 2482 | "micros": 42, # Micro (10^-6) units. |
| 2483 | # The value must be between -999,999 and +999,999 inclusive. |
| 2484 | # If `units` is positive, `micros` must be positive or zero. |
| 2485 | # If `units` is zero, `micros` can be positive, zero, or negative. |
| 2486 | # If `units` is negative, `micros` must be negative or zero. |
| 2487 | # For example -1.75 is represented as `units`=-1 and `micros`=-750,000. |
| 2488 | "units": "A String", # Whole units. |
| 2489 | }, |
| 2490 | "min": { # Deprecated. See CompensationInfo. # Required. Minimum value. |
| 2491 | # |
| 2492 | # Decimal number. |
| 2493 | "micros": 42, # Micro (10^-6) units. |
| 2494 | # The value must be between -999,999 and +999,999 inclusive. |
| 2495 | # If `units` is positive, `micros` must be positive or zero. |
| 2496 | # If `units` is zero, `micros` can be positive, zero, or negative. |
| 2497 | # If `units` is negative, `micros` must be negative or zero. |
| 2498 | # For example -1.75 is represented as `units`=-1 and `micros`=-750,000. |
| 2499 | "units": "A String", # Whole units. |
| 2500 | }, |
| 2501 | }, |
| 2502 | }, |
| 2503 | "startDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Optional. The start date of the job in UTC time zone. Typically this field |
| 2504 | # is used for contracting engagements. |
| 2505 | # Dates prior to 1970/1/1 and invalid date formats are ignored. |
| 2506 | # and time zone are either specified elsewhere or are not significant. The date |
| 2507 | # is relative to the Proleptic Gregorian Calendar. This can represent: |
| 2508 | # |
| 2509 | # * A full date, with non-zero year, month and day values |
| 2510 | # * A month and day value, with a zero year, e.g. an anniversary |
| 2511 | # * A year on its own, with zero month and day values |
| 2512 | # * A year and month value, with a zero day, e.g. a credit card expiration date |
| 2513 | # |
| 2514 | # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. |
| 2515 | "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| 2516 | # a year. |
| 2517 | "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| 2518 | # if specifying a year by itself or a year and month where the day is not |
| 2519 | # significant. |
| 2520 | "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| 2521 | # month and day. |
| 2522 | }, |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2523 | "department": "A String", # Optional. The department or functional area within the company with the open |
| 2524 | # position. |
| 2525 | # |
| 2526 | # The maximum number of allowed characters is 255. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2527 | "applicationEmailList": [ # Optional but at least one of application_urls, |
| 2528 | # application_email_list or application_instruction must be |
| 2529 | # specified. |
| 2530 | # |
| 2531 | # Use this field to specify email address(es) to which resumes or |
| 2532 | # applications can be sent. |
| 2533 | # |
| 2534 | # The maximum number of allowed characters is 255. |
| 2535 | "A String", |
| 2536 | ], |
| 2537 | "companyTitle": "A String", # Deprecated. Use company_display_name instead. |
| 2538 | # |
| 2539 | # Output only. |
| 2540 | # |
| 2541 | # The name of the company listing the job. |
| 2542 | "level": "A String", # Optional. The experience level associated with the job, such as "Entry Level". |
| 2543 | "filterableCustomFields": { # Deprecated. Use custom_attributes instead. |
| 2544 | # |
| 2545 | # Optional. |
| 2546 | # |
| 2547 | # A map of fields to hold filterable custom job attributes not captured by |
| 2548 | # the standard fields such as job_title, company_name, or |
| 2549 | # level. These custom fields store arbitrary |
| 2550 | # string values, and can be used for purposes not covered by |
| 2551 | # the structured fields. For the best search experience, use of the |
| 2552 | # structured rather than custom fields is recommended. |
| 2553 | # |
| 2554 | # Data stored in these custom fields fields are indexed and |
| 2555 | # searched against by keyword searches (see |
| 2556 | # SearchJobsRequest.custom_field_filters][]). |
| 2557 | # |
| 2558 | # The map key must be a number between 1-20. If an invalid key is |
| 2559 | # provided on job create or update, an error is returned. |
| 2560 | "a_key": { # Resource that represents the custom data not captured by the standard fields. |
| 2561 | "values": [ # Optional. The values of the custom data. |
| 2562 | "A String", |
| 2563 | ], |
| 2564 | }, |
| 2565 | }, |
| 2566 | "compensationInfo": { # Job compensation details. # Optional. Job compensation information. |
| 2567 | "entries": [ # Optional. Job compensation information. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2568 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2569 | # At most one entry can be of type |
| 2570 | # CompensationInfo.CompensationType.BASE, which is |
| 2571 | # referred as ** base compensation entry ** for the job. |
| 2572 | { # A compensation entry that represents one component of compensation, such |
| 2573 | # as base pay, bonus, or other compensation type. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2574 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2575 | # Annualization: One compensation entry can be annualized if |
| 2576 | # - it contains valid amount or range. |
| 2577 | # - and its expected_units_per_year is set or can be derived. |
| 2578 | # Its annualized range is determined as (amount or range) times |
| 2579 | # expected_units_per_year. |
| 2580 | "amount": { # Represents an amount of money with its currency type. # Optional. Compensation amount. |
| 2581 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 2582 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 2583 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 2584 | # If `units` is positive, `nanos` must be positive or zero. |
| 2585 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 2586 | # If `units` is negative, `nanos` must be negative or zero. |
| 2587 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 2588 | "units": "A String", # The whole units of the amount. |
| 2589 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 2590 | }, |
| 2591 | "description": "A String", # Optional. Compensation description. For example, could |
| 2592 | # indicate equity terms or provide additional context to an estimated |
| 2593 | # bonus. |
| 2594 | "expectedUnitsPerYear": 3.14, # Optional. Expected number of units paid each year. If not specified, when |
| 2595 | # Job.employment_types is FULLTIME, a default value is inferred |
| 2596 | # based on unit. Default values: |
| 2597 | # - HOURLY: 2080 |
| 2598 | # - DAILY: 260 |
| 2599 | # - WEEKLY: 52 |
| 2600 | # - MONTHLY: 12 |
| 2601 | # - ANNUAL: 1 |
| 2602 | "range": { # Compensation range. # Optional. Compensation range. |
| 2603 | "min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set |
| 2604 | # to zero and the currency code is set to match the |
| 2605 | # currency code of max_compensation. |
| 2606 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 2607 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 2608 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 2609 | # If `units` is positive, `nanos` must be positive or zero. |
| 2610 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 2611 | # If `units` is negative, `nanos` must be negative or zero. |
| 2612 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 2613 | "units": "A String", # The whole units of the amount. |
| 2614 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 2615 | }, |
| 2616 | "max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set |
| 2617 | # to a maximal compensation value and the currency code is set to |
| 2618 | # match the currency code of |
| 2619 | # min_compensation. |
| 2620 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 2621 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 2622 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 2623 | # If `units` is positive, `nanos` must be positive or zero. |
| 2624 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 2625 | # If `units` is negative, `nanos` must be negative or zero. |
| 2626 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 2627 | "units": "A String", # The whole units of the amount. |
| 2628 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 2629 | }, |
| 2630 | }, |
| 2631 | "type": "A String", # Required. Compensation type. |
| 2632 | "unit": "A String", # Optional. Frequency of the specified amount. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2633 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2634 | # Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2635 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2636 | ], |
| 2637 | "annualizedBaseCompensationRange": { # Compensation range. # Output only. Annualized base compensation range. Computed as |
| 2638 | # base compensation entry's CompensationEntry.compensation times |
| 2639 | # CompensationEntry.expected_units_per_year. |
| 2640 | # |
| 2641 | # See CompensationEntry for explanation on compensation annualization. |
| 2642 | "min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set |
| 2643 | # to zero and the currency code is set to match the |
| 2644 | # currency code of max_compensation. |
| 2645 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 2646 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 2647 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 2648 | # If `units` is positive, `nanos` must be positive or zero. |
| 2649 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 2650 | # If `units` is negative, `nanos` must be negative or zero. |
| 2651 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 2652 | "units": "A String", # The whole units of the amount. |
| 2653 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 2654 | }, |
| 2655 | "max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set |
| 2656 | # to a maximal compensation value and the currency code is set to |
| 2657 | # match the currency code of |
| 2658 | # min_compensation. |
| 2659 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 2660 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 2661 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 2662 | # If `units` is positive, `nanos` must be positive or zero. |
| 2663 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 2664 | # If `units` is negative, `nanos` must be negative or zero. |
| 2665 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 2666 | "units": "A String", # The whole units of the amount. |
| 2667 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2668 | }, |
| 2669 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2670 | "amount": { # Represents an amount of money with its currency type. # Deprecated. Use entries instead. |
| 2671 | # |
| 2672 | # Optional. |
| 2673 | # |
| 2674 | # The amount of compensation or pay for the job. |
| 2675 | # As an alternative, compensation_amount_min and |
| 2676 | # compensation_amount_max may be used to define a range of |
| 2677 | # compensation. |
| 2678 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 2679 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 2680 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 2681 | # If `units` is positive, `nanos` must be positive or zero. |
| 2682 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 2683 | # If `units` is negative, `nanos` must be negative or zero. |
| 2684 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 2685 | "units": "A String", # The whole units of the amount. |
| 2686 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 2687 | }, |
| 2688 | "max": { # Represents an amount of money with its currency type. # Deprecated. Use entries instead. |
| 2689 | # |
| 2690 | # Optional. |
| 2691 | # |
| 2692 | # An upper bound on a range for compensation or pay for the job. |
| 2693 | # The currency type is specified in compensation_amount. |
| 2694 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 2695 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 2696 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 2697 | # If `units` is positive, `nanos` must be positive or zero. |
| 2698 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 2699 | # If `units` is negative, `nanos` must be negative or zero. |
| 2700 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 2701 | "units": "A String", # The whole units of the amount. |
| 2702 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 2703 | }, |
| 2704 | "type": "A String", # Deprecated. Use entries instead. |
| 2705 | # |
| 2706 | # Optional. |
| 2707 | # |
| 2708 | # Type of job compensation. |
| 2709 | "min": { # Represents an amount of money with its currency type. # Deprecated. Use entries instead. |
| 2710 | # |
| 2711 | # Optional. |
| 2712 | # |
| 2713 | # A lower bound on a range for compensation or pay for the job. |
| 2714 | # The currency type is specified in compensation_amount. |
| 2715 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 2716 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 2717 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 2718 | # If `units` is positive, `nanos` must be positive or zero. |
| 2719 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 2720 | # If `units` is negative, `nanos` must be negative or zero. |
| 2721 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 2722 | "units": "A String", # The whole units of the amount. |
| 2723 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 2724 | }, |
| 2725 | "annualizedTotalCompensationRange": { # Compensation range. # Output only. Annualized total compensation range. Computed as |
| 2726 | # all compensation entries' CompensationEntry.compensation times |
| 2727 | # CompensationEntry.expected_units_per_year. |
| 2728 | # |
| 2729 | # See CompensationEntry for explanation on compensation annualization. |
| 2730 | "min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set |
| 2731 | # to zero and the currency code is set to match the |
| 2732 | # currency code of max_compensation. |
| 2733 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 2734 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 2735 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 2736 | # If `units` is positive, `nanos` must be positive or zero. |
| 2737 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 2738 | # If `units` is negative, `nanos` must be negative or zero. |
| 2739 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 2740 | "units": "A String", # The whole units of the amount. |
| 2741 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 2742 | }, |
| 2743 | "max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set |
| 2744 | # to a maximal compensation value and the currency code is set to |
| 2745 | # match the currency code of |
| 2746 | # min_compensation. |
| 2747 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 2748 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 2749 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 2750 | # If `units` is positive, `nanos` must be positive or zero. |
| 2751 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 2752 | # If `units` is negative, `nanos` must be negative or zero. |
| 2753 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 2754 | "units": "A String", # The whole units of the amount. |
| 2755 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 2756 | }, |
| 2757 | }, |
| 2758 | }, |
| 2759 | "region": "A String", # Optional. The job Region (for example, state, country) throughout which the job |
| 2760 | # is available. If this field is set, a |
| 2761 | # LocationFilter in a search query within the job region |
| 2762 | # finds this job if an exact location match is not specified. |
| 2763 | # If this field is set, setting job locations |
| 2764 | # to the same location level as this field is strongly recommended. |
| 2765 | "createTime": "A String", # Output only. The timestamp when this job was created. |
| 2766 | "incentives": "A String", # Optional. A description of bonus, commission, and other compensation |
| 2767 | # incentives associated with the job not including salary or pay. |
| 2768 | # |
| 2769 | # The maximum number of allowed characters is 10,000. |
| 2770 | "companyDisplayName": "A String", # Output only. The name of the company listing the job. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2771 | "unindexedCustomFields": { # Deprecated. Use custom_attributes instead. |
| 2772 | # |
| 2773 | # Optional. |
| 2774 | # |
| 2775 | # A map of fields to hold non-filterable custom job attributes, similar to |
| 2776 | # filterable_custom_fields. These fields are distinct in that the data |
| 2777 | # in these fields are not indexed. Therefore, the client cannot search |
| 2778 | # against them, nor can the client use them to list jobs. |
| 2779 | # |
| 2780 | # The key of the map can be any valid string. |
| 2781 | "a_key": { # Resource that represents the custom data not captured by the standard fields. |
| 2782 | "values": [ # Optional. The values of the custom data. |
| 2783 | "A String", |
| 2784 | ], |
| 2785 | }, |
| 2786 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2787 | "visibility": "A String", # Optional. The visibility of the job. |
| 2788 | # Defaults to JobVisibility.PRIVATE if not specified. |
| 2789 | # Currently only JobVisibility.PRIVATE is supported. |
| 2790 | "employmentTypes": [ # Optional. The employment type(s) of a job, for example, |
| 2791 | # full time or |
| 2792 | # part time. |
| 2793 | "A String", |
| 2794 | ], |
| 2795 | "benefits": [ # Optional. The benefits included with the job. |
| 2796 | "A String", |
| 2797 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2798 | "expiryDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Deprecated. Use expire_time instead. |
| 2799 | # |
| 2800 | # Optional but strongly recommended to be provided for the best service |
| 2801 | # experience. |
| 2802 | # |
| 2803 | # The expiration date of the job in UTC time. After 12 am on this date, the |
| 2804 | # job is marked as expired, and it no longer appears in search results. |
| 2805 | # The expired job can't be deleted or listed by the DeleteJob and |
| 2806 | # ListJobs APIs, but it can be retrieved with the GetJob API or |
| 2807 | # updated with the UpdateJob API. An expired job can be updated and |
| 2808 | # opened again by using a future expiration date. It can also remain expired. |
| 2809 | # Updating an expired job to be open fails if there is another existing open |
| 2810 | # job with same requisition_id, company_name and language_code. |
| 2811 | # |
| 2812 | # The expired jobs are retained in our system for 90 days. However, the |
| 2813 | # overall expired job count cannot exceed 3 times the maximum of open jobs |
| 2814 | # count over the past week, otherwise jobs with earlier expire time are |
| 2815 | # removed first. Expired jobs are no longer accessible after they are cleaned |
| 2816 | # out. |
| 2817 | # |
| 2818 | # A valid date range is between 1970/1/1 and 2100/12/31. Invalid dates are |
| 2819 | # ignored and treated as expiry date not provided. |
| 2820 | # |
| 2821 | # If this value is not provided on job creation or is invalid, the job |
| 2822 | # posting expires after 30 days from the job's creation time. For example, if |
| 2823 | # the job was created on 2017/01/01 13:00AM UTC with an unspecified |
| 2824 | # expiration date, the job expires after 2017/01/31 13:00AM UTC. |
| 2825 | # |
| 2826 | # If this value is not provided on job update, it depends on the field masks |
| 2827 | # set by UpdateJobRequest.update_job_fields. If the field masks include |
| 2828 | # expiry_date, or the masks are empty meaning that every field is |
| 2829 | # updated, the job expires after 30 days from the job's last update time. |
| 2830 | # Otherwise the expiration date isn't updated. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2831 | # and time zone are either specified elsewhere or are not significant. The date |
| 2832 | # is relative to the Proleptic Gregorian Calendar. This can represent: |
| 2833 | # |
| 2834 | # * A full date, with non-zero year, month and day values |
| 2835 | # * A month and day value, with a zero year, e.g. an anniversary |
| 2836 | # * A year on its own, with zero month and day values |
| 2837 | # * A year and month value, with a zero day, e.g. a credit card expiration date |
| 2838 | # |
| 2839 | # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2840 | "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| 2841 | # a year. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2842 | "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2843 | # if specifying a year by itself or a year and month where the day is not |
| 2844 | # significant. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2845 | "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| 2846 | # month and day. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2847 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2848 | "companyName": "A String", # Optional but one of company_name or distributor_company_id must be |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2849 | # provided. |
| 2850 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2851 | # The resource name of the company listing the job, such as |
| 2852 | # /companies/foo. This field takes precedence over the |
| 2853 | # distributor-assigned company identifier, distributor_company_id. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2854 | "locations": [ # Optional but strongly recommended for the best service experience. |
| 2855 | # |
| 2856 | # Location(s) where the emploeyer is looking to hire for this job posting. |
| 2857 | # |
| 2858 | # Specifying the full street address(es) of the hiring location enables |
| 2859 | # better API results, especially job searches by commute time. |
| 2860 | # |
| 2861 | # At most 50 locations are allowed for best search performance. If a job has |
| 2862 | # more locations, it is suggested to split it into multiple jobs with unique |
| 2863 | # requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as |
| 2864 | # multiple jobs with the same requisition_id, company_name and |
| 2865 | # language_code are not allowed. If the original requisition_id must |
| 2866 | # be preserved, a custom field should be used for storage. It is also |
| 2867 | # suggested to group the locations that close to each other in the same job |
| 2868 | # for better search experience. |
| 2869 | # |
| 2870 | # The maximum number of allowed characters is 500. |
| 2871 | "A String", |
| 2872 | ], |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2873 | "endDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Optional. The end date of the job in UTC time zone. Typically this field |
| 2874 | # is used for contracting engagements. |
| 2875 | # Dates prior to 1970/1/1 and invalid date formats are ignored. |
| 2876 | # and time zone are either specified elsewhere or are not significant. The date |
| 2877 | # is relative to the Proleptic Gregorian Calendar. This can represent: |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2878 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2879 | # * A full date, with non-zero year, month and day values |
| 2880 | # * A month and day value, with a zero year, e.g. an anniversary |
| 2881 | # * A year on its own, with zero month and day values |
| 2882 | # * A year and month value, with a zero day, e.g. a credit card expiration date |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2883 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2884 | # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. |
| 2885 | "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| 2886 | # a year. |
| 2887 | "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| 2888 | # if specifying a year by itself or a year and month where the day is not |
| 2889 | # significant. |
| 2890 | "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| 2891 | # month and day. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2892 | }, |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2893 | }</pre> |
| 2894 | </div> |
| 2895 | |
| 2896 | <div class="method"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2897 | <code class="details" id="histogram">histogram(body=None, x__xgafv=None)</code> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2898 | <pre>Deprecated. Use SearchJobsRequest.histogram_facets instead to make |
| 2899 | a single call with both search and histogram. |
| 2900 | |
| 2901 | Retrieves a histogram for the given |
| 2902 | GetHistogramRequest. This call provides a structured |
| 2903 | count of jobs that match against the search query, grouped by specified |
| 2904 | facets. |
| 2905 | |
| 2906 | This call constrains the visibility of jobs |
| 2907 | present in the database, and only counts jobs the caller has |
| 2908 | permission to search against. |
| 2909 | |
| 2910 | For example, use this call to generate the |
| 2911 | number of jobs in the U.S. by state. |
| 2912 | |
| 2913 | Args: |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2914 | body: object, The request body. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2915 | The object takes the form of: |
| 2916 | |
| 2917 | { # Deprecated. Use SearchJobsRequest.histogram_facets instead to make |
| 2918 | # a single call with both search and histogram. |
| 2919 | # |
| 2920 | # Input only. |
| 2921 | # |
| 2922 | # A request for the `GetHistogram` method. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2923 | "requestMetadata": { # Input only. # Meta information, such as `user_id`, collected from the job searcher or |
| 2924 | # other entity conducting a job search, is used to improve the service's |
| 2925 | # search quality. Users determine identifier values, which must be |
| 2926 | # unique and consist. |
| 2927 | # |
| 2928 | # Meta information related to the job searcher or entity |
| 2929 | # conducting the job search. This information is used to improve the |
| 2930 | # performance of the service. |
| 2931 | "sessionId": "A String", # Required. A unique session identification string. A session is defined as the |
| 2932 | # duration of an end user's interaction with the service over a period. |
| 2933 | # Obfuscate this field for privacy concerns before |
| 2934 | # providing it to the API. |
| 2935 | # |
| 2936 | # If this field is not available for some reason, please send "UNKNOWN". Note |
| 2937 | # that any improvements to the service model for a particular tenant site, |
| 2938 | # rely on this field being set correctly to some unique session_id. |
| 2939 | "userId": "A String", # Required. A unique user identification string, as determined by the client. The |
| 2940 | # client is responsible for ensuring client-level uniqueness of this value |
| 2941 | # in order to have the strongest positive impact on search quality. |
| 2942 | # Obfuscate this field for privacy concerns before |
| 2943 | # providing it to the service. |
| 2944 | # |
| 2945 | # If this field is not available for some reason, please send "UNKNOWN". Note |
| 2946 | # that any improvements to the service model for a particular tenant site, |
| 2947 | # rely on this field being set correctly to some unique user_id. |
| 2948 | "deviceInfo": { # Input only. # Optional. The type of device used by the job seeker at the time of the call to the |
| 2949 | # service. |
| 2950 | # |
| 2951 | # Device information collected from the job seeker, candidate, or |
| 2952 | # other entity conducting the job search. Providing this information improves |
| 2953 | # the quality of the search results across devices. |
| 2954 | "deviceType": "A String", # Optional. Type of the device. |
| 2955 | "id": "A String", # Optional. A device-specific ID. The ID must be a unique identifier that distinguishes |
| 2956 | # the device from other devices. |
| 2957 | }, |
| 2958 | "domain": "A String", # Required. The client-defined scope or source of the service call, which typically |
| 2959 | # is the domain on |
| 2960 | # which the service has been implemented and is currently being run. |
| 2961 | # |
| 2962 | # For example, if the service is being run by client <em>Foo, Inc.</em>, on |
| 2963 | # job board www.foo.com and career site www.bar.com, then this field is |
| 2964 | # set to "foo.com" for use on the job board, and "bar.com" for use on the |
| 2965 | # career site. |
| 2966 | # |
| 2967 | # If this field is not available for some reason, send "UNKNOWN". Note that |
| 2968 | # any improvements to the service model for a particular tenant site rely on |
| 2969 | # this field being set correctly to some domain. |
| 2970 | }, |
| 2971 | "searchTypes": [ # Required. A list of facets that specify the histogram data to be calculated |
| 2972 | # against and returned. |
| 2973 | # |
| 2974 | # Histogram response times can be slow, and counts |
| 2975 | # can be approximations. This call may be temporarily or permanently removed |
| 2976 | # prior to the production release of Cloud Talent Solution. |
| 2977 | "A String", |
| 2978 | ], |
| 2979 | "allowBroadening": True or False, # Optional. Controls whether to broaden the search to avoid too few results for a |
| 2980 | # given query in instances where a search has sparse results. Results from a |
| 2981 | # broadened query is a superset of the results from the original query. |
| 2982 | # |
| 2983 | # Defaults to false. |
| 2984 | "filters": { # Input only. # Deprecated. Use query instead. |
| 2985 | # |
| 2986 | # Optional. |
| 2987 | # |
| 2988 | # Restrictions on the scope of the histogram. |
| 2989 | # |
| 2990 | # Deprecated. Use JobQuery instead. |
| 2991 | # |
| 2992 | # The filters required to perform a search query or histogram. |
| 2993 | "customAttributeFilter": "A String", # Optional. This filter specifies a structured syntax to match against the |
| 2994 | # Job.custom_attributes that are marked as `filterable`. |
| 2995 | # |
| 2996 | # The syntax for this expression is a subset of Google SQL syntax. |
| 2997 | # |
| 2998 | # Supported operators are: =, !=, <, <=, >, >= where the left of the operator |
| 2999 | # is a custom field key and the right of the operator is a number or string |
| 3000 | # (surrounded by quotes) value. |
| 3001 | # |
| 3002 | # Supported functions are LOWER(<field_name>) to |
| 3003 | # perform case insensitive match and EMPTY(<field_name>) to filter on the |
| 3004 | # existence of a key. |
| 3005 | # |
| 3006 | # Boolean expressions (AND/OR/NOT) are supported up to 3 levels of |
| 3007 | # nesting (For example, "((A AND B AND C) OR NOT D) AND E"), and there can |
| 3008 | # be a maximum of 100 comparisons/functions in the expression. The expression |
| 3009 | # must be < 3000 bytes in length. |
| 3010 | # |
| 3011 | # Sample Query: |
| 3012 | # (key1 = "TEST" OR LOWER(key1)="test" OR NOT EMPTY(key1)) AND key2 > 100 |
| 3013 | "customFieldFilters": { # Deprecated. Use custom_attribute_filter instead. |
| 3014 | # |
| 3015 | # Optional. |
| 3016 | # |
| 3017 | # This filter specifies searching against |
| 3018 | # custom field values. See Job.filterable_custom_fields for information. |
| 3019 | # The key value specifies a number between 1-20 (the service |
| 3020 | # supports 20 custom fields) corresponding to the desired custom field map |
| 3021 | # value. If an invalid key is provided or specified together with |
| 3022 | # custom_attribute_filter, an error is thrown. |
| 3023 | "a_key": { # Input only. |
| 3024 | # |
| 3025 | # Custom field filter of the search. |
| 3026 | "type": "A String", # Optional. The type of filter. |
| 3027 | # Defaults to FilterType.OR. |
| 3028 | "queries": [ # Required. The query strings for the filter. |
| 3029 | "A String", |
| 3030 | ], |
| 3031 | }, |
| 3032 | }, |
| 3033 | "publishDateRange": "A String", # Optional. Jobs published within a range specified by this filter are searched |
| 3034 | # against, for example, DateRange.PAST_MONTH. If a value is not |
| 3035 | # specified, all open jobs are searched against regardless of the |
| 3036 | # date they were published. |
| 3037 | "query": "A String", # Optional. The query filter contains the keywords that match against the job |
| 3038 | # title, description, and location fields. |
| 3039 | # |
| 3040 | # The maximum query size is 255 bytes/characters. |
| 3041 | "tenantJobOnly": True or False, # Deprecated. Do not use this field. |
| 3042 | # |
| 3043 | # This flag controls whether the job search should be restricted to jobs |
| 3044 | # owned by the current user. |
| 3045 | # |
| 3046 | # Defaults to false where all jobs accessible to the |
| 3047 | # user are searched against. |
| 3048 | "locationFilters": [ # Optional. The location filter specifies geo-regions containing the jobs to |
| 3049 | # search against. See LocationFilter for more information. |
| 3050 | # |
| 3051 | # If a location value is not specified, jobs are retrieved |
| 3052 | # from all locations. |
| 3053 | # |
| 3054 | # If multiple values are specified, jobs are retrieved from any of the |
| 3055 | # specified locations. If different values are specified for the |
| 3056 | # LocationFilter.distance_in_miles parameter, the maximum provided |
| 3057 | # distance is used for all locations. |
| 3058 | # |
| 3059 | # At most 5 location filters are allowed. |
| 3060 | { # Input only. |
| 3061 | # |
| 3062 | # Geographic region of the search. |
| 3063 | "name": "A String", # Optional. The address name, such as "Mountain View" or "Bay Area". |
| 3064 | "distanceInMiles": 3.14, # Optional. The distance_in_miles is applied when the location being searched for is |
| 3065 | # identified as a city or smaller. When the location being searched for is a |
| 3066 | # state or larger, this field is ignored. |
| 3067 | "isTelecommute": True or False, # Optional. Allows the client to return jobs without a |
| 3068 | # set location, specifically, telecommuting jobs (telecomuting is considered |
| 3069 | # by the service as a special location. |
| 3070 | # Job.allow_telecommute indicates if a job permits telecommuting. |
| 3071 | # If this field is true, telecommuting jobs are searched, and |
| 3072 | # name and lat_lng are |
| 3073 | # ignored. |
| 3074 | # This filter can be used by itself to search exclusively for telecommuting |
| 3075 | # jobs, or it can be combined with another location |
| 3076 | # filter to search for a combination of job locations, |
| 3077 | # such as "Mountain View" or "telecommuting" jobs. However, when used in |
| 3078 | # combination with other location filters, telecommuting jobs can be |
| 3079 | # treated as less relevant than other jobs in the search response. |
| 3080 | "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 |
| 3081 | # search. This field is ignored if `location_name` is provided. |
| 3082 | # of doubles representing degrees latitude and degrees longitude. Unless |
| 3083 | # specified otherwise, this must conform to the |
| 3084 | # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 |
| 3085 | # standard</a>. Values must be within normalized ranges. |
| 3086 | "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. |
| 3087 | "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. |
| 3088 | }, |
| 3089 | "regionCode": "A String", # Optional. CLDR region code of the country/region of the address. This will be used |
| 3090 | # to address ambiguity of the user-input location, e.g. "Liverpool" |
| 3091 | # against "Liverpool, NY, US" or "Liverpool, UK". |
| 3092 | # |
| 3093 | # Set this field if all the jobs to search against are from a same region, |
| 3094 | # or jobs are world-wide but the job seeker is from a specific region. |
| 3095 | # |
| 3096 | # See http://cldr.unicode.org/ and |
| 3097 | # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html |
| 3098 | # for details. Example: "CH" for Switzerland. |
| 3099 | }, |
| 3100 | ], |
| 3101 | "disableSpellCheck": True or False, # Optional. This flag controls the spell-check feature. If false, the |
| 3102 | # service attempts to correct a misspelled query, |
| 3103 | # for example, "enginee" is corrected to "engineer". |
| 3104 | # |
| 3105 | # Defaults to false: a spell check is performed. |
| 3106 | "compensationFilter": { # Input only. # Optional. This search filter is applied only to |
| 3107 | # Job.compensation_info. For example, if the filter is specified |
| 3108 | # as "Hourly job with per-hour compensation > $15", only jobs that meet |
| 3109 | # this criteria are searched. If a filter is not defined, all open jobs |
| 3110 | # are searched. |
| 3111 | # |
| 3112 | # Filter on job compensation type and amount. |
| 3113 | "type": "A String", # Required. Type of filter. |
| 3114 | "units": [ # Required. Specify desired `base compensation entry's` |
| 3115 | # CompensationInfo.CompensationUnit. |
| 3116 | "A String", |
| 3117 | ], |
| 3118 | "includeJobsWithUnspecifiedCompensationRange": True or False, # Optional. Whether to include jobs whose compensation range is unspecified. |
| 3119 | "range": { # Compensation range. # Optional. Compensation range. |
| 3120 | "min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set |
| 3121 | # to zero and the currency code is set to match the |
| 3122 | # currency code of max_compensation. |
| 3123 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 3124 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 3125 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 3126 | # If `units` is positive, `nanos` must be positive or zero. |
| 3127 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 3128 | # If `units` is negative, `nanos` must be negative or zero. |
| 3129 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 3130 | "units": "A String", # The whole units of the amount. |
| 3131 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 3132 | }, |
| 3133 | "max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set |
| 3134 | # to a maximal compensation value and the currency code is set to |
| 3135 | # match the currency code of |
| 3136 | # min_compensation. |
| 3137 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 3138 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 3139 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 3140 | # If `units` is positive, `nanos` must be positive or zero. |
| 3141 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 3142 | # If `units` is negative, `nanos` must be negative or zero. |
| 3143 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 3144 | "units": "A String", # The whole units of the amount. |
| 3145 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 3146 | }, |
| 3147 | }, |
| 3148 | }, |
| 3149 | "languageCodes": [ # Optional. This filter specifies the locale of jobs to search against, |
| 3150 | # for example, "en-US". |
| 3151 | # |
| 3152 | # If a value is not specified, the search results may contain jobs in any |
| 3153 | # locale. |
| 3154 | # |
| 3155 | # |
| 3156 | # Language codes should be in BCP-47 format, for example, "en-US" or |
| 3157 | # "sr-Latn". For more information, see [Tags for Identifying |
| 3158 | # Languages](https://tools.ietf.org/html/bcp47). |
| 3159 | # |
| 3160 | # At most 10 language code filters are allowed. |
| 3161 | "A String", |
| 3162 | ], |
| 3163 | "extendedCompensationFilter": { # Deprecated. Always use CompensationFilter. # Deprecated. Always use compensation_filter. |
| 3164 | # |
| 3165 | # Optional. |
| 3166 | # |
| 3167 | # This search filter is applied only to |
| 3168 | # Job.extended_compensation_info. For example, if the filter is specified |
| 3169 | # as "Hourly job with per-hour compensation > $15", only jobs that meet |
| 3170 | # these criteria are searched. If a filter is not defined, all open jobs |
| 3171 | # are searched. |
| 3172 | # |
| 3173 | # Input only. |
| 3174 | # |
| 3175 | # Filter on job compensation type and amount. |
| 3176 | "currency": "A String", # Optional. Specify currency in 3-letter |
| 3177 | # [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) format. If |
| 3178 | # unspecified, jobs are returned regardless of currency. |
| 3179 | "type": "A String", # Required. Type of filter. |
| 3180 | "compensationUnits": [ # Required. Specify desired `base compensation entry's` |
| 3181 | # ExtendedCompensationInfo.CompensationUnit. |
| 3182 | "A String", |
| 3183 | ], |
| 3184 | "includeJobWithUnspecifiedCompensationRange": True or False, # Optional. Whether to include jobs whose compensation range is unspecified. |
| 3185 | "compensationRange": { # Deprecated. See CompensationInfo. # Optional. Compensation range. |
| 3186 | # |
| 3187 | # Compensation range. |
| 3188 | "max": { # Deprecated. See CompensationInfo. # Required. Maximum value. |
| 3189 | # |
| 3190 | # Decimal number. |
| 3191 | "micros": 42, # Micro (10^-6) units. |
| 3192 | # The value must be between -999,999 and +999,999 inclusive. |
| 3193 | # If `units` is positive, `micros` must be positive or zero. |
| 3194 | # If `units` is zero, `micros` can be positive, zero, or negative. |
| 3195 | # If `units` is negative, `micros` must be negative or zero. |
| 3196 | # For example -1.75 is represented as `units`=-1 and `micros`=-750,000. |
| 3197 | "units": "A String", # Whole units. |
| 3198 | }, |
| 3199 | "min": { # Deprecated. See CompensationInfo. # Required. Minimum value. |
| 3200 | # |
| 3201 | # Decimal number. |
| 3202 | "micros": 42, # Micro (10^-6) units. |
| 3203 | # The value must be between -999,999 and +999,999 inclusive. |
| 3204 | # If `units` is positive, `micros` must be positive or zero. |
| 3205 | # If `units` is zero, `micros` can be positive, zero, or negative. |
| 3206 | # If `units` is negative, `micros` must be negative or zero. |
| 3207 | # For example -1.75 is represented as `units`=-1 and `micros`=-750,000. |
| 3208 | "units": "A String", # Whole units. |
| 3209 | }, |
| 3210 | }, |
| 3211 | }, |
| 3212 | "commuteFilter": { # Input only. # Optional. Allows filtering jobs by commute time with different travel methods (e.g. |
| 3213 | # driving or public transit). Note: this only works with COMMUTE |
| 3214 | # MODE. When specified, [JobFilters.location_filters] will be |
| 3215 | # ignored. |
| 3216 | # |
| 3217 | # Currently we do not support sorting by commute time. |
| 3218 | # |
| 3219 | # Parameters needed for commute search. |
| 3220 | "roadTraffic": "A String", # Optional. Specifies the traffic density to use when calculating commute time. |
| 3221 | # Must not be present if departure_hour_local is specified. |
| 3222 | "allowNonStreetLevelAddress": True or False, # Optional. If `true`, jobs without street level addresses may also be returned. |
| 3223 | # For city level addresses, the city center is used. For state and coarser |
| 3224 | # level addresses, text matching is used. |
| 3225 | # If this field is set to `false` or is not specified, only jobs that include |
| 3226 | # street level addresses will be returned by commute search. |
| 3227 | "method": "A String", # Required. The method of transportation for which to calculate the commute time. |
| 3228 | "travelTime": "A String", # Required. The maximum travel time in seconds. The maximum allowed value is `3600s` |
| 3229 | # (one hour). Format is `123s`. |
| 3230 | "departureHourLocal": 42, # Optional. The departure hour to use to calculate traffic impact. Accepts an |
| 3231 | # integer between 0 and 23, representing the hour in the time zone of the |
| 3232 | # start_location. Must not be present if road_traffic is specified. |
| 3233 | "startLocation": { # 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 |
| 3234 | # commute time. |
| 3235 | # of doubles representing degrees latitude and degrees longitude. Unless |
| 3236 | # specified otherwise, this must conform to the |
| 3237 | # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 |
| 3238 | # standard</a>. Values must be within normalized ranges. |
| 3239 | "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. |
| 3240 | "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. |
| 3241 | }, |
| 3242 | }, |
| 3243 | "categories": [ # Optional. The category filter specifies the categories of jobs to search against. |
| 3244 | # See Category for more information. |
| 3245 | # |
| 3246 | # If a value is not specified, jobs from any category are searched against. |
| 3247 | # |
| 3248 | # If multiple values are specified, jobs from any of the specified |
| 3249 | # categories are searched against. |
| 3250 | "A String", |
| 3251 | ], |
| 3252 | "companyNames": [ # Optional. The company names filter specifies the company entities to search |
| 3253 | # against. |
| 3254 | # |
| 3255 | # If a value is not specified, jobs are searched for against all companies. |
| 3256 | # |
| 3257 | # If multiple values are specified, jobs are searched against the |
| 3258 | # specified companies. |
| 3259 | # |
| 3260 | # At most 20 company filters are allowed. |
| 3261 | "A String", |
| 3262 | ], |
| 3263 | "companyTitles": [ # Optional. This filter specifies the exact company titles |
| 3264 | # of jobs to search against. |
| 3265 | # |
| 3266 | # If a value is not specified, jobs within the search results can be |
| 3267 | # associated with any company. |
| 3268 | # |
| 3269 | # If multiple values are specified, jobs within the search results may be |
| 3270 | # associated with any of the specified companies. |
| 3271 | # |
| 3272 | # At most 20 company title filters are allowed. |
| 3273 | "A String", |
| 3274 | ], |
| 3275 | "employmentTypes": [ # Optional. The employment type filter specifies the employment type of jobs to |
| 3276 | # search against, such as EmploymentType.FULL_TIME. |
| 3277 | # |
| 3278 | # If a value is not specified, jobs in the search results include any |
| 3279 | # employment type. |
| 3280 | # |
| 3281 | # If multiple values are specified, jobs in the search results include any |
| 3282 | # of the specified employment types. |
| 3283 | "A String", |
| 3284 | ], |
| 3285 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3286 | "query": { # Input only. # Optional. Query used to search against jobs, such as keyword, location filters, etc. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3287 | # |
| 3288 | # The query required to perform a search query or histogram. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3289 | "query": "A String", # Optional. The query string that matches against the job title, description, and |
| 3290 | # location fields. |
| 3291 | # |
| 3292 | # The maximum query size is 255 bytes. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 3293 | "employmentTypes": [ # Optional. The employment type filter specifies the employment type of jobs to |
| 3294 | # search against, such as EmploymentType.FULL_TIME. |
| 3295 | # |
| 3296 | # If a value is not specified, jobs in the search results include any |
| 3297 | # employment type. |
| 3298 | # |
| 3299 | # If multiple values are specified, jobs in the search results include |
| 3300 | # any of the specified employment types. |
| 3301 | "A String", |
| 3302 | ], |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3303 | "compensationFilter": { # Input only. # Optional. This search filter is applied only to |
| 3304 | # Job.compensation_info. For example, if the filter is specified |
| 3305 | # as "Hourly job with per-hour compensation > $15", only jobs meeting |
| 3306 | # these criteria are searched. If a filter isn't defined, all open jobs |
| 3307 | # are searched. |
| 3308 | # |
| 3309 | # Filter on job compensation type and amount. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 3310 | "type": "A String", # Required. Type of filter. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3311 | "units": [ # Required. Specify desired `base compensation entry's` |
| 3312 | # CompensationInfo.CompensationUnit. |
| 3313 | "A String", |
| 3314 | ], |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 3315 | "includeJobsWithUnspecifiedCompensationRange": True or False, # Optional. Whether to include jobs whose compensation range is unspecified. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3316 | "range": { # Compensation range. # Optional. Compensation range. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 3317 | "min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set |
| 3318 | # to zero and the currency code is set to match the |
| 3319 | # currency code of max_compensation. |
| 3320 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 3321 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 3322 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 3323 | # If `units` is positive, `nanos` must be positive or zero. |
| 3324 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 3325 | # If `units` is negative, `nanos` must be negative or zero. |
| 3326 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 3327 | "units": "A String", # The whole units of the amount. |
| 3328 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 3329 | }, |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3330 | "max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set |
| 3331 | # to a maximal compensation value and the currency code is set to |
| 3332 | # match the currency code of |
| 3333 | # min_compensation. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3334 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 3335 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 3336 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 3337 | # If `units` is positive, `nanos` must be positive or zero. |
| 3338 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 3339 | # If `units` is negative, `nanos` must be negative or zero. |
| 3340 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3341 | "units": "A String", # The whole units of the amount. |
| 3342 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3343 | }, |
| 3344 | }, |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3345 | }, |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3346 | "companyDisplayNames": [ # Optional. This filter specifies the exact company display |
| 3347 | # name of the jobs to search against. |
| 3348 | # |
| 3349 | # If a value isn't specified, jobs within the search results are |
| 3350 | # associated with any company. |
| 3351 | # |
| 3352 | # If multiple values are specified, jobs within the search results may be |
| 3353 | # associated with any of the specified companies. |
| 3354 | # |
| 3355 | # At most 20 company display name filters are allowed. |
| 3356 | "A String", |
| 3357 | ], |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 3358 | "commuteFilter": { # Input only. # Optional. Allows filtering jobs by commute time with different travel methods (for |
| 3359 | # example, driving or public transit). Note: This only works with COMMUTE |
| 3360 | # MODE. When specified, [JobQuery.location_filters] is |
| 3361 | # ignored. |
| 3362 | # |
| 3363 | # Currently we don't support sorting by commute time. |
| 3364 | # |
| 3365 | # Parameters needed for commute search. |
| 3366 | "roadTraffic": "A String", # Optional. Specifies the traffic density to use when calculating commute time. |
| 3367 | # Must not be present if departure_hour_local is specified. |
| 3368 | "allowNonStreetLevelAddress": True or False, # Optional. If `true`, jobs without street level addresses may also be returned. |
| 3369 | # For city level addresses, the city center is used. For state and coarser |
| 3370 | # level addresses, text matching is used. |
| 3371 | # If this field is set to `false` or is not specified, only jobs that include |
| 3372 | # street level addresses will be returned by commute search. |
| 3373 | "method": "A String", # Required. The method of transportation for which to calculate the commute time. |
| 3374 | "travelTime": "A String", # Required. The maximum travel time in seconds. The maximum allowed value is `3600s` |
| 3375 | # (one hour). Format is `123s`. |
| 3376 | "departureHourLocal": 42, # Optional. The departure hour to use to calculate traffic impact. Accepts an |
| 3377 | # integer between 0 and 23, representing the hour in the time zone of the |
| 3378 | # start_location. Must not be present if road_traffic is specified. |
| 3379 | "startLocation": { # 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 |
| 3380 | # commute time. |
| 3381 | # of doubles representing degrees latitude and degrees longitude. Unless |
| 3382 | # specified otherwise, this must conform to the |
| 3383 | # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 |
| 3384 | # standard</a>. Values must be within normalized ranges. |
| 3385 | "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. |
| 3386 | "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. |
| 3387 | }, |
| 3388 | }, |
| 3389 | "locationFilters": [ # Optional. The location filter specifies geo-regions containing the jobs to |
| 3390 | # search against. See LocationFilter for more information. |
| 3391 | # |
| 3392 | # If a location value isn't specified, jobs fitting the other search |
| 3393 | # criteria are retrieved regardless of where they're located. |
| 3394 | # |
| 3395 | # If multiple values are specified, jobs are retrieved from any of the |
| 3396 | # specified locations. If different values are specified for the |
| 3397 | # LocationFilter.distance_in_miles parameter, the maximum provided |
| 3398 | # distance is used for all locations. |
| 3399 | # |
| 3400 | # At most 5 location filters are allowed. |
| 3401 | { # Input only. |
| 3402 | # |
| 3403 | # Geographic region of the search. |
| 3404 | "name": "A String", # Optional. The address name, such as "Mountain View" or "Bay Area". |
| 3405 | "distanceInMiles": 3.14, # Optional. The distance_in_miles is applied when the location being searched for is |
| 3406 | # identified as a city or smaller. When the location being searched for is a |
| 3407 | # state or larger, this field is ignored. |
| 3408 | "isTelecommute": True or False, # Optional. Allows the client to return jobs without a |
| 3409 | # set location, specifically, telecommuting jobs (telecomuting is considered |
| 3410 | # by the service as a special location. |
| 3411 | # Job.allow_telecommute indicates if a job permits telecommuting. |
| 3412 | # If this field is true, telecommuting jobs are searched, and |
| 3413 | # name and lat_lng are |
| 3414 | # ignored. |
| 3415 | # This filter can be used by itself to search exclusively for telecommuting |
| 3416 | # jobs, or it can be combined with another location |
| 3417 | # filter to search for a combination of job locations, |
| 3418 | # such as "Mountain View" or "telecommuting" jobs. However, when used in |
| 3419 | # combination with other location filters, telecommuting jobs can be |
| 3420 | # treated as less relevant than other jobs in the search response. |
| 3421 | "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 |
| 3422 | # search. This field is ignored if `location_name` is provided. |
| 3423 | # of doubles representing degrees latitude and degrees longitude. Unless |
| 3424 | # specified otherwise, this must conform to the |
| 3425 | # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 |
| 3426 | # standard</a>. Values must be within normalized ranges. |
| 3427 | "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. |
| 3428 | "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. |
| 3429 | }, |
| 3430 | "regionCode": "A String", # Optional. CLDR region code of the country/region of the address. This will be used |
| 3431 | # to address ambiguity of the user-input location, e.g. "Liverpool" |
| 3432 | # against "Liverpool, NY, US" or "Liverpool, UK". |
| 3433 | # |
| 3434 | # Set this field if all the jobs to search against are from a same region, |
| 3435 | # or jobs are world-wide but the job seeker is from a specific region. |
| 3436 | # |
| 3437 | # See http://cldr.unicode.org/ and |
| 3438 | # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html |
| 3439 | # for details. Example: "CH" for Switzerland. |
| 3440 | }, |
| 3441 | ], |
| 3442 | "languageCodes": [ # Optional. This filter specifies the locale of jobs to search against, |
| 3443 | # for example, "en-US". |
| 3444 | # |
| 3445 | # If a value isn't specified, the search results can contain jobs in any |
| 3446 | # locale. |
| 3447 | # |
| 3448 | # |
| 3449 | # Language codes should be in BCP-47 format, such as "en-US" or "sr-Latn". |
| 3450 | # For more information, see |
| 3451 | # [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). |
| 3452 | # |
| 3453 | # At most 10 language code filters are allowed. |
| 3454 | "A String", |
| 3455 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3456 | "companyNames": [ # Optional. This filter specifies the company entities to search against. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3457 | # |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3458 | # If a value isn't specified, jobs are searched for against all |
| 3459 | # companies. |
| 3460 | # |
| 3461 | # If multiple values are specified, jobs are searched against the |
| 3462 | # companies specified. |
| 3463 | # |
| 3464 | # At most 20 company filters are allowed. |
| 3465 | "A String", |
| 3466 | ], |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 3467 | "disableSpellCheck": True or False, # Optional. This flag controls the spell-check feature. If false, the |
| 3468 | # service attempts to correct a misspelled query, |
| 3469 | # for example, "enginee" is corrected to "engineer". |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3470 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 3471 | # Defaults to false: a spell check is performed. |
| 3472 | "publishDateRange": "A String", # Optional. Jobs published within a range specified by this filter are searched |
| 3473 | # against, for example, DateRange.PAST_MONTH. If a value isn't |
| 3474 | # specified, all open jobs are searched against regardless of their |
| 3475 | # published date. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3476 | "categories": [ # Optional. The category filter specifies the categories of jobs to search against. |
| 3477 | # See Category for more information. |
| 3478 | # |
| 3479 | # If a value is not specified, jobs from any category are searched against. |
| 3480 | # |
| 3481 | # If multiple values are specified, jobs from any of the specified |
| 3482 | # categories are searched against. |
| 3483 | "A String", |
| 3484 | ], |
| 3485 | "customAttributeFilter": "A String", # Optional. This filter specifies a structured syntax to match against the |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3486 | # Job.custom_attributes marked as `filterable`. |
| 3487 | # |
| 3488 | # The syntax for this expression is a subset of Google SQL syntax. |
| 3489 | # |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3490 | # Supported operators are: =, !=, <, <=, >, >= where the left of the operator |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3491 | # is a custom field key and the right of the operator is a number or string |
| 3492 | # (surrounded by quotes) value. |
| 3493 | # |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3494 | # Supported functions are LOWER(<field_name>) to |
| 3495 | # perform case insensitive match and EMPTY(<field_name>) to filter on the |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3496 | # existence of a key. |
| 3497 | # |
| 3498 | # Boolean expressions (AND/OR/NOT) are supported up to 3 levels of |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3499 | # nesting (for example, "((A AND B AND C) OR NOT D) AND E"), a maximum of 50 |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3500 | # comparisons/functions are allowed in the expression. The expression |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3501 | # must be < 2000 characters in length. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3502 | # |
| 3503 | # Sample Query: |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3504 | # (key1 = "TEST" OR LOWER(key1)="test" OR NOT EMPTY(key1)) AND key2 > 100 |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3505 | }, |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3506 | } |
| 3507 | |
| 3508 | x__xgafv: string, V1 error format. |
| 3509 | Allowed values |
| 3510 | 1 - v1 error format |
| 3511 | 2 - v2 error format |
| 3512 | |
| 3513 | Returns: |
| 3514 | An object of the form: |
| 3515 | |
| 3516 | { # Deprecated. Use SearchJobsRequest.histogram_facets instead to make |
| 3517 | # a single call with both search and histogram. |
| 3518 | # |
| 3519 | # Output only. |
| 3520 | # |
| 3521 | # The response of the GetHistogram method. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3522 | "results": [ # The Histogram results. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3523 | { # Output only. |
| 3524 | # |
| 3525 | # Result of a histogram call. The response contains the histogram map for the |
| 3526 | # search type specified by HistogramResult.field. |
| 3527 | # The response is a map of each filter value to the corresponding count of |
| 3528 | # jobs for that filter. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3529 | "values": { # A map from the values of field to the number of jobs with that value |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3530 | # in this search result. |
| 3531 | # |
| 3532 | # Key: search type (filter names, such as the companyName). |
| 3533 | # |
| 3534 | # Values: the count of jobs that match the filter for this search. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3535 | "a_key": 42, |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3536 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3537 | "searchType": "A String", # The Histogram search filters. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3538 | }, |
| 3539 | ], |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 3540 | "metadata": { # Output only. # Additional information for the API invocation, such as the request |
| 3541 | # tracking id. |
| 3542 | # |
| 3543 | # Additional information returned to client, such as debugging |
| 3544 | # information. |
| 3545 | "mode": "A String", # For search response only. Indicates the mode of a performed search. |
| 3546 | "experimentIdList": [ # Identifiers for the versions of the search algorithm used during |
| 3547 | # this API invocation if multiple algorithms are used. |
| 3548 | # The default value is empty. |
| 3549 | # For search response only. |
| 3550 | 42, |
| 3551 | ], |
| 3552 | "requestId": "A String", # A unique id associated with this call. |
| 3553 | # This id is logged for tracking purposes. |
| 3554 | }, |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3555 | }</pre> |
| 3556 | </div> |
| 3557 | |
| 3558 | <div class="method"> |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 3559 | <code class="details" id="list">list(filter=None, pageToken=None, pageSize=None, idsOnly=None, x__xgafv=None)</code> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3560 | <pre>Lists jobs by filter. |
| 3561 | |
| 3562 | Args: |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3563 | 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] | 3564 | |
| 3565 | Supported operator: =, AND |
| 3566 | |
| 3567 | The fields eligible for filtering are: |
| 3568 | |
| 3569 | * `companyName` (Required) |
| 3570 | * `requisitionId` (Optional) |
| 3571 | |
| 3572 | Sample Query: |
| 3573 | |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3574 | * companyName = "companies/123" |
| 3575 | * companyName = "companies/123" AND requisitionId = "req-1" |
| 3576 | pageToken: string, Optional. The starting point of a query result. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3577 | pageSize: integer, Optional. The maximum number of jobs to be returned per page of results. |
| 3578 | |
| 3579 | If ids_only is set to true, the maximum allowed page size |
| 3580 | is 1000. Otherwise, the maximum allowed page size is 100. |
| 3581 | |
| 3582 | Default is 100 if empty or a number < 1 is specified. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 3583 | idsOnly: boolean, Optional. If set to `true`, only Job.name, Job.requisition_id and |
| 3584 | Job.language_code will be returned. |
| 3585 | |
| 3586 | A typical use case is to synchronize job repositories. |
| 3587 | |
| 3588 | Defaults to false. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3589 | x__xgafv: string, V1 error format. |
| 3590 | Allowed values |
| 3591 | 1 - v1 error format |
| 3592 | 2 - v2 error format |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3593 | |
| 3594 | Returns: |
| 3595 | An object of the form: |
| 3596 | |
| 3597 | { # Output only. |
| 3598 | # |
| 3599 | # List jobs response. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3600 | "jobs": [ # The Jobs for a given company. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3601 | # |
| 3602 | # The maximum number of items returned is based on the limit field |
| 3603 | # provided in the request. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3604 | { # A Job resource represents a job posting (also referred to as a "job listing" |
| 3605 | # 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] | 3606 | # entity responsible for the job. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 3607 | "languageCode": "A String", # Optional. The language of the posting. This field is distinct from |
| 3608 | # any requirements for fluency that are associated with the job. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3609 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 3610 | # Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn". |
| 3611 | # For more information, see |
| 3612 | # [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){: |
| 3613 | # class="external" target="_blank" }. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3614 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 3615 | # If this field is unspecified and Job.description is present, detected |
| 3616 | # language code based on Job.description is assigned, otherwise |
| 3617 | # defaults to 'en_US'. |
| 3618 | "educationLevels": [ # Optional. The desired education level for the job, such as |
| 3619 | # "Bachelors", "Masters", "Doctorate". |
| 3620 | "A String", |
| 3621 | ], |
| 3622 | "description": "A String", # Required. The description of the job, which typically includes a multi-paragraph |
| 3623 | # description of the company and related information. Separate fields are |
| 3624 | # provided on the job object for responsibilities, |
| 3625 | # qualifications, and other job characteristics. Use of |
| 3626 | # these separate job fields is recommended. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3627 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 3628 | # This field accepts and sanitizes HTML input, and also accepts |
| 3629 | # bold, italic, ordered list, and unordered list markup tags. |
| 3630 | # |
| 3631 | # The maximum number of allowed characters is 100,000. |
| 3632 | "updateTime": "A String", # Output only. The timestamp when this job was last updated. |
| 3633 | "promotionValue": 42, # Optional. A promotion value of the job, as determined by the client. |
| 3634 | # The value determines the sort order of the jobs returned when searching for |
| 3635 | # jobs using the featured jobs search call, with higher promotional values |
| 3636 | # being returned first and ties being resolved by relevance sort. Only the |
| 3637 | # jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH. |
| 3638 | # |
| 3639 | # Default value is 0, and negative values are treated as 0. |
| 3640 | "qualifications": "A String", # Optional. A description of the qualifications required to perform the |
| 3641 | # job. The use of this field is recommended |
| 3642 | # as an alternative to using the more general description field. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3643 | # |
| 3644 | # This field accepts and sanitizes HTML input, and also accepts |
| 3645 | # bold, italic, ordered list, and unordered list markup tags. |
| 3646 | # |
| 3647 | # The maximum number of allowed characters is 10,000. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 3648 | "customAttributes": { # Optional. A map of fields to hold both filterable and non-filterable custom job |
| 3649 | # attributes that are not covered by the provided structured fields. |
| 3650 | # |
| 3651 | # This field is a more general combination of the deprecated id-based |
| 3652 | # filterable_custom_fields and string-based |
| 3653 | # non_filterable_custom_fields. |
| 3654 | # |
| 3655 | # The keys of the map are strings up to 64 bytes and must match the |
| 3656 | # pattern: a-zA-Z*. |
| 3657 | # |
| 3658 | # At most 100 filterable and at most 100 unfilterable keys are supported. |
| 3659 | # For filterable `string_values`, across all keys at most 200 values are |
| 3660 | # allowed, with each string no more than 255 characters. For unfilterable |
| 3661 | # `string_values`, the maximum total size of `string_values` across all keys |
| 3662 | # is 50KB. |
| 3663 | "a_key": { # Custom attribute values that are either filterable or non-filterable. |
| 3664 | "longValue": "A String", # Optional but at least one of string_values or long_value must |
| 3665 | # be specified. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3666 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 3667 | # This field is used to perform number range search. |
| 3668 | # (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`. For |
| 3669 | # `long_value`, a value between Long.MIN and Long.MAX is allowed. |
| 3670 | "filterable": True or False, # Optional. If the `filterable` flag is true, custom field values are searchable. |
| 3671 | # If false, values are not searchable. |
| 3672 | # |
| 3673 | # Default is false. |
| 3674 | "stringValues": { # Represents array of string values. # Optional but at least one of string_values or long_value must |
| 3675 | # be specified. |
| 3676 | # |
| 3677 | # This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or |
| 3678 | # `CASE_INSENSITIVE_MATCH`) search. |
| 3679 | # For filterable `string_values`, a maximum total number of 200 values |
| 3680 | # is allowed, with each `string_value` has a byte size of no more than |
| 3681 | # 255B. For unfilterable `string_values`, the maximum total byte size of |
| 3682 | # unfilterable `string_values` is 50KB. |
| 3683 | # |
| 3684 | # Empty strings are not allowed. |
| 3685 | "values": [ # Required. String values. |
| 3686 | "A String", |
| 3687 | ], |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3688 | }, |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3689 | }, |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3690 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 3691 | "applicationUrls": [ # Optional but at least one of application_urls, |
| 3692 | # application_email_list or application_instruction must be |
| 3693 | # specified. |
| 3694 | # |
| 3695 | # Use this URL field to direct an applicant to a website, for example to |
| 3696 | # link to an online application form. |
| 3697 | # |
| 3698 | # The maximum number of allowed characters is 2,000. |
| 3699 | "A String", |
| 3700 | ], |
| 3701 | "requisitionId": "A String", # Required. The requisition ID, also referred to as the posting ID, assigned by the |
| 3702 | # client to identify a job. This field is intended to be used by clients |
| 3703 | # for client identification and tracking of listings. A job is not allowed |
| 3704 | # to be created if there is another job with the same requisition_id, |
| 3705 | # company_name and language_code. |
| 3706 | # |
| 3707 | # The maximum number of allowed characters is 255. |
| 3708 | "jobLocations": [ # Output only. Structured locations of the job, resolved from locations. |
| 3709 | { # Output only. |
| 3710 | # |
| 3711 | # A resource that represents a location with full geographic |
| 3712 | # information. |
| 3713 | "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair. |
| 3714 | # of doubles representing degrees latitude and degrees longitude. Unless |
| 3715 | # specified otherwise, this must conform to the |
| 3716 | # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 |
| 3717 | # standard</a>. Values must be within normalized ranges. |
| 3718 | "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. |
| 3719 | "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. |
| 3720 | }, |
| 3721 | "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information, |
| 3722 | # such as postal delivery and payments addresses. Given a postal address, |
| 3723 | # a postal service can deliver items to a premises, P.O. Box, or other |
| 3724 | # delivery location. |
| 3725 | # Given a postal address, a postal service can deliver items to a premise, P.O. |
| 3726 | # Box or similar. |
| 3727 | # It is not intended to model geographical locations (roads, towns, |
| 3728 | # mountains). |
| 3729 | # |
| 3730 | # In typical usage an address would be created via user input or from importing |
| 3731 | # existing data, depending on the type of process. |
| 3732 | # |
| 3733 | # Advice on address input / editing: |
| 3734 | # - Use an i18n-ready address widget such as |
| 3735 | # https://github.com/google/libaddressinput) |
| 3736 | # - Users should not be presented with UI elements for input or editing of |
| 3737 | # fields outside countries where that field is used. |
| 3738 | # |
| 3739 | # For more guidance on how to use this schema, please see: |
| 3740 | # https://support.google.com/business/answer/6397478 |
| 3741 | "sublocality": "A String", # Optional. Sublocality of the address. |
| 3742 | # For example, this can be neighborhoods, boroughs, districts. |
| 3743 | "recipients": [ # Optional. The recipient at the address. |
| 3744 | # This field may, under certain circumstances, contain multiline information. |
| 3745 | # For example, it might contain "care of" information. |
| 3746 | "A String", |
| 3747 | ], |
| 3748 | "locality": "A String", # Optional. Generally refers to the city/town portion of the address. |
| 3749 | # Examples: US city, IT comune, UK post town. |
| 3750 | # In regions of the world where localities are not well defined or do not fit |
| 3751 | # into this structure well, leave locality empty and use address_lines. |
| 3752 | "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This |
| 3753 | # is never inferred and it is up to the user to ensure the value is |
| 3754 | # correct. See http://cldr.unicode.org/ and |
| 3755 | # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html |
| 3756 | # for details. Example: "CH" for Switzerland. |
| 3757 | "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if |
| 3758 | # known). This is often the UI language of the input form or is expected |
| 3759 | # to match one of the languages used in the address' country/region, or their |
| 3760 | # transliterated equivalents. |
| 3761 | # This can affect formatting in certain countries, but is not critical |
| 3762 | # to the correctness of the data and will never affect any validation or |
| 3763 | # other non-formatting related operations. |
| 3764 | # |
| 3765 | # If this value is not known, it should be omitted (rather than specifying a |
| 3766 | # possibly incorrect default). |
| 3767 | # |
| 3768 | # Examples: "zh-Hant", "ja", "ja-Latn", "en". |
| 3769 | "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require |
| 3770 | # postal codes to be present, but where they are used, they may trigger |
| 3771 | # additional validation with other parts of the address (e.g. state/zip |
| 3772 | # validation in the U.S.A.). |
| 3773 | "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal |
| 3774 | # addresses of a country or region. |
| 3775 | # For example, this can be a state, a province, an oblast, or a prefecture. |
| 3776 | # Specifically, for Spain this is the province and not the autonomous |
| 3777 | # community (e.g. "Barcelona" and not "Catalonia"). |
| 3778 | # Many countries don't use an administrative area in postal addresses. E.g. |
| 3779 | # in Switzerland this should be left unpopulated. |
| 3780 | "addressLines": [ # Unstructured address lines describing the lower levels of an address. |
| 3781 | # |
| 3782 | # Because values in address_lines do not have type information and may |
| 3783 | # sometimes contain multiple values in a single field (e.g. |
| 3784 | # "Austin, TX"), it is important that the line order is clear. The order of |
| 3785 | # address lines should be "envelope order" for the country/region of the |
| 3786 | # address. In places where this can vary (e.g. Japan), address_language is |
| 3787 | # used to make it explicit (e.g. "ja" for large-to-small ordering and |
| 3788 | # "ja-Latn" or "en" for small-to-large). This way, the most specific line of |
| 3789 | # an address can be selected based on the language. |
| 3790 | # |
| 3791 | # The minimum permitted structural representation of an address consists |
| 3792 | # of a region_code with all remaining information placed in the |
| 3793 | # address_lines. It would be possible to format such an address very |
| 3794 | # approximately without geocoding, but no semantic reasoning could be |
| 3795 | # made about any of the address components until it was at least |
| 3796 | # partially resolved. |
| 3797 | # |
| 3798 | # Creating an address only containing a region_code and address_lines, and |
| 3799 | # then geocoding is the recommended way to handle completely unstructured |
| 3800 | # addresses (as opposed to guessing which parts of the address should be |
| 3801 | # localities or administrative areas). |
| 3802 | "A String", |
| 3803 | ], |
| 3804 | "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used |
| 3805 | # in most regions. Where it is used, the value is either a string like |
| 3806 | # "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number |
| 3807 | # alone, representing the "sector code" (Jamaica), "delivery area indicator" |
| 3808 | # (Malawi) or "post office indicator" (e.g. Côte d'Ivoire). |
| 3809 | "organization": "A String", # Optional. The name of the organization at the address. |
| 3810 | "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is |
| 3811 | # the latest revision. |
| 3812 | # |
| 3813 | # All new revisions **must** be backward compatible with old revisions. |
| 3814 | }, |
| 3815 | "locationType": "A String", # The type of a location, which corresponds to the address lines field of |
| 3816 | # PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of |
| 3817 | # LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of |
| 3818 | # LocationType#LOCALITY. |
| 3819 | "radiusMeters": 3.14, # Radius in meters of the job location. This value is derived from the |
| 3820 | # location bounding box in which a circle with the specified radius |
| 3821 | # centered from LatLng coves the area associated with the job location. |
| 3822 | # For example, currently, "Mountain View, CA, USA" has a radius of |
| 3823 | # 7885.79 meters. |
| 3824 | }, |
| 3825 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3826 | "expireTime": "A String", # Optional but strongly recommended for the best service |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3827 | # experience. |
| 3828 | # |
| 3829 | # The expiration timestamp of the job. After this timestamp, the |
| 3830 | # job is marked as expired, and it no longer appears in search results. The |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3831 | # expired job can't be deleted or listed by the DeleteJob and |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3832 | # ListJobs APIs, but it can be retrieved with the GetJob API or |
| 3833 | # updated with the UpdateJob API. An expired job can be updated and |
| 3834 | # opened again by using a future expiration timestamp. Updating an expired |
| 3835 | # job fails if there is another existing open job with same |
| 3836 | # requisition_id, company_name and language_code. |
| 3837 | # |
| 3838 | # The expired jobs are retained in our system for 90 days. However, the |
| 3839 | # overall expired job count cannot exceed 3 times the maximum of open jobs |
| 3840 | # count over the past week, otherwise jobs with earlier expire time are |
| 3841 | # cleaned first. Expired jobs are no longer accessible after they are cleaned |
| 3842 | # out. |
| 3843 | # The format of this field is RFC 3339 date strings. Example: |
| 3844 | # 2000-01-01T00:00:00.999999999Z |
| 3845 | # See |
| 3846 | # [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt). |
| 3847 | # |
| 3848 | # A valid date range is between 1970-01-01T00:00:00.0Z and |
| 3849 | # 2100-12-31T23:59:59.999Z. Invalid dates are ignored and treated as expire |
| 3850 | # time not provided. |
| 3851 | # |
| 3852 | # If this value is not provided at the time of job creation or is invalid, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3853 | # the job posting expires after 30 days from the job's creation time. For |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3854 | # example, if the job was created on 2017/01/01 13:00AM UTC with an |
| 3855 | # unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC. |
| 3856 | # |
| 3857 | # If this value is not provided but expiry_date is, expiry_date is |
| 3858 | # used. |
| 3859 | # |
| 3860 | # If this value is not provided on job update, it depends on the field masks |
| 3861 | # set by UpdateJobRequest.update_job_fields. If the field masks include |
| 3862 | # expiry_time, or the masks are empty meaning that every field is |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3863 | # updated, the job posting expires after 30 days from the job's last |
| 3864 | # update time. Otherwise the expiration date isn't updated. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 3865 | "name": "A String", # Required during job update. |
| 3866 | # |
| 3867 | # Resource name assigned to a job by the API, for example, "/jobs/foo". Use |
| 3868 | # of this field in job queries and API calls is preferred over the use of |
| 3869 | # requisition_id since this value is unique. |
| 3870 | "jobTitle": "A String", # Required. The title of the job, such as "Software Engineer" |
| 3871 | # |
| 3872 | # The maximum number of allowed characters is 500. |
| 3873 | "referenceUrl": "A String", # Output only. The URL of a web page that displays job details. |
| 3874 | "responsibilities": "A String", # Optional. A description of job responsibilities. The use of this field is |
| 3875 | # recommended as an alternative to using the more general description |
| 3876 | # field. |
| 3877 | # |
| 3878 | # This field accepts and sanitizes HTML input, and also accepts |
| 3879 | # bold, italic, ordered list, and unordered list markup tags. |
| 3880 | # |
| 3881 | # The maximum number of allowed characters is 10,000. |
| 3882 | "distributorCompanyId": "A String", # Optional but one of company_name or distributor_company_id must be |
| 3883 | # provided. |
| 3884 | # |
| 3885 | # A unique company identifier used by job distributors to identify an |
| 3886 | # employer's company entity. company_name takes precedence over |
| 3887 | # this field, and is the recommended field to use to identify companies. |
| 3888 | # |
| 3889 | # The maximum number of allowed characters is 255. |
| 3890 | "publishDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Optional. The date this job was most recently published in UTC format. The default |
| 3891 | # value is the time the request arrives at the server. |
| 3892 | # and time zone are either specified elsewhere or are not significant. The date |
| 3893 | # is relative to the Proleptic Gregorian Calendar. This can represent: |
| 3894 | # |
| 3895 | # * A full date, with non-zero year, month and day values |
| 3896 | # * A month and day value, with a zero year, e.g. an anniversary |
| 3897 | # * A year on its own, with zero month and day values |
| 3898 | # * A year and month value, with a zero day, e.g. a credit card expiration date |
| 3899 | # |
| 3900 | # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. |
| 3901 | "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| 3902 | # a year. |
| 3903 | "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| 3904 | # if specifying a year by itself or a year and month where the day is not |
| 3905 | # significant. |
| 3906 | "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| 3907 | # month and day. |
| 3908 | }, |
| 3909 | "applicationInstruction": "A String", # Optional but at least one of application_urls, |
| 3910 | # application_email_list or application_instruction must be |
| 3911 | # specified. |
| 3912 | # |
| 3913 | # Use this field to provide instructions, such as "Mail your application |
| 3914 | # to ...", that a candidate can follow to apply for the job. |
| 3915 | # |
| 3916 | # This field accepts and sanitizes HTML input, and also accepts |
| 3917 | # bold, italic, ordered list, and unordered list markup tags. |
| 3918 | # |
| 3919 | # The maximum number of allowed characters is 3,000. |
| 3920 | "extendedCompensationInfo": { # Deprecated. Use CompensationInfo. # Deprecated. Always use compensation_info. |
| 3921 | # |
| 3922 | # Optional. |
| 3923 | # |
| 3924 | # Job compensation information. |
| 3925 | # |
| 3926 | # This field replaces compensation_info. Only |
| 3927 | # CompensationInfo.entries or extended_compensation_info can be set, |
| 3928 | # otherwise an exception is thrown. |
| 3929 | # |
| 3930 | # Describes job compensation. |
| 3931 | "annualizedBaseCompensationRange": { # Deprecated. See CompensationInfo. # Output only. Annualized base compensation range. |
| 3932 | # |
| 3933 | # Compensation range. |
| 3934 | "max": { # Deprecated. See CompensationInfo. # Required. Maximum value. |
| 3935 | # |
| 3936 | # Decimal number. |
| 3937 | "micros": 42, # Micro (10^-6) units. |
| 3938 | # The value must be between -999,999 and +999,999 inclusive. |
| 3939 | # If `units` is positive, `micros` must be positive or zero. |
| 3940 | # If `units` is zero, `micros` can be positive, zero, or negative. |
| 3941 | # If `units` is negative, `micros` must be negative or zero. |
| 3942 | # For example -1.75 is represented as `units`=-1 and `micros`=-750,000. |
| 3943 | "units": "A String", # Whole units. |
| 3944 | }, |
| 3945 | "min": { # Deprecated. See CompensationInfo. # Required. Minimum value. |
| 3946 | # |
| 3947 | # Decimal number. |
| 3948 | "micros": 42, # Micro (10^-6) units. |
| 3949 | # The value must be between -999,999 and +999,999 inclusive. |
| 3950 | # If `units` is positive, `micros` must be positive or zero. |
| 3951 | # If `units` is zero, `micros` can be positive, zero, or negative. |
| 3952 | # If `units` is negative, `micros` must be negative or zero. |
| 3953 | # For example -1.75 is represented as `units`=-1 and `micros`=-750,000. |
| 3954 | "units": "A String", # Whole units. |
| 3955 | }, |
| 3956 | }, |
| 3957 | "annualizedTotalCompensationUnspecified": True or False, # Output only. Indicates annualized total compensation range cannot be derived, due to |
| 3958 | # the job's all CompensationEntry cannot be annualized. |
| 3959 | # See CompensationEntry for explanation on annualization and base |
| 3960 | # compensation entry. |
| 3961 | "currency": "A String", # Optional. A 3-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) |
| 3962 | # currency code. |
| 3963 | "annualizedBaseCompensationUnspecified": True or False, # Output only. Indicates annualized base compensation range cannot be derived, due to |
| 3964 | # the job's base compensation entry cannot be annualized. |
| 3965 | # See CompensationEntry for explanation on annualization and base |
| 3966 | # compensation entry. |
| 3967 | "entries": [ # Optional. Job compensation information. |
| 3968 | # |
| 3969 | # At most one entry can be of type |
| 3970 | # ExtendedCompensationInfo.CompensationType.BASE, which is |
| 3971 | # referred as ** base compensation entry ** for the job. |
| 3972 | { # Deprecated. See CompensationInfo. |
| 3973 | # |
| 3974 | # A compensation entry that represents one component of compensation, such |
| 3975 | # as base pay, bonus, or other compensation type. |
| 3976 | # |
| 3977 | # Annualization: One compensation entry can be annualized if |
| 3978 | # - it contains valid amount or range. |
| 3979 | # - and its expected_units_per_year is set or can be derived. |
| 3980 | # Its annualized range is determined as (amount or range) times |
| 3981 | # expected_units_per_year. |
| 3982 | "range": { # Deprecated. See CompensationInfo. # Optional. Compensation range. |
| 3983 | # |
| 3984 | # Compensation range. |
| 3985 | "max": { # Deprecated. See CompensationInfo. # Required. Maximum value. |
| 3986 | # |
| 3987 | # Decimal number. |
| 3988 | "micros": 42, # Micro (10^-6) units. |
| 3989 | # The value must be between -999,999 and +999,999 inclusive. |
| 3990 | # If `units` is positive, `micros` must be positive or zero. |
| 3991 | # If `units` is zero, `micros` can be positive, zero, or negative. |
| 3992 | # If `units` is negative, `micros` must be negative or zero. |
| 3993 | # For example -1.75 is represented as `units`=-1 and `micros`=-750,000. |
| 3994 | "units": "A String", # Whole units. |
| 3995 | }, |
| 3996 | "min": { # Deprecated. See CompensationInfo. # Required. Minimum value. |
| 3997 | # |
| 3998 | # Decimal number. |
| 3999 | "micros": 42, # Micro (10^-6) units. |
| 4000 | # The value must be between -999,999 and +999,999 inclusive. |
| 4001 | # If `units` is positive, `micros` must be positive or zero. |
| 4002 | # If `units` is zero, `micros` can be positive, zero, or negative. |
| 4003 | # If `units` is negative, `micros` must be negative or zero. |
| 4004 | # For example -1.75 is represented as `units`=-1 and `micros`=-750,000. |
| 4005 | "units": "A String", # Whole units. |
| 4006 | }, |
| 4007 | }, |
| 4008 | "expectedUnitsPerYear": { # Deprecated. See CompensationInfo. # Optional. Expected number of units paid each year. If not specified, when |
| 4009 | # Job.employment_types is FULLTIME, a default value is inferred |
| 4010 | # based on unit. Default values: |
| 4011 | # - HOURLY: 2080 |
| 4012 | # - DAILY: 260 |
| 4013 | # - WEEKLY: 52 |
| 4014 | # - MONTHLY: 12 |
| 4015 | # - ANNUAL: 1 |
| 4016 | # |
| 4017 | # Decimal number. |
| 4018 | "micros": 42, # Micro (10^-6) units. |
| 4019 | # The value must be between -999,999 and +999,999 inclusive. |
| 4020 | # If `units` is positive, `micros` must be positive or zero. |
| 4021 | # If `units` is zero, `micros` can be positive, zero, or negative. |
| 4022 | # If `units` is negative, `micros` must be negative or zero. |
| 4023 | # For example -1.75 is represented as `units`=-1 and `micros`=-750,000. |
| 4024 | "units": "A String", # Whole units. |
| 4025 | }, |
| 4026 | "amount": { # Deprecated. See CompensationInfo. # Optional. Monetary amount. |
| 4027 | # |
| 4028 | # Decimal number. |
| 4029 | "micros": 42, # Micro (10^-6) units. |
| 4030 | # The value must be between -999,999 and +999,999 inclusive. |
| 4031 | # If `units` is positive, `micros` must be positive or zero. |
| 4032 | # If `units` is zero, `micros` can be positive, zero, or negative. |
| 4033 | # If `units` is negative, `micros` must be negative or zero. |
| 4034 | # For example -1.75 is represented as `units`=-1 and `micros`=-750,000. |
| 4035 | "units": "A String", # Whole units. |
| 4036 | }, |
| 4037 | "description": "A String", # Optional. Compensation description. |
| 4038 | "unspecified": True or False, # Optional. Indicates compensation amount and range are unset. |
| 4039 | "unit": "A String", # Optional. Frequency of the specified amount. |
| 4040 | # |
| 4041 | # Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED. |
| 4042 | "type": "A String", # Required. Compensation type. |
| 4043 | }, |
| 4044 | ], |
| 4045 | "annualizedTotalCompensationRange": { # Deprecated. See CompensationInfo. # Output only. Annualized total compensation range. |
| 4046 | # |
| 4047 | # Compensation range. |
| 4048 | "max": { # Deprecated. See CompensationInfo. # Required. Maximum value. |
| 4049 | # |
| 4050 | # Decimal number. |
| 4051 | "micros": 42, # Micro (10^-6) units. |
| 4052 | # The value must be between -999,999 and +999,999 inclusive. |
| 4053 | # If `units` is positive, `micros` must be positive or zero. |
| 4054 | # If `units` is zero, `micros` can be positive, zero, or negative. |
| 4055 | # If `units` is negative, `micros` must be negative or zero. |
| 4056 | # For example -1.75 is represented as `units`=-1 and `micros`=-750,000. |
| 4057 | "units": "A String", # Whole units. |
| 4058 | }, |
| 4059 | "min": { # Deprecated. See CompensationInfo. # Required. Minimum value. |
| 4060 | # |
| 4061 | # Decimal number. |
| 4062 | "micros": 42, # Micro (10^-6) units. |
| 4063 | # The value must be between -999,999 and +999,999 inclusive. |
| 4064 | # If `units` is positive, `micros` must be positive or zero. |
| 4065 | # If `units` is zero, `micros` can be positive, zero, or negative. |
| 4066 | # If `units` is negative, `micros` must be negative or zero. |
| 4067 | # For example -1.75 is represented as `units`=-1 and `micros`=-750,000. |
| 4068 | "units": "A String", # Whole units. |
| 4069 | }, |
| 4070 | }, |
| 4071 | }, |
| 4072 | "startDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Optional. The start date of the job in UTC time zone. Typically this field |
| 4073 | # is used for contracting engagements. |
| 4074 | # Dates prior to 1970/1/1 and invalid date formats are ignored. |
| 4075 | # and time zone are either specified elsewhere or are not significant. The date |
| 4076 | # is relative to the Proleptic Gregorian Calendar. This can represent: |
| 4077 | # |
| 4078 | # * A full date, with non-zero year, month and day values |
| 4079 | # * A month and day value, with a zero year, e.g. an anniversary |
| 4080 | # * A year on its own, with zero month and day values |
| 4081 | # * A year and month value, with a zero day, e.g. a credit card expiration date |
| 4082 | # |
| 4083 | # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. |
| 4084 | "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| 4085 | # a year. |
| 4086 | "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| 4087 | # if specifying a year by itself or a year and month where the day is not |
| 4088 | # significant. |
| 4089 | "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| 4090 | # month and day. |
| 4091 | }, |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4092 | "department": "A String", # Optional. The department or functional area within the company with the open |
| 4093 | # position. |
| 4094 | # |
| 4095 | # The maximum number of allowed characters is 255. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4096 | "applicationEmailList": [ # Optional but at least one of application_urls, |
| 4097 | # application_email_list or application_instruction must be |
| 4098 | # specified. |
| 4099 | # |
| 4100 | # Use this field to specify email address(es) to which resumes or |
| 4101 | # applications can be sent. |
| 4102 | # |
| 4103 | # The maximum number of allowed characters is 255. |
| 4104 | "A String", |
| 4105 | ], |
| 4106 | "companyTitle": "A String", # Deprecated. Use company_display_name instead. |
| 4107 | # |
| 4108 | # Output only. |
| 4109 | # |
| 4110 | # The name of the company listing the job. |
| 4111 | "level": "A String", # Optional. The experience level associated with the job, such as "Entry Level". |
| 4112 | "filterableCustomFields": { # Deprecated. Use custom_attributes instead. |
| 4113 | # |
| 4114 | # Optional. |
| 4115 | # |
| 4116 | # A map of fields to hold filterable custom job attributes not captured by |
| 4117 | # the standard fields such as job_title, company_name, or |
| 4118 | # level. These custom fields store arbitrary |
| 4119 | # string values, and can be used for purposes not covered by |
| 4120 | # the structured fields. For the best search experience, use of the |
| 4121 | # structured rather than custom fields is recommended. |
| 4122 | # |
| 4123 | # Data stored in these custom fields fields are indexed and |
| 4124 | # searched against by keyword searches (see |
| 4125 | # SearchJobsRequest.custom_field_filters][]). |
| 4126 | # |
| 4127 | # The map key must be a number between 1-20. If an invalid key is |
| 4128 | # provided on job create or update, an error is returned. |
| 4129 | "a_key": { # Resource that represents the custom data not captured by the standard fields. |
| 4130 | "values": [ # Optional. The values of the custom data. |
| 4131 | "A String", |
| 4132 | ], |
| 4133 | }, |
| 4134 | }, |
| 4135 | "compensationInfo": { # Job compensation details. # Optional. Job compensation information. |
| 4136 | "entries": [ # Optional. Job compensation information. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4137 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4138 | # At most one entry can be of type |
| 4139 | # CompensationInfo.CompensationType.BASE, which is |
| 4140 | # referred as ** base compensation entry ** for the job. |
| 4141 | { # A compensation entry that represents one component of compensation, such |
| 4142 | # as base pay, bonus, or other compensation type. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4143 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4144 | # Annualization: One compensation entry can be annualized if |
| 4145 | # - it contains valid amount or range. |
| 4146 | # - and its expected_units_per_year is set or can be derived. |
| 4147 | # Its annualized range is determined as (amount or range) times |
| 4148 | # expected_units_per_year. |
| 4149 | "amount": { # Represents an amount of money with its currency type. # Optional. Compensation amount. |
| 4150 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 4151 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 4152 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 4153 | # If `units` is positive, `nanos` must be positive or zero. |
| 4154 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 4155 | # If `units` is negative, `nanos` must be negative or zero. |
| 4156 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 4157 | "units": "A String", # The whole units of the amount. |
| 4158 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 4159 | }, |
| 4160 | "description": "A String", # Optional. Compensation description. For example, could |
| 4161 | # indicate equity terms or provide additional context to an estimated |
| 4162 | # bonus. |
| 4163 | "expectedUnitsPerYear": 3.14, # Optional. Expected number of units paid each year. If not specified, when |
| 4164 | # Job.employment_types is FULLTIME, a default value is inferred |
| 4165 | # based on unit. Default values: |
| 4166 | # - HOURLY: 2080 |
| 4167 | # - DAILY: 260 |
| 4168 | # - WEEKLY: 52 |
| 4169 | # - MONTHLY: 12 |
| 4170 | # - ANNUAL: 1 |
| 4171 | "range": { # Compensation range. # Optional. Compensation range. |
| 4172 | "min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set |
| 4173 | # to zero and the currency code is set to match the |
| 4174 | # currency code of max_compensation. |
| 4175 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 4176 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 4177 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 4178 | # If `units` is positive, `nanos` must be positive or zero. |
| 4179 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 4180 | # If `units` is negative, `nanos` must be negative or zero. |
| 4181 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 4182 | "units": "A String", # The whole units of the amount. |
| 4183 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 4184 | }, |
| 4185 | "max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set |
| 4186 | # to a maximal compensation value and the currency code is set to |
| 4187 | # match the currency code of |
| 4188 | # min_compensation. |
| 4189 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 4190 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 4191 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 4192 | # If `units` is positive, `nanos` must be positive or zero. |
| 4193 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 4194 | # If `units` is negative, `nanos` must be negative or zero. |
| 4195 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 4196 | "units": "A String", # The whole units of the amount. |
| 4197 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 4198 | }, |
| 4199 | }, |
| 4200 | "type": "A String", # Required. Compensation type. |
| 4201 | "unit": "A String", # Optional. Frequency of the specified amount. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4202 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4203 | # Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4204 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4205 | ], |
| 4206 | "annualizedBaseCompensationRange": { # Compensation range. # Output only. Annualized base compensation range. Computed as |
| 4207 | # base compensation entry's CompensationEntry.compensation times |
| 4208 | # CompensationEntry.expected_units_per_year. |
| 4209 | # |
| 4210 | # See CompensationEntry for explanation on compensation annualization. |
| 4211 | "min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set |
| 4212 | # to zero and the currency code is set to match the |
| 4213 | # currency code of max_compensation. |
| 4214 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 4215 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 4216 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 4217 | # If `units` is positive, `nanos` must be positive or zero. |
| 4218 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 4219 | # If `units` is negative, `nanos` must be negative or zero. |
| 4220 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 4221 | "units": "A String", # The whole units of the amount. |
| 4222 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 4223 | }, |
| 4224 | "max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set |
| 4225 | # to a maximal compensation value and the currency code is set to |
| 4226 | # match the currency code of |
| 4227 | # min_compensation. |
| 4228 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 4229 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 4230 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 4231 | # If `units` is positive, `nanos` must be positive or zero. |
| 4232 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 4233 | # If `units` is negative, `nanos` must be negative or zero. |
| 4234 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 4235 | "units": "A String", # The whole units of the amount. |
| 4236 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4237 | }, |
| 4238 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4239 | "amount": { # Represents an amount of money with its currency type. # Deprecated. Use entries instead. |
| 4240 | # |
| 4241 | # Optional. |
| 4242 | # |
| 4243 | # The amount of compensation or pay for the job. |
| 4244 | # As an alternative, compensation_amount_min and |
| 4245 | # compensation_amount_max may be used to define a range of |
| 4246 | # compensation. |
| 4247 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 4248 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 4249 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 4250 | # If `units` is positive, `nanos` must be positive or zero. |
| 4251 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 4252 | # If `units` is negative, `nanos` must be negative or zero. |
| 4253 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 4254 | "units": "A String", # The whole units of the amount. |
| 4255 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 4256 | }, |
| 4257 | "max": { # Represents an amount of money with its currency type. # Deprecated. Use entries instead. |
| 4258 | # |
| 4259 | # Optional. |
| 4260 | # |
| 4261 | # An upper bound on a range for compensation or pay for the job. |
| 4262 | # The currency type is specified in compensation_amount. |
| 4263 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 4264 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 4265 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 4266 | # If `units` is positive, `nanos` must be positive or zero. |
| 4267 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 4268 | # If `units` is negative, `nanos` must be negative or zero. |
| 4269 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 4270 | "units": "A String", # The whole units of the amount. |
| 4271 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 4272 | }, |
| 4273 | "type": "A String", # Deprecated. Use entries instead. |
| 4274 | # |
| 4275 | # Optional. |
| 4276 | # |
| 4277 | # Type of job compensation. |
| 4278 | "min": { # Represents an amount of money with its currency type. # Deprecated. Use entries instead. |
| 4279 | # |
| 4280 | # Optional. |
| 4281 | # |
| 4282 | # A lower bound on a range for compensation or pay for the job. |
| 4283 | # The currency type is specified in compensation_amount. |
| 4284 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 4285 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 4286 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 4287 | # If `units` is positive, `nanos` must be positive or zero. |
| 4288 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 4289 | # If `units` is negative, `nanos` must be negative or zero. |
| 4290 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 4291 | "units": "A String", # The whole units of the amount. |
| 4292 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 4293 | }, |
| 4294 | "annualizedTotalCompensationRange": { # Compensation range. # Output only. Annualized total compensation range. Computed as |
| 4295 | # all compensation entries' CompensationEntry.compensation times |
| 4296 | # CompensationEntry.expected_units_per_year. |
| 4297 | # |
| 4298 | # See CompensationEntry for explanation on compensation annualization. |
| 4299 | "min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set |
| 4300 | # to zero and the currency code is set to match the |
| 4301 | # currency code of max_compensation. |
| 4302 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 4303 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 4304 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 4305 | # If `units` is positive, `nanos` must be positive or zero. |
| 4306 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 4307 | # If `units` is negative, `nanos` must be negative or zero. |
| 4308 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 4309 | "units": "A String", # The whole units of the amount. |
| 4310 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 4311 | }, |
| 4312 | "max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set |
| 4313 | # to a maximal compensation value and the currency code is set to |
| 4314 | # match the currency code of |
| 4315 | # min_compensation. |
| 4316 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 4317 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 4318 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 4319 | # If `units` is positive, `nanos` must be positive or zero. |
| 4320 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 4321 | # If `units` is negative, `nanos` must be negative or zero. |
| 4322 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 4323 | "units": "A String", # The whole units of the amount. |
| 4324 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 4325 | }, |
| 4326 | }, |
| 4327 | }, |
| 4328 | "region": "A String", # Optional. The job Region (for example, state, country) throughout which the job |
| 4329 | # is available. If this field is set, a |
| 4330 | # LocationFilter in a search query within the job region |
| 4331 | # finds this job if an exact location match is not specified. |
| 4332 | # If this field is set, setting job locations |
| 4333 | # to the same location level as this field is strongly recommended. |
| 4334 | "createTime": "A String", # Output only. The timestamp when this job was created. |
| 4335 | "incentives": "A String", # Optional. A description of bonus, commission, and other compensation |
| 4336 | # incentives associated with the job not including salary or pay. |
| 4337 | # |
| 4338 | # The maximum number of allowed characters is 10,000. |
| 4339 | "companyDisplayName": "A String", # Output only. The name of the company listing the job. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4340 | "unindexedCustomFields": { # Deprecated. Use custom_attributes instead. |
| 4341 | # |
| 4342 | # Optional. |
| 4343 | # |
| 4344 | # A map of fields to hold non-filterable custom job attributes, similar to |
| 4345 | # filterable_custom_fields. These fields are distinct in that the data |
| 4346 | # in these fields are not indexed. Therefore, the client cannot search |
| 4347 | # against them, nor can the client use them to list jobs. |
| 4348 | # |
| 4349 | # The key of the map can be any valid string. |
| 4350 | "a_key": { # Resource that represents the custom data not captured by the standard fields. |
| 4351 | "values": [ # Optional. The values of the custom data. |
| 4352 | "A String", |
| 4353 | ], |
| 4354 | }, |
| 4355 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4356 | "visibility": "A String", # Optional. The visibility of the job. |
| 4357 | # Defaults to JobVisibility.PRIVATE if not specified. |
| 4358 | # Currently only JobVisibility.PRIVATE is supported. |
| 4359 | "employmentTypes": [ # Optional. The employment type(s) of a job, for example, |
| 4360 | # full time or |
| 4361 | # part time. |
| 4362 | "A String", |
| 4363 | ], |
| 4364 | "benefits": [ # Optional. The benefits included with the job. |
| 4365 | "A String", |
| 4366 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4367 | "expiryDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Deprecated. Use expire_time instead. |
| 4368 | # |
| 4369 | # Optional but strongly recommended to be provided for the best service |
| 4370 | # experience. |
| 4371 | # |
| 4372 | # The expiration date of the job in UTC time. After 12 am on this date, the |
| 4373 | # job is marked as expired, and it no longer appears in search results. |
| 4374 | # The expired job can't be deleted or listed by the DeleteJob and |
| 4375 | # ListJobs APIs, but it can be retrieved with the GetJob API or |
| 4376 | # updated with the UpdateJob API. An expired job can be updated and |
| 4377 | # opened again by using a future expiration date. It can also remain expired. |
| 4378 | # Updating an expired job to be open fails if there is another existing open |
| 4379 | # job with same requisition_id, company_name and language_code. |
| 4380 | # |
| 4381 | # The expired jobs are retained in our system for 90 days. However, the |
| 4382 | # overall expired job count cannot exceed 3 times the maximum of open jobs |
| 4383 | # count over the past week, otherwise jobs with earlier expire time are |
| 4384 | # removed first. Expired jobs are no longer accessible after they are cleaned |
| 4385 | # out. |
| 4386 | # |
| 4387 | # A valid date range is between 1970/1/1 and 2100/12/31. Invalid dates are |
| 4388 | # ignored and treated as expiry date not provided. |
| 4389 | # |
| 4390 | # If this value is not provided on job creation or is invalid, the job |
| 4391 | # posting expires after 30 days from the job's creation time. For example, if |
| 4392 | # the job was created on 2017/01/01 13:00AM UTC with an unspecified |
| 4393 | # expiration date, the job expires after 2017/01/31 13:00AM UTC. |
| 4394 | # |
| 4395 | # If this value is not provided on job update, it depends on the field masks |
| 4396 | # set by UpdateJobRequest.update_job_fields. If the field masks include |
| 4397 | # expiry_date, or the masks are empty meaning that every field is |
| 4398 | # updated, the job expires after 30 days from the job's last update time. |
| 4399 | # Otherwise the expiration date isn't updated. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4400 | # and time zone are either specified elsewhere or are not significant. The date |
| 4401 | # is relative to the Proleptic Gregorian Calendar. This can represent: |
| 4402 | # |
| 4403 | # * A full date, with non-zero year, month and day values |
| 4404 | # * A month and day value, with a zero year, e.g. an anniversary |
| 4405 | # * A year on its own, with zero month and day values |
| 4406 | # * A year and month value, with a zero day, e.g. a credit card expiration date |
| 4407 | # |
| 4408 | # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4409 | "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| 4410 | # a year. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4411 | "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4412 | # if specifying a year by itself or a year and month where the day is not |
| 4413 | # significant. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4414 | "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| 4415 | # month and day. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4416 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4417 | "companyName": "A String", # Optional but one of company_name or distributor_company_id must be |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4418 | # provided. |
| 4419 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4420 | # The resource name of the company listing the job, such as |
| 4421 | # /companies/foo. This field takes precedence over the |
| 4422 | # distributor-assigned company identifier, distributor_company_id. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4423 | "locations": [ # Optional but strongly recommended for the best service experience. |
| 4424 | # |
| 4425 | # Location(s) where the emploeyer is looking to hire for this job posting. |
| 4426 | # |
| 4427 | # Specifying the full street address(es) of the hiring location enables |
| 4428 | # better API results, especially job searches by commute time. |
| 4429 | # |
| 4430 | # At most 50 locations are allowed for best search performance. If a job has |
| 4431 | # more locations, it is suggested to split it into multiple jobs with unique |
| 4432 | # requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as |
| 4433 | # multiple jobs with the same requisition_id, company_name and |
| 4434 | # language_code are not allowed. If the original requisition_id must |
| 4435 | # be preserved, a custom field should be used for storage. It is also |
| 4436 | # suggested to group the locations that close to each other in the same job |
| 4437 | # for better search experience. |
| 4438 | # |
| 4439 | # The maximum number of allowed characters is 500. |
| 4440 | "A String", |
| 4441 | ], |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4442 | "endDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Optional. The end date of the job in UTC time zone. Typically this field |
| 4443 | # is used for contracting engagements. |
| 4444 | # Dates prior to 1970/1/1 and invalid date formats are ignored. |
| 4445 | # and time zone are either specified elsewhere or are not significant. The date |
| 4446 | # is relative to the Proleptic Gregorian Calendar. This can represent: |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4447 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4448 | # * A full date, with non-zero year, month and day values |
| 4449 | # * A month and day value, with a zero year, e.g. an anniversary |
| 4450 | # * A year on its own, with zero month and day values |
| 4451 | # * A year and month value, with a zero day, e.g. a credit card expiration date |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4452 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4453 | # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. |
| 4454 | "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| 4455 | # a year. |
| 4456 | "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| 4457 | # if specifying a year by itself or a year and month where the day is not |
| 4458 | # significant. |
| 4459 | "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| 4460 | # month and day. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4461 | }, |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4462 | }, |
| 4463 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4464 | "nextPageToken": "A String", # A token to retrieve the next page of results. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4465 | "metadata": { # Output only. # Additional information for the API invocation, such as the request |
| 4466 | # tracking id. |
| 4467 | # |
| 4468 | # Additional information returned to client, such as debugging |
| 4469 | # information. |
| 4470 | "mode": "A String", # For search response only. Indicates the mode of a performed search. |
| 4471 | "experimentIdList": [ # Identifiers for the versions of the search algorithm used during |
| 4472 | # this API invocation if multiple algorithms are used. |
| 4473 | # The default value is empty. |
| 4474 | # For search response only. |
| 4475 | 42, |
| 4476 | ], |
| 4477 | "requestId": "A String", # A unique id associated with this call. |
| 4478 | # This id is logged for tracking purposes. |
| 4479 | }, |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4480 | }</pre> |
| 4481 | </div> |
| 4482 | |
| 4483 | <div class="method"> |
| 4484 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 4485 | <pre>Retrieves the next page of results. |
| 4486 | |
| 4487 | Args: |
| 4488 | previous_request: The request for the previous page. (required) |
| 4489 | previous_response: The response from the request for the previous page. (required) |
| 4490 | |
| 4491 | Returns: |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4492 | 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] | 4493 | page. Returns None if there are no more items in the collection. |
| 4494 | </pre> |
| 4495 | </div> |
| 4496 | |
| 4497 | <div class="method"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4498 | <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] | 4499 | <pre>Updates specified job. |
| 4500 | |
| 4501 | Typically, updated contents become visible in search results within 10 |
| 4502 | seconds, but it may take up to 5 minutes. |
| 4503 | |
| 4504 | Args: |
| 4505 | name: string, Required during job update. |
| 4506 | |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4507 | Resource name assigned to a job by the API, for example, "/jobs/foo". Use |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4508 | of this field in job queries and API calls is preferred over the use of |
| 4509 | requisition_id since this value is unique. (required) |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4510 | body: object, The request body. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4511 | The object takes the form of: |
| 4512 | |
| 4513 | { # Input only. |
| 4514 | # |
| 4515 | # Update job request. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4516 | "job": { # A Job resource represents a job posting (also referred to as a "job listing" # Required. The Job to be updated. |
| 4517 | # or "job requisition"). A job belongs to a Company, which is the hiring |
| 4518 | # entity responsible for the job. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4519 | "languageCode": "A String", # Optional. The language of the posting. This field is distinct from |
| 4520 | # any requirements for fluency that are associated with the job. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4521 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4522 | # Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn". |
| 4523 | # For more information, see |
| 4524 | # [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){: |
| 4525 | # class="external" target="_blank" }. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4526 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4527 | # If this field is unspecified and Job.description is present, detected |
| 4528 | # language code based on Job.description is assigned, otherwise |
| 4529 | # defaults to 'en_US'. |
| 4530 | "educationLevels": [ # Optional. The desired education level for the job, such as |
| 4531 | # "Bachelors", "Masters", "Doctorate". |
| 4532 | "A String", |
| 4533 | ], |
| 4534 | "description": "A String", # Required. The description of the job, which typically includes a multi-paragraph |
| 4535 | # description of the company and related information. Separate fields are |
| 4536 | # provided on the job object for responsibilities, |
| 4537 | # qualifications, and other job characteristics. Use of |
| 4538 | # these separate job fields is recommended. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4539 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4540 | # This field accepts and sanitizes HTML input, and also accepts |
| 4541 | # bold, italic, ordered list, and unordered list markup tags. |
| 4542 | # |
| 4543 | # The maximum number of allowed characters is 100,000. |
| 4544 | "updateTime": "A String", # Output only. The timestamp when this job was last updated. |
| 4545 | "promotionValue": 42, # Optional. A promotion value of the job, as determined by the client. |
| 4546 | # The value determines the sort order of the jobs returned when searching for |
| 4547 | # jobs using the featured jobs search call, with higher promotional values |
| 4548 | # being returned first and ties being resolved by relevance sort. Only the |
| 4549 | # jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH. |
| 4550 | # |
| 4551 | # Default value is 0, and negative values are treated as 0. |
| 4552 | "qualifications": "A String", # Optional. A description of the qualifications required to perform the |
| 4553 | # job. The use of this field is recommended |
| 4554 | # as an alternative to using the more general description field. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4555 | # |
| 4556 | # This field accepts and sanitizes HTML input, and also accepts |
| 4557 | # bold, italic, ordered list, and unordered list markup tags. |
| 4558 | # |
| 4559 | # The maximum number of allowed characters is 10,000. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4560 | "customAttributes": { # Optional. A map of fields to hold both filterable and non-filterable custom job |
| 4561 | # attributes that are not covered by the provided structured fields. |
| 4562 | # |
| 4563 | # This field is a more general combination of the deprecated id-based |
| 4564 | # filterable_custom_fields and string-based |
| 4565 | # non_filterable_custom_fields. |
| 4566 | # |
| 4567 | # The keys of the map are strings up to 64 bytes and must match the |
| 4568 | # pattern: a-zA-Z*. |
| 4569 | # |
| 4570 | # At most 100 filterable and at most 100 unfilterable keys are supported. |
| 4571 | # For filterable `string_values`, across all keys at most 200 values are |
| 4572 | # allowed, with each string no more than 255 characters. For unfilterable |
| 4573 | # `string_values`, the maximum total size of `string_values` across all keys |
| 4574 | # is 50KB. |
| 4575 | "a_key": { # Custom attribute values that are either filterable or non-filterable. |
| 4576 | "longValue": "A String", # Optional but at least one of string_values or long_value must |
| 4577 | # be specified. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4578 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4579 | # This field is used to perform number range search. |
| 4580 | # (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`. For |
| 4581 | # `long_value`, a value between Long.MIN and Long.MAX is allowed. |
| 4582 | "filterable": True or False, # Optional. If the `filterable` flag is true, custom field values are searchable. |
| 4583 | # If false, values are not searchable. |
| 4584 | # |
| 4585 | # Default is false. |
| 4586 | "stringValues": { # Represents array of string values. # Optional but at least one of string_values or long_value must |
| 4587 | # be specified. |
| 4588 | # |
| 4589 | # This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or |
| 4590 | # `CASE_INSENSITIVE_MATCH`) search. |
| 4591 | # For filterable `string_values`, a maximum total number of 200 values |
| 4592 | # is allowed, with each `string_value` has a byte size of no more than |
| 4593 | # 255B. For unfilterable `string_values`, the maximum total byte size of |
| 4594 | # unfilterable `string_values` is 50KB. |
| 4595 | # |
| 4596 | # Empty strings are not allowed. |
| 4597 | "values": [ # Required. String values. |
| 4598 | "A String", |
| 4599 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4600 | }, |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4601 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4602 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4603 | "applicationUrls": [ # Optional but at least one of application_urls, |
| 4604 | # application_email_list or application_instruction must be |
| 4605 | # specified. |
| 4606 | # |
| 4607 | # Use this URL field to direct an applicant to a website, for example to |
| 4608 | # link to an online application form. |
| 4609 | # |
| 4610 | # The maximum number of allowed characters is 2,000. |
| 4611 | "A String", |
| 4612 | ], |
| 4613 | "requisitionId": "A String", # Required. The requisition ID, also referred to as the posting ID, assigned by the |
| 4614 | # client to identify a job. This field is intended to be used by clients |
| 4615 | # for client identification and tracking of listings. A job is not allowed |
| 4616 | # to be created if there is another job with the same requisition_id, |
| 4617 | # company_name and language_code. |
| 4618 | # |
| 4619 | # The maximum number of allowed characters is 255. |
| 4620 | "jobLocations": [ # Output only. Structured locations of the job, resolved from locations. |
| 4621 | { # Output only. |
| 4622 | # |
| 4623 | # A resource that represents a location with full geographic |
| 4624 | # information. |
| 4625 | "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair. |
| 4626 | # of doubles representing degrees latitude and degrees longitude. Unless |
| 4627 | # specified otherwise, this must conform to the |
| 4628 | # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 |
| 4629 | # standard</a>. Values must be within normalized ranges. |
| 4630 | "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. |
| 4631 | "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. |
| 4632 | }, |
| 4633 | "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information, |
| 4634 | # such as postal delivery and payments addresses. Given a postal address, |
| 4635 | # a postal service can deliver items to a premises, P.O. Box, or other |
| 4636 | # delivery location. |
| 4637 | # Given a postal address, a postal service can deliver items to a premise, P.O. |
| 4638 | # Box or similar. |
| 4639 | # It is not intended to model geographical locations (roads, towns, |
| 4640 | # mountains). |
| 4641 | # |
| 4642 | # In typical usage an address would be created via user input or from importing |
| 4643 | # existing data, depending on the type of process. |
| 4644 | # |
| 4645 | # Advice on address input / editing: |
| 4646 | # - Use an i18n-ready address widget such as |
| 4647 | # https://github.com/google/libaddressinput) |
| 4648 | # - Users should not be presented with UI elements for input or editing of |
| 4649 | # fields outside countries where that field is used. |
| 4650 | # |
| 4651 | # For more guidance on how to use this schema, please see: |
| 4652 | # https://support.google.com/business/answer/6397478 |
| 4653 | "sublocality": "A String", # Optional. Sublocality of the address. |
| 4654 | # For example, this can be neighborhoods, boroughs, districts. |
| 4655 | "recipients": [ # Optional. The recipient at the address. |
| 4656 | # This field may, under certain circumstances, contain multiline information. |
| 4657 | # For example, it might contain "care of" information. |
| 4658 | "A String", |
| 4659 | ], |
| 4660 | "locality": "A String", # Optional. Generally refers to the city/town portion of the address. |
| 4661 | # Examples: US city, IT comune, UK post town. |
| 4662 | # In regions of the world where localities are not well defined or do not fit |
| 4663 | # into this structure well, leave locality empty and use address_lines. |
| 4664 | "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This |
| 4665 | # is never inferred and it is up to the user to ensure the value is |
| 4666 | # correct. See http://cldr.unicode.org/ and |
| 4667 | # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html |
| 4668 | # for details. Example: "CH" for Switzerland. |
| 4669 | "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if |
| 4670 | # known). This is often the UI language of the input form or is expected |
| 4671 | # to match one of the languages used in the address' country/region, or their |
| 4672 | # transliterated equivalents. |
| 4673 | # This can affect formatting in certain countries, but is not critical |
| 4674 | # to the correctness of the data and will never affect any validation or |
| 4675 | # other non-formatting related operations. |
| 4676 | # |
| 4677 | # If this value is not known, it should be omitted (rather than specifying a |
| 4678 | # possibly incorrect default). |
| 4679 | # |
| 4680 | # Examples: "zh-Hant", "ja", "ja-Latn", "en". |
| 4681 | "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require |
| 4682 | # postal codes to be present, but where they are used, they may trigger |
| 4683 | # additional validation with other parts of the address (e.g. state/zip |
| 4684 | # validation in the U.S.A.). |
| 4685 | "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal |
| 4686 | # addresses of a country or region. |
| 4687 | # For example, this can be a state, a province, an oblast, or a prefecture. |
| 4688 | # Specifically, for Spain this is the province and not the autonomous |
| 4689 | # community (e.g. "Barcelona" and not "Catalonia"). |
| 4690 | # Many countries don't use an administrative area in postal addresses. E.g. |
| 4691 | # in Switzerland this should be left unpopulated. |
| 4692 | "addressLines": [ # Unstructured address lines describing the lower levels of an address. |
| 4693 | # |
| 4694 | # Because values in address_lines do not have type information and may |
| 4695 | # sometimes contain multiple values in a single field (e.g. |
| 4696 | # "Austin, TX"), it is important that the line order is clear. The order of |
| 4697 | # address lines should be "envelope order" for the country/region of the |
| 4698 | # address. In places where this can vary (e.g. Japan), address_language is |
| 4699 | # used to make it explicit (e.g. "ja" for large-to-small ordering and |
| 4700 | # "ja-Latn" or "en" for small-to-large). This way, the most specific line of |
| 4701 | # an address can be selected based on the language. |
| 4702 | # |
| 4703 | # The minimum permitted structural representation of an address consists |
| 4704 | # of a region_code with all remaining information placed in the |
| 4705 | # address_lines. It would be possible to format such an address very |
| 4706 | # approximately without geocoding, but no semantic reasoning could be |
| 4707 | # made about any of the address components until it was at least |
| 4708 | # partially resolved. |
| 4709 | # |
| 4710 | # Creating an address only containing a region_code and address_lines, and |
| 4711 | # then geocoding is the recommended way to handle completely unstructured |
| 4712 | # addresses (as opposed to guessing which parts of the address should be |
| 4713 | # localities or administrative areas). |
| 4714 | "A String", |
| 4715 | ], |
| 4716 | "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used |
| 4717 | # in most regions. Where it is used, the value is either a string like |
| 4718 | # "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number |
| 4719 | # alone, representing the "sector code" (Jamaica), "delivery area indicator" |
| 4720 | # (Malawi) or "post office indicator" (e.g. Côte d'Ivoire). |
| 4721 | "organization": "A String", # Optional. The name of the organization at the address. |
| 4722 | "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is |
| 4723 | # the latest revision. |
| 4724 | # |
| 4725 | # All new revisions **must** be backward compatible with old revisions. |
| 4726 | }, |
| 4727 | "locationType": "A String", # The type of a location, which corresponds to the address lines field of |
| 4728 | # PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of |
| 4729 | # LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of |
| 4730 | # LocationType#LOCALITY. |
| 4731 | "radiusMeters": 3.14, # Radius in meters of the job location. This value is derived from the |
| 4732 | # location bounding box in which a circle with the specified radius |
| 4733 | # centered from LatLng coves the area associated with the job location. |
| 4734 | # For example, currently, "Mountain View, CA, USA" has a radius of |
| 4735 | # 7885.79 meters. |
| 4736 | }, |
| 4737 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4738 | "expireTime": "A String", # Optional but strongly recommended for the best service |
| 4739 | # experience. |
| 4740 | # |
| 4741 | # The expiration timestamp of the job. After this timestamp, the |
| 4742 | # job is marked as expired, and it no longer appears in search results. The |
| 4743 | # expired job can't be deleted or listed by the DeleteJob and |
| 4744 | # ListJobs APIs, but it can be retrieved with the GetJob API or |
| 4745 | # updated with the UpdateJob API. An expired job can be updated and |
| 4746 | # opened again by using a future expiration timestamp. Updating an expired |
| 4747 | # job fails if there is another existing open job with same |
| 4748 | # requisition_id, company_name and language_code. |
| 4749 | # |
| 4750 | # The expired jobs are retained in our system for 90 days. However, the |
| 4751 | # overall expired job count cannot exceed 3 times the maximum of open jobs |
| 4752 | # count over the past week, otherwise jobs with earlier expire time are |
| 4753 | # cleaned first. Expired jobs are no longer accessible after they are cleaned |
| 4754 | # out. |
| 4755 | # The format of this field is RFC 3339 date strings. Example: |
| 4756 | # 2000-01-01T00:00:00.999999999Z |
| 4757 | # See |
| 4758 | # [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt). |
| 4759 | # |
| 4760 | # A valid date range is between 1970-01-01T00:00:00.0Z and |
| 4761 | # 2100-12-31T23:59:59.999Z. Invalid dates are ignored and treated as expire |
| 4762 | # time not provided. |
| 4763 | # |
| 4764 | # If this value is not provided at the time of job creation or is invalid, |
| 4765 | # the job posting expires after 30 days from the job's creation time. For |
| 4766 | # example, if the job was created on 2017/01/01 13:00AM UTC with an |
| 4767 | # unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC. |
| 4768 | # |
| 4769 | # If this value is not provided but expiry_date is, expiry_date is |
| 4770 | # used. |
| 4771 | # |
| 4772 | # If this value is not provided on job update, it depends on the field masks |
| 4773 | # set by UpdateJobRequest.update_job_fields. If the field masks include |
| 4774 | # expiry_time, or the masks are empty meaning that every field is |
| 4775 | # updated, the job posting expires after 30 days from the job's last |
| 4776 | # update time. Otherwise the expiration date isn't updated. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4777 | "name": "A String", # Required during job update. |
| 4778 | # |
| 4779 | # Resource name assigned to a job by the API, for example, "/jobs/foo". Use |
| 4780 | # of this field in job queries and API calls is preferred over the use of |
| 4781 | # requisition_id since this value is unique. |
| 4782 | "jobTitle": "A String", # Required. The title of the job, such as "Software Engineer" |
| 4783 | # |
| 4784 | # The maximum number of allowed characters is 500. |
| 4785 | "referenceUrl": "A String", # Output only. The URL of a web page that displays job details. |
| 4786 | "responsibilities": "A String", # Optional. A description of job responsibilities. The use of this field is |
| 4787 | # recommended as an alternative to using the more general description |
| 4788 | # field. |
| 4789 | # |
| 4790 | # This field accepts and sanitizes HTML input, and also accepts |
| 4791 | # bold, italic, ordered list, and unordered list markup tags. |
| 4792 | # |
| 4793 | # The maximum number of allowed characters is 10,000. |
| 4794 | "distributorCompanyId": "A String", # Optional but one of company_name or distributor_company_id must be |
| 4795 | # provided. |
| 4796 | # |
| 4797 | # A unique company identifier used by job distributors to identify an |
| 4798 | # employer's company entity. company_name takes precedence over |
| 4799 | # this field, and is the recommended field to use to identify companies. |
| 4800 | # |
| 4801 | # The maximum number of allowed characters is 255. |
| 4802 | "publishDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Optional. The date this job was most recently published in UTC format. The default |
| 4803 | # value is the time the request arrives at the server. |
| 4804 | # and time zone are either specified elsewhere or are not significant. The date |
| 4805 | # is relative to the Proleptic Gregorian Calendar. This can represent: |
| 4806 | # |
| 4807 | # * A full date, with non-zero year, month and day values |
| 4808 | # * A month and day value, with a zero year, e.g. an anniversary |
| 4809 | # * A year on its own, with zero month and day values |
| 4810 | # * A year and month value, with a zero day, e.g. a credit card expiration date |
| 4811 | # |
| 4812 | # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. |
| 4813 | "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| 4814 | # a year. |
| 4815 | "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| 4816 | # if specifying a year by itself or a year and month where the day is not |
| 4817 | # significant. |
| 4818 | "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| 4819 | # month and day. |
| 4820 | }, |
| 4821 | "applicationInstruction": "A String", # Optional but at least one of application_urls, |
| 4822 | # application_email_list or application_instruction must be |
| 4823 | # specified. |
| 4824 | # |
| 4825 | # Use this field to provide instructions, such as "Mail your application |
| 4826 | # to ...", that a candidate can follow to apply for the job. |
| 4827 | # |
| 4828 | # This field accepts and sanitizes HTML input, and also accepts |
| 4829 | # bold, italic, ordered list, and unordered list markup tags. |
| 4830 | # |
| 4831 | # The maximum number of allowed characters is 3,000. |
| 4832 | "extendedCompensationInfo": { # Deprecated. Use CompensationInfo. # Deprecated. Always use compensation_info. |
| 4833 | # |
| 4834 | # Optional. |
| 4835 | # |
| 4836 | # Job compensation information. |
| 4837 | # |
| 4838 | # This field replaces compensation_info. Only |
| 4839 | # CompensationInfo.entries or extended_compensation_info can be set, |
| 4840 | # otherwise an exception is thrown. |
| 4841 | # |
| 4842 | # Describes job compensation. |
| 4843 | "annualizedBaseCompensationRange": { # Deprecated. See CompensationInfo. # Output only. Annualized base compensation range. |
| 4844 | # |
| 4845 | # Compensation range. |
| 4846 | "max": { # Deprecated. See CompensationInfo. # Required. Maximum value. |
| 4847 | # |
| 4848 | # Decimal number. |
| 4849 | "micros": 42, # Micro (10^-6) units. |
| 4850 | # The value must be between -999,999 and +999,999 inclusive. |
| 4851 | # If `units` is positive, `micros` must be positive or zero. |
| 4852 | # If `units` is zero, `micros` can be positive, zero, or negative. |
| 4853 | # If `units` is negative, `micros` must be negative or zero. |
| 4854 | # For example -1.75 is represented as `units`=-1 and `micros`=-750,000. |
| 4855 | "units": "A String", # Whole units. |
| 4856 | }, |
| 4857 | "min": { # Deprecated. See CompensationInfo. # Required. Minimum value. |
| 4858 | # |
| 4859 | # Decimal number. |
| 4860 | "micros": 42, # Micro (10^-6) units. |
| 4861 | # The value must be between -999,999 and +999,999 inclusive. |
| 4862 | # If `units` is positive, `micros` must be positive or zero. |
| 4863 | # If `units` is zero, `micros` can be positive, zero, or negative. |
| 4864 | # If `units` is negative, `micros` must be negative or zero. |
| 4865 | # For example -1.75 is represented as `units`=-1 and `micros`=-750,000. |
| 4866 | "units": "A String", # Whole units. |
| 4867 | }, |
| 4868 | }, |
| 4869 | "annualizedTotalCompensationUnspecified": True or False, # Output only. Indicates annualized total compensation range cannot be derived, due to |
| 4870 | # the job's all CompensationEntry cannot be annualized. |
| 4871 | # See CompensationEntry for explanation on annualization and base |
| 4872 | # compensation entry. |
| 4873 | "currency": "A String", # Optional. A 3-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) |
| 4874 | # currency code. |
| 4875 | "annualizedBaseCompensationUnspecified": True or False, # Output only. Indicates annualized base compensation range cannot be derived, due to |
| 4876 | # the job's base compensation entry cannot be annualized. |
| 4877 | # See CompensationEntry for explanation on annualization and base |
| 4878 | # compensation entry. |
| 4879 | "entries": [ # Optional. Job compensation information. |
| 4880 | # |
| 4881 | # At most one entry can be of type |
| 4882 | # ExtendedCompensationInfo.CompensationType.BASE, which is |
| 4883 | # referred as ** base compensation entry ** for the job. |
| 4884 | { # Deprecated. See CompensationInfo. |
| 4885 | # |
| 4886 | # A compensation entry that represents one component of compensation, such |
| 4887 | # as base pay, bonus, or other compensation type. |
| 4888 | # |
| 4889 | # Annualization: One compensation entry can be annualized if |
| 4890 | # - it contains valid amount or range. |
| 4891 | # - and its expected_units_per_year is set or can be derived. |
| 4892 | # Its annualized range is determined as (amount or range) times |
| 4893 | # expected_units_per_year. |
| 4894 | "range": { # Deprecated. See CompensationInfo. # Optional. Compensation range. |
| 4895 | # |
| 4896 | # Compensation range. |
| 4897 | "max": { # Deprecated. See CompensationInfo. # Required. Maximum value. |
| 4898 | # |
| 4899 | # Decimal number. |
| 4900 | "micros": 42, # Micro (10^-6) units. |
| 4901 | # The value must be between -999,999 and +999,999 inclusive. |
| 4902 | # If `units` is positive, `micros` must be positive or zero. |
| 4903 | # If `units` is zero, `micros` can be positive, zero, or negative. |
| 4904 | # If `units` is negative, `micros` must be negative or zero. |
| 4905 | # For example -1.75 is represented as `units`=-1 and `micros`=-750,000. |
| 4906 | "units": "A String", # Whole units. |
| 4907 | }, |
| 4908 | "min": { # Deprecated. See CompensationInfo. # Required. Minimum value. |
| 4909 | # |
| 4910 | # Decimal number. |
| 4911 | "micros": 42, # Micro (10^-6) units. |
| 4912 | # The value must be between -999,999 and +999,999 inclusive. |
| 4913 | # If `units` is positive, `micros` must be positive or zero. |
| 4914 | # If `units` is zero, `micros` can be positive, zero, or negative. |
| 4915 | # If `units` is negative, `micros` must be negative or zero. |
| 4916 | # For example -1.75 is represented as `units`=-1 and `micros`=-750,000. |
| 4917 | "units": "A String", # Whole units. |
| 4918 | }, |
| 4919 | }, |
| 4920 | "expectedUnitsPerYear": { # Deprecated. See CompensationInfo. # Optional. Expected number of units paid each year. If not specified, when |
| 4921 | # Job.employment_types is FULLTIME, a default value is inferred |
| 4922 | # based on unit. Default values: |
| 4923 | # - HOURLY: 2080 |
| 4924 | # - DAILY: 260 |
| 4925 | # - WEEKLY: 52 |
| 4926 | # - MONTHLY: 12 |
| 4927 | # - ANNUAL: 1 |
| 4928 | # |
| 4929 | # Decimal number. |
| 4930 | "micros": 42, # Micro (10^-6) units. |
| 4931 | # The value must be between -999,999 and +999,999 inclusive. |
| 4932 | # If `units` is positive, `micros` must be positive or zero. |
| 4933 | # If `units` is zero, `micros` can be positive, zero, or negative. |
| 4934 | # If `units` is negative, `micros` must be negative or zero. |
| 4935 | # For example -1.75 is represented as `units`=-1 and `micros`=-750,000. |
| 4936 | "units": "A String", # Whole units. |
| 4937 | }, |
| 4938 | "amount": { # Deprecated. See CompensationInfo. # Optional. Monetary amount. |
| 4939 | # |
| 4940 | # Decimal number. |
| 4941 | "micros": 42, # Micro (10^-6) units. |
| 4942 | # The value must be between -999,999 and +999,999 inclusive. |
| 4943 | # If `units` is positive, `micros` must be positive or zero. |
| 4944 | # If `units` is zero, `micros` can be positive, zero, or negative. |
| 4945 | # If `units` is negative, `micros` must be negative or zero. |
| 4946 | # For example -1.75 is represented as `units`=-1 and `micros`=-750,000. |
| 4947 | "units": "A String", # Whole units. |
| 4948 | }, |
| 4949 | "description": "A String", # Optional. Compensation description. |
| 4950 | "unspecified": True or False, # Optional. Indicates compensation amount and range are unset. |
| 4951 | "unit": "A String", # Optional. Frequency of the specified amount. |
| 4952 | # |
| 4953 | # Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED. |
| 4954 | "type": "A String", # Required. Compensation type. |
| 4955 | }, |
| 4956 | ], |
| 4957 | "annualizedTotalCompensationRange": { # Deprecated. See CompensationInfo. # Output only. Annualized total compensation range. |
| 4958 | # |
| 4959 | # Compensation range. |
| 4960 | "max": { # Deprecated. See CompensationInfo. # Required. Maximum value. |
| 4961 | # |
| 4962 | # Decimal number. |
| 4963 | "micros": 42, # Micro (10^-6) units. |
| 4964 | # The value must be between -999,999 and +999,999 inclusive. |
| 4965 | # If `units` is positive, `micros` must be positive or zero. |
| 4966 | # If `units` is zero, `micros` can be positive, zero, or negative. |
| 4967 | # If `units` is negative, `micros` must be negative or zero. |
| 4968 | # For example -1.75 is represented as `units`=-1 and `micros`=-750,000. |
| 4969 | "units": "A String", # Whole units. |
| 4970 | }, |
| 4971 | "min": { # Deprecated. See CompensationInfo. # Required. Minimum value. |
| 4972 | # |
| 4973 | # Decimal number. |
| 4974 | "micros": 42, # Micro (10^-6) units. |
| 4975 | # The value must be between -999,999 and +999,999 inclusive. |
| 4976 | # If `units` is positive, `micros` must be positive or zero. |
| 4977 | # If `units` is zero, `micros` can be positive, zero, or negative. |
| 4978 | # If `units` is negative, `micros` must be negative or zero. |
| 4979 | # For example -1.75 is represented as `units`=-1 and `micros`=-750,000. |
| 4980 | "units": "A String", # Whole units. |
| 4981 | }, |
| 4982 | }, |
| 4983 | }, |
| 4984 | "startDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Optional. The start date of the job in UTC time zone. Typically this field |
| 4985 | # is used for contracting engagements. |
| 4986 | # Dates prior to 1970/1/1 and invalid date formats are ignored. |
| 4987 | # and time zone are either specified elsewhere or are not significant. The date |
| 4988 | # is relative to the Proleptic Gregorian Calendar. This can represent: |
| 4989 | # |
| 4990 | # * A full date, with non-zero year, month and day values |
| 4991 | # * A month and day value, with a zero year, e.g. an anniversary |
| 4992 | # * A year on its own, with zero month and day values |
| 4993 | # * A year and month value, with a zero day, e.g. a credit card expiration date |
| 4994 | # |
| 4995 | # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. |
| 4996 | "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| 4997 | # a year. |
| 4998 | "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| 4999 | # if specifying a year by itself or a year and month where the day is not |
| 5000 | # significant. |
| 5001 | "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| 5002 | # month and day. |
| 5003 | }, |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 5004 | "department": "A String", # Optional. The department or functional area within the company with the open |
| 5005 | # position. |
| 5006 | # |
| 5007 | # The maximum number of allowed characters is 255. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 5008 | "applicationEmailList": [ # Optional but at least one of application_urls, |
| 5009 | # application_email_list or application_instruction must be |
| 5010 | # specified. |
| 5011 | # |
| 5012 | # Use this field to specify email address(es) to which resumes or |
| 5013 | # applications can be sent. |
| 5014 | # |
| 5015 | # The maximum number of allowed characters is 255. |
| 5016 | "A String", |
| 5017 | ], |
| 5018 | "companyTitle": "A String", # Deprecated. Use company_display_name instead. |
| 5019 | # |
| 5020 | # Output only. |
| 5021 | # |
| 5022 | # The name of the company listing the job. |
| 5023 | "level": "A String", # Optional. The experience level associated with the job, such as "Entry Level". |
| 5024 | "filterableCustomFields": { # Deprecated. Use custom_attributes instead. |
| 5025 | # |
| 5026 | # Optional. |
| 5027 | # |
| 5028 | # A map of fields to hold filterable custom job attributes not captured by |
| 5029 | # the standard fields such as job_title, company_name, or |
| 5030 | # level. These custom fields store arbitrary |
| 5031 | # string values, and can be used for purposes not covered by |
| 5032 | # the structured fields. For the best search experience, use of the |
| 5033 | # structured rather than custom fields is recommended. |
| 5034 | # |
| 5035 | # Data stored in these custom fields fields are indexed and |
| 5036 | # searched against by keyword searches (see |
| 5037 | # SearchJobsRequest.custom_field_filters][]). |
| 5038 | # |
| 5039 | # The map key must be a number between 1-20. If an invalid key is |
| 5040 | # provided on job create or update, an error is returned. |
| 5041 | "a_key": { # Resource that represents the custom data not captured by the standard fields. |
| 5042 | "values": [ # Optional. The values of the custom data. |
| 5043 | "A String", |
| 5044 | ], |
| 5045 | }, |
| 5046 | }, |
| 5047 | "compensationInfo": { # Job compensation details. # Optional. Job compensation information. |
| 5048 | "entries": [ # Optional. Job compensation information. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5049 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 5050 | # At most one entry can be of type |
| 5051 | # CompensationInfo.CompensationType.BASE, which is |
| 5052 | # referred as ** base compensation entry ** for the job. |
| 5053 | { # A compensation entry that represents one component of compensation, such |
| 5054 | # as base pay, bonus, or other compensation type. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5055 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 5056 | # Annualization: One compensation entry can be annualized if |
| 5057 | # - it contains valid amount or range. |
| 5058 | # - and its expected_units_per_year is set or can be derived. |
| 5059 | # Its annualized range is determined as (amount or range) times |
| 5060 | # expected_units_per_year. |
| 5061 | "amount": { # Represents an amount of money with its currency type. # Optional. Compensation amount. |
| 5062 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 5063 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 5064 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 5065 | # If `units` is positive, `nanos` must be positive or zero. |
| 5066 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 5067 | # If `units` is negative, `nanos` must be negative or zero. |
| 5068 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 5069 | "units": "A String", # The whole units of the amount. |
| 5070 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 5071 | }, |
| 5072 | "description": "A String", # Optional. Compensation description. For example, could |
| 5073 | # indicate equity terms or provide additional context to an estimated |
| 5074 | # bonus. |
| 5075 | "expectedUnitsPerYear": 3.14, # Optional. Expected number of units paid each year. If not specified, when |
| 5076 | # Job.employment_types is FULLTIME, a default value is inferred |
| 5077 | # based on unit. Default values: |
| 5078 | # - HOURLY: 2080 |
| 5079 | # - DAILY: 260 |
| 5080 | # - WEEKLY: 52 |
| 5081 | # - MONTHLY: 12 |
| 5082 | # - ANNUAL: 1 |
| 5083 | "range": { # Compensation range. # Optional. Compensation range. |
| 5084 | "min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set |
| 5085 | # to zero and the currency code is set to match the |
| 5086 | # currency code of max_compensation. |
| 5087 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 5088 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 5089 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 5090 | # If `units` is positive, `nanos` must be positive or zero. |
| 5091 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 5092 | # If `units` is negative, `nanos` must be negative or zero. |
| 5093 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 5094 | "units": "A String", # The whole units of the amount. |
| 5095 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 5096 | }, |
| 5097 | "max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set |
| 5098 | # to a maximal compensation value and the currency code is set to |
| 5099 | # match the currency code of |
| 5100 | # min_compensation. |
| 5101 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 5102 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 5103 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 5104 | # If `units` is positive, `nanos` must be positive or zero. |
| 5105 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 5106 | # If `units` is negative, `nanos` must be negative or zero. |
| 5107 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 5108 | "units": "A String", # The whole units of the amount. |
| 5109 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 5110 | }, |
| 5111 | }, |
| 5112 | "type": "A String", # Required. Compensation type. |
| 5113 | "unit": "A String", # Optional. Frequency of the specified amount. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5114 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 5115 | # Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5116 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 5117 | ], |
| 5118 | "annualizedBaseCompensationRange": { # Compensation range. # Output only. Annualized base compensation range. Computed as |
| 5119 | # base compensation entry's CompensationEntry.compensation times |
| 5120 | # CompensationEntry.expected_units_per_year. |
| 5121 | # |
| 5122 | # See CompensationEntry for explanation on compensation annualization. |
| 5123 | "min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set |
| 5124 | # to zero and the currency code is set to match the |
| 5125 | # currency code of max_compensation. |
| 5126 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 5127 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 5128 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 5129 | # If `units` is positive, `nanos` must be positive or zero. |
| 5130 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 5131 | # If `units` is negative, `nanos` must be negative or zero. |
| 5132 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 5133 | "units": "A String", # The whole units of the amount. |
| 5134 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 5135 | }, |
| 5136 | "max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set |
| 5137 | # to a maximal compensation value and the currency code is set to |
| 5138 | # match the currency code of |
| 5139 | # min_compensation. |
| 5140 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 5141 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 5142 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 5143 | # If `units` is positive, `nanos` must be positive or zero. |
| 5144 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 5145 | # If `units` is negative, `nanos` must be negative or zero. |
| 5146 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 5147 | "units": "A String", # The whole units of the amount. |
| 5148 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5149 | }, |
| 5150 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 5151 | "amount": { # Represents an amount of money with its currency type. # Deprecated. Use entries instead. |
| 5152 | # |
| 5153 | # Optional. |
| 5154 | # |
| 5155 | # The amount of compensation or pay for the job. |
| 5156 | # As an alternative, compensation_amount_min and |
| 5157 | # compensation_amount_max may be used to define a range of |
| 5158 | # compensation. |
| 5159 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 5160 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 5161 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 5162 | # If `units` is positive, `nanos` must be positive or zero. |
| 5163 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 5164 | # If `units` is negative, `nanos` must be negative or zero. |
| 5165 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 5166 | "units": "A String", # The whole units of the amount. |
| 5167 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 5168 | }, |
| 5169 | "max": { # Represents an amount of money with its currency type. # Deprecated. Use entries instead. |
| 5170 | # |
| 5171 | # Optional. |
| 5172 | # |
| 5173 | # An upper bound on a range for compensation or pay for the job. |
| 5174 | # The currency type is specified in compensation_amount. |
| 5175 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 5176 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 5177 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 5178 | # If `units` is positive, `nanos` must be positive or zero. |
| 5179 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 5180 | # If `units` is negative, `nanos` must be negative or zero. |
| 5181 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 5182 | "units": "A String", # The whole units of the amount. |
| 5183 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 5184 | }, |
| 5185 | "type": "A String", # Deprecated. Use entries instead. |
| 5186 | # |
| 5187 | # Optional. |
| 5188 | # |
| 5189 | # Type of job compensation. |
| 5190 | "min": { # Represents an amount of money with its currency type. # Deprecated. Use entries instead. |
| 5191 | # |
| 5192 | # Optional. |
| 5193 | # |
| 5194 | # A lower bound on a range for compensation or pay for the job. |
| 5195 | # The currency type is specified in compensation_amount. |
| 5196 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 5197 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 5198 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 5199 | # If `units` is positive, `nanos` must be positive or zero. |
| 5200 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 5201 | # If `units` is negative, `nanos` must be negative or zero. |
| 5202 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 5203 | "units": "A String", # The whole units of the amount. |
| 5204 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 5205 | }, |
| 5206 | "annualizedTotalCompensationRange": { # Compensation range. # Output only. Annualized total compensation range. Computed as |
| 5207 | # all compensation entries' CompensationEntry.compensation times |
| 5208 | # CompensationEntry.expected_units_per_year. |
| 5209 | # |
| 5210 | # See CompensationEntry for explanation on compensation annualization. |
| 5211 | "min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set |
| 5212 | # to zero and the currency code is set to match the |
| 5213 | # currency code of max_compensation. |
| 5214 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 5215 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 5216 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 5217 | # If `units` is positive, `nanos` must be positive or zero. |
| 5218 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 5219 | # If `units` is negative, `nanos` must be negative or zero. |
| 5220 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 5221 | "units": "A String", # The whole units of the amount. |
| 5222 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 5223 | }, |
| 5224 | "max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set |
| 5225 | # to a maximal compensation value and the currency code is set to |
| 5226 | # match the currency code of |
| 5227 | # min_compensation. |
| 5228 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 5229 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 5230 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 5231 | # If `units` is positive, `nanos` must be positive or zero. |
| 5232 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 5233 | # If `units` is negative, `nanos` must be negative or zero. |
| 5234 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 5235 | "units": "A String", # The whole units of the amount. |
| 5236 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 5237 | }, |
| 5238 | }, |
| 5239 | }, |
| 5240 | "region": "A String", # Optional. The job Region (for example, state, country) throughout which the job |
| 5241 | # is available. If this field is set, a |
| 5242 | # LocationFilter in a search query within the job region |
| 5243 | # finds this job if an exact location match is not specified. |
| 5244 | # If this field is set, setting job locations |
| 5245 | # to the same location level as this field is strongly recommended. |
| 5246 | "createTime": "A String", # Output only. The timestamp when this job was created. |
| 5247 | "incentives": "A String", # Optional. A description of bonus, commission, and other compensation |
| 5248 | # incentives associated with the job not including salary or pay. |
| 5249 | # |
| 5250 | # The maximum number of allowed characters is 10,000. |
| 5251 | "companyDisplayName": "A String", # Output only. The name of the company listing the job. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5252 | "unindexedCustomFields": { # Deprecated. Use custom_attributes instead. |
| 5253 | # |
| 5254 | # Optional. |
| 5255 | # |
| 5256 | # A map of fields to hold non-filterable custom job attributes, similar to |
| 5257 | # filterable_custom_fields. These fields are distinct in that the data |
| 5258 | # in these fields are not indexed. Therefore, the client cannot search |
| 5259 | # against them, nor can the client use them to list jobs. |
| 5260 | # |
| 5261 | # The key of the map can be any valid string. |
| 5262 | "a_key": { # Resource that represents the custom data not captured by the standard fields. |
| 5263 | "values": [ # Optional. The values of the custom data. |
| 5264 | "A String", |
| 5265 | ], |
| 5266 | }, |
| 5267 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 5268 | "visibility": "A String", # Optional. The visibility of the job. |
| 5269 | # Defaults to JobVisibility.PRIVATE if not specified. |
| 5270 | # Currently only JobVisibility.PRIVATE is supported. |
| 5271 | "employmentTypes": [ # Optional. The employment type(s) of a job, for example, |
| 5272 | # full time or |
| 5273 | # part time. |
| 5274 | "A String", |
| 5275 | ], |
| 5276 | "benefits": [ # Optional. The benefits included with the job. |
| 5277 | "A String", |
| 5278 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5279 | "expiryDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Deprecated. Use expire_time instead. |
| 5280 | # |
| 5281 | # Optional but strongly recommended to be provided for the best service |
| 5282 | # experience. |
| 5283 | # |
| 5284 | # The expiration date of the job in UTC time. After 12 am on this date, the |
| 5285 | # job is marked as expired, and it no longer appears in search results. |
| 5286 | # The expired job can't be deleted or listed by the DeleteJob and |
| 5287 | # ListJobs APIs, but it can be retrieved with the GetJob API or |
| 5288 | # updated with the UpdateJob API. An expired job can be updated and |
| 5289 | # opened again by using a future expiration date. It can also remain expired. |
| 5290 | # Updating an expired job to be open fails if there is another existing open |
| 5291 | # job with same requisition_id, company_name and language_code. |
| 5292 | # |
| 5293 | # The expired jobs are retained in our system for 90 days. However, the |
| 5294 | # overall expired job count cannot exceed 3 times the maximum of open jobs |
| 5295 | # count over the past week, otherwise jobs with earlier expire time are |
| 5296 | # removed first. Expired jobs are no longer accessible after they are cleaned |
| 5297 | # out. |
| 5298 | # |
| 5299 | # A valid date range is between 1970/1/1 and 2100/12/31. Invalid dates are |
| 5300 | # ignored and treated as expiry date not provided. |
| 5301 | # |
| 5302 | # If this value is not provided on job creation or is invalid, the job |
| 5303 | # posting expires after 30 days from the job's creation time. For example, if |
| 5304 | # the job was created on 2017/01/01 13:00AM UTC with an unspecified |
| 5305 | # expiration date, the job expires after 2017/01/31 13:00AM UTC. |
| 5306 | # |
| 5307 | # If this value is not provided on job update, it depends on the field masks |
| 5308 | # set by UpdateJobRequest.update_job_fields. If the field masks include |
| 5309 | # expiry_date, or the masks are empty meaning that every field is |
| 5310 | # updated, the job expires after 30 days from the job's last update time. |
| 5311 | # Otherwise the expiration date isn't updated. |
| 5312 | # and time zone are either specified elsewhere or are not significant. The date |
| 5313 | # is relative to the Proleptic Gregorian Calendar. This can represent: |
| 5314 | # |
| 5315 | # * A full date, with non-zero year, month and day values |
| 5316 | # * A month and day value, with a zero year, e.g. an anniversary |
| 5317 | # * A year on its own, with zero month and day values |
| 5318 | # * A year and month value, with a zero day, e.g. a credit card expiration date |
| 5319 | # |
| 5320 | # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 5321 | "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| 5322 | # a year. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5323 | "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| 5324 | # if specifying a year by itself or a year and month where the day is not |
| 5325 | # significant. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5326 | "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| 5327 | # month and day. |
| 5328 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 5329 | "companyName": "A String", # Optional but one of company_name or distributor_company_id must be |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5330 | # provided. |
| 5331 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 5332 | # The resource name of the company listing the job, such as |
| 5333 | # /companies/foo. This field takes precedence over the |
| 5334 | # distributor-assigned company identifier, distributor_company_id. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5335 | "locations": [ # Optional but strongly recommended for the best service experience. |
| 5336 | # |
| 5337 | # Location(s) where the emploeyer is looking to hire for this job posting. |
| 5338 | # |
| 5339 | # Specifying the full street address(es) of the hiring location enables |
| 5340 | # better API results, especially job searches by commute time. |
| 5341 | # |
| 5342 | # At most 50 locations are allowed for best search performance. If a job has |
| 5343 | # more locations, it is suggested to split it into multiple jobs with unique |
| 5344 | # requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as |
| 5345 | # multiple jobs with the same requisition_id, company_name and |
| 5346 | # language_code are not allowed. If the original requisition_id must |
| 5347 | # be preserved, a custom field should be used for storage. It is also |
| 5348 | # suggested to group the locations that close to each other in the same job |
| 5349 | # for better search experience. |
| 5350 | # |
| 5351 | # The maximum number of allowed characters is 500. |
| 5352 | "A String", |
| 5353 | ], |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 5354 | "endDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Optional. The end date of the job in UTC time zone. Typically this field |
| 5355 | # is used for contracting engagements. |
| 5356 | # Dates prior to 1970/1/1 and invalid date formats are ignored. |
| 5357 | # and time zone are either specified elsewhere or are not significant. The date |
| 5358 | # is relative to the Proleptic Gregorian Calendar. This can represent: |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5359 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 5360 | # * A full date, with non-zero year, month and day values |
| 5361 | # * A month and day value, with a zero year, e.g. an anniversary |
| 5362 | # * A year on its own, with zero month and day values |
| 5363 | # * A year and month value, with a zero day, e.g. a credit card expiration date |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5364 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 5365 | # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. |
| 5366 | "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| 5367 | # a year. |
| 5368 | "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| 5369 | # if specifying a year by itself or a year and month where the day is not |
| 5370 | # significant. |
| 5371 | "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| 5372 | # month and day. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5373 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5374 | }, |
| 5375 | "processingOptions": { # Input only. # Optional. Options for job processing. |
| 5376 | # |
| 5377 | # UpdateJobRequest.disable_street_address_resolution is ignored if this |
| 5378 | # flag is set. |
| 5379 | # |
| 5380 | # Options for job processing. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 5381 | "disableStreetAddressResolution": True or False, # Optional. If set to `true`, the service does not attempt to resolve a |
| 5382 | # more precise address for the job. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5383 | "htmlSanitization": "A String", # Optional. Option for job HTML content sanitization. Applied fields are: |
| 5384 | # |
| 5385 | # * description |
| 5386 | # * applicationInstruction |
| 5387 | # * incentives |
| 5388 | # * qualifications |
| 5389 | # * responsibilities |
| 5390 | # |
| 5391 | # HTML tags in these fields may be stripped if sanitiazation is not disabled. |
| 5392 | # |
| 5393 | # Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY. |
| 5394 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 5395 | "updateJobFields": "A String", # Optional but strongly recommended to be provided for the best service |
| 5396 | # experience. |
| 5397 | # |
| 5398 | # If update_job_fields is provided, only the specified fields in |
| 5399 | # job are updated. Otherwise all the fields are updated. |
| 5400 | # |
| 5401 | # A field mask to restrict the fields that are updated. Valid values are: |
| 5402 | # |
| 5403 | # * jobTitle |
| 5404 | # * employmentTypes |
| 5405 | # * description |
| 5406 | # * applicationUrls |
| 5407 | # * applicationEmailList |
| 5408 | # * applicationInstruction |
| 5409 | # * responsibilities |
| 5410 | # * qualifications |
| 5411 | # * educationLevels |
| 5412 | # * level |
| 5413 | # * department |
| 5414 | # * startDate |
| 5415 | # * endDate |
| 5416 | # * compensationInfo |
| 5417 | # * incentives |
| 5418 | # * languageCode |
| 5419 | # * benefits |
| 5420 | # * expireTime |
| 5421 | # * customAttributes |
| 5422 | # * visibility |
| 5423 | # * publishDate |
| 5424 | # * promotionValue |
| 5425 | # * locations |
| 5426 | # * region |
| 5427 | # * expiryDate (deprecated) |
| 5428 | # * filterableCustomFields (deprecated) |
| 5429 | # * unindexedCustomFields (deprecated) |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5430 | "disableStreetAddressResolution": True or False, # Deprecated. Please use processing_options. This flag is ignored if |
| 5431 | # processing_options is set. |
| 5432 | # |
| 5433 | # Optional. |
| 5434 | # |
| 5435 | # If set to `true`, the service does not attempt resolve a more precise |
| 5436 | # address for the job. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 5437 | } |
| 5438 | |
| 5439 | x__xgafv: string, V1 error format. |
| 5440 | Allowed values |
| 5441 | 1 - v1 error format |
| 5442 | 2 - v2 error format |
| 5443 | |
| 5444 | Returns: |
| 5445 | An object of the form: |
| 5446 | |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5447 | { # A Job resource represents a job posting (also referred to as a "job listing" |
| 5448 | # 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] | 5449 | # entity responsible for the job. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 5450 | "languageCode": "A String", # Optional. The language of the posting. This field is distinct from |
| 5451 | # any requirements for fluency that are associated with the job. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 5452 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 5453 | # Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn". |
| 5454 | # For more information, see |
| 5455 | # [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){: |
| 5456 | # class="external" target="_blank" }. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 5457 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 5458 | # If this field is unspecified and Job.description is present, detected |
| 5459 | # language code based on Job.description is assigned, otherwise |
| 5460 | # defaults to 'en_US'. |
| 5461 | "educationLevels": [ # Optional. The desired education level for the job, such as |
| 5462 | # "Bachelors", "Masters", "Doctorate". |
| 5463 | "A String", |
| 5464 | ], |
| 5465 | "description": "A String", # Required. The description of the job, which typically includes a multi-paragraph |
| 5466 | # description of the company and related information. Separate fields are |
| 5467 | # provided on the job object for responsibilities, |
| 5468 | # qualifications, and other job characteristics. Use of |
| 5469 | # these separate job fields is recommended. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 5470 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 5471 | # This field accepts and sanitizes HTML input, and also accepts |
| 5472 | # bold, italic, ordered list, and unordered list markup tags. |
| 5473 | # |
| 5474 | # The maximum number of allowed characters is 100,000. |
| 5475 | "updateTime": "A String", # Output only. The timestamp when this job was last updated. |
| 5476 | "promotionValue": 42, # Optional. A promotion value of the job, as determined by the client. |
| 5477 | # The value determines the sort order of the jobs returned when searching for |
| 5478 | # jobs using the featured jobs search call, with higher promotional values |
| 5479 | # being returned first and ties being resolved by relevance sort. Only the |
| 5480 | # jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH. |
| 5481 | # |
| 5482 | # Default value is 0, and negative values are treated as 0. |
| 5483 | "qualifications": "A String", # Optional. A description of the qualifications required to perform the |
| 5484 | # job. The use of this field is recommended |
| 5485 | # as an alternative to using the more general description field. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 5486 | # |
| 5487 | # This field accepts and sanitizes HTML input, and also accepts |
| 5488 | # bold, italic, ordered list, and unordered list markup tags. |
| 5489 | # |
| 5490 | # The maximum number of allowed characters is 10,000. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 5491 | "customAttributes": { # Optional. A map of fields to hold both filterable and non-filterable custom job |
| 5492 | # attributes that are not covered by the provided structured fields. |
| 5493 | # |
| 5494 | # This field is a more general combination of the deprecated id-based |
| 5495 | # filterable_custom_fields and string-based |
| 5496 | # non_filterable_custom_fields. |
| 5497 | # |
| 5498 | # The keys of the map are strings up to 64 bytes and must match the |
| 5499 | # pattern: a-zA-Z*. |
| 5500 | # |
| 5501 | # At most 100 filterable and at most 100 unfilterable keys are supported. |
| 5502 | # For filterable `string_values`, across all keys at most 200 values are |
| 5503 | # allowed, with each string no more than 255 characters. For unfilterable |
| 5504 | # `string_values`, the maximum total size of `string_values` across all keys |
| 5505 | # is 50KB. |
| 5506 | "a_key": { # Custom attribute values that are either filterable or non-filterable. |
| 5507 | "longValue": "A String", # Optional but at least one of string_values or long_value must |
| 5508 | # be specified. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 5509 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 5510 | # This field is used to perform number range search. |
| 5511 | # (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`. For |
| 5512 | # `long_value`, a value between Long.MIN and Long.MAX is allowed. |
| 5513 | "filterable": True or False, # Optional. If the `filterable` flag is true, custom field values are searchable. |
| 5514 | # If false, values are not searchable. |
| 5515 | # |
| 5516 | # Default is false. |
| 5517 | "stringValues": { # Represents array of string values. # Optional but at least one of string_values or long_value must |
| 5518 | # be specified. |
| 5519 | # |
| 5520 | # This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or |
| 5521 | # `CASE_INSENSITIVE_MATCH`) search. |
| 5522 | # For filterable `string_values`, a maximum total number of 200 values |
| 5523 | # is allowed, with each `string_value` has a byte size of no more than |
| 5524 | # 255B. For unfilterable `string_values`, the maximum total byte size of |
| 5525 | # unfilterable `string_values` is 50KB. |
| 5526 | # |
| 5527 | # Empty strings are not allowed. |
| 5528 | "values": [ # Required. String values. |
| 5529 | "A String", |
| 5530 | ], |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 5531 | }, |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 5532 | }, |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 5533 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 5534 | "applicationUrls": [ # Optional but at least one of application_urls, |
| 5535 | # application_email_list or application_instruction must be |
| 5536 | # specified. |
| 5537 | # |
| 5538 | # Use this URL field to direct an applicant to a website, for example to |
| 5539 | # link to an online application form. |
| 5540 | # |
| 5541 | # The maximum number of allowed characters is 2,000. |
| 5542 | "A String", |
| 5543 | ], |
| 5544 | "requisitionId": "A String", # Required. The requisition ID, also referred to as the posting ID, assigned by the |
| 5545 | # client to identify a job. This field is intended to be used by clients |
| 5546 | # for client identification and tracking of listings. A job is not allowed |
| 5547 | # to be created if there is another job with the same requisition_id, |
| 5548 | # company_name and language_code. |
| 5549 | # |
| 5550 | # The maximum number of allowed characters is 255. |
| 5551 | "jobLocations": [ # Output only. Structured locations of the job, resolved from locations. |
| 5552 | { # Output only. |
| 5553 | # |
| 5554 | # A resource that represents a location with full geographic |
| 5555 | # information. |
| 5556 | "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair. |
| 5557 | # of doubles representing degrees latitude and degrees longitude. Unless |
| 5558 | # specified otherwise, this must conform to the |
| 5559 | # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 |
| 5560 | # standard</a>. Values must be within normalized ranges. |
| 5561 | "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. |
| 5562 | "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. |
| 5563 | }, |
| 5564 | "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information, |
| 5565 | # such as postal delivery and payments addresses. Given a postal address, |
| 5566 | # a postal service can deliver items to a premises, P.O. Box, or other |
| 5567 | # delivery location. |
| 5568 | # Given a postal address, a postal service can deliver items to a premise, P.O. |
| 5569 | # Box or similar. |
| 5570 | # It is not intended to model geographical locations (roads, towns, |
| 5571 | # mountains). |
| 5572 | # |
| 5573 | # In typical usage an address would be created via user input or from importing |
| 5574 | # existing data, depending on the type of process. |
| 5575 | # |
| 5576 | # Advice on address input / editing: |
| 5577 | # - Use an i18n-ready address widget such as |
| 5578 | # https://github.com/google/libaddressinput) |
| 5579 | # - Users should not be presented with UI elements for input or editing of |
| 5580 | # fields outside countries where that field is used. |
| 5581 | # |
| 5582 | # For more guidance on how to use this schema, please see: |
| 5583 | # https://support.google.com/business/answer/6397478 |
| 5584 | "sublocality": "A String", # Optional. Sublocality of the address. |
| 5585 | # For example, this can be neighborhoods, boroughs, districts. |
| 5586 | "recipients": [ # Optional. The recipient at the address. |
| 5587 | # This field may, under certain circumstances, contain multiline information. |
| 5588 | # For example, it might contain "care of" information. |
| 5589 | "A String", |
| 5590 | ], |
| 5591 | "locality": "A String", # Optional. Generally refers to the city/town portion of the address. |
| 5592 | # Examples: US city, IT comune, UK post town. |
| 5593 | # In regions of the world where localities are not well defined or do not fit |
| 5594 | # into this structure well, leave locality empty and use address_lines. |
| 5595 | "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This |
| 5596 | # is never inferred and it is up to the user to ensure the value is |
| 5597 | # correct. See http://cldr.unicode.org/ and |
| 5598 | # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html |
| 5599 | # for details. Example: "CH" for Switzerland. |
| 5600 | "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if |
| 5601 | # known). This is often the UI language of the input form or is expected |
| 5602 | # to match one of the languages used in the address' country/region, or their |
| 5603 | # transliterated equivalents. |
| 5604 | # This can affect formatting in certain countries, but is not critical |
| 5605 | # to the correctness of the data and will never affect any validation or |
| 5606 | # other non-formatting related operations. |
| 5607 | # |
| 5608 | # If this value is not known, it should be omitted (rather than specifying a |
| 5609 | # possibly incorrect default). |
| 5610 | # |
| 5611 | # Examples: "zh-Hant", "ja", "ja-Latn", "en". |
| 5612 | "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require |
| 5613 | # postal codes to be present, but where they are used, they may trigger |
| 5614 | # additional validation with other parts of the address (e.g. state/zip |
| 5615 | # validation in the U.S.A.). |
| 5616 | "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal |
| 5617 | # addresses of a country or region. |
| 5618 | # For example, this can be a state, a province, an oblast, or a prefecture. |
| 5619 | # Specifically, for Spain this is the province and not the autonomous |
| 5620 | # community (e.g. "Barcelona" and not "Catalonia"). |
| 5621 | # Many countries don't use an administrative area in postal addresses. E.g. |
| 5622 | # in Switzerland this should be left unpopulated. |
| 5623 | "addressLines": [ # Unstructured address lines describing the lower levels of an address. |
| 5624 | # |
| 5625 | # Because values in address_lines do not have type information and may |
| 5626 | # sometimes contain multiple values in a single field (e.g. |
| 5627 | # "Austin, TX"), it is important that the line order is clear. The order of |
| 5628 | # address lines should be "envelope order" for the country/region of the |
| 5629 | # address. In places where this can vary (e.g. Japan), address_language is |
| 5630 | # used to make it explicit (e.g. "ja" for large-to-small ordering and |
| 5631 | # "ja-Latn" or "en" for small-to-large). This way, the most specific line of |
| 5632 | # an address can be selected based on the language. |
| 5633 | # |
| 5634 | # The minimum permitted structural representation of an address consists |
| 5635 | # of a region_code with all remaining information placed in the |
| 5636 | # address_lines. It would be possible to format such an address very |
| 5637 | # approximately without geocoding, but no semantic reasoning could be |
| 5638 | # made about any of the address components until it was at least |
| 5639 | # partially resolved. |
| 5640 | # |
| 5641 | # Creating an address only containing a region_code and address_lines, and |
| 5642 | # then geocoding is the recommended way to handle completely unstructured |
| 5643 | # addresses (as opposed to guessing which parts of the address should be |
| 5644 | # localities or administrative areas). |
| 5645 | "A String", |
| 5646 | ], |
| 5647 | "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used |
| 5648 | # in most regions. Where it is used, the value is either a string like |
| 5649 | # "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number |
| 5650 | # alone, representing the "sector code" (Jamaica), "delivery area indicator" |
| 5651 | # (Malawi) or "post office indicator" (e.g. Côte d'Ivoire). |
| 5652 | "organization": "A String", # Optional. The name of the organization at the address. |
| 5653 | "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is |
| 5654 | # the latest revision. |
| 5655 | # |
| 5656 | # All new revisions **must** be backward compatible with old revisions. |
| 5657 | }, |
| 5658 | "locationType": "A String", # The type of a location, which corresponds to the address lines field of |
| 5659 | # PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of |
| 5660 | # LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of |
| 5661 | # LocationType#LOCALITY. |
| 5662 | "radiusMeters": 3.14, # Radius in meters of the job location. This value is derived from the |
| 5663 | # location bounding box in which a circle with the specified radius |
| 5664 | # centered from LatLng coves the area associated with the job location. |
| 5665 | # For example, currently, "Mountain View, CA, USA" has a radius of |
| 5666 | # 7885.79 meters. |
| 5667 | }, |
| 5668 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5669 | "expireTime": "A String", # Optional but strongly recommended for the best service |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 5670 | # experience. |
| 5671 | # |
| 5672 | # The expiration timestamp of the job. After this timestamp, the |
| 5673 | # job is marked as expired, and it no longer appears in search results. The |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5674 | # expired job can't be deleted or listed by the DeleteJob and |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 5675 | # ListJobs APIs, but it can be retrieved with the GetJob API or |
| 5676 | # updated with the UpdateJob API. An expired job can be updated and |
| 5677 | # opened again by using a future expiration timestamp. Updating an expired |
| 5678 | # job fails if there is another existing open job with same |
| 5679 | # requisition_id, company_name and language_code. |
| 5680 | # |
| 5681 | # The expired jobs are retained in our system for 90 days. However, the |
| 5682 | # overall expired job count cannot exceed 3 times the maximum of open jobs |
| 5683 | # count over the past week, otherwise jobs with earlier expire time are |
| 5684 | # cleaned first. Expired jobs are no longer accessible after they are cleaned |
| 5685 | # out. |
| 5686 | # The format of this field is RFC 3339 date strings. Example: |
| 5687 | # 2000-01-01T00:00:00.999999999Z |
| 5688 | # See |
| 5689 | # [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt). |
| 5690 | # |
| 5691 | # A valid date range is between 1970-01-01T00:00:00.0Z and |
| 5692 | # 2100-12-31T23:59:59.999Z. Invalid dates are ignored and treated as expire |
| 5693 | # time not provided. |
| 5694 | # |
| 5695 | # If this value is not provided at the time of job creation or is invalid, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5696 | # the job posting expires after 30 days from the job's creation time. For |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 5697 | # example, if the job was created on 2017/01/01 13:00AM UTC with an |
| 5698 | # unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC. |
| 5699 | # |
| 5700 | # If this value is not provided but expiry_date is, expiry_date is |
| 5701 | # used. |
| 5702 | # |
| 5703 | # If this value is not provided on job update, it depends on the field masks |
| 5704 | # set by UpdateJobRequest.update_job_fields. If the field masks include |
| 5705 | # expiry_time, or the masks are empty meaning that every field is |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5706 | # updated, the job posting expires after 30 days from the job's last |
| 5707 | # update time. Otherwise the expiration date isn't updated. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 5708 | "name": "A String", # Required during job update. |
| 5709 | # |
| 5710 | # Resource name assigned to a job by the API, for example, "/jobs/foo". Use |
| 5711 | # of this field in job queries and API calls is preferred over the use of |
| 5712 | # requisition_id since this value is unique. |
| 5713 | "jobTitle": "A String", # Required. The title of the job, such as "Software Engineer" |
| 5714 | # |
| 5715 | # The maximum number of allowed characters is 500. |
| 5716 | "referenceUrl": "A String", # Output only. The URL of a web page that displays job details. |
| 5717 | "responsibilities": "A String", # Optional. A description of job responsibilities. The use of this field is |
| 5718 | # recommended as an alternative to using the more general description |
| 5719 | # field. |
| 5720 | # |
| 5721 | # This field accepts and sanitizes HTML input, and also accepts |
| 5722 | # bold, italic, ordered list, and unordered list markup tags. |
| 5723 | # |
| 5724 | # The maximum number of allowed characters is 10,000. |
| 5725 | "distributorCompanyId": "A String", # Optional but one of company_name or distributor_company_id must be |
| 5726 | # provided. |
| 5727 | # |
| 5728 | # A unique company identifier used by job distributors to identify an |
| 5729 | # employer's company entity. company_name takes precedence over |
| 5730 | # this field, and is the recommended field to use to identify companies. |
| 5731 | # |
| 5732 | # The maximum number of allowed characters is 255. |
| 5733 | "publishDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Optional. The date this job was most recently published in UTC format. The default |
| 5734 | # value is the time the request arrives at the server. |
| 5735 | # and time zone are either specified elsewhere or are not significant. The date |
| 5736 | # is relative to the Proleptic Gregorian Calendar. This can represent: |
| 5737 | # |
| 5738 | # * A full date, with non-zero year, month and day values |
| 5739 | # * A month and day value, with a zero year, e.g. an anniversary |
| 5740 | # * A year on its own, with zero month and day values |
| 5741 | # * A year and month value, with a zero day, e.g. a credit card expiration date |
| 5742 | # |
| 5743 | # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. |
| 5744 | "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| 5745 | # a year. |
| 5746 | "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| 5747 | # if specifying a year by itself or a year and month where the day is not |
| 5748 | # significant. |
| 5749 | "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| 5750 | # month and day. |
| 5751 | }, |
| 5752 | "applicationInstruction": "A String", # Optional but at least one of application_urls, |
| 5753 | # application_email_list or application_instruction must be |
| 5754 | # specified. |
| 5755 | # |
| 5756 | # Use this field to provide instructions, such as "Mail your application |
| 5757 | # to ...", that a candidate can follow to apply for the job. |
| 5758 | # |
| 5759 | # This field accepts and sanitizes HTML input, and also accepts |
| 5760 | # bold, italic, ordered list, and unordered list markup tags. |
| 5761 | # |
| 5762 | # The maximum number of allowed characters is 3,000. |
| 5763 | "extendedCompensationInfo": { # Deprecated. Use CompensationInfo. # Deprecated. Always use compensation_info. |
| 5764 | # |
| 5765 | # Optional. |
| 5766 | # |
| 5767 | # Job compensation information. |
| 5768 | # |
| 5769 | # This field replaces compensation_info. Only |
| 5770 | # CompensationInfo.entries or extended_compensation_info can be set, |
| 5771 | # otherwise an exception is thrown. |
| 5772 | # |
| 5773 | # Describes job compensation. |
| 5774 | "annualizedBaseCompensationRange": { # Deprecated. See CompensationInfo. # Output only. Annualized base compensation range. |
| 5775 | # |
| 5776 | # Compensation range. |
| 5777 | "max": { # Deprecated. See CompensationInfo. # Required. Maximum value. |
| 5778 | # |
| 5779 | # Decimal number. |
| 5780 | "micros": 42, # Micro (10^-6) units. |
| 5781 | # The value must be between -999,999 and +999,999 inclusive. |
| 5782 | # If `units` is positive, `micros` must be positive or zero. |
| 5783 | # If `units` is zero, `micros` can be positive, zero, or negative. |
| 5784 | # If `units` is negative, `micros` must be negative or zero. |
| 5785 | # For example -1.75 is represented as `units`=-1 and `micros`=-750,000. |
| 5786 | "units": "A String", # Whole units. |
| 5787 | }, |
| 5788 | "min": { # Deprecated. See CompensationInfo. # Required. Minimum value. |
| 5789 | # |
| 5790 | # Decimal number. |
| 5791 | "micros": 42, # Micro (10^-6) units. |
| 5792 | # The value must be between -999,999 and +999,999 inclusive. |
| 5793 | # If `units` is positive, `micros` must be positive or zero. |
| 5794 | # If `units` is zero, `micros` can be positive, zero, or negative. |
| 5795 | # If `units` is negative, `micros` must be negative or zero. |
| 5796 | # For example -1.75 is represented as `units`=-1 and `micros`=-750,000. |
| 5797 | "units": "A String", # Whole units. |
| 5798 | }, |
| 5799 | }, |
| 5800 | "annualizedTotalCompensationUnspecified": True or False, # Output only. Indicates annualized total compensation range cannot be derived, due to |
| 5801 | # the job's all CompensationEntry cannot be annualized. |
| 5802 | # See CompensationEntry for explanation on annualization and base |
| 5803 | # compensation entry. |
| 5804 | "currency": "A String", # Optional. A 3-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) |
| 5805 | # currency code. |
| 5806 | "annualizedBaseCompensationUnspecified": True or False, # Output only. Indicates annualized base compensation range cannot be derived, due to |
| 5807 | # the job's base compensation entry cannot be annualized. |
| 5808 | # See CompensationEntry for explanation on annualization and base |
| 5809 | # compensation entry. |
| 5810 | "entries": [ # Optional. Job compensation information. |
| 5811 | # |
| 5812 | # At most one entry can be of type |
| 5813 | # ExtendedCompensationInfo.CompensationType.BASE, which is |
| 5814 | # referred as ** base compensation entry ** for the job. |
| 5815 | { # Deprecated. See CompensationInfo. |
| 5816 | # |
| 5817 | # A compensation entry that represents one component of compensation, such |
| 5818 | # as base pay, bonus, or other compensation type. |
| 5819 | # |
| 5820 | # Annualization: One compensation entry can be annualized if |
| 5821 | # - it contains valid amount or range. |
| 5822 | # - and its expected_units_per_year is set or can be derived. |
| 5823 | # Its annualized range is determined as (amount or range) times |
| 5824 | # expected_units_per_year. |
| 5825 | "range": { # Deprecated. See CompensationInfo. # Optional. Compensation range. |
| 5826 | # |
| 5827 | # Compensation range. |
| 5828 | "max": { # Deprecated. See CompensationInfo. # Required. Maximum value. |
| 5829 | # |
| 5830 | # Decimal number. |
| 5831 | "micros": 42, # Micro (10^-6) units. |
| 5832 | # The value must be between -999,999 and +999,999 inclusive. |
| 5833 | # If `units` is positive, `micros` must be positive or zero. |
| 5834 | # If `units` is zero, `micros` can be positive, zero, or negative. |
| 5835 | # If `units` is negative, `micros` must be negative or zero. |
| 5836 | # For example -1.75 is represented as `units`=-1 and `micros`=-750,000. |
| 5837 | "units": "A String", # Whole units. |
| 5838 | }, |
| 5839 | "min": { # Deprecated. See CompensationInfo. # Required. Minimum value. |
| 5840 | # |
| 5841 | # Decimal number. |
| 5842 | "micros": 42, # Micro (10^-6) units. |
| 5843 | # The value must be between -999,999 and +999,999 inclusive. |
| 5844 | # If `units` is positive, `micros` must be positive or zero. |
| 5845 | # If `units` is zero, `micros` can be positive, zero, or negative. |
| 5846 | # If `units` is negative, `micros` must be negative or zero. |
| 5847 | # For example -1.75 is represented as `units`=-1 and `micros`=-750,000. |
| 5848 | "units": "A String", # Whole units. |
| 5849 | }, |
| 5850 | }, |
| 5851 | "expectedUnitsPerYear": { # Deprecated. See CompensationInfo. # Optional. Expected number of units paid each year. If not specified, when |
| 5852 | # Job.employment_types is FULLTIME, a default value is inferred |
| 5853 | # based on unit. Default values: |
| 5854 | # - HOURLY: 2080 |
| 5855 | # - DAILY: 260 |
| 5856 | # - WEEKLY: 52 |
| 5857 | # - MONTHLY: 12 |
| 5858 | # - ANNUAL: 1 |
| 5859 | # |
| 5860 | # Decimal number. |
| 5861 | "micros": 42, # Micro (10^-6) units. |
| 5862 | # The value must be between -999,999 and +999,999 inclusive. |
| 5863 | # If `units` is positive, `micros` must be positive or zero. |
| 5864 | # If `units` is zero, `micros` can be positive, zero, or negative. |
| 5865 | # If `units` is negative, `micros` must be negative or zero. |
| 5866 | # For example -1.75 is represented as `units`=-1 and `micros`=-750,000. |
| 5867 | "units": "A String", # Whole units. |
| 5868 | }, |
| 5869 | "amount": { # Deprecated. See CompensationInfo. # Optional. Monetary amount. |
| 5870 | # |
| 5871 | # Decimal number. |
| 5872 | "micros": 42, # Micro (10^-6) units. |
| 5873 | # The value must be between -999,999 and +999,999 inclusive. |
| 5874 | # If `units` is positive, `micros` must be positive or zero. |
| 5875 | # If `units` is zero, `micros` can be positive, zero, or negative. |
| 5876 | # If `units` is negative, `micros` must be negative or zero. |
| 5877 | # For example -1.75 is represented as `units`=-1 and `micros`=-750,000. |
| 5878 | "units": "A String", # Whole units. |
| 5879 | }, |
| 5880 | "description": "A String", # Optional. Compensation description. |
| 5881 | "unspecified": True or False, # Optional. Indicates compensation amount and range are unset. |
| 5882 | "unit": "A String", # Optional. Frequency of the specified amount. |
| 5883 | # |
| 5884 | # Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED. |
| 5885 | "type": "A String", # Required. Compensation type. |
| 5886 | }, |
| 5887 | ], |
| 5888 | "annualizedTotalCompensationRange": { # Deprecated. See CompensationInfo. # Output only. Annualized total compensation range. |
| 5889 | # |
| 5890 | # Compensation range. |
| 5891 | "max": { # Deprecated. See CompensationInfo. # Required. Maximum value. |
| 5892 | # |
| 5893 | # Decimal number. |
| 5894 | "micros": 42, # Micro (10^-6) units. |
| 5895 | # The value must be between -999,999 and +999,999 inclusive. |
| 5896 | # If `units` is positive, `micros` must be positive or zero. |
| 5897 | # If `units` is zero, `micros` can be positive, zero, or negative. |
| 5898 | # If `units` is negative, `micros` must be negative or zero. |
| 5899 | # For example -1.75 is represented as `units`=-1 and `micros`=-750,000. |
| 5900 | "units": "A String", # Whole units. |
| 5901 | }, |
| 5902 | "min": { # Deprecated. See CompensationInfo. # Required. Minimum value. |
| 5903 | # |
| 5904 | # Decimal number. |
| 5905 | "micros": 42, # Micro (10^-6) units. |
| 5906 | # The value must be between -999,999 and +999,999 inclusive. |
| 5907 | # If `units` is positive, `micros` must be positive or zero. |
| 5908 | # If `units` is zero, `micros` can be positive, zero, or negative. |
| 5909 | # If `units` is negative, `micros` must be negative or zero. |
| 5910 | # For example -1.75 is represented as `units`=-1 and `micros`=-750,000. |
| 5911 | "units": "A String", # Whole units. |
| 5912 | }, |
| 5913 | }, |
| 5914 | }, |
| 5915 | "startDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Optional. The start date of the job in UTC time zone. Typically this field |
| 5916 | # is used for contracting engagements. |
| 5917 | # Dates prior to 1970/1/1 and invalid date formats are ignored. |
| 5918 | # and time zone are either specified elsewhere or are not significant. The date |
| 5919 | # is relative to the Proleptic Gregorian Calendar. This can represent: |
| 5920 | # |
| 5921 | # * A full date, with non-zero year, month and day values |
| 5922 | # * A month and day value, with a zero year, e.g. an anniversary |
| 5923 | # * A year on its own, with zero month and day values |
| 5924 | # * A year and month value, with a zero day, e.g. a credit card expiration date |
| 5925 | # |
| 5926 | # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. |
| 5927 | "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| 5928 | # a year. |
| 5929 | "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| 5930 | # if specifying a year by itself or a year and month where the day is not |
| 5931 | # significant. |
| 5932 | "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| 5933 | # month and day. |
| 5934 | }, |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 5935 | "department": "A String", # Optional. The department or functional area within the company with the open |
| 5936 | # position. |
| 5937 | # |
| 5938 | # The maximum number of allowed characters is 255. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 5939 | "applicationEmailList": [ # Optional but at least one of application_urls, |
| 5940 | # application_email_list or application_instruction must be |
| 5941 | # specified. |
| 5942 | # |
| 5943 | # Use this field to specify email address(es) to which resumes or |
| 5944 | # applications can be sent. |
| 5945 | # |
| 5946 | # The maximum number of allowed characters is 255. |
| 5947 | "A String", |
| 5948 | ], |
| 5949 | "companyTitle": "A String", # Deprecated. Use company_display_name instead. |
| 5950 | # |
| 5951 | # Output only. |
| 5952 | # |
| 5953 | # The name of the company listing the job. |
| 5954 | "level": "A String", # Optional. The experience level associated with the job, such as "Entry Level". |
| 5955 | "filterableCustomFields": { # Deprecated. Use custom_attributes instead. |
| 5956 | # |
| 5957 | # Optional. |
| 5958 | # |
| 5959 | # A map of fields to hold filterable custom job attributes not captured by |
| 5960 | # the standard fields such as job_title, company_name, or |
| 5961 | # level. These custom fields store arbitrary |
| 5962 | # string values, and can be used for purposes not covered by |
| 5963 | # the structured fields. For the best search experience, use of the |
| 5964 | # structured rather than custom fields is recommended. |
| 5965 | # |
| 5966 | # Data stored in these custom fields fields are indexed and |
| 5967 | # searched against by keyword searches (see |
| 5968 | # SearchJobsRequest.custom_field_filters][]). |
| 5969 | # |
| 5970 | # The map key must be a number between 1-20. If an invalid key is |
| 5971 | # provided on job create or update, an error is returned. |
| 5972 | "a_key": { # Resource that represents the custom data not captured by the standard fields. |
| 5973 | "values": [ # Optional. The values of the custom data. |
| 5974 | "A String", |
| 5975 | ], |
| 5976 | }, |
| 5977 | }, |
| 5978 | "compensationInfo": { # Job compensation details. # Optional. Job compensation information. |
| 5979 | "entries": [ # Optional. Job compensation information. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5980 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 5981 | # At most one entry can be of type |
| 5982 | # CompensationInfo.CompensationType.BASE, which is |
| 5983 | # referred as ** base compensation entry ** for the job. |
| 5984 | { # A compensation entry that represents one component of compensation, such |
| 5985 | # as base pay, bonus, or other compensation type. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5986 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 5987 | # Annualization: One compensation entry can be annualized if |
| 5988 | # - it contains valid amount or range. |
| 5989 | # - and its expected_units_per_year is set or can be derived. |
| 5990 | # Its annualized range is determined as (amount or range) times |
| 5991 | # expected_units_per_year. |
| 5992 | "amount": { # Represents an amount of money with its currency type. # Optional. Compensation amount. |
| 5993 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 5994 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 5995 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 5996 | # If `units` is positive, `nanos` must be positive or zero. |
| 5997 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 5998 | # If `units` is negative, `nanos` must be negative or zero. |
| 5999 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 6000 | "units": "A String", # The whole units of the amount. |
| 6001 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 6002 | }, |
| 6003 | "description": "A String", # Optional. Compensation description. For example, could |
| 6004 | # indicate equity terms or provide additional context to an estimated |
| 6005 | # bonus. |
| 6006 | "expectedUnitsPerYear": 3.14, # Optional. Expected number of units paid each year. If not specified, when |
| 6007 | # Job.employment_types is FULLTIME, a default value is inferred |
| 6008 | # based on unit. Default values: |
| 6009 | # - HOURLY: 2080 |
| 6010 | # - DAILY: 260 |
| 6011 | # - WEEKLY: 52 |
| 6012 | # - MONTHLY: 12 |
| 6013 | # - ANNUAL: 1 |
| 6014 | "range": { # Compensation range. # Optional. Compensation range. |
| 6015 | "min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set |
| 6016 | # to zero and the currency code is set to match the |
| 6017 | # currency code of max_compensation. |
| 6018 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 6019 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 6020 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 6021 | # If `units` is positive, `nanos` must be positive or zero. |
| 6022 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 6023 | # If `units` is negative, `nanos` must be negative or zero. |
| 6024 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 6025 | "units": "A String", # The whole units of the amount. |
| 6026 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 6027 | }, |
| 6028 | "max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set |
| 6029 | # to a maximal compensation value and the currency code is set to |
| 6030 | # match the currency code of |
| 6031 | # min_compensation. |
| 6032 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 6033 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 6034 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 6035 | # If `units` is positive, `nanos` must be positive or zero. |
| 6036 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 6037 | # If `units` is negative, `nanos` must be negative or zero. |
| 6038 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 6039 | "units": "A String", # The whole units of the amount. |
| 6040 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 6041 | }, |
| 6042 | }, |
| 6043 | "type": "A String", # Required. Compensation type. |
| 6044 | "unit": "A String", # Optional. Frequency of the specified amount. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 6045 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 6046 | # Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 6047 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 6048 | ], |
| 6049 | "annualizedBaseCompensationRange": { # Compensation range. # Output only. Annualized base compensation range. Computed as |
| 6050 | # base compensation entry's CompensationEntry.compensation times |
| 6051 | # CompensationEntry.expected_units_per_year. |
| 6052 | # |
| 6053 | # See CompensationEntry for explanation on compensation annualization. |
| 6054 | "min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set |
| 6055 | # to zero and the currency code is set to match the |
| 6056 | # currency code of max_compensation. |
| 6057 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 6058 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 6059 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 6060 | # If `units` is positive, `nanos` must be positive or zero. |
| 6061 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 6062 | # If `units` is negative, `nanos` must be negative or zero. |
| 6063 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 6064 | "units": "A String", # The whole units of the amount. |
| 6065 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 6066 | }, |
| 6067 | "max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set |
| 6068 | # to a maximal compensation value and the currency code is set to |
| 6069 | # match the currency code of |
| 6070 | # min_compensation. |
| 6071 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 6072 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 6073 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 6074 | # If `units` is positive, `nanos` must be positive or zero. |
| 6075 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 6076 | # If `units` is negative, `nanos` must be negative or zero. |
| 6077 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 6078 | "units": "A String", # The whole units of the amount. |
| 6079 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 6080 | }, |
| 6081 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 6082 | "amount": { # Represents an amount of money with its currency type. # Deprecated. Use entries instead. |
| 6083 | # |
| 6084 | # Optional. |
| 6085 | # |
| 6086 | # The amount of compensation or pay for the job. |
| 6087 | # As an alternative, compensation_amount_min and |
| 6088 | # compensation_amount_max may be used to define a range of |
| 6089 | # compensation. |
| 6090 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 6091 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 6092 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 6093 | # If `units` is positive, `nanos` must be positive or zero. |
| 6094 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 6095 | # If `units` is negative, `nanos` must be negative or zero. |
| 6096 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 6097 | "units": "A String", # The whole units of the amount. |
| 6098 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 6099 | }, |
| 6100 | "max": { # Represents an amount of money with its currency type. # Deprecated. Use entries instead. |
| 6101 | # |
| 6102 | # Optional. |
| 6103 | # |
| 6104 | # An upper bound on a range for compensation or pay for the job. |
| 6105 | # The currency type is specified in compensation_amount. |
| 6106 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 6107 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 6108 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 6109 | # If `units` is positive, `nanos` must be positive or zero. |
| 6110 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 6111 | # If `units` is negative, `nanos` must be negative or zero. |
| 6112 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 6113 | "units": "A String", # The whole units of the amount. |
| 6114 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 6115 | }, |
| 6116 | "type": "A String", # Deprecated. Use entries instead. |
| 6117 | # |
| 6118 | # Optional. |
| 6119 | # |
| 6120 | # Type of job compensation. |
| 6121 | "min": { # Represents an amount of money with its currency type. # Deprecated. Use entries instead. |
| 6122 | # |
| 6123 | # Optional. |
| 6124 | # |
| 6125 | # A lower bound on a range for compensation or pay for the job. |
| 6126 | # The currency type is specified in compensation_amount. |
| 6127 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 6128 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 6129 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 6130 | # If `units` is positive, `nanos` must be positive or zero. |
| 6131 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 6132 | # If `units` is negative, `nanos` must be negative or zero. |
| 6133 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 6134 | "units": "A String", # The whole units of the amount. |
| 6135 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 6136 | }, |
| 6137 | "annualizedTotalCompensationRange": { # Compensation range. # Output only. Annualized total compensation range. Computed as |
| 6138 | # all compensation entries' CompensationEntry.compensation times |
| 6139 | # CompensationEntry.expected_units_per_year. |
| 6140 | # |
| 6141 | # See CompensationEntry for explanation on compensation annualization. |
| 6142 | "min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set |
| 6143 | # to zero and the currency code is set to match the |
| 6144 | # currency code of max_compensation. |
| 6145 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 6146 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 6147 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 6148 | # If `units` is positive, `nanos` must be positive or zero. |
| 6149 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 6150 | # If `units` is negative, `nanos` must be negative or zero. |
| 6151 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 6152 | "units": "A String", # The whole units of the amount. |
| 6153 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 6154 | }, |
| 6155 | "max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set |
| 6156 | # to a maximal compensation value and the currency code is set to |
| 6157 | # match the currency code of |
| 6158 | # min_compensation. |
| 6159 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 6160 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 6161 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 6162 | # If `units` is positive, `nanos` must be positive or zero. |
| 6163 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 6164 | # If `units` is negative, `nanos` must be negative or zero. |
| 6165 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 6166 | "units": "A String", # The whole units of the amount. |
| 6167 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 6168 | }, |
| 6169 | }, |
| 6170 | }, |
| 6171 | "region": "A String", # Optional. The job Region (for example, state, country) throughout which the job |
| 6172 | # is available. If this field is set, a |
| 6173 | # LocationFilter in a search query within the job region |
| 6174 | # finds this job if an exact location match is not specified. |
| 6175 | # If this field is set, setting job locations |
| 6176 | # to the same location level as this field is strongly recommended. |
| 6177 | "createTime": "A String", # Output only. The timestamp when this job was created. |
| 6178 | "incentives": "A String", # Optional. A description of bonus, commission, and other compensation |
| 6179 | # incentives associated with the job not including salary or pay. |
| 6180 | # |
| 6181 | # The maximum number of allowed characters is 10,000. |
| 6182 | "companyDisplayName": "A String", # Output only. The name of the company listing the job. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 6183 | "unindexedCustomFields": { # Deprecated. Use custom_attributes instead. |
| 6184 | # |
| 6185 | # Optional. |
| 6186 | # |
| 6187 | # A map of fields to hold non-filterable custom job attributes, similar to |
| 6188 | # filterable_custom_fields. These fields are distinct in that the data |
| 6189 | # in these fields are not indexed. Therefore, the client cannot search |
| 6190 | # against them, nor can the client use them to list jobs. |
| 6191 | # |
| 6192 | # The key of the map can be any valid string. |
| 6193 | "a_key": { # Resource that represents the custom data not captured by the standard fields. |
| 6194 | "values": [ # Optional. The values of the custom data. |
| 6195 | "A String", |
| 6196 | ], |
| 6197 | }, |
| 6198 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 6199 | "visibility": "A String", # Optional. The visibility of the job. |
| 6200 | # Defaults to JobVisibility.PRIVATE if not specified. |
| 6201 | # Currently only JobVisibility.PRIVATE is supported. |
| 6202 | "employmentTypes": [ # Optional. The employment type(s) of a job, for example, |
| 6203 | # full time or |
| 6204 | # part time. |
| 6205 | "A String", |
| 6206 | ], |
| 6207 | "benefits": [ # Optional. The benefits included with the job. |
| 6208 | "A String", |
| 6209 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 6210 | "expiryDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Deprecated. Use expire_time instead. |
| 6211 | # |
| 6212 | # Optional but strongly recommended to be provided for the best service |
| 6213 | # experience. |
| 6214 | # |
| 6215 | # The expiration date of the job in UTC time. After 12 am on this date, the |
| 6216 | # job is marked as expired, and it no longer appears in search results. |
| 6217 | # The expired job can't be deleted or listed by the DeleteJob and |
| 6218 | # ListJobs APIs, but it can be retrieved with the GetJob API or |
| 6219 | # updated with the UpdateJob API. An expired job can be updated and |
| 6220 | # opened again by using a future expiration date. It can also remain expired. |
| 6221 | # Updating an expired job to be open fails if there is another existing open |
| 6222 | # job with same requisition_id, company_name and language_code. |
| 6223 | # |
| 6224 | # The expired jobs are retained in our system for 90 days. However, the |
| 6225 | # overall expired job count cannot exceed 3 times the maximum of open jobs |
| 6226 | # count over the past week, otherwise jobs with earlier expire time are |
| 6227 | # removed first. Expired jobs are no longer accessible after they are cleaned |
| 6228 | # out. |
| 6229 | # |
| 6230 | # A valid date range is between 1970/1/1 and 2100/12/31. Invalid dates are |
| 6231 | # ignored and treated as expiry date not provided. |
| 6232 | # |
| 6233 | # If this value is not provided on job creation or is invalid, the job |
| 6234 | # posting expires after 30 days from the job's creation time. For example, if |
| 6235 | # the job was created on 2017/01/01 13:00AM UTC with an unspecified |
| 6236 | # expiration date, the job expires after 2017/01/31 13:00AM UTC. |
| 6237 | # |
| 6238 | # If this value is not provided on job update, it depends on the field masks |
| 6239 | # set by UpdateJobRequest.update_job_fields. If the field masks include |
| 6240 | # expiry_date, or the masks are empty meaning that every field is |
| 6241 | # updated, the job expires after 30 days from the job's last update time. |
| 6242 | # Otherwise the expiration date isn't updated. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 6243 | # and time zone are either specified elsewhere or are not significant. The date |
| 6244 | # is relative to the Proleptic Gregorian Calendar. This can represent: |
| 6245 | # |
| 6246 | # * A full date, with non-zero year, month and day values |
| 6247 | # * A month and day value, with a zero year, e.g. an anniversary |
| 6248 | # * A year on its own, with zero month and day values |
| 6249 | # * A year and month value, with a zero day, e.g. a credit card expiration date |
| 6250 | # |
| 6251 | # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 6252 | "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| 6253 | # a year. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 6254 | "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 6255 | # if specifying a year by itself or a year and month where the day is not |
| 6256 | # significant. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 6257 | "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| 6258 | # month and day. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 6259 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 6260 | "companyName": "A String", # Optional but one of company_name or distributor_company_id must be |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 6261 | # provided. |
| 6262 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 6263 | # The resource name of the company listing the job, such as |
| 6264 | # /companies/foo. This field takes precedence over the |
| 6265 | # distributor-assigned company identifier, distributor_company_id. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 6266 | "locations": [ # Optional but strongly recommended for the best service experience. |
| 6267 | # |
| 6268 | # Location(s) where the emploeyer is looking to hire for this job posting. |
| 6269 | # |
| 6270 | # Specifying the full street address(es) of the hiring location enables |
| 6271 | # better API results, especially job searches by commute time. |
| 6272 | # |
| 6273 | # At most 50 locations are allowed for best search performance. If a job has |
| 6274 | # more locations, it is suggested to split it into multiple jobs with unique |
| 6275 | # requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as |
| 6276 | # multiple jobs with the same requisition_id, company_name and |
| 6277 | # language_code are not allowed. If the original requisition_id must |
| 6278 | # be preserved, a custom field should be used for storage. It is also |
| 6279 | # suggested to group the locations that close to each other in the same job |
| 6280 | # for better search experience. |
| 6281 | # |
| 6282 | # The maximum number of allowed characters is 500. |
| 6283 | "A String", |
| 6284 | ], |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 6285 | "endDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Optional. The end date of the job in UTC time zone. Typically this field |
| 6286 | # is used for contracting engagements. |
| 6287 | # Dates prior to 1970/1/1 and invalid date formats are ignored. |
| 6288 | # and time zone are either specified elsewhere or are not significant. The date |
| 6289 | # is relative to the Proleptic Gregorian Calendar. This can represent: |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 6290 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 6291 | # * A full date, with non-zero year, month and day values |
| 6292 | # * A month and day value, with a zero year, e.g. an anniversary |
| 6293 | # * A year on its own, with zero month and day values |
| 6294 | # * A year and month value, with a zero day, e.g. a credit card expiration date |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 6295 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 6296 | # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. |
| 6297 | "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| 6298 | # a year. |
| 6299 | "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| 6300 | # if specifying a year by itself or a year and month where the day is not |
| 6301 | # significant. |
| 6302 | "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| 6303 | # month and day. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 6304 | }, |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 6305 | }</pre> |
| 6306 | </div> |
| 6307 | |
| 6308 | <div class="method"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 6309 | <code class="details" id="search">search(body=None, x__xgafv=None)</code> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 6310 | <pre>Searches for jobs using the provided SearchJobsRequest. |
| 6311 | |
| 6312 | This call constrains the visibility of jobs |
| 6313 | present in the database, and only returns jobs that the caller has |
| 6314 | permission to search against. |
| 6315 | |
| 6316 | Args: |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 6317 | body: object, The request body. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 6318 | The object takes the form of: |
| 6319 | |
| 6320 | { # Input only. |
| 6321 | # |
| 6322 | # The Request body of the `SearchJobs` call. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 6323 | "jobView": "A String", # Optional. The number of job attributes returned for jobs in the |
| 6324 | # search response. Defaults to JobView.SMALL if no value is specified. |
| 6325 | "histogramFacets": { # Input only. # Optional. Restrictions on what fields to perform histogram on, such as |
| 6326 | # `COMPANY_SIZE` etc. |
| 6327 | # |
| 6328 | # Histogram facets to be specified in SearchJobsRequest. |
| 6329 | "simpleHistogramFacets": [ # Optional. Specifies the simple type of histogram facets, for example, |
| 6330 | # `COMPANY_SIZE`, `EMPLOYMENT_TYPE` etc. This field is equivalent to |
| 6331 | # GetHistogramRequest. |
| 6332 | "A String", |
| 6333 | ], |
| 6334 | "customAttributeHistogramFacets": [ # Optional. Specifies the custom attributes histogram requests. |
| 6335 | # Duplicate values of CustomAttributeHistogramRequest.key are not |
| 6336 | # allowed. |
| 6337 | { # Custom attributes histogram request. An error will be thrown if neither |
| 6338 | # string_value_histogram or long_value_histogram_bucketing_option has |
| 6339 | # been defined. |
| 6340 | "key": "A String", # Required. Specifies the custom field key to perform a histogram on. If specified |
| 6341 | # without `long_value_histogram_bucketing_option`, histogram on string values |
| 6342 | # of the given `key` is triggered, otherwise histogram is performed on long |
| 6343 | # values. |
| 6344 | "longValueHistogramBucketingOption": { # Input only. # Optional. Specifies buckets used to perform a range histogram on Job's |
| 6345 | # filterable long custom field values, or min/max value requirements. |
| 6346 | # |
| 6347 | # Use this field to specify bucketing option for the histogram search response. |
| 6348 | "requiresMinMax": True or False, # Optional. If set to true, the histogram result includes minimum/maximum |
| 6349 | # value of the numeric field. |
| 6350 | "bucketBounds": [ # Required. Two adjacent values form a histogram bucket. Values should be in |
| 6351 | # ascending order. For example, if [5, 10, 15] are provided, four buckets are |
| 6352 | # created: (-inf, 5), 5, 10), [10, 15), [15, inf). At most 20 |
| 6353 | # [buckets_bound is supported. |
| 6354 | 3.14, |
| 6355 | ], |
| 6356 | }, |
| 6357 | "stringValueHistogram": True or False, # Optional. If set to true, the response will include the histogram value for |
| 6358 | # each key as a string. |
| 6359 | }, |
| 6360 | ], |
| 6361 | "compensationHistogramFacets": [ # Optional. Specifies compensation field-based histogram requests. |
| 6362 | # Duplicate values of CompensationHistogramRequest.type are not allowed. |
| 6363 | { # Input only. |
| 6364 | # |
| 6365 | # Compensation based histogram request. |
| 6366 | "type": "A String", # Required. Type of the request, representing which field the histogramming should be |
| 6367 | # performed over. A single request can only specify one histogram of each |
| 6368 | # `CompensationHistogramRequestType`. |
| 6369 | "bucketingOption": { # Input only. # Required. Numeric histogram options, like buckets, whether include min or max value. |
| 6370 | # |
| 6371 | # Use this field to specify bucketing option for the histogram search response. |
| 6372 | "requiresMinMax": True or False, # Optional. If set to true, the histogram result includes minimum/maximum |
| 6373 | # value of the numeric field. |
| 6374 | "bucketBounds": [ # Required. Two adjacent values form a histogram bucket. Values should be in |
| 6375 | # ascending order. For example, if [5, 10, 15] are provided, four buckets are |
| 6376 | # created: (-inf, 5), 5, 10), [10, 15), [15, inf). At most 20 |
| 6377 | # [buckets_bound is supported. |
| 6378 | 3.14, |
| 6379 | ], |
| 6380 | }, |
| 6381 | }, |
| 6382 | ], |
| 6383 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 6384 | "offset": 42, # Optional. An integer that specifies the current offset (that is, starting result |
| 6385 | # location, amongst the jobs deemed by the API as relevant) in search |
| 6386 | # results. This field is only considered if page_token is unset. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 6387 | # |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 6388 | # For example, 0 means to return results starting from the first matching |
| 6389 | # job, and 10 means to return from the 11th job. This can be used for |
| 6390 | # pagination, (for example, pageSize = 10 and offset = 10 means to return |
| 6391 | # from the second page). |
| 6392 | "pageSize": 42, # Optional. A limit on the number of jobs returned in the search results. |
| 6393 | # Increasing this value above the default value of 10 can increase search |
| 6394 | # response time. The value can be between 1 and 100. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 6395 | "orderBy": "A String", # Deprecated. Use sort_by instead. |
| 6396 | # |
| 6397 | # Optional. |
| 6398 | # |
| 6399 | # The criteria determining how search results are sorted. |
| 6400 | # Defaults to SortBy.RELEVANCE_DESC if no value is specified. |
| 6401 | "enablePreciseResultSize": True or False, # Optional. Controls if the search job request requires the return of a precise |
| 6402 | # count of the first 300 results. Setting this to `true` ensures |
| 6403 | # consistency in the number of results per page. Best practice is to set this |
| 6404 | # value to true if a client allows users to jump directly to a |
| 6405 | # non-sequential search results page. |
| 6406 | # |
| 6407 | # Enabling this flag may adversely impact performance. |
| 6408 | # |
| 6409 | # Defaults to false. |
| 6410 | "requestMetadata": { # Input only. # Required. The meta information collected about the job searcher, used to improve the |
| 6411 | # search quality of the service. The identifiers, (such as `user_id`) are |
| 6412 | # provided by users, and must be unique and consistent. |
| 6413 | # |
| 6414 | # Meta information related to the job searcher or entity |
| 6415 | # conducting the job search. This information is used to improve the |
| 6416 | # performance of the service. |
| 6417 | "sessionId": "A String", # Required. A unique session identification string. A session is defined as the |
| 6418 | # duration of an end user's interaction with the service over a period. |
| 6419 | # Obfuscate this field for privacy concerns before |
| 6420 | # providing it to the API. |
| 6421 | # |
| 6422 | # If this field is not available for some reason, please send "UNKNOWN". Note |
| 6423 | # that any improvements to the service model for a particular tenant site, |
| 6424 | # rely on this field being set correctly to some unique session_id. |
| 6425 | "userId": "A String", # Required. A unique user identification string, as determined by the client. The |
| 6426 | # client is responsible for ensuring client-level uniqueness of this value |
| 6427 | # in order to have the strongest positive impact on search quality. |
| 6428 | # Obfuscate this field for privacy concerns before |
| 6429 | # providing it to the service. |
| 6430 | # |
| 6431 | # If this field is not available for some reason, please send "UNKNOWN". Note |
| 6432 | # that any improvements to the service model for a particular tenant site, |
| 6433 | # rely on this field being set correctly to some unique user_id. |
| 6434 | "deviceInfo": { # Input only. # Optional. The type of device used by the job seeker at the time of the call to the |
| 6435 | # service. |
| 6436 | # |
| 6437 | # Device information collected from the job seeker, candidate, or |
| 6438 | # other entity conducting the job search. Providing this information improves |
| 6439 | # the quality of the search results across devices. |
| 6440 | "deviceType": "A String", # Optional. Type of the device. |
| 6441 | "id": "A String", # Optional. A device-specific ID. The ID must be a unique identifier that distinguishes |
| 6442 | # the device from other devices. |
| 6443 | }, |
| 6444 | "domain": "A String", # Required. The client-defined scope or source of the service call, which typically |
| 6445 | # is the domain on |
| 6446 | # which the service has been implemented and is currently being run. |
| 6447 | # |
| 6448 | # For example, if the service is being run by client <em>Foo, Inc.</em>, on |
| 6449 | # job board www.foo.com and career site www.bar.com, then this field is |
| 6450 | # set to "foo.com" for use on the job board, and "bar.com" for use on the |
| 6451 | # career site. |
| 6452 | # |
| 6453 | # If this field is not available for some reason, send "UNKNOWN". Note that |
| 6454 | # any improvements to the service model for a particular tenant site rely on |
| 6455 | # this field being set correctly to some domain. |
| 6456 | }, |
| 6457 | "disableRelevanceThresholding": True or False, # Optional. Controls whether to disable relevance thresholding. Relevance |
| 6458 | # thresholding removes jobs that have low relevance in search results, |
| 6459 | # for example, removing "Assistant to the CEO" positions from the search |
| 6460 | # results of a search for "CEO". |
| 6461 | # |
| 6462 | # Disabling relevance thresholding improves the accuracy of subsequent |
| 6463 | # search requests. |
| 6464 | # |
| 6465 | # Defaults to false. |
| 6466 | "sortBy": "A String", # Optional. The criteria determining how search results are sorted. |
| 6467 | # Defaults to SortBy.RELEVANCE_DESC if no value is specified. |
| 6468 | "filters": { # Input only. # Deprecated. Use query instead. |
| 6469 | # |
| 6470 | # Optional. |
| 6471 | # |
| 6472 | # Restrictions on the scope of the search request, such as filtering |
| 6473 | # by location. |
| 6474 | # |
| 6475 | # Deprecated. Use JobQuery instead. |
| 6476 | # |
| 6477 | # The filters required to perform a search query or histogram. |
| 6478 | "customAttributeFilter": "A String", # Optional. This filter specifies a structured syntax to match against the |
| 6479 | # Job.custom_attributes that are marked as `filterable`. |
| 6480 | # |
| 6481 | # The syntax for this expression is a subset of Google SQL syntax. |
| 6482 | # |
| 6483 | # Supported operators are: =, !=, <, <=, >, >= where the left of the operator |
| 6484 | # is a custom field key and the right of the operator is a number or string |
| 6485 | # (surrounded by quotes) value. |
| 6486 | # |
| 6487 | # Supported functions are LOWER(<field_name>) to |
| 6488 | # perform case insensitive match and EMPTY(<field_name>) to filter on the |
| 6489 | # existence of a key. |
| 6490 | # |
| 6491 | # Boolean expressions (AND/OR/NOT) are supported up to 3 levels of |
| 6492 | # nesting (For example, "((A AND B AND C) OR NOT D) AND E"), and there can |
| 6493 | # be a maximum of 100 comparisons/functions in the expression. The expression |
| 6494 | # must be < 3000 bytes in length. |
| 6495 | # |
| 6496 | # Sample Query: |
| 6497 | # (key1 = "TEST" OR LOWER(key1)="test" OR NOT EMPTY(key1)) AND key2 > 100 |
| 6498 | "customFieldFilters": { # Deprecated. Use custom_attribute_filter instead. |
| 6499 | # |
| 6500 | # Optional. |
| 6501 | # |
| 6502 | # This filter specifies searching against |
| 6503 | # custom field values. See Job.filterable_custom_fields for information. |
| 6504 | # The key value specifies a number between 1-20 (the service |
| 6505 | # supports 20 custom fields) corresponding to the desired custom field map |
| 6506 | # value. If an invalid key is provided or specified together with |
| 6507 | # custom_attribute_filter, an error is thrown. |
| 6508 | "a_key": { # Input only. |
| 6509 | # |
| 6510 | # Custom field filter of the search. |
| 6511 | "type": "A String", # Optional. The type of filter. |
| 6512 | # Defaults to FilterType.OR. |
| 6513 | "queries": [ # Required. The query strings for the filter. |
| 6514 | "A String", |
| 6515 | ], |
| 6516 | }, |
| 6517 | }, |
| 6518 | "publishDateRange": "A String", # Optional. Jobs published within a range specified by this filter are searched |
| 6519 | # against, for example, DateRange.PAST_MONTH. If a value is not |
| 6520 | # specified, all open jobs are searched against regardless of the |
| 6521 | # date they were published. |
| 6522 | "query": "A String", # Optional. The query filter contains the keywords that match against the job |
| 6523 | # title, description, and location fields. |
| 6524 | # |
| 6525 | # The maximum query size is 255 bytes/characters. |
| 6526 | "tenantJobOnly": True or False, # Deprecated. Do not use this field. |
| 6527 | # |
| 6528 | # This flag controls whether the job search should be restricted to jobs |
| 6529 | # owned by the current user. |
| 6530 | # |
| 6531 | # Defaults to false where all jobs accessible to the |
| 6532 | # user are searched against. |
| 6533 | "locationFilters": [ # Optional. The location filter specifies geo-regions containing the jobs to |
| 6534 | # search against. See LocationFilter for more information. |
| 6535 | # |
| 6536 | # If a location value is not specified, jobs are retrieved |
| 6537 | # from all locations. |
| 6538 | # |
| 6539 | # If multiple values are specified, jobs are retrieved from any of the |
| 6540 | # specified locations. If different values are specified for the |
| 6541 | # LocationFilter.distance_in_miles parameter, the maximum provided |
| 6542 | # distance is used for all locations. |
| 6543 | # |
| 6544 | # At most 5 location filters are allowed. |
| 6545 | { # Input only. |
| 6546 | # |
| 6547 | # Geographic region of the search. |
| 6548 | "name": "A String", # Optional. The address name, such as "Mountain View" or "Bay Area". |
| 6549 | "distanceInMiles": 3.14, # Optional. The distance_in_miles is applied when the location being searched for is |
| 6550 | # identified as a city or smaller. When the location being searched for is a |
| 6551 | # state or larger, this field is ignored. |
| 6552 | "isTelecommute": True or False, # Optional. Allows the client to return jobs without a |
| 6553 | # set location, specifically, telecommuting jobs (telecomuting is considered |
| 6554 | # by the service as a special location. |
| 6555 | # Job.allow_telecommute indicates if a job permits telecommuting. |
| 6556 | # If this field is true, telecommuting jobs are searched, and |
| 6557 | # name and lat_lng are |
| 6558 | # ignored. |
| 6559 | # This filter can be used by itself to search exclusively for telecommuting |
| 6560 | # jobs, or it can be combined with another location |
| 6561 | # filter to search for a combination of job locations, |
| 6562 | # such as "Mountain View" or "telecommuting" jobs. However, when used in |
| 6563 | # combination with other location filters, telecommuting jobs can be |
| 6564 | # treated as less relevant than other jobs in the search response. |
| 6565 | "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 |
| 6566 | # search. This field is ignored if `location_name` is provided. |
| 6567 | # of doubles representing degrees latitude and degrees longitude. Unless |
| 6568 | # specified otherwise, this must conform to the |
| 6569 | # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 |
| 6570 | # standard</a>. Values must be within normalized ranges. |
| 6571 | "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. |
| 6572 | "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. |
| 6573 | }, |
| 6574 | "regionCode": "A String", # Optional. CLDR region code of the country/region of the address. This will be used |
| 6575 | # to address ambiguity of the user-input location, e.g. "Liverpool" |
| 6576 | # against "Liverpool, NY, US" or "Liverpool, UK". |
| 6577 | # |
| 6578 | # Set this field if all the jobs to search against are from a same region, |
| 6579 | # or jobs are world-wide but the job seeker is from a specific region. |
| 6580 | # |
| 6581 | # See http://cldr.unicode.org/ and |
| 6582 | # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html |
| 6583 | # for details. Example: "CH" for Switzerland. |
| 6584 | }, |
| 6585 | ], |
| 6586 | "disableSpellCheck": True or False, # Optional. This flag controls the spell-check feature. If false, the |
| 6587 | # service attempts to correct a misspelled query, |
| 6588 | # for example, "enginee" is corrected to "engineer". |
| 6589 | # |
| 6590 | # Defaults to false: a spell check is performed. |
| 6591 | "compensationFilter": { # Input only. # Optional. This search filter is applied only to |
| 6592 | # Job.compensation_info. For example, if the filter is specified |
| 6593 | # as "Hourly job with per-hour compensation > $15", only jobs that meet |
| 6594 | # this criteria are searched. If a filter is not defined, all open jobs |
| 6595 | # are searched. |
| 6596 | # |
| 6597 | # Filter on job compensation type and amount. |
| 6598 | "type": "A String", # Required. Type of filter. |
| 6599 | "units": [ # Required. Specify desired `base compensation entry's` |
| 6600 | # CompensationInfo.CompensationUnit. |
| 6601 | "A String", |
| 6602 | ], |
| 6603 | "includeJobsWithUnspecifiedCompensationRange": True or False, # Optional. Whether to include jobs whose compensation range is unspecified. |
| 6604 | "range": { # Compensation range. # Optional. Compensation range. |
| 6605 | "min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set |
| 6606 | # to zero and the currency code is set to match the |
| 6607 | # currency code of max_compensation. |
| 6608 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 6609 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 6610 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 6611 | # If `units` is positive, `nanos` must be positive or zero. |
| 6612 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 6613 | # If `units` is negative, `nanos` must be negative or zero. |
| 6614 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 6615 | "units": "A String", # The whole units of the amount. |
| 6616 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 6617 | }, |
| 6618 | "max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set |
| 6619 | # to a maximal compensation value and the currency code is set to |
| 6620 | # match the currency code of |
| 6621 | # min_compensation. |
| 6622 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 6623 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 6624 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 6625 | # If `units` is positive, `nanos` must be positive or zero. |
| 6626 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 6627 | # If `units` is negative, `nanos` must be negative or zero. |
| 6628 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 6629 | "units": "A String", # The whole units of the amount. |
| 6630 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 6631 | }, |
| 6632 | }, |
| 6633 | }, |
| 6634 | "languageCodes": [ # Optional. This filter specifies the locale of jobs to search against, |
| 6635 | # for example, "en-US". |
| 6636 | # |
| 6637 | # If a value is not specified, the search results may contain jobs in any |
| 6638 | # locale. |
| 6639 | # |
| 6640 | # |
| 6641 | # Language codes should be in BCP-47 format, for example, "en-US" or |
| 6642 | # "sr-Latn". For more information, see [Tags for Identifying |
| 6643 | # Languages](https://tools.ietf.org/html/bcp47). |
| 6644 | # |
| 6645 | # At most 10 language code filters are allowed. |
| 6646 | "A String", |
| 6647 | ], |
| 6648 | "extendedCompensationFilter": { # Deprecated. Always use CompensationFilter. # Deprecated. Always use compensation_filter. |
| 6649 | # |
| 6650 | # Optional. |
| 6651 | # |
| 6652 | # This search filter is applied only to |
| 6653 | # Job.extended_compensation_info. For example, if the filter is specified |
| 6654 | # as "Hourly job with per-hour compensation > $15", only jobs that meet |
| 6655 | # these criteria are searched. If a filter is not defined, all open jobs |
| 6656 | # are searched. |
| 6657 | # |
| 6658 | # Input only. |
| 6659 | # |
| 6660 | # Filter on job compensation type and amount. |
| 6661 | "currency": "A String", # Optional. Specify currency in 3-letter |
| 6662 | # [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) format. If |
| 6663 | # unspecified, jobs are returned regardless of currency. |
| 6664 | "type": "A String", # Required. Type of filter. |
| 6665 | "compensationUnits": [ # Required. Specify desired `base compensation entry's` |
| 6666 | # ExtendedCompensationInfo.CompensationUnit. |
| 6667 | "A String", |
| 6668 | ], |
| 6669 | "includeJobWithUnspecifiedCompensationRange": True or False, # Optional. Whether to include jobs whose compensation range is unspecified. |
| 6670 | "compensationRange": { # Deprecated. See CompensationInfo. # Optional. Compensation range. |
| 6671 | # |
| 6672 | # Compensation range. |
| 6673 | "max": { # Deprecated. See CompensationInfo. # Required. Maximum value. |
| 6674 | # |
| 6675 | # Decimal number. |
| 6676 | "micros": 42, # Micro (10^-6) units. |
| 6677 | # The value must be between -999,999 and +999,999 inclusive. |
| 6678 | # If `units` is positive, `micros` must be positive or zero. |
| 6679 | # If `units` is zero, `micros` can be positive, zero, or negative. |
| 6680 | # If `units` is negative, `micros` must be negative or zero. |
| 6681 | # For example -1.75 is represented as `units`=-1 and `micros`=-750,000. |
| 6682 | "units": "A String", # Whole units. |
| 6683 | }, |
| 6684 | "min": { # Deprecated. See CompensationInfo. # Required. Minimum value. |
| 6685 | # |
| 6686 | # Decimal number. |
| 6687 | "micros": 42, # Micro (10^-6) units. |
| 6688 | # The value must be between -999,999 and +999,999 inclusive. |
| 6689 | # If `units` is positive, `micros` must be positive or zero. |
| 6690 | # If `units` is zero, `micros` can be positive, zero, or negative. |
| 6691 | # If `units` is negative, `micros` must be negative or zero. |
| 6692 | # For example -1.75 is represented as `units`=-1 and `micros`=-750,000. |
| 6693 | "units": "A String", # Whole units. |
| 6694 | }, |
| 6695 | }, |
| 6696 | }, |
| 6697 | "commuteFilter": { # Input only. # Optional. Allows filtering jobs by commute time with different travel methods (e.g. |
| 6698 | # driving or public transit). Note: this only works with COMMUTE |
| 6699 | # MODE. When specified, [JobFilters.location_filters] will be |
| 6700 | # ignored. |
| 6701 | # |
| 6702 | # Currently we do not support sorting by commute time. |
| 6703 | # |
| 6704 | # Parameters needed for commute search. |
| 6705 | "roadTraffic": "A String", # Optional. Specifies the traffic density to use when calculating commute time. |
| 6706 | # Must not be present if departure_hour_local is specified. |
| 6707 | "allowNonStreetLevelAddress": True or False, # Optional. If `true`, jobs without street level addresses may also be returned. |
| 6708 | # For city level addresses, the city center is used. For state and coarser |
| 6709 | # level addresses, text matching is used. |
| 6710 | # If this field is set to `false` or is not specified, only jobs that include |
| 6711 | # street level addresses will be returned by commute search. |
| 6712 | "method": "A String", # Required. The method of transportation for which to calculate the commute time. |
| 6713 | "travelTime": "A String", # Required. The maximum travel time in seconds. The maximum allowed value is `3600s` |
| 6714 | # (one hour). Format is `123s`. |
| 6715 | "departureHourLocal": 42, # Optional. The departure hour to use to calculate traffic impact. Accepts an |
| 6716 | # integer between 0 and 23, representing the hour in the time zone of the |
| 6717 | # start_location. Must not be present if road_traffic is specified. |
| 6718 | "startLocation": { # 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 |
| 6719 | # commute time. |
| 6720 | # of doubles representing degrees latitude and degrees longitude. Unless |
| 6721 | # specified otherwise, this must conform to the |
| 6722 | # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 |
| 6723 | # standard</a>. Values must be within normalized ranges. |
| 6724 | "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. |
| 6725 | "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. |
| 6726 | }, |
| 6727 | }, |
| 6728 | "categories": [ # Optional. The category filter specifies the categories of jobs to search against. |
| 6729 | # See Category for more information. |
| 6730 | # |
| 6731 | # If a value is not specified, jobs from any category are searched against. |
| 6732 | # |
| 6733 | # If multiple values are specified, jobs from any of the specified |
| 6734 | # categories are searched against. |
| 6735 | "A String", |
| 6736 | ], |
| 6737 | "companyNames": [ # Optional. The company names filter specifies the company entities to search |
| 6738 | # against. |
| 6739 | # |
| 6740 | # If a value is not specified, jobs are searched for against all companies. |
| 6741 | # |
| 6742 | # If multiple values are specified, jobs are searched against the |
| 6743 | # specified companies. |
| 6744 | # |
| 6745 | # At most 20 company filters are allowed. |
| 6746 | "A String", |
| 6747 | ], |
| 6748 | "companyTitles": [ # Optional. This filter specifies the exact company titles |
| 6749 | # of jobs to search against. |
| 6750 | # |
| 6751 | # If a value is not specified, jobs within the search results can be |
| 6752 | # associated with any company. |
| 6753 | # |
| 6754 | # If multiple values are specified, jobs within the search results may be |
| 6755 | # associated with any of the specified companies. |
| 6756 | # |
| 6757 | # At most 20 company title filters are allowed. |
| 6758 | "A String", |
| 6759 | ], |
| 6760 | "employmentTypes": [ # Optional. The employment type filter specifies the employment type of jobs to |
| 6761 | # search against, such as EmploymentType.FULL_TIME. |
| 6762 | # |
| 6763 | # If a value is not specified, jobs in the search results include any |
| 6764 | # employment type. |
| 6765 | # |
| 6766 | # If multiple values are specified, jobs in the search results include any |
| 6767 | # of the specified employment types. |
| 6768 | "A String", |
| 6769 | ], |
| 6770 | }, |
| 6771 | "pageToken": "A String", # Optional. The token specifying the current offset within |
| 6772 | # search results. See SearchJobsResponse.next_page_token for |
| 6773 | # an explanation of how to obtain the next set of query results. |
| 6774 | "mode": "A String", # Required. Mode of a search. |
| 6775 | "enableBroadening": True or False, # Optional. Controls whether to broaden the search when it produces sparse results. |
| 6776 | # Broadened queries append results to the end of the matching results |
| 6777 | # list. |
| 6778 | # |
| 6779 | # Defaults to false. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 6780 | "query": { # Input only. # Optional. Query used to search against jobs, such as keyword, location filters, etc. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 6781 | # |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 6782 | # The query required to perform a search query or histogram. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 6783 | "query": "A String", # Optional. The query string that matches against the job title, description, and |
| 6784 | # location fields. |
| 6785 | # |
| 6786 | # The maximum query size is 255 bytes. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 6787 | "employmentTypes": [ # Optional. The employment type filter specifies the employment type of jobs to |
| 6788 | # search against, such as EmploymentType.FULL_TIME. |
| 6789 | # |
| 6790 | # If a value is not specified, jobs in the search results include any |
| 6791 | # employment type. |
| 6792 | # |
| 6793 | # If multiple values are specified, jobs in the search results include |
| 6794 | # any of the specified employment types. |
| 6795 | "A String", |
| 6796 | ], |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 6797 | "compensationFilter": { # Input only. # Optional. This search filter is applied only to |
| 6798 | # Job.compensation_info. For example, if the filter is specified |
| 6799 | # as "Hourly job with per-hour compensation > $15", only jobs meeting |
| 6800 | # these criteria are searched. If a filter isn't defined, all open jobs |
| 6801 | # are searched. |
| 6802 | # |
| 6803 | # Filter on job compensation type and amount. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 6804 | "type": "A String", # Required. Type of filter. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 6805 | "units": [ # Required. Specify desired `base compensation entry's` |
| 6806 | # CompensationInfo.CompensationUnit. |
| 6807 | "A String", |
| 6808 | ], |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 6809 | "includeJobsWithUnspecifiedCompensationRange": True or False, # Optional. Whether to include jobs whose compensation range is unspecified. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 6810 | "range": { # Compensation range. # Optional. Compensation range. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 6811 | "min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set |
| 6812 | # to zero and the currency code is set to match the |
| 6813 | # currency code of max_compensation. |
| 6814 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 6815 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 6816 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 6817 | # If `units` is positive, `nanos` must be positive or zero. |
| 6818 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 6819 | # If `units` is negative, `nanos` must be negative or zero. |
| 6820 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 6821 | "units": "A String", # The whole units of the amount. |
| 6822 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 6823 | }, |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 6824 | "max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set |
| 6825 | # to a maximal compensation value and the currency code is set to |
| 6826 | # match the currency code of |
| 6827 | # min_compensation. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 6828 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 6829 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 6830 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 6831 | # If `units` is positive, `nanos` must be positive or zero. |
| 6832 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 6833 | # If `units` is negative, `nanos` must be negative or zero. |
| 6834 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 6835 | "units": "A String", # The whole units of the amount. |
| 6836 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 6837 | }, |
| 6838 | }, |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 6839 | }, |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 6840 | "companyDisplayNames": [ # Optional. This filter specifies the exact company display |
| 6841 | # name of the jobs to search against. |
| 6842 | # |
| 6843 | # If a value isn't specified, jobs within the search results are |
| 6844 | # associated with any company. |
| 6845 | # |
| 6846 | # If multiple values are specified, jobs within the search results may be |
| 6847 | # associated with any of the specified companies. |
| 6848 | # |
| 6849 | # At most 20 company display name filters are allowed. |
| 6850 | "A String", |
| 6851 | ], |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 6852 | "commuteFilter": { # Input only. # Optional. Allows filtering jobs by commute time with different travel methods (for |
| 6853 | # example, driving or public transit). Note: This only works with COMMUTE |
| 6854 | # MODE. When specified, [JobQuery.location_filters] is |
| 6855 | # ignored. |
| 6856 | # |
| 6857 | # Currently we don't support sorting by commute time. |
| 6858 | # |
| 6859 | # Parameters needed for commute search. |
| 6860 | "roadTraffic": "A String", # Optional. Specifies the traffic density to use when calculating commute time. |
| 6861 | # Must not be present if departure_hour_local is specified. |
| 6862 | "allowNonStreetLevelAddress": True or False, # Optional. If `true`, jobs without street level addresses may also be returned. |
| 6863 | # For city level addresses, the city center is used. For state and coarser |
| 6864 | # level addresses, text matching is used. |
| 6865 | # If this field is set to `false` or is not specified, only jobs that include |
| 6866 | # street level addresses will be returned by commute search. |
| 6867 | "method": "A String", # Required. The method of transportation for which to calculate the commute time. |
| 6868 | "travelTime": "A String", # Required. The maximum travel time in seconds. The maximum allowed value is `3600s` |
| 6869 | # (one hour). Format is `123s`. |
| 6870 | "departureHourLocal": 42, # Optional. The departure hour to use to calculate traffic impact. Accepts an |
| 6871 | # integer between 0 and 23, representing the hour in the time zone of the |
| 6872 | # start_location. Must not be present if road_traffic is specified. |
| 6873 | "startLocation": { # 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 |
| 6874 | # commute time. |
| 6875 | # of doubles representing degrees latitude and degrees longitude. Unless |
| 6876 | # specified otherwise, this must conform to the |
| 6877 | # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 |
| 6878 | # standard</a>. Values must be within normalized ranges. |
| 6879 | "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. |
| 6880 | "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. |
| 6881 | }, |
| 6882 | }, |
| 6883 | "locationFilters": [ # Optional. The location filter specifies geo-regions containing the jobs to |
| 6884 | # search against. See LocationFilter for more information. |
| 6885 | # |
| 6886 | # If a location value isn't specified, jobs fitting the other search |
| 6887 | # criteria are retrieved regardless of where they're located. |
| 6888 | # |
| 6889 | # If multiple values are specified, jobs are retrieved from any of the |
| 6890 | # specified locations. If different values are specified for the |
| 6891 | # LocationFilter.distance_in_miles parameter, the maximum provided |
| 6892 | # distance is used for all locations. |
| 6893 | # |
| 6894 | # At most 5 location filters are allowed. |
| 6895 | { # Input only. |
| 6896 | # |
| 6897 | # Geographic region of the search. |
| 6898 | "name": "A String", # Optional. The address name, such as "Mountain View" or "Bay Area". |
| 6899 | "distanceInMiles": 3.14, # Optional. The distance_in_miles is applied when the location being searched for is |
| 6900 | # identified as a city or smaller. When the location being searched for is a |
| 6901 | # state or larger, this field is ignored. |
| 6902 | "isTelecommute": True or False, # Optional. Allows the client to return jobs without a |
| 6903 | # set location, specifically, telecommuting jobs (telecomuting is considered |
| 6904 | # by the service as a special location. |
| 6905 | # Job.allow_telecommute indicates if a job permits telecommuting. |
| 6906 | # If this field is true, telecommuting jobs are searched, and |
| 6907 | # name and lat_lng are |
| 6908 | # ignored. |
| 6909 | # This filter can be used by itself to search exclusively for telecommuting |
| 6910 | # jobs, or it can be combined with another location |
| 6911 | # filter to search for a combination of job locations, |
| 6912 | # such as "Mountain View" or "telecommuting" jobs. However, when used in |
| 6913 | # combination with other location filters, telecommuting jobs can be |
| 6914 | # treated as less relevant than other jobs in the search response. |
| 6915 | "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 |
| 6916 | # search. This field is ignored if `location_name` is provided. |
| 6917 | # of doubles representing degrees latitude and degrees longitude. Unless |
| 6918 | # specified otherwise, this must conform to the |
| 6919 | # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 |
| 6920 | # standard</a>. Values must be within normalized ranges. |
| 6921 | "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. |
| 6922 | "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. |
| 6923 | }, |
| 6924 | "regionCode": "A String", # Optional. CLDR region code of the country/region of the address. This will be used |
| 6925 | # to address ambiguity of the user-input location, e.g. "Liverpool" |
| 6926 | # against "Liverpool, NY, US" or "Liverpool, UK". |
| 6927 | # |
| 6928 | # Set this field if all the jobs to search against are from a same region, |
| 6929 | # or jobs are world-wide but the job seeker is from a specific region. |
| 6930 | # |
| 6931 | # See http://cldr.unicode.org/ and |
| 6932 | # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html |
| 6933 | # for details. Example: "CH" for Switzerland. |
| 6934 | }, |
| 6935 | ], |
| 6936 | "languageCodes": [ # Optional. This filter specifies the locale of jobs to search against, |
| 6937 | # for example, "en-US". |
| 6938 | # |
| 6939 | # If a value isn't specified, the search results can contain jobs in any |
| 6940 | # locale. |
| 6941 | # |
| 6942 | # |
| 6943 | # Language codes should be in BCP-47 format, such as "en-US" or "sr-Latn". |
| 6944 | # For more information, see |
| 6945 | # [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). |
| 6946 | # |
| 6947 | # At most 10 language code filters are allowed. |
| 6948 | "A String", |
| 6949 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 6950 | "companyNames": [ # Optional. This filter specifies the company entities to search against. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 6951 | # |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 6952 | # If a value isn't specified, jobs are searched for against all |
| 6953 | # companies. |
| 6954 | # |
| 6955 | # If multiple values are specified, jobs are searched against the |
| 6956 | # companies specified. |
| 6957 | # |
| 6958 | # At most 20 company filters are allowed. |
| 6959 | "A String", |
| 6960 | ], |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 6961 | "disableSpellCheck": True or False, # Optional. This flag controls the spell-check feature. If false, the |
| 6962 | # service attempts to correct a misspelled query, |
| 6963 | # for example, "enginee" is corrected to "engineer". |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 6964 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 6965 | # Defaults to false: a spell check is performed. |
| 6966 | "publishDateRange": "A String", # Optional. Jobs published within a range specified by this filter are searched |
| 6967 | # against, for example, DateRange.PAST_MONTH. If a value isn't |
| 6968 | # specified, all open jobs are searched against regardless of their |
| 6969 | # published date. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 6970 | "categories": [ # Optional. The category filter specifies the categories of jobs to search against. |
| 6971 | # See Category for more information. |
| 6972 | # |
| 6973 | # If a value is not specified, jobs from any category are searched against. |
| 6974 | # |
| 6975 | # If multiple values are specified, jobs from any of the specified |
| 6976 | # categories are searched against. |
| 6977 | "A String", |
| 6978 | ], |
| 6979 | "customAttributeFilter": "A String", # Optional. This filter specifies a structured syntax to match against the |
| 6980 | # Job.custom_attributes marked as `filterable`. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 6981 | # |
| 6982 | # The syntax for this expression is a subset of Google SQL syntax. |
| 6983 | # |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 6984 | # Supported operators are: =, !=, <, <=, >, >= where the left of the operator |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 6985 | # is a custom field key and the right of the operator is a number or string |
| 6986 | # (surrounded by quotes) value. |
| 6987 | # |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 6988 | # Supported functions are LOWER(<field_name>) to |
| 6989 | # perform case insensitive match and EMPTY(<field_name>) to filter on the |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 6990 | # existence of a key. |
| 6991 | # |
| 6992 | # Boolean expressions (AND/OR/NOT) are supported up to 3 levels of |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 6993 | # nesting (for example, "((A AND B AND C) OR NOT D) AND E"), a maximum of 50 |
| 6994 | # comparisons/functions are allowed in the expression. The expression |
| 6995 | # must be < 2000 characters in length. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 6996 | # |
| 6997 | # Sample Query: |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 6998 | # (key1 = "TEST" OR LOWER(key1)="test" OR NOT EMPTY(key1)) AND key2 > 100 |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 6999 | }, |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 7000 | } |
| 7001 | |
| 7002 | x__xgafv: string, V1 error format. |
| 7003 | Allowed values |
| 7004 | 1 - v1 error format |
| 7005 | 2 - v2 error format |
| 7006 | |
| 7007 | Returns: |
| 7008 | An object of the form: |
| 7009 | |
| 7010 | { # Output only. |
| 7011 | # |
| 7012 | # Response for SearchJob method. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 7013 | "appliedCommuteFilter": { # Input only. # The commute filter the service applied to the specified query. This |
| 7014 | # information is only available when query has a valid CommutePreference. |
| 7015 | # |
| 7016 | # Parameters needed for commute search. |
| 7017 | "roadTraffic": "A String", # Optional. Specifies the traffic density to use when calculating commute time. |
| 7018 | # Must not be present if departure_hour_local is specified. |
| 7019 | "allowNonStreetLevelAddress": True or False, # Optional. If `true`, jobs without street level addresses may also be returned. |
| 7020 | # For city level addresses, the city center is used. For state and coarser |
| 7021 | # level addresses, text matching is used. |
| 7022 | # If this field is set to `false` or is not specified, only jobs that include |
| 7023 | # street level addresses will be returned by commute search. |
| 7024 | "method": "A String", # Required. The method of transportation for which to calculate the commute time. |
| 7025 | "travelTime": "A String", # Required. The maximum travel time in seconds. The maximum allowed value is `3600s` |
| 7026 | # (one hour). Format is `123s`. |
| 7027 | "departureHourLocal": 42, # Optional. The departure hour to use to calculate traffic impact. Accepts an |
| 7028 | # integer between 0 and 23, representing the hour in the time zone of the |
| 7029 | # start_location. Must not be present if road_traffic is specified. |
| 7030 | "startLocation": { # 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 |
| 7031 | # commute time. |
| 7032 | # of doubles representing degrees latitude and degrees longitude. Unless |
| 7033 | # specified otherwise, this must conform to the |
| 7034 | # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 |
| 7035 | # standard</a>. Values must be within normalized ranges. |
| 7036 | "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. |
| 7037 | "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. |
| 7038 | }, |
| 7039 | }, |
| 7040 | "numJobsFromBroadenedQuery": 42, # If query broadening is enabled, we may append additional results from the |
| 7041 | # broadened query. This number indicates how many of the jobs returned in the |
| 7042 | # jobs field are from the broadened query. These results are always at the |
| 7043 | # end of the jobs list. In particular, a value of 0 means all the jobs in the |
| 7044 | # jobs list are from the original (without broadening) query. If this |
| 7045 | # field is non-zero, subsequent requests with offset after this result set |
| 7046 | # should contain all broadened results. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 7047 | "metadata": { # Output only. # Additional information for the API invocation, such as the request |
| 7048 | # tracking id. |
| 7049 | # |
| 7050 | # Additional information returned to client, such as debugging |
| 7051 | # information. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 7052 | "mode": "A String", # For search response only. Indicates the mode of a performed search. |
| 7053 | "experimentIdList": [ # Identifiers for the versions of the search algorithm used during |
| 7054 | # this API invocation if multiple algorithms are used. |
| 7055 | # The default value is empty. |
| 7056 | # For search response only. |
| 7057 | 42, |
| 7058 | ], |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 7059 | "requestId": "A String", # A unique id associated with this call. |
| 7060 | # This id is logged for tracking purposes. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 7061 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 7062 | "matchingJobs": [ # The Job entities that match the specified SearchJobsRequest. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 7063 | { # Output only. |
| 7064 | # |
| 7065 | # Job entry with metadata inside SearchJobsResponse. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 7066 | "job": { # A Job resource represents a job posting (also referred to as a "job listing" # Job resource that matches the specified SearchJobsRequest. |
| 7067 | # 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] | 7068 | # entity responsible for the job. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 7069 | "languageCode": "A String", # Optional. The language of the posting. This field is distinct from |
| 7070 | # any requirements for fluency that are associated with the job. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 7071 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 7072 | # Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn". |
| 7073 | # For more information, see |
| 7074 | # [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){: |
| 7075 | # class="external" target="_blank" }. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 7076 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 7077 | # If this field is unspecified and Job.description is present, detected |
| 7078 | # language code based on Job.description is assigned, otherwise |
| 7079 | # defaults to 'en_US'. |
| 7080 | "educationLevels": [ # Optional. The desired education level for the job, such as |
| 7081 | # "Bachelors", "Masters", "Doctorate". |
| 7082 | "A String", |
| 7083 | ], |
| 7084 | "description": "A String", # Required. The description of the job, which typically includes a multi-paragraph |
| 7085 | # description of the company and related information. Separate fields are |
| 7086 | # provided on the job object for responsibilities, |
| 7087 | # qualifications, and other job characteristics. Use of |
| 7088 | # these separate job fields is recommended. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 7089 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 7090 | # This field accepts and sanitizes HTML input, and also accepts |
| 7091 | # bold, italic, ordered list, and unordered list markup tags. |
| 7092 | # |
| 7093 | # The maximum number of allowed characters is 100,000. |
| 7094 | "updateTime": "A String", # Output only. The timestamp when this job was last updated. |
| 7095 | "promotionValue": 42, # Optional. A promotion value of the job, as determined by the client. |
| 7096 | # The value determines the sort order of the jobs returned when searching for |
| 7097 | # jobs using the featured jobs search call, with higher promotional values |
| 7098 | # being returned first and ties being resolved by relevance sort. Only the |
| 7099 | # jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH. |
| 7100 | # |
| 7101 | # Default value is 0, and negative values are treated as 0. |
| 7102 | "qualifications": "A String", # Optional. A description of the qualifications required to perform the |
| 7103 | # job. The use of this field is recommended |
| 7104 | # as an alternative to using the more general description field. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 7105 | # |
| 7106 | # This field accepts and sanitizes HTML input, and also accepts |
| 7107 | # bold, italic, ordered list, and unordered list markup tags. |
| 7108 | # |
| 7109 | # The maximum number of allowed characters is 10,000. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 7110 | "customAttributes": { # Optional. A map of fields to hold both filterable and non-filterable custom job |
| 7111 | # attributes that are not covered by the provided structured fields. |
| 7112 | # |
| 7113 | # This field is a more general combination of the deprecated id-based |
| 7114 | # filterable_custom_fields and string-based |
| 7115 | # non_filterable_custom_fields. |
| 7116 | # |
| 7117 | # The keys of the map are strings up to 64 bytes and must match the |
| 7118 | # pattern: a-zA-Z*. |
| 7119 | # |
| 7120 | # At most 100 filterable and at most 100 unfilterable keys are supported. |
| 7121 | # For filterable `string_values`, across all keys at most 200 values are |
| 7122 | # allowed, with each string no more than 255 characters. For unfilterable |
| 7123 | # `string_values`, the maximum total size of `string_values` across all keys |
| 7124 | # is 50KB. |
| 7125 | "a_key": { # Custom attribute values that are either filterable or non-filterable. |
| 7126 | "longValue": "A String", # Optional but at least one of string_values or long_value must |
| 7127 | # be specified. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 7128 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 7129 | # This field is used to perform number range search. |
| 7130 | # (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`. For |
| 7131 | # `long_value`, a value between Long.MIN and Long.MAX is allowed. |
| 7132 | "filterable": True or False, # Optional. If the `filterable` flag is true, custom field values are searchable. |
| 7133 | # If false, values are not searchable. |
| 7134 | # |
| 7135 | # Default is false. |
| 7136 | "stringValues": { # Represents array of string values. # Optional but at least one of string_values or long_value must |
| 7137 | # be specified. |
| 7138 | # |
| 7139 | # This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or |
| 7140 | # `CASE_INSENSITIVE_MATCH`) search. |
| 7141 | # For filterable `string_values`, a maximum total number of 200 values |
| 7142 | # is allowed, with each `string_value` has a byte size of no more than |
| 7143 | # 255B. For unfilterable `string_values`, the maximum total byte size of |
| 7144 | # unfilterable `string_values` is 50KB. |
| 7145 | # |
| 7146 | # Empty strings are not allowed. |
| 7147 | "values": [ # Required. String values. |
| 7148 | "A String", |
| 7149 | ], |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 7150 | }, |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 7151 | }, |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 7152 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 7153 | "applicationUrls": [ # Optional but at least one of application_urls, |
| 7154 | # application_email_list or application_instruction must be |
| 7155 | # specified. |
| 7156 | # |
| 7157 | # Use this URL field to direct an applicant to a website, for example to |
| 7158 | # link to an online application form. |
| 7159 | # |
| 7160 | # The maximum number of allowed characters is 2,000. |
| 7161 | "A String", |
| 7162 | ], |
| 7163 | "requisitionId": "A String", # Required. The requisition ID, also referred to as the posting ID, assigned by the |
| 7164 | # client to identify a job. This field is intended to be used by clients |
| 7165 | # for client identification and tracking of listings. A job is not allowed |
| 7166 | # to be created if there is another job with the same requisition_id, |
| 7167 | # company_name and language_code. |
| 7168 | # |
| 7169 | # The maximum number of allowed characters is 255. |
| 7170 | "jobLocations": [ # Output only. Structured locations of the job, resolved from locations. |
| 7171 | { # Output only. |
| 7172 | # |
| 7173 | # A resource that represents a location with full geographic |
| 7174 | # information. |
| 7175 | "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair. |
| 7176 | # of doubles representing degrees latitude and degrees longitude. Unless |
| 7177 | # specified otherwise, this must conform to the |
| 7178 | # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 |
| 7179 | # standard</a>. Values must be within normalized ranges. |
| 7180 | "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. |
| 7181 | "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. |
| 7182 | }, |
| 7183 | "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information, |
| 7184 | # such as postal delivery and payments addresses. Given a postal address, |
| 7185 | # a postal service can deliver items to a premises, P.O. Box, or other |
| 7186 | # delivery location. |
| 7187 | # Given a postal address, a postal service can deliver items to a premise, P.O. |
| 7188 | # Box or similar. |
| 7189 | # It is not intended to model geographical locations (roads, towns, |
| 7190 | # mountains). |
| 7191 | # |
| 7192 | # In typical usage an address would be created via user input or from importing |
| 7193 | # existing data, depending on the type of process. |
| 7194 | # |
| 7195 | # Advice on address input / editing: |
| 7196 | # - Use an i18n-ready address widget such as |
| 7197 | # https://github.com/google/libaddressinput) |
| 7198 | # - Users should not be presented with UI elements for input or editing of |
| 7199 | # fields outside countries where that field is used. |
| 7200 | # |
| 7201 | # For more guidance on how to use this schema, please see: |
| 7202 | # https://support.google.com/business/answer/6397478 |
| 7203 | "sublocality": "A String", # Optional. Sublocality of the address. |
| 7204 | # For example, this can be neighborhoods, boroughs, districts. |
| 7205 | "recipients": [ # Optional. The recipient at the address. |
| 7206 | # This field may, under certain circumstances, contain multiline information. |
| 7207 | # For example, it might contain "care of" information. |
| 7208 | "A String", |
| 7209 | ], |
| 7210 | "locality": "A String", # Optional. Generally refers to the city/town portion of the address. |
| 7211 | # Examples: US city, IT comune, UK post town. |
| 7212 | # In regions of the world where localities are not well defined or do not fit |
| 7213 | # into this structure well, leave locality empty and use address_lines. |
| 7214 | "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This |
| 7215 | # is never inferred and it is up to the user to ensure the value is |
| 7216 | # correct. See http://cldr.unicode.org/ and |
| 7217 | # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html |
| 7218 | # for details. Example: "CH" for Switzerland. |
| 7219 | "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if |
| 7220 | # known). This is often the UI language of the input form or is expected |
| 7221 | # to match one of the languages used in the address' country/region, or their |
| 7222 | # transliterated equivalents. |
| 7223 | # This can affect formatting in certain countries, but is not critical |
| 7224 | # to the correctness of the data and will never affect any validation or |
| 7225 | # other non-formatting related operations. |
| 7226 | # |
| 7227 | # If this value is not known, it should be omitted (rather than specifying a |
| 7228 | # possibly incorrect default). |
| 7229 | # |
| 7230 | # Examples: "zh-Hant", "ja", "ja-Latn", "en". |
| 7231 | "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require |
| 7232 | # postal codes to be present, but where they are used, they may trigger |
| 7233 | # additional validation with other parts of the address (e.g. state/zip |
| 7234 | # validation in the U.S.A.). |
| 7235 | "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal |
| 7236 | # addresses of a country or region. |
| 7237 | # For example, this can be a state, a province, an oblast, or a prefecture. |
| 7238 | # Specifically, for Spain this is the province and not the autonomous |
| 7239 | # community (e.g. "Barcelona" and not "Catalonia"). |
| 7240 | # Many countries don't use an administrative area in postal addresses. E.g. |
| 7241 | # in Switzerland this should be left unpopulated. |
| 7242 | "addressLines": [ # Unstructured address lines describing the lower levels of an address. |
| 7243 | # |
| 7244 | # Because values in address_lines do not have type information and may |
| 7245 | # sometimes contain multiple values in a single field (e.g. |
| 7246 | # "Austin, TX"), it is important that the line order is clear. The order of |
| 7247 | # address lines should be "envelope order" for the country/region of the |
| 7248 | # address. In places where this can vary (e.g. Japan), address_language is |
| 7249 | # used to make it explicit (e.g. "ja" for large-to-small ordering and |
| 7250 | # "ja-Latn" or "en" for small-to-large). This way, the most specific line of |
| 7251 | # an address can be selected based on the language. |
| 7252 | # |
| 7253 | # The minimum permitted structural representation of an address consists |
| 7254 | # of a region_code with all remaining information placed in the |
| 7255 | # address_lines. It would be possible to format such an address very |
| 7256 | # approximately without geocoding, but no semantic reasoning could be |
| 7257 | # made about any of the address components until it was at least |
| 7258 | # partially resolved. |
| 7259 | # |
| 7260 | # Creating an address only containing a region_code and address_lines, and |
| 7261 | # then geocoding is the recommended way to handle completely unstructured |
| 7262 | # addresses (as opposed to guessing which parts of the address should be |
| 7263 | # localities or administrative areas). |
| 7264 | "A String", |
| 7265 | ], |
| 7266 | "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used |
| 7267 | # in most regions. Where it is used, the value is either a string like |
| 7268 | # "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number |
| 7269 | # alone, representing the "sector code" (Jamaica), "delivery area indicator" |
| 7270 | # (Malawi) or "post office indicator" (e.g. Côte d'Ivoire). |
| 7271 | "organization": "A String", # Optional. The name of the organization at the address. |
| 7272 | "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is |
| 7273 | # the latest revision. |
| 7274 | # |
| 7275 | # All new revisions **must** be backward compatible with old revisions. |
| 7276 | }, |
| 7277 | "locationType": "A String", # The type of a location, which corresponds to the address lines field of |
| 7278 | # PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of |
| 7279 | # LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of |
| 7280 | # LocationType#LOCALITY. |
| 7281 | "radiusMeters": 3.14, # Radius in meters of the job location. This value is derived from the |
| 7282 | # location bounding box in which a circle with the specified radius |
| 7283 | # centered from LatLng coves the area associated with the job location. |
| 7284 | # For example, currently, "Mountain View, CA, USA" has a radius of |
| 7285 | # 7885.79 meters. |
| 7286 | }, |
| 7287 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 7288 | "expireTime": "A String", # Optional but strongly recommended for the best service |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 7289 | # experience. |
| 7290 | # |
| 7291 | # The expiration timestamp of the job. After this timestamp, the |
| 7292 | # job is marked as expired, and it no longer appears in search results. The |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 7293 | # expired job can't be deleted or listed by the DeleteJob and |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 7294 | # ListJobs APIs, but it can be retrieved with the GetJob API or |
| 7295 | # updated with the UpdateJob API. An expired job can be updated and |
| 7296 | # opened again by using a future expiration timestamp. Updating an expired |
| 7297 | # job fails if there is another existing open job with same |
| 7298 | # requisition_id, company_name and language_code. |
| 7299 | # |
| 7300 | # The expired jobs are retained in our system for 90 days. However, the |
| 7301 | # overall expired job count cannot exceed 3 times the maximum of open jobs |
| 7302 | # count over the past week, otherwise jobs with earlier expire time are |
| 7303 | # cleaned first. Expired jobs are no longer accessible after they are cleaned |
| 7304 | # out. |
| 7305 | # The format of this field is RFC 3339 date strings. Example: |
| 7306 | # 2000-01-01T00:00:00.999999999Z |
| 7307 | # See |
| 7308 | # [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt). |
| 7309 | # |
| 7310 | # A valid date range is between 1970-01-01T00:00:00.0Z and |
| 7311 | # 2100-12-31T23:59:59.999Z. Invalid dates are ignored and treated as expire |
| 7312 | # time not provided. |
| 7313 | # |
| 7314 | # If this value is not provided at the time of job creation or is invalid, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 7315 | # the job posting expires after 30 days from the job's creation time. For |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 7316 | # example, if the job was created on 2017/01/01 13:00AM UTC with an |
| 7317 | # unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC. |
| 7318 | # |
| 7319 | # If this value is not provided but expiry_date is, expiry_date is |
| 7320 | # used. |
| 7321 | # |
| 7322 | # If this value is not provided on job update, it depends on the field masks |
| 7323 | # set by UpdateJobRequest.update_job_fields. If the field masks include |
| 7324 | # expiry_time, or the masks are empty meaning that every field is |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 7325 | # updated, the job posting expires after 30 days from the job's last |
| 7326 | # update time. Otherwise the expiration date isn't updated. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 7327 | "name": "A String", # Required during job update. |
| 7328 | # |
| 7329 | # Resource name assigned to a job by the API, for example, "/jobs/foo". Use |
| 7330 | # of this field in job queries and API calls is preferred over the use of |
| 7331 | # requisition_id since this value is unique. |
| 7332 | "jobTitle": "A String", # Required. The title of the job, such as "Software Engineer" |
| 7333 | # |
| 7334 | # The maximum number of allowed characters is 500. |
| 7335 | "referenceUrl": "A String", # Output only. The URL of a web page that displays job details. |
| 7336 | "responsibilities": "A String", # Optional. A description of job responsibilities. The use of this field is |
| 7337 | # recommended as an alternative to using the more general description |
| 7338 | # field. |
| 7339 | # |
| 7340 | # This field accepts and sanitizes HTML input, and also accepts |
| 7341 | # bold, italic, ordered list, and unordered list markup tags. |
| 7342 | # |
| 7343 | # The maximum number of allowed characters is 10,000. |
| 7344 | "distributorCompanyId": "A String", # Optional but one of company_name or distributor_company_id must be |
| 7345 | # provided. |
| 7346 | # |
| 7347 | # A unique company identifier used by job distributors to identify an |
| 7348 | # employer's company entity. company_name takes precedence over |
| 7349 | # this field, and is the recommended field to use to identify companies. |
| 7350 | # |
| 7351 | # The maximum number of allowed characters is 255. |
| 7352 | "publishDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Optional. The date this job was most recently published in UTC format. The default |
| 7353 | # value is the time the request arrives at the server. |
| 7354 | # and time zone are either specified elsewhere or are not significant. The date |
| 7355 | # is relative to the Proleptic Gregorian Calendar. This can represent: |
| 7356 | # |
| 7357 | # * A full date, with non-zero year, month and day values |
| 7358 | # * A month and day value, with a zero year, e.g. an anniversary |
| 7359 | # * A year on its own, with zero month and day values |
| 7360 | # * A year and month value, with a zero day, e.g. a credit card expiration date |
| 7361 | # |
| 7362 | # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. |
| 7363 | "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| 7364 | # a year. |
| 7365 | "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| 7366 | # if specifying a year by itself or a year and month where the day is not |
| 7367 | # significant. |
| 7368 | "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| 7369 | # month and day. |
| 7370 | }, |
| 7371 | "applicationInstruction": "A String", # Optional but at least one of application_urls, |
| 7372 | # application_email_list or application_instruction must be |
| 7373 | # specified. |
| 7374 | # |
| 7375 | # Use this field to provide instructions, such as "Mail your application |
| 7376 | # to ...", that a candidate can follow to apply for the job. |
| 7377 | # |
| 7378 | # This field accepts and sanitizes HTML input, and also accepts |
| 7379 | # bold, italic, ordered list, and unordered list markup tags. |
| 7380 | # |
| 7381 | # The maximum number of allowed characters is 3,000. |
| 7382 | "extendedCompensationInfo": { # Deprecated. Use CompensationInfo. # Deprecated. Always use compensation_info. |
| 7383 | # |
| 7384 | # Optional. |
| 7385 | # |
| 7386 | # Job compensation information. |
| 7387 | # |
| 7388 | # This field replaces compensation_info. Only |
| 7389 | # CompensationInfo.entries or extended_compensation_info can be set, |
| 7390 | # otherwise an exception is thrown. |
| 7391 | # |
| 7392 | # Describes job compensation. |
| 7393 | "annualizedBaseCompensationRange": { # Deprecated. See CompensationInfo. # Output only. Annualized base compensation range. |
| 7394 | # |
| 7395 | # Compensation range. |
| 7396 | "max": { # Deprecated. See CompensationInfo. # Required. Maximum value. |
| 7397 | # |
| 7398 | # Decimal number. |
| 7399 | "micros": 42, # Micro (10^-6) units. |
| 7400 | # The value must be between -999,999 and +999,999 inclusive. |
| 7401 | # If `units` is positive, `micros` must be positive or zero. |
| 7402 | # If `units` is zero, `micros` can be positive, zero, or negative. |
| 7403 | # If `units` is negative, `micros` must be negative or zero. |
| 7404 | # For example -1.75 is represented as `units`=-1 and `micros`=-750,000. |
| 7405 | "units": "A String", # Whole units. |
| 7406 | }, |
| 7407 | "min": { # Deprecated. See CompensationInfo. # Required. Minimum value. |
| 7408 | # |
| 7409 | # Decimal number. |
| 7410 | "micros": 42, # Micro (10^-6) units. |
| 7411 | # The value must be between -999,999 and +999,999 inclusive. |
| 7412 | # If `units` is positive, `micros` must be positive or zero. |
| 7413 | # If `units` is zero, `micros` can be positive, zero, or negative. |
| 7414 | # If `units` is negative, `micros` must be negative or zero. |
| 7415 | # For example -1.75 is represented as `units`=-1 and `micros`=-750,000. |
| 7416 | "units": "A String", # Whole units. |
| 7417 | }, |
| 7418 | }, |
| 7419 | "annualizedTotalCompensationUnspecified": True or False, # Output only. Indicates annualized total compensation range cannot be derived, due to |
| 7420 | # the job's all CompensationEntry cannot be annualized. |
| 7421 | # See CompensationEntry for explanation on annualization and base |
| 7422 | # compensation entry. |
| 7423 | "currency": "A String", # Optional. A 3-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) |
| 7424 | # currency code. |
| 7425 | "annualizedBaseCompensationUnspecified": True or False, # Output only. Indicates annualized base compensation range cannot be derived, due to |
| 7426 | # the job's base compensation entry cannot be annualized. |
| 7427 | # See CompensationEntry for explanation on annualization and base |
| 7428 | # compensation entry. |
| 7429 | "entries": [ # Optional. Job compensation information. |
| 7430 | # |
| 7431 | # At most one entry can be of type |
| 7432 | # ExtendedCompensationInfo.CompensationType.BASE, which is |
| 7433 | # referred as ** base compensation entry ** for the job. |
| 7434 | { # Deprecated. See CompensationInfo. |
| 7435 | # |
| 7436 | # A compensation entry that represents one component of compensation, such |
| 7437 | # as base pay, bonus, or other compensation type. |
| 7438 | # |
| 7439 | # Annualization: One compensation entry can be annualized if |
| 7440 | # - it contains valid amount or range. |
| 7441 | # - and its expected_units_per_year is set or can be derived. |
| 7442 | # Its annualized range is determined as (amount or range) times |
| 7443 | # expected_units_per_year. |
| 7444 | "range": { # Deprecated. See CompensationInfo. # Optional. Compensation range. |
| 7445 | # |
| 7446 | # Compensation range. |
| 7447 | "max": { # Deprecated. See CompensationInfo. # Required. Maximum value. |
| 7448 | # |
| 7449 | # Decimal number. |
| 7450 | "micros": 42, # Micro (10^-6) units. |
| 7451 | # The value must be between -999,999 and +999,999 inclusive. |
| 7452 | # If `units` is positive, `micros` must be positive or zero. |
| 7453 | # If `units` is zero, `micros` can be positive, zero, or negative. |
| 7454 | # If `units` is negative, `micros` must be negative or zero. |
| 7455 | # For example -1.75 is represented as `units`=-1 and `micros`=-750,000. |
| 7456 | "units": "A String", # Whole units. |
| 7457 | }, |
| 7458 | "min": { # Deprecated. See CompensationInfo. # Required. Minimum value. |
| 7459 | # |
| 7460 | # Decimal number. |
| 7461 | "micros": 42, # Micro (10^-6) units. |
| 7462 | # The value must be between -999,999 and +999,999 inclusive. |
| 7463 | # If `units` is positive, `micros` must be positive or zero. |
| 7464 | # If `units` is zero, `micros` can be positive, zero, or negative. |
| 7465 | # If `units` is negative, `micros` must be negative or zero. |
| 7466 | # For example -1.75 is represented as `units`=-1 and `micros`=-750,000. |
| 7467 | "units": "A String", # Whole units. |
| 7468 | }, |
| 7469 | }, |
| 7470 | "expectedUnitsPerYear": { # Deprecated. See CompensationInfo. # Optional. Expected number of units paid each year. If not specified, when |
| 7471 | # Job.employment_types is FULLTIME, a default value is inferred |
| 7472 | # based on unit. Default values: |
| 7473 | # - HOURLY: 2080 |
| 7474 | # - DAILY: 260 |
| 7475 | # - WEEKLY: 52 |
| 7476 | # - MONTHLY: 12 |
| 7477 | # - ANNUAL: 1 |
| 7478 | # |
| 7479 | # Decimal number. |
| 7480 | "micros": 42, # Micro (10^-6) units. |
| 7481 | # The value must be between -999,999 and +999,999 inclusive. |
| 7482 | # If `units` is positive, `micros` must be positive or zero. |
| 7483 | # If `units` is zero, `micros` can be positive, zero, or negative. |
| 7484 | # If `units` is negative, `micros` must be negative or zero. |
| 7485 | # For example -1.75 is represented as `units`=-1 and `micros`=-750,000. |
| 7486 | "units": "A String", # Whole units. |
| 7487 | }, |
| 7488 | "amount": { # Deprecated. See CompensationInfo. # Optional. Monetary amount. |
| 7489 | # |
| 7490 | # Decimal number. |
| 7491 | "micros": 42, # Micro (10^-6) units. |
| 7492 | # The value must be between -999,999 and +999,999 inclusive. |
| 7493 | # If `units` is positive, `micros` must be positive or zero. |
| 7494 | # If `units` is zero, `micros` can be positive, zero, or negative. |
| 7495 | # If `units` is negative, `micros` must be negative or zero. |
| 7496 | # For example -1.75 is represented as `units`=-1 and `micros`=-750,000. |
| 7497 | "units": "A String", # Whole units. |
| 7498 | }, |
| 7499 | "description": "A String", # Optional. Compensation description. |
| 7500 | "unspecified": True or False, # Optional. Indicates compensation amount and range are unset. |
| 7501 | "unit": "A String", # Optional. Frequency of the specified amount. |
| 7502 | # |
| 7503 | # Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED. |
| 7504 | "type": "A String", # Required. Compensation type. |
| 7505 | }, |
| 7506 | ], |
| 7507 | "annualizedTotalCompensationRange": { # Deprecated. See CompensationInfo. # Output only. Annualized total compensation range. |
| 7508 | # |
| 7509 | # Compensation range. |
| 7510 | "max": { # Deprecated. See CompensationInfo. # Required. Maximum value. |
| 7511 | # |
| 7512 | # Decimal number. |
| 7513 | "micros": 42, # Micro (10^-6) units. |
| 7514 | # The value must be between -999,999 and +999,999 inclusive. |
| 7515 | # If `units` is positive, `micros` must be positive or zero. |
| 7516 | # If `units` is zero, `micros` can be positive, zero, or negative. |
| 7517 | # If `units` is negative, `micros` must be negative or zero. |
| 7518 | # For example -1.75 is represented as `units`=-1 and `micros`=-750,000. |
| 7519 | "units": "A String", # Whole units. |
| 7520 | }, |
| 7521 | "min": { # Deprecated. See CompensationInfo. # Required. Minimum value. |
| 7522 | # |
| 7523 | # Decimal number. |
| 7524 | "micros": 42, # Micro (10^-6) units. |
| 7525 | # The value must be between -999,999 and +999,999 inclusive. |
| 7526 | # If `units` is positive, `micros` must be positive or zero. |
| 7527 | # If `units` is zero, `micros` can be positive, zero, or negative. |
| 7528 | # If `units` is negative, `micros` must be negative or zero. |
| 7529 | # For example -1.75 is represented as `units`=-1 and `micros`=-750,000. |
| 7530 | "units": "A String", # Whole units. |
| 7531 | }, |
| 7532 | }, |
| 7533 | }, |
| 7534 | "startDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Optional. The start date of the job in UTC time zone. Typically this field |
| 7535 | # is used for contracting engagements. |
| 7536 | # Dates prior to 1970/1/1 and invalid date formats are ignored. |
| 7537 | # and time zone are either specified elsewhere or are not significant. The date |
| 7538 | # is relative to the Proleptic Gregorian Calendar. This can represent: |
| 7539 | # |
| 7540 | # * A full date, with non-zero year, month and day values |
| 7541 | # * A month and day value, with a zero year, e.g. an anniversary |
| 7542 | # * A year on its own, with zero month and day values |
| 7543 | # * A year and month value, with a zero day, e.g. a credit card expiration date |
| 7544 | # |
| 7545 | # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. |
| 7546 | "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| 7547 | # a year. |
| 7548 | "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| 7549 | # if specifying a year by itself or a year and month where the day is not |
| 7550 | # significant. |
| 7551 | "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| 7552 | # month and day. |
| 7553 | }, |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 7554 | "department": "A String", # Optional. The department or functional area within the company with the open |
| 7555 | # position. |
| 7556 | # |
| 7557 | # The maximum number of allowed characters is 255. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 7558 | "applicationEmailList": [ # Optional but at least one of application_urls, |
| 7559 | # application_email_list or application_instruction must be |
| 7560 | # specified. |
| 7561 | # |
| 7562 | # Use this field to specify email address(es) to which resumes or |
| 7563 | # applications can be sent. |
| 7564 | # |
| 7565 | # The maximum number of allowed characters is 255. |
| 7566 | "A String", |
| 7567 | ], |
| 7568 | "companyTitle": "A String", # Deprecated. Use company_display_name instead. |
| 7569 | # |
| 7570 | # Output only. |
| 7571 | # |
| 7572 | # The name of the company listing the job. |
| 7573 | "level": "A String", # Optional. The experience level associated with the job, such as "Entry Level". |
| 7574 | "filterableCustomFields": { # Deprecated. Use custom_attributes instead. |
| 7575 | # |
| 7576 | # Optional. |
| 7577 | # |
| 7578 | # A map of fields to hold filterable custom job attributes not captured by |
| 7579 | # the standard fields such as job_title, company_name, or |
| 7580 | # level. These custom fields store arbitrary |
| 7581 | # string values, and can be used for purposes not covered by |
| 7582 | # the structured fields. For the best search experience, use of the |
| 7583 | # structured rather than custom fields is recommended. |
| 7584 | # |
| 7585 | # Data stored in these custom fields fields are indexed and |
| 7586 | # searched against by keyword searches (see |
| 7587 | # SearchJobsRequest.custom_field_filters][]). |
| 7588 | # |
| 7589 | # The map key must be a number between 1-20. If an invalid key is |
| 7590 | # provided on job create or update, an error is returned. |
| 7591 | "a_key": { # Resource that represents the custom data not captured by the standard fields. |
| 7592 | "values": [ # Optional. The values of the custom data. |
| 7593 | "A String", |
| 7594 | ], |
| 7595 | }, |
| 7596 | }, |
| 7597 | "compensationInfo": { # Job compensation details. # Optional. Job compensation information. |
| 7598 | "entries": [ # Optional. Job compensation information. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 7599 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 7600 | # At most one entry can be of type |
| 7601 | # CompensationInfo.CompensationType.BASE, which is |
| 7602 | # referred as ** base compensation entry ** for the job. |
| 7603 | { # A compensation entry that represents one component of compensation, such |
| 7604 | # as base pay, bonus, or other compensation type. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 7605 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 7606 | # Annualization: One compensation entry can be annualized if |
| 7607 | # - it contains valid amount or range. |
| 7608 | # - and its expected_units_per_year is set or can be derived. |
| 7609 | # Its annualized range is determined as (amount or range) times |
| 7610 | # expected_units_per_year. |
| 7611 | "amount": { # Represents an amount of money with its currency type. # Optional. Compensation amount. |
| 7612 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 7613 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 7614 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 7615 | # If `units` is positive, `nanos` must be positive or zero. |
| 7616 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 7617 | # If `units` is negative, `nanos` must be negative or zero. |
| 7618 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 7619 | "units": "A String", # The whole units of the amount. |
| 7620 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 7621 | }, |
| 7622 | "description": "A String", # Optional. Compensation description. For example, could |
| 7623 | # indicate equity terms or provide additional context to an estimated |
| 7624 | # bonus. |
| 7625 | "expectedUnitsPerYear": 3.14, # Optional. Expected number of units paid each year. If not specified, when |
| 7626 | # Job.employment_types is FULLTIME, a default value is inferred |
| 7627 | # based on unit. Default values: |
| 7628 | # - HOURLY: 2080 |
| 7629 | # - DAILY: 260 |
| 7630 | # - WEEKLY: 52 |
| 7631 | # - MONTHLY: 12 |
| 7632 | # - ANNUAL: 1 |
| 7633 | "range": { # Compensation range. # Optional. Compensation range. |
| 7634 | "min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set |
| 7635 | # to zero and the currency code is set to match the |
| 7636 | # currency code of max_compensation. |
| 7637 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 7638 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 7639 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 7640 | # If `units` is positive, `nanos` must be positive or zero. |
| 7641 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 7642 | # If `units` is negative, `nanos` must be negative or zero. |
| 7643 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 7644 | "units": "A String", # The whole units of the amount. |
| 7645 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 7646 | }, |
| 7647 | "max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set |
| 7648 | # to a maximal compensation value and the currency code is set to |
| 7649 | # match the currency code of |
| 7650 | # min_compensation. |
| 7651 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 7652 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 7653 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 7654 | # If `units` is positive, `nanos` must be positive or zero. |
| 7655 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 7656 | # If `units` is negative, `nanos` must be negative or zero. |
| 7657 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 7658 | "units": "A String", # The whole units of the amount. |
| 7659 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 7660 | }, |
| 7661 | }, |
| 7662 | "type": "A String", # Required. Compensation type. |
| 7663 | "unit": "A String", # Optional. Frequency of the specified amount. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 7664 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 7665 | # Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 7666 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 7667 | ], |
| 7668 | "annualizedBaseCompensationRange": { # Compensation range. # Output only. Annualized base compensation range. Computed as |
| 7669 | # base compensation entry's CompensationEntry.compensation times |
| 7670 | # CompensationEntry.expected_units_per_year. |
| 7671 | # |
| 7672 | # See CompensationEntry for explanation on compensation annualization. |
| 7673 | "min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set |
| 7674 | # to zero and the currency code is set to match the |
| 7675 | # currency code of max_compensation. |
| 7676 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 7677 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 7678 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 7679 | # If `units` is positive, `nanos` must be positive or zero. |
| 7680 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 7681 | # If `units` is negative, `nanos` must be negative or zero. |
| 7682 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 7683 | "units": "A String", # The whole units of the amount. |
| 7684 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 7685 | }, |
| 7686 | "max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set |
| 7687 | # to a maximal compensation value and the currency code is set to |
| 7688 | # match the currency code of |
| 7689 | # min_compensation. |
| 7690 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 7691 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 7692 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 7693 | # If `units` is positive, `nanos` must be positive or zero. |
| 7694 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 7695 | # If `units` is negative, `nanos` must be negative or zero. |
| 7696 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 7697 | "units": "A String", # The whole units of the amount. |
| 7698 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 7699 | }, |
| 7700 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 7701 | "amount": { # Represents an amount of money with its currency type. # Deprecated. Use entries instead. |
| 7702 | # |
| 7703 | # Optional. |
| 7704 | # |
| 7705 | # The amount of compensation or pay for the job. |
| 7706 | # As an alternative, compensation_amount_min and |
| 7707 | # compensation_amount_max may be used to define a range of |
| 7708 | # compensation. |
| 7709 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 7710 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 7711 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 7712 | # If `units` is positive, `nanos` must be positive or zero. |
| 7713 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 7714 | # If `units` is negative, `nanos` must be negative or zero. |
| 7715 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 7716 | "units": "A String", # The whole units of the amount. |
| 7717 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 7718 | }, |
| 7719 | "max": { # Represents an amount of money with its currency type. # Deprecated. Use entries instead. |
| 7720 | # |
| 7721 | # Optional. |
| 7722 | # |
| 7723 | # An upper bound on a range for compensation or pay for the job. |
| 7724 | # The currency type is specified in compensation_amount. |
| 7725 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 7726 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 7727 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 7728 | # If `units` is positive, `nanos` must be positive or zero. |
| 7729 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 7730 | # If `units` is negative, `nanos` must be negative or zero. |
| 7731 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 7732 | "units": "A String", # The whole units of the amount. |
| 7733 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 7734 | }, |
| 7735 | "type": "A String", # Deprecated. Use entries instead. |
| 7736 | # |
| 7737 | # Optional. |
| 7738 | # |
| 7739 | # Type of job compensation. |
| 7740 | "min": { # Represents an amount of money with its currency type. # Deprecated. Use entries instead. |
| 7741 | # |
| 7742 | # Optional. |
| 7743 | # |
| 7744 | # A lower bound on a range for compensation or pay for the job. |
| 7745 | # The currency type is specified in compensation_amount. |
| 7746 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 7747 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 7748 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 7749 | # If `units` is positive, `nanos` must be positive or zero. |
| 7750 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 7751 | # If `units` is negative, `nanos` must be negative or zero. |
| 7752 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 7753 | "units": "A String", # The whole units of the amount. |
| 7754 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 7755 | }, |
| 7756 | "annualizedTotalCompensationRange": { # Compensation range. # Output only. Annualized total compensation range. Computed as |
| 7757 | # all compensation entries' CompensationEntry.compensation times |
| 7758 | # CompensationEntry.expected_units_per_year. |
| 7759 | # |
| 7760 | # See CompensationEntry for explanation on compensation annualization. |
| 7761 | "min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set |
| 7762 | # to zero and the currency code is set to match the |
| 7763 | # currency code of max_compensation. |
| 7764 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 7765 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 7766 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 7767 | # If `units` is positive, `nanos` must be positive or zero. |
| 7768 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 7769 | # If `units` is negative, `nanos` must be negative or zero. |
| 7770 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 7771 | "units": "A String", # The whole units of the amount. |
| 7772 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 7773 | }, |
| 7774 | "max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set |
| 7775 | # to a maximal compensation value and the currency code is set to |
| 7776 | # match the currency code of |
| 7777 | # min_compensation. |
| 7778 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 7779 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 7780 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 7781 | # If `units` is positive, `nanos` must be positive or zero. |
| 7782 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 7783 | # If `units` is negative, `nanos` must be negative or zero. |
| 7784 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 7785 | "units": "A String", # The whole units of the amount. |
| 7786 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 7787 | }, |
| 7788 | }, |
| 7789 | }, |
| 7790 | "region": "A String", # Optional. The job Region (for example, state, country) throughout which the job |
| 7791 | # is available. If this field is set, a |
| 7792 | # LocationFilter in a search query within the job region |
| 7793 | # finds this job if an exact location match is not specified. |
| 7794 | # If this field is set, setting job locations |
| 7795 | # to the same location level as this field is strongly recommended. |
| 7796 | "createTime": "A String", # Output only. The timestamp when this job was created. |
| 7797 | "incentives": "A String", # Optional. A description of bonus, commission, and other compensation |
| 7798 | # incentives associated with the job not including salary or pay. |
| 7799 | # |
| 7800 | # The maximum number of allowed characters is 10,000. |
| 7801 | "companyDisplayName": "A String", # Output only. The name of the company listing the job. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 7802 | "unindexedCustomFields": { # Deprecated. Use custom_attributes instead. |
| 7803 | # |
| 7804 | # Optional. |
| 7805 | # |
| 7806 | # A map of fields to hold non-filterable custom job attributes, similar to |
| 7807 | # filterable_custom_fields. These fields are distinct in that the data |
| 7808 | # in these fields are not indexed. Therefore, the client cannot search |
| 7809 | # against them, nor can the client use them to list jobs. |
| 7810 | # |
| 7811 | # The key of the map can be any valid string. |
| 7812 | "a_key": { # Resource that represents the custom data not captured by the standard fields. |
| 7813 | "values": [ # Optional. The values of the custom data. |
| 7814 | "A String", |
| 7815 | ], |
| 7816 | }, |
| 7817 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 7818 | "visibility": "A String", # Optional. The visibility of the job. |
| 7819 | # Defaults to JobVisibility.PRIVATE if not specified. |
| 7820 | # Currently only JobVisibility.PRIVATE is supported. |
| 7821 | "employmentTypes": [ # Optional. The employment type(s) of a job, for example, |
| 7822 | # full time or |
| 7823 | # part time. |
| 7824 | "A String", |
| 7825 | ], |
| 7826 | "benefits": [ # Optional. The benefits included with the job. |
| 7827 | "A String", |
| 7828 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 7829 | "expiryDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Deprecated. Use expire_time instead. |
| 7830 | # |
| 7831 | # Optional but strongly recommended to be provided for the best service |
| 7832 | # experience. |
| 7833 | # |
| 7834 | # The expiration date of the job in UTC time. After 12 am on this date, the |
| 7835 | # job is marked as expired, and it no longer appears in search results. |
| 7836 | # The expired job can't be deleted or listed by the DeleteJob and |
| 7837 | # ListJobs APIs, but it can be retrieved with the GetJob API or |
| 7838 | # updated with the UpdateJob API. An expired job can be updated and |
| 7839 | # opened again by using a future expiration date. It can also remain expired. |
| 7840 | # Updating an expired job to be open fails if there is another existing open |
| 7841 | # job with same requisition_id, company_name and language_code. |
| 7842 | # |
| 7843 | # The expired jobs are retained in our system for 90 days. However, the |
| 7844 | # overall expired job count cannot exceed 3 times the maximum of open jobs |
| 7845 | # count over the past week, otherwise jobs with earlier expire time are |
| 7846 | # removed first. Expired jobs are no longer accessible after they are cleaned |
| 7847 | # out. |
| 7848 | # |
| 7849 | # A valid date range is between 1970/1/1 and 2100/12/31. Invalid dates are |
| 7850 | # ignored and treated as expiry date not provided. |
| 7851 | # |
| 7852 | # If this value is not provided on job creation or is invalid, the job |
| 7853 | # posting expires after 30 days from the job's creation time. For example, if |
| 7854 | # the job was created on 2017/01/01 13:00AM UTC with an unspecified |
| 7855 | # expiration date, the job expires after 2017/01/31 13:00AM UTC. |
| 7856 | # |
| 7857 | # If this value is not provided on job update, it depends on the field masks |
| 7858 | # set by UpdateJobRequest.update_job_fields. If the field masks include |
| 7859 | # expiry_date, or the masks are empty meaning that every field is |
| 7860 | # updated, the job expires after 30 days from the job's last update time. |
| 7861 | # Otherwise the expiration date isn't updated. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 7862 | # and time zone are either specified elsewhere or are not significant. The date |
| 7863 | # is relative to the Proleptic Gregorian Calendar. This can represent: |
| 7864 | # |
| 7865 | # * A full date, with non-zero year, month and day values |
| 7866 | # * A month and day value, with a zero year, e.g. an anniversary |
| 7867 | # * A year on its own, with zero month and day values |
| 7868 | # * A year and month value, with a zero day, e.g. a credit card expiration date |
| 7869 | # |
| 7870 | # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 7871 | "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| 7872 | # a year. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 7873 | "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 7874 | # if specifying a year by itself or a year and month where the day is not |
| 7875 | # significant. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 7876 | "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| 7877 | # month and day. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 7878 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 7879 | "companyName": "A String", # Optional but one of company_name or distributor_company_id must be |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 7880 | # provided. |
| 7881 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 7882 | # The resource name of the company listing the job, such as |
| 7883 | # /companies/foo. This field takes precedence over the |
| 7884 | # distributor-assigned company identifier, distributor_company_id. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 7885 | "locations": [ # Optional but strongly recommended for the best service experience. |
| 7886 | # |
| 7887 | # Location(s) where the emploeyer is looking to hire for this job posting. |
| 7888 | # |
| 7889 | # Specifying the full street address(es) of the hiring location enables |
| 7890 | # better API results, especially job searches by commute time. |
| 7891 | # |
| 7892 | # At most 50 locations are allowed for best search performance. If a job has |
| 7893 | # more locations, it is suggested to split it into multiple jobs with unique |
| 7894 | # requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as |
| 7895 | # multiple jobs with the same requisition_id, company_name and |
| 7896 | # language_code are not allowed. If the original requisition_id must |
| 7897 | # be preserved, a custom field should be used for storage. It is also |
| 7898 | # suggested to group the locations that close to each other in the same job |
| 7899 | # for better search experience. |
| 7900 | # |
| 7901 | # The maximum number of allowed characters is 500. |
| 7902 | "A String", |
| 7903 | ], |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 7904 | "endDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Optional. The end date of the job in UTC time zone. Typically this field |
| 7905 | # is used for contracting engagements. |
| 7906 | # Dates prior to 1970/1/1 and invalid date formats are ignored. |
| 7907 | # and time zone are either specified elsewhere or are not significant. The date |
| 7908 | # is relative to the Proleptic Gregorian Calendar. This can represent: |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 7909 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 7910 | # * A full date, with non-zero year, month and day values |
| 7911 | # * A month and day value, with a zero year, e.g. an anniversary |
| 7912 | # * A year on its own, with zero month and day values |
| 7913 | # * A year and month value, with a zero day, e.g. a credit card expiration date |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 7914 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 7915 | # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. |
| 7916 | "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| 7917 | # a year. |
| 7918 | "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| 7919 | # if specifying a year by itself or a year and month where the day is not |
| 7920 | # significant. |
| 7921 | "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| 7922 | # month and day. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 7923 | }, |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 7924 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 7925 | "searchTextSnippet": "A String", # Contains snippets of text from the Job.description and similar |
| 7926 | # fields that most closely match a search query's keywords, if available. |
| 7927 | # All HTML tags in the original fields are stripped when returned in this |
| 7928 | # field, and matching query keywords are enclosed in HTML bold tags. |
| 7929 | "jobTitleSnippet": "A String", # Contains snippets of text from the Job.job_title field most |
| 7930 | # closely matching a search query's keywords, if available. The matching |
| 7931 | # query keywords are enclosed in HTML bold tags. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 7932 | "commuteInfo": { # Output only. # Commute information which is generated based on specified |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 7933 | # CommutePreference. |
| 7934 | # |
| 7935 | # Commute details related to this job. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 7936 | "jobLocation": { # Output only. # Location used as the destination in the commute calculation. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 7937 | # |
| 7938 | # A resource that represents a location with full geographic |
| 7939 | # information. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 7940 | "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair. |
| 7941 | # of doubles representing degrees latitude and degrees longitude. Unless |
| 7942 | # specified otherwise, this must conform to the |
| 7943 | # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 |
| 7944 | # standard</a>. Values must be within normalized ranges. |
| 7945 | "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. |
| 7946 | "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. |
| 7947 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 7948 | "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] | 7949 | # such as postal delivery and payments addresses. Given a postal address, |
| 7950 | # a postal service can deliver items to a premises, P.O. Box, or other |
| 7951 | # delivery location. |
| 7952 | # Given a postal address, a postal service can deliver items to a premise, P.O. |
| 7953 | # Box or similar. |
| 7954 | # It is not intended to model geographical locations (roads, towns, |
| 7955 | # mountains). |
| 7956 | # |
| 7957 | # In typical usage an address would be created via user input or from importing |
| 7958 | # existing data, depending on the type of process. |
| 7959 | # |
| 7960 | # Advice on address input / editing: |
| 7961 | # - Use an i18n-ready address widget such as |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 7962 | # https://github.com/google/libaddressinput) |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 7963 | # - Users should not be presented with UI elements for input or editing of |
| 7964 | # fields outside countries where that field is used. |
| 7965 | # |
| 7966 | # For more guidance on how to use this schema, please see: |
| 7967 | # https://support.google.com/business/answer/6397478 |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 7968 | "sublocality": "A String", # Optional. Sublocality of the address. |
| 7969 | # For example, this can be neighborhoods, boroughs, districts. |
| 7970 | "recipients": [ # Optional. The recipient at the address. |
| 7971 | # This field may, under certain circumstances, contain multiline information. |
| 7972 | # For example, it might contain "care of" information. |
| 7973 | "A String", |
| 7974 | ], |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 7975 | "locality": "A String", # Optional. Generally refers to the city/town portion of the address. |
| 7976 | # Examples: US city, IT comune, UK post town. |
| 7977 | # In regions of the world where localities are not well defined or do not fit |
| 7978 | # into this structure well, leave locality empty and use address_lines. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 7979 | "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This |
| 7980 | # is never inferred and it is up to the user to ensure the value is |
| 7981 | # correct. See http://cldr.unicode.org/ and |
| 7982 | # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html |
| 7983 | # for details. Example: "CH" for Switzerland. |
| 7984 | "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if |
| 7985 | # known). This is often the UI language of the input form or is expected |
| 7986 | # to match one of the languages used in the address' country/region, or their |
| 7987 | # transliterated equivalents. |
| 7988 | # This can affect formatting in certain countries, but is not critical |
| 7989 | # to the correctness of the data and will never affect any validation or |
| 7990 | # other non-formatting related operations. |
| 7991 | # |
| 7992 | # If this value is not known, it should be omitted (rather than specifying a |
| 7993 | # possibly incorrect default). |
| 7994 | # |
| 7995 | # Examples: "zh-Hant", "ja", "ja-Latn", "en". |
| 7996 | "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require |
| 7997 | # postal codes to be present, but where they are used, they may trigger |
| 7998 | # additional validation with other parts of the address (e.g. state/zip |
| 7999 | # validation in the U.S.A.). |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 8000 | "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal |
| 8001 | # addresses of a country or region. |
| 8002 | # For example, this can be a state, a province, an oblast, or a prefecture. |
| 8003 | # Specifically, for Spain this is the province and not the autonomous |
| 8004 | # community (e.g. "Barcelona" and not "Catalonia"). |
| 8005 | # Many countries don't use an administrative area in postal addresses. E.g. |
| 8006 | # in Switzerland this should be left unpopulated. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 8007 | "addressLines": [ # Unstructured address lines describing the lower levels of an address. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 8008 | # |
| 8009 | # Because values in address_lines do not have type information and may |
| 8010 | # sometimes contain multiple values in a single field (e.g. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 8011 | # "Austin, TX"), it is important that the line order is clear. The order of |
| 8012 | # 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] | 8013 | # 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] | 8014 | # used to make it explicit (e.g. "ja" for large-to-small ordering and |
| 8015 | # "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] | 8016 | # an address can be selected based on the language. |
| 8017 | # |
| 8018 | # The minimum permitted structural representation of an address consists |
| 8019 | # of a region_code with all remaining information placed in the |
| 8020 | # address_lines. It would be possible to format such an address very |
| 8021 | # approximately without geocoding, but no semantic reasoning could be |
| 8022 | # made about any of the address components until it was at least |
| 8023 | # partially resolved. |
| 8024 | # |
| 8025 | # Creating an address only containing a region_code and address_lines, and |
| 8026 | # then geocoding is the recommended way to handle completely unstructured |
| 8027 | # addresses (as opposed to guessing which parts of the address should be |
| 8028 | # localities or administrative areas). |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 8029 | "A String", |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 8030 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 8031 | "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used |
| 8032 | # in most regions. Where it is used, the value is either a string like |
| 8033 | # "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number |
| 8034 | # alone, representing the "sector code" (Jamaica), "delivery area indicator" |
| 8035 | # (Malawi) or "post office indicator" (e.g. Côte d'Ivoire). |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 8036 | "organization": "A String", # Optional. The name of the organization at the address. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 8037 | "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 8038 | # the latest revision. |
| 8039 | # |
| 8040 | # All new revisions **must** be backward compatible with old revisions. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 8041 | }, |
| 8042 | "locationType": "A String", # The type of a location, which corresponds to the address lines field of |
| 8043 | # PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of |
| 8044 | # LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of |
| 8045 | # LocationType#LOCALITY. |
| 8046 | "radiusMeters": 3.14, # Radius in meters of the job location. This value is derived from the |
| 8047 | # location bounding box in which a circle with the specified radius |
| 8048 | # centered from LatLng coves the area associated with the job location. |
| 8049 | # For example, currently, "Mountain View, CA, USA" has a radius of |
| 8050 | # 7885.79 meters. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 8051 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 8052 | "travelDuration": "A String", # The number of seconds required to travel to the job location from the query |
| 8053 | # location. A duration of 0 seconds indicates that the job is not |
| 8054 | # reachable within the requested duration, but was returned as part of an |
| 8055 | # expanded query. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 8056 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 8057 | "jobSummary": "A String", # A summary of the job with core information that's displayed on the search |
| 8058 | # results listing page. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 8059 | }, |
| 8060 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 8061 | "nextPageToken": "A String", # The token that specifies the starting position of the next page of results. |
| 8062 | # This field is empty if there are no more results. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 8063 | "estimatedTotalSize": "A String", # An estimation of the number of jobs that match the specified query. |
| 8064 | # |
| 8065 | # This number is not guaranteed to be accurate. For accurate results, |
| 8066 | # seenenable_precise_result_size. |
| 8067 | "totalSize": "A String", # The precise result count, which is available only if the client set |
| 8068 | # enable_precise_result_size to `true` or if the response |
| 8069 | # is the last page of results. Otherwise, the value will be `-1`. |
| 8070 | "histogramResults": { # Output only. # The histogram results that match specified |
| 8071 | # SearchJobsRequest.HistogramFacets. |
| 8072 | # |
| 8073 | # Histogram results that matches HistogramFacets specified in |
| 8074 | # SearchJobsRequest. |
| 8075 | "simpleHistogramResults": [ # Specifies histogram results that matches |
| 8076 | # HistogramFacets.simple_histogram_facets. |
| 8077 | { # Output only. |
| 8078 | # |
| 8079 | # Result of a histogram call. The response contains the histogram map for the |
| 8080 | # search type specified by HistogramResult.field. |
| 8081 | # The response is a map of each filter value to the corresponding count of |
| 8082 | # jobs for that filter. |
| 8083 | "values": { # A map from the values of field to the number of jobs with that value |
| 8084 | # in this search result. |
| 8085 | # |
| 8086 | # Key: search type (filter names, such as the companyName). |
| 8087 | # |
| 8088 | # Values: the count of jobs that match the filter for this search. |
| 8089 | "a_key": 42, |
| 8090 | }, |
| 8091 | "searchType": "A String", # The Histogram search filters. |
| 8092 | }, |
| 8093 | ], |
| 8094 | "compensationHistogramResults": [ # Specifies compensation field-based histogram results that matches |
| 8095 | # HistogramFacets.compensation_histogram_requests. |
| 8096 | { # Output only. |
| 8097 | # |
| 8098 | # Compensation based histogram result. |
| 8099 | "type": "A String", # Type of the request, corresponding to |
| 8100 | # CompensationHistogramRequest.type. |
| 8101 | "result": { # Output only. # Histogram result. |
| 8102 | # |
| 8103 | # Custom numeric bucketing result. |
| 8104 | "maxValue": 3.14, # Stores the maximum value of the numeric field. Will be populated only if |
| 8105 | # [NumericBucketingOption.requires_min_max] is set to true. |
| 8106 | "minValue": 3.14, # Stores the minimum value of the numeric field. Will be populated only if |
| 8107 | # [NumericBucketingOption.requires_min_max] is set to true. |
| 8108 | "counts": [ # Count within each bucket. Its size is the length of |
| 8109 | # NumericBucketingOption.bucket_bounds plus 1. |
| 8110 | { # Represents count of jobs within one bucket. |
| 8111 | "count": 42, # Number of jobs whose numeric field value fall into `range`. |
| 8112 | "range": { # Represents starting and ending value of a range in double. # Bucket range on which histogram was performed for the numeric field, |
| 8113 | # that is, the count represents number of jobs in this range. |
| 8114 | "to": 3.14, # Ending value of the bucket range. |
| 8115 | "from": 3.14, # Starting value of the bucket range. |
| 8116 | }, |
| 8117 | }, |
| 8118 | ], |
| 8119 | }, |
| 8120 | }, |
| 8121 | ], |
| 8122 | "customAttributeHistogramResults": [ # Specifies histogram results for custom attributes that |
| 8123 | # matches HistogramFacets.custom_attribute_histogram_facets. |
| 8124 | { # Output only. |
| 8125 | # |
| 8126 | # Custom attribute histogram result. |
| 8127 | "key": "A String", # Stores the key of custom attribute the histogram is performed on. |
| 8128 | "longValueHistogramResult": { # Output only. # Stores bucketed histogram counting result or min/max values for |
| 8129 | # custom attribute long values associated with `key`. |
| 8130 | # |
| 8131 | # Custom numeric bucketing result. |
| 8132 | "maxValue": 3.14, # Stores the maximum value of the numeric field. Will be populated only if |
| 8133 | # [NumericBucketingOption.requires_min_max] is set to true. |
| 8134 | "minValue": 3.14, # Stores the minimum value of the numeric field. Will be populated only if |
| 8135 | # [NumericBucketingOption.requires_min_max] is set to true. |
| 8136 | "counts": [ # Count within each bucket. Its size is the length of |
| 8137 | # NumericBucketingOption.bucket_bounds plus 1. |
| 8138 | { # Represents count of jobs within one bucket. |
| 8139 | "count": 42, # Number of jobs whose numeric field value fall into `range`. |
| 8140 | "range": { # Represents starting and ending value of a range in double. # Bucket range on which histogram was performed for the numeric field, |
| 8141 | # that is, the count represents number of jobs in this range. |
| 8142 | "to": 3.14, # Ending value of the bucket range. |
| 8143 | "from": 3.14, # Starting value of the bucket range. |
| 8144 | }, |
| 8145 | }, |
| 8146 | ], |
| 8147 | }, |
| 8148 | "stringValueHistogramResult": { # Stores a map from the values of string custom field associated |
| 8149 | # with `key` to the number of jobs with that value in this histogram result. |
| 8150 | "a_key": 42, |
| 8151 | }, |
| 8152 | }, |
| 8153 | ], |
| 8154 | }, |
| 8155 | "jobView": "A String", # Corresponds to SearchJobsRequest.job_view. |
| 8156 | "spellResult": { # Output only. # The spell checking result, and correction. |
| 8157 | # |
| 8158 | # Spell check result. |
| 8159 | "correctedText": "A String", # Correction output consisting of the corrected keyword string. |
| 8160 | "corrected": True or False, # Indicates if the query was corrected by the spell checker. |
| 8161 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 8162 | "appliedJobLocationFilters": [ # 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] | 8163 | # any filters are lat-lng based, the JobLocation.location_type is |
| 8164 | # JobLocation.LocationType#LOCATION_TYPE_UNSPECIFIED. |
| 8165 | { # Output only. |
| 8166 | # |
| 8167 | # A resource that represents a location with full geographic |
| 8168 | # information. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 8169 | "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair. |
| 8170 | # of doubles representing degrees latitude and degrees longitude. Unless |
| 8171 | # specified otherwise, this must conform to the |
| 8172 | # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 |
| 8173 | # standard</a>. Values must be within normalized ranges. |
| 8174 | "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. |
| 8175 | "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. |
| 8176 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 8177 | "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] | 8178 | # such as postal delivery and payments addresses. Given a postal address, |
| 8179 | # a postal service can deliver items to a premises, P.O. Box, or other |
| 8180 | # delivery location. |
| 8181 | # Given a postal address, a postal service can deliver items to a premise, P.O. |
| 8182 | # Box or similar. |
| 8183 | # It is not intended to model geographical locations (roads, towns, |
| 8184 | # mountains). |
| 8185 | # |
| 8186 | # In typical usage an address would be created via user input or from importing |
| 8187 | # existing data, depending on the type of process. |
| 8188 | # |
| 8189 | # Advice on address input / editing: |
| 8190 | # - Use an i18n-ready address widget such as |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 8191 | # https://github.com/google/libaddressinput) |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 8192 | # - Users should not be presented with UI elements for input or editing of |
| 8193 | # fields outside countries where that field is used. |
| 8194 | # |
| 8195 | # For more guidance on how to use this schema, please see: |
| 8196 | # https://support.google.com/business/answer/6397478 |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 8197 | "sublocality": "A String", # Optional. Sublocality of the address. |
| 8198 | # For example, this can be neighborhoods, boroughs, districts. |
| 8199 | "recipients": [ # Optional. The recipient at the address. |
| 8200 | # This field may, under certain circumstances, contain multiline information. |
| 8201 | # For example, it might contain "care of" information. |
| 8202 | "A String", |
| 8203 | ], |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 8204 | "locality": "A String", # Optional. Generally refers to the city/town portion of the address. |
| 8205 | # Examples: US city, IT comune, UK post town. |
| 8206 | # In regions of the world where localities are not well defined or do not fit |
| 8207 | # into this structure well, leave locality empty and use address_lines. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 8208 | "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This |
| 8209 | # is never inferred and it is up to the user to ensure the value is |
| 8210 | # correct. See http://cldr.unicode.org/ and |
| 8211 | # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html |
| 8212 | # for details. Example: "CH" for Switzerland. |
| 8213 | "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if |
| 8214 | # known). This is often the UI language of the input form or is expected |
| 8215 | # to match one of the languages used in the address' country/region, or their |
| 8216 | # transliterated equivalents. |
| 8217 | # This can affect formatting in certain countries, but is not critical |
| 8218 | # to the correctness of the data and will never affect any validation or |
| 8219 | # other non-formatting related operations. |
| 8220 | # |
| 8221 | # If this value is not known, it should be omitted (rather than specifying a |
| 8222 | # possibly incorrect default). |
| 8223 | # |
| 8224 | # Examples: "zh-Hant", "ja", "ja-Latn", "en". |
| 8225 | "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require |
| 8226 | # postal codes to be present, but where they are used, they may trigger |
| 8227 | # additional validation with other parts of the address (e.g. state/zip |
| 8228 | # validation in the U.S.A.). |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 8229 | "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal |
| 8230 | # addresses of a country or region. |
| 8231 | # For example, this can be a state, a province, an oblast, or a prefecture. |
| 8232 | # Specifically, for Spain this is the province and not the autonomous |
| 8233 | # community (e.g. "Barcelona" and not "Catalonia"). |
| 8234 | # Many countries don't use an administrative area in postal addresses. E.g. |
| 8235 | # in Switzerland this should be left unpopulated. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 8236 | "addressLines": [ # Unstructured address lines describing the lower levels of an address. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 8237 | # |
| 8238 | # Because values in address_lines do not have type information and may |
| 8239 | # sometimes contain multiple values in a single field (e.g. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 8240 | # "Austin, TX"), it is important that the line order is clear. The order of |
| 8241 | # 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] | 8242 | # 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] | 8243 | # used to make it explicit (e.g. "ja" for large-to-small ordering and |
| 8244 | # "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] | 8245 | # an address can be selected based on the language. |
| 8246 | # |
| 8247 | # The minimum permitted structural representation of an address consists |
| 8248 | # of a region_code with all remaining information placed in the |
| 8249 | # address_lines. It would be possible to format such an address very |
| 8250 | # approximately without geocoding, but no semantic reasoning could be |
| 8251 | # made about any of the address components until it was at least |
| 8252 | # partially resolved. |
| 8253 | # |
| 8254 | # Creating an address only containing a region_code and address_lines, and |
| 8255 | # then geocoding is the recommended way to handle completely unstructured |
| 8256 | # addresses (as opposed to guessing which parts of the address should be |
| 8257 | # localities or administrative areas). |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 8258 | "A String", |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 8259 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 8260 | "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used |
| 8261 | # in most regions. Where it is used, the value is either a string like |
| 8262 | # "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number |
| 8263 | # alone, representing the "sector code" (Jamaica), "delivery area indicator" |
| 8264 | # (Malawi) or "post office indicator" (e.g. Côte d'Ivoire). |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 8265 | "organization": "A String", # Optional. The name of the organization at the address. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 8266 | "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 8267 | # the latest revision. |
| 8268 | # |
| 8269 | # All new revisions **must** be backward compatible with old revisions. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 8270 | }, |
| 8271 | "locationType": "A String", # The type of a location, which corresponds to the address lines field of |
| 8272 | # PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of |
| 8273 | # LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of |
| 8274 | # LocationType#LOCALITY. |
| 8275 | "radiusMeters": 3.14, # Radius in meters of the job location. This value is derived from the |
| 8276 | # location bounding box in which a circle with the specified radius |
| 8277 | # centered from LatLng coves the area associated with the job location. |
| 8278 | # For example, currently, "Mountain View, CA, USA" has a radius of |
| 8279 | # 7885.79 meters. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 8280 | }, |
| 8281 | ], |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 8282 | }</pre> |
| 8283 | </div> |
| 8284 | |
| 8285 | <div class="method"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 8286 | <code class="details" id="searchForAlert">searchForAlert(body=None, x__xgafv=None)</code> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 8287 | <pre>Searches for jobs using the provided SearchJobsRequest. |
| 8288 | |
| 8289 | This API call is intended for the use case of targeting passive job |
| 8290 | seekers (for example, job seekers who have signed up to receive email |
| 8291 | alerts about potential job opportunities), and has different algorithmic |
| 8292 | adjustments that are targeted to passive job seekers. |
| 8293 | |
| 8294 | This call constrains the visibility of jobs |
| 8295 | present in the database, and only returns jobs the caller has |
| 8296 | permission to search against. |
| 8297 | |
| 8298 | Args: |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 8299 | body: object, The request body. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 8300 | The object takes the form of: |
| 8301 | |
| 8302 | { # Input only. |
| 8303 | # |
| 8304 | # The Request body of the `SearchJobs` call. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 8305 | "jobView": "A String", # Optional. The number of job attributes returned for jobs in the |
| 8306 | # search response. Defaults to JobView.SMALL if no value is specified. |
| 8307 | "histogramFacets": { # Input only. # Optional. Restrictions on what fields to perform histogram on, such as |
| 8308 | # `COMPANY_SIZE` etc. |
| 8309 | # |
| 8310 | # Histogram facets to be specified in SearchJobsRequest. |
| 8311 | "simpleHistogramFacets": [ # Optional. Specifies the simple type of histogram facets, for example, |
| 8312 | # `COMPANY_SIZE`, `EMPLOYMENT_TYPE` etc. This field is equivalent to |
| 8313 | # GetHistogramRequest. |
| 8314 | "A String", |
| 8315 | ], |
| 8316 | "customAttributeHistogramFacets": [ # Optional. Specifies the custom attributes histogram requests. |
| 8317 | # Duplicate values of CustomAttributeHistogramRequest.key are not |
| 8318 | # allowed. |
| 8319 | { # Custom attributes histogram request. An error will be thrown if neither |
| 8320 | # string_value_histogram or long_value_histogram_bucketing_option has |
| 8321 | # been defined. |
| 8322 | "key": "A String", # Required. Specifies the custom field key to perform a histogram on. If specified |
| 8323 | # without `long_value_histogram_bucketing_option`, histogram on string values |
| 8324 | # of the given `key` is triggered, otherwise histogram is performed on long |
| 8325 | # values. |
| 8326 | "longValueHistogramBucketingOption": { # Input only. # Optional. Specifies buckets used to perform a range histogram on Job's |
| 8327 | # filterable long custom field values, or min/max value requirements. |
| 8328 | # |
| 8329 | # Use this field to specify bucketing option for the histogram search response. |
| 8330 | "requiresMinMax": True or False, # Optional. If set to true, the histogram result includes minimum/maximum |
| 8331 | # value of the numeric field. |
| 8332 | "bucketBounds": [ # Required. Two adjacent values form a histogram bucket. Values should be in |
| 8333 | # ascending order. For example, if [5, 10, 15] are provided, four buckets are |
| 8334 | # created: (-inf, 5), 5, 10), [10, 15), [15, inf). At most 20 |
| 8335 | # [buckets_bound is supported. |
| 8336 | 3.14, |
| 8337 | ], |
| 8338 | }, |
| 8339 | "stringValueHistogram": True or False, # Optional. If set to true, the response will include the histogram value for |
| 8340 | # each key as a string. |
| 8341 | }, |
| 8342 | ], |
| 8343 | "compensationHistogramFacets": [ # Optional. Specifies compensation field-based histogram requests. |
| 8344 | # Duplicate values of CompensationHistogramRequest.type are not allowed. |
| 8345 | { # Input only. |
| 8346 | # |
| 8347 | # Compensation based histogram request. |
| 8348 | "type": "A String", # Required. Type of the request, representing which field the histogramming should be |
| 8349 | # performed over. A single request can only specify one histogram of each |
| 8350 | # `CompensationHistogramRequestType`. |
| 8351 | "bucketingOption": { # Input only. # Required. Numeric histogram options, like buckets, whether include min or max value. |
| 8352 | # |
| 8353 | # Use this field to specify bucketing option for the histogram search response. |
| 8354 | "requiresMinMax": True or False, # Optional. If set to true, the histogram result includes minimum/maximum |
| 8355 | # value of the numeric field. |
| 8356 | "bucketBounds": [ # Required. Two adjacent values form a histogram bucket. Values should be in |
| 8357 | # ascending order. For example, if [5, 10, 15] are provided, four buckets are |
| 8358 | # created: (-inf, 5), 5, 10), [10, 15), [15, inf). At most 20 |
| 8359 | # [buckets_bound is supported. |
| 8360 | 3.14, |
| 8361 | ], |
| 8362 | }, |
| 8363 | }, |
| 8364 | ], |
| 8365 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 8366 | "offset": 42, # Optional. An integer that specifies the current offset (that is, starting result |
| 8367 | # location, amongst the jobs deemed by the API as relevant) in search |
| 8368 | # results. This field is only considered if page_token is unset. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 8369 | # |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 8370 | # For example, 0 means to return results starting from the first matching |
| 8371 | # job, and 10 means to return from the 11th job. This can be used for |
| 8372 | # pagination, (for example, pageSize = 10 and offset = 10 means to return |
| 8373 | # from the second page). |
| 8374 | "pageSize": 42, # Optional. A limit on the number of jobs returned in the search results. |
| 8375 | # Increasing this value above the default value of 10 can increase search |
| 8376 | # response time. The value can be between 1 and 100. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 8377 | "orderBy": "A String", # Deprecated. Use sort_by instead. |
| 8378 | # |
| 8379 | # Optional. |
| 8380 | # |
| 8381 | # The criteria determining how search results are sorted. |
| 8382 | # Defaults to SortBy.RELEVANCE_DESC if no value is specified. |
| 8383 | "enablePreciseResultSize": True or False, # Optional. Controls if the search job request requires the return of a precise |
| 8384 | # count of the first 300 results. Setting this to `true` ensures |
| 8385 | # consistency in the number of results per page. Best practice is to set this |
| 8386 | # value to true if a client allows users to jump directly to a |
| 8387 | # non-sequential search results page. |
| 8388 | # |
| 8389 | # Enabling this flag may adversely impact performance. |
| 8390 | # |
| 8391 | # Defaults to false. |
| 8392 | "requestMetadata": { # Input only. # Required. The meta information collected about the job searcher, used to improve the |
| 8393 | # search quality of the service. The identifiers, (such as `user_id`) are |
| 8394 | # provided by users, and must be unique and consistent. |
| 8395 | # |
| 8396 | # Meta information related to the job searcher or entity |
| 8397 | # conducting the job search. This information is used to improve the |
| 8398 | # performance of the service. |
| 8399 | "sessionId": "A String", # Required. A unique session identification string. A session is defined as the |
| 8400 | # duration of an end user's interaction with the service over a period. |
| 8401 | # Obfuscate this field for privacy concerns before |
| 8402 | # providing it to the API. |
| 8403 | # |
| 8404 | # If this field is not available for some reason, please send "UNKNOWN". Note |
| 8405 | # that any improvements to the service model for a particular tenant site, |
| 8406 | # rely on this field being set correctly to some unique session_id. |
| 8407 | "userId": "A String", # Required. A unique user identification string, as determined by the client. The |
| 8408 | # client is responsible for ensuring client-level uniqueness of this value |
| 8409 | # in order to have the strongest positive impact on search quality. |
| 8410 | # Obfuscate this field for privacy concerns before |
| 8411 | # providing it to the service. |
| 8412 | # |
| 8413 | # If this field is not available for some reason, please send "UNKNOWN". Note |
| 8414 | # that any improvements to the service model for a particular tenant site, |
| 8415 | # rely on this field being set correctly to some unique user_id. |
| 8416 | "deviceInfo": { # Input only. # Optional. The type of device used by the job seeker at the time of the call to the |
| 8417 | # service. |
| 8418 | # |
| 8419 | # Device information collected from the job seeker, candidate, or |
| 8420 | # other entity conducting the job search. Providing this information improves |
| 8421 | # the quality of the search results across devices. |
| 8422 | "deviceType": "A String", # Optional. Type of the device. |
| 8423 | "id": "A String", # Optional. A device-specific ID. The ID must be a unique identifier that distinguishes |
| 8424 | # the device from other devices. |
| 8425 | }, |
| 8426 | "domain": "A String", # Required. The client-defined scope or source of the service call, which typically |
| 8427 | # is the domain on |
| 8428 | # which the service has been implemented and is currently being run. |
| 8429 | # |
| 8430 | # For example, if the service is being run by client <em>Foo, Inc.</em>, on |
| 8431 | # job board www.foo.com and career site www.bar.com, then this field is |
| 8432 | # set to "foo.com" for use on the job board, and "bar.com" for use on the |
| 8433 | # career site. |
| 8434 | # |
| 8435 | # If this field is not available for some reason, send "UNKNOWN". Note that |
| 8436 | # any improvements to the service model for a particular tenant site rely on |
| 8437 | # this field being set correctly to some domain. |
| 8438 | }, |
| 8439 | "disableRelevanceThresholding": True or False, # Optional. Controls whether to disable relevance thresholding. Relevance |
| 8440 | # thresholding removes jobs that have low relevance in search results, |
| 8441 | # for example, removing "Assistant to the CEO" positions from the search |
| 8442 | # results of a search for "CEO". |
| 8443 | # |
| 8444 | # Disabling relevance thresholding improves the accuracy of subsequent |
| 8445 | # search requests. |
| 8446 | # |
| 8447 | # Defaults to false. |
| 8448 | "sortBy": "A String", # Optional. The criteria determining how search results are sorted. |
| 8449 | # Defaults to SortBy.RELEVANCE_DESC if no value is specified. |
| 8450 | "filters": { # Input only. # Deprecated. Use query instead. |
| 8451 | # |
| 8452 | # Optional. |
| 8453 | # |
| 8454 | # Restrictions on the scope of the search request, such as filtering |
| 8455 | # by location. |
| 8456 | # |
| 8457 | # Deprecated. Use JobQuery instead. |
| 8458 | # |
| 8459 | # The filters required to perform a search query or histogram. |
| 8460 | "customAttributeFilter": "A String", # Optional. This filter specifies a structured syntax to match against the |
| 8461 | # Job.custom_attributes that are marked as `filterable`. |
| 8462 | # |
| 8463 | # The syntax for this expression is a subset of Google SQL syntax. |
| 8464 | # |
| 8465 | # Supported operators are: =, !=, <, <=, >, >= where the left of the operator |
| 8466 | # is a custom field key and the right of the operator is a number or string |
| 8467 | # (surrounded by quotes) value. |
| 8468 | # |
| 8469 | # Supported functions are LOWER(<field_name>) to |
| 8470 | # perform case insensitive match and EMPTY(<field_name>) to filter on the |
| 8471 | # existence of a key. |
| 8472 | # |
| 8473 | # Boolean expressions (AND/OR/NOT) are supported up to 3 levels of |
| 8474 | # nesting (For example, "((A AND B AND C) OR NOT D) AND E"), and there can |
| 8475 | # be a maximum of 100 comparisons/functions in the expression. The expression |
| 8476 | # must be < 3000 bytes in length. |
| 8477 | # |
| 8478 | # Sample Query: |
| 8479 | # (key1 = "TEST" OR LOWER(key1)="test" OR NOT EMPTY(key1)) AND key2 > 100 |
| 8480 | "customFieldFilters": { # Deprecated. Use custom_attribute_filter instead. |
| 8481 | # |
| 8482 | # Optional. |
| 8483 | # |
| 8484 | # This filter specifies searching against |
| 8485 | # custom field values. See Job.filterable_custom_fields for information. |
| 8486 | # The key value specifies a number between 1-20 (the service |
| 8487 | # supports 20 custom fields) corresponding to the desired custom field map |
| 8488 | # value. If an invalid key is provided or specified together with |
| 8489 | # custom_attribute_filter, an error is thrown. |
| 8490 | "a_key": { # Input only. |
| 8491 | # |
| 8492 | # Custom field filter of the search. |
| 8493 | "type": "A String", # Optional. The type of filter. |
| 8494 | # Defaults to FilterType.OR. |
| 8495 | "queries": [ # Required. The query strings for the filter. |
| 8496 | "A String", |
| 8497 | ], |
| 8498 | }, |
| 8499 | }, |
| 8500 | "publishDateRange": "A String", # Optional. Jobs published within a range specified by this filter are searched |
| 8501 | # against, for example, DateRange.PAST_MONTH. If a value is not |
| 8502 | # specified, all open jobs are searched against regardless of the |
| 8503 | # date they were published. |
| 8504 | "query": "A String", # Optional. The query filter contains the keywords that match against the job |
| 8505 | # title, description, and location fields. |
| 8506 | # |
| 8507 | # The maximum query size is 255 bytes/characters. |
| 8508 | "tenantJobOnly": True or False, # Deprecated. Do not use this field. |
| 8509 | # |
| 8510 | # This flag controls whether the job search should be restricted to jobs |
| 8511 | # owned by the current user. |
| 8512 | # |
| 8513 | # Defaults to false where all jobs accessible to the |
| 8514 | # user are searched against. |
| 8515 | "locationFilters": [ # Optional. The location filter specifies geo-regions containing the jobs to |
| 8516 | # search against. See LocationFilter for more information. |
| 8517 | # |
| 8518 | # If a location value is not specified, jobs are retrieved |
| 8519 | # from all locations. |
| 8520 | # |
| 8521 | # If multiple values are specified, jobs are retrieved from any of the |
| 8522 | # specified locations. If different values are specified for the |
| 8523 | # LocationFilter.distance_in_miles parameter, the maximum provided |
| 8524 | # distance is used for all locations. |
| 8525 | # |
| 8526 | # At most 5 location filters are allowed. |
| 8527 | { # Input only. |
| 8528 | # |
| 8529 | # Geographic region of the search. |
| 8530 | "name": "A String", # Optional. The address name, such as "Mountain View" or "Bay Area". |
| 8531 | "distanceInMiles": 3.14, # Optional. The distance_in_miles is applied when the location being searched for is |
| 8532 | # identified as a city or smaller. When the location being searched for is a |
| 8533 | # state or larger, this field is ignored. |
| 8534 | "isTelecommute": True or False, # Optional. Allows the client to return jobs without a |
| 8535 | # set location, specifically, telecommuting jobs (telecomuting is considered |
| 8536 | # by the service as a special location. |
| 8537 | # Job.allow_telecommute indicates if a job permits telecommuting. |
| 8538 | # If this field is true, telecommuting jobs are searched, and |
| 8539 | # name and lat_lng are |
| 8540 | # ignored. |
| 8541 | # This filter can be used by itself to search exclusively for telecommuting |
| 8542 | # jobs, or it can be combined with another location |
| 8543 | # filter to search for a combination of job locations, |
| 8544 | # such as "Mountain View" or "telecommuting" jobs. However, when used in |
| 8545 | # combination with other location filters, telecommuting jobs can be |
| 8546 | # treated as less relevant than other jobs in the search response. |
| 8547 | "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 |
| 8548 | # search. This field is ignored if `location_name` is provided. |
| 8549 | # of doubles representing degrees latitude and degrees longitude. Unless |
| 8550 | # specified otherwise, this must conform to the |
| 8551 | # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 |
| 8552 | # standard</a>. Values must be within normalized ranges. |
| 8553 | "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. |
| 8554 | "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. |
| 8555 | }, |
| 8556 | "regionCode": "A String", # Optional. CLDR region code of the country/region of the address. This will be used |
| 8557 | # to address ambiguity of the user-input location, e.g. "Liverpool" |
| 8558 | # against "Liverpool, NY, US" or "Liverpool, UK". |
| 8559 | # |
| 8560 | # Set this field if all the jobs to search against are from a same region, |
| 8561 | # or jobs are world-wide but the job seeker is from a specific region. |
| 8562 | # |
| 8563 | # See http://cldr.unicode.org/ and |
| 8564 | # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html |
| 8565 | # for details. Example: "CH" for Switzerland. |
| 8566 | }, |
| 8567 | ], |
| 8568 | "disableSpellCheck": True or False, # Optional. This flag controls the spell-check feature. If false, the |
| 8569 | # service attempts to correct a misspelled query, |
| 8570 | # for example, "enginee" is corrected to "engineer". |
| 8571 | # |
| 8572 | # Defaults to false: a spell check is performed. |
| 8573 | "compensationFilter": { # Input only. # Optional. This search filter is applied only to |
| 8574 | # Job.compensation_info. For example, if the filter is specified |
| 8575 | # as "Hourly job with per-hour compensation > $15", only jobs that meet |
| 8576 | # this criteria are searched. If a filter is not defined, all open jobs |
| 8577 | # are searched. |
| 8578 | # |
| 8579 | # Filter on job compensation type and amount. |
| 8580 | "type": "A String", # Required. Type of filter. |
| 8581 | "units": [ # Required. Specify desired `base compensation entry's` |
| 8582 | # CompensationInfo.CompensationUnit. |
| 8583 | "A String", |
| 8584 | ], |
| 8585 | "includeJobsWithUnspecifiedCompensationRange": True or False, # Optional. Whether to include jobs whose compensation range is unspecified. |
| 8586 | "range": { # Compensation range. # Optional. Compensation range. |
| 8587 | "min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set |
| 8588 | # to zero and the currency code is set to match the |
| 8589 | # currency code of max_compensation. |
| 8590 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 8591 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 8592 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 8593 | # If `units` is positive, `nanos` must be positive or zero. |
| 8594 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 8595 | # If `units` is negative, `nanos` must be negative or zero. |
| 8596 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 8597 | "units": "A String", # The whole units of the amount. |
| 8598 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 8599 | }, |
| 8600 | "max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set |
| 8601 | # to a maximal compensation value and the currency code is set to |
| 8602 | # match the currency code of |
| 8603 | # min_compensation. |
| 8604 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 8605 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 8606 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 8607 | # If `units` is positive, `nanos` must be positive or zero. |
| 8608 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 8609 | # If `units` is negative, `nanos` must be negative or zero. |
| 8610 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 8611 | "units": "A String", # The whole units of the amount. |
| 8612 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 8613 | }, |
| 8614 | }, |
| 8615 | }, |
| 8616 | "languageCodes": [ # Optional. This filter specifies the locale of jobs to search against, |
| 8617 | # for example, "en-US". |
| 8618 | # |
| 8619 | # If a value is not specified, the search results may contain jobs in any |
| 8620 | # locale. |
| 8621 | # |
| 8622 | # |
| 8623 | # Language codes should be in BCP-47 format, for example, "en-US" or |
| 8624 | # "sr-Latn". For more information, see [Tags for Identifying |
| 8625 | # Languages](https://tools.ietf.org/html/bcp47). |
| 8626 | # |
| 8627 | # At most 10 language code filters are allowed. |
| 8628 | "A String", |
| 8629 | ], |
| 8630 | "extendedCompensationFilter": { # Deprecated. Always use CompensationFilter. # Deprecated. Always use compensation_filter. |
| 8631 | # |
| 8632 | # Optional. |
| 8633 | # |
| 8634 | # This search filter is applied only to |
| 8635 | # Job.extended_compensation_info. For example, if the filter is specified |
| 8636 | # as "Hourly job with per-hour compensation > $15", only jobs that meet |
| 8637 | # these criteria are searched. If a filter is not defined, all open jobs |
| 8638 | # are searched. |
| 8639 | # |
| 8640 | # Input only. |
| 8641 | # |
| 8642 | # Filter on job compensation type and amount. |
| 8643 | "currency": "A String", # Optional. Specify currency in 3-letter |
| 8644 | # [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) format. If |
| 8645 | # unspecified, jobs are returned regardless of currency. |
| 8646 | "type": "A String", # Required. Type of filter. |
| 8647 | "compensationUnits": [ # Required. Specify desired `base compensation entry's` |
| 8648 | # ExtendedCompensationInfo.CompensationUnit. |
| 8649 | "A String", |
| 8650 | ], |
| 8651 | "includeJobWithUnspecifiedCompensationRange": True or False, # Optional. Whether to include jobs whose compensation range is unspecified. |
| 8652 | "compensationRange": { # Deprecated. See CompensationInfo. # Optional. Compensation range. |
| 8653 | # |
| 8654 | # Compensation range. |
| 8655 | "max": { # Deprecated. See CompensationInfo. # Required. Maximum value. |
| 8656 | # |
| 8657 | # Decimal number. |
| 8658 | "micros": 42, # Micro (10^-6) units. |
| 8659 | # The value must be between -999,999 and +999,999 inclusive. |
| 8660 | # If `units` is positive, `micros` must be positive or zero. |
| 8661 | # If `units` is zero, `micros` can be positive, zero, or negative. |
| 8662 | # If `units` is negative, `micros` must be negative or zero. |
| 8663 | # For example -1.75 is represented as `units`=-1 and `micros`=-750,000. |
| 8664 | "units": "A String", # Whole units. |
| 8665 | }, |
| 8666 | "min": { # Deprecated. See CompensationInfo. # Required. Minimum value. |
| 8667 | # |
| 8668 | # Decimal number. |
| 8669 | "micros": 42, # Micro (10^-6) units. |
| 8670 | # The value must be between -999,999 and +999,999 inclusive. |
| 8671 | # If `units` is positive, `micros` must be positive or zero. |
| 8672 | # If `units` is zero, `micros` can be positive, zero, or negative. |
| 8673 | # If `units` is negative, `micros` must be negative or zero. |
| 8674 | # For example -1.75 is represented as `units`=-1 and `micros`=-750,000. |
| 8675 | "units": "A String", # Whole units. |
| 8676 | }, |
| 8677 | }, |
| 8678 | }, |
| 8679 | "commuteFilter": { # Input only. # Optional. Allows filtering jobs by commute time with different travel methods (e.g. |
| 8680 | # driving or public transit). Note: this only works with COMMUTE |
| 8681 | # MODE. When specified, [JobFilters.location_filters] will be |
| 8682 | # ignored. |
| 8683 | # |
| 8684 | # Currently we do not support sorting by commute time. |
| 8685 | # |
| 8686 | # Parameters needed for commute search. |
| 8687 | "roadTraffic": "A String", # Optional. Specifies the traffic density to use when calculating commute time. |
| 8688 | # Must not be present if departure_hour_local is specified. |
| 8689 | "allowNonStreetLevelAddress": True or False, # Optional. If `true`, jobs without street level addresses may also be returned. |
| 8690 | # For city level addresses, the city center is used. For state and coarser |
| 8691 | # level addresses, text matching is used. |
| 8692 | # If this field is set to `false` or is not specified, only jobs that include |
| 8693 | # street level addresses will be returned by commute search. |
| 8694 | "method": "A String", # Required. The method of transportation for which to calculate the commute time. |
| 8695 | "travelTime": "A String", # Required. The maximum travel time in seconds. The maximum allowed value is `3600s` |
| 8696 | # (one hour). Format is `123s`. |
| 8697 | "departureHourLocal": 42, # Optional. The departure hour to use to calculate traffic impact. Accepts an |
| 8698 | # integer between 0 and 23, representing the hour in the time zone of the |
| 8699 | # start_location. Must not be present if road_traffic is specified. |
| 8700 | "startLocation": { # 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 |
| 8701 | # commute time. |
| 8702 | # of doubles representing degrees latitude and degrees longitude. Unless |
| 8703 | # specified otherwise, this must conform to the |
| 8704 | # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 |
| 8705 | # standard</a>. Values must be within normalized ranges. |
| 8706 | "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. |
| 8707 | "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. |
| 8708 | }, |
| 8709 | }, |
| 8710 | "categories": [ # Optional. The category filter specifies the categories of jobs to search against. |
| 8711 | # See Category for more information. |
| 8712 | # |
| 8713 | # If a value is not specified, jobs from any category are searched against. |
| 8714 | # |
| 8715 | # If multiple values are specified, jobs from any of the specified |
| 8716 | # categories are searched against. |
| 8717 | "A String", |
| 8718 | ], |
| 8719 | "companyNames": [ # Optional. The company names filter specifies the company entities to search |
| 8720 | # against. |
| 8721 | # |
| 8722 | # If a value is not specified, jobs are searched for against all companies. |
| 8723 | # |
| 8724 | # If multiple values are specified, jobs are searched against the |
| 8725 | # specified companies. |
| 8726 | # |
| 8727 | # At most 20 company filters are allowed. |
| 8728 | "A String", |
| 8729 | ], |
| 8730 | "companyTitles": [ # Optional. This filter specifies the exact company titles |
| 8731 | # of jobs to search against. |
| 8732 | # |
| 8733 | # If a value is not specified, jobs within the search results can be |
| 8734 | # associated with any company. |
| 8735 | # |
| 8736 | # If multiple values are specified, jobs within the search results may be |
| 8737 | # associated with any of the specified companies. |
| 8738 | # |
| 8739 | # At most 20 company title filters are allowed. |
| 8740 | "A String", |
| 8741 | ], |
| 8742 | "employmentTypes": [ # Optional. The employment type filter specifies the employment type of jobs to |
| 8743 | # search against, such as EmploymentType.FULL_TIME. |
| 8744 | # |
| 8745 | # If a value is not specified, jobs in the search results include any |
| 8746 | # employment type. |
| 8747 | # |
| 8748 | # If multiple values are specified, jobs in the search results include any |
| 8749 | # of the specified employment types. |
| 8750 | "A String", |
| 8751 | ], |
| 8752 | }, |
| 8753 | "pageToken": "A String", # Optional. The token specifying the current offset within |
| 8754 | # search results. See SearchJobsResponse.next_page_token for |
| 8755 | # an explanation of how to obtain the next set of query results. |
| 8756 | "mode": "A String", # Required. Mode of a search. |
| 8757 | "enableBroadening": True or False, # Optional. Controls whether to broaden the search when it produces sparse results. |
| 8758 | # Broadened queries append results to the end of the matching results |
| 8759 | # list. |
| 8760 | # |
| 8761 | # Defaults to false. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 8762 | "query": { # Input only. # Optional. Query used to search against jobs, such as keyword, location filters, etc. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 8763 | # |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 8764 | # The query required to perform a search query or histogram. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 8765 | "query": "A String", # Optional. The query string that matches against the job title, description, and |
| 8766 | # location fields. |
| 8767 | # |
| 8768 | # The maximum query size is 255 bytes. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 8769 | "employmentTypes": [ # Optional. The employment type filter specifies the employment type of jobs to |
| 8770 | # search against, such as EmploymentType.FULL_TIME. |
| 8771 | # |
| 8772 | # If a value is not specified, jobs in the search results include any |
| 8773 | # employment type. |
| 8774 | # |
| 8775 | # If multiple values are specified, jobs in the search results include |
| 8776 | # any of the specified employment types. |
| 8777 | "A String", |
| 8778 | ], |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 8779 | "compensationFilter": { # Input only. # Optional. This search filter is applied only to |
| 8780 | # Job.compensation_info. For example, if the filter is specified |
| 8781 | # as "Hourly job with per-hour compensation > $15", only jobs meeting |
| 8782 | # these criteria are searched. If a filter isn't defined, all open jobs |
| 8783 | # are searched. |
| 8784 | # |
| 8785 | # Filter on job compensation type and amount. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 8786 | "type": "A String", # Required. Type of filter. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 8787 | "units": [ # Required. Specify desired `base compensation entry's` |
| 8788 | # CompensationInfo.CompensationUnit. |
| 8789 | "A String", |
| 8790 | ], |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 8791 | "includeJobsWithUnspecifiedCompensationRange": True or False, # Optional. Whether to include jobs whose compensation range is unspecified. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 8792 | "range": { # Compensation range. # Optional. Compensation range. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 8793 | "min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set |
| 8794 | # to zero and the currency code is set to match the |
| 8795 | # currency code of max_compensation. |
| 8796 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 8797 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 8798 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 8799 | # If `units` is positive, `nanos` must be positive or zero. |
| 8800 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 8801 | # If `units` is negative, `nanos` must be negative or zero. |
| 8802 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 8803 | "units": "A String", # The whole units of the amount. |
| 8804 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 8805 | }, |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 8806 | "max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set |
| 8807 | # to a maximal compensation value and the currency code is set to |
| 8808 | # match the currency code of |
| 8809 | # min_compensation. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 8810 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 8811 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 8812 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 8813 | # If `units` is positive, `nanos` must be positive or zero. |
| 8814 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 8815 | # If `units` is negative, `nanos` must be negative or zero. |
| 8816 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 8817 | "units": "A String", # The whole units of the amount. |
| 8818 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 8819 | }, |
| 8820 | }, |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 8821 | }, |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 8822 | "companyDisplayNames": [ # Optional. This filter specifies the exact company display |
| 8823 | # name of the jobs to search against. |
| 8824 | # |
| 8825 | # If a value isn't specified, jobs within the search results are |
| 8826 | # associated with any company. |
| 8827 | # |
| 8828 | # If multiple values are specified, jobs within the search results may be |
| 8829 | # associated with any of the specified companies. |
| 8830 | # |
| 8831 | # At most 20 company display name filters are allowed. |
| 8832 | "A String", |
| 8833 | ], |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 8834 | "commuteFilter": { # Input only. # Optional. Allows filtering jobs by commute time with different travel methods (for |
| 8835 | # example, driving or public transit). Note: This only works with COMMUTE |
| 8836 | # MODE. When specified, [JobQuery.location_filters] is |
| 8837 | # ignored. |
| 8838 | # |
| 8839 | # Currently we don't support sorting by commute time. |
| 8840 | # |
| 8841 | # Parameters needed for commute search. |
| 8842 | "roadTraffic": "A String", # Optional. Specifies the traffic density to use when calculating commute time. |
| 8843 | # Must not be present if departure_hour_local is specified. |
| 8844 | "allowNonStreetLevelAddress": True or False, # Optional. If `true`, jobs without street level addresses may also be returned. |
| 8845 | # For city level addresses, the city center is used. For state and coarser |
| 8846 | # level addresses, text matching is used. |
| 8847 | # If this field is set to `false` or is not specified, only jobs that include |
| 8848 | # street level addresses will be returned by commute search. |
| 8849 | "method": "A String", # Required. The method of transportation for which to calculate the commute time. |
| 8850 | "travelTime": "A String", # Required. The maximum travel time in seconds. The maximum allowed value is `3600s` |
| 8851 | # (one hour). Format is `123s`. |
| 8852 | "departureHourLocal": 42, # Optional. The departure hour to use to calculate traffic impact. Accepts an |
| 8853 | # integer between 0 and 23, representing the hour in the time zone of the |
| 8854 | # start_location. Must not be present if road_traffic is specified. |
| 8855 | "startLocation": { # 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 |
| 8856 | # commute time. |
| 8857 | # of doubles representing degrees latitude and degrees longitude. Unless |
| 8858 | # specified otherwise, this must conform to the |
| 8859 | # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 |
| 8860 | # standard</a>. Values must be within normalized ranges. |
| 8861 | "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. |
| 8862 | "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. |
| 8863 | }, |
| 8864 | }, |
| 8865 | "locationFilters": [ # Optional. The location filter specifies geo-regions containing the jobs to |
| 8866 | # search against. See LocationFilter for more information. |
| 8867 | # |
| 8868 | # If a location value isn't specified, jobs fitting the other search |
| 8869 | # criteria are retrieved regardless of where they're located. |
| 8870 | # |
| 8871 | # If multiple values are specified, jobs are retrieved from any of the |
| 8872 | # specified locations. If different values are specified for the |
| 8873 | # LocationFilter.distance_in_miles parameter, the maximum provided |
| 8874 | # distance is used for all locations. |
| 8875 | # |
| 8876 | # At most 5 location filters are allowed. |
| 8877 | { # Input only. |
| 8878 | # |
| 8879 | # Geographic region of the search. |
| 8880 | "name": "A String", # Optional. The address name, such as "Mountain View" or "Bay Area". |
| 8881 | "distanceInMiles": 3.14, # Optional. The distance_in_miles is applied when the location being searched for is |
| 8882 | # identified as a city or smaller. When the location being searched for is a |
| 8883 | # state or larger, this field is ignored. |
| 8884 | "isTelecommute": True or False, # Optional. Allows the client to return jobs without a |
| 8885 | # set location, specifically, telecommuting jobs (telecomuting is considered |
| 8886 | # by the service as a special location. |
| 8887 | # Job.allow_telecommute indicates if a job permits telecommuting. |
| 8888 | # If this field is true, telecommuting jobs are searched, and |
| 8889 | # name and lat_lng are |
| 8890 | # ignored. |
| 8891 | # This filter can be used by itself to search exclusively for telecommuting |
| 8892 | # jobs, or it can be combined with another location |
| 8893 | # filter to search for a combination of job locations, |
| 8894 | # such as "Mountain View" or "telecommuting" jobs. However, when used in |
| 8895 | # combination with other location filters, telecommuting jobs can be |
| 8896 | # treated as less relevant than other jobs in the search response. |
| 8897 | "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 |
| 8898 | # search. This field is ignored if `location_name` is provided. |
| 8899 | # of doubles representing degrees latitude and degrees longitude. Unless |
| 8900 | # specified otherwise, this must conform to the |
| 8901 | # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 |
| 8902 | # standard</a>. Values must be within normalized ranges. |
| 8903 | "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. |
| 8904 | "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. |
| 8905 | }, |
| 8906 | "regionCode": "A String", # Optional. CLDR region code of the country/region of the address. This will be used |
| 8907 | # to address ambiguity of the user-input location, e.g. "Liverpool" |
| 8908 | # against "Liverpool, NY, US" or "Liverpool, UK". |
| 8909 | # |
| 8910 | # Set this field if all the jobs to search against are from a same region, |
| 8911 | # or jobs are world-wide but the job seeker is from a specific region. |
| 8912 | # |
| 8913 | # See http://cldr.unicode.org/ and |
| 8914 | # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html |
| 8915 | # for details. Example: "CH" for Switzerland. |
| 8916 | }, |
| 8917 | ], |
| 8918 | "languageCodes": [ # Optional. This filter specifies the locale of jobs to search against, |
| 8919 | # for example, "en-US". |
| 8920 | # |
| 8921 | # If a value isn't specified, the search results can contain jobs in any |
| 8922 | # locale. |
| 8923 | # |
| 8924 | # |
| 8925 | # Language codes should be in BCP-47 format, such as "en-US" or "sr-Latn". |
| 8926 | # For more information, see |
| 8927 | # [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). |
| 8928 | # |
| 8929 | # At most 10 language code filters are allowed. |
| 8930 | "A String", |
| 8931 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 8932 | "companyNames": [ # Optional. This filter specifies the company entities to search against. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 8933 | # |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 8934 | # If a value isn't specified, jobs are searched for against all |
| 8935 | # companies. |
| 8936 | # |
| 8937 | # If multiple values are specified, jobs are searched against the |
| 8938 | # companies specified. |
| 8939 | # |
| 8940 | # At most 20 company filters are allowed. |
| 8941 | "A String", |
| 8942 | ], |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 8943 | "disableSpellCheck": True or False, # Optional. This flag controls the spell-check feature. If false, the |
| 8944 | # service attempts to correct a misspelled query, |
| 8945 | # for example, "enginee" is corrected to "engineer". |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 8946 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 8947 | # Defaults to false: a spell check is performed. |
| 8948 | "publishDateRange": "A String", # Optional. Jobs published within a range specified by this filter are searched |
| 8949 | # against, for example, DateRange.PAST_MONTH. If a value isn't |
| 8950 | # specified, all open jobs are searched against regardless of their |
| 8951 | # published date. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 8952 | "categories": [ # Optional. The category filter specifies the categories of jobs to search against. |
| 8953 | # See Category for more information. |
| 8954 | # |
| 8955 | # If a value is not specified, jobs from any category are searched against. |
| 8956 | # |
| 8957 | # If multiple values are specified, jobs from any of the specified |
| 8958 | # categories are searched against. |
| 8959 | "A String", |
| 8960 | ], |
| 8961 | "customAttributeFilter": "A String", # Optional. This filter specifies a structured syntax to match against the |
| 8962 | # Job.custom_attributes marked as `filterable`. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 8963 | # |
| 8964 | # The syntax for this expression is a subset of Google SQL syntax. |
| 8965 | # |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 8966 | # Supported operators are: =, !=, <, <=, >, >= where the left of the operator |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 8967 | # is a custom field key and the right of the operator is a number or string |
| 8968 | # (surrounded by quotes) value. |
| 8969 | # |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 8970 | # Supported functions are LOWER(<field_name>) to |
| 8971 | # perform case insensitive match and EMPTY(<field_name>) to filter on the |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 8972 | # existence of a key. |
| 8973 | # |
| 8974 | # Boolean expressions (AND/OR/NOT) are supported up to 3 levels of |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 8975 | # nesting (for example, "((A AND B AND C) OR NOT D) AND E"), a maximum of 50 |
| 8976 | # comparisons/functions are allowed in the expression. The expression |
| 8977 | # must be < 2000 characters in length. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 8978 | # |
| 8979 | # Sample Query: |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 8980 | # (key1 = "TEST" OR LOWER(key1)="test" OR NOT EMPTY(key1)) AND key2 > 100 |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 8981 | }, |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 8982 | } |
| 8983 | |
| 8984 | x__xgafv: string, V1 error format. |
| 8985 | Allowed values |
| 8986 | 1 - v1 error format |
| 8987 | 2 - v2 error format |
| 8988 | |
| 8989 | Returns: |
| 8990 | An object of the form: |
| 8991 | |
| 8992 | { # Output only. |
| 8993 | # |
| 8994 | # Response for SearchJob method. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 8995 | "appliedCommuteFilter": { # Input only. # The commute filter the service applied to the specified query. This |
| 8996 | # information is only available when query has a valid CommutePreference. |
| 8997 | # |
| 8998 | # Parameters needed for commute search. |
| 8999 | "roadTraffic": "A String", # Optional. Specifies the traffic density to use when calculating commute time. |
| 9000 | # Must not be present if departure_hour_local is specified. |
| 9001 | "allowNonStreetLevelAddress": True or False, # Optional. If `true`, jobs without street level addresses may also be returned. |
| 9002 | # For city level addresses, the city center is used. For state and coarser |
| 9003 | # level addresses, text matching is used. |
| 9004 | # If this field is set to `false` or is not specified, only jobs that include |
| 9005 | # street level addresses will be returned by commute search. |
| 9006 | "method": "A String", # Required. The method of transportation for which to calculate the commute time. |
| 9007 | "travelTime": "A String", # Required. The maximum travel time in seconds. The maximum allowed value is `3600s` |
| 9008 | # (one hour). Format is `123s`. |
| 9009 | "departureHourLocal": 42, # Optional. The departure hour to use to calculate traffic impact. Accepts an |
| 9010 | # integer between 0 and 23, representing the hour in the time zone of the |
| 9011 | # start_location. Must not be present if road_traffic is specified. |
| 9012 | "startLocation": { # 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 |
| 9013 | # commute time. |
| 9014 | # of doubles representing degrees latitude and degrees longitude. Unless |
| 9015 | # specified otherwise, this must conform to the |
| 9016 | # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 |
| 9017 | # standard</a>. Values must be within normalized ranges. |
| 9018 | "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. |
| 9019 | "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. |
| 9020 | }, |
| 9021 | }, |
| 9022 | "numJobsFromBroadenedQuery": 42, # If query broadening is enabled, we may append additional results from the |
| 9023 | # broadened query. This number indicates how many of the jobs returned in the |
| 9024 | # jobs field are from the broadened query. These results are always at the |
| 9025 | # end of the jobs list. In particular, a value of 0 means all the jobs in the |
| 9026 | # jobs list are from the original (without broadening) query. If this |
| 9027 | # field is non-zero, subsequent requests with offset after this result set |
| 9028 | # should contain all broadened results. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 9029 | "metadata": { # Output only. # Additional information for the API invocation, such as the request |
| 9030 | # tracking id. |
| 9031 | # |
| 9032 | # Additional information returned to client, such as debugging |
| 9033 | # information. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 9034 | "mode": "A String", # For search response only. Indicates the mode of a performed search. |
| 9035 | "experimentIdList": [ # Identifiers for the versions of the search algorithm used during |
| 9036 | # this API invocation if multiple algorithms are used. |
| 9037 | # The default value is empty. |
| 9038 | # For search response only. |
| 9039 | 42, |
| 9040 | ], |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 9041 | "requestId": "A String", # A unique id associated with this call. |
| 9042 | # This id is logged for tracking purposes. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 9043 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 9044 | "matchingJobs": [ # The Job entities that match the specified SearchJobsRequest. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 9045 | { # Output only. |
| 9046 | # |
| 9047 | # Job entry with metadata inside SearchJobsResponse. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 9048 | "job": { # A Job resource represents a job posting (also referred to as a "job listing" # Job resource that matches the specified SearchJobsRequest. |
| 9049 | # 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] | 9050 | # entity responsible for the job. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 9051 | "languageCode": "A String", # Optional. The language of the posting. This field is distinct from |
| 9052 | # any requirements for fluency that are associated with the job. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 9053 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 9054 | # Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn". |
| 9055 | # For more information, see |
| 9056 | # [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){: |
| 9057 | # class="external" target="_blank" }. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 9058 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 9059 | # If this field is unspecified and Job.description is present, detected |
| 9060 | # language code based on Job.description is assigned, otherwise |
| 9061 | # defaults to 'en_US'. |
| 9062 | "educationLevels": [ # Optional. The desired education level for the job, such as |
| 9063 | # "Bachelors", "Masters", "Doctorate". |
| 9064 | "A String", |
| 9065 | ], |
| 9066 | "description": "A String", # Required. The description of the job, which typically includes a multi-paragraph |
| 9067 | # description of the company and related information. Separate fields are |
| 9068 | # provided on the job object for responsibilities, |
| 9069 | # qualifications, and other job characteristics. Use of |
| 9070 | # these separate job fields is recommended. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 9071 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 9072 | # This field accepts and sanitizes HTML input, and also accepts |
| 9073 | # bold, italic, ordered list, and unordered list markup tags. |
| 9074 | # |
| 9075 | # The maximum number of allowed characters is 100,000. |
| 9076 | "updateTime": "A String", # Output only. The timestamp when this job was last updated. |
| 9077 | "promotionValue": 42, # Optional. A promotion value of the job, as determined by the client. |
| 9078 | # The value determines the sort order of the jobs returned when searching for |
| 9079 | # jobs using the featured jobs search call, with higher promotional values |
| 9080 | # being returned first and ties being resolved by relevance sort. Only the |
| 9081 | # jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH. |
| 9082 | # |
| 9083 | # Default value is 0, and negative values are treated as 0. |
| 9084 | "qualifications": "A String", # Optional. A description of the qualifications required to perform the |
| 9085 | # job. The use of this field is recommended |
| 9086 | # as an alternative to using the more general description field. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 9087 | # |
| 9088 | # This field accepts and sanitizes HTML input, and also accepts |
| 9089 | # bold, italic, ordered list, and unordered list markup tags. |
| 9090 | # |
| 9091 | # The maximum number of allowed characters is 10,000. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 9092 | "customAttributes": { # Optional. A map of fields to hold both filterable and non-filterable custom job |
| 9093 | # attributes that are not covered by the provided structured fields. |
| 9094 | # |
| 9095 | # This field is a more general combination of the deprecated id-based |
| 9096 | # filterable_custom_fields and string-based |
| 9097 | # non_filterable_custom_fields. |
| 9098 | # |
| 9099 | # The keys of the map are strings up to 64 bytes and must match the |
| 9100 | # pattern: a-zA-Z*. |
| 9101 | # |
| 9102 | # At most 100 filterable and at most 100 unfilterable keys are supported. |
| 9103 | # For filterable `string_values`, across all keys at most 200 values are |
| 9104 | # allowed, with each string no more than 255 characters. For unfilterable |
| 9105 | # `string_values`, the maximum total size of `string_values` across all keys |
| 9106 | # is 50KB. |
| 9107 | "a_key": { # Custom attribute values that are either filterable or non-filterable. |
| 9108 | "longValue": "A String", # Optional but at least one of string_values or long_value must |
| 9109 | # be specified. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 9110 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 9111 | # This field is used to perform number range search. |
| 9112 | # (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`. For |
| 9113 | # `long_value`, a value between Long.MIN and Long.MAX is allowed. |
| 9114 | "filterable": True or False, # Optional. If the `filterable` flag is true, custom field values are searchable. |
| 9115 | # If false, values are not searchable. |
| 9116 | # |
| 9117 | # Default is false. |
| 9118 | "stringValues": { # Represents array of string values. # Optional but at least one of string_values or long_value must |
| 9119 | # be specified. |
| 9120 | # |
| 9121 | # This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or |
| 9122 | # `CASE_INSENSITIVE_MATCH`) search. |
| 9123 | # For filterable `string_values`, a maximum total number of 200 values |
| 9124 | # is allowed, with each `string_value` has a byte size of no more than |
| 9125 | # 255B. For unfilterable `string_values`, the maximum total byte size of |
| 9126 | # unfilterable `string_values` is 50KB. |
| 9127 | # |
| 9128 | # Empty strings are not allowed. |
| 9129 | "values": [ # Required. String values. |
| 9130 | "A String", |
| 9131 | ], |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 9132 | }, |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 9133 | }, |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 9134 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 9135 | "applicationUrls": [ # Optional but at least one of application_urls, |
| 9136 | # application_email_list or application_instruction must be |
| 9137 | # specified. |
| 9138 | # |
| 9139 | # Use this URL field to direct an applicant to a website, for example to |
| 9140 | # link to an online application form. |
| 9141 | # |
| 9142 | # The maximum number of allowed characters is 2,000. |
| 9143 | "A String", |
| 9144 | ], |
| 9145 | "requisitionId": "A String", # Required. The requisition ID, also referred to as the posting ID, assigned by the |
| 9146 | # client to identify a job. This field is intended to be used by clients |
| 9147 | # for client identification and tracking of listings. A job is not allowed |
| 9148 | # to be created if there is another job with the same requisition_id, |
| 9149 | # company_name and language_code. |
| 9150 | # |
| 9151 | # The maximum number of allowed characters is 255. |
| 9152 | "jobLocations": [ # Output only. Structured locations of the job, resolved from locations. |
| 9153 | { # Output only. |
| 9154 | # |
| 9155 | # A resource that represents a location with full geographic |
| 9156 | # information. |
| 9157 | "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair. |
| 9158 | # of doubles representing degrees latitude and degrees longitude. Unless |
| 9159 | # specified otherwise, this must conform to the |
| 9160 | # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 |
| 9161 | # standard</a>. Values must be within normalized ranges. |
| 9162 | "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. |
| 9163 | "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. |
| 9164 | }, |
| 9165 | "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information, |
| 9166 | # such as postal delivery and payments addresses. Given a postal address, |
| 9167 | # a postal service can deliver items to a premises, P.O. Box, or other |
| 9168 | # delivery location. |
| 9169 | # Given a postal address, a postal service can deliver items to a premise, P.O. |
| 9170 | # Box or similar. |
| 9171 | # It is not intended to model geographical locations (roads, towns, |
| 9172 | # mountains). |
| 9173 | # |
| 9174 | # In typical usage an address would be created via user input or from importing |
| 9175 | # existing data, depending on the type of process. |
| 9176 | # |
| 9177 | # Advice on address input / editing: |
| 9178 | # - Use an i18n-ready address widget such as |
| 9179 | # https://github.com/google/libaddressinput) |
| 9180 | # - Users should not be presented with UI elements for input or editing of |
| 9181 | # fields outside countries where that field is used. |
| 9182 | # |
| 9183 | # For more guidance on how to use this schema, please see: |
| 9184 | # https://support.google.com/business/answer/6397478 |
| 9185 | "sublocality": "A String", # Optional. Sublocality of the address. |
| 9186 | # For example, this can be neighborhoods, boroughs, districts. |
| 9187 | "recipients": [ # Optional. The recipient at the address. |
| 9188 | # This field may, under certain circumstances, contain multiline information. |
| 9189 | # For example, it might contain "care of" information. |
| 9190 | "A String", |
| 9191 | ], |
| 9192 | "locality": "A String", # Optional. Generally refers to the city/town portion of the address. |
| 9193 | # Examples: US city, IT comune, UK post town. |
| 9194 | # In regions of the world where localities are not well defined or do not fit |
| 9195 | # into this structure well, leave locality empty and use address_lines. |
| 9196 | "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This |
| 9197 | # is never inferred and it is up to the user to ensure the value is |
| 9198 | # correct. See http://cldr.unicode.org/ and |
| 9199 | # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html |
| 9200 | # for details. Example: "CH" for Switzerland. |
| 9201 | "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if |
| 9202 | # known). This is often the UI language of the input form or is expected |
| 9203 | # to match one of the languages used in the address' country/region, or their |
| 9204 | # transliterated equivalents. |
| 9205 | # This can affect formatting in certain countries, but is not critical |
| 9206 | # to the correctness of the data and will never affect any validation or |
| 9207 | # other non-formatting related operations. |
| 9208 | # |
| 9209 | # If this value is not known, it should be omitted (rather than specifying a |
| 9210 | # possibly incorrect default). |
| 9211 | # |
| 9212 | # Examples: "zh-Hant", "ja", "ja-Latn", "en". |
| 9213 | "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require |
| 9214 | # postal codes to be present, but where they are used, they may trigger |
| 9215 | # additional validation with other parts of the address (e.g. state/zip |
| 9216 | # validation in the U.S.A.). |
| 9217 | "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal |
| 9218 | # addresses of a country or region. |
| 9219 | # For example, this can be a state, a province, an oblast, or a prefecture. |
| 9220 | # Specifically, for Spain this is the province and not the autonomous |
| 9221 | # community (e.g. "Barcelona" and not "Catalonia"). |
| 9222 | # Many countries don't use an administrative area in postal addresses. E.g. |
| 9223 | # in Switzerland this should be left unpopulated. |
| 9224 | "addressLines": [ # Unstructured address lines describing the lower levels of an address. |
| 9225 | # |
| 9226 | # Because values in address_lines do not have type information and may |
| 9227 | # sometimes contain multiple values in a single field (e.g. |
| 9228 | # "Austin, TX"), it is important that the line order is clear. The order of |
| 9229 | # address lines should be "envelope order" for the country/region of the |
| 9230 | # address. In places where this can vary (e.g. Japan), address_language is |
| 9231 | # used to make it explicit (e.g. "ja" for large-to-small ordering and |
| 9232 | # "ja-Latn" or "en" for small-to-large). This way, the most specific line of |
| 9233 | # an address can be selected based on the language. |
| 9234 | # |
| 9235 | # The minimum permitted structural representation of an address consists |
| 9236 | # of a region_code with all remaining information placed in the |
| 9237 | # address_lines. It would be possible to format such an address very |
| 9238 | # approximately without geocoding, but no semantic reasoning could be |
| 9239 | # made about any of the address components until it was at least |
| 9240 | # partially resolved. |
| 9241 | # |
| 9242 | # Creating an address only containing a region_code and address_lines, and |
| 9243 | # then geocoding is the recommended way to handle completely unstructured |
| 9244 | # addresses (as opposed to guessing which parts of the address should be |
| 9245 | # localities or administrative areas). |
| 9246 | "A String", |
| 9247 | ], |
| 9248 | "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used |
| 9249 | # in most regions. Where it is used, the value is either a string like |
| 9250 | # "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number |
| 9251 | # alone, representing the "sector code" (Jamaica), "delivery area indicator" |
| 9252 | # (Malawi) or "post office indicator" (e.g. Côte d'Ivoire). |
| 9253 | "organization": "A String", # Optional. The name of the organization at the address. |
| 9254 | "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is |
| 9255 | # the latest revision. |
| 9256 | # |
| 9257 | # All new revisions **must** be backward compatible with old revisions. |
| 9258 | }, |
| 9259 | "locationType": "A String", # The type of a location, which corresponds to the address lines field of |
| 9260 | # PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of |
| 9261 | # LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of |
| 9262 | # LocationType#LOCALITY. |
| 9263 | "radiusMeters": 3.14, # Radius in meters of the job location. This value is derived from the |
| 9264 | # location bounding box in which a circle with the specified radius |
| 9265 | # centered from LatLng coves the area associated with the job location. |
| 9266 | # For example, currently, "Mountain View, CA, USA" has a radius of |
| 9267 | # 7885.79 meters. |
| 9268 | }, |
| 9269 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 9270 | "expireTime": "A String", # Optional but strongly recommended for the best service |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 9271 | # experience. |
| 9272 | # |
| 9273 | # The expiration timestamp of the job. After this timestamp, the |
| 9274 | # job is marked as expired, and it no longer appears in search results. The |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 9275 | # expired job can't be deleted or listed by the DeleteJob and |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 9276 | # ListJobs APIs, but it can be retrieved with the GetJob API or |
| 9277 | # updated with the UpdateJob API. An expired job can be updated and |
| 9278 | # opened again by using a future expiration timestamp. Updating an expired |
| 9279 | # job fails if there is another existing open job with same |
| 9280 | # requisition_id, company_name and language_code. |
| 9281 | # |
| 9282 | # The expired jobs are retained in our system for 90 days. However, the |
| 9283 | # overall expired job count cannot exceed 3 times the maximum of open jobs |
| 9284 | # count over the past week, otherwise jobs with earlier expire time are |
| 9285 | # cleaned first. Expired jobs are no longer accessible after they are cleaned |
| 9286 | # out. |
| 9287 | # The format of this field is RFC 3339 date strings. Example: |
| 9288 | # 2000-01-01T00:00:00.999999999Z |
| 9289 | # See |
| 9290 | # [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt). |
| 9291 | # |
| 9292 | # A valid date range is between 1970-01-01T00:00:00.0Z and |
| 9293 | # 2100-12-31T23:59:59.999Z. Invalid dates are ignored and treated as expire |
| 9294 | # time not provided. |
| 9295 | # |
| 9296 | # If this value is not provided at the time of job creation or is invalid, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 9297 | # the job posting expires after 30 days from the job's creation time. For |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 9298 | # example, if the job was created on 2017/01/01 13:00AM UTC with an |
| 9299 | # unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC. |
| 9300 | # |
| 9301 | # If this value is not provided but expiry_date is, expiry_date is |
| 9302 | # used. |
| 9303 | # |
| 9304 | # If this value is not provided on job update, it depends on the field masks |
| 9305 | # set by UpdateJobRequest.update_job_fields. If the field masks include |
| 9306 | # expiry_time, or the masks are empty meaning that every field is |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 9307 | # updated, the job posting expires after 30 days from the job's last |
| 9308 | # update time. Otherwise the expiration date isn't updated. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 9309 | "name": "A String", # Required during job update. |
| 9310 | # |
| 9311 | # Resource name assigned to a job by the API, for example, "/jobs/foo". Use |
| 9312 | # of this field in job queries and API calls is preferred over the use of |
| 9313 | # requisition_id since this value is unique. |
| 9314 | "jobTitle": "A String", # Required. The title of the job, such as "Software Engineer" |
| 9315 | # |
| 9316 | # The maximum number of allowed characters is 500. |
| 9317 | "referenceUrl": "A String", # Output only. The URL of a web page that displays job details. |
| 9318 | "responsibilities": "A String", # Optional. A description of job responsibilities. The use of this field is |
| 9319 | # recommended as an alternative to using the more general description |
| 9320 | # field. |
| 9321 | # |
| 9322 | # This field accepts and sanitizes HTML input, and also accepts |
| 9323 | # bold, italic, ordered list, and unordered list markup tags. |
| 9324 | # |
| 9325 | # The maximum number of allowed characters is 10,000. |
| 9326 | "distributorCompanyId": "A String", # Optional but one of company_name or distributor_company_id must be |
| 9327 | # provided. |
| 9328 | # |
| 9329 | # A unique company identifier used by job distributors to identify an |
| 9330 | # employer's company entity. company_name takes precedence over |
| 9331 | # this field, and is the recommended field to use to identify companies. |
| 9332 | # |
| 9333 | # The maximum number of allowed characters is 255. |
| 9334 | "publishDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Optional. The date this job was most recently published in UTC format. The default |
| 9335 | # value is the time the request arrives at the server. |
| 9336 | # and time zone are either specified elsewhere or are not significant. The date |
| 9337 | # is relative to the Proleptic Gregorian Calendar. This can represent: |
| 9338 | # |
| 9339 | # * A full date, with non-zero year, month and day values |
| 9340 | # * A month and day value, with a zero year, e.g. an anniversary |
| 9341 | # * A year on its own, with zero month and day values |
| 9342 | # * A year and month value, with a zero day, e.g. a credit card expiration date |
| 9343 | # |
| 9344 | # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. |
| 9345 | "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| 9346 | # a year. |
| 9347 | "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| 9348 | # if specifying a year by itself or a year and month where the day is not |
| 9349 | # significant. |
| 9350 | "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| 9351 | # month and day. |
| 9352 | }, |
| 9353 | "applicationInstruction": "A String", # Optional but at least one of application_urls, |
| 9354 | # application_email_list or application_instruction must be |
| 9355 | # specified. |
| 9356 | # |
| 9357 | # Use this field to provide instructions, such as "Mail your application |
| 9358 | # to ...", that a candidate can follow to apply for the job. |
| 9359 | # |
| 9360 | # This field accepts and sanitizes HTML input, and also accepts |
| 9361 | # bold, italic, ordered list, and unordered list markup tags. |
| 9362 | # |
| 9363 | # The maximum number of allowed characters is 3,000. |
| 9364 | "extendedCompensationInfo": { # Deprecated. Use CompensationInfo. # Deprecated. Always use compensation_info. |
| 9365 | # |
| 9366 | # Optional. |
| 9367 | # |
| 9368 | # Job compensation information. |
| 9369 | # |
| 9370 | # This field replaces compensation_info. Only |
| 9371 | # CompensationInfo.entries or extended_compensation_info can be set, |
| 9372 | # otherwise an exception is thrown. |
| 9373 | # |
| 9374 | # Describes job compensation. |
| 9375 | "annualizedBaseCompensationRange": { # Deprecated. See CompensationInfo. # Output only. Annualized base compensation range. |
| 9376 | # |
| 9377 | # Compensation range. |
| 9378 | "max": { # Deprecated. See CompensationInfo. # Required. Maximum value. |
| 9379 | # |
| 9380 | # Decimal number. |
| 9381 | "micros": 42, # Micro (10^-6) units. |
| 9382 | # The value must be between -999,999 and +999,999 inclusive. |
| 9383 | # If `units` is positive, `micros` must be positive or zero. |
| 9384 | # If `units` is zero, `micros` can be positive, zero, or negative. |
| 9385 | # If `units` is negative, `micros` must be negative or zero. |
| 9386 | # For example -1.75 is represented as `units`=-1 and `micros`=-750,000. |
| 9387 | "units": "A String", # Whole units. |
| 9388 | }, |
| 9389 | "min": { # Deprecated. See CompensationInfo. # Required. Minimum value. |
| 9390 | # |
| 9391 | # Decimal number. |
| 9392 | "micros": 42, # Micro (10^-6) units. |
| 9393 | # The value must be between -999,999 and +999,999 inclusive. |
| 9394 | # If `units` is positive, `micros` must be positive or zero. |
| 9395 | # If `units` is zero, `micros` can be positive, zero, or negative. |
| 9396 | # If `units` is negative, `micros` must be negative or zero. |
| 9397 | # For example -1.75 is represented as `units`=-1 and `micros`=-750,000. |
| 9398 | "units": "A String", # Whole units. |
| 9399 | }, |
| 9400 | }, |
| 9401 | "annualizedTotalCompensationUnspecified": True or False, # Output only. Indicates annualized total compensation range cannot be derived, due to |
| 9402 | # the job's all CompensationEntry cannot be annualized. |
| 9403 | # See CompensationEntry for explanation on annualization and base |
| 9404 | # compensation entry. |
| 9405 | "currency": "A String", # Optional. A 3-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) |
| 9406 | # currency code. |
| 9407 | "annualizedBaseCompensationUnspecified": True or False, # Output only. Indicates annualized base compensation range cannot be derived, due to |
| 9408 | # the job's base compensation entry cannot be annualized. |
| 9409 | # See CompensationEntry for explanation on annualization and base |
| 9410 | # compensation entry. |
| 9411 | "entries": [ # Optional. Job compensation information. |
| 9412 | # |
| 9413 | # At most one entry can be of type |
| 9414 | # ExtendedCompensationInfo.CompensationType.BASE, which is |
| 9415 | # referred as ** base compensation entry ** for the job. |
| 9416 | { # Deprecated. See CompensationInfo. |
| 9417 | # |
| 9418 | # A compensation entry that represents one component of compensation, such |
| 9419 | # as base pay, bonus, or other compensation type. |
| 9420 | # |
| 9421 | # Annualization: One compensation entry can be annualized if |
| 9422 | # - it contains valid amount or range. |
| 9423 | # - and its expected_units_per_year is set or can be derived. |
| 9424 | # Its annualized range is determined as (amount or range) times |
| 9425 | # expected_units_per_year. |
| 9426 | "range": { # Deprecated. See CompensationInfo. # Optional. Compensation range. |
| 9427 | # |
| 9428 | # Compensation range. |
| 9429 | "max": { # Deprecated. See CompensationInfo. # Required. Maximum value. |
| 9430 | # |
| 9431 | # Decimal number. |
| 9432 | "micros": 42, # Micro (10^-6) units. |
| 9433 | # The value must be between -999,999 and +999,999 inclusive. |
| 9434 | # If `units` is positive, `micros` must be positive or zero. |
| 9435 | # If `units` is zero, `micros` can be positive, zero, or negative. |
| 9436 | # If `units` is negative, `micros` must be negative or zero. |
| 9437 | # For example -1.75 is represented as `units`=-1 and `micros`=-750,000. |
| 9438 | "units": "A String", # Whole units. |
| 9439 | }, |
| 9440 | "min": { # Deprecated. See CompensationInfo. # Required. Minimum value. |
| 9441 | # |
| 9442 | # Decimal number. |
| 9443 | "micros": 42, # Micro (10^-6) units. |
| 9444 | # The value must be between -999,999 and +999,999 inclusive. |
| 9445 | # If `units` is positive, `micros` must be positive or zero. |
| 9446 | # If `units` is zero, `micros` can be positive, zero, or negative. |
| 9447 | # If `units` is negative, `micros` must be negative or zero. |
| 9448 | # For example -1.75 is represented as `units`=-1 and `micros`=-750,000. |
| 9449 | "units": "A String", # Whole units. |
| 9450 | }, |
| 9451 | }, |
| 9452 | "expectedUnitsPerYear": { # Deprecated. See CompensationInfo. # Optional. Expected number of units paid each year. If not specified, when |
| 9453 | # Job.employment_types is FULLTIME, a default value is inferred |
| 9454 | # based on unit. Default values: |
| 9455 | # - HOURLY: 2080 |
| 9456 | # - DAILY: 260 |
| 9457 | # - WEEKLY: 52 |
| 9458 | # - MONTHLY: 12 |
| 9459 | # - ANNUAL: 1 |
| 9460 | # |
| 9461 | # Decimal number. |
| 9462 | "micros": 42, # Micro (10^-6) units. |
| 9463 | # The value must be between -999,999 and +999,999 inclusive. |
| 9464 | # If `units` is positive, `micros` must be positive or zero. |
| 9465 | # If `units` is zero, `micros` can be positive, zero, or negative. |
| 9466 | # If `units` is negative, `micros` must be negative or zero. |
| 9467 | # For example -1.75 is represented as `units`=-1 and `micros`=-750,000. |
| 9468 | "units": "A String", # Whole units. |
| 9469 | }, |
| 9470 | "amount": { # Deprecated. See CompensationInfo. # Optional. Monetary amount. |
| 9471 | # |
| 9472 | # Decimal number. |
| 9473 | "micros": 42, # Micro (10^-6) units. |
| 9474 | # The value must be between -999,999 and +999,999 inclusive. |
| 9475 | # If `units` is positive, `micros` must be positive or zero. |
| 9476 | # If `units` is zero, `micros` can be positive, zero, or negative. |
| 9477 | # If `units` is negative, `micros` must be negative or zero. |
| 9478 | # For example -1.75 is represented as `units`=-1 and `micros`=-750,000. |
| 9479 | "units": "A String", # Whole units. |
| 9480 | }, |
| 9481 | "description": "A String", # Optional. Compensation description. |
| 9482 | "unspecified": True or False, # Optional. Indicates compensation amount and range are unset. |
| 9483 | "unit": "A String", # Optional. Frequency of the specified amount. |
| 9484 | # |
| 9485 | # Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED. |
| 9486 | "type": "A String", # Required. Compensation type. |
| 9487 | }, |
| 9488 | ], |
| 9489 | "annualizedTotalCompensationRange": { # Deprecated. See CompensationInfo. # Output only. Annualized total compensation range. |
| 9490 | # |
| 9491 | # Compensation range. |
| 9492 | "max": { # Deprecated. See CompensationInfo. # Required. Maximum value. |
| 9493 | # |
| 9494 | # Decimal number. |
| 9495 | "micros": 42, # Micro (10^-6) units. |
| 9496 | # The value must be between -999,999 and +999,999 inclusive. |
| 9497 | # If `units` is positive, `micros` must be positive or zero. |
| 9498 | # If `units` is zero, `micros` can be positive, zero, or negative. |
| 9499 | # If `units` is negative, `micros` must be negative or zero. |
| 9500 | # For example -1.75 is represented as `units`=-1 and `micros`=-750,000. |
| 9501 | "units": "A String", # Whole units. |
| 9502 | }, |
| 9503 | "min": { # Deprecated. See CompensationInfo. # Required. Minimum value. |
| 9504 | # |
| 9505 | # Decimal number. |
| 9506 | "micros": 42, # Micro (10^-6) units. |
| 9507 | # The value must be between -999,999 and +999,999 inclusive. |
| 9508 | # If `units` is positive, `micros` must be positive or zero. |
| 9509 | # If `units` is zero, `micros` can be positive, zero, or negative. |
| 9510 | # If `units` is negative, `micros` must be negative or zero. |
| 9511 | # For example -1.75 is represented as `units`=-1 and `micros`=-750,000. |
| 9512 | "units": "A String", # Whole units. |
| 9513 | }, |
| 9514 | }, |
| 9515 | }, |
| 9516 | "startDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Optional. The start date of the job in UTC time zone. Typically this field |
| 9517 | # is used for contracting engagements. |
| 9518 | # Dates prior to 1970/1/1 and invalid date formats are ignored. |
| 9519 | # and time zone are either specified elsewhere or are not significant. The date |
| 9520 | # is relative to the Proleptic Gregorian Calendar. This can represent: |
| 9521 | # |
| 9522 | # * A full date, with non-zero year, month and day values |
| 9523 | # * A month and day value, with a zero year, e.g. an anniversary |
| 9524 | # * A year on its own, with zero month and day values |
| 9525 | # * A year and month value, with a zero day, e.g. a credit card expiration date |
| 9526 | # |
| 9527 | # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. |
| 9528 | "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| 9529 | # a year. |
| 9530 | "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| 9531 | # if specifying a year by itself or a year and month where the day is not |
| 9532 | # significant. |
| 9533 | "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| 9534 | # month and day. |
| 9535 | }, |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 9536 | "department": "A String", # Optional. The department or functional area within the company with the open |
| 9537 | # position. |
| 9538 | # |
| 9539 | # The maximum number of allowed characters is 255. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 9540 | "applicationEmailList": [ # Optional but at least one of application_urls, |
| 9541 | # application_email_list or application_instruction must be |
| 9542 | # specified. |
| 9543 | # |
| 9544 | # Use this field to specify email address(es) to which resumes or |
| 9545 | # applications can be sent. |
| 9546 | # |
| 9547 | # The maximum number of allowed characters is 255. |
| 9548 | "A String", |
| 9549 | ], |
| 9550 | "companyTitle": "A String", # Deprecated. Use company_display_name instead. |
| 9551 | # |
| 9552 | # Output only. |
| 9553 | # |
| 9554 | # The name of the company listing the job. |
| 9555 | "level": "A String", # Optional. The experience level associated with the job, such as "Entry Level". |
| 9556 | "filterableCustomFields": { # Deprecated. Use custom_attributes instead. |
| 9557 | # |
| 9558 | # Optional. |
| 9559 | # |
| 9560 | # A map of fields to hold filterable custom job attributes not captured by |
| 9561 | # the standard fields such as job_title, company_name, or |
| 9562 | # level. These custom fields store arbitrary |
| 9563 | # string values, and can be used for purposes not covered by |
| 9564 | # the structured fields. For the best search experience, use of the |
| 9565 | # structured rather than custom fields is recommended. |
| 9566 | # |
| 9567 | # Data stored in these custom fields fields are indexed and |
| 9568 | # searched against by keyword searches (see |
| 9569 | # SearchJobsRequest.custom_field_filters][]). |
| 9570 | # |
| 9571 | # The map key must be a number between 1-20. If an invalid key is |
| 9572 | # provided on job create or update, an error is returned. |
| 9573 | "a_key": { # Resource that represents the custom data not captured by the standard fields. |
| 9574 | "values": [ # Optional. The values of the custom data. |
| 9575 | "A String", |
| 9576 | ], |
| 9577 | }, |
| 9578 | }, |
| 9579 | "compensationInfo": { # Job compensation details. # Optional. Job compensation information. |
| 9580 | "entries": [ # Optional. Job compensation information. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 9581 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 9582 | # At most one entry can be of type |
| 9583 | # CompensationInfo.CompensationType.BASE, which is |
| 9584 | # referred as ** base compensation entry ** for the job. |
| 9585 | { # A compensation entry that represents one component of compensation, such |
| 9586 | # as base pay, bonus, or other compensation type. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 9587 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 9588 | # Annualization: One compensation entry can be annualized if |
| 9589 | # - it contains valid amount or range. |
| 9590 | # - and its expected_units_per_year is set or can be derived. |
| 9591 | # Its annualized range is determined as (amount or range) times |
| 9592 | # expected_units_per_year. |
| 9593 | "amount": { # Represents an amount of money with its currency type. # Optional. Compensation amount. |
| 9594 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 9595 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 9596 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 9597 | # If `units` is positive, `nanos` must be positive or zero. |
| 9598 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 9599 | # If `units` is negative, `nanos` must be negative or zero. |
| 9600 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 9601 | "units": "A String", # The whole units of the amount. |
| 9602 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 9603 | }, |
| 9604 | "description": "A String", # Optional. Compensation description. For example, could |
| 9605 | # indicate equity terms or provide additional context to an estimated |
| 9606 | # bonus. |
| 9607 | "expectedUnitsPerYear": 3.14, # Optional. Expected number of units paid each year. If not specified, when |
| 9608 | # Job.employment_types is FULLTIME, a default value is inferred |
| 9609 | # based on unit. Default values: |
| 9610 | # - HOURLY: 2080 |
| 9611 | # - DAILY: 260 |
| 9612 | # - WEEKLY: 52 |
| 9613 | # - MONTHLY: 12 |
| 9614 | # - ANNUAL: 1 |
| 9615 | "range": { # Compensation range. # Optional. Compensation range. |
| 9616 | "min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set |
| 9617 | # to zero and the currency code is set to match the |
| 9618 | # currency code of max_compensation. |
| 9619 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 9620 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 9621 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 9622 | # If `units` is positive, `nanos` must be positive or zero. |
| 9623 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 9624 | # If `units` is negative, `nanos` must be negative or zero. |
| 9625 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 9626 | "units": "A String", # The whole units of the amount. |
| 9627 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 9628 | }, |
| 9629 | "max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set |
| 9630 | # to a maximal compensation value and the currency code is set to |
| 9631 | # match the currency code of |
| 9632 | # min_compensation. |
| 9633 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 9634 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 9635 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 9636 | # If `units` is positive, `nanos` must be positive or zero. |
| 9637 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 9638 | # If `units` is negative, `nanos` must be negative or zero. |
| 9639 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 9640 | "units": "A String", # The whole units of the amount. |
| 9641 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 9642 | }, |
| 9643 | }, |
| 9644 | "type": "A String", # Required. Compensation type. |
| 9645 | "unit": "A String", # Optional. Frequency of the specified amount. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 9646 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 9647 | # Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 9648 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 9649 | ], |
| 9650 | "annualizedBaseCompensationRange": { # Compensation range. # Output only. Annualized base compensation range. Computed as |
| 9651 | # base compensation entry's CompensationEntry.compensation times |
| 9652 | # CompensationEntry.expected_units_per_year. |
| 9653 | # |
| 9654 | # See CompensationEntry for explanation on compensation annualization. |
| 9655 | "min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set |
| 9656 | # to zero and the currency code is set to match the |
| 9657 | # currency code of max_compensation. |
| 9658 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 9659 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 9660 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 9661 | # If `units` is positive, `nanos` must be positive or zero. |
| 9662 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 9663 | # If `units` is negative, `nanos` must be negative or zero. |
| 9664 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 9665 | "units": "A String", # The whole units of the amount. |
| 9666 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 9667 | }, |
| 9668 | "max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set |
| 9669 | # to a maximal compensation value and the currency code is set to |
| 9670 | # match the currency code of |
| 9671 | # min_compensation. |
| 9672 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 9673 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 9674 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 9675 | # If `units` is positive, `nanos` must be positive or zero. |
| 9676 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 9677 | # If `units` is negative, `nanos` must be negative or zero. |
| 9678 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 9679 | "units": "A String", # The whole units of the amount. |
| 9680 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 9681 | }, |
| 9682 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 9683 | "amount": { # Represents an amount of money with its currency type. # Deprecated. Use entries instead. |
| 9684 | # |
| 9685 | # Optional. |
| 9686 | # |
| 9687 | # The amount of compensation or pay for the job. |
| 9688 | # As an alternative, compensation_amount_min and |
| 9689 | # compensation_amount_max may be used to define a range of |
| 9690 | # compensation. |
| 9691 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 9692 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 9693 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 9694 | # If `units` is positive, `nanos` must be positive or zero. |
| 9695 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 9696 | # If `units` is negative, `nanos` must be negative or zero. |
| 9697 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 9698 | "units": "A String", # The whole units of the amount. |
| 9699 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 9700 | }, |
| 9701 | "max": { # Represents an amount of money with its currency type. # Deprecated. Use entries instead. |
| 9702 | # |
| 9703 | # Optional. |
| 9704 | # |
| 9705 | # An upper bound on a range for compensation or pay for the job. |
| 9706 | # The currency type is specified in compensation_amount. |
| 9707 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 9708 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 9709 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 9710 | # If `units` is positive, `nanos` must be positive or zero. |
| 9711 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 9712 | # If `units` is negative, `nanos` must be negative or zero. |
| 9713 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 9714 | "units": "A String", # The whole units of the amount. |
| 9715 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 9716 | }, |
| 9717 | "type": "A String", # Deprecated. Use entries instead. |
| 9718 | # |
| 9719 | # Optional. |
| 9720 | # |
| 9721 | # Type of job compensation. |
| 9722 | "min": { # Represents an amount of money with its currency type. # Deprecated. Use entries instead. |
| 9723 | # |
| 9724 | # Optional. |
| 9725 | # |
| 9726 | # A lower bound on a range for compensation or pay for the job. |
| 9727 | # The currency type is specified in compensation_amount. |
| 9728 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 9729 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 9730 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 9731 | # If `units` is positive, `nanos` must be positive or zero. |
| 9732 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 9733 | # If `units` is negative, `nanos` must be negative or zero. |
| 9734 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 9735 | "units": "A String", # The whole units of the amount. |
| 9736 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 9737 | }, |
| 9738 | "annualizedTotalCompensationRange": { # Compensation range. # Output only. Annualized total compensation range. Computed as |
| 9739 | # all compensation entries' CompensationEntry.compensation times |
| 9740 | # CompensationEntry.expected_units_per_year. |
| 9741 | # |
| 9742 | # See CompensationEntry for explanation on compensation annualization. |
| 9743 | "min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set |
| 9744 | # to zero and the currency code is set to match the |
| 9745 | # currency code of max_compensation. |
| 9746 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 9747 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 9748 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 9749 | # If `units` is positive, `nanos` must be positive or zero. |
| 9750 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 9751 | # If `units` is negative, `nanos` must be negative or zero. |
| 9752 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 9753 | "units": "A String", # The whole units of the amount. |
| 9754 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 9755 | }, |
| 9756 | "max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set |
| 9757 | # to a maximal compensation value and the currency code is set to |
| 9758 | # match the currency code of |
| 9759 | # min_compensation. |
| 9760 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 9761 | "nanos": 42, # Number of nano (10^-9) units of the amount. |
| 9762 | # The value must be between -999,999,999 and +999,999,999 inclusive. |
| 9763 | # If `units` is positive, `nanos` must be positive or zero. |
| 9764 | # If `units` is zero, `nanos` can be positive, zero, or negative. |
| 9765 | # If `units` is negative, `nanos` must be negative or zero. |
| 9766 | # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 9767 | "units": "A String", # The whole units of the amount. |
| 9768 | # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 9769 | }, |
| 9770 | }, |
| 9771 | }, |
| 9772 | "region": "A String", # Optional. The job Region (for example, state, country) throughout which the job |
| 9773 | # is available. If this field is set, a |
| 9774 | # LocationFilter in a search query within the job region |
| 9775 | # finds this job if an exact location match is not specified. |
| 9776 | # If this field is set, setting job locations |
| 9777 | # to the same location level as this field is strongly recommended. |
| 9778 | "createTime": "A String", # Output only. The timestamp when this job was created. |
| 9779 | "incentives": "A String", # Optional. A description of bonus, commission, and other compensation |
| 9780 | # incentives associated with the job not including salary or pay. |
| 9781 | # |
| 9782 | # The maximum number of allowed characters is 10,000. |
| 9783 | "companyDisplayName": "A String", # Output only. The name of the company listing the job. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 9784 | "unindexedCustomFields": { # Deprecated. Use custom_attributes instead. |
| 9785 | # |
| 9786 | # Optional. |
| 9787 | # |
| 9788 | # A map of fields to hold non-filterable custom job attributes, similar to |
| 9789 | # filterable_custom_fields. These fields are distinct in that the data |
| 9790 | # in these fields are not indexed. Therefore, the client cannot search |
| 9791 | # against them, nor can the client use them to list jobs. |
| 9792 | # |
| 9793 | # The key of the map can be any valid string. |
| 9794 | "a_key": { # Resource that represents the custom data not captured by the standard fields. |
| 9795 | "values": [ # Optional. The values of the custom data. |
| 9796 | "A String", |
| 9797 | ], |
| 9798 | }, |
| 9799 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 9800 | "visibility": "A String", # Optional. The visibility of the job. |
| 9801 | # Defaults to JobVisibility.PRIVATE if not specified. |
| 9802 | # Currently only JobVisibility.PRIVATE is supported. |
| 9803 | "employmentTypes": [ # Optional. The employment type(s) of a job, for example, |
| 9804 | # full time or |
| 9805 | # part time. |
| 9806 | "A String", |
| 9807 | ], |
| 9808 | "benefits": [ # Optional. The benefits included with the job. |
| 9809 | "A String", |
| 9810 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 9811 | "expiryDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Deprecated. Use expire_time instead. |
| 9812 | # |
| 9813 | # Optional but strongly recommended to be provided for the best service |
| 9814 | # experience. |
| 9815 | # |
| 9816 | # The expiration date of the job in UTC time. After 12 am on this date, the |
| 9817 | # job is marked as expired, and it no longer appears in search results. |
| 9818 | # The expired job can't be deleted or listed by the DeleteJob and |
| 9819 | # ListJobs APIs, but it can be retrieved with the GetJob API or |
| 9820 | # updated with the UpdateJob API. An expired job can be updated and |
| 9821 | # opened again by using a future expiration date. It can also remain expired. |
| 9822 | # Updating an expired job to be open fails if there is another existing open |
| 9823 | # job with same requisition_id, company_name and language_code. |
| 9824 | # |
| 9825 | # The expired jobs are retained in our system for 90 days. However, the |
| 9826 | # overall expired job count cannot exceed 3 times the maximum of open jobs |
| 9827 | # count over the past week, otherwise jobs with earlier expire time are |
| 9828 | # removed first. Expired jobs are no longer accessible after they are cleaned |
| 9829 | # out. |
| 9830 | # |
| 9831 | # A valid date range is between 1970/1/1 and 2100/12/31. Invalid dates are |
| 9832 | # ignored and treated as expiry date not provided. |
| 9833 | # |
| 9834 | # If this value is not provided on job creation or is invalid, the job |
| 9835 | # posting expires after 30 days from the job's creation time. For example, if |
| 9836 | # the job was created on 2017/01/01 13:00AM UTC with an unspecified |
| 9837 | # expiration date, the job expires after 2017/01/31 13:00AM UTC. |
| 9838 | # |
| 9839 | # If this value is not provided on job update, it depends on the field masks |
| 9840 | # set by UpdateJobRequest.update_job_fields. If the field masks include |
| 9841 | # expiry_date, or the masks are empty meaning that every field is |
| 9842 | # updated, the job expires after 30 days from the job's last update time. |
| 9843 | # Otherwise the expiration date isn't updated. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 9844 | # and time zone are either specified elsewhere or are not significant. The date |
| 9845 | # is relative to the Proleptic Gregorian Calendar. This can represent: |
| 9846 | # |
| 9847 | # * A full date, with non-zero year, month and day values |
| 9848 | # * A month and day value, with a zero year, e.g. an anniversary |
| 9849 | # * A year on its own, with zero month and day values |
| 9850 | # * A year and month value, with a zero day, e.g. a credit card expiration date |
| 9851 | # |
| 9852 | # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 9853 | "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| 9854 | # a year. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 9855 | "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 9856 | # if specifying a year by itself or a year and month where the day is not |
| 9857 | # significant. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 9858 | "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| 9859 | # month and day. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 9860 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 9861 | "companyName": "A String", # Optional but one of company_name or distributor_company_id must be |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 9862 | # provided. |
| 9863 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 9864 | # The resource name of the company listing the job, such as |
| 9865 | # /companies/foo. This field takes precedence over the |
| 9866 | # distributor-assigned company identifier, distributor_company_id. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 9867 | "locations": [ # Optional but strongly recommended for the best service experience. |
| 9868 | # |
| 9869 | # Location(s) where the emploeyer is looking to hire for this job posting. |
| 9870 | # |
| 9871 | # Specifying the full street address(es) of the hiring location enables |
| 9872 | # better API results, especially job searches by commute time. |
| 9873 | # |
| 9874 | # At most 50 locations are allowed for best search performance. If a job has |
| 9875 | # more locations, it is suggested to split it into multiple jobs with unique |
| 9876 | # requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as |
| 9877 | # multiple jobs with the same requisition_id, company_name and |
| 9878 | # language_code are not allowed. If the original requisition_id must |
| 9879 | # be preserved, a custom field should be used for storage. It is also |
| 9880 | # suggested to group the locations that close to each other in the same job |
| 9881 | # for better search experience. |
| 9882 | # |
| 9883 | # The maximum number of allowed characters is 500. |
| 9884 | "A String", |
| 9885 | ], |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 9886 | "endDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Optional. The end date of the job in UTC time zone. Typically this field |
| 9887 | # is used for contracting engagements. |
| 9888 | # Dates prior to 1970/1/1 and invalid date formats are ignored. |
| 9889 | # and time zone are either specified elsewhere or are not significant. The date |
| 9890 | # is relative to the Proleptic Gregorian Calendar. This can represent: |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 9891 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 9892 | # * A full date, with non-zero year, month and day values |
| 9893 | # * A month and day value, with a zero year, e.g. an anniversary |
| 9894 | # * A year on its own, with zero month and day values |
| 9895 | # * A year and month value, with a zero day, e.g. a credit card expiration date |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 9896 | # |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 9897 | # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. |
| 9898 | "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| 9899 | # a year. |
| 9900 | "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| 9901 | # if specifying a year by itself or a year and month where the day is not |
| 9902 | # significant. |
| 9903 | "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| 9904 | # month and day. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 9905 | }, |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 9906 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 9907 | "searchTextSnippet": "A String", # Contains snippets of text from the Job.description and similar |
| 9908 | # fields that most closely match a search query's keywords, if available. |
| 9909 | # All HTML tags in the original fields are stripped when returned in this |
| 9910 | # field, and matching query keywords are enclosed in HTML bold tags. |
| 9911 | "jobTitleSnippet": "A String", # Contains snippets of text from the Job.job_title field most |
| 9912 | # closely matching a search query's keywords, if available. The matching |
| 9913 | # query keywords are enclosed in HTML bold tags. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 9914 | "commuteInfo": { # Output only. # Commute information which is generated based on specified |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 9915 | # CommutePreference. |
| 9916 | # |
| 9917 | # Commute details related to this job. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 9918 | "jobLocation": { # Output only. # Location used as the destination in the commute calculation. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 9919 | # |
| 9920 | # A resource that represents a location with full geographic |
| 9921 | # information. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 9922 | "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair. |
| 9923 | # of doubles representing degrees latitude and degrees longitude. Unless |
| 9924 | # specified otherwise, this must conform to the |
| 9925 | # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 |
| 9926 | # standard</a>. Values must be within normalized ranges. |
| 9927 | "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. |
| 9928 | "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. |
| 9929 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 9930 | "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] | 9931 | # such as postal delivery and payments addresses. Given a postal address, |
| 9932 | # a postal service can deliver items to a premises, P.O. Box, or other |
| 9933 | # delivery location. |
| 9934 | # Given a postal address, a postal service can deliver items to a premise, P.O. |
| 9935 | # Box or similar. |
| 9936 | # It is not intended to model geographical locations (roads, towns, |
| 9937 | # mountains). |
| 9938 | # |
| 9939 | # In typical usage an address would be created via user input or from importing |
| 9940 | # existing data, depending on the type of process. |
| 9941 | # |
| 9942 | # Advice on address input / editing: |
| 9943 | # - Use an i18n-ready address widget such as |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 9944 | # https://github.com/google/libaddressinput) |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 9945 | # - Users should not be presented with UI elements for input or editing of |
| 9946 | # fields outside countries where that field is used. |
| 9947 | # |
| 9948 | # For more guidance on how to use this schema, please see: |
| 9949 | # https://support.google.com/business/answer/6397478 |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 9950 | "sublocality": "A String", # Optional. Sublocality of the address. |
| 9951 | # For example, this can be neighborhoods, boroughs, districts. |
| 9952 | "recipients": [ # Optional. The recipient at the address. |
| 9953 | # This field may, under certain circumstances, contain multiline information. |
| 9954 | # For example, it might contain "care of" information. |
| 9955 | "A String", |
| 9956 | ], |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 9957 | "locality": "A String", # Optional. Generally refers to the city/town portion of the address. |
| 9958 | # Examples: US city, IT comune, UK post town. |
| 9959 | # In regions of the world where localities are not well defined or do not fit |
| 9960 | # into this structure well, leave locality empty and use address_lines. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 9961 | "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This |
| 9962 | # is never inferred and it is up to the user to ensure the value is |
| 9963 | # correct. See http://cldr.unicode.org/ and |
| 9964 | # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html |
| 9965 | # for details. Example: "CH" for Switzerland. |
| 9966 | "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if |
| 9967 | # known). This is often the UI language of the input form or is expected |
| 9968 | # to match one of the languages used in the address' country/region, or their |
| 9969 | # transliterated equivalents. |
| 9970 | # This can affect formatting in certain countries, but is not critical |
| 9971 | # to the correctness of the data and will never affect any validation or |
| 9972 | # other non-formatting related operations. |
| 9973 | # |
| 9974 | # If this value is not known, it should be omitted (rather than specifying a |
| 9975 | # possibly incorrect default). |
| 9976 | # |
| 9977 | # Examples: "zh-Hant", "ja", "ja-Latn", "en". |
| 9978 | "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require |
| 9979 | # postal codes to be present, but where they are used, they may trigger |
| 9980 | # additional validation with other parts of the address (e.g. state/zip |
| 9981 | # validation in the U.S.A.). |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 9982 | "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal |
| 9983 | # addresses of a country or region. |
| 9984 | # For example, this can be a state, a province, an oblast, or a prefecture. |
| 9985 | # Specifically, for Spain this is the province and not the autonomous |
| 9986 | # community (e.g. "Barcelona" and not "Catalonia"). |
| 9987 | # Many countries don't use an administrative area in postal addresses. E.g. |
| 9988 | # in Switzerland this should be left unpopulated. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 9989 | "addressLines": [ # Unstructured address lines describing the lower levels of an address. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 9990 | # |
| 9991 | # Because values in address_lines do not have type information and may |
| 9992 | # sometimes contain multiple values in a single field (e.g. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 9993 | # "Austin, TX"), it is important that the line order is clear. The order of |
| 9994 | # 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] | 9995 | # 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] | 9996 | # used to make it explicit (e.g. "ja" for large-to-small ordering and |
| 9997 | # "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] | 9998 | # an address can be selected based on the language. |
| 9999 | # |
| 10000 | # The minimum permitted structural representation of an address consists |
| 10001 | # of a region_code with all remaining information placed in the |
| 10002 | # address_lines. It would be possible to format such an address very |
| 10003 | # approximately without geocoding, but no semantic reasoning could be |
| 10004 | # made about any of the address components until it was at least |
| 10005 | # partially resolved. |
| 10006 | # |
| 10007 | # Creating an address only containing a region_code and address_lines, and |
| 10008 | # then geocoding is the recommended way to handle completely unstructured |
| 10009 | # addresses (as opposed to guessing which parts of the address should be |
| 10010 | # localities or administrative areas). |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 10011 | "A String", |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 10012 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 10013 | "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used |
| 10014 | # in most regions. Where it is used, the value is either a string like |
| 10015 | # "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number |
| 10016 | # alone, representing the "sector code" (Jamaica), "delivery area indicator" |
| 10017 | # (Malawi) or "post office indicator" (e.g. Côte d'Ivoire). |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 10018 | "organization": "A String", # Optional. The name of the organization at the address. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 10019 | "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 10020 | # the latest revision. |
| 10021 | # |
| 10022 | # All new revisions **must** be backward compatible with old revisions. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 10023 | }, |
| 10024 | "locationType": "A String", # The type of a location, which corresponds to the address lines field of |
| 10025 | # PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of |
| 10026 | # LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of |
| 10027 | # LocationType#LOCALITY. |
| 10028 | "radiusMeters": 3.14, # Radius in meters of the job location. This value is derived from the |
| 10029 | # location bounding box in which a circle with the specified radius |
| 10030 | # centered from LatLng coves the area associated with the job location. |
| 10031 | # For example, currently, "Mountain View, CA, USA" has a radius of |
| 10032 | # 7885.79 meters. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 10033 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 10034 | "travelDuration": "A String", # The number of seconds required to travel to the job location from the query |
| 10035 | # location. A duration of 0 seconds indicates that the job is not |
| 10036 | # reachable within the requested duration, but was returned as part of an |
| 10037 | # expanded query. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 10038 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 10039 | "jobSummary": "A String", # A summary of the job with core information that's displayed on the search |
| 10040 | # results listing page. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 10041 | }, |
| 10042 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 10043 | "nextPageToken": "A String", # The token that specifies the starting position of the next page of results. |
| 10044 | # This field is empty if there are no more results. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 10045 | "estimatedTotalSize": "A String", # An estimation of the number of jobs that match the specified query. |
| 10046 | # |
| 10047 | # This number is not guaranteed to be accurate. For accurate results, |
| 10048 | # seenenable_precise_result_size. |
| 10049 | "totalSize": "A String", # The precise result count, which is available only if the client set |
| 10050 | # enable_precise_result_size to `true` or if the response |
| 10051 | # is the last page of results. Otherwise, the value will be `-1`. |
| 10052 | "histogramResults": { # Output only. # The histogram results that match specified |
| 10053 | # SearchJobsRequest.HistogramFacets. |
| 10054 | # |
| 10055 | # Histogram results that matches HistogramFacets specified in |
| 10056 | # SearchJobsRequest. |
| 10057 | "simpleHistogramResults": [ # Specifies histogram results that matches |
| 10058 | # HistogramFacets.simple_histogram_facets. |
| 10059 | { # Output only. |
| 10060 | # |
| 10061 | # Result of a histogram call. The response contains the histogram map for the |
| 10062 | # search type specified by HistogramResult.field. |
| 10063 | # The response is a map of each filter value to the corresponding count of |
| 10064 | # jobs for that filter. |
| 10065 | "values": { # A map from the values of field to the number of jobs with that value |
| 10066 | # in this search result. |
| 10067 | # |
| 10068 | # Key: search type (filter names, such as the companyName). |
| 10069 | # |
| 10070 | # Values: the count of jobs that match the filter for this search. |
| 10071 | "a_key": 42, |
| 10072 | }, |
| 10073 | "searchType": "A String", # The Histogram search filters. |
| 10074 | }, |
| 10075 | ], |
| 10076 | "compensationHistogramResults": [ # Specifies compensation field-based histogram results that matches |
| 10077 | # HistogramFacets.compensation_histogram_requests. |
| 10078 | { # Output only. |
| 10079 | # |
| 10080 | # Compensation based histogram result. |
| 10081 | "type": "A String", # Type of the request, corresponding to |
| 10082 | # CompensationHistogramRequest.type. |
| 10083 | "result": { # Output only. # Histogram result. |
| 10084 | # |
| 10085 | # Custom numeric bucketing result. |
| 10086 | "maxValue": 3.14, # Stores the maximum value of the numeric field. Will be populated only if |
| 10087 | # [NumericBucketingOption.requires_min_max] is set to true. |
| 10088 | "minValue": 3.14, # Stores the minimum value of the numeric field. Will be populated only if |
| 10089 | # [NumericBucketingOption.requires_min_max] is set to true. |
| 10090 | "counts": [ # Count within each bucket. Its size is the length of |
| 10091 | # NumericBucketingOption.bucket_bounds plus 1. |
| 10092 | { # Represents count of jobs within one bucket. |
| 10093 | "count": 42, # Number of jobs whose numeric field value fall into `range`. |
| 10094 | "range": { # Represents starting and ending value of a range in double. # Bucket range on which histogram was performed for the numeric field, |
| 10095 | # that is, the count represents number of jobs in this range. |
| 10096 | "to": 3.14, # Ending value of the bucket range. |
| 10097 | "from": 3.14, # Starting value of the bucket range. |
| 10098 | }, |
| 10099 | }, |
| 10100 | ], |
| 10101 | }, |
| 10102 | }, |
| 10103 | ], |
| 10104 | "customAttributeHistogramResults": [ # Specifies histogram results for custom attributes that |
| 10105 | # matches HistogramFacets.custom_attribute_histogram_facets. |
| 10106 | { # Output only. |
| 10107 | # |
| 10108 | # Custom attribute histogram result. |
| 10109 | "key": "A String", # Stores the key of custom attribute the histogram is performed on. |
| 10110 | "longValueHistogramResult": { # Output only. # Stores bucketed histogram counting result or min/max values for |
| 10111 | # custom attribute long values associated with `key`. |
| 10112 | # |
| 10113 | # Custom numeric bucketing result. |
| 10114 | "maxValue": 3.14, # Stores the maximum value of the numeric field. Will be populated only if |
| 10115 | # [NumericBucketingOption.requires_min_max] is set to true. |
| 10116 | "minValue": 3.14, # Stores the minimum value of the numeric field. Will be populated only if |
| 10117 | # [NumericBucketingOption.requires_min_max] is set to true. |
| 10118 | "counts": [ # Count within each bucket. Its size is the length of |
| 10119 | # NumericBucketingOption.bucket_bounds plus 1. |
| 10120 | { # Represents count of jobs within one bucket. |
| 10121 | "count": 42, # Number of jobs whose numeric field value fall into `range`. |
| 10122 | "range": { # Represents starting and ending value of a range in double. # Bucket range on which histogram was performed for the numeric field, |
| 10123 | # that is, the count represents number of jobs in this range. |
| 10124 | "to": 3.14, # Ending value of the bucket range. |
| 10125 | "from": 3.14, # Starting value of the bucket range. |
| 10126 | }, |
| 10127 | }, |
| 10128 | ], |
| 10129 | }, |
| 10130 | "stringValueHistogramResult": { # Stores a map from the values of string custom field associated |
| 10131 | # with `key` to the number of jobs with that value in this histogram result. |
| 10132 | "a_key": 42, |
| 10133 | }, |
| 10134 | }, |
| 10135 | ], |
| 10136 | }, |
| 10137 | "jobView": "A String", # Corresponds to SearchJobsRequest.job_view. |
| 10138 | "spellResult": { # Output only. # The spell checking result, and correction. |
| 10139 | # |
| 10140 | # Spell check result. |
| 10141 | "correctedText": "A String", # Correction output consisting of the corrected keyword string. |
| 10142 | "corrected": True or False, # Indicates if the query was corrected by the spell checker. |
| 10143 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 10144 | "appliedJobLocationFilters": [ # 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] | 10145 | # any filters are lat-lng based, the JobLocation.location_type is |
| 10146 | # JobLocation.LocationType#LOCATION_TYPE_UNSPECIFIED. |
| 10147 | { # Output only. |
| 10148 | # |
| 10149 | # A resource that represents a location with full geographic |
| 10150 | # information. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 10151 | "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair. |
| 10152 | # of doubles representing degrees latitude and degrees longitude. Unless |
| 10153 | # specified otherwise, this must conform to the |
| 10154 | # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 |
| 10155 | # standard</a>. Values must be within normalized ranges. |
| 10156 | "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. |
| 10157 | "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. |
| 10158 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 10159 | "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] | 10160 | # such as postal delivery and payments addresses. Given a postal address, |
| 10161 | # a postal service can deliver items to a premises, P.O. Box, or other |
| 10162 | # delivery location. |
| 10163 | # Given a postal address, a postal service can deliver items to a premise, P.O. |
| 10164 | # Box or similar. |
| 10165 | # It is not intended to model geographical locations (roads, towns, |
| 10166 | # mountains). |
| 10167 | # |
| 10168 | # In typical usage an address would be created via user input or from importing |
| 10169 | # existing data, depending on the type of process. |
| 10170 | # |
| 10171 | # Advice on address input / editing: |
| 10172 | # - Use an i18n-ready address widget such as |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 10173 | # https://github.com/google/libaddressinput) |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 10174 | # - Users should not be presented with UI elements for input or editing of |
| 10175 | # fields outside countries where that field is used. |
| 10176 | # |
| 10177 | # For more guidance on how to use this schema, please see: |
| 10178 | # https://support.google.com/business/answer/6397478 |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 10179 | "sublocality": "A String", # Optional. Sublocality of the address. |
| 10180 | # For example, this can be neighborhoods, boroughs, districts. |
| 10181 | "recipients": [ # Optional. The recipient at the address. |
| 10182 | # This field may, under certain circumstances, contain multiline information. |
| 10183 | # For example, it might contain "care of" information. |
| 10184 | "A String", |
| 10185 | ], |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 10186 | "locality": "A String", # Optional. Generally refers to the city/town portion of the address. |
| 10187 | # Examples: US city, IT comune, UK post town. |
| 10188 | # In regions of the world where localities are not well defined or do not fit |
| 10189 | # into this structure well, leave locality empty and use address_lines. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 10190 | "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This |
| 10191 | # is never inferred and it is up to the user to ensure the value is |
| 10192 | # correct. See http://cldr.unicode.org/ and |
| 10193 | # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html |
| 10194 | # for details. Example: "CH" for Switzerland. |
| 10195 | "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if |
| 10196 | # known). This is often the UI language of the input form or is expected |
| 10197 | # to match one of the languages used in the address' country/region, or their |
| 10198 | # transliterated equivalents. |
| 10199 | # This can affect formatting in certain countries, but is not critical |
| 10200 | # to the correctness of the data and will never affect any validation or |
| 10201 | # other non-formatting related operations. |
| 10202 | # |
| 10203 | # If this value is not known, it should be omitted (rather than specifying a |
| 10204 | # possibly incorrect default). |
| 10205 | # |
| 10206 | # Examples: "zh-Hant", "ja", "ja-Latn", "en". |
| 10207 | "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require |
| 10208 | # postal codes to be present, but where they are used, they may trigger |
| 10209 | # additional validation with other parts of the address (e.g. state/zip |
| 10210 | # validation in the U.S.A.). |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 10211 | "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal |
| 10212 | # addresses of a country or region. |
| 10213 | # For example, this can be a state, a province, an oblast, or a prefecture. |
| 10214 | # Specifically, for Spain this is the province and not the autonomous |
| 10215 | # community (e.g. "Barcelona" and not "Catalonia"). |
| 10216 | # Many countries don't use an administrative area in postal addresses. E.g. |
| 10217 | # in Switzerland this should be left unpopulated. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 10218 | "addressLines": [ # Unstructured address lines describing the lower levels of an address. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 10219 | # |
| 10220 | # Because values in address_lines do not have type information and may |
| 10221 | # sometimes contain multiple values in a single field (e.g. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 10222 | # "Austin, TX"), it is important that the line order is clear. The order of |
| 10223 | # 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] | 10224 | # 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] | 10225 | # used to make it explicit (e.g. "ja" for large-to-small ordering and |
| 10226 | # "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] | 10227 | # an address can be selected based on the language. |
| 10228 | # |
| 10229 | # The minimum permitted structural representation of an address consists |
| 10230 | # of a region_code with all remaining information placed in the |
| 10231 | # address_lines. It would be possible to format such an address very |
| 10232 | # approximately without geocoding, but no semantic reasoning could be |
| 10233 | # made about any of the address components until it was at least |
| 10234 | # partially resolved. |
| 10235 | # |
| 10236 | # Creating an address only containing a region_code and address_lines, and |
| 10237 | # then geocoding is the recommended way to handle completely unstructured |
| 10238 | # addresses (as opposed to guessing which parts of the address should be |
| 10239 | # localities or administrative areas). |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 10240 | "A String", |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 10241 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 10242 | "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used |
| 10243 | # in most regions. Where it is used, the value is either a string like |
| 10244 | # "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number |
| 10245 | # alone, representing the "sector code" (Jamaica), "delivery area indicator" |
| 10246 | # (Malawi) or "post office indicator" (e.g. Côte d'Ivoire). |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 10247 | "organization": "A String", # Optional. The name of the organization at the address. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 10248 | "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 10249 | # the latest revision. |
| 10250 | # |
| 10251 | # All new revisions **must** be backward compatible with old revisions. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 10252 | }, |
| 10253 | "locationType": "A String", # The type of a location, which corresponds to the address lines field of |
| 10254 | # PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of |
| 10255 | # LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of |
| 10256 | # LocationType#LOCALITY. |
| 10257 | "radiusMeters": 3.14, # Radius in meters of the job location. This value is derived from the |
| 10258 | # location bounding box in which a circle with the specified radius |
| 10259 | # centered from LatLng coves the area associated with the job location. |
| 10260 | # For example, currently, "Mountain View, CA, USA" has a radius of |
| 10261 | # 7885.79 meters. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 10262 | }, |
| 10263 | ], |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 10264 | }</pre> |
| 10265 | </div> |
| 10266 | |
| 10267 | <div class="method"> |
| 10268 | <code class="details" id="searchForAlert_next">searchForAlert_next(previous_request, previous_response)</code> |
| 10269 | <pre>Retrieves the next page of results. |
| 10270 | |
| 10271 | Args: |
| 10272 | previous_request: The request for the previous page. (required) |
| 10273 | previous_response: The response from the request for the previous page. (required) |
| 10274 | |
| 10275 | Returns: |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 10276 | 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] | 10277 | page. Returns None if there are no more items in the collection. |
| 10278 | </pre> |
| 10279 | </div> |
| 10280 | |
| 10281 | <div class="method"> |
| 10282 | <code class="details" id="search_next">search_next(previous_request, previous_response)</code> |
| 10283 | <pre>Retrieves the next page of results. |
| 10284 | |
| 10285 | Args: |
| 10286 | previous_request: The request for the previous page. (required) |
| 10287 | previous_response: The response from the request for the previous page. (required) |
| 10288 | |
| 10289 | Returns: |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 10290 | 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] | 10291 | page. Returns None if there are no more items in the collection. |
| 10292 | </pre> |
| 10293 | </div> |
| 10294 | |
| 10295 | </body></html> |