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

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

[diff] [blame]

192

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

193

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

194

# delivery location.

195

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

196

# Box or similar.

197

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

198

# mountains).

199

#

200

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

201

# existing data, depending on the type of process.

202

#

203

# Advice on address input / editing:

204

# - Use an i18n-ready address widget such as

Dan O'Meara

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

[diff] [blame]

205

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

Bu Sun Kim

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

[diff] [blame]

206

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

207

# fields outside countries where that field is used.

208

#

209

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

210

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

Bu Sun Kim

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

[diff] [blame]

211

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

212

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

Bu Sun Kim

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

[diff] [blame]

213

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

214

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

215

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

Bu Sun Kim

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

[diff] [blame]

216

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

217

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

Bu Sun Kim

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

[diff] [blame]

218

#

219

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

220

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

Bu Sun Kim

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

[diff] [blame]

221

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

222

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

Bu Sun Kim

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

[diff] [blame]

223

# 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]

224

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

225

# "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]

226

# an address can be selected based on the language.

227

#

228

# The minimum permitted structural representation of an address consists

229

# of a region_code with all remaining information placed in the

230

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

231

# approximately without geocoding, but no semantic reasoning could be

232

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

233

# partially resolved.

234

#

235

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

236

# then geocoding is the recommended way to handle completely unstructured

237

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

238

# localities or administrative areas).

Bu Sun Kim

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

[diff] [blame]

239

"A String",

Bu Sun Kim

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

[diff] [blame]

240

],

Bu Sun Kim

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

[diff] [blame]

241

"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]

242

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

243

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

244

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

Bu Sun Kim

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

[diff] [blame]

245

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

246

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

247

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

248

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

249

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

250

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

251

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

252

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

253

# transliterated equivalents.

254

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

255

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

256

# other non-formatting related operations.

257

#

258

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

259

# possibly incorrect default).

260

#

261

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

262

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

263

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

264

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

265

"A String",

266

],

267

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

Bu Sun Kim

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

[diff] [blame]

268

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

Bu Sun Kim

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

[diff] [blame]

269

"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]

270

# the latest revision.

271

#

272

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

Bu Sun Kim

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

[diff] [blame]

273

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

274

# addresses of a country or region.

275

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

276

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

277

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

278

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

279

# in Switzerland this should be left unpopulated.

280

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

281

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

282

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

283

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

284

},

285

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

286

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

287

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

288

# LocationType#LOCALITY.

289

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

290

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

291

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

292

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

293

# 7885.79 meters.

294

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

295

# of doubles representing degrees latitude and degrees longitude. Unless

296

# specified otherwise, this must conform to the

297

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

298

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

299

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

300

"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]

301

},

Bu Sun Kim

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

[diff] [blame]

302

},

Bu Sun Kim

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

[diff] [blame]

303

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

304

# employers.

Bu Sun Kim

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

[diff] [blame]

305

#

Bu Sun Kim

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

[diff] [blame]

306

# Defaults to false if not provided.

307

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

Bu Sun Kim

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

[diff] [blame]

308

#

Dan O'Meara

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

[diff] [blame]

309

# Required.

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

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

Bu Sun Kim

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

[diff] [blame]

312

# for example, "Google, LLC.".

313

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

314

# for example, "Google, LLC.".

315

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

316

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

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-20 12:08:20 -0700

[diff] [blame]

330

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

331

# different from the job location. The service attempts

332

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

333

# location wherever possible in structured_company_hq_location.

334

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

335

# the employer.

336

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

337

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

338

# For unsupported types, use `unknown_type_id`.

339

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

340

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

341

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

342

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

343

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

344

},

345

],

346

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

347

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

348

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

349

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

350

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

351

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

352

"A String",

353

],

354

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

355

# availability by the service when job content appears suspicious,

356

# abusive, or spammy.

357

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

358

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

Bu Sun Kim

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

[diff] [blame]

359

#

Bu Sun Kim

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

[diff] [blame]

360

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

361

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

362

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

363

# employer for billing purposes. Recommended practice is to use

364

# the distributor_company_id.

365

#

366

# Defaults to same value as distributor_company_id when a value

367

# is not provided.

368

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

369

# site.

370

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

Bu Sun Kim

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

[diff] [blame]

371

#

Dan O'Meara

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

