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