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