[diff] [blame]

372

# Optional.

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

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

375

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

376

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

377

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

378

# keyword queries need to be surrounded by quotes.

379

42,

380

],

Bu Sun Kim

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

[diff] [blame]

381

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

#

# Optional.

#

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

386

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

387

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

388

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

389

# roles.

390

#

391

# The maximum number of allowed characters is 500.

392

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

393

#

394

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

395

# company is created, for example,

396

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

397

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

398

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

399

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

400

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

401

# distinct brand displayed.

402

#

403

# The maximum number of allowed characters is 255.

404

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

Bu Sun Kim

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

[diff] [blame]

405

# resolved from hq_location if possible.

406

#

407

# A resource that represents a location with full geographic

408

# information.

Bu Sun Kim

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

[diff] [blame]

409

"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]

410

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

411

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

412

# delivery location.

413

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

414

# Box or similar.

415

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

416

# mountains).

417

#

418

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

419

# existing data, depending on the type of process.

420

#

421

# Advice on address input / editing:

422

# - Use an i18n-ready address widget such as

Dan O'Meara

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

[diff] [blame]

423

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

Bu Sun Kim

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

[diff] [blame]

424

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

425

# fields outside countries where that field is used.

426

#

427

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

428

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

Bu Sun Kim

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

[diff] [blame]

429

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

430

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

Bu Sun Kim

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

[diff] [blame]

431

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

432

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

433

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

Bu Sun Kim

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

[diff] [blame]

434

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

435

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

Bu Sun Kim

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

[diff] [blame]

436

#

437

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

438

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

Bu Sun Kim

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

[diff] [blame]

439

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

440

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

Bu Sun Kim

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

[diff] [blame]

441

# 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]

442

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

443

# "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]

444

# an address can be selected based on the language.

445

#

446

# The minimum permitted structural representation of an address consists

447

# of a region_code with all remaining information placed in the

448

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

449

# approximately without geocoding, but no semantic reasoning could be

450

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

451

# partially resolved.

452

#

453

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

454

# then geocoding is the recommended way to handle completely unstructured

455

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

456

# localities or administrative areas).

Bu Sun Kim

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

[diff] [blame]

457

"A String",

Bu Sun Kim

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

[diff] [blame]

458

],

Bu Sun Kim

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

[diff] [blame]

459

"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]

460

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

461

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

462

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

Bu Sun Kim

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

[diff] [blame]

463

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

464

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

465

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

466

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

467

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

468

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

469

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

470

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

471

# transliterated equivalents.

472

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

473

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

474

# other non-formatting related operations.

475

#

476

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

477

# possibly incorrect default).

478

#

479

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

480

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

481

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

482

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

483

"A String",

484

],

485

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

Bu Sun Kim

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

[diff] [blame]

486

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

Bu Sun Kim

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

[diff] [blame]

487

"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]

488

# the latest revision.

489

#

490

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

Bu Sun Kim

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

[diff] [blame]

491

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

492

# addresses of a country or region.

493

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

494

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

495

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

496

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

497

# in Switzerland this should be left unpopulated.

498

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

499

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

500

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

501

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

502

},

503

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

504

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

505

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

506

# LocationType#LOCALITY.

507

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

508

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

509

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

510

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

511

# 7885.79 meters.

512

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

513

# of doubles representing degrees latitude and degrees longitude. Unless

514

# specified otherwise, this must conform to the

515

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

516

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

517

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

518

"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]

519

},

Bu Sun Kim

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

[diff] [blame]

520

},

Bu Sun Kim

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

[diff] [blame]

521

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

522

# employers.

Bu Sun Kim

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

[diff] [blame]

523

#

Bu Sun Kim

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

[diff] [blame]

524

# Defaults to false if not provided.

525

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

Bu Sun Kim

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

[diff] [blame]

526

#

Dan O'Meara

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

[diff] [blame]

527

# Required.

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

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

Bu Sun Kim

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

[diff] [blame]

530

# for example, "Google, LLC.".

531

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

532

# for example, "Google, LLC.".

533

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

534

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

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-20 12:08:20 -0700

[diff] [blame]

583

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

584

# different from the job location. The service attempts

585

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

586

# location wherever possible in structured_company_hq_location.

587

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

588

# the employer.

589

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

