Blame - docs/dyn/jobs_v2.companies.html - platform/external/python/google-api-python-client

2019-06-14 16:50:42 -0700

[diff] [blame]

194

# such as postal delivery and payments addresses. Given a postal address,

195

# a postal service can deliver items to a premises, P.O. Box, or other

196

# delivery location.

197

# Given a postal address, a postal service can deliver items to a premise, P.O.

198

# Box or similar.

199

# It is not intended to model geographical locations (roads, towns,

200

# mountains).

201

#

202

# In typical usage an address would be created via user input or from importing

203

# existing data, depending on the type of process.

204

#

205

# Advice on address input / editing:

206

# - Use an i18n-ready address widget such as

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

207

# https://github.com/google/libaddressinput)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

208

# - Users should not be presented with UI elements for input or editing of

209

# fields outside countries where that field is used.

210

#

211

# For more guidance on how to use this schema, please see:

212

# https://support.google.com/business/answer/6397478

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

213

"locality": "A String", # Optional. Generally refers to the city/town portion of the address.

214

# Examples: US city, IT comune, UK post town.

215

# In regions of the world where localities are not well defined or do not fit

216

# into this structure well, leave locality empty and use address_lines.

217

"administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal

218

# addresses of a country or region.

219

# For example, this can be a state, a province, an oblast, or a prefecture.

220

# Specifically, for Spain this is the province and not the autonomous

221

# community (e.g. "Barcelona" and not "Catalonia").

222

# Many countries don't use an administrative area in postal addresses. E.g.

223

# in Switzerland this should be left unpopulated.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

224

"organization": "A String", # Optional. The name of the organization at the address.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

225

"addressLines": [ # Unstructured address lines describing the lower levels of an address.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

226

#

227

# Because values in address_lines do not have type information and may

228

# sometimes contain multiple values in a single field (e.g.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

229

# "Austin, TX"), it is important that the line order is clear. The order of

230

# address lines should be "envelope order" for the country/region of the

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

231

# address. In places where this can vary (e.g. Japan), address_language is

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

232

# used to make it explicit (e.g. "ja" for large-to-small ordering and

233

# "ja-Latn" or "en" for small-to-large). This way, the most specific line of

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

234

# an address can be selected based on the language.

235

#

236

# The minimum permitted structural representation of an address consists

237

# of a region_code with all remaining information placed in the

238

# address_lines. It would be possible to format such an address very

239

# approximately without geocoding, but no semantic reasoning could be

240

# made about any of the address components until it was at least

241

# partially resolved.

242

#

243

# Creating an address only containing a region_code and address_lines, and

244

# then geocoding is the recommended way to handle completely unstructured

245

# addresses (as opposed to guessing which parts of the address should be

246

# localities or administrative areas).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

247

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

248

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

249

"regionCode": "A String", # Required. CLDR region code of the country/region of the address. This

250

# is never inferred and it is up to the user to ensure the value is

251

# correct. See http://cldr.unicode.org/ and

252

# http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html

253

# for details. Example: "CH" for Switzerland.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

254

"postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

255

# postal codes to be present, but where they are used, they may trigger

256

# additional validation with other parts of the address (e.g. state/zip

257

# validation in the U.S.A.).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

258

"sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used

259

# in most regions. Where it is used, the value is either a string like

260

# "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number

261

# alone, representing the "sector code" (Jamaica), "delivery area indicator"

262

# (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

263

"languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if

264

# known). This is often the UI language of the input form or is expected

265

# to match one of the languages used in the address' country/region, or their

266

# transliterated equivalents.

267

# This can affect formatting in certain countries, but is not critical

268

# to the correctness of the data and will never affect any validation or

269

# other non-formatting related operations.

270

#

271

# If this value is not known, it should be omitted (rather than specifying a

272

# possibly incorrect default).

273

#

274

# Examples: "zh-Hant", "ja", "ja-Latn", "en".

275

"recipients": [ # Optional. The recipient at the address.

276

# This field may, under certain circumstances, contain multiline information.

277

# For example, it might contain "care of" information.

278

"A String",

279

],

280

"sublocality": "A String", # Optional. Sublocality of the address.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

281

# For example, this can be neighborhoods, boroughs, districts.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

282

"revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

283

# the latest revision.

284

#

285

# All new revisions **must** be backward compatible with old revisions.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

286

},

287

"locationType": "A String", # The type of a location, which corresponds to the address lines field of

288

# PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of

289

# LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of

290

# LocationType#LOCALITY.

291

"radiusMeters": 3.14, # Radius in meters of the job location. This value is derived from the

292

# location bounding box in which a circle with the specified radius

293

# centered from LatLng coves the area associated with the job location.

294

# For example, currently, "Mountain View, CA, USA" has a radius of

295

# 7885.79 meters.

296

"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.

297

# of doubles representing degrees latitude and degrees longitude. Unless

298

# specified otherwise, this must conform to the

299

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

300

# standard</a>. Values must be within normalized ranges.

301

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

302

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

303

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

304

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

305

"hiringAgency": True or False, # Optional. Set to true if it is the hiring agency that post jobs for other

306

# employers.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

307

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

308

# Defaults to false if not provided.

309

"title": "A String", # Deprecated. Use display_name instead.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

310

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

311

# Required.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

312

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

313

# The name of the employer to be displayed with the job,

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

314

# for example, "Google, LLC.".

315

"displayName": "A String", # Required. The name of the employer to be displayed with the job,

316

# for example, "Google, LLC.".

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

317

}

318

319

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

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.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

330

"website": "A String", # Optional. The URL representing the company's primary web site or home page,

331

# such as, "www.google.com".

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

332

"hqLocation": "A String", # Optional. The street address of the company's main headquarters, which may be

333

# different from the job location. The service attempts

334

# to geolocate the provided address, and populates a more specific

335

# location wherever possible in structured_company_hq_location.

336

"companyInfoSources": [ # Optional. Identifiers external to the application that help to further identify

337

# the employer.

338

{ # A resource that represents an external Google identifier for a company,

339

# for example, a Google+ business page or a Google Maps business page.

340

# For unsupported types, use `unknown_type_id`.

341

"mapsCid": "A String", # Optional. The numeric identifier for the employer's headquarters on Google Maps,

342

# namely, the Google Maps CID (cell id).

343

"freebaseMid": "A String", # Optional. The Google's Knowledge Graph value for the employer's company.

344

"unknownTypeId": "A String", # Optional. A Google identifier that does not match any of the other types.

345

"gplusId": "A String", # Optional. The numeric identifier for the employer's Google+ business page.

346

},

347

],

348

"keywordSearchableCustomAttributes": [ # Optional. A list of keys of filterable Job.custom_attributes, whose

349

# corresponding `string_values` are used in keyword search. Jobs with

350

# `string_values` under these specified field keys are returned if any

351

# of the values matches the search keyword. Custom field values with

352

# parenthesis, brackets and special symbols might not be properly searchable,

353

# and those keyword queries need to be surrounded by quotes.

354

"A String",

355

],

356

"suspended": True or False, # Output only. Indicates whether a company is flagged to be suspended from public

