| 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_v3p1beta1.html">Cloud Talent Solution API</a> . <a href="jobs_v3p1beta1.projects.html">projects</a> . <a href="jobs_v3p1beta1.projects.companies.html">companies</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 78 | <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 79 | <p class="firstline">Creates a new company entity.</p> |
| 80 | <p class="toc_element"> |
| 81 | <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> |
| 82 | <p class="firstline">Deletes specified company.</p> |
| 83 | <p class="toc_element"> |
| 84 | <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| 85 | <p class="firstline">Retrieves specified company.</p> |
| 86 | <p class="toc_element"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 87 | <code><a href="#list">list(parent, pageToken=None, pageSize=None, requireOpenJobs=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 88 | <p class="firstline">Lists all companies associated with the service account.</p> |
| 89 | <p class="toc_element"> |
| 90 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 91 | <p class="firstline">Retrieves the next page of results.</p> |
| 92 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 93 | <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] | 94 | <p class="firstline">Updates specified company. Company names can't be updated. To update a</p> |
| 95 | <h3>Method Details</h3> |
| 96 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 97 | <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 98 | <pre>Creates a new company entity. |
| 99 | |
| 100 | Args: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 101 | parent: string, Required. Resource name of the project under which the company is created. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 102 | |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 103 | The format is "projects/{project_id}", for example, |
| 104 | "projects/api-test-project". (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 105 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 106 | The object takes the form of: |
| 107 | |
| 108 | { # Input only. |
| 109 | # |
| 110 | # The Request of the CreateCompany method. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 111 | "company": { # A Company resource represents a company in the service. A company is the # Required. The company to be created. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 112 | # entity that owns job postings, that is, the hiring entity responsible for |
| 113 | # employing applicants for the job position. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 114 | "keywordSearchableJobCustomAttributes": [ # Optional. A list of keys of filterable Job.custom_attributes, whose |
| 115 | # corresponding `string_values` are used in keyword search. Jobs with |
| 116 | # `string_values` under these specified field keys are returned if any |
| 117 | # of the values matches the search keyword. Custom field values with |
| 118 | # parenthesis, brackets and special symbols won't be properly searchable, |
| 119 | # and those keyword queries need to be surrounded by quotes. |
| 120 | "A String", |
| 121 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 122 | "size": "A String", # Optional. The employer's company size. |
| 123 | "websiteUri": "A String", # Optional. The URI representing the company's primary web site or home page, |
| 124 | # for example, "https://www.google.com". |
| 125 | # |
| 126 | # The maximum number of allowed characters is 255. |
| 127 | "imageUri": "A String", # Optional. A URI that hosts the employer's company logo. |
| 128 | "suspended": True or False, # Output only. Indicates whether a company is flagged to be suspended from |
| 129 | # public availability by the service when job content appears suspicious, |
| 130 | # abusive, or spammy. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 131 | "derivedInfo": { # Derived details about the company. # Output only. Derived details about the company. |
| 132 | "headquartersLocation": { # Output only. # A structured headquarters location of the company, resolved from |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 133 | # Company.hq_location if provided. |
| 134 | # |
| 135 | # A resource that represents a location with full geographic information. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 136 | "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] | 137 | # such as postal delivery and payments addresses. Given a postal address, |
| 138 | # a postal service can deliver items to a premises, P.O. Box, or other |
| 139 | # delivery location. |
| 140 | # Given a postal address, a postal service can deliver items to a premise, P.O. |
| 141 | # Box or similar. |
| 142 | # It is not intended to model geographical locations (roads, towns, |
| 143 | # mountains). |
| 144 | # |
| 145 | # In typical usage an address would be created via user input or from importing |
| 146 | # existing data, depending on the type of process. |
| 147 | # |
| 148 | # Advice on address input / editing: |
| 149 | # - Use an i18n-ready address widget such as |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 150 | # https://github.com/google/libaddressinput) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 151 | # - Users should not be presented with UI elements for input or editing of |
| 152 | # fields outside countries where that field is used. |
| 153 | # |
| 154 | # For more guidance on how to use this schema, please see: |
| 155 | # https://support.google.com/business/answer/6397478 |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 156 | "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require |
| 157 | # postal codes to be present, but where they are used, they may trigger |
| 158 | # additional validation with other parts of the address (e.g. state/zip |
| 159 | # validation in the U.S.A.). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 160 | "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This |
| 161 | # is never inferred and it is up to the user to ensure the value is |
| 162 | # correct. See http://cldr.unicode.org/ and |
| 163 | # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html |
| 164 | # for details. Example: "CH" for Switzerland. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 165 | "organization": "A String", # Optional. The name of the organization at the address. |
| 166 | "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is |
| 167 | # the latest revision. |
| 168 | # |
| 169 | # All new revisions **must** be backward compatible with old revisions. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 170 | "addressLines": [ # Unstructured address lines describing the lower levels of an address. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 171 | # |
| 172 | # Because values in address_lines do not have type information and may |
| 173 | # sometimes contain multiple values in a single field (e.g. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 174 | # "Austin, TX"), it is important that the line order is clear. The order of |
| 175 | # 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] | 176 | # 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] | 177 | # used to make it explicit (e.g. "ja" for large-to-small ordering and |
| 178 | # "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] | 179 | # an address can be selected based on the language. |
| 180 | # |
| 181 | # The minimum permitted structural representation of an address consists |
| 182 | # of a region_code with all remaining information placed in the |
| 183 | # address_lines. It would be possible to format such an address very |
| 184 | # approximately without geocoding, but no semantic reasoning could be |
| 185 | # made about any of the address components until it was at least |
| 186 | # partially resolved. |
| 187 | # |
| 188 | # Creating an address only containing a region_code and address_lines, and |
| 189 | # then geocoding is the recommended way to handle completely unstructured |
| 190 | # addresses (as opposed to guessing which parts of the address should be |
| 191 | # localities or administrative areas). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 192 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 193 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 194 | "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal |
| 195 | # addresses of a country or region. |
| 196 | # For example, this can be a state, a province, an oblast, or a prefecture. |
| 197 | # Specifically, for Spain this is the province and not the autonomous |
| 198 | # community (e.g. "Barcelona" and not "Catalonia"). |
| 199 | # Many countries don't use an administrative area in postal addresses. E.g. |
| 200 | # in Switzerland this should be left unpopulated. |
| 201 | "recipients": [ # Optional. The recipient at the address. |
| 202 | # This field may, under certain circumstances, contain multiline information. |
| 203 | # For example, it might contain "care of" information. |
| 204 | "A String", |
| 205 | ], |
| 206 | "locality": "A String", # Optional. Generally refers to the city/town portion of the address. |
| 207 | # Examples: US city, IT comune, UK post town. |
| 208 | # In regions of the world where localities are not well defined or do not fit |
| 209 | # into this structure well, leave locality empty and use address_lines. |
| 210 | "sublocality": "A String", # Optional. Sublocality of the address. |
| 211 | # For example, this can be neighborhoods, boroughs, districts. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 212 | "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if |
| 213 | # known). This is often the UI language of the input form or is expected |
| 214 | # to match one of the languages used in the address' country/region, or their |
| 215 | # transliterated equivalents. |
| 216 | # This can affect formatting in certain countries, but is not critical |
| 217 | # to the correctness of the data and will never affect any validation or |
| 218 | # other non-formatting related operations. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 219 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 220 | # If this value is not known, it should be omitted (rather than specifying a |
| 221 | # possibly incorrect default). |
| 222 | # |
| 223 | # Examples: "zh-Hant", "ja", "ja-Latn", "en". |
| 224 | "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used |
| 225 | # in most regions. Where it is used, the value is either a string like |
| 226 | # "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number |
| 227 | # alone, representing the "sector code" (Jamaica), "delivery area indicator" |
| 228 | # (Malawi) or "post office indicator" (e.g. Côte d'Ivoire). |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 229 | }, |
| 230 | "radiusInMiles": 3.14, # Radius in miles of the job location. This value is derived from the |
| 231 | # location bounding box in which a circle with the specified radius |
| 232 | # centered from LatLng covers the area associated with the job location. |
| 233 | # For example, currently, "Mountain View, CA, USA" has a radius of |
| 234 | # 6.17 miles. |
| 235 | "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair. |
| 236 | # of doubles representing degrees latitude and degrees longitude. Unless |
| 237 | # specified otherwise, this must conform to the |
| 238 | # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 |
| 239 | # standard</a>. Values must be within normalized ranges. |
| 240 | "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. |
| 241 | "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 242 | }, |
| 243 | "locationType": "A String", # The type of a location, which corresponds to the address lines field of |
| 244 | # PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of |
| 245 | # LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of |
| 246 | # LocationType#LOCALITY. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 247 | }, |
| 248 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 249 | "displayName": "A String", # Required. The display name of the company, for example, "Google LLC". |
| 250 | "externalId": "A String", # Required. Client side company identifier, used to uniquely identify the |
| 251 | # company. |
| 252 | # |
| 253 | # The maximum number of allowed characters is 255. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 254 | "eeoText": "A String", # Optional. Equal Employment Opportunity legal disclaimer text to be |
| 255 | # associated with all jobs, and typically to be displayed in all |
| 256 | # roles. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 257 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 258 | # The maximum number of allowed characters is 500. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 259 | "careerSiteUri": "A String", # Optional. The URI to employer's career site or careers page on the employer's web |
| 260 | # site, for example, "https://careers.google.com". |
| 261 | "hiringAgency": True or False, # Optional. Set to true if it is the hiring agency that post jobs for other |
| 262 | # employers. |
| 263 | # |
| 264 | # Defaults to false if not provided. |
| 265 | "headquartersAddress": "A String", # Optional. The street address of the company's main headquarters, which may be |
| 266 | # different from the job location. The service attempts |
| 267 | # to geolocate the provided address, and populates a more specific |
| 268 | # location wherever possible in DerivedInfo.headquarters_location. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 269 | "name": "A String", # Required during company update. |
| 270 | # |
| 271 | # The resource name for a company. This is generated by the service when a |
| 272 | # company is created. |
| 273 | # |
| 274 | # The format is "projects/{project_id}/companies/{company_id}", for example, |
| 275 | # "projects/api-test-project/companies/foo". |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 276 | }, |
| 277 | } |
| 278 | |
| 279 | x__xgafv: string, V1 error format. |
| 280 | Allowed values |
| 281 | 1 - v1 error format |
| 282 | 2 - v2 error format |
| 283 | |
| 284 | Returns: |
| 285 | An object of the form: |
| 286 | |
| 287 | { # A Company resource represents a company in the service. A company is the |
| 288 | # entity that owns job postings, that is, the hiring entity responsible for |
| 289 | # employing applicants for the job position. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 290 | "keywordSearchableJobCustomAttributes": [ # Optional. A list of keys of filterable Job.custom_attributes, whose |
| 291 | # corresponding `string_values` are used in keyword search. Jobs with |
| 292 | # `string_values` under these specified field keys are returned if any |
| 293 | # of the values matches the search keyword. Custom field values with |
| 294 | # parenthesis, brackets and special symbols won't be properly searchable, |
| 295 | # and those keyword queries need to be surrounded by quotes. |
| 296 | "A String", |
| 297 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 298 | "size": "A String", # Optional. The employer's company size. |
| 299 | "websiteUri": "A String", # Optional. The URI representing the company's primary web site or home page, |
| 300 | # for example, "https://www.google.com". |
| 301 | # |
| 302 | # The maximum number of allowed characters is 255. |
| 303 | "imageUri": "A String", # Optional. A URI that hosts the employer's company logo. |
| 304 | "suspended": True or False, # Output only. Indicates whether a company is flagged to be suspended from |
| 305 | # public availability by the service when job content appears suspicious, |
| 306 | # abusive, or spammy. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 307 | "derivedInfo": { # Derived details about the company. # Output only. Derived details about the company. |
| 308 | "headquartersLocation": { # Output only. # A structured headquarters location of the company, resolved from |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 309 | # Company.hq_location if provided. |
| 310 | # |
| 311 | # A resource that represents a location with full geographic information. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 312 | "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] | 313 | # such as postal delivery and payments addresses. Given a postal address, |
| 314 | # a postal service can deliver items to a premises, P.O. Box, or other |
| 315 | # delivery location. |
| 316 | # Given a postal address, a postal service can deliver items to a premise, P.O. |
| 317 | # Box or similar. |
| 318 | # It is not intended to model geographical locations (roads, towns, |
| 319 | # mountains). |
| 320 | # |
| 321 | # In typical usage an address would be created via user input or from importing |
| 322 | # existing data, depending on the type of process. |
| 323 | # |
| 324 | # Advice on address input / editing: |
| 325 | # - Use an i18n-ready address widget such as |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 326 | # https://github.com/google/libaddressinput) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 327 | # - Users should not be presented with UI elements for input or editing of |
| 328 | # fields outside countries where that field is used. |
| 329 | # |
| 330 | # For more guidance on how to use this schema, please see: |
| 331 | # https://support.google.com/business/answer/6397478 |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 332 | "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require |
| 333 | # postal codes to be present, but where they are used, they may trigger |
| 334 | # additional validation with other parts of the address (e.g. state/zip |
| 335 | # validation in the U.S.A.). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 336 | "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This |
| 337 | # is never inferred and it is up to the user to ensure the value is |
| 338 | # correct. See http://cldr.unicode.org/ and |
| 339 | # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html |
| 340 | # for details. Example: "CH" for Switzerland. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 341 | "organization": "A String", # Optional. The name of the organization at the address. |
| 342 | "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is |
| 343 | # the latest revision. |
| 344 | # |
| 345 | # All new revisions **must** be backward compatible with old revisions. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 346 | "addressLines": [ # Unstructured address lines describing the lower levels of an address. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 347 | # |
| 348 | # Because values in address_lines do not have type information and may |
| 349 | # sometimes contain multiple values in a single field (e.g. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 350 | # "Austin, TX"), it is important that the line order is clear. The order of |
| 351 | # 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] | 352 | # 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] | 353 | # used to make it explicit (e.g. "ja" for large-to-small ordering and |
| 354 | # "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] | 355 | # an address can be selected based on the language. |
| 356 | # |
| 357 | # The minimum permitted structural representation of an address consists |
| 358 | # of a region_code with all remaining information placed in the |
| 359 | # address_lines. It would be possible to format such an address very |
| 360 | # approximately without geocoding, but no semantic reasoning could be |
| 361 | # made about any of the address components until it was at least |
| 362 | # partially resolved. |
| 363 | # |
| 364 | # Creating an address only containing a region_code and address_lines, and |
| 365 | # then geocoding is the recommended way to handle completely unstructured |
| 366 | # addresses (as opposed to guessing which parts of the address should be |
| 367 | # localities or administrative areas). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 368 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 369 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 370 | "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal |
| 371 | # addresses of a country or region. |
| 372 | # For example, this can be a state, a province, an oblast, or a prefecture. |
| 373 | # Specifically, for Spain this is the province and not the autonomous |
| 374 | # community (e.g. "Barcelona" and not "Catalonia"). |
| 375 | # Many countries don't use an administrative area in postal addresses. E.g. |
| 376 | # in Switzerland this should be left unpopulated. |
| 377 | "recipients": [ # Optional. The recipient at the address. |
| 378 | # This field may, under certain circumstances, contain multiline information. |
| 379 | # For example, it might contain "care of" information. |
| 380 | "A String", |
| 381 | ], |
| 382 | "locality": "A String", # Optional. Generally refers to the city/town portion of the address. |
| 383 | # Examples: US city, IT comune, UK post town. |
| 384 | # In regions of the world where localities are not well defined or do not fit |
| 385 | # into this structure well, leave locality empty and use address_lines. |
| 386 | "sublocality": "A String", # Optional. Sublocality of the address. |
| 387 | # For example, this can be neighborhoods, boroughs, districts. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 388 | "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if |
| 389 | # known). This is often the UI language of the input form or is expected |
| 390 | # to match one of the languages used in the address' country/region, or their |
| 391 | # transliterated equivalents. |
| 392 | # This can affect formatting in certain countries, but is not critical |
| 393 | # to the correctness of the data and will never affect any validation or |
| 394 | # other non-formatting related operations. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 395 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 396 | # If this value is not known, it should be omitted (rather than specifying a |
| 397 | # possibly incorrect default). |
| 398 | # |
| 399 | # Examples: "zh-Hant", "ja", "ja-Latn", "en". |
| 400 | "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used |
| 401 | # in most regions. Where it is used, the value is either a string like |
| 402 | # "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number |
| 403 | # alone, representing the "sector code" (Jamaica), "delivery area indicator" |
| 404 | # (Malawi) or "post office indicator" (e.g. Côte d'Ivoire). |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 405 | }, |
| 406 | "radiusInMiles": 3.14, # Radius in miles of the job location. This value is derived from the |
| 407 | # location bounding box in which a circle with the specified radius |
| 408 | # centered from LatLng covers the area associated with the job location. |
| 409 | # For example, currently, "Mountain View, CA, USA" has a radius of |
| 410 | # 6.17 miles. |
| 411 | "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair. |
| 412 | # of doubles representing degrees latitude and degrees longitude. Unless |
| 413 | # specified otherwise, this must conform to the |
| 414 | # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 |
| 415 | # standard</a>. Values must be within normalized ranges. |
| 416 | "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. |
| 417 | "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 418 | }, |
| 419 | "locationType": "A String", # The type of a location, which corresponds to the address lines field of |
| 420 | # PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of |
| 421 | # LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of |
| 422 | # LocationType#LOCALITY. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 423 | }, |
| 424 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 425 | "displayName": "A String", # Required. The display name of the company, for example, "Google LLC". |
| 426 | "externalId": "A String", # Required. Client side company identifier, used to uniquely identify the |
| 427 | # company. |
| 428 | # |
| 429 | # The maximum number of allowed characters is 255. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 430 | "eeoText": "A String", # Optional. Equal Employment Opportunity legal disclaimer text to be |
| 431 | # associated with all jobs, and typically to be displayed in all |
| 432 | # roles. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 433 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 434 | # The maximum number of allowed characters is 500. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 435 | "careerSiteUri": "A String", # Optional. The URI to employer's career site or careers page on the employer's web |
| 436 | # site, for example, "https://careers.google.com". |
| 437 | "hiringAgency": True or False, # Optional. Set to true if it is the hiring agency that post jobs for other |
| 438 | # employers. |
| 439 | # |
| 440 | # Defaults to false if not provided. |
| 441 | "headquartersAddress": "A String", # Optional. The street address of the company's main headquarters, which may be |
| 442 | # different from the job location. The service attempts |
| 443 | # to geolocate the provided address, and populates a more specific |
| 444 | # location wherever possible in DerivedInfo.headquarters_location. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 445 | "name": "A String", # Required during company update. |
| 446 | # |
| 447 | # The resource name for a company. This is generated by the service when a |
| 448 | # company is created. |
| 449 | # |
| 450 | # The format is "projects/{project_id}/companies/{company_id}", for example, |
| 451 | # "projects/api-test-project/companies/foo". |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 452 | }</pre> |
| 453 | </div> |
| 454 | |
| 455 | <div class="method"> |
| 456 | <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| 457 | <pre>Deletes specified company. |
| 458 | Prerequisite: The company has no jobs associated with it. |
| 459 | |
| 460 | Args: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 461 | name: string, Required. The resource name of the company to be deleted. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 462 | |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 463 | The format is "projects/{project_id}/companies/{company_id}", for example, |
| 464 | "projects/api-test-project/companies/foo". (required) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 465 | x__xgafv: string, V1 error format. |
| 466 | Allowed values |
| 467 | 1 - v1 error format |
| 468 | 2 - v2 error format |
| 469 | |
| 470 | Returns: |
| 471 | An object of the form: |
| 472 | |
| 473 | { # A generic empty message that you can re-use to avoid defining duplicated |
| 474 | # empty messages in your APIs. A typical example is to use it as the request |
| 475 | # or the response type of an API method. For instance: |
| 476 | # |
| 477 | # service Foo { |
| 478 | # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); |
| 479 | # } |
| 480 | # |
| 481 | # The JSON representation for `Empty` is empty JSON object `{}`. |
| 482 | }</pre> |
| 483 | </div> |
| 484 | |
| 485 | <div class="method"> |
| 486 | <code class="details" id="get">get(name, x__xgafv=None)</code> |
| 487 | <pre>Retrieves specified company. |
| 488 | |
| 489 | Args: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 490 | name: string, Required. The resource name of the company to be retrieved. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 491 | |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 492 | The format is "projects/{project_id}/companies/{company_id}", for example, |
| 493 | "projects/api-test-project/companies/foo". (required) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 494 | x__xgafv: string, V1 error format. |
| 495 | Allowed values |
| 496 | 1 - v1 error format |
| 497 | 2 - v2 error format |
| 498 | |
| 499 | Returns: |
| 500 | An object of the form: |
| 501 | |
| 502 | { # A Company resource represents a company in the service. A company is the |
| 503 | # entity that owns job postings, that is, the hiring entity responsible for |
| 504 | # employing applicants for the job position. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 505 | "keywordSearchableJobCustomAttributes": [ # Optional. A list of keys of filterable Job.custom_attributes, whose |
| 506 | # corresponding `string_values` are used in keyword search. Jobs with |
| 507 | # `string_values` under these specified field keys are returned if any |
| 508 | # of the values matches the search keyword. Custom field values with |
| 509 | # parenthesis, brackets and special symbols won't be properly searchable, |
| 510 | # and those keyword queries need to be surrounded by quotes. |
| 511 | "A String", |
| 512 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 513 | "size": "A String", # Optional. The employer's company size. |
| 514 | "websiteUri": "A String", # Optional. The URI representing the company's primary web site or home page, |
| 515 | # for example, "https://www.google.com". |
| 516 | # |
| 517 | # The maximum number of allowed characters is 255. |
| 518 | "imageUri": "A String", # Optional. A URI that hosts the employer's company logo. |
| 519 | "suspended": True or False, # Output only. Indicates whether a company is flagged to be suspended from |
| 520 | # public availability by the service when job content appears suspicious, |
| 521 | # abusive, or spammy. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 522 | "derivedInfo": { # Derived details about the company. # Output only. Derived details about the company. |
| 523 | "headquartersLocation": { # Output only. # A structured headquarters location of the company, resolved from |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 524 | # Company.hq_location if provided. |
| 525 | # |
| 526 | # A resource that represents a location with full geographic information. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 527 | "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] | 528 | # such as postal delivery and payments addresses. Given a postal address, |
| 529 | # a postal service can deliver items to a premises, P.O. Box, or other |
| 530 | # delivery location. |
| 531 | # Given a postal address, a postal service can deliver items to a premise, P.O. |
| 532 | # Box or similar. |
| 533 | # It is not intended to model geographical locations (roads, towns, |
| 534 | # mountains). |
| 535 | # |
| 536 | # In typical usage an address would be created via user input or from importing |
| 537 | # existing data, depending on the type of process. |
| 538 | # |
| 539 | # Advice on address input / editing: |
| 540 | # - Use an i18n-ready address widget such as |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 541 | # https://github.com/google/libaddressinput) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 542 | # - Users should not be presented with UI elements for input or editing of |
| 543 | # fields outside countries where that field is used. |
| 544 | # |
| 545 | # For more guidance on how to use this schema, please see: |
| 546 | # https://support.google.com/business/answer/6397478 |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 547 | "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require |
| 548 | # postal codes to be present, but where they are used, they may trigger |
| 549 | # additional validation with other parts of the address (e.g. state/zip |
| 550 | # validation in the U.S.A.). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 551 | "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This |
| 552 | # is never inferred and it is up to the user to ensure the value is |
| 553 | # correct. See http://cldr.unicode.org/ and |
| 554 | # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html |
| 555 | # for details. Example: "CH" for Switzerland. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 556 | "organization": "A String", # Optional. The name of the organization at the address. |
| 557 | "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is |
| 558 | # the latest revision. |
| 559 | # |
| 560 | # All new revisions **must** be backward compatible with old revisions. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 561 | "addressLines": [ # Unstructured address lines describing the lower levels of an address. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 562 | # |
| 563 | # Because values in address_lines do not have type information and may |
| 564 | # sometimes contain multiple values in a single field (e.g. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 565 | # "Austin, TX"), it is important that the line order is clear. The order of |
| 566 | # 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] | 567 | # 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] | 568 | # used to make it explicit (e.g. "ja" for large-to-small ordering and |
| 569 | # "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] | 570 | # an address can be selected based on the language. |
| 571 | # |
| 572 | # The minimum permitted structural representation of an address consists |
| 573 | # of a region_code with all remaining information placed in the |
| 574 | # address_lines. It would be possible to format such an address very |
| 575 | # approximately without geocoding, but no semantic reasoning could be |
| 576 | # made about any of the address components until it was at least |
| 577 | # partially resolved. |
| 578 | # |
| 579 | # Creating an address only containing a region_code and address_lines, and |
| 580 | # then geocoding is the recommended way to handle completely unstructured |
| 581 | # addresses (as opposed to guessing which parts of the address should be |
| 582 | # localities or administrative areas). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 583 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 584 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 585 | "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal |
| 586 | # addresses of a country or region. |
| 587 | # For example, this can be a state, a province, an oblast, or a prefecture. |
| 588 | # Specifically, for Spain this is the province and not the autonomous |
| 589 | # community (e.g. "Barcelona" and not "Catalonia"). |
| 590 | # Many countries don't use an administrative area in postal addresses. E.g. |
| 591 | # in Switzerland this should be left unpopulated. |
| 592 | "recipients": [ # Optional. The recipient at the address. |
| 593 | # This field may, under certain circumstances, contain multiline information. |
| 594 | # For example, it might contain "care of" information. |
| 595 | "A String", |
| 596 | ], |
| 597 | "locality": "A String", # Optional. Generally refers to the city/town portion of the address. |
| 598 | # Examples: US city, IT comune, UK post town. |
| 599 | # In regions of the world where localities are not well defined or do not fit |
| 600 | # into this structure well, leave locality empty and use address_lines. |
| 601 | "sublocality": "A String", # Optional. Sublocality of the address. |
| 602 | # For example, this can be neighborhoods, boroughs, districts. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 603 | "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if |
| 604 | # known). This is often the UI language of the input form or is expected |
| 605 | # to match one of the languages used in the address' country/region, or their |
| 606 | # transliterated equivalents. |
| 607 | # This can affect formatting in certain countries, but is not critical |
| 608 | # to the correctness of the data and will never affect any validation or |
| 609 | # other non-formatting related operations. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 610 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 611 | # If this value is not known, it should be omitted (rather than specifying a |
| 612 | # possibly incorrect default). |
| 613 | # |
| 614 | # Examples: "zh-Hant", "ja", "ja-Latn", "en". |
| 615 | "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used |
| 616 | # in most regions. Where it is used, the value is either a string like |
| 617 | # "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number |
| 618 | # alone, representing the "sector code" (Jamaica), "delivery area indicator" |
| 619 | # (Malawi) or "post office indicator" (e.g. Côte d'Ivoire). |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 620 | }, |
| 621 | "radiusInMiles": 3.14, # Radius in miles of the job location. This value is derived from the |
| 622 | # location bounding box in which a circle with the specified radius |
| 623 | # centered from LatLng covers the area associated with the job location. |
| 624 | # For example, currently, "Mountain View, CA, USA" has a radius of |
| 625 | # 6.17 miles. |
| 626 | "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair. |
| 627 | # of doubles representing degrees latitude and degrees longitude. Unless |
| 628 | # specified otherwise, this must conform to the |
| 629 | # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 |
| 630 | # standard</a>. Values must be within normalized ranges. |
| 631 | "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. |
| 632 | "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 633 | }, |
| 634 | "locationType": "A String", # The type of a location, which corresponds to the address lines field of |
| 635 | # PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of |
| 636 | # LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of |
| 637 | # LocationType#LOCALITY. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 638 | }, |
| 639 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 640 | "displayName": "A String", # Required. The display name of the company, for example, "Google LLC". |
| 641 | "externalId": "A String", # Required. Client side company identifier, used to uniquely identify the |
| 642 | # company. |
| 643 | # |
| 644 | # The maximum number of allowed characters is 255. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 645 | "eeoText": "A String", # Optional. Equal Employment Opportunity legal disclaimer text to be |
| 646 | # associated with all jobs, and typically to be displayed in all |
| 647 | # roles. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 648 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 649 | # The maximum number of allowed characters is 500. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 650 | "careerSiteUri": "A String", # Optional. The URI to employer's career site or careers page on the employer's web |
| 651 | # site, for example, "https://careers.google.com". |
| 652 | "hiringAgency": True or False, # Optional. Set to true if it is the hiring agency that post jobs for other |
| 653 | # employers. |
| 654 | # |
| 655 | # Defaults to false if not provided. |
| 656 | "headquartersAddress": "A String", # Optional. The street address of the company's main headquarters, which may be |
| 657 | # different from the job location. The service attempts |
| 658 | # to geolocate the provided address, and populates a more specific |
| 659 | # location wherever possible in DerivedInfo.headquarters_location. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 660 | "name": "A String", # Required during company update. |
| 661 | # |
| 662 | # The resource name for a company. This is generated by the service when a |
| 663 | # company is created. |
| 664 | # |
| 665 | # The format is "projects/{project_id}/companies/{company_id}", for example, |
| 666 | # "projects/api-test-project/companies/foo". |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 667 | }</pre> |
| 668 | </div> |
| 669 | |
| 670 | <div class="method"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 671 | <code class="details" id="list">list(parent, pageToken=None, pageSize=None, requireOpenJobs=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 672 | <pre>Lists all companies associated with the service account. |
| 673 | |
| 674 | Args: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 675 | parent: string, Required. Resource name of the project under which the company is created. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 676 | |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 677 | The format is "projects/{project_id}", for example, |
| 678 | "projects/api-test-project". (required) |
| 679 | pageToken: string, Optional. The starting indicator from which to return results. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 680 | pageSize: integer, Optional. The maximum number of companies to be returned, at most 100. |
| 681 | Default is 100 if a non-positive number is provided. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 682 | requireOpenJobs: boolean, Optional. Set to true if the companies requested must have open jobs. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 683 | |
| 684 | Defaults to false. |
| 685 | |
| 686 | If true, at most page_size of companies are fetched, among which |
| 687 | only those with open jobs are returned. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 688 | x__xgafv: string, V1 error format. |
| 689 | Allowed values |
| 690 | 1 - v1 error format |
| 691 | 2 - v2 error format |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 692 | |
| 693 | Returns: |
| 694 | An object of the form: |
| 695 | |
| 696 | { # Output only. |
| 697 | # |
| 698 | # The List companies response object. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 699 | "metadata": { # Output only. # Additional information for the API invocation, such as the request |
| 700 | # tracking id. |
| 701 | # |
| 702 | # Additional information returned to client, such as debugging information. |
| 703 | "requestId": "A String", # A unique id associated with this call. |
| 704 | # This id is logged for tracking purposes. |
| 705 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 706 | "companies": [ # Companies for the current client. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 707 | { # A Company resource represents a company in the service. A company is the |
| 708 | # entity that owns job postings, that is, the hiring entity responsible for |
| 709 | # employing applicants for the job position. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 710 | "keywordSearchableJobCustomAttributes": [ # Optional. A list of keys of filterable Job.custom_attributes, whose |
| 711 | # corresponding `string_values` are used in keyword search. Jobs with |
| 712 | # `string_values` under these specified field keys are returned if any |
| 713 | # of the values matches the search keyword. Custom field values with |
| 714 | # parenthesis, brackets and special symbols won't be properly searchable, |
| 715 | # and those keyword queries need to be surrounded by quotes. |
| 716 | "A String", |
| 717 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 718 | "size": "A String", # Optional. The employer's company size. |
| 719 | "websiteUri": "A String", # Optional. The URI representing the company's primary web site or home page, |
| 720 | # for example, "https://www.google.com". |
| 721 | # |
| 722 | # The maximum number of allowed characters is 255. |
| 723 | "imageUri": "A String", # Optional. A URI that hosts the employer's company logo. |
| 724 | "suspended": True or False, # Output only. Indicates whether a company is flagged to be suspended from |
| 725 | # public availability by the service when job content appears suspicious, |
| 726 | # abusive, or spammy. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 727 | "derivedInfo": { # Derived details about the company. # Output only. Derived details about the company. |
| 728 | "headquartersLocation": { # Output only. # A structured headquarters location of the company, resolved from |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 729 | # Company.hq_location if provided. |
| 730 | # |
| 731 | # A resource that represents a location with full geographic information. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 732 | "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] | 733 | # such as postal delivery and payments addresses. Given a postal address, |
| 734 | # a postal service can deliver items to a premises, P.O. Box, or other |
| 735 | # delivery location. |
| 736 | # Given a postal address, a postal service can deliver items to a premise, P.O. |
| 737 | # Box or similar. |
| 738 | # It is not intended to model geographical locations (roads, towns, |
| 739 | # mountains). |
| 740 | # |
| 741 | # In typical usage an address would be created via user input or from importing |
| 742 | # existing data, depending on the type of process. |
| 743 | # |
| 744 | # Advice on address input / editing: |
| 745 | # - Use an i18n-ready address widget such as |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 746 | # https://github.com/google/libaddressinput) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 747 | # - Users should not be presented with UI elements for input or editing of |
| 748 | # fields outside countries where that field is used. |
| 749 | # |
| 750 | # For more guidance on how to use this schema, please see: |
| 751 | # https://support.google.com/business/answer/6397478 |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 752 | "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require |
| 753 | # postal codes to be present, but where they are used, they may trigger |
| 754 | # additional validation with other parts of the address (e.g. state/zip |
| 755 | # validation in the U.S.A.). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 756 | "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This |
| 757 | # is never inferred and it is up to the user to ensure the value is |
| 758 | # correct. See http://cldr.unicode.org/ and |
| 759 | # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html |
| 760 | # for details. Example: "CH" for Switzerland. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 761 | "organization": "A String", # Optional. The name of the organization at the address. |
| 762 | "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is |
| 763 | # the latest revision. |
| 764 | # |
| 765 | # All new revisions **must** be backward compatible with old revisions. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 766 | "addressLines": [ # Unstructured address lines describing the lower levels of an address. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 767 | # |
| 768 | # Because values in address_lines do not have type information and may |
| 769 | # sometimes contain multiple values in a single field (e.g. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 770 | # "Austin, TX"), it is important that the line order is clear. The order of |
| 771 | # 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] | 772 | # 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] | 773 | # used to make it explicit (e.g. "ja" for large-to-small ordering and |
| 774 | # "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] | 775 | # an address can be selected based on the language. |
| 776 | # |
| 777 | # The minimum permitted structural representation of an address consists |
| 778 | # of a region_code with all remaining information placed in the |
| 779 | # address_lines. It would be possible to format such an address very |
| 780 | # approximately without geocoding, but no semantic reasoning could be |
| 781 | # made about any of the address components until it was at least |
| 782 | # partially resolved. |
| 783 | # |
| 784 | # Creating an address only containing a region_code and address_lines, and |
| 785 | # then geocoding is the recommended way to handle completely unstructured |
| 786 | # addresses (as opposed to guessing which parts of the address should be |
| 787 | # localities or administrative areas). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 788 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 789 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 790 | "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal |
| 791 | # addresses of a country or region. |
| 792 | # For example, this can be a state, a province, an oblast, or a prefecture. |
| 793 | # Specifically, for Spain this is the province and not the autonomous |
| 794 | # community (e.g. "Barcelona" and not "Catalonia"). |
| 795 | # Many countries don't use an administrative area in postal addresses. E.g. |
| 796 | # in Switzerland this should be left unpopulated. |
| 797 | "recipients": [ # Optional. The recipient at the address. |
| 798 | # This field may, under certain circumstances, contain multiline information. |
| 799 | # For example, it might contain "care of" information. |
| 800 | "A String", |
| 801 | ], |
| 802 | "locality": "A String", # Optional. Generally refers to the city/town portion of the address. |
| 803 | # Examples: US city, IT comune, UK post town. |
| 804 | # In regions of the world where localities are not well defined or do not fit |
| 805 | # into this structure well, leave locality empty and use address_lines. |
| 806 | "sublocality": "A String", # Optional. Sublocality of the address. |
| 807 | # For example, this can be neighborhoods, boroughs, districts. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 808 | "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if |
| 809 | # known). This is often the UI language of the input form or is expected |
| 810 | # to match one of the languages used in the address' country/region, or their |
| 811 | # transliterated equivalents. |
| 812 | # This can affect formatting in certain countries, but is not critical |
| 813 | # to the correctness of the data and will never affect any validation or |
| 814 | # other non-formatting related operations. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 815 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 816 | # If this value is not known, it should be omitted (rather than specifying a |
| 817 | # possibly incorrect default). |
| 818 | # |
| 819 | # Examples: "zh-Hant", "ja", "ja-Latn", "en". |
| 820 | "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used |
| 821 | # in most regions. Where it is used, the value is either a string like |
| 822 | # "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number |
| 823 | # alone, representing the "sector code" (Jamaica), "delivery area indicator" |
| 824 | # (Malawi) or "post office indicator" (e.g. Côte d'Ivoire). |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 825 | }, |
| 826 | "radiusInMiles": 3.14, # Radius in miles of the job location. This value is derived from the |
| 827 | # location bounding box in which a circle with the specified radius |
| 828 | # centered from LatLng covers the area associated with the job location. |
| 829 | # For example, currently, "Mountain View, CA, USA" has a radius of |
| 830 | # 6.17 miles. |
| 831 | "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair. |
| 832 | # of doubles representing degrees latitude and degrees longitude. Unless |
| 833 | # specified otherwise, this must conform to the |
| 834 | # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 |
| 835 | # standard</a>. Values must be within normalized ranges. |
| 836 | "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. |
| 837 | "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 838 | }, |
| 839 | "locationType": "A String", # The type of a location, which corresponds to the address lines field of |
| 840 | # PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of |
| 841 | # LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of |
| 842 | # LocationType#LOCALITY. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 843 | }, |
| 844 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 845 | "displayName": "A String", # Required. The display name of the company, for example, "Google LLC". |
| 846 | "externalId": "A String", # Required. Client side company identifier, used to uniquely identify the |
| 847 | # company. |
| 848 | # |
| 849 | # The maximum number of allowed characters is 255. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 850 | "eeoText": "A String", # Optional. Equal Employment Opportunity legal disclaimer text to be |
| 851 | # associated with all jobs, and typically to be displayed in all |
| 852 | # roles. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 853 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 854 | # The maximum number of allowed characters is 500. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 855 | "careerSiteUri": "A String", # Optional. The URI to employer's career site or careers page on the employer's web |
| 856 | # site, for example, "https://careers.google.com". |
| 857 | "hiringAgency": True or False, # Optional. Set to true if it is the hiring agency that post jobs for other |
| 858 | # employers. |
| 859 | # |
| 860 | # Defaults to false if not provided. |
| 861 | "headquartersAddress": "A String", # Optional. The street address of the company's main headquarters, which may be |
| 862 | # different from the job location. The service attempts |
| 863 | # to geolocate the provided address, and populates a more specific |
| 864 | # location wherever possible in DerivedInfo.headquarters_location. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 865 | "name": "A String", # Required during company update. |
| 866 | # |
| 867 | # The resource name for a company. This is generated by the service when a |
| 868 | # company is created. |
| 869 | # |
| 870 | # The format is "projects/{project_id}/companies/{company_id}", for example, |
| 871 | # "projects/api-test-project/companies/foo". |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 872 | }, |
| 873 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 874 | "nextPageToken": "A String", # A token to retrieve the next page of results. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 875 | }</pre> |
| 876 | </div> |
| 877 | |
| 878 | <div class="method"> |
| 879 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 880 | <pre>Retrieves the next page of results. |
| 881 | |
| 882 | Args: |
| 883 | previous_request: The request for the previous page. (required) |
| 884 | previous_response: The response from the request for the previous page. (required) |
| 885 | |
| 886 | Returns: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 887 | 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] | 888 | page. Returns None if there are no more items in the collection. |
| 889 | </pre> |
| 890 | </div> |
| 891 | |
| 892 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 893 | <code class="details" id="patch">patch(name, body=None, x__xgafv=None)</code> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 894 | <pre>Updates specified company. Company names can't be updated. To update a |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 895 | company name, delete the company and all jobs associated with it, and only |
| 896 | then re-create them. |
| 897 | |
| 898 | Args: |
| 899 | name: string, Required during company update. |
| 900 | |
| 901 | The resource name for a company. This is generated by the service when a |
| 902 | company is created. |
| 903 | |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 904 | The format is "projects/{project_id}/companies/{company_id}", for example, |
| 905 | "projects/api-test-project/companies/foo". (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 906 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 907 | The object takes the form of: |
| 908 | |
| 909 | { # Input only. |
| 910 | # |
| 911 | # Request for updating a specified company. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 912 | "updateMask": "A String", # Optional but strongly recommended for the best service |
| 913 | # experience. |
| 914 | # |
| 915 | # If update_mask is provided, only the specified fields in |
| 916 | # company are updated. Otherwise all the fields are updated. |
| 917 | # |
| 918 | # A field mask to specify the company fields to be updated. Only |
| 919 | # top level fields of Company are supported. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 920 | "company": { # A Company resource represents a company in the service. A company is the # Required. The company resource to replace the current resource in the system. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 921 | # entity that owns job postings, that is, the hiring entity responsible for |
| 922 | # employing applicants for the job position. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 923 | "keywordSearchableJobCustomAttributes": [ # Optional. A list of keys of filterable Job.custom_attributes, whose |
| 924 | # corresponding `string_values` are used in keyword search. Jobs with |
| 925 | # `string_values` under these specified field keys are returned if any |
| 926 | # of the values matches the search keyword. Custom field values with |
| 927 | # parenthesis, brackets and special symbols won't be properly searchable, |
| 928 | # and those keyword queries need to be surrounded by quotes. |
| 929 | "A String", |
| 930 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 931 | "size": "A String", # Optional. The employer's company size. |
| 932 | "websiteUri": "A String", # Optional. The URI representing the company's primary web site or home page, |
| 933 | # for example, "https://www.google.com". |
| 934 | # |
| 935 | # The maximum number of allowed characters is 255. |
| 936 | "imageUri": "A String", # Optional. A URI that hosts the employer's company logo. |
| 937 | "suspended": True or False, # Output only. Indicates whether a company is flagged to be suspended from |
| 938 | # public availability by the service when job content appears suspicious, |
| 939 | # abusive, or spammy. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 940 | "derivedInfo": { # Derived details about the company. # Output only. Derived details about the company. |
| 941 | "headquartersLocation": { # Output only. # A structured headquarters location of the company, resolved from |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 942 | # Company.hq_location if provided. |
| 943 | # |
| 944 | # A resource that represents a location with full geographic information. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 945 | "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] | 946 | # such as postal delivery and payments addresses. Given a postal address, |
| 947 | # a postal service can deliver items to a premises, P.O. Box, or other |
| 948 | # delivery location. |
| 949 | # Given a postal address, a postal service can deliver items to a premise, P.O. |
| 950 | # Box or similar. |
| 951 | # It is not intended to model geographical locations (roads, towns, |
| 952 | # mountains). |
| 953 | # |
| 954 | # In typical usage an address would be created via user input or from importing |
| 955 | # existing data, depending on the type of process. |
| 956 | # |
| 957 | # Advice on address input / editing: |
| 958 | # - Use an i18n-ready address widget such as |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 959 | # https://github.com/google/libaddressinput) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 960 | # - Users should not be presented with UI elements for input or editing of |
| 961 | # fields outside countries where that field is used. |
| 962 | # |
| 963 | # For more guidance on how to use this schema, please see: |
| 964 | # https://support.google.com/business/answer/6397478 |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 965 | "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require |
| 966 | # postal codes to be present, but where they are used, they may trigger |
| 967 | # additional validation with other parts of the address (e.g. state/zip |
| 968 | # validation in the U.S.A.). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 969 | "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This |
| 970 | # is never inferred and it is up to the user to ensure the value is |
| 971 | # correct. See http://cldr.unicode.org/ and |
| 972 | # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html |
| 973 | # for details. Example: "CH" for Switzerland. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 974 | "organization": "A String", # Optional. The name of the organization at the address. |
| 975 | "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is |
| 976 | # the latest revision. |
| 977 | # |
| 978 | # All new revisions **must** be backward compatible with old revisions. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 979 | "addressLines": [ # Unstructured address lines describing the lower levels of an address. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 980 | # |
| 981 | # Because values in address_lines do not have type information and may |
| 982 | # sometimes contain multiple values in a single field (e.g. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 983 | # "Austin, TX"), it is important that the line order is clear. The order of |
| 984 | # 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] | 985 | # 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] | 986 | # used to make it explicit (e.g. "ja" for large-to-small ordering and |
| 987 | # "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] | 988 | # an address can be selected based on the language. |
| 989 | # |
| 990 | # The minimum permitted structural representation of an address consists |
| 991 | # of a region_code with all remaining information placed in the |
| 992 | # address_lines. It would be possible to format such an address very |
| 993 | # approximately without geocoding, but no semantic reasoning could be |
| 994 | # made about any of the address components until it was at least |
| 995 | # partially resolved. |
| 996 | # |
| 997 | # Creating an address only containing a region_code and address_lines, and |
| 998 | # then geocoding is the recommended way to handle completely unstructured |
| 999 | # addresses (as opposed to guessing which parts of the address should be |
| 1000 | # localities or administrative areas). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1001 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1002 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1003 | "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal |
| 1004 | # addresses of a country or region. |
| 1005 | # For example, this can be a state, a province, an oblast, or a prefecture. |
| 1006 | # Specifically, for Spain this is the province and not the autonomous |
| 1007 | # community (e.g. "Barcelona" and not "Catalonia"). |
| 1008 | # Many countries don't use an administrative area in postal addresses. E.g. |
| 1009 | # in Switzerland this should be left unpopulated. |
| 1010 | "recipients": [ # Optional. The recipient at the address. |
| 1011 | # This field may, under certain circumstances, contain multiline information. |
| 1012 | # For example, it might contain "care of" information. |
| 1013 | "A String", |
| 1014 | ], |
| 1015 | "locality": "A String", # Optional. Generally refers to the city/town portion of the address. |
| 1016 | # Examples: US city, IT comune, UK post town. |
| 1017 | # In regions of the world where localities are not well defined or do not fit |
| 1018 | # into this structure well, leave locality empty and use address_lines. |
| 1019 | "sublocality": "A String", # Optional. Sublocality of the address. |
| 1020 | # For example, this can be neighborhoods, boroughs, districts. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1021 | "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if |
| 1022 | # known). This is often the UI language of the input form or is expected |
| 1023 | # to match one of the languages used in the address' country/region, or their |
| 1024 | # transliterated equivalents. |
| 1025 | # This can affect formatting in certain countries, but is not critical |
| 1026 | # to the correctness of the data and will never affect any validation or |
| 1027 | # other non-formatting related operations. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1028 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1029 | # If this value is not known, it should be omitted (rather than specifying a |
| 1030 | # possibly incorrect default). |
| 1031 | # |
| 1032 | # Examples: "zh-Hant", "ja", "ja-Latn", "en". |
| 1033 | "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used |
| 1034 | # in most regions. Where it is used, the value is either a string like |
| 1035 | # "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number |
| 1036 | # alone, representing the "sector code" (Jamaica), "delivery area indicator" |
| 1037 | # (Malawi) or "post office indicator" (e.g. Côte d'Ivoire). |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1038 | }, |
| 1039 | "radiusInMiles": 3.14, # Radius in miles of the job location. This value is derived from the |
| 1040 | # location bounding box in which a circle with the specified radius |
| 1041 | # centered from LatLng covers the area associated with the job location. |
| 1042 | # For example, currently, "Mountain View, CA, USA" has a radius of |
| 1043 | # 6.17 miles. |
| 1044 | "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair. |
| 1045 | # of doubles representing degrees latitude and degrees longitude. Unless |
| 1046 | # specified otherwise, this must conform to the |
| 1047 | # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 |
| 1048 | # standard</a>. Values must be within normalized ranges. |
| 1049 | "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. |
| 1050 | "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1051 | }, |
| 1052 | "locationType": "A String", # The type of a location, which corresponds to the address lines field of |
| 1053 | # PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of |
| 1054 | # LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of |
| 1055 | # LocationType#LOCALITY. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1056 | }, |
| 1057 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1058 | "displayName": "A String", # Required. The display name of the company, for example, "Google LLC". |
| 1059 | "externalId": "A String", # Required. Client side company identifier, used to uniquely identify the |
| 1060 | # company. |
| 1061 | # |
| 1062 | # The maximum number of allowed characters is 255. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1063 | "eeoText": "A String", # Optional. Equal Employment Opportunity legal disclaimer text to be |
| 1064 | # associated with all jobs, and typically to be displayed in all |
| 1065 | # roles. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1066 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1067 | # The maximum number of allowed characters is 500. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1068 | "careerSiteUri": "A String", # Optional. The URI to employer's career site or careers page on the employer's web |
| 1069 | # site, for example, "https://careers.google.com". |
| 1070 | "hiringAgency": True or False, # Optional. Set to true if it is the hiring agency that post jobs for other |
| 1071 | # employers. |
| 1072 | # |
| 1073 | # Defaults to false if not provided. |
| 1074 | "headquartersAddress": "A String", # Optional. The street address of the company's main headquarters, which may be |
| 1075 | # different from the job location. The service attempts |
| 1076 | # to geolocate the provided address, and populates a more specific |
| 1077 | # location wherever possible in DerivedInfo.headquarters_location. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1078 | "name": "A String", # Required during company update. |
| 1079 | # |
| 1080 | # The resource name for a company. This is generated by the service when a |
| 1081 | # company is created. |
| 1082 | # |
| 1083 | # The format is "projects/{project_id}/companies/{company_id}", for example, |
| 1084 | # "projects/api-test-project/companies/foo". |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1085 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1086 | } |
| 1087 | |
| 1088 | x__xgafv: string, V1 error format. |
| 1089 | Allowed values |
| 1090 | 1 - v1 error format |
| 1091 | 2 - v2 error format |
| 1092 | |
| 1093 | Returns: |
| 1094 | An object of the form: |
| 1095 | |
| 1096 | { # A Company resource represents a company in the service. A company is the |
| 1097 | # entity that owns job postings, that is, the hiring entity responsible for |
| 1098 | # employing applicants for the job position. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1099 | "keywordSearchableJobCustomAttributes": [ # Optional. A list of keys of filterable Job.custom_attributes, whose |
| 1100 | # corresponding `string_values` are used in keyword search. Jobs with |
| 1101 | # `string_values` under these specified field keys are returned if any |
| 1102 | # of the values matches the search keyword. Custom field values with |
| 1103 | # parenthesis, brackets and special symbols won't be properly searchable, |
| 1104 | # and those keyword queries need to be surrounded by quotes. |
| 1105 | "A String", |
| 1106 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1107 | "size": "A String", # Optional. The employer's company size. |
| 1108 | "websiteUri": "A String", # Optional. The URI representing the company's primary web site or home page, |
| 1109 | # for example, "https://www.google.com". |
| 1110 | # |
| 1111 | # The maximum number of allowed characters is 255. |
| 1112 | "imageUri": "A String", # Optional. A URI that hosts the employer's company logo. |
| 1113 | "suspended": True or False, # Output only. Indicates whether a company is flagged to be suspended from |
| 1114 | # public availability by the service when job content appears suspicious, |
| 1115 | # abusive, or spammy. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1116 | "derivedInfo": { # Derived details about the company. # Output only. Derived details about the company. |
| 1117 | "headquartersLocation": { # Output only. # A structured headquarters location of the company, resolved from |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1118 | # Company.hq_location if provided. |
| 1119 | # |
| 1120 | # A resource that represents a location with full geographic information. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1121 | "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] | 1122 | # such as postal delivery and payments addresses. Given a postal address, |
| 1123 | # a postal service can deliver items to a premises, P.O. Box, or other |
| 1124 | # delivery location. |
| 1125 | # Given a postal address, a postal service can deliver items to a premise, P.O. |
| 1126 | # Box or similar. |
| 1127 | # It is not intended to model geographical locations (roads, towns, |
| 1128 | # mountains). |
| 1129 | # |
| 1130 | # In typical usage an address would be created via user input or from importing |
| 1131 | # existing data, depending on the type of process. |
| 1132 | # |
| 1133 | # Advice on address input / editing: |
| 1134 | # - Use an i18n-ready address widget such as |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1135 | # https://github.com/google/libaddressinput) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1136 | # - Users should not be presented with UI elements for input or editing of |
| 1137 | # fields outside countries where that field is used. |
| 1138 | # |
| 1139 | # For more guidance on how to use this schema, please see: |
| 1140 | # https://support.google.com/business/answer/6397478 |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1141 | "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require |
| 1142 | # postal codes to be present, but where they are used, they may trigger |
| 1143 | # additional validation with other parts of the address (e.g. state/zip |
| 1144 | # validation in the U.S.A.). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1145 | "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This |
| 1146 | # is never inferred and it is up to the user to ensure the value is |
| 1147 | # correct. See http://cldr.unicode.org/ and |
| 1148 | # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html |
| 1149 | # for details. Example: "CH" for Switzerland. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1150 | "organization": "A String", # Optional. The name of the organization at the address. |
| 1151 | "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is |
| 1152 | # the latest revision. |
| 1153 | # |
| 1154 | # All new revisions **must** be backward compatible with old revisions. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1155 | "addressLines": [ # Unstructured address lines describing the lower levels of an address. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1156 | # |
| 1157 | # Because values in address_lines do not have type information and may |
| 1158 | # sometimes contain multiple values in a single field (e.g. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1159 | # "Austin, TX"), it is important that the line order is clear. The order of |
| 1160 | # 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] | 1161 | # 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] | 1162 | # used to make it explicit (e.g. "ja" for large-to-small ordering and |
| 1163 | # "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] | 1164 | # an address can be selected based on the language. |
| 1165 | # |
| 1166 | # The minimum permitted structural representation of an address consists |
| 1167 | # of a region_code with all remaining information placed in the |
| 1168 | # address_lines. It would be possible to format such an address very |
| 1169 | # approximately without geocoding, but no semantic reasoning could be |
| 1170 | # made about any of the address components until it was at least |
| 1171 | # partially resolved. |
| 1172 | # |
| 1173 | # Creating an address only containing a region_code and address_lines, and |
| 1174 | # then geocoding is the recommended way to handle completely unstructured |
| 1175 | # addresses (as opposed to guessing which parts of the address should be |
| 1176 | # localities or administrative areas). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1177 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1178 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1179 | "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal |
| 1180 | # addresses of a country or region. |
| 1181 | # For example, this can be a state, a province, an oblast, or a prefecture. |
| 1182 | # Specifically, for Spain this is the province and not the autonomous |
| 1183 | # community (e.g. "Barcelona" and not "Catalonia"). |
| 1184 | # Many countries don't use an administrative area in postal addresses. E.g. |
| 1185 | # in Switzerland this should be left unpopulated. |
| 1186 | "recipients": [ # Optional. The recipient at the address. |
| 1187 | # This field may, under certain circumstances, contain multiline information. |
| 1188 | # For example, it might contain "care of" information. |
| 1189 | "A String", |
| 1190 | ], |
| 1191 | "locality": "A String", # Optional. Generally refers to the city/town portion of the address. |
| 1192 | # Examples: US city, IT comune, UK post town. |
| 1193 | # In regions of the world where localities are not well defined or do not fit |
| 1194 | # into this structure well, leave locality empty and use address_lines. |
| 1195 | "sublocality": "A String", # Optional. Sublocality of the address. |
| 1196 | # For example, this can be neighborhoods, boroughs, districts. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1197 | "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if |
| 1198 | # known). This is often the UI language of the input form or is expected |
| 1199 | # to match one of the languages used in the address' country/region, or their |
| 1200 | # transliterated equivalents. |
| 1201 | # This can affect formatting in certain countries, but is not critical |
| 1202 | # to the correctness of the data and will never affect any validation or |
| 1203 | # other non-formatting related operations. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1204 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1205 | # If this value is not known, it should be omitted (rather than specifying a |
| 1206 | # possibly incorrect default). |
| 1207 | # |
| 1208 | # Examples: "zh-Hant", "ja", "ja-Latn", "en". |
| 1209 | "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used |
| 1210 | # in most regions. Where it is used, the value is either a string like |
| 1211 | # "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number |
| 1212 | # alone, representing the "sector code" (Jamaica), "delivery area indicator" |
| 1213 | # (Malawi) or "post office indicator" (e.g. Côte d'Ivoire). |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1214 | }, |
| 1215 | "radiusInMiles": 3.14, # Radius in miles of the job location. This value is derived from the |
| 1216 | # location bounding box in which a circle with the specified radius |
| 1217 | # centered from LatLng covers the area associated with the job location. |
| 1218 | # For example, currently, "Mountain View, CA, USA" has a radius of |
| 1219 | # 6.17 miles. |
| 1220 | "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair. |
| 1221 | # of doubles representing degrees latitude and degrees longitude. Unless |
| 1222 | # specified otherwise, this must conform to the |
| 1223 | # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 |
| 1224 | # standard</a>. Values must be within normalized ranges. |
| 1225 | "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. |
| 1226 | "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1227 | }, |
| 1228 | "locationType": "A String", # The type of a location, which corresponds to the address lines field of |
| 1229 | # PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of |
| 1230 | # LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of |
| 1231 | # LocationType#LOCALITY. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1232 | }, |
| 1233 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1234 | "displayName": "A String", # Required. The display name of the company, for example, "Google LLC". |
| 1235 | "externalId": "A String", # Required. Client side company identifier, used to uniquely identify the |
| 1236 | # company. |
| 1237 | # |
| 1238 | # The maximum number of allowed characters is 255. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1239 | "eeoText": "A String", # Optional. Equal Employment Opportunity legal disclaimer text to be |
| 1240 | # associated with all jobs, and typically to be displayed in all |
| 1241 | # roles. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1242 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1243 | # The maximum number of allowed characters is 500. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1244 | "careerSiteUri": "A String", # Optional. The URI to employer's career site or careers page on the employer's web |
| 1245 | # site, for example, "https://careers.google.com". |
| 1246 | "hiringAgency": True or False, # Optional. Set to true if it is the hiring agency that post jobs for other |
| 1247 | # employers. |
| 1248 | # |
| 1249 | # Defaults to false if not provided. |
| 1250 | "headquartersAddress": "A String", # Optional. The street address of the company's main headquarters, which may be |
| 1251 | # different from the job location. The service attempts |
| 1252 | # to geolocate the provided address, and populates a more specific |
| 1253 | # location wherever possible in DerivedInfo.headquarters_location. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1254 | "name": "A String", # Required during company update. |
| 1255 | # |
| 1256 | # The resource name for a company. This is generated by the service when a |
| 1257 | # company is created. |
| 1258 | # |
| 1259 | # The format is "projects/{project_id}/companies/{company_id}", for example, |
| 1260 | # "projects/api-test-project/companies/foo". |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1261 | }</pre> |
| 1262 | </div> |
| 1263 | |
| 1264 | </body></html> |