590

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

591

# For unsupported types, use `unknown_type_id`.

592

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

593

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

594

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

595

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

596

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

597

},

598

],

599

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

600

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

601

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

602

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

603

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

604

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

605

"A String",

606

],

607

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

608

# availability by the service when job content appears suspicious,

609

# abusive, or spammy.

610

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

611

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

Bu Sun Kim

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

[diff] [blame]

612

#

Bu Sun Kim

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

[diff] [blame]

613

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

614

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

615

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

616

# employer for billing purposes. Recommended practice is to use

617

# the distributor_company_id.

618

#

619

# Defaults to same value as distributor_company_id when a value

620

# is not provided.

621

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

622

# site.

623

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

Bu Sun Kim

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

[diff] [blame]

624

#

Dan O'Meara

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

[diff] [blame]

625

# Optional.

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

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

628

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

629

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

630

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

631

# keyword queries need to be surrounded by quotes.

632

42,

633

],

Bu Sun Kim

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

[diff] [blame]

634

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

#

# Optional.

#

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

639

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

640

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

641

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

642

# roles.

643

#

644

# The maximum number of allowed characters is 500.

645

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

646

#

647

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

648

# company is created, for example,

649

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

650

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

651

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

652

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

653

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

654

# distinct brand displayed.

655

#

656

# The maximum number of allowed characters is 255.

657

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

Bu Sun Kim

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

[diff] [blame]

658

# resolved from hq_location if possible.

659

#

660

# A resource that represents a location with full geographic

661

# information.

Bu Sun Kim

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

[diff] [blame]

662

"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]

663

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

664

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

665

# delivery location.

666

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

667

# Box or similar.

668

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

669

# mountains).

670

#

671

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

672

# existing data, depending on the type of process.

673

#

674

# Advice on address input / editing:

675

# - Use an i18n-ready address widget such as

Dan O'Meara

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

[diff] [blame]

676

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

Bu Sun Kim

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

[diff] [blame]

677

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

678

# fields outside countries where that field is used.

679

#

680

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

681

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

Bu Sun Kim

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

[diff] [blame]

682

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

683

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

Bu Sun Kim

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

[diff] [blame]

684

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

685

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

686

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

Bu Sun Kim

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

[diff] [blame]

687

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

688

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

Bu Sun Kim

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

[diff] [blame]

689

#

690

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

691

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

Bu Sun Kim

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

[diff] [blame]

692

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

693

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

Bu Sun Kim

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

[diff] [blame]

694

# 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]

695

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

696

# "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]

697

# an address can be selected based on the language.

698

#

699

# The minimum permitted structural representation of an address consists

700

# of a region_code with all remaining information placed in the

701

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

702

# approximately without geocoding, but no semantic reasoning could be

703

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

704

# partially resolved.

705

#

706

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

707

# then geocoding is the recommended way to handle completely unstructured

708

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

709

# localities or administrative areas).

Bu Sun Kim

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

[diff] [blame]

710

"A String",

Bu Sun Kim

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

[diff] [blame]

711

],

Bu Sun Kim

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

[diff] [blame]

712

"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]

713

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

714

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

715

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

Bu Sun Kim

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

[diff] [blame]

716

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

717

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

718

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

719

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

720

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

721

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

722

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

723

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

724

# transliterated equivalents.

725

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

726

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

727

# other non-formatting related operations.

728

#

729

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

730

# possibly incorrect default).

731

#

732

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

733

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

734

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

735

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

736

"A String",

737

],

738

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

Bu Sun Kim

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

[diff] [blame]

739

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

Bu Sun Kim

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

[diff] [blame]

740

"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]

741

# the latest revision.

742

#

743

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

Bu Sun Kim

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

[diff] [blame]

744

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

745

# addresses of a country or region.

746

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

747

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

748

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

749

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

750

# in Switzerland this should be left unpopulated.

751

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

752

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

753

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

754

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

755

},

756

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

757

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

758

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

759

# LocationType#LOCALITY.

760

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

761

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

762

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

763

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

764

# 7885.79 meters.

765

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

766

# of doubles representing degrees latitude and degrees longitude. Unless

767

# specified otherwise, this must conform to the

768

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

769

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

770

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

771

"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]

772

},

Bu Sun Kim

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

[diff] [blame]

