blob: b87ac56099be7ffa5f1be5e30d9380bbc01d13d8 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="jobs_v3.html">Cloud Talent Solution API</a> . <a href="jobs_v3.projects.html">projects</a> . <a href="jobs_v3.projects.companies.html">companies</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070078 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070079<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 Kim65020912020-05-20 12:08:20 -070087 <code><a href="#list">list(parent, pageToken=None, requireOpenJobs=None, pageSize=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070088<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'Mearadd494642020-05-01 07:42:23 -070093 <code><a href="#patch">patch(name, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070094<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'Mearadd494642020-05-01 07:42:23 -070097 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070098 <pre>Creates a new company entity.
99
100Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700101 parent: string, Required. Resource name of the project under which the company is created.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700102
Bu Sun Kim65020912020-05-20 12:08:20 -0700103The format is &quot;projects/{project_id}&quot;, for example,
104&quot;projects/api-test-project&quot;. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700105 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700106 The object takes the form of:
107
108{ # Input only.
109 #
110 # The Request of the CreateCompany method.
Bu Sun Kim65020912020-05-20 12:08:20 -0700111 &quot;company&quot;: { # A Company resource represents a company in the service. A company is the # Required. The company to be created.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700112 # entity that owns job postings, that is, the hiring entity responsible for
113 # employing applicants for the job position.
Bu Sun Kim65020912020-05-20 12:08:20 -0700114 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the company, for example, &quot;Google LLC&quot;.
115 &quot;headquartersAddress&quot;: &quot;A String&quot;, # Optional. The street address of the company&#x27;s main headquarters, which may be
116 # different from the job location. The service attempts
117 # to geolocate the provided address, and populates a more specific
118 # location wherever possible in DerivedInfo.headquarters_location.
119 &quot;keywordSearchableJobCustomAttributes&quot;: [ # Optional. A list of keys of filterable Job.custom_attributes, whose
120 # corresponding `string_values` are used in keyword search. Jobs with
121 # `string_values` under these specified field keys are returned if any
122 # of the values matches the search keyword. Custom field values with
123 # parenthesis, brackets and special symbols won&#x27;t be properly searchable,
124 # and those keyword queries need to be surrounded by quotes.
125 &quot;A String&quot;,
126 ],
127 &quot;derivedInfo&quot;: { # Derived details about the company. # Output only. Derived details about the company.
128 &quot;headquartersLocation&quot;: { # Output only. # A structured headquarters location of the company, resolved from
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700129 # Company.hq_location if provided.
130 #
131 # A resource that represents a location with full geographic information.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700132 &quot;radiusInMiles&quot;: 3.14, # Radius in miles of the job location. This value is derived from the
133 # location bounding box in which a circle with the specified radius
134 # centered from LatLng covers the area associated with the job location.
135 # For example, currently, &quot;Mountain View, CA, USA&quot; has a radius of
136 # 6.17 miles.
Bu Sun Kim65020912020-05-20 12:08:20 -0700137 &quot;latLng&quot;: { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700138 # of doubles representing degrees latitude and degrees longitude. Unless
139 # specified otherwise, this must conform to the
Bu Sun Kim65020912020-05-20 12:08:20 -0700140 # &lt;a href=&quot;http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf&quot;&gt;WGS84
Dan O'Mearadd494642020-05-01 07:42:23 -0700141 # standard&lt;/a&gt;. Values must be within normalized ranges.
Bu Sun Kim65020912020-05-20 12:08:20 -0700142 &quot;longitude&quot;: 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700143 &quot;latitude&quot;: 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700144 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700145 &quot;postalAddress&quot;: { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700146 # such as postal delivery and payments addresses. Given a postal address,
147 # a postal service can deliver items to a premises, P.O. Box, or other
148 # delivery location.
149 # Given a postal address, a postal service can deliver items to a premise, P.O.
150 # Box or similar.
151 # It is not intended to model geographical locations (roads, towns,
152 # mountains).
153 #
154 # In typical usage an address would be created via user input or from importing
155 # existing data, depending on the type of process.
156 #
157 # Advice on address input / editing:
158 # - Use an i18n-ready address widget such as
Dan O'Mearadd494642020-05-01 07:42:23 -0700159 # https://github.com/google/libaddressinput)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700160 # - Users should not be presented with UI elements for input or editing of
161 # fields outside countries where that field is used.
162 #
163 # For more guidance on how to use this schema, please see:
164 # https://support.google.com/business/answer/6397478
Bu Sun Kim65020912020-05-20 12:08:20 -0700165 &quot;postalCode&quot;: &quot;A String&quot;, # Optional. Postal code of the address. Not all countries use or require
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700166 # postal codes to be present, but where they are used, they may trigger
167 # additional validation with other parts of the address (e.g. state/zip
168 # validation in the U.S.A.).
Bu Sun Kim65020912020-05-20 12:08:20 -0700169 &quot;languageCode&quot;: &quot;A String&quot;, # Optional. BCP-47 language code of the contents of this address (if
170 # known). This is often the UI language of the input form or is expected
171 # to match one of the languages used in the address&#x27; country/region, or their
172 # transliterated equivalents.
173 # This can affect formatting in certain countries, but is not critical
174 # to the correctness of the data and will never affect any validation or
175 # other non-formatting related operations.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700176 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700177 # If this value is not known, it should be omitted (rather than specifying a
178 # possibly incorrect default).
179 #
180 # Examples: &quot;zh-Hant&quot;, &quot;ja&quot;, &quot;ja-Latn&quot;, &quot;en&quot;.
181 &quot;sortingCode&quot;: &quot;A String&quot;, # Optional. Additional, country-specific, sorting code. This is not used
182 # in most regions. Where it is used, the value is either a string like
183 # &quot;CEDEX&quot;, optionally followed by a number (e.g. &quot;CEDEX 7&quot;), or just a number
184 # alone, representing the &quot;sector code&quot; (Jamaica), &quot;delivery area indicator&quot;
185 # (Malawi) or &quot;post office indicator&quot; (e.g. Côte d&#x27;Ivoire).
186 &quot;recipients&quot;: [ # Optional. The recipient at the address.
187 # This field may, under certain circumstances, contain multiline information.
188 # For example, it might contain &quot;care of&quot; information.
189 &quot;A String&quot;,
190 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700191 &quot;sublocality&quot;: &quot;A String&quot;, # Optional. Sublocality of the address.
192 # For example, this can be neighborhoods, boroughs, districts.
193 &quot;revision&quot;: 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is
194 # the latest revision.
195 #
196 # All new revisions **must** be backward compatible with old revisions.
197 &quot;locality&quot;: &quot;A String&quot;, # Optional. Generally refers to the city/town portion of the address.
198 # Examples: US city, IT comune, UK post town.
199 # In regions of the world where localities are not well defined or do not fit
200 # into this structure well, leave locality empty and use address_lines.
201 &quot;administrativeArea&quot;: &quot;A String&quot;, # Optional. Highest administrative subdivision which is used for postal
202 # addresses of a country or region.
203 # For example, this can be a state, a province, an oblast, or a prefecture.
204 # Specifically, for Spain this is the province and not the autonomous
205 # community (e.g. &quot;Barcelona&quot; and not &quot;Catalonia&quot;).
206 # Many countries don&#x27;t use an administrative area in postal addresses. E.g.
207 # in Switzerland this should be left unpopulated.
208 &quot;organization&quot;: &quot;A String&quot;, # Optional. The name of the organization at the address.
209 &quot;addressLines&quot;: [ # Unstructured address lines describing the lower levels of an address.
210 #
211 # Because values in address_lines do not have type information and may
212 # sometimes contain multiple values in a single field (e.g.
213 # &quot;Austin, TX&quot;), it is important that the line order is clear. The order of
214 # address lines should be &quot;envelope order&quot; for the country/region of the
215 # address. In places where this can vary (e.g. Japan), address_language is
216 # used to make it explicit (e.g. &quot;ja&quot; for large-to-small ordering and
217 # &quot;ja-Latn&quot; or &quot;en&quot; for small-to-large). This way, the most specific line of
218 # an address can be selected based on the language.
219 #
220 # The minimum permitted structural representation of an address consists
221 # of a region_code with all remaining information placed in the
222 # address_lines. It would be possible to format such an address very
223 # approximately without geocoding, but no semantic reasoning could be
224 # made about any of the address components until it was at least
225 # partially resolved.
226 #
227 # Creating an address only containing a region_code and address_lines, and
228 # then geocoding is the recommended way to handle completely unstructured
229 # addresses (as opposed to guessing which parts of the address should be
230 # localities or administrative areas).
231 &quot;A String&quot;,
232 ],
233 &quot;regionCode&quot;: &quot;A String&quot;, # Required. CLDR region code of the country/region of the address. This
234 # is never inferred and it is up to the user to ensure the value is
235 # correct. See http://cldr.unicode.org/ and
236 # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html
237 # for details. Example: &quot;CH&quot; for Switzerland.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700238 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700239 &quot;locationType&quot;: &quot;A String&quot;, # The type of a location, which corresponds to the address lines field of
240 # PostalAddress. For example, &quot;Downtown, Atlanta, GA, USA&quot; has a type of
241 # LocationType#NEIGHBORHOOD, and &quot;Kansas City, KS, USA&quot; has a type of
242 # LocationType#LOCALITY.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700243 },
244 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700245 &quot;suspended&quot;: True or False, # Output only. Indicates whether a company is flagged to be suspended from
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700246 # public availability by the service when job content appears suspicious,
247 # abusive, or spammy.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700248 &quot;eeoText&quot;: &quot;A String&quot;, # Optional. Equal Employment Opportunity legal disclaimer text to be
249 # associated with all jobs, and typically to be displayed in all
250 # roles.
251 #
252 # The maximum number of allowed characters is 500.
253 &quot;name&quot;: &quot;A String&quot;, # Required during company update.
254 #
255 # The resource name for a company. This is generated by the service when a
256 # company is created.
257 #
258 # The format is &quot;projects/{project_id}/companies/{company_id}&quot;, for example,
259 # &quot;projects/api-test-project/companies/foo&quot;.
260 &quot;imageUri&quot;: &quot;A String&quot;, # Optional. A URI that hosts the employer&#x27;s company logo.
261 &quot;size&quot;: &quot;A String&quot;, # Optional. The employer&#x27;s company size.
262 &quot;hiringAgency&quot;: True or False, # Optional. Set to true if it is the hiring agency that post jobs for other
263 # employers.
264 #
265 # Defaults to false if not provided.
266 &quot;websiteUri&quot;: &quot;A String&quot;, # Optional. The URI representing the company&#x27;s primary web site or home page,
267 # for example, &quot;https://www.google.com&quot;.
268 #
269 # The maximum number of allowed characters is 255.
270 &quot;externalId&quot;: &quot;A String&quot;, # Required. Client side company identifier, used to uniquely identify the
271 # company.
272 #
273 # The maximum number of allowed characters is 255.
274 &quot;careerSiteUri&quot;: &quot;A String&quot;, # Optional. The URI to employer&#x27;s career site or careers page on the employer&#x27;s web
275 # site, for example, &quot;https://careers.google.com&quot;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700276 },
277 }
278
279 x__xgafv: string, V1 error format.
280 Allowed values
281 1 - v1 error format
282 2 - v2 error format
283
284Returns:
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 Kim65020912020-05-20 12:08:20 -0700290 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the company, for example, &quot;Google LLC&quot;.
291 &quot;headquartersAddress&quot;: &quot;A String&quot;, # Optional. The street address of the company&#x27;s main headquarters, which may be
292 # different from the job location. The service attempts
293 # to geolocate the provided address, and populates a more specific
294 # location wherever possible in DerivedInfo.headquarters_location.
295 &quot;keywordSearchableJobCustomAttributes&quot;: [ # Optional. A list of keys of filterable Job.custom_attributes, whose
296 # corresponding `string_values` are used in keyword search. Jobs with
297 # `string_values` under these specified field keys are returned if any
298 # of the values matches the search keyword. Custom field values with
299 # parenthesis, brackets and special symbols won&#x27;t be properly searchable,
300 # and those keyword queries need to be surrounded by quotes.
301 &quot;A String&quot;,
302 ],
303 &quot;derivedInfo&quot;: { # Derived details about the company. # Output only. Derived details about the company.
304 &quot;headquartersLocation&quot;: { # Output only. # A structured headquarters location of the company, resolved from
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700305 # Company.hq_location if provided.
306 #
307 # A resource that represents a location with full geographic information.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700308 &quot;radiusInMiles&quot;: 3.14, # Radius in miles of the job location. This value is derived from the
309 # location bounding box in which a circle with the specified radius
310 # centered from LatLng covers the area associated with the job location.
311 # For example, currently, &quot;Mountain View, CA, USA&quot; has a radius of
312 # 6.17 miles.
Bu Sun Kim65020912020-05-20 12:08:20 -0700313 &quot;latLng&quot;: { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700314 # of doubles representing degrees latitude and degrees longitude. Unless
315 # specified otherwise, this must conform to the
Bu Sun Kim65020912020-05-20 12:08:20 -0700316 # &lt;a href=&quot;http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf&quot;&gt;WGS84
Dan O'Mearadd494642020-05-01 07:42:23 -0700317 # standard&lt;/a&gt;. Values must be within normalized ranges.
Bu Sun Kim65020912020-05-20 12:08:20 -0700318 &quot;longitude&quot;: 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700319 &quot;latitude&quot;: 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700320 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700321 &quot;postalAddress&quot;: { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700322 # such as postal delivery and payments addresses. Given a postal address,
323 # a postal service can deliver items to a premises, P.O. Box, or other
324 # delivery location.
325 # Given a postal address, a postal service can deliver items to a premise, P.O.
326 # Box or similar.
327 # It is not intended to model geographical locations (roads, towns,
328 # mountains).
329 #
330 # In typical usage an address would be created via user input or from importing
331 # existing data, depending on the type of process.
332 #
333 # Advice on address input / editing:
334 # - Use an i18n-ready address widget such as
Dan O'Mearadd494642020-05-01 07:42:23 -0700335 # https://github.com/google/libaddressinput)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700336 # - Users should not be presented with UI elements for input or editing of
337 # fields outside countries where that field is used.
338 #
339 # For more guidance on how to use this schema, please see:
340 # https://support.google.com/business/answer/6397478
Bu Sun Kim65020912020-05-20 12:08:20 -0700341 &quot;postalCode&quot;: &quot;A String&quot;, # Optional. Postal code of the address. Not all countries use or require
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700342 # postal codes to be present, but where they are used, they may trigger
343 # additional validation with other parts of the address (e.g. state/zip
344 # validation in the U.S.A.).
Bu Sun Kim65020912020-05-20 12:08:20 -0700345 &quot;languageCode&quot;: &quot;A String&quot;, # Optional. BCP-47 language code of the contents of this address (if
346 # known). This is often the UI language of the input form or is expected
347 # to match one of the languages used in the address&#x27; country/region, or their
348 # transliterated equivalents.
349 # This can affect formatting in certain countries, but is not critical
350 # to the correctness of the data and will never affect any validation or
351 # other non-formatting related operations.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700352 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700353 # If this value is not known, it should be omitted (rather than specifying a
354 # possibly incorrect default).
355 #
356 # Examples: &quot;zh-Hant&quot;, &quot;ja&quot;, &quot;ja-Latn&quot;, &quot;en&quot;.
357 &quot;sortingCode&quot;: &quot;A String&quot;, # Optional. Additional, country-specific, sorting code. This is not used
358 # in most regions. Where it is used, the value is either a string like
359 # &quot;CEDEX&quot;, optionally followed by a number (e.g. &quot;CEDEX 7&quot;), or just a number
360 # alone, representing the &quot;sector code&quot; (Jamaica), &quot;delivery area indicator&quot;
361 # (Malawi) or &quot;post office indicator&quot; (e.g. Côte d&#x27;Ivoire).
362 &quot;recipients&quot;: [ # Optional. The recipient at the address.
363 # This field may, under certain circumstances, contain multiline information.
364 # For example, it might contain &quot;care of&quot; information.
365 &quot;A String&quot;,
366 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700367 &quot;sublocality&quot;: &quot;A String&quot;, # Optional. Sublocality of the address.
368 # For example, this can be neighborhoods, boroughs, districts.
369 &quot;revision&quot;: 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is
370 # the latest revision.
371 #
372 # All new revisions **must** be backward compatible with old revisions.
373 &quot;locality&quot;: &quot;A String&quot;, # Optional. Generally refers to the city/town portion of the address.
374 # Examples: US city, IT comune, UK post town.
375 # In regions of the world where localities are not well defined or do not fit
376 # into this structure well, leave locality empty and use address_lines.
377 &quot;administrativeArea&quot;: &quot;A String&quot;, # Optional. Highest administrative subdivision which is used for postal
378 # addresses of a country or region.
379 # For example, this can be a state, a province, an oblast, or a prefecture.
380 # Specifically, for Spain this is the province and not the autonomous
381 # community (e.g. &quot;Barcelona&quot; and not &quot;Catalonia&quot;).
382 # Many countries don&#x27;t use an administrative area in postal addresses. E.g.
383 # in Switzerland this should be left unpopulated.
384 &quot;organization&quot;: &quot;A String&quot;, # Optional. The name of the organization at the address.
385 &quot;addressLines&quot;: [ # Unstructured address lines describing the lower levels of an address.
386 #
387 # Because values in address_lines do not have type information and may
388 # sometimes contain multiple values in a single field (e.g.
389 # &quot;Austin, TX&quot;), it is important that the line order is clear. The order of
390 # address lines should be &quot;envelope order&quot; for the country/region of the
391 # address. In places where this can vary (e.g. Japan), address_language is
392 # used to make it explicit (e.g. &quot;ja&quot; for large-to-small ordering and
393 # &quot;ja-Latn&quot; or &quot;en&quot; for small-to-large). This way, the most specific line of
394 # an address can be selected based on the language.
395 #
396 # The minimum permitted structural representation of an address consists
397 # of a region_code with all remaining information placed in the
398 # address_lines. It would be possible to format such an address very
399 # approximately without geocoding, but no semantic reasoning could be
400 # made about any of the address components until it was at least
401 # partially resolved.
402 #
403 # Creating an address only containing a region_code and address_lines, and
404 # then geocoding is the recommended way to handle completely unstructured
405 # addresses (as opposed to guessing which parts of the address should be
406 # localities or administrative areas).
407 &quot;A String&quot;,
408 ],
409 &quot;regionCode&quot;: &quot;A String&quot;, # Required. CLDR region code of the country/region of the address. This
410 # is never inferred and it is up to the user to ensure the value is
411 # correct. See http://cldr.unicode.org/ and
412 # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html
413 # for details. Example: &quot;CH&quot; for Switzerland.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700414 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700415 &quot;locationType&quot;: &quot;A String&quot;, # The type of a location, which corresponds to the address lines field of
416 # PostalAddress. For example, &quot;Downtown, Atlanta, GA, USA&quot; has a type of
417 # LocationType#NEIGHBORHOOD, and &quot;Kansas City, KS, USA&quot; has a type of
418 # LocationType#LOCALITY.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700419 },
420 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700421 &quot;suspended&quot;: True or False, # Output only. Indicates whether a company is flagged to be suspended from
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700422 # public availability by the service when job content appears suspicious,
423 # abusive, or spammy.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700424 &quot;eeoText&quot;: &quot;A String&quot;, # Optional. Equal Employment Opportunity legal disclaimer text to be
425 # associated with all jobs, and typically to be displayed in all
426 # roles.
427 #
428 # The maximum number of allowed characters is 500.
429 &quot;name&quot;: &quot;A String&quot;, # Required during company update.
430 #
431 # The resource name for a company. This is generated by the service when a
432 # company is created.
433 #
434 # The format is &quot;projects/{project_id}/companies/{company_id}&quot;, for example,
435 # &quot;projects/api-test-project/companies/foo&quot;.
436 &quot;imageUri&quot;: &quot;A String&quot;, # Optional. A URI that hosts the employer&#x27;s company logo.
437 &quot;size&quot;: &quot;A String&quot;, # Optional. The employer&#x27;s company size.
438 &quot;hiringAgency&quot;: True or False, # Optional. Set to true if it is the hiring agency that post jobs for other
439 # employers.
440 #
441 # Defaults to false if not provided.
442 &quot;websiteUri&quot;: &quot;A String&quot;, # Optional. The URI representing the company&#x27;s primary web site or home page,
443 # for example, &quot;https://www.google.com&quot;.
444 #
445 # The maximum number of allowed characters is 255.
446 &quot;externalId&quot;: &quot;A String&quot;, # Required. Client side company identifier, used to uniquely identify the
447 # company.
448 #
449 # The maximum number of allowed characters is 255.
450 &quot;careerSiteUri&quot;: &quot;A String&quot;, # Optional. The URI to employer&#x27;s career site or careers page on the employer&#x27;s web
451 # site, for example, &quot;https://careers.google.com&quot;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700452 }</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.
458Prerequisite: The company has no jobs associated with it.
459
460Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700461 name: string, Required. The resource name of the company to be deleted.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700462
Bu Sun Kim65020912020-05-20 12:08:20 -0700463The format is &quot;projects/{project_id}/companies/{company_id}&quot;, for example,
464&quot;projects/api-test-project/companies/foo&quot;. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700465 x__xgafv: string, V1 error format.
466 Allowed values
467 1 - v1 error format
468 2 - v2 error format
469
470Returns:
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
489Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700490 name: string, Required. The resource name of the company to be retrieved.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700491
Bu Sun Kim65020912020-05-20 12:08:20 -0700492The format is &quot;projects/{project_id}/companies/{company_id}&quot;, for example,
493&quot;projects/api-test-project/companies/foo&quot;. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700494 x__xgafv: string, V1 error format.
495 Allowed values
496 1 - v1 error format
497 2 - v2 error format
498
499Returns:
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 Kim65020912020-05-20 12:08:20 -0700505 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the company, for example, &quot;Google LLC&quot;.
506 &quot;headquartersAddress&quot;: &quot;A String&quot;, # Optional. The street address of the company&#x27;s main headquarters, which may be
507 # different from the job location. The service attempts
508 # to geolocate the provided address, and populates a more specific
509 # location wherever possible in DerivedInfo.headquarters_location.
510 &quot;keywordSearchableJobCustomAttributes&quot;: [ # Optional. A list of keys of filterable Job.custom_attributes, whose
511 # corresponding `string_values` are used in keyword search. Jobs with
512 # `string_values` under these specified field keys are returned if any
513 # of the values matches the search keyword. Custom field values with
514 # parenthesis, brackets and special symbols won&#x27;t be properly searchable,
515 # and those keyword queries need to be surrounded by quotes.
516 &quot;A String&quot;,
517 ],
518 &quot;derivedInfo&quot;: { # Derived details about the company. # Output only. Derived details about the company.
519 &quot;headquartersLocation&quot;: { # Output only. # A structured headquarters location of the company, resolved from
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700520 # Company.hq_location if provided.
521 #
522 # A resource that represents a location with full geographic information.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700523 &quot;radiusInMiles&quot;: 3.14, # Radius in miles of the job location. This value is derived from the
524 # location bounding box in which a circle with the specified radius
525 # centered from LatLng covers the area associated with the job location.
526 # For example, currently, &quot;Mountain View, CA, USA&quot; has a radius of
527 # 6.17 miles.
Bu Sun Kim65020912020-05-20 12:08:20 -0700528 &quot;latLng&quot;: { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700529 # of doubles representing degrees latitude and degrees longitude. Unless
530 # specified otherwise, this must conform to the
Bu Sun Kim65020912020-05-20 12:08:20 -0700531 # &lt;a href=&quot;http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf&quot;&gt;WGS84
Dan O'Mearadd494642020-05-01 07:42:23 -0700532 # standard&lt;/a&gt;. Values must be within normalized ranges.
Bu Sun Kim65020912020-05-20 12:08:20 -0700533 &quot;longitude&quot;: 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700534 &quot;latitude&quot;: 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700535 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700536 &quot;postalAddress&quot;: { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700537 # such as postal delivery and payments addresses. Given a postal address,
538 # a postal service can deliver items to a premises, P.O. Box, or other
539 # delivery location.
540 # Given a postal address, a postal service can deliver items to a premise, P.O.
541 # Box or similar.
542 # It is not intended to model geographical locations (roads, towns,
543 # mountains).
544 #
545 # In typical usage an address would be created via user input or from importing
546 # existing data, depending on the type of process.
547 #
548 # Advice on address input / editing:
549 # - Use an i18n-ready address widget such as
Dan O'Mearadd494642020-05-01 07:42:23 -0700550 # https://github.com/google/libaddressinput)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700551 # - Users should not be presented with UI elements for input or editing of
552 # fields outside countries where that field is used.
553 #
554 # For more guidance on how to use this schema, please see:
555 # https://support.google.com/business/answer/6397478
Bu Sun Kim65020912020-05-20 12:08:20 -0700556 &quot;postalCode&quot;: &quot;A String&quot;, # Optional. Postal code of the address. Not all countries use or require
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700557 # postal codes to be present, but where they are used, they may trigger
558 # additional validation with other parts of the address (e.g. state/zip
559 # validation in the U.S.A.).
Bu Sun Kim65020912020-05-20 12:08:20 -0700560 &quot;languageCode&quot;: &quot;A String&quot;, # Optional. BCP-47 language code of the contents of this address (if
561 # known). This is often the UI language of the input form or is expected
562 # to match one of the languages used in the address&#x27; country/region, or their
563 # transliterated equivalents.
564 # This can affect formatting in certain countries, but is not critical
565 # to the correctness of the data and will never affect any validation or
566 # other non-formatting related operations.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700567 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700568 # If this value is not known, it should be omitted (rather than specifying a
569 # possibly incorrect default).
570 #
571 # Examples: &quot;zh-Hant&quot;, &quot;ja&quot;, &quot;ja-Latn&quot;, &quot;en&quot;.
572 &quot;sortingCode&quot;: &quot;A String&quot;, # Optional. Additional, country-specific, sorting code. This is not used
573 # in most regions. Where it is used, the value is either a string like
574 # &quot;CEDEX&quot;, optionally followed by a number (e.g. &quot;CEDEX 7&quot;), or just a number
575 # alone, representing the &quot;sector code&quot; (Jamaica), &quot;delivery area indicator&quot;
576 # (Malawi) or &quot;post office indicator&quot; (e.g. Côte d&#x27;Ivoire).
577 &quot;recipients&quot;: [ # Optional. The recipient at the address.
578 # This field may, under certain circumstances, contain multiline information.
579 # For example, it might contain &quot;care of&quot; information.
580 &quot;A String&quot;,
581 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700582 &quot;sublocality&quot;: &quot;A String&quot;, # Optional. Sublocality of the address.
583 # For example, this can be neighborhoods, boroughs, districts.
584 &quot;revision&quot;: 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is
585 # the latest revision.
586 #
587 # All new revisions **must** be backward compatible with old revisions.
588 &quot;locality&quot;: &quot;A String&quot;, # Optional. Generally refers to the city/town portion of the address.
589 # Examples: US city, IT comune, UK post town.
590 # In regions of the world where localities are not well defined or do not fit
591 # into this structure well, leave locality empty and use address_lines.
592 &quot;administrativeArea&quot;: &quot;A String&quot;, # Optional. Highest administrative subdivision which is used for postal
593 # addresses of a country or region.
594 # For example, this can be a state, a province, an oblast, or a prefecture.
595 # Specifically, for Spain this is the province and not the autonomous
596 # community (e.g. &quot;Barcelona&quot; and not &quot;Catalonia&quot;).
597 # Many countries don&#x27;t use an administrative area in postal addresses. E.g.
598 # in Switzerland this should be left unpopulated.
599 &quot;organization&quot;: &quot;A String&quot;, # Optional. The name of the organization at the address.
600 &quot;addressLines&quot;: [ # Unstructured address lines describing the lower levels of an address.
601 #
602 # Because values in address_lines do not have type information and may
603 # sometimes contain multiple values in a single field (e.g.
604 # &quot;Austin, TX&quot;), it is important that the line order is clear. The order of
605 # address lines should be &quot;envelope order&quot; for the country/region of the
606 # address. In places where this can vary (e.g. Japan), address_language is
607 # used to make it explicit (e.g. &quot;ja&quot; for large-to-small ordering and
608 # &quot;ja-Latn&quot; or &quot;en&quot; for small-to-large). This way, the most specific line of
609 # an address can be selected based on the language.
610 #
611 # The minimum permitted structural representation of an address consists
612 # of a region_code with all remaining information placed in the
613 # address_lines. It would be possible to format such an address very
614 # approximately without geocoding, but no semantic reasoning could be
615 # made about any of the address components until it was at least
616 # partially resolved.
617 #
618 # Creating an address only containing a region_code and address_lines, and
619 # then geocoding is the recommended way to handle completely unstructured
620 # addresses (as opposed to guessing which parts of the address should be
621 # localities or administrative areas).
622 &quot;A String&quot;,
623 ],
624 &quot;regionCode&quot;: &quot;A String&quot;, # Required. CLDR region code of the country/region of the address. This
625 # is never inferred and it is up to the user to ensure the value is
626 # correct. See http://cldr.unicode.org/ and
627 # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html
628 # for details. Example: &quot;CH&quot; for Switzerland.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700629 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700630 &quot;locationType&quot;: &quot;A String&quot;, # The type of a location, which corresponds to the address lines field of
631 # PostalAddress. For example, &quot;Downtown, Atlanta, GA, USA&quot; has a type of
632 # LocationType#NEIGHBORHOOD, and &quot;Kansas City, KS, USA&quot; has a type of
633 # LocationType#LOCALITY.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700634 },
635 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700636 &quot;suspended&quot;: True or False, # Output only. Indicates whether a company is flagged to be suspended from
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700637 # public availability by the service when job content appears suspicious,
638 # abusive, or spammy.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700639 &quot;eeoText&quot;: &quot;A String&quot;, # Optional. Equal Employment Opportunity legal disclaimer text to be
640 # associated with all jobs, and typically to be displayed in all
641 # roles.
642 #
643 # The maximum number of allowed characters is 500.
644 &quot;name&quot;: &quot;A String&quot;, # Required during company update.
645 #
646 # The resource name for a company. This is generated by the service when a
647 # company is created.
648 #
649 # The format is &quot;projects/{project_id}/companies/{company_id}&quot;, for example,
650 # &quot;projects/api-test-project/companies/foo&quot;.
651 &quot;imageUri&quot;: &quot;A String&quot;, # Optional. A URI that hosts the employer&#x27;s company logo.
652 &quot;size&quot;: &quot;A String&quot;, # Optional. The employer&#x27;s company size.
653 &quot;hiringAgency&quot;: True or False, # Optional. Set to true if it is the hiring agency that post jobs for other
654 # employers.
655 #
656 # Defaults to false if not provided.
657 &quot;websiteUri&quot;: &quot;A String&quot;, # Optional. The URI representing the company&#x27;s primary web site or home page,
658 # for example, &quot;https://www.google.com&quot;.
659 #
660 # The maximum number of allowed characters is 255.
661 &quot;externalId&quot;: &quot;A String&quot;, # Required. Client side company identifier, used to uniquely identify the
662 # company.
663 #
664 # The maximum number of allowed characters is 255.
665 &quot;careerSiteUri&quot;: &quot;A String&quot;, # Optional. The URI to employer&#x27;s career site or careers page on the employer&#x27;s web
666 # site, for example, &quot;https://careers.google.com&quot;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700667 }</pre>
668</div>
669
670<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700671 <code class="details" id="list">list(parent, pageToken=None, requireOpenJobs=None, pageSize=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700672 <pre>Lists all companies associated with the service account.
673
674Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700675 parent: string, Required. Resource name of the project under which the company is created.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700676
Bu Sun Kim65020912020-05-20 12:08:20 -0700677The format is &quot;projects/{project_id}&quot;, for example,
678&quot;projects/api-test-project&quot;. (required)
679 pageToken: string, Optional. The starting indicator from which to return results.
Dan O'Mearadd494642020-05-01 07:42:23 -0700680 requireOpenJobs: boolean, Optional. Set to true if the companies requested must have open jobs.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700681
682Defaults to false.
683
684If true, at most page_size of companies are fetched, among which
685only those with open jobs are returned.
Bu Sun Kim65020912020-05-20 12:08:20 -0700686 pageSize: integer, Optional. The maximum number of companies to be returned, at most 100.
687Default is 100 if a non-positive number is provided.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700688 x__xgafv: string, V1 error format.
689 Allowed values
690 1 - v1 error format
691 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700692
693Returns:
694 An object of the form:
695
696 { # Output only.
697 #
698 # The List companies response object.
Bu Sun Kim65020912020-05-20 12:08:20 -0700699 &quot;nextPageToken&quot;: &quot;A String&quot;, # A token to retrieve the next page of results.
700 &quot;companies&quot;: [ # Companies for the current client.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700701 { # A Company resource represents a company in the service. A company is the
702 # entity that owns job postings, that is, the hiring entity responsible for
703 # employing applicants for the job position.
Bu Sun Kim65020912020-05-20 12:08:20 -0700704 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the company, for example, &quot;Google LLC&quot;.
705 &quot;headquartersAddress&quot;: &quot;A String&quot;, # Optional. The street address of the company&#x27;s main headquarters, which may be
706 # different from the job location. The service attempts
707 # to geolocate the provided address, and populates a more specific
708 # location wherever possible in DerivedInfo.headquarters_location.
709 &quot;keywordSearchableJobCustomAttributes&quot;: [ # Optional. A list of keys of filterable Job.custom_attributes, whose
710 # corresponding `string_values` are used in keyword search. Jobs with
711 # `string_values` under these specified field keys are returned if any
712 # of the values matches the search keyword. Custom field values with
713 # parenthesis, brackets and special symbols won&#x27;t be properly searchable,
714 # and those keyword queries need to be surrounded by quotes.
715 &quot;A String&quot;,
716 ],
717 &quot;derivedInfo&quot;: { # Derived details about the company. # Output only. Derived details about the company.
718 &quot;headquartersLocation&quot;: { # Output only. # A structured headquarters location of the company, resolved from
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700719 # Company.hq_location if provided.
720 #
721 # A resource that represents a location with full geographic information.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700722 &quot;radiusInMiles&quot;: 3.14, # Radius in miles of the job location. This value is derived from the
723 # location bounding box in which a circle with the specified radius
724 # centered from LatLng covers the area associated with the job location.
725 # For example, currently, &quot;Mountain View, CA, USA&quot; has a radius of
726 # 6.17 miles.
Bu Sun Kim65020912020-05-20 12:08:20 -0700727 &quot;latLng&quot;: { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700728 # of doubles representing degrees latitude and degrees longitude. Unless
729 # specified otherwise, this must conform to the
Bu Sun Kim65020912020-05-20 12:08:20 -0700730 # &lt;a href=&quot;http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf&quot;&gt;WGS84
Dan O'Mearadd494642020-05-01 07:42:23 -0700731 # standard&lt;/a&gt;. Values must be within normalized ranges.
Bu Sun Kim65020912020-05-20 12:08:20 -0700732 &quot;longitude&quot;: 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700733 &quot;latitude&quot;: 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700734 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700735 &quot;postalAddress&quot;: { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700736 # such as postal delivery and payments addresses. Given a postal address,
737 # a postal service can deliver items to a premises, P.O. Box, or other
738 # delivery location.
739 # Given a postal address, a postal service can deliver items to a premise, P.O.
740 # Box or similar.
741 # It is not intended to model geographical locations (roads, towns,
742 # mountains).
743 #
744 # In typical usage an address would be created via user input or from importing
745 # existing data, depending on the type of process.
746 #
747 # Advice on address input / editing:
748 # - Use an i18n-ready address widget such as
Dan O'Mearadd494642020-05-01 07:42:23 -0700749 # https://github.com/google/libaddressinput)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700750 # - Users should not be presented with UI elements for input or editing of
751 # fields outside countries where that field is used.
752 #
753 # For more guidance on how to use this schema, please see:
754 # https://support.google.com/business/answer/6397478
Bu Sun Kim65020912020-05-20 12:08:20 -0700755 &quot;postalCode&quot;: &quot;A String&quot;, # Optional. Postal code of the address. Not all countries use or require
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700756 # postal codes to be present, but where they are used, they may trigger
757 # additional validation with other parts of the address (e.g. state/zip
758 # validation in the U.S.A.).
Bu Sun Kim65020912020-05-20 12:08:20 -0700759 &quot;languageCode&quot;: &quot;A String&quot;, # Optional. BCP-47 language code of the contents of this address (if
760 # known). This is often the UI language of the input form or is expected
761 # to match one of the languages used in the address&#x27; country/region, or their
762 # transliterated equivalents.
763 # This can affect formatting in certain countries, but is not critical
764 # to the correctness of the data and will never affect any validation or
765 # other non-formatting related operations.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700766 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700767 # If this value is not known, it should be omitted (rather than specifying a
768 # possibly incorrect default).
769 #
770 # Examples: &quot;zh-Hant&quot;, &quot;ja&quot;, &quot;ja-Latn&quot;, &quot;en&quot;.
771 &quot;sortingCode&quot;: &quot;A String&quot;, # Optional. Additional, country-specific, sorting code. This is not used
772 # in most regions. Where it is used, the value is either a string like
773 # &quot;CEDEX&quot;, optionally followed by a number (e.g. &quot;CEDEX 7&quot;), or just a number
774 # alone, representing the &quot;sector code&quot; (Jamaica), &quot;delivery area indicator&quot;
775 # (Malawi) or &quot;post office indicator&quot; (e.g. Côte d&#x27;Ivoire).
776 &quot;recipients&quot;: [ # Optional. The recipient at the address.
777 # This field may, under certain circumstances, contain multiline information.
778 # For example, it might contain &quot;care of&quot; information.
779 &quot;A String&quot;,
780 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700781 &quot;sublocality&quot;: &quot;A String&quot;, # Optional. Sublocality of the address.
782 # For example, this can be neighborhoods, boroughs, districts.
783 &quot;revision&quot;: 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is
784 # the latest revision.
785 #
786 # All new revisions **must** be backward compatible with old revisions.
787 &quot;locality&quot;: &quot;A String&quot;, # Optional. Generally refers to the city/town portion of the address.
788 # Examples: US city, IT comune, UK post town.
789 # In regions of the world where localities are not well defined or do not fit
790 # into this structure well, leave locality empty and use address_lines.
791 &quot;administrativeArea&quot;: &quot;A String&quot;, # Optional. Highest administrative subdivision which is used for postal
792 # addresses of a country or region.
793 # For example, this can be a state, a province, an oblast, or a prefecture.
794 # Specifically, for Spain this is the province and not the autonomous
795 # community (e.g. &quot;Barcelona&quot; and not &quot;Catalonia&quot;).
796 # Many countries don&#x27;t use an administrative area in postal addresses. E.g.
797 # in Switzerland this should be left unpopulated.
798 &quot;organization&quot;: &quot;A String&quot;, # Optional. The name of the organization at the address.
799 &quot;addressLines&quot;: [ # Unstructured address lines describing the lower levels of an address.
800 #
801 # Because values in address_lines do not have type information and may
802 # sometimes contain multiple values in a single field (e.g.
803 # &quot;Austin, TX&quot;), it is important that the line order is clear. The order of
804 # address lines should be &quot;envelope order&quot; for the country/region of the
805 # address. In places where this can vary (e.g. Japan), address_language is
806 # used to make it explicit (e.g. &quot;ja&quot; for large-to-small ordering and
807 # &quot;ja-Latn&quot; or &quot;en&quot; for small-to-large). This way, the most specific line of
808 # an address can be selected based on the language.
809 #
810 # The minimum permitted structural representation of an address consists
811 # of a region_code with all remaining information placed in the
812 # address_lines. It would be possible to format such an address very
813 # approximately without geocoding, but no semantic reasoning could be
814 # made about any of the address components until it was at least
815 # partially resolved.
816 #
817 # Creating an address only containing a region_code and address_lines, and
818 # then geocoding is the recommended way to handle completely unstructured
819 # addresses (as opposed to guessing which parts of the address should be
820 # localities or administrative areas).
821 &quot;A String&quot;,
822 ],
823 &quot;regionCode&quot;: &quot;A String&quot;, # Required. CLDR region code of the country/region of the address. This
824 # is never inferred and it is up to the user to ensure the value is
825 # correct. See http://cldr.unicode.org/ and
826 # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html
827 # for details. Example: &quot;CH&quot; for Switzerland.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700828 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700829 &quot;locationType&quot;: &quot;A String&quot;, # The type of a location, which corresponds to the address lines field of
830 # PostalAddress. For example, &quot;Downtown, Atlanta, GA, USA&quot; has a type of
831 # LocationType#NEIGHBORHOOD, and &quot;Kansas City, KS, USA&quot; has a type of
832 # LocationType#LOCALITY.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700833 },
834 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700835 &quot;suspended&quot;: True or False, # Output only. Indicates whether a company is flagged to be suspended from
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700836 # public availability by the service when job content appears suspicious,
837 # abusive, or spammy.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700838 &quot;eeoText&quot;: &quot;A String&quot;, # Optional. Equal Employment Opportunity legal disclaimer text to be
839 # associated with all jobs, and typically to be displayed in all
840 # roles.
841 #
842 # The maximum number of allowed characters is 500.
843 &quot;name&quot;: &quot;A String&quot;, # Required during company update.
844 #
845 # The resource name for a company. This is generated by the service when a
846 # company is created.
847 #
848 # The format is &quot;projects/{project_id}/companies/{company_id}&quot;, for example,
849 # &quot;projects/api-test-project/companies/foo&quot;.
850 &quot;imageUri&quot;: &quot;A String&quot;, # Optional. A URI that hosts the employer&#x27;s company logo.
851 &quot;size&quot;: &quot;A String&quot;, # Optional. The employer&#x27;s company size.
852 &quot;hiringAgency&quot;: True or False, # Optional. Set to true if it is the hiring agency that post jobs for other
853 # employers.
854 #
855 # Defaults to false if not provided.
856 &quot;websiteUri&quot;: &quot;A String&quot;, # Optional. The URI representing the company&#x27;s primary web site or home page,
857 # for example, &quot;https://www.google.com&quot;.
858 #
859 # The maximum number of allowed characters is 255.
860 &quot;externalId&quot;: &quot;A String&quot;, # Required. Client side company identifier, used to uniquely identify the
861 # company.
862 #
863 # The maximum number of allowed characters is 255.
864 &quot;careerSiteUri&quot;: &quot;A String&quot;, # Optional. The URI to employer&#x27;s career site or careers page on the employer&#x27;s web
865 # site, for example, &quot;https://careers.google.com&quot;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700866 },
867 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700868 &quot;metadata&quot;: { # Output only. # Additional information for the API invocation, such as the request
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700869 # tracking id.
870 #
871 # Additional information returned to client, such as debugging information.
Bu Sun Kim65020912020-05-20 12:08:20 -0700872 &quot;requestId&quot;: &quot;A String&quot;, # A unique id associated with this call.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700873 # This id is logged for tracking purposes.
874 },
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
882Args:
883 previous_request: The request for the previous page. (required)
884 previous_response: The response from the request for the previous page. (required)
885
886Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700887 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700888 page. Returns None if there are no more items in the collection.
889 </pre>
890</div>
891
892<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700893 <code class="details" id="patch">patch(name, body=None, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700894 <pre>Updates specified company. Company names can&#x27;t be updated. To update a
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700895company name, delete the company and all jobs associated with it, and only
896then re-create them.
897
898Args:
899 name: string, Required during company update.
900
901The resource name for a company. This is generated by the service when a
902company is created.
903
Bu Sun Kim65020912020-05-20 12:08:20 -0700904The format is &quot;projects/{project_id}/companies/{company_id}&quot;, for example,
905&quot;projects/api-test-project/companies/foo&quot;. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700906 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700907 The object takes the form of:
908
909{ # Input only.
910 #
911 # Request for updating a specified company.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700912 &quot;updateMask&quot;: &quot;A String&quot;, # 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 Kim65020912020-05-20 12:08:20 -0700920 &quot;company&quot;: { # 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 Kim715bd7f2019-06-14 16:50:42 -0700921 # entity that owns job postings, that is, the hiring entity responsible for
922 # employing applicants for the job position.
Bu Sun Kim65020912020-05-20 12:08:20 -0700923 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the company, for example, &quot;Google LLC&quot;.
924 &quot;headquartersAddress&quot;: &quot;A String&quot;, # Optional. The street address of the company&#x27;s main headquarters, which may be
925 # different from the job location. The service attempts
926 # to geolocate the provided address, and populates a more specific
927 # location wherever possible in DerivedInfo.headquarters_location.
928 &quot;keywordSearchableJobCustomAttributes&quot;: [ # Optional. A list of keys of filterable Job.custom_attributes, whose
929 # corresponding `string_values` are used in keyword search. Jobs with
930 # `string_values` under these specified field keys are returned if any
931 # of the values matches the search keyword. Custom field values with
932 # parenthesis, brackets and special symbols won&#x27;t be properly searchable,
933 # and those keyword queries need to be surrounded by quotes.
934 &quot;A String&quot;,
935 ],
936 &quot;derivedInfo&quot;: { # Derived details about the company. # Output only. Derived details about the company.
937 &quot;headquartersLocation&quot;: { # Output only. # A structured headquarters location of the company, resolved from
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700938 # Company.hq_location if provided.
939 #
940 # A resource that represents a location with full geographic information.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700941 &quot;radiusInMiles&quot;: 3.14, # Radius in miles of the job location. This value is derived from the
942 # location bounding box in which a circle with the specified radius
943 # centered from LatLng covers the area associated with the job location.
944 # For example, currently, &quot;Mountain View, CA, USA&quot; has a radius of
945 # 6.17 miles.
Bu Sun Kim65020912020-05-20 12:08:20 -0700946 &quot;latLng&quot;: { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700947 # of doubles representing degrees latitude and degrees longitude. Unless
948 # specified otherwise, this must conform to the
Bu Sun Kim65020912020-05-20 12:08:20 -0700949 # &lt;a href=&quot;http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf&quot;&gt;WGS84
Dan O'Mearadd494642020-05-01 07:42:23 -0700950 # standard&lt;/a&gt;. Values must be within normalized ranges.
Bu Sun Kim65020912020-05-20 12:08:20 -0700951 &quot;longitude&quot;: 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700952 &quot;latitude&quot;: 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700953 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700954 &quot;postalAddress&quot;: { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700955 # such as postal delivery and payments addresses. Given a postal address,
956 # a postal service can deliver items to a premises, P.O. Box, or other
957 # delivery location.
958 # Given a postal address, a postal service can deliver items to a premise, P.O.
959 # Box or similar.
960 # It is not intended to model geographical locations (roads, towns,
961 # mountains).
962 #
963 # In typical usage an address would be created via user input or from importing
964 # existing data, depending on the type of process.
965 #
966 # Advice on address input / editing:
967 # - Use an i18n-ready address widget such as
Dan O'Mearadd494642020-05-01 07:42:23 -0700968 # https://github.com/google/libaddressinput)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700969 # - Users should not be presented with UI elements for input or editing of
970 # fields outside countries where that field is used.
971 #
972 # For more guidance on how to use this schema, please see:
973 # https://support.google.com/business/answer/6397478
Bu Sun Kim65020912020-05-20 12:08:20 -0700974 &quot;postalCode&quot;: &quot;A String&quot;, # Optional. Postal code of the address. Not all countries use or require
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700975 # postal codes to be present, but where they are used, they may trigger
976 # additional validation with other parts of the address (e.g. state/zip
977 # validation in the U.S.A.).
Bu Sun Kim65020912020-05-20 12:08:20 -0700978 &quot;languageCode&quot;: &quot;A String&quot;, # Optional. BCP-47 language code of the contents of this address (if
979 # known). This is often the UI language of the input form or is expected
980 # to match one of the languages used in the address&#x27; country/region, or their
981 # transliterated equivalents.
982 # This can affect formatting in certain countries, but is not critical
983 # to the correctness of the data and will never affect any validation or
984 # other non-formatting related operations.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700985 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700986 # If this value is not known, it should be omitted (rather than specifying a
987 # possibly incorrect default).
988 #
989 # Examples: &quot;zh-Hant&quot;, &quot;ja&quot;, &quot;ja-Latn&quot;, &quot;en&quot;.
990 &quot;sortingCode&quot;: &quot;A String&quot;, # Optional. Additional, country-specific, sorting code. This is not used
991 # in most regions. Where it is used, the value is either a string like
992 # &quot;CEDEX&quot;, optionally followed by a number (e.g. &quot;CEDEX 7&quot;), or just a number
993 # alone, representing the &quot;sector code&quot; (Jamaica), &quot;delivery area indicator&quot;
994 # (Malawi) or &quot;post office indicator&quot; (e.g. Côte d&#x27;Ivoire).
995 &quot;recipients&quot;: [ # Optional. The recipient at the address.
996 # This field may, under certain circumstances, contain multiline information.
997 # For example, it might contain &quot;care of&quot; information.
998 &quot;A String&quot;,
999 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -07001000 &quot;sublocality&quot;: &quot;A String&quot;, # Optional. Sublocality of the address.
1001 # For example, this can be neighborhoods, boroughs, districts.
1002 &quot;revision&quot;: 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is
1003 # the latest revision.
1004 #
1005 # All new revisions **must** be backward compatible with old revisions.
1006 &quot;locality&quot;: &quot;A String&quot;, # Optional. Generally refers to the city/town portion of the address.
1007 # Examples: US city, IT comune, UK post town.
1008 # In regions of the world where localities are not well defined or do not fit
1009 # into this structure well, leave locality empty and use address_lines.
1010 &quot;administrativeArea&quot;: &quot;A String&quot;, # Optional. Highest administrative subdivision which is used for postal
1011 # addresses of a country or region.
1012 # For example, this can be a state, a province, an oblast, or a prefecture.
1013 # Specifically, for Spain this is the province and not the autonomous
1014 # community (e.g. &quot;Barcelona&quot; and not &quot;Catalonia&quot;).
1015 # Many countries don&#x27;t use an administrative area in postal addresses. E.g.
1016 # in Switzerland this should be left unpopulated.
1017 &quot;organization&quot;: &quot;A String&quot;, # Optional. The name of the organization at the address.
1018 &quot;addressLines&quot;: [ # Unstructured address lines describing the lower levels of an address.
1019 #
1020 # Because values in address_lines do not have type information and may
1021 # sometimes contain multiple values in a single field (e.g.
1022 # &quot;Austin, TX&quot;), it is important that the line order is clear. The order of
1023 # address lines should be &quot;envelope order&quot; for the country/region of the
1024 # address. In places where this can vary (e.g. Japan), address_language is
1025 # used to make it explicit (e.g. &quot;ja&quot; for large-to-small ordering and
1026 # &quot;ja-Latn&quot; or &quot;en&quot; for small-to-large). This way, the most specific line of
1027 # an address can be selected based on the language.
1028 #
1029 # The minimum permitted structural representation of an address consists
1030 # of a region_code with all remaining information placed in the
1031 # address_lines. It would be possible to format such an address very
1032 # approximately without geocoding, but no semantic reasoning could be
1033 # made about any of the address components until it was at least
1034 # partially resolved.
1035 #
1036 # Creating an address only containing a region_code and address_lines, and
1037 # then geocoding is the recommended way to handle completely unstructured
1038 # addresses (as opposed to guessing which parts of the address should be
1039 # localities or administrative areas).
1040 &quot;A String&quot;,
1041 ],
1042 &quot;regionCode&quot;: &quot;A String&quot;, # Required. CLDR region code of the country/region of the address. This
1043 # is never inferred and it is up to the user to ensure the value is
1044 # correct. See http://cldr.unicode.org/ and
1045 # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html
1046 # for details. Example: &quot;CH&quot; for Switzerland.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001047 },
Bu Sun Kim65020912020-05-20 12:08:20 -07001048 &quot;locationType&quot;: &quot;A String&quot;, # The type of a location, which corresponds to the address lines field of
1049 # PostalAddress. For example, &quot;Downtown, Atlanta, GA, USA&quot; has a type of
1050 # LocationType#NEIGHBORHOOD, and &quot;Kansas City, KS, USA&quot; has a type of
1051 # LocationType#LOCALITY.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001052 },
1053 },
Bu Sun Kim65020912020-05-20 12:08:20 -07001054 &quot;suspended&quot;: True or False, # Output only. Indicates whether a company is flagged to be suspended from
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001055 # public availability by the service when job content appears suspicious,
1056 # abusive, or spammy.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -07001057 &quot;eeoText&quot;: &quot;A String&quot;, # Optional. Equal Employment Opportunity legal disclaimer text to be
1058 # associated with all jobs, and typically to be displayed in all
1059 # roles.
1060 #
1061 # The maximum number of allowed characters is 500.
1062 &quot;name&quot;: &quot;A String&quot;, # Required during company update.
1063 #
1064 # The resource name for a company. This is generated by the service when a
1065 # company is created.
1066 #
1067 # The format is &quot;projects/{project_id}/companies/{company_id}&quot;, for example,
1068 # &quot;projects/api-test-project/companies/foo&quot;.
1069 &quot;imageUri&quot;: &quot;A String&quot;, # Optional. A URI that hosts the employer&#x27;s company logo.
1070 &quot;size&quot;: &quot;A String&quot;, # Optional. The employer&#x27;s company size.
1071 &quot;hiringAgency&quot;: True or False, # Optional. Set to true if it is the hiring agency that post jobs for other
1072 # employers.
1073 #
1074 # Defaults to false if not provided.
1075 &quot;websiteUri&quot;: &quot;A String&quot;, # Optional. The URI representing the company&#x27;s primary web site or home page,
1076 # for example, &quot;https://www.google.com&quot;.
1077 #
1078 # The maximum number of allowed characters is 255.
1079 &quot;externalId&quot;: &quot;A String&quot;, # Required. Client side company identifier, used to uniquely identify the
1080 # company.
1081 #
1082 # The maximum number of allowed characters is 255.
1083 &quot;careerSiteUri&quot;: &quot;A String&quot;, # Optional. The URI to employer&#x27;s career site or careers page on the employer&#x27;s web
1084 # site, for example, &quot;https://careers.google.com&quot;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001085 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001086 }
1087
1088 x__xgafv: string, V1 error format.
1089 Allowed values
1090 1 - v1 error format
1091 2 - v2 error format
1092
1093Returns:
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 Kim65020912020-05-20 12:08:20 -07001099 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the company, for example, &quot;Google LLC&quot;.
1100 &quot;headquartersAddress&quot;: &quot;A String&quot;, # Optional. The street address of the company&#x27;s main headquarters, which may be
1101 # different from the job location. The service attempts
1102 # to geolocate the provided address, and populates a more specific
1103 # location wherever possible in DerivedInfo.headquarters_location.
1104 &quot;keywordSearchableJobCustomAttributes&quot;: [ # Optional. A list of keys of filterable Job.custom_attributes, whose
1105 # corresponding `string_values` are used in keyword search. Jobs with
1106 # `string_values` under these specified field keys are returned if any
1107 # of the values matches the search keyword. Custom field values with
1108 # parenthesis, brackets and special symbols won&#x27;t be properly searchable,
1109 # and those keyword queries need to be surrounded by quotes.
1110 &quot;A String&quot;,
1111 ],
1112 &quot;derivedInfo&quot;: { # Derived details about the company. # Output only. Derived details about the company.
1113 &quot;headquartersLocation&quot;: { # Output only. # A structured headquarters location of the company, resolved from
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001114 # Company.hq_location if provided.
1115 #
1116 # A resource that represents a location with full geographic information.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -07001117 &quot;radiusInMiles&quot;: 3.14, # Radius in miles of the job location. This value is derived from the
1118 # location bounding box in which a circle with the specified radius
1119 # centered from LatLng covers the area associated with the job location.
1120 # For example, currently, &quot;Mountain View, CA, USA&quot; has a radius of
1121 # 6.17 miles.
Bu Sun Kim65020912020-05-20 12:08:20 -07001122 &quot;latLng&quot;: { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001123 # of doubles representing degrees latitude and degrees longitude. Unless
1124 # specified otherwise, this must conform to the
Bu Sun Kim65020912020-05-20 12:08:20 -07001125 # &lt;a href=&quot;http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf&quot;&gt;WGS84
Dan O'Mearadd494642020-05-01 07:42:23 -07001126 # standard&lt;/a&gt;. Values must be within normalized ranges.
Bu Sun Kim65020912020-05-20 12:08:20 -07001127 &quot;longitude&quot;: 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -07001128 &quot;latitude&quot;: 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001129 },
Bu Sun Kim65020912020-05-20 12:08:20 -07001130 &quot;postalAddress&quot;: { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001131 # such as postal delivery and payments addresses. Given a postal address,
1132 # a postal service can deliver items to a premises, P.O. Box, or other
1133 # delivery location.
1134 # Given a postal address, a postal service can deliver items to a premise, P.O.
1135 # Box or similar.
1136 # It is not intended to model geographical locations (roads, towns,
1137 # mountains).
1138 #
1139 # In typical usage an address would be created via user input or from importing
1140 # existing data, depending on the type of process.
1141 #
1142 # Advice on address input / editing:
1143 # - Use an i18n-ready address widget such as
Dan O'Mearadd494642020-05-01 07:42:23 -07001144 # https://github.com/google/libaddressinput)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001145 # - Users should not be presented with UI elements for input or editing of
1146 # fields outside countries where that field is used.
1147 #
1148 # For more guidance on how to use this schema, please see:
1149 # https://support.google.com/business/answer/6397478
Bu Sun Kim65020912020-05-20 12:08:20 -07001150 &quot;postalCode&quot;: &quot;A String&quot;, # Optional. Postal code of the address. Not all countries use or require
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001151 # postal codes to be present, but where they are used, they may trigger
1152 # additional validation with other parts of the address (e.g. state/zip
1153 # validation in the U.S.A.).
Bu Sun Kim65020912020-05-20 12:08:20 -07001154 &quot;languageCode&quot;: &quot;A String&quot;, # Optional. BCP-47 language code of the contents of this address (if
1155 # known). This is often the UI language of the input form or is expected
1156 # to match one of the languages used in the address&#x27; country/region, or their
1157 # transliterated equivalents.
1158 # This can affect formatting in certain countries, but is not critical
1159 # to the correctness of the data and will never affect any validation or
1160 # other non-formatting related operations.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001161 #
Bu Sun Kim65020912020-05-20 12:08:20 -07001162 # If this value is not known, it should be omitted (rather than specifying a
1163 # possibly incorrect default).
1164 #
1165 # Examples: &quot;zh-Hant&quot;, &quot;ja&quot;, &quot;ja-Latn&quot;, &quot;en&quot;.
1166 &quot;sortingCode&quot;: &quot;A String&quot;, # Optional. Additional, country-specific, sorting code. This is not used
1167 # in most regions. Where it is used, the value is either a string like
1168 # &quot;CEDEX&quot;, optionally followed by a number (e.g. &quot;CEDEX 7&quot;), or just a number
1169 # alone, representing the &quot;sector code&quot; (Jamaica), &quot;delivery area indicator&quot;
1170 # (Malawi) or &quot;post office indicator&quot; (e.g. Côte d&#x27;Ivoire).
1171 &quot;recipients&quot;: [ # Optional. The recipient at the address.
1172 # This field may, under certain circumstances, contain multiline information.
1173 # For example, it might contain &quot;care of&quot; information.
1174 &quot;A String&quot;,
1175 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -07001176 &quot;sublocality&quot;: &quot;A String&quot;, # Optional. Sublocality of the address.
1177 # For example, this can be neighborhoods, boroughs, districts.
1178 &quot;revision&quot;: 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is
1179 # the latest revision.
1180 #
1181 # All new revisions **must** be backward compatible with old revisions.
1182 &quot;locality&quot;: &quot;A String&quot;, # Optional. Generally refers to the city/town portion of the address.
1183 # Examples: US city, IT comune, UK post town.
1184 # In regions of the world where localities are not well defined or do not fit
1185 # into this structure well, leave locality empty and use address_lines.
1186 &quot;administrativeArea&quot;: &quot;A String&quot;, # Optional. Highest administrative subdivision which is used for postal
1187 # addresses of a country or region.
1188 # For example, this can be a state, a province, an oblast, or a prefecture.
1189 # Specifically, for Spain this is the province and not the autonomous
1190 # community (e.g. &quot;Barcelona&quot; and not &quot;Catalonia&quot;).
1191 # Many countries don&#x27;t use an administrative area in postal addresses. E.g.
1192 # in Switzerland this should be left unpopulated.
1193 &quot;organization&quot;: &quot;A String&quot;, # Optional. The name of the organization at the address.
1194 &quot;addressLines&quot;: [ # Unstructured address lines describing the lower levels of an address.
1195 #
1196 # Because values in address_lines do not have type information and may
1197 # sometimes contain multiple values in a single field (e.g.
1198 # &quot;Austin, TX&quot;), it is important that the line order is clear. The order of
1199 # address lines should be &quot;envelope order&quot; for the country/region of the
1200 # address. In places where this can vary (e.g. Japan), address_language is
1201 # used to make it explicit (e.g. &quot;ja&quot; for large-to-small ordering and
1202 # &quot;ja-Latn&quot; or &quot;en&quot; for small-to-large). This way, the most specific line of
1203 # an address can be selected based on the language.
1204 #
1205 # The minimum permitted structural representation of an address consists
1206 # of a region_code with all remaining information placed in the
1207 # address_lines. It would be possible to format such an address very
1208 # approximately without geocoding, but no semantic reasoning could be
1209 # made about any of the address components until it was at least
1210 # partially resolved.
1211 #
1212 # Creating an address only containing a region_code and address_lines, and
1213 # then geocoding is the recommended way to handle completely unstructured
1214 # addresses (as opposed to guessing which parts of the address should be
1215 # localities or administrative areas).
1216 &quot;A String&quot;,
1217 ],
1218 &quot;regionCode&quot;: &quot;A String&quot;, # Required. CLDR region code of the country/region of the address. This
1219 # is never inferred and it is up to the user to ensure the value is
1220 # correct. See http://cldr.unicode.org/ and
1221 # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html
1222 # for details. Example: &quot;CH&quot; for Switzerland.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001223 },
Bu Sun Kim65020912020-05-20 12:08:20 -07001224 &quot;locationType&quot;: &quot;A String&quot;, # The type of a location, which corresponds to the address lines field of
1225 # PostalAddress. For example, &quot;Downtown, Atlanta, GA, USA&quot; has a type of
1226 # LocationType#NEIGHBORHOOD, and &quot;Kansas City, KS, USA&quot; has a type of
1227 # LocationType#LOCALITY.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001228 },
1229 },
Bu Sun Kim65020912020-05-20 12:08:20 -07001230 &quot;suspended&quot;: True or False, # Output only. Indicates whether a company is flagged to be suspended from
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001231 # public availability by the service when job content appears suspicious,
1232 # abusive, or spammy.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -07001233 &quot;eeoText&quot;: &quot;A String&quot;, # Optional. Equal Employment Opportunity legal disclaimer text to be
1234 # associated with all jobs, and typically to be displayed in all
1235 # roles.
1236 #
1237 # The maximum number of allowed characters is 500.
1238 &quot;name&quot;: &quot;A String&quot;, # Required during company update.
1239 #
1240 # The resource name for a company. This is generated by the service when a
1241 # company is created.
1242 #
1243 # The format is &quot;projects/{project_id}/companies/{company_id}&quot;, for example,
1244 # &quot;projects/api-test-project/companies/foo&quot;.
1245 &quot;imageUri&quot;: &quot;A String&quot;, # Optional. A URI that hosts the employer&#x27;s company logo.
1246 &quot;size&quot;: &quot;A String&quot;, # Optional. The employer&#x27;s company size.
1247 &quot;hiringAgency&quot;: True or False, # Optional. Set to true if it is the hiring agency that post jobs for other
1248 # employers.
1249 #
1250 # Defaults to false if not provided.
1251 &quot;websiteUri&quot;: &quot;A String&quot;, # Optional. The URI representing the company&#x27;s primary web site or home page,
1252 # for example, &quot;https://www.google.com&quot;.
1253 #
1254 # The maximum number of allowed characters is 255.
1255 &quot;externalId&quot;: &quot;A String&quot;, # Required. Client side company identifier, used to uniquely identify the
1256 # company.
1257 #
1258 # The maximum number of allowed characters is 255.
1259 &quot;careerSiteUri&quot;: &quot;A String&quot;, # Optional. The URI to employer&#x27;s career site or careers page on the employer&#x27;s web
1260 # site, for example, &quot;https://careers.google.com&quot;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001261 }</pre>
1262</div>
1263
1264</body></html>