357

# availability by the service when job content appears suspicious,

358

# abusive, or spammy.

359

"imageUrl": "A String", # Optional. A URL that hosts the employer's company logo. If provided,

360

# the logo image should be squared at 80x80 pixels.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

361

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

362

# The url must be a Google Photos or Google Album url.

363

# Only images in these Google sub-domains are accepted.

364

"distributorBillingCompanyId": "A String", # Optional. The unique company identifier provided by the client to identify an

365

# employer for billing purposes. Recommended practice is to use

366

# the distributor_company_id.

367

#

368

# Defaults to same value as distributor_company_id when a value

369

# is not provided.

370

"careerPageLink": "A String", # Optional. The URL to employer's career site or careers page on the employer's web

371

# site.

372

"keywordSearchableCustomFields": [ # Deprecated. Use keyword_searchable_custom_attributes instead.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

373

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

374

# Optional.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

375

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

376

# A list of filterable custom fields that should be used in keyword

377

# search. The jobs of this company are returned if any of these custom

378

# fields matches the search keyword. Custom field values with parenthesis,

379

# brackets and special symbols might not be properly searchable, and those

380

# keyword queries need to be surrounded by quotes.

381

42,

382

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

383

"disableLocationOptimization": True or False, # Deprecated. Do not use this field.

#

# Optional.

#

# This field is no longer used. Any value set to it is ignored.

388

"companySize": "A String", # Optional. The employer's company size.

389

"eeoText": "A String", # Optional. Equal Employment Opportunity legal disclaimer text to be

390

# associated with all jobs, and typically to be displayed in all

391

# roles.

392

#

393

# The maximum number of allowed characters is 500.

394

"name": "A String", # Required during company update.

395

#

396

# The resource name for a company. This is generated by the service when a

397

# company is created, for example,

398

# "companies/0000aaaa-1111-bbbb-2222-cccc3333dddd".

399

"distributorCompanyId": "A String", # Required. A client's company identifier, used to uniquely identify the

400

# company. If an employer has a subsidiary or sub-brand, such as "Alphabet"

401

# and "Google", which the client wishes to use as the company displayed on

402

# the job. Best practice is to create a distinct company identifier for each

403

# distinct brand displayed.

404

#

405

# The maximum number of allowed characters is 255.

406

"structuredCompanyHqLocation": { # Output only. # Output only. A structured headquarters location of the company,

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

407

# resolved from hq_location if possible.

408

#

409

# A resource that represents a location with full geographic

410

# information.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

411

"postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information,

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

412

# such as postal delivery and payments addresses. Given a postal address,

413

# a postal service can deliver items to a premises, P.O. Box, or other

414

# delivery location.

415

# Given a postal address, a postal service can deliver items to a premise, P.O.

416

# Box or similar.

417

# It is not intended to model geographical locations (roads, towns,

418

# mountains).

419

#

420

# In typical usage an address would be created via user input or from importing

421

# existing data, depending on the type of process.

422

#

423

# Advice on address input / editing:

424

# - Use an i18n-ready address widget such as

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

425

# https://github.com/google/libaddressinput)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

426

# - Users should not be presented with UI elements for input or editing of

427

# fields outside countries where that field is used.

428

#

429

# For more guidance on how to use this schema, please see:

430

# https://support.google.com/business/answer/6397478

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

431

"locality": "A String", # Optional. Generally refers to the city/town portion of the address.

432

# Examples: US city, IT comune, UK post town.

433

# In regions of the world where localities are not well defined or do not fit

434

# into this structure well, leave locality empty and use address_lines.

435

"administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal

436

# addresses of a country or region.

437

# For example, this can be a state, a province, an oblast, or a prefecture.

438

# Specifically, for Spain this is the province and not the autonomous

439

# community (e.g. "Barcelona" and not "Catalonia").

440

# Many countries don't use an administrative area in postal addresses. E.g.

441

# in Switzerland this should be left unpopulated.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

442

"organization": "A String", # Optional. The name of the organization at the address.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

443

"addressLines": [ # Unstructured address lines describing the lower levels of an address.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

444

#

445

# Because values in address_lines do not have type information and may

446

# sometimes contain multiple values in a single field (e.g.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

447

# "Austin, TX"), it is important that the line order is clear. The order of

448

# address lines should be "envelope order" for the country/region of the

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

449

# address. In places where this can vary (e.g. Japan), address_language is

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

450

# used to make it explicit (e.g. "ja" for large-to-small ordering and

451

# "ja-Latn" or "en" for small-to-large). This way, the most specific line of

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

452

# an address can be selected based on the language.

453

#

454

# The minimum permitted structural representation of an address consists

455

# of a region_code with all remaining information placed in the

456

# address_lines. It would be possible to format such an address very

457

# approximately without geocoding, but no semantic reasoning could be

458

# made about any of the address components until it was at least

459

# partially resolved.

460

#

461

# Creating an address only containing a region_code and address_lines, and

462

# then geocoding is the recommended way to handle completely unstructured

463

# addresses (as opposed to guessing which parts of the address should be

464

# localities or administrative areas).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

465

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

466

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

467

"regionCode": "A String", # Required. CLDR region code of the country/region of the address. This

468

# is never inferred and it is up to the user to ensure the value is

469

# correct. See http://cldr.unicode.org/ and

470

# http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html

471

# for details. Example: "CH" for Switzerland.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

472

"postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

473

# postal codes to be present, but where they are used, they may trigger

474

# additional validation with other parts of the address (e.g. state/zip

475

# validation in the U.S.A.).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

476

"sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used

477

# in most regions. Where it is used, the value is either a string like

478

# "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number

479

# alone, representing the "sector code" (Jamaica), "delivery area indicator"

480

# (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

481

"languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if

482

# known). This is often the UI language of the input form or is expected

483

# to match one of the languages used in the address' country/region, or their

484

# transliterated equivalents.

485

# This can affect formatting in certain countries, but is not critical

486

# to the correctness of the data and will never affect any validation or

487

# other non-formatting related operations.

488

#

489

# If this value is not known, it should be omitted (rather than specifying a

490

# possibly incorrect default).

491

#

492

# Examples: "zh-Hant", "ja", "ja-Latn", "en".

493

"recipients": [ # Optional. The recipient at the address.

494

# This field may, under certain circumstances, contain multiline information.

495

# For example, it might contain "care of" information.

496

"A String",

497

],

498

"sublocality": "A String", # Optional. Sublocality of the address.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

499

# For example, this can be neighborhoods, boroughs, districts.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

500

"revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

501

# the latest revision.

502

#

503

# All new revisions **must** be backward compatible with old revisions.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

504

},

505

"locationType": "A String", # The type of a location, which corresponds to the address lines field of

506

# PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of

507

# LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of

508

# LocationType#LOCALITY.

509

"radiusMeters": 3.14, # Radius in meters of the job location. This value is derived from the

510

# location bounding box in which a circle with the specified radius

511

# centered from LatLng coves the area associated with the job location.

512

# For example, currently, "Mountain View, CA, USA" has a radius of

513

# 7885.79 meters.

514

"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.

515

# of doubles representing degrees latitude and degrees longitude. Unless

516

# specified otherwise, this must conform to the

517

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

518

# standard</a>. Values must be within normalized ranges.

519

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

520

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

521

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

522

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

523

"hiringAgency": True or False, # Optional. Set to true if it is the hiring agency that post jobs for other

524

# employers.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

525

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

526

# Defaults to false if not provided.

527

"title": "A String", # Deprecated. Use display_name instead.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

528

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

529

# Required.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

530

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

531

# The name of the employer to be displayed with the job,

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

532

# for example, "Google, LLC.".

533

"displayName": "A String", # Required. The name of the employer to be displayed with the job,

534

# for example, "Google, LLC.".

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="delete">delete(name, x__xgafv=None)</code>

540

<pre>Deletes the specified company.

541

542

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

543

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

544

such as, "companies/0000aaaa-1111-bbbb-2222-cccc3333dddd". (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

545

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

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 `{}`.

}</pre>

</div>

<code class="details" id="get">get(name, x__xgafv=None)</code>

567

<pre>Retrieves the specified company.

568

569

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

570

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

571

such as "companies/0000aaaa-1111-bbbb-2222-cccc3333dddd". (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

572

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

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.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

583

"website": "A String", # Optional. The URL representing the company's primary web site or home page,

584

# such as, "www.google.com".

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

585

"hqLocation": "A String", # Optional. The street address of the company's main headquarters, which may be

586

# different from the job location. The service attempts

587

# to geolocate the provided address, and populates a more specific

588

# location wherever possible in structured_company_hq_location.

589

"companyInfoSources": [ # Optional. Identifiers external to the application that help to further identify

590

# the employer.

591

{ # A resource that represents an external Google identifier for a company,

592

# for example, a Google+ business page or a Google Maps business page.

593

# For unsupported types, use `unknown_type_id`.

594

"mapsCid": "A String", # Optional. The numeric identifier for the employer's headquarters on Google Maps,

595

# namely, the Google Maps CID (cell id).

596

"freebaseMid": "A String", # Optional. The Google's Knowledge Graph value for the employer's company.

597

"unknownTypeId": "A String", # Optional. A Google identifier that does not match any of the other types.

598

"gplusId": "A String", # Optional. The numeric identifier for the employer's Google+ business page.

599

},

600

],

601

"keywordSearchableCustomAttributes": [ # Optional. A list of keys of filterable Job.custom_attributes, whose

602

# corresponding `string_values` are used in keyword search. Jobs with

603

# `string_values` under these specified field keys are returned if any

604

# of the values matches the search keyword. Custom field values with

605

# parenthesis, brackets and special symbols might not be properly searchable,

606

# and those keyword queries need to be surrounded by quotes.

607

"A String",

608

],

609

"suspended": True or False, # Output only. Indicates whether a company is flagged to be suspended from public

610

# availability by the service when job content appears suspicious,

611

# abusive, or spammy.

612

"imageUrl": "A String", # Optional. A URL that hosts the employer's company logo. If provided,

613

# the logo image should be squared at 80x80 pixels.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

614

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

615

# The url must be a Google Photos or Google Album url.

616

# Only images in these Google sub-domains are accepted.

617

"distributorBillingCompanyId": "A String", # Optional. The unique company identifier provided by the client to identify an

618

# employer for billing purposes. Recommended practice is to use

619

# the distributor_company_id.

620

#

621

# Defaults to same value as distributor_company_id when a value

622

# is not provided.

623

"careerPageLink": "A String", # Optional. The URL to employer's career site or careers page on the employer's web

624

# site.

625

"keywordSearchableCustomFields": [ # Deprecated. Use keyword_searchable_custom_attributes instead.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

626

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

627

# Optional.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

628

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

629

# A list of filterable custom fields that should be used in keyword

630

# search. The jobs of this company are returned if any of these custom

631

# fields matches the search keyword. Custom field values with parenthesis,

632

# brackets and special symbols might not be properly searchable, and those

633

# keyword queries need to be surrounded by quotes.

634

42,

635

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

636

"disableLocationOptimization": True or False, # Deprecated. Do not use this field.

#

# Optional.

#

# This field is no longer used. Any value set to it is ignored.

641

"companySize": "A String", # Optional. The employer's company size.

642

"eeoText": "A String", # Optional. Equal Employment Opportunity legal disclaimer text to be

643

# associated with all jobs, and typically to be displayed in all

644

# roles.

645

#

646

# The maximum number of allowed characters is 500.

647

"name": "A String", # Required during company update.

648

#

649

# The resource name for a company. This is generated by the service when a

650

# company is created, for example,

651

# "companies/0000aaaa-1111-bbbb-2222-cccc3333dddd".

652

"distributorCompanyId": "A String", # Required. A client's company identifier, used to uniquely identify the

653

# company. If an employer has a subsidiary or sub-brand, such as "Alphabet"

654

# and "Google", which the client wishes to use as the company displayed on

655

# the job. Best practice is to create a distinct company identifier for each

656

# distinct brand displayed.

657

#

658

# The maximum number of allowed characters is 255.

659

"structuredCompanyHqLocation": { # Output only. # Output only. A structured headquarters location of the company,

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

660

# resolved from hq_location if possible.

661

#

662

# A resource that represents a location with full geographic

663

# information.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

664

"postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information,

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

665

# such as postal delivery and payments addresses. Given a postal address,

666

# a postal service can deliver items to a premises, P.O. Box, or other

667

# delivery location.

668

# Given a postal address, a postal service can deliver items to a premise, P.O.

669

# Box or similar.

670

# It is not intended to model geographical locations (roads, towns,

671

# mountains).

672

#

673

# In typical usage an address would be created via user input or from importing

674

# existing data, depending on the type of process.

675

#

676

# Advice on address input / editing:

677

# - Use an i18n-ready address widget such as

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

678

# https://github.com/google/libaddressinput)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

679

# - Users should not be presented with UI elements for input or editing of

680

# fields outside countries where that field is used.

681

#

682

# For more guidance on how to use this schema, please see:

683

# https://support.google.com/business/answer/6397478

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

684

"locality": "A String", # Optional. Generally refers to the city/town portion of the address.

685

# Examples: US city, IT comune, UK post town.

686

# In regions of the world where localities are not well defined or do not fit

687

# into this structure well, leave locality empty and use address_lines.

688

"administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal

689

# addresses of a country or region.

690

# For example, this can be a state, a province, an oblast, or a prefecture.

691

# Specifically, for Spain this is the province and not the autonomous

692

# community (e.g. "Barcelona" and not "Catalonia").

693

# Many countries don't use an administrative area in postal addresses. E.g.

694

# in Switzerland this should be left unpopulated.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

695

"organization": "A String", # Optional. The name of the organization at the address.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

696

"addressLines": [ # Unstructured address lines describing the lower levels of an address.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

697

#

698

# Because values in address_lines do not have type information and may

699

# sometimes contain multiple values in a single field (e.g.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

700

# "Austin, TX"), it is important that the line order is clear. The order of

701

# address lines should be "envelope order" for the country/region of the

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

702

# address. In places where this can vary (e.g. Japan), address_language is

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

703

# used to make it explicit (e.g. "ja" for large-to-small ordering and

704

# "ja-Latn" or "en" for small-to-large). This way, the most specific line of

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

705

# an address can be selected based on the language.

706

#

707

# The minimum permitted structural representation of an address consists

708

# of a region_code with all remaining information placed in the

709

# address_lines. It would be possible to format such an address very

710

# approximately without geocoding, but no semantic reasoning could be

711

# made about any of the address components until it was at least

712

# partially resolved.

713

#

714

# Creating an address only containing a region_code and address_lines, and

715

# then geocoding is the recommended way to handle completely unstructured

716

# addresses (as opposed to guessing which parts of the address should be

717

# localities or administrative areas).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

718

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

719

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

720

"regionCode": "A String", # Required. CLDR region code of the country/region of the address. This

721

# is never inferred and it is up to the user to ensure the value is

722

# correct. See http://cldr.unicode.org/ and

723

# http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html

724

# for details. Example: "CH" for Switzerland.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

725

"postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

726

# postal codes to be present, but where they are used, they may trigger

727

# additional validation with other parts of the address (e.g. state/zip

728

# validation in the U.S.A.).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

729

"sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used

730

# in most regions. Where it is used, the value is either a string like

731

# "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number

732

# alone, representing the "sector code" (Jamaica), "delivery area indicator"

733

# (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

734

"languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if

735

# known). This is often the UI language of the input form or is expected

736

# to match one of the languages used in the address' country/region, or their

737

# transliterated equivalents.

738

# This can affect formatting in certain countries, but is not critical

739

# to the correctness of the data and will never affect any validation or

740

# other non-formatting related operations.

741

#

742

# If this value is not known, it should be omitted (rather than specifying a

743

# possibly incorrect default).

744

#

745

# Examples: "zh-Hant", "ja", "ja-Latn", "en".

746

"recipients": [ # Optional. The recipient at the address.

747

# This field may, under certain circumstances, contain multiline information.

748

# For example, it might contain "care of" information.

749

"A String",

750

],

751

"sublocality": "A String", # Optional. Sublocality of the address.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

752

# For example, this can be neighborhoods, boroughs, districts.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

753

"revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

754

# the latest revision.

755

#

756

# All new revisions **must** be backward compatible with old revisions.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

757

},

758

"locationType": "A String", # The type of a location, which corresponds to the address lines field of

759

# PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of

760

# LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of

761

# LocationType#LOCALITY.

762

"radiusMeters": 3.14, # Radius in meters of the job location. This value is derived from the

763

# location bounding box in which a circle with the specified radius

764

# centered from LatLng coves the area associated with the job location.

765

# For example, currently, "Mountain View, CA, USA" has a radius of

766

# 7885.79 meters.

767

"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.

768

# of doubles representing degrees latitude and degrees longitude. Unless

769

# specified otherwise, this must conform to the

770

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

771

# standard</a>. Values must be within normalized ranges.

772

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

773

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

774

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

775

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

776

"hiringAgency": True or False, # Optional. Set to true if it is the hiring agency that post jobs for other

777

# employers.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

778

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

779

# Defaults to false if not provided.

780

"title": "A String", # Deprecated. Use display_name instead.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

781

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

782

# Required.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

783

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

784

# The name of the employer to be displayed with the job,

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

785

# for example, "Google, LLC.".

786

"displayName": "A String", # Required. The name of the employer to be displayed with the job,

787

# for example, "Google, LLC.".

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

792

<code class="details" id="list">list(pageToken=None, pageSize=None, mustHaveOpenJobs=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

793

<pre>Lists all companies associated with a Cloud Talent Solution account.

794

795

Args:

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

796

pageToken: string, Optional. The starting indicator from which to return results.

797

pageSize: integer, Optional. The maximum number of companies to be returned, at most 100.

798

Default is 100 if a non-positive number is provided.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

799

mustHaveOpenJobs: boolean, Optional. Set to true if the companies request must have open jobs.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

Defaults to false.

If true, at most page_size of companies are fetched, among which

804

only those with open jobs are returned.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

805

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

{ # Output only.

#

# The List companies response object.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

816

"nextPageToken": "A String", # A token to retrieve the next page of results.

817

"companies": [ # Companies for the current client.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

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.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

821

"website": "A String", # Optional. The URL representing the company's primary web site or home page,

822

# such as, "www.google.com".

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

823

"hqLocation": "A String", # Optional. The street address of the company's main headquarters, which may be

824

# different from the job location. The service attempts

825

# to geolocate the provided address, and populates a more specific

826

# location wherever possible in structured_company_hq_location.

827

"companyInfoSources": [ # Optional. Identifiers external to the application that help to further identify

828

# the employer.

829

{ # A resource that represents an external Google identifier for a company,

830

# for example, a Google+ business page or a Google Maps business page.

831

# For unsupported types, use `unknown_type_id`.

832

"mapsCid": "A String", # Optional. The numeric identifier for the employer's headquarters on Google Maps,

833

# namely, the Google Maps CID (cell id).

834

"freebaseMid": "A String", # Optional. The Google's Knowledge Graph value for the employer's company.

835

"unknownTypeId": "A String", # Optional. A Google identifier that does not match any of the other types.

836

"gplusId": "A String", # Optional. The numeric identifier for the employer's Google+ business page.

837

},

838

],

839

"keywordSearchableCustomAttributes": [ # Optional. A list of keys of filterable Job.custom_attributes, whose

840

# corresponding `string_values` are used in keyword search. Jobs with

841

# `string_values` under these specified field keys are returned if any

842

# of the values matches the search keyword. Custom field values with

843

# parenthesis, brackets and special symbols might not be properly searchable,

844

# and those keyword queries need to be surrounded by quotes.

845

"A String",

846

],

847

"suspended": True or False, # Output only. Indicates whether a company is flagged to be suspended from public

848

# availability by the service when job content appears suspicious,

849

# abusive, or spammy.

850

"imageUrl": "A String", # Optional. A URL that hosts the employer's company logo. If provided,

851

# the logo image should be squared at 80x80 pixels.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

852

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

853

# The url must be a Google Photos or Google Album url.

854

# Only images in these Google sub-domains are accepted.

855

"distributorBillingCompanyId": "A String", # Optional. The unique company identifier provided by the client to identify an

856

# employer for billing purposes. Recommended practice is to use

857

# the distributor_company_id.

858

#

859

# Defaults to same value as distributor_company_id when a value

860

# is not provided.

861

"careerPageLink": "A String", # Optional. The URL to employer's career site or careers page on the employer's web

862

# site.

863

"keywordSearchableCustomFields": [ # Deprecated. Use keyword_searchable_custom_attributes instead.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

864

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

865

# Optional.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

866

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

867

# A list of filterable custom fields that should be used in keyword

868

# search. The jobs of this company are returned if any of these custom

869

# fields matches the search keyword. Custom field values with parenthesis,

870

# brackets and special symbols might not be properly searchable, and those

871

# keyword queries need to be surrounded by quotes.

872

42,

873

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

874

"disableLocationOptimization": True or False, # Deprecated. Do not use this field.

#

# Optional.

#

# This field is no longer used. Any value set to it is ignored.

879

"companySize": "A String", # Optional. The employer's company size.

880

"eeoText": "A String", # Optional. Equal Employment Opportunity legal disclaimer text to be

881

# associated with all jobs, and typically to be displayed in all

882

# roles.

883

#

884

# The maximum number of allowed characters is 500.

885

"name": "A String", # Required during company update.

886

#

887

# The resource name for a company. This is generated by the service when a

888

# company is created, for example,

889

# "companies/0000aaaa-1111-bbbb-2222-cccc3333dddd".

890

"distributorCompanyId": "A String", # Required. A client's company identifier, used to uniquely identify the

891

# company. If an employer has a subsidiary or sub-brand, such as "Alphabet"

892

# and "Google", which the client wishes to use as the company displayed on

893

# the job. Best practice is to create a distinct company identifier for each

894

# distinct brand displayed.

895

#

896

# The maximum number of allowed characters is 255.

897

"structuredCompanyHqLocation": { # Output only. # Output only. A structured headquarters location of the company,

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

898

# resolved from hq_location if possible.

899

#

900

# A resource that represents a location with full geographic

901

# information.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

902

"postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information,

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

903

# such as postal delivery and payments addresses. Given a postal address,

904

# a postal service can deliver items to a premises, P.O. Box, or other

905

# delivery location.

906

# Given a postal address, a postal service can deliver items to a premise, P.O.

907

# Box or similar.

908

# It is not intended to model geographical locations (roads, towns,

909

# mountains).

910

#

911

# In typical usage an address would be created via user input or from importing

912

# existing data, depending on the type of process.

913

#

914

# Advice on address input / editing:

915

# - Use an i18n-ready address widget such as

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

916

# https://github.com/google/libaddressinput)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

917

# - Users should not be presented with UI elements for input or editing of

918

# fields outside countries where that field is used.

919

#

920

# For more guidance on how to use this schema, please see:

921

# https://support.google.com/business/answer/6397478

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

922

"locality": "A String", # Optional. Generally refers to the city/town portion of the address.

923

# Examples: US city, IT comune, UK post town.

924

# In regions of the world where localities are not well defined or do not fit

925

# into this structure well, leave locality empty and use address_lines.

926

"administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal

927

# addresses of a country or region.

928

# For example, this can be a state, a province, an oblast, or a prefecture.

929

# Specifically, for Spain this is the province and not the autonomous

930

# community (e.g. "Barcelona" and not "Catalonia").

931

# Many countries don't use an administrative area in postal addresses. E.g.

932

# in Switzerland this should be left unpopulated.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

933

"organization": "A String", # Optional. The name of the organization at the address.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

934

"addressLines": [ # Unstructured address lines describing the lower levels of an address.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

935

#

936

# Because values in address_lines do not have type information and may

937

# sometimes contain multiple values in a single field (e.g.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

938

# "Austin, TX"), it is important that the line order is clear. The order of

939

# address lines should be "envelope order" for the country/region of the

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

940

# address. In places where this can vary (e.g. Japan), address_language is

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

941

# used to make it explicit (e.g. "ja" for large-to-small ordering and

942

# "ja-Latn" or "en" for small-to-large). This way, the most specific line of

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

943

# an address can be selected based on the language.

944

#

945

# The minimum permitted structural representation of an address consists

946

# of a region_code with all remaining information placed in the

947

# address_lines. It would be possible to format such an address very

948

# approximately without geocoding, but no semantic reasoning could be

949

# made about any of the address components until it was at least

950

# partially resolved.

951

#

952

# Creating an address only containing a region_code and address_lines, and

953

# then geocoding is the recommended way to handle completely unstructured

954

# addresses (as opposed to guessing which parts of the address should be

955

# localities or administrative areas).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

956

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

957

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

958

"regionCode": "A String", # Required. CLDR region code of the country/region of the address. This

959

# is never inferred and it is up to the user to ensure the value is

960

# correct. See http://cldr.unicode.org/ and

961

# http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html

962

# for details. Example: "CH" for Switzerland.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

963

"postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

964

# postal codes to be present, but where they are used, they may trigger

965

# additional validation with other parts of the address (e.g. state/zip

966

# validation in the U.S.A.).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

967

"sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used

968

# in most regions. Where it is used, the value is either a string like

969

# "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number

970

# alone, representing the "sector code" (Jamaica), "delivery area indicator"

971

# (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

972

"languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if

973

# known). This is often the UI language of the input form or is expected

974

# to match one of the languages used in the address' country/region, or their

975

# transliterated equivalents.

976

# This can affect formatting in certain countries, but is not critical

977

# to the correctness of the data and will never affect any validation or

978

# other non-formatting related operations.

979

#

980

# If this value is not known, it should be omitted (rather than specifying a

981

# possibly incorrect default).

982

#

983

# Examples: "zh-Hant", "ja", "ja-Latn", "en".

984

"recipients": [ # Optional. The recipient at the address.

985

# This field may, under certain circumstances, contain multiline information.

986

# For example, it might contain "care of" information.

987

"A String",

988

],

989

"sublocality": "A String", # Optional. Sublocality of the address.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

990

# For example, this can be neighborhoods, boroughs, districts.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

991

"revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

992

# the latest revision.

993

#

994

# All new revisions **must** be backward compatible with old revisions.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

995

},

996

"locationType": "A String", # The type of a location, which corresponds to the address lines field of

997

# PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of

998

# LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of

999

# LocationType#LOCALITY.

1000

"radiusMeters": 3.14, # Radius in meters of the job location. This value is derived from the

1001

# location bounding box in which a circle with the specified radius

1002

# centered from LatLng coves the area associated with the job location.

1003

# For example, currently, "Mountain View, CA, USA" has a radius of

1004

# 7885.79 meters.

1005

"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.

1006

# of doubles representing degrees latitude and degrees longitude. Unless

1007

# specified otherwise, this must conform to the

1008

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

1009

# standard</a>. Values must be within normalized ranges.

1010

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

1011

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1012

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1013

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1014

"hiringAgency": True or False, # Optional. Set to true if it is the hiring agency that post jobs for other

1015

# employers.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1016

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1017

# Defaults to false if not provided.

1018

"title": "A String", # Deprecated. Use display_name instead.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1019

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1020

# Required.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1021

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1022

# The name of the employer to be displayed with the job,

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1023

# for example, "Google, LLC.".

1024

"displayName": "A String", # Required. The name of the employer to be displayed with the job,

1025

# for example, "Google, LLC.".

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1026

},

1027

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1028

"metadata": { # Output only. # Additional information for the API invocation, such as the request

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1029

# tracking id.

1030

#

1031

# Additional information returned to client, such as debugging

1032

# information.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1033

"requestId": "A String", # A unique id associated with this call.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1034

# This id is logged for tracking purposes.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1035

"mode": "A String", # For search response only. Indicates the mode of a performed search.

1036

"experimentIdList": [ # Identifiers for the versions of the search algorithm used during

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1037

# this API invocation if multiple algorithms are used.

1038

# The default value is empty.

1039

# For search response only.

1040

42,

1041

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

},

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

1048

<pre>Retrieves the next page of results.

1049

1050

Args:

1051

previous_request: The request for the previous page. (required)

1052

previous_response: The response from the request for the previous page. (required)

1053

1054

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1055

A request object that you can call 'execute()' on to request the next

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1056

page. Returns None if there are no more items in the collection.

</pre>

</div>

Dan O'Meara

2020-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 Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1062

<pre>Updates the specified company. Company names can't be updated. To update a

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1063

company name, delete the company and all jobs associated with it, and only

then re-create them.

Args:

The resource name for a company. This is generated by the service when a

1070

company is created, for example,

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1071

"companies/0000aaaa-1111-bbbb-2222-cccc3333dddd". (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1072

body: object, The request body.

Bu Sun Kim

2019-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.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1078

"website": "A String", # Optional. The URL representing the company's primary web site or home page,

1079

# such as, "www.google.com".

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1080

"hqLocation": "A String", # Optional. The street address of the company's main headquarters, which may be

1081

# different from the job location. The service attempts

1082

# to geolocate the provided address, and populates a more specific

1083

# location wherever possible in structured_company_hq_location.

1084

"companyInfoSources": [ # Optional. Identifiers external to the application that help to further identify

1085

# the employer.

1086

{ # A resource that represents an external Google identifier for a company,

1087

# for example, a Google+ business page or a Google Maps business page.

1088

# For unsupported types, use `unknown_type_id`.

1089

"mapsCid": "A String", # Optional. The numeric identifier for the employer's headquarters on Google Maps,

1090

# namely, the Google Maps CID (cell id).

1091

"freebaseMid": "A String", # Optional. The Google's Knowledge Graph value for the employer's company.

1092

"unknownTypeId": "A String", # Optional. A Google identifier that does not match any of the other types.

1093

"gplusId": "A String", # Optional. The numeric identifier for the employer's Google+ business page.

1094

},

1095

],

1096

"keywordSearchableCustomAttributes": [ # Optional. A list of keys of filterable Job.custom_attributes, whose

1097

# corresponding `string_values` are used in keyword search. Jobs with

1098

# `string_values` under these specified field keys are returned if any

1099

# of the values matches the search keyword. Custom field values with

1100

# parenthesis, brackets and special symbols might not be properly searchable,

1101

# and those keyword queries need to be surrounded by quotes.

1102

"A String",

1103

],

1104

"suspended": True or False, # Output only. Indicates whether a company is flagged to be suspended from public

1105

# availability by the service when job content appears suspicious,

1106

# abusive, or spammy.

1107

"imageUrl": "A String", # Optional. A URL that hosts the employer's company logo. If provided,

1108

# the logo image should be squared at 80x80 pixels.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1109

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1110

# The url must be a Google Photos or Google Album url.

1111

# Only images in these Google sub-domains are accepted.

1112

"distributorBillingCompanyId": "A String", # Optional. The unique company identifier provided by the client to identify an

1113

# employer for billing purposes. Recommended practice is to use

1114

# the distributor_company_id.

1115

#

1116

# Defaults to same value as distributor_company_id when a value

1117

# is not provided.

1118

"careerPageLink": "A String", # Optional. The URL to employer's career site or careers page on the employer's web

1119

# site.

1120

"keywordSearchableCustomFields": [ # Deprecated. Use keyword_searchable_custom_attributes instead.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1121

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1122

# Optional.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1123

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1124

# A list of filterable custom fields that should be used in keyword

1125

# search. The jobs of this company are returned if any of these custom

1126

# fields matches the search keyword. Custom field values with parenthesis,

1127

# brackets and special symbols might not be properly searchable, and those

1128

# keyword queries need to be surrounded by quotes.

1129

42,

1130

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1131

"disableLocationOptimization": True or False, # Deprecated. Do not use this field.

#

# Optional.

#

# This field is no longer used. Any value set to it is ignored.

1136

"companySize": "A String", # Optional. The employer's company size.

1137

"eeoText": "A String", # Optional. Equal Employment Opportunity legal disclaimer text to be

1138

# associated with all jobs, and typically to be displayed in all

1139

# roles.

1140

#

1141

# The maximum number of allowed characters is 500.

1142

"name": "A String", # Required during company update.

1143

#

1144

# The resource name for a company. This is generated by the service when a

1145

# company is created, for example,

1146

# "companies/0000aaaa-1111-bbbb-2222-cccc3333dddd".

1147

"distributorCompanyId": "A String", # Required. A client's company identifier, used to uniquely identify the

1148

# company. If an employer has a subsidiary or sub-brand, such as "Alphabet"

1149

# and "Google", which the client wishes to use as the company displayed on

1150

# the job. Best practice is to create a distinct company identifier for each

1151

# distinct brand displayed.

1152

#

1153

# The maximum number of allowed characters is 255.

1154

"structuredCompanyHqLocation": { # Output only. # Output only. A structured headquarters location of the company,

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1155

# resolved from hq_location if possible.

1156

#

1157

# A resource that represents a location with full geographic

1158

# information.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1159

"postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information,

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1160

# such as postal delivery and payments addresses. Given a postal address,

1161

# a postal service can deliver items to a premises, P.O. Box, or other

1162

# delivery location.

1163

# Given a postal address, a postal service can deliver items to a premise, P.O.

1164

# Box or similar.

1165

# It is not intended to model geographical locations (roads, towns,

1166

# mountains).

1167

#

1168

# In typical usage an address would be created via user input or from importing

1169

# existing data, depending on the type of process.

1170

#

1171

# Advice on address input / editing:

1172

# - Use an i18n-ready address widget such as

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1173

# https://github.com/google/libaddressinput)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1174

# - Users should not be presented with UI elements for input or editing of

1175

# fields outside countries where that field is used.

1176

#

1177

# For more guidance on how to use this schema, please see:

1178

# https://support.google.com/business/answer/6397478

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1179

"locality": "A String", # Optional. Generally refers to the city/town portion of the address.

1180

# Examples: US city, IT comune, UK post town.

1181

# In regions of the world where localities are not well defined or do not fit

1182

# into this structure well, leave locality empty and use address_lines.

1183

"administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal

1184

# addresses of a country or region.

1185

# For example, this can be a state, a province, an oblast, or a prefecture.

1186

# Specifically, for Spain this is the province and not the autonomous

1187

# community (e.g. "Barcelona" and not "Catalonia").

1188

# Many countries don't use an administrative area in postal addresses. E.g.

1189

# in Switzerland this should be left unpopulated.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1190

"organization": "A String", # Optional. The name of the organization at the address.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1191

"addressLines": [ # Unstructured address lines describing the lower levels of an address.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1192

#

1193

# Because values in address_lines do not have type information and may

1194

# sometimes contain multiple values in a single field (e.g.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1195

# "Austin, TX"), it is important that the line order is clear. The order of

1196

# address lines should be "envelope order" for the country/region of the

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1197

# address. In places where this can vary (e.g. Japan), address_language is

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1198

# used to make it explicit (e.g. "ja" for large-to-small ordering and

1199

# "ja-Latn" or "en" for small-to-large). This way, the most specific line of

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1200

# an address can be selected based on the language.

1201

#

1202

# The minimum permitted structural representation of an address consists

1203

# of a region_code with all remaining information placed in the

1204

# address_lines. It would be possible to format such an address very

1205

# approximately without geocoding, but no semantic reasoning could be

1206

# made about any of the address components until it was at least

1207

# partially resolved.

1208

#

1209

# Creating an address only containing a region_code and address_lines, and

1210

# then geocoding is the recommended way to handle completely unstructured

1211

# addresses (as opposed to guessing which parts of the address should be

1212

# localities or administrative areas).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1213

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1214

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1215

"regionCode": "A String", # Required. CLDR region code of the country/region of the address. This

1216

# is never inferred and it is up to the user to ensure the value is

1217

# correct. See http://cldr.unicode.org/ and

1218

# http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html

1219

# for details. Example: "CH" for Switzerland.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1220

"postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1221

# postal codes to be present, but where they are used, they may trigger

1222

# additional validation with other parts of the address (e.g. state/zip

1223

# validation in the U.S.A.).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1224

"sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used

1225

# in most regions. Where it is used, the value is either a string like

1226

# "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number

1227

# alone, representing the "sector code" (Jamaica), "delivery area indicator"

1228

# (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

1229

"languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if

1230

# known). This is often the UI language of the input form or is expected

1231

# to match one of the languages used in the address' country/region, or their

1232

# transliterated equivalents.

1233

# This can affect formatting in certain countries, but is not critical

1234

# to the correctness of the data and will never affect any validation or

1235

# other non-formatting related operations.

1236

#

1237

# If this value is not known, it should be omitted (rather than specifying a

1238

# possibly incorrect default).

1239

#

1240

# Examples: "zh-Hant", "ja", "ja-Latn", "en".

1241

"recipients": [ # Optional. The recipient at the address.

1242

# This field may, under certain circumstances, contain multiline information.

1243

# For example, it might contain "care of" information.

1244

"A String",

1245

],

1246

"sublocality": "A String", # Optional. Sublocality of the address.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1247

# For example, this can be neighborhoods, boroughs, districts.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1248

"revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1249

# the latest revision.

1250

#

1251

# All new revisions **must** be backward compatible with old revisions.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1252

},

1253

"locationType": "A String", # The type of a location, which corresponds to the address lines field of

1254

# PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of

1255

# LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of

1256

# LocationType#LOCALITY.

1257

"radiusMeters": 3.14, # Radius in meters of the job location. This value is derived from the

1258

# location bounding box in which a circle with the specified radius

1259

# centered from LatLng coves the area associated with the job location.

1260

# For example, currently, "Mountain View, CA, USA" has a radius of

1261

# 7885.79 meters.

1262

"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.

1263

# of doubles representing degrees latitude and degrees longitude. Unless

1264

# specified otherwise, this must conform to the

1265

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

1266

# standard</a>. Values must be within normalized ranges.

1267

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

1268

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1269

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1270

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1271

"hiringAgency": True or False, # Optional. Set to true if it is the hiring agency that post jobs for other

1272

# employers.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1273

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1274

# Defaults to false if not provided.

1275

"title": "A String", # Deprecated. Use display_name instead.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1276

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1277

# Required.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1278

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1279

# The name of the employer to be displayed with the job,

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1280

# for example, "Google, LLC.".

1281

"displayName": "A String", # Required. The name of the employer to be displayed with the job,

1282

# for example, "Google, LLC.".

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1283

}

1284

1285

updateCompanyFields: string, Optional but strongly recommended to be provided for the best service

1286

experience.

1287

1288

If update_company_fields is provided, only the specified fields in

1289

company are updated. Otherwise all the fields are updated.

1290

1291

A field mask to specify the company fields to update. Valid values are:

* displayName

* website

* imageUrl

* companySize

* distributorBillingCompanyId

* companyInfoSources

* careerPageLink

* hiringAgency

* hqLocation

* eeoText

* keywordSearchableCustomAttributes

1304

* title (deprecated)

1305

* keywordSearchableCustomFields (deprecated)

1306

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

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.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1317

"website": "A String", # Optional. The URL representing the company's primary web site or home page,

1318

# such as, "www.google.com".

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1319

"hqLocation": "A String", # Optional. The street address of the company's main headquarters, which may be

1320

# different from the job location. The service attempts

1321

# to geolocate the provided address, and populates a more specific

1322

# location wherever possible in structured_company_hq_location.

1323

"companyInfoSources": [ # Optional. Identifiers external to the application that help to further identify

1324

# the employer.

1325

{ # A resource that represents an external Google identifier for a company,

1326

# for example, a Google+ business page or a Google Maps business page.

1327

# For unsupported types, use `unknown_type_id`.

1328

"mapsCid": "A String", # Optional. The numeric identifier for the employer's headquarters on Google Maps,

1329

# namely, the Google Maps CID (cell id).

1330

"freebaseMid": "A String", # Optional. The Google's Knowledge Graph value for the employer's company.

1331

"unknownTypeId": "A String", # Optional. A Google identifier that does not match any of the other types.

1332

"gplusId": "A String", # Optional. The numeric identifier for the employer's Google+ business page.

1333

},

1334

],

1335

"keywordSearchableCustomAttributes": [ # Optional. A list of keys of filterable Job.custom_attributes, whose

1336

# corresponding `string_values` are used in keyword search. Jobs with

1337

# `string_values` under these specified field keys are returned if any

1338

# of the values matches the search keyword. Custom field values with

1339

# parenthesis, brackets and special symbols might not be properly searchable,

1340

# and those keyword queries need to be surrounded by quotes.

1341

"A String",

1342

],

1343

"suspended": True or False, # Output only. Indicates whether a company is flagged to be suspended from public

1344

# availability by the service when job content appears suspicious,

1345

# abusive, or spammy.

1346

"imageUrl": "A String", # Optional. A URL that hosts the employer's company logo. If provided,

1347

# the logo image should be squared at 80x80 pixels.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1348

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1349

# The url must be a Google Photos or Google Album url.

1350

# Only images in these Google sub-domains are accepted.

1351

"distributorBillingCompanyId": "A String", # Optional. The unique company identifier provided by the client to identify an

1352

# employer for billing purposes. Recommended practice is to use

1353

# the distributor_company_id.

1354

#

1355

# Defaults to same value as distributor_company_id when a value

1356

# is not provided.

1357

"careerPageLink": "A String", # Optional. The URL to employer's career site or careers page on the employer's web

1358

# site.

1359

"keywordSearchableCustomFields": [ # Deprecated. Use keyword_searchable_custom_attributes instead.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1360

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1361

# Optional.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1362

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1363

# A list of filterable custom fields that should be used in keyword

1364

# search. The jobs of this company are returned if any of these custom

1365

# fields matches the search keyword. Custom field values with parenthesis,

1366

# brackets and special symbols might not be properly searchable, and those

1367

# keyword queries need to be surrounded by quotes.

1368

42,

1369

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1370

"disableLocationOptimization": True or False, # Deprecated. Do not use this field.

#

# Optional.

#

# This field is no longer used. Any value set to it is ignored.

1375

"companySize": "A String", # Optional. The employer's company size.

1376

"eeoText": "A String", # Optional. Equal Employment Opportunity legal disclaimer text to be

1377

# associated with all jobs, and typically to be displayed in all

1378

# roles.

1379

#

1380

# The maximum number of allowed characters is 500.

1381

"name": "A String", # Required during company update.

1382

#

1383

# The resource name for a company. This is generated by the service when a

1384

# company is created, for example,

1385

# "companies/0000aaaa-1111-bbbb-2222-cccc3333dddd".

1386

"distributorCompanyId": "A String", # Required. A client's company identifier, used to uniquely identify the

1387

# company. If an employer has a subsidiary or sub-brand, such as "Alphabet"

1388

# and "Google", which the client wishes to use as the company displayed on

1389

# the job. Best practice is to create a distinct company identifier for each

1390

# distinct brand displayed.

1391

#

1392

# The maximum number of allowed characters is 255.

1393

"structuredCompanyHqLocation": { # Output only. # Output only. A structured headquarters location of the company,

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1394

# resolved from hq_location if possible.

1395

#

1396

# A resource that represents a location with full geographic

1397

# information.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1398

"postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information,

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1399

# such as postal delivery and payments addresses. Given a postal address,

1400

# a postal service can deliver items to a premises, P.O. Box, or other

1401

# delivery location.

1402

# Given a postal address, a postal service can deliver items to a premise, P.O.

1403

# Box or similar.

1404

# It is not intended to model geographical locations (roads, towns,

1405

# mountains).

1406

#

1407

# In typical usage an address would be created via user input or from importing

1408

# existing data, depending on the type of process.

1409

#

1410

# Advice on address input / editing:

1411

# - Use an i18n-ready address widget such as

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1412

# https://github.com/google/libaddressinput)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1413

# - Users should not be presented with UI elements for input or editing of

1414

# fields outside countries where that field is used.

1415

#

1416

# For more guidance on how to use this schema, please see:

1417

# https://support.google.com/business/answer/6397478

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1418

"locality": "A String", # Optional. Generally refers to the city/town portion of the address.

1419

# Examples: US city, IT comune, UK post town.

1420

# In regions of the world where localities are not well defined or do not fit

1421

# into this structure well, leave locality empty and use address_lines.

1422

"administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal

1423

# addresses of a country or region.

1424

# For example, this can be a state, a province, an oblast, or a prefecture.

1425

# Specifically, for Spain this is the province and not the autonomous

1426

# community (e.g. "Barcelona" and not "Catalonia").

1427

# Many countries don't use an administrative area in postal addresses. E.g.

1428

# in Switzerland this should be left unpopulated.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1429

"organization": "A String", # Optional. The name of the organization at the address.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1430

"addressLines": [ # Unstructured address lines describing the lower levels of an address.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1431

#

1432

# Because values in address_lines do not have type information and may

1433

# sometimes contain multiple values in a single field (e.g.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1434

# "Austin, TX"), it is important that the line order is clear. The order of

1435

# address lines should be "envelope order" for the country/region of the

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1436

# address. In places where this can vary (e.g. Japan), address_language is

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1437

# used to make it explicit (e.g. "ja" for large-to-small ordering and

1438

# "ja-Latn" or "en" for small-to-large). This way, the most specific line of

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1439

# an address can be selected based on the language.

1440

#

1441

# The minimum permitted structural representation of an address consists

1442

# of a region_code with all remaining information placed in the

1443

# address_lines. It would be possible to format such an address very

1444

# approximately without geocoding, but no semantic reasoning could be

1445

# made about any of the address components until it was at least

1446

# partially resolved.

1447

#

1448

# Creating an address only containing a region_code and address_lines, and

1449

# then geocoding is the recommended way to handle completely unstructured

1450

# addresses (as opposed to guessing which parts of the address should be

1451

# localities or administrative areas).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1452

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1453

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1454

"regionCode": "A String", # Required. CLDR region code of the country/region of the address. This

1455

# is never inferred and it is up to the user to ensure the value is

1456

# correct. See http://cldr.unicode.org/ and

1457

# http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html

1458

# for details. Example: "CH" for Switzerland.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1459

"postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1460

# postal codes to be present, but where they are used, they may trigger

1461

# additional validation with other parts of the address (e.g. state/zip

1462

# validation in the U.S.A.).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1463

"sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used

1464

# in most regions. Where it is used, the value is either a string like

1465

# "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number

1466

# alone, representing the "sector code" (Jamaica), "delivery area indicator"

1467

# (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

1468

"languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if

1469

# known). This is often the UI language of the input form or is expected

1470

# to match one of the languages used in the address' country/region, or their

1471

# transliterated equivalents.

1472

# This can affect formatting in certain countries, but is not critical

1473

# to the correctness of the data and will never affect any validation or

1474

# other non-formatting related operations.

1475

#

1476

# If this value is not known, it should be omitted (rather than specifying a

1477

# possibly incorrect default).

1478

#

1479

# Examples: "zh-Hant", "ja", "ja-Latn", "en".

1480

"recipients": [ # Optional. The recipient at the address.

1481

# This field may, under certain circumstances, contain multiline information.

1482

# For example, it might contain "care of" information.

1483

"A String",

1484

],

1485

"sublocality": "A String", # Optional. Sublocality of the address.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1486

# For example, this can be neighborhoods, boroughs, districts.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1487

"revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1488

# the latest revision.

1489

#

1490

# All new revisions **must** be backward compatible with old revisions.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1491

},

1492

"locationType": "A String", # The type of a location, which corresponds to the address lines field of

1493

# PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of

1494

# LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of

1495

# LocationType#LOCALITY.

1496

"radiusMeters": 3.14, # Radius in meters of the job location. This value is derived from the

1497

# location bounding box in which a circle with the specified radius

1498

# centered from LatLng coves the area associated with the job location.

1499

# For example, currently, "Mountain View, CA, USA" has a radius of

1500

# 7885.79 meters.

1501

"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.

1502

# of doubles representing degrees latitude and degrees longitude. Unless

1503

# specified otherwise, this must conform to the

1504

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

1505

# standard</a>. Values must be within normalized ranges.

1506

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

1507

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1508

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1509

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1510

"hiringAgency": True or False, # Optional. Set to true if it is the hiring agency that post jobs for other

1511

# employers.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1512

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1513

# Defaults to false if not provided.

1514

"title": "A String", # Deprecated. Use display_name instead.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1515

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1516

# Required.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1517

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1518

# The name of the employer to be displayed with the job,

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1519

# for example, "Google, LLC.".

1520

"displayName": "A String", # Required. The name of the employer to be displayed with the job,

1521

# for example, "Google, LLC.".

Bu Sun Kim