773

},

Bu Sun Kim

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

[diff] [blame]

774

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

775

# employers.

Bu Sun Kim

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

[diff] [blame]

776

#

Bu Sun Kim

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

[diff] [blame]

777

# Defaults to false if not provided.

778

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

Bu Sun Kim

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

[diff] [blame]

779

#

Dan O'Meara

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

[diff] [blame]

780

# Required.

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

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

Bu Sun Kim

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

[diff] [blame]

783

# for example, "Google, LLC.".

784

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

785

# for example, "Google, LLC.".

786

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

787

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

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

792

<code class="details" id="list">list(mustHaveOpenJobs=None, pageToken=None, pageSize=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:

Dan O'Meara

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

[diff] [blame]

796

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

801

only those with open jobs are returned.

Dan O'Meara

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

[diff] [blame]

802

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

Bu Sun Kim

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

[diff] [blame]

803

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

804

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

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-20 12:08:20 -0700

[diff] [blame]

821

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

822

# different from the job location. The service attempts

823

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

824

# location wherever possible in structured_company_hq_location.

825

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

826

# the employer.

827

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

828

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

829

# For unsupported types, use `unknown_type_id`.

830

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

831

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

832

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

833

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

834

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

835

},

836

],

837

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

838

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

839

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

840

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

841

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

842

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

843

"A String",

844

],

845

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

846

# availability by the service when job content appears suspicious,

847

# abusive, or spammy.

848

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

849

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

Bu Sun Kim

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

[diff] [blame]

850

#

Bu Sun Kim

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

[diff] [blame]

851

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

852

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

853

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

854

# employer for billing purposes. Recommended practice is to use

855

# the distributor_company_id.

856

#

857

# Defaults to same value as distributor_company_id when a value

858

# is not provided.

859

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

860

# site.

861

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

Bu Sun Kim

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

[diff] [blame]

862

#

Dan O'Meara

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

[diff] [blame]

863

# Optional.

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

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

866

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

867

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

868

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

869

# keyword queries need to be surrounded by quotes.

870

42,

871

],

Bu Sun Kim

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

[diff] [blame]

872

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

#

# Optional.

#

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

877

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

878

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

879

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

880

# roles.

881

#

882

# The maximum number of allowed characters is 500.

883

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

884

#

885

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

886

# company is created, for example,

887

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

888

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

889

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

890

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

891

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

892

# distinct brand displayed.

893

#

894

# The maximum number of allowed characters is 255.

895

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

Bu Sun Kim

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

[diff] [blame]

896

# resolved from hq_location if possible.

897

#

898

# A resource that represents a location with full geographic

899

# information.

Bu Sun Kim

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

[diff] [blame]

900

"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]

901

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

902

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

903

# delivery location.

904

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

905

# Box or similar.

906

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

907

# mountains).

908

#

909

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

910

# existing data, depending on the type of process.

911

#

912

# Advice on address input / editing:

913

# - Use an i18n-ready address widget such as

Dan O'Meara

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

[diff] [blame]

914

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

Bu Sun Kim

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

[diff] [blame]

915

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

916

# fields outside countries where that field is used.

917

#

918

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

919

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

Bu Sun Kim

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

[diff] [blame]

920

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

921

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

Bu Sun Kim

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

[diff] [blame]

922

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

923

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

924

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

Bu Sun Kim

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

[diff] [blame]

925

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

926

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

Bu Sun Kim

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

[diff] [blame]

927

#

928

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

929

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

Bu Sun Kim

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

[diff] [blame]

930

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

931

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

Bu Sun Kim

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

[diff] [blame]

932

# 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]

933

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

934

# "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]

935

# an address can be selected based on the language.

936

#

937

# The minimum permitted structural representation of an address consists

938

# of a region_code with all remaining information placed in the

939

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

940

# approximately without geocoding, but no semantic reasoning could be

941

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

942

# partially resolved.

943

#

944

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

945

# then geocoding is the recommended way to handle completely unstructured

946

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

947

# localities or administrative areas).

Bu Sun Kim

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

[diff] [blame]

948

"A String",

Bu Sun Kim

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

[diff] [blame]

949

],

Bu Sun Kim

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

[diff] [blame]

950

"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]

951

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

952

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

953

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

Bu Sun Kim

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

[diff] [blame]

954

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

955

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

956

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

957

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

958

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

959

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

960

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

961

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

962

# transliterated equivalents.

963

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

964

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

965

# other non-formatting related operations.

966

#

967

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

968

# possibly incorrect default).

969

#

970

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

971

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

972

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

973

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

974

"A String",

975

],

976

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

Bu Sun Kim

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

[diff] [blame]

977

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

Bu Sun Kim

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

[diff] [blame]

978

"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]

979

# the latest revision.

980

#

981

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

Bu Sun Kim

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

[diff] [blame]

982

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

983

# addresses of a country or region.

984

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

985

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

986

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

987

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

988

# in Switzerland this should be left unpopulated.

989

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

990

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

991

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

992

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

993

},

994

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

995

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

996

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

997

# LocationType#LOCALITY.

998

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

999

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

1000

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

1001

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

1002

# 7885.79 meters.

1003

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

1004

# of doubles representing degrees latitude and degrees longitude. Unless

1005

# specified otherwise, this must conform to the

1006

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

1007

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

1008

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

1009

"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]

1010

},

Bu Sun Kim

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

[diff] [blame]

1011

},

Bu Sun Kim

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

[diff] [blame]

1012

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

1013

# employers.

Bu Sun Kim

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

[diff] [blame]

1014

#

Bu Sun Kim

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

[diff] [blame]

1015

# Defaults to false if not provided.

1016

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

Bu Sun Kim

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

[diff] [blame]

1017

#

Dan O'Meara

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

[diff] [blame]

1018

# Required.

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

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

Bu Sun Kim

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

[diff] [blame]

1021

# for example, "Google, LLC.".

1022

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

1023

# for example, "Google, LLC.".

1024

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

1025

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

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-20 12:08:20 -0700

[diff] [blame]

1078

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

1079

# different from the job location. The service attempts

1080

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

1081

# location wherever possible in structured_company_hq_location.

1082

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

1083

# the employer.

1084

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

1085

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

1086

# For unsupported types, use `unknown_type_id`.

1087

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

1088

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

1089

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

1090

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

1091

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

1092

},

1093

],

1094

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

1095

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

1096

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

1097

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

1098

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

1099

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

1100

"A String",

1101

],

1102

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

1103

# availability by the service when job content appears suspicious,

1104

# abusive, or spammy.

1105

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

1106

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

Bu Sun Kim

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

[diff] [blame]

1107

#

Bu Sun Kim

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

[diff] [blame]

1108

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

1109

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

1110

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

1111

# employer for billing purposes. Recommended practice is to use

1112

# the distributor_company_id.

1113

#

1114

# Defaults to same value as distributor_company_id when a value

1115

# is not provided.

1116

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

1117

# site.

1118

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

Bu Sun Kim

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

[diff] [blame]

1119

#

Dan O'Meara

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

[diff] [blame]

1120

# Optional.

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

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

1123

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

1124

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

1125

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

1126

# keyword queries need to be surrounded by quotes.

1127

42,

1128

],

Bu Sun Kim

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

[diff] [blame]

1129

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

#

# Optional.

#

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

1134

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

1135

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

1136

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

1137

# roles.

1138

#

1139

# The maximum number of allowed characters is 500.

1140

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

1141

#

1142

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

1143

# company is created, for example,

1144

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

1145

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

1146

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

1147

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

1148

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

1149

# distinct brand displayed.

1150

#

1151

# The maximum number of allowed characters is 255.

1152

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

Bu Sun Kim

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

[diff] [blame]

1153

# resolved from hq_location if possible.

1154

#

1155

# A resource that represents a location with full geographic

1156

# information.

Bu Sun Kim

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

[diff] [blame]

1157

"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]

1158

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

1159

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

1160

# delivery location.

1161

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

1162

# Box or similar.

1163

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

1164

# mountains).

1165

#

1166

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

1167

# existing data, depending on the type of process.

1168

#

1169

# Advice on address input / editing:

1170

# - Use an i18n-ready address widget such as

Dan O'Meara

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

[diff] [blame]

1171

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

Bu Sun Kim

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

[diff] [blame]

1172

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

1173

# fields outside countries where that field is used.

1174

#

1175

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

1176

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

Bu Sun Kim

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

[diff] [blame]

1177

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

1178

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

Bu Sun Kim

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

[diff] [blame]

1179

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

1180

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

1181

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

Bu Sun Kim

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

[diff] [blame]

1182

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

1183

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

Bu Sun Kim

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

[diff] [blame]

1184

#

1185

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

1186

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

Bu Sun Kim

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

[diff] [blame]

1187

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

1188

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

Bu Sun Kim

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

[diff] [blame]

1189

# 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]

1190

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

1191

# "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]

1192

# an address can be selected based on the language.

1193

#

1194

# The minimum permitted structural representation of an address consists

1195

# of a region_code with all remaining information placed in the

1196

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

1197

# approximately without geocoding, but no semantic reasoning could be

1198

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

1199

# partially resolved.

1200

#

1201

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

1202

# then geocoding is the recommended way to handle completely unstructured

1203

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

1204

# localities or administrative areas).

Bu Sun Kim

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

[diff] [blame]

1205

"A String",

Bu Sun Kim

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

[diff] [blame]

1206

],

Bu Sun Kim

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

[diff] [blame]

1207

"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]

1208

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

1209

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

1210

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

Bu Sun Kim

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

[diff] [blame]

1211

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

1212

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

1213

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

1214

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

1215

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

1216

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

1217

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

1218

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

1219

# transliterated equivalents.

1220

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

1221

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

1222

# other non-formatting related operations.

1223

#

1224

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

1225

# possibly incorrect default).

1226

#

1227

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

1228

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

1229

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

1230

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

1231

"A String",

1232

],

1233

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

Bu Sun Kim

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

[diff] [blame]

1234

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

Bu Sun Kim

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

[diff] [blame]

1235

"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]

1236

# the latest revision.

1237

#

1238

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

Bu Sun Kim

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

[diff] [blame]

1239

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

1240

# addresses of a country or region.

1241

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

1242

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

1243

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

1244

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

1245

# in Switzerland this should be left unpopulated.

1246

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

1247

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

1248

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

1249

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

1250

},

1251

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

1252

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

1253

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

1254

# LocationType#LOCALITY.

1255

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

1256

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

1257

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

1258

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

1259

# 7885.79 meters.

1260

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

1261

# of doubles representing degrees latitude and degrees longitude. Unless

1262

# specified otherwise, this must conform to the

1263

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

1264

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

1265

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

1266

"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]

1267

},

Bu Sun Kim

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

[diff] [blame]

1268

},

Bu Sun Kim

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

[diff] [blame]

1269

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

1270

# employers.

Bu Sun Kim

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

[diff] [blame]

1271

#

Bu Sun Kim

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

[diff] [blame]

1272

# Defaults to false if not provided.

1273

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

Bu Sun Kim

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

[diff] [blame]

1274

#

Dan O'Meara

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

[diff] [blame]

1275

# Required.

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

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

Bu Sun Kim

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

[diff] [blame]

1278

# for example, "Google, LLC.".

1279

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

1280

# for example, "Google, LLC.".

1281

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

1282

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

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-20 12:08:20 -0700

[diff] [blame]

1317

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

1318

# different from the job location. The service attempts

1319

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

1320

# location wherever possible in structured_company_hq_location.

1321

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

1322

# the employer.

1323

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

1324

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

1325

# For unsupported types, use `unknown_type_id`.

1326

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

1327

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

1328

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

1329

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

1330

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

1331

},

1332

],

1333

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

1334

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

1335

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

1336

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

1337

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

1338

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

1339

"A String",

1340

],

1341

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

1342

# availability by the service when job content appears suspicious,

1343

# abusive, or spammy.

1344

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

1345

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

Bu Sun Kim

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

[diff] [blame]

1346

#

Bu Sun Kim

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

[diff] [blame]

1347

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

1348

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

1349

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

1350

# employer for billing purposes. Recommended practice is to use

1351

# the distributor_company_id.

1352

#

1353

# Defaults to same value as distributor_company_id when a value

1354

# is not provided.

1355

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

1356

# site.

1357

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

Bu Sun Kim

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

[diff] [blame]

1358

#

Dan O'Meara

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

[diff] [blame]

1359

# Optional.

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

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

1362

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

1363

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

1364

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

1365

# keyword queries need to be surrounded by quotes.

1366

42,

1367

],

Bu Sun Kim

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

[diff] [blame]

1368

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

#

# Optional.

#

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

1373

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

1374

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

1375

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

1376

# roles.

1377

#

1378

# The maximum number of allowed characters is 500.

1379

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

1380

#

1381

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

1382

# company is created, for example,

1383

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

1384

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

1385

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

1386

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

1387

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

1388

# distinct brand displayed.

1389

#

1390

# The maximum number of allowed characters is 255.

1391

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

Bu Sun Kim

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

[diff] [blame]

1392

# resolved from hq_location if possible.

1393

#

1394

# A resource that represents a location with full geographic

1395

# information.

Bu Sun Kim

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

[diff] [blame]

1396

"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]

1397

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

1398

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

1399

# delivery location.

1400

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

1401

# Box or similar.

1402

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

1403

# mountains).

1404

#

1405

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

1406

# existing data, depending on the type of process.

1407

#

1408

# Advice on address input / editing:

1409

# - Use an i18n-ready address widget such as

Dan O'Meara

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

[diff] [blame]

1410

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

Bu Sun Kim

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

[diff] [blame]

1411

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

1412

# fields outside countries where that field is used.

1413

#

1414

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

1415

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

Bu Sun Kim

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

[diff] [blame]

1416

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

1417

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

Bu Sun Kim

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

[diff] [blame]

1418

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

1419

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

1420

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

Bu Sun Kim

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

[diff] [blame]

1421

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

1422

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

Bu Sun Kim

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

[diff] [blame]

1423

#

1424

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

1425

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

Bu Sun Kim

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

[diff] [blame]

1426

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

1427

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

Bu Sun Kim

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

[diff] [blame]

1428

# 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]

1429

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

1430

# "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]

1431

# an address can be selected based on the language.

1432

#

1433

# The minimum permitted structural representation of an address consists

1434

# of a region_code with all remaining information placed in the

1435

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

1436

# approximately without geocoding, but no semantic reasoning could be

1437

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

1438

# partially resolved.

1439

#

1440

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

1441

# then geocoding is the recommended way to handle completely unstructured

1442

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

1443

# localities or administrative areas).

Bu Sun Kim

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

[diff] [blame]

1444

"A String",

Bu Sun Kim

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

[diff] [blame]

1445

],

Bu Sun Kim

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

[diff] [blame]

1446

"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]

1447

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

1448

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

1449

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

Bu Sun Kim

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

[diff] [blame]

1450

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

1451

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

1452

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

1453

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

1454

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

1455

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

1456

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

1457

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

1458

# transliterated equivalents.

1459

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

1460

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

1461

# other non-formatting related operations.

1462

#

1463

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

1464

# possibly incorrect default).

1465

#

1466

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

1467

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

1468

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

1469

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

1470

"A String",

1471

],

1472

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

Bu Sun Kim

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

[diff] [blame]

1473

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

Bu Sun Kim

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

[diff] [blame]

1474

"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]

1475

# the latest revision.

1476

#

1477

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

Bu Sun Kim

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

[diff] [blame]

1478

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

1479

# addresses of a country or region.

1480

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

1481

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

1482

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

1483

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

1484

# in Switzerland this should be left unpopulated.

1485

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

1486

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

1487

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

1488

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

1489

},

1490

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

1491

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

1492

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

1493

# LocationType#LOCALITY.

1494

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

1495

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

1496

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

1497

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

1498

# 7885.79 meters.

1499

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

1500

# of doubles representing degrees latitude and degrees longitude. Unless

1501

# specified otherwise, this must conform to the

1502

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

1503

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

1504

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

1505

"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]

1506

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1507

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1508

"hiringAgency": True or False, # Optional. Set to true if it is the hiring agency that post jobs for other

1509

# employers.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1510

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1511

# Defaults to false if not provided.

1512

"title": "A String", # Deprecated. Use display_name instead.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1513

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1514

# Required.

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

# The name of the employer to be displayed with the job,

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1517

# for example, "Google, LLC.".

1518

"displayName": "A String", # Required. The name of the employer to be displayed with the job,

1519

# for example, "Google, LLC.".

1520

"website": "A String", # Optional. The URL representing the company's primary web site or home page,

1521

# such as, "www.google.com".

Bu Sun Kim