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

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

[diff] [blame]

78

<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

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

[diff] [blame]

79

<p class="firstline">Creates a new company entity.</p>

80

81

<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>

82

<p class="firstline">Deletes specified company.</p>

83

84

<code><a href="#get">get(name, x__xgafv=None)</a></code></p>

85

<p class="firstline">Retrieves specified company.</p>

86

Bu Sun Kim

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

[diff] [blame]

87

<code><a href="#list">list(parent, pageToken=None, requireOpenJobs=None, pageSize=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

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

[diff] [blame]

88

<p class="firstline">Lists all companies associated with the service account.</p>

89

90

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

91

<p class="firstline">Retrieves the next page of results.</p>

92

Dan O'Meara

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

[diff] [blame]

93

<code><a href="#patch">patch(name, body=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

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

[diff] [blame]

94

<p class="firstline">Updates specified company. Company names can't be updated. To update a</p>

95

<h3>Method Details</h3>

96

Dan O'Meara

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

[diff] [blame]

97

<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>

Bu Sun Kim

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

[diff] [blame]

98

<pre>Creates a new company entity.

99

100

Args:

Dan O'Meara

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

[diff] [blame]

101

parent: string, Required. Resource name of the project under which the company is created.

Bu Sun Kim

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

[diff] [blame]

102

Bu Sun Kim

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

[diff] [blame]

103

The format is "projects/{project_id}", for example,

104

"projects/api-test-project". (required)

Dan O'Meara

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

[diff] [blame]

105

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

106

The object takes the form of:

{ # Input only.

#

# The Request of the CreateCompany method.

Bu Sun Kim

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

[diff] [blame]

111

"company": { # A Company resource represents a company in the service. A company is the # Required. The company to be created.

Bu Sun Kim

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

[diff] [blame]

112

# entity that owns job postings, that is, the hiring entity responsible for

113

# employing applicants for the job position.

Bu Sun Kim

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

[diff] [blame]

114

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

115

# employers.

Bu Sun Kim

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

[diff] [blame]

116

#

Bu Sun Kim

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

[diff] [blame]

117

# Defaults to false if not provided.

118

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

119

# for example, "https://www.google.com".

Bu Sun Kim

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

[diff] [blame]

120

#

Bu Sun Kim

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

[diff] [blame]

121

# The maximum number of allowed characters is 255.

Bu Sun Kim

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

[diff] [blame^]

122

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

Bu Sun Kim

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

[diff] [blame]

123

"externalId": "A String", # Required. Client side company identifier, used to uniquely identify the

124

# company.

125

#

126

# The maximum number of allowed characters is 255.

Bu Sun Kim

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

[diff] [blame^]

127

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

128

# site, for example, "https://careers.google.com".

Bu Sun Kim

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

[diff] [blame]

129

"displayName": "A String", # Required. The display name of the company, for example, "Google LLC".

130

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

Bu Sun Kim

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

[diff] [blame]

131

# different from the job location. The service attempts

132

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

133

# location wherever possible in DerivedInfo.headquarters_location.

Bu Sun Kim

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

[diff] [blame]

134

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

135

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

136

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

137

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

138

# parenthesis, brackets and special symbols won't be properly searchable,

139

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

140

"A String",

141

],

142

"derivedInfo": { # Derived details about the company. # Output only. Derived details about the company.

143

"headquartersLocation": { # Output only. # A structured headquarters location of the company, resolved from

Bu Sun Kim

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

[diff] [blame]

144

# Company.hq_location if provided.

145

#

146

# A resource that represents a location with full geographic information.

Bu Sun Kim

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

[diff] [blame^]

147

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

148

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

149

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

150

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

151

# 6.17 miles.

152

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

153

# of doubles representing degrees latitude and degrees longitude. Unless

154

# specified otherwise, this must conform to the

155

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

156

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

157

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

158

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

159

},

Bu Sun Kim

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

[diff] [blame]

160

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

161

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

162

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

163

# delivery location.

164

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

165

# Box or similar.

166

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

167

# mountains).

168

#

169

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

170

# existing data, depending on the type of process.

171

#

172

# Advice on address input / editing:

173

# - Use an i18n-ready address widget such as

Dan O'Meara

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

[diff] [blame]

174

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

Bu Sun Kim

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

[diff] [blame]

175

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

176

# fields outside countries where that field is used.

177

#

178

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

179

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

Bu Sun Kim

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

[diff] [blame]

180

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

181

# the latest revision.

Bu Sun Kim

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

[diff] [blame]

182

#

Bu Sun Kim

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

[diff] [blame]

183

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

184

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

Bu Sun Kim

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

[diff] [blame]

185

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

186

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

187

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

Bu Sun Kim

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

[diff] [blame]

188

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

Bu Sun Kim

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

[diff] [blame]

189

# addresses of a country or region.

190

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

191

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

Bu Sun Kim

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

[diff] [blame]

192

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

193

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

Bu Sun Kim

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

[diff] [blame]

194

# in Switzerland this should be left unpopulated.

Bu Sun Kim

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

[diff] [blame]

195

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

196

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

197

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

198

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

199

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

200

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

201

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

Bu Sun Kim

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

[diff] [blame]

202

#

203

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

204

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

Bu Sun Kim

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

[diff] [blame]

205

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

206

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

Bu Sun Kim

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

[diff] [blame]

207

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

208

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

209

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

210

# an address can be selected based on the language.

211

#

212

# The minimum permitted structural representation of an address consists

213

# of a region_code with all remaining information placed in the

214

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

215

# approximately without geocoding, but no semantic reasoning could be

216

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

217

# partially resolved.

218

#

219

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

220

# then geocoding is the recommended way to handle completely unstructured

221

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

222

# localities or administrative areas).

Bu Sun Kim

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

[diff] [blame]

223

"A String",

Bu Sun Kim

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

[diff] [blame]

224

],

Bu Sun Kim

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

[diff] [blame]

225

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

226

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

227

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

228

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

Bu Sun Kim

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

[diff] [blame]

229

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

230

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

231

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

232

# transliterated equivalents.

233

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

234

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

235

# other non-formatting related operations.

Bu Sun Kim

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

[diff] [blame]

236

#

Bu Sun Kim

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

[diff] [blame]

237

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

238

# possibly incorrect default).

239

#

240

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

241

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

242

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

243

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

244

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

245

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

246

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

247

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

248

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

249

"A String",

250

],

251

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

252

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

253

},

254

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

255

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

256

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

257

# LocationType#LOCALITY.

Bu Sun Kim

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

[diff] [blame]

258

},

259

},

Bu Sun Kim

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

[diff] [blame]

260

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

Bu Sun Kim

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

[diff] [blame]

261

# public availability by the service when job content appears suspicious,

262

# abusive, or spammy.

Bu Sun Kim

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

[diff] [blame]

263

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

264

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

265

# roles.

Bu Sun Kim

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

[diff] [blame]

266

#

Bu Sun Kim

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

[diff] [blame]

267

# The maximum number of allowed characters is 500.

268

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

269

#

270

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

271

# company is created.

272

#

273

# The format is "projects/{project_id}/companies/{company_id}", for example,

274

# "projects/api-test-project/companies/foo".

Bu Sun Kim

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

[diff] [blame^]

275

"imageUri": "A String", # Optional. A URI that hosts the employer's company logo.

Bu Sun Kim

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

[diff] [blame]

},

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

286

287

{ # A Company resource represents a company in the service. A company is the

288

# entity that owns job postings, that is, the hiring entity responsible for

289

# employing applicants for the job position.

Bu Sun Kim

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

[diff] [blame]

290

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

291

# employers.

Bu Sun Kim

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

[diff] [blame]

292

#

Bu Sun Kim

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

[diff] [blame]

293

# Defaults to false if not provided.

294

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

295

# for example, "https://www.google.com".

Bu Sun Kim

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

[diff] [blame]

296

#

Bu Sun Kim

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

[diff] [blame]

297

# The maximum number of allowed characters is 255.

Bu Sun Kim

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

[diff] [blame^]

298

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

Bu Sun Kim

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

[diff] [blame]

299

"externalId": "A String", # Required. Client side company identifier, used to uniquely identify the

300

# company.

301

#

302

# The maximum number of allowed characters is 255.

Bu Sun Kim

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

[diff] [blame^]

303

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

304

# site, for example, "https://careers.google.com".

Bu Sun Kim

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

[diff] [blame]

305

"displayName": "A String", # Required. The display name of the company, for example, "Google LLC".

306

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

Bu Sun Kim

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

[diff] [blame]

307

# different from the job location. The service attempts

308

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

309

# location wherever possible in DerivedInfo.headquarters_location.

Bu Sun Kim

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

[diff] [blame]

310

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

311

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

312

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

313

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

314

# parenthesis, brackets and special symbols won't be properly searchable,

315

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

316

"A String",

317

],

318

"derivedInfo": { # Derived details about the company. # Output only. Derived details about the company.

319

"headquartersLocation": { # Output only. # A structured headquarters location of the company, resolved from

Bu Sun Kim

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

[diff] [blame]

320

# Company.hq_location if provided.

321

#

322

# A resource that represents a location with full geographic information.

Bu Sun Kim

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

[diff] [blame^]

323

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

324

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

325

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

326

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

327

# 6.17 miles.

328

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

329

# of doubles representing degrees latitude and degrees longitude. Unless

330

# specified otherwise, this must conform to the

331

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

332

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

333

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

334

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

335

},

Bu Sun Kim

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

[diff] [blame]

336

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

337

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

338

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

339

# delivery location.

340

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

341

# Box or similar.

342

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

343

# mountains).

344

#

345

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

346

# existing data, depending on the type of process.

347

#

348

# Advice on address input / editing:

349

# - Use an i18n-ready address widget such as

Dan O'Meara

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

[diff] [blame]

350

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

Bu Sun Kim

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

[diff] [blame]

351

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

352

# fields outside countries where that field is used.

353

#

354

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

355

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

Bu Sun Kim

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

[diff] [blame]

356

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

357

# the latest revision.

Bu Sun Kim

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

[diff] [blame]

358

#

Bu Sun Kim

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

[diff] [blame]

359

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

360

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

Bu Sun Kim

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

[diff] [blame]

361

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

362

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

363

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

Bu Sun Kim

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

[diff] [blame]

364

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

Bu Sun Kim

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

[diff] [blame]

365

# addresses of a country or region.

366

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

367

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

Bu Sun Kim

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

[diff] [blame]

368

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

369

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

Bu Sun Kim

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

[diff] [blame]

370

# in Switzerland this should be left unpopulated.

Bu Sun Kim

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

[diff] [blame]

371

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

372

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

373

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

374

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

375

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

376

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

377

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

Bu Sun Kim

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

[diff] [blame]

378

#

379

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

380

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

Bu Sun Kim

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

[diff] [blame]

381

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

382

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

Bu Sun Kim

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

[diff] [blame]

383

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

384

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

385

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

386

# an address can be selected based on the language.

387

#

388

# The minimum permitted structural representation of an address consists

389

# of a region_code with all remaining information placed in the

390

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

391

# approximately without geocoding, but no semantic reasoning could be

392

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

393

# partially resolved.

394

#

395

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

396

# then geocoding is the recommended way to handle completely unstructured

397

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

398

# localities or administrative areas).

Bu Sun Kim

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

[diff] [blame]

399

"A String",

Bu Sun Kim

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

[diff] [blame]

400

],

Bu Sun Kim

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

[diff] [blame]

401

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

402

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

403

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

404

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

Bu Sun Kim

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

[diff] [blame]

405

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

406

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

407

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

408

# transliterated equivalents.

409

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

410

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

411

# other non-formatting related operations.

Bu Sun Kim

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

[diff] [blame]

412

#

Bu Sun Kim

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

[diff] [blame]

413

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

414

# possibly incorrect default).

415

#

416

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

417

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

418

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

419

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

420

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

421

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

422

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

423

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

424

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

425

"A String",

426

],

427

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

428

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

429

},

430

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

431

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

432

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

433

# LocationType#LOCALITY.

Bu Sun Kim

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

[diff] [blame]

434

},

435

},

Bu Sun Kim

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

[diff] [blame]

436

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

Bu Sun Kim

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

[diff] [blame]

437

# public availability by the service when job content appears suspicious,

438

# abusive, or spammy.

Bu Sun Kim

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

[diff] [blame]

439

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

440

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

441

# roles.

Bu Sun Kim

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

[diff] [blame]

442

#

Bu Sun Kim

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

[diff] [blame]

443

# The maximum number of allowed characters is 500.

444

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

445

#

446

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

447

# company is created.

448

#

449

# The format is "projects/{project_id}/companies/{company_id}", for example,

450

# "projects/api-test-project/companies/foo".

Bu Sun Kim

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

[diff] [blame^]

451

"imageUri": "A String", # Optional. A URI that hosts the employer's company logo.

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>

457

<pre>Deletes specified company.

458

Prerequisite: The company has no jobs associated with it.

459

460

Args:

Dan O'Meara

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

[diff] [blame]

461

Bu Sun Kim

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

[diff] [blame]

462

Bu Sun Kim

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

[diff] [blame]

463

The format is "projects/{project_id}/companies/{company_id}", for example,

464

"projects/api-test-project/companies/foo". (required)

Bu Sun Kim

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

[diff] [blame]

465

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

472

473

{ # A generic empty message that you can re-use to avoid defining duplicated

474

# empty messages in your APIs. A typical example is to use it as the request

475

# or the response type of an API method. For instance:

476

#

477

# service Foo {

478

# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);

479

# }

480

#

481

# The JSON representation for `Empty` is empty JSON object `{}`.

}</pre>

</div>

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

487

<pre>Retrieves specified company.

488

489

Args:

Dan O'Meara

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

[diff] [blame]

490

Bu Sun Kim

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

[diff] [blame]

491

Bu Sun Kim

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

[diff] [blame]

492

The format is "projects/{project_id}/companies/{company_id}", for example,

493

"projects/api-test-project/companies/foo". (required)

Bu Sun Kim

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

[diff] [blame]

494

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

501

502

{ # A Company resource represents a company in the service. A company is the

503

# entity that owns job postings, that is, the hiring entity responsible for

504

# employing applicants for the job position.

Bu Sun Kim

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

[diff] [blame]

505

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

506

# employers.

Bu Sun Kim

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

[diff] [blame]

507

#

Bu Sun Kim

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

[diff] [blame]

508

# Defaults to false if not provided.

509

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

510

# for example, "https://www.google.com".

Bu Sun Kim

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

[diff] [blame]

511

#

Bu Sun Kim

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

[diff] [blame]

512

# The maximum number of allowed characters is 255.

Bu Sun Kim

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

[diff] [blame^]

513

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

Bu Sun Kim

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

[diff] [blame]

514

"externalId": "A String", # Required. Client side company identifier, used to uniquely identify the

515

# company.

516

#

517

# The maximum number of allowed characters is 255.

Bu Sun Kim

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

[diff] [blame^]

518

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

519

# site, for example, "https://careers.google.com".

Bu Sun Kim

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

[diff] [blame]

520

"displayName": "A String", # Required. The display name of the company, for example, "Google LLC".

521

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

Bu Sun Kim

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

[diff] [blame]

522

# different from the job location. The service attempts

523

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

524

# location wherever possible in DerivedInfo.headquarters_location.

Bu Sun Kim

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

[diff] [blame]

525

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

526

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

527

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

528

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

529

# parenthesis, brackets and special symbols won't be properly searchable,

530

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

531

"A String",

532

],

533

"derivedInfo": { # Derived details about the company. # Output only. Derived details about the company.

534

"headquartersLocation": { # Output only. # A structured headquarters location of the company, resolved from

Bu Sun Kim

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

[diff] [blame]

535

# Company.hq_location if provided.

536

#

537

# A resource that represents a location with full geographic information.

Bu Sun Kim

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

[diff] [blame^]

538

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

539

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

540

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

541

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

542

# 6.17 miles.

543

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

544

# of doubles representing degrees latitude and degrees longitude. Unless

545

# specified otherwise, this must conform to the

546

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

547

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

548

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

549

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

550

},

Bu Sun Kim

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

[diff] [blame]

551

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

552

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

553

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

554

# delivery location.

555

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

556

# Box or similar.

557

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

558

# mountains).

559

#

560

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

561

# existing data, depending on the type of process.

562

#

563

# Advice on address input / editing:

564

# - Use an i18n-ready address widget such as

Dan O'Meara

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

[diff] [blame]

565

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

Bu Sun Kim

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

[diff] [blame]

566

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

567

# fields outside countries where that field is used.

568

#

569

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

570

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

Bu Sun Kim

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

[diff] [blame]

571

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

572

# the latest revision.

Bu Sun Kim

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

[diff] [blame]

573

#

Bu Sun Kim

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

[diff] [blame]

574

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

575

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

Bu Sun Kim

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

[diff] [blame]

576

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

577

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

578

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

Bu Sun Kim

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

[diff] [blame]

579

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

Bu Sun Kim

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

[diff] [blame]

580

# addresses of a country or region.

581

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

582

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

Bu Sun Kim

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

[diff] [blame]

583

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

584

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

Bu Sun Kim

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

[diff] [blame]

585

# in Switzerland this should be left unpopulated.

Bu Sun Kim

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

[diff] [blame]

586

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

587

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

588

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

589

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

590

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

591

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

592

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

Bu Sun Kim

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

[diff] [blame]

593

#

594

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

595

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

Bu Sun Kim

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

[diff] [blame]

596

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

597

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

Bu Sun Kim

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

[diff] [blame]

598

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

599

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

600

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

601

# an address can be selected based on the language.

602

#

603

# The minimum permitted structural representation of an address consists

604

# of a region_code with all remaining information placed in the

605

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

606

# approximately without geocoding, but no semantic reasoning could be

607

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

608

# partially resolved.

609

#

610

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

611

# then geocoding is the recommended way to handle completely unstructured

612

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

613

# localities or administrative areas).

Bu Sun Kim

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

[diff] [blame]

614

"A String",

Bu Sun Kim

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

[diff] [blame]

615

],

Bu Sun Kim

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

[diff] [blame]

616

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

617

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

618

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

619

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

Bu Sun Kim

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

[diff] [blame]

620

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

621

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

622

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

623

# transliterated equivalents.

624

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

625

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

626

# other non-formatting related operations.

Bu Sun Kim

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

[diff] [blame]

627

#

Bu Sun Kim

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

[diff] [blame]

628

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

629

# possibly incorrect default).

630

#

631

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

632

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

633

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

634

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

635

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

636

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

637

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

638

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

639

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

640

"A String",

641

],

642

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

643

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

644

},

645

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

646

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

647

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

648

# LocationType#LOCALITY.

Bu Sun Kim

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

[diff] [blame]

649

},

650

},

Bu Sun Kim

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

[diff] [blame]

651

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

Bu Sun Kim

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

[diff] [blame]

652

# public availability by the service when job content appears suspicious,

653

# abusive, or spammy.

Bu Sun Kim

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

[diff] [blame]

654

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

655

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

656

# roles.

Bu Sun Kim

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

[diff] [blame]

657

#

Bu Sun Kim

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

[diff] [blame]

658

# The maximum number of allowed characters is 500.

659

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

660

#

661

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

662

# company is created.

663

#

664

# The format is "projects/{project_id}/companies/{company_id}", for example,

665

# "projects/api-test-project/companies/foo".

Bu Sun Kim

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

[diff] [blame^]

666

"imageUri": "A String", # Optional. A URI that hosts the employer's company logo.

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]

671

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

Bu Sun Kim

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

[diff] [blame]

672

<pre>Lists all companies associated with the service account.

673

674

Args:

Dan O'Meara

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

[diff] [blame]

675

parent: string, Required. Resource name of the project under which the company is created.

Bu Sun Kim

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

[diff] [blame]

676

Bu Sun Kim

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

[diff] [blame]

677

The format is "projects/{project_id}", for example,

678

"projects/api-test-project". (required)

679

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

Dan O'Meara

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

[diff] [blame]

680

requireOpenJobs: boolean, Optional. Set to true if the companies requested 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

685

only those with open jobs are returned.

Bu Sun Kim

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

[diff] [blame]

686

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

687

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

Bu Sun Kim

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

[diff] [blame]

688

x__xgafv: string, V1 error format.

689

Allowed values

690

1 - v1 error format

691

2 - v2 error format

Bu Sun Kim

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

[diff] [blame]

692

693

Returns:

694

An object of the form:

{ # Output only.

#

# The List companies response object.

Bu Sun Kim

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

[diff] [blame]

699

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

Bu Sun Kim

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

[diff] [blame]

700

{ # A Company resource represents a company in the service. A company is the

701

# entity that owns job postings, that is, the hiring entity responsible for

702

# employing applicants for the job position.

Bu Sun Kim

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

[diff] [blame]

703

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

704

# employers.

Bu Sun Kim

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

[diff] [blame]

705

#

Bu Sun Kim

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

[diff] [blame]

706

# Defaults to false if not provided.

707

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

708

# for example, "https://www.google.com".

Bu Sun Kim

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

[diff] [blame]

709

#

Bu Sun Kim

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

[diff] [blame]

710

# The maximum number of allowed characters is 255.

Bu Sun Kim

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

[diff] [blame^]

711

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

Bu Sun Kim

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

[diff] [blame]

712

"externalId": "A String", # Required. Client side company identifier, used to uniquely identify the

713

# company.

714

#

715

# The maximum number of allowed characters is 255.

Bu Sun Kim

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

[diff] [blame^]

716

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

717

# site, for example, "https://careers.google.com".

Bu Sun Kim

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

[diff] [blame]

718

"displayName": "A String", # Required. The display name of the company, for example, "Google LLC".

719

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

Bu Sun Kim

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

[diff] [blame]

720

# different from the job location. The service attempts

721

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

722

# location wherever possible in DerivedInfo.headquarters_location.

Bu Sun Kim

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

[diff] [blame]

723

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

724

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

725

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

726

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

727

# parenthesis, brackets and special symbols won't be properly searchable,

728

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

729

"A String",

730

],

731

"derivedInfo": { # Derived details about the company. # Output only. Derived details about the company.

732

"headquartersLocation": { # Output only. # A structured headquarters location of the company, resolved from

Bu Sun Kim

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

[diff] [blame]

733

# Company.hq_location if provided.

734

#

735

# A resource that represents a location with full geographic information.

Bu Sun Kim

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

[diff] [blame^]

736

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

737

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

738

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

739

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

740

# 6.17 miles.

741

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

742

# of doubles representing degrees latitude and degrees longitude. Unless

743

# specified otherwise, this must conform to the

744

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

745

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

746

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

747

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

748

},

Bu Sun Kim

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

[diff] [blame]

749

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

750

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

751

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

752

# delivery location.

753

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

754

# Box or similar.

755

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

756

# mountains).

757

#

758

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

759

# existing data, depending on the type of process.

760

#

761

# Advice on address input / editing:

762

# - Use an i18n-ready address widget such as

Dan O'Meara

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

[diff] [blame]

763

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

Bu Sun Kim

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

[diff] [blame]

764

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

765

# fields outside countries where that field is used.

766

#

767

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

768

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

Bu Sun Kim

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

[diff] [blame]

769

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

770

# the latest revision.

Bu Sun Kim

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

[diff] [blame]

771

#

Bu Sun Kim

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

[diff] [blame]

772

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

773

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

Bu Sun Kim

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

[diff] [blame]

774

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

775

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

776

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

Bu Sun Kim

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

[diff] [blame]

777

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

Bu Sun Kim

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

[diff] [blame]

778

# addresses of a country or region.

779

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

780

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

Bu Sun Kim

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

[diff] [blame]

781

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

782

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

Bu Sun Kim

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

[diff] [blame]

783

# in Switzerland this should be left unpopulated.

Bu Sun Kim

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

[diff] [blame]

784

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

785

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

786

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

787

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

788

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

789

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

790

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

Bu Sun Kim

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

[diff] [blame]

791

#

792

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

793

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

Bu Sun Kim

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

[diff] [blame]

794

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

795

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

Bu Sun Kim

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

[diff] [blame]

796

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

797

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

798

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

799

# an address can be selected based on the language.

800

#

801

# The minimum permitted structural representation of an address consists

802

# of a region_code with all remaining information placed in the

803

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

804

# approximately without geocoding, but no semantic reasoning could be

805

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

806

# partially resolved.

807

#

808

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

809

# then geocoding is the recommended way to handle completely unstructured

810

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

811

# localities or administrative areas).

Bu Sun Kim

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

[diff] [blame]

812

"A String",

Bu Sun Kim

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

[diff] [blame]

813

],

Bu Sun Kim

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

[diff] [blame]

814

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

815

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

816

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

817

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

Bu Sun Kim

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

[diff] [blame]

818

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

819

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

820

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

821

# transliterated equivalents.

822

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

823

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

824

# other non-formatting related operations.

Bu Sun Kim

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

[diff] [blame]

825

#

Bu Sun Kim

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

[diff] [blame]

826

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

827

# possibly incorrect default).

828

#

829

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

830

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

831

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

832

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

833

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

834

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

835

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

836

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

837

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

838

"A String",

839

],

840

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

841

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

842

},

843

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

844

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

845

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

846

# LocationType#LOCALITY.

Bu Sun Kim

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

[diff] [blame]

847

},

848

},

Bu Sun Kim

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

[diff] [blame]

849

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

Bu Sun Kim

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

[diff] [blame]

850

# public availability by the service when job content appears suspicious,

851

# abusive, or spammy.

Bu Sun Kim

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

[diff] [blame]

852

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

853

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

854

# roles.

Bu Sun Kim

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

[diff] [blame]

855

#

Bu Sun Kim

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

[diff] [blame]

856

# The maximum number of allowed characters is 500.

857

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

858

#

859

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

860

# company is created.

861

#

862

# The format is "projects/{project_id}/companies/{company_id}", for example,

863

# "projects/api-test-project/companies/foo".

Bu Sun Kim

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

[diff] [blame^]

864

"imageUri": "A String", # Optional. A URI that hosts the employer's company logo.

Bu Sun Kim

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

[diff] [blame]

865

},

866

],

Bu Sun Kim

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

[diff] [blame]

867

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

868

# tracking id.

869

#

870

# Additional information returned to client, such as debugging information.

Bu Sun Kim

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

[diff] [blame]

871

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

Bu Sun Kim

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

[diff] [blame]

872

# This id is logged for tracking purposes.

873

},

Bu Sun Kim

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

[diff] [blame^]

874

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

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>

880

<pre>Retrieves the next page of results.

881

882

Args:

883

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

884

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

885

886

Returns:

Bu Sun Kim

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

[diff] [blame]

887

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]

888

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]

893

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

Bu Sun Kim

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

[diff] [blame]

894

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

Bu Sun Kim

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

[diff] [blame]

895

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

902

company is created.

903

Bu Sun Kim

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

[diff] [blame]

904

The format is "projects/{project_id}/companies/{company_id}", for example,

905

"projects/api-test-project/companies/foo". (required)

Dan O'Meara

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

[diff] [blame]

906

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

907

The object takes the form of:

{ # Input only.

#

# Request for updating a specified company.

Bu Sun Kim

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

[diff] [blame]

912

"company": { # A Company resource represents a company in the service. A company is the # Required. The company resource to replace the current resource in the system.

Bu Sun Kim

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

[diff] [blame]

913

# entity that owns job postings, that is, the hiring entity responsible for

914

# employing applicants for the job position.

Bu Sun Kim

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

[diff] [blame]

915

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

916

# employers.

Bu Sun Kim

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

[diff] [blame]

917

#

Bu Sun Kim

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

[diff] [blame]

918

# Defaults to false if not provided.

919

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

920

# for example, "https://www.google.com".

Bu Sun Kim

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

[diff] [blame]

921

#

Bu Sun Kim

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

[diff] [blame]

922

# The maximum number of allowed characters is 255.

Bu Sun Kim

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

[diff] [blame^]

923

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

Bu Sun Kim

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

[diff] [blame]

924

"externalId": "A String", # Required. Client side company identifier, used to uniquely identify the

925

# company.

926

#

927

# The maximum number of allowed characters is 255.

Bu Sun Kim

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

[diff] [blame^]

928

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

929

# site, for example, "https://careers.google.com".

Bu Sun Kim

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

[diff] [blame]

930

"displayName": "A String", # Required. The display name of the company, for example, "Google LLC".

931

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

Bu Sun Kim

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

[diff] [blame]

932

# different from the job location. The service attempts

933

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

934

# location wherever possible in DerivedInfo.headquarters_location.

Bu Sun Kim

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

[diff] [blame]

935

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

936

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

937

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

938

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

939

# parenthesis, brackets and special symbols won't be properly searchable,

940

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

941

"A String",

942

],

943

"derivedInfo": { # Derived details about the company. # Output only. Derived details about the company.

944

"headquartersLocation": { # Output only. # A structured headquarters location of the company, resolved from

Bu Sun Kim

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

[diff] [blame]

945

# Company.hq_location if provided.

946

#

947

# A resource that represents a location with full geographic information.

Bu Sun Kim

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

[diff] [blame^]

948

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

949

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

950

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

951

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

952

# 6.17 miles.

953

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

954

# of doubles representing degrees latitude and degrees longitude. Unless

955

# specified otherwise, this must conform to the

956

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

957

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

958

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

959

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

960

},

Bu Sun Kim

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

[diff] [blame]

961

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

962

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

963

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

964

# delivery location.

965

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

966

# Box or similar.

967

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

968

# mountains).

969

#

970

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

971

# existing data, depending on the type of process.

972

#

973

# Advice on address input / editing:

974

# - Use an i18n-ready address widget such as

Dan O'Meara

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

[diff] [blame]

975

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

Bu Sun Kim

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

[diff] [blame]

976

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

977

# fields outside countries where that field is used.

978

#

979

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

980

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

Bu Sun Kim

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

[diff] [blame]

981

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

982

# the latest revision.

Bu Sun Kim

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

[diff] [blame]

983

#

Bu Sun Kim

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

[diff] [blame]

984

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

985

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

Bu Sun Kim

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

[diff] [blame]

986

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

987

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

988

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

Bu Sun Kim

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

[diff] [blame]

989

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

Bu Sun Kim

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

[diff] [blame]

990

# addresses of a country or region.

991

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

992

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

Bu Sun Kim

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

[diff] [blame]

993

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

994

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

Bu Sun Kim

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

[diff] [blame]

995

# in Switzerland this should be left unpopulated.

Bu Sun Kim

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

[diff] [blame]

996

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

997

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

998

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

999

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

1000

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

1001

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

1002

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

Bu Sun Kim

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

[diff] [blame]

1003

#

1004

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

1005

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

Bu Sun Kim

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

[diff] [blame]

1006

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

1007

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

Bu Sun Kim

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

[diff] [blame]

1008

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

1009

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

1010

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

1011

# an address can be selected based on the language.

1012

#

1013

# The minimum permitted structural representation of an address consists

1014

# of a region_code with all remaining information placed in the

1015

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

1016

# approximately without geocoding, but no semantic reasoning could be

1017

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

1018

# partially resolved.

1019

#

1020

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

1021

# then geocoding is the recommended way to handle completely unstructured

1022

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

1023

# localities or administrative areas).

Bu Sun Kim

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

[diff] [blame]

1024

"A String",

Bu Sun Kim

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

[diff] [blame]

1025

],

Bu Sun Kim

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

[diff] [blame]

1026

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

1027

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

1028

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

1029

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

Bu Sun Kim

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

[diff] [blame]

1030

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

1031

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

1032

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

1033

# transliterated equivalents.

1034

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

1035

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

1036

# other non-formatting related operations.

Bu Sun Kim

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

[diff] [blame]

1037

#

Bu Sun Kim

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

[diff] [blame]

1038

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

1039

# possibly incorrect default).

1040

#

1041

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

1042

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

1043

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

1044

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

1045

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

1046

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

1047

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

1048

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

1049

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

1050

"A String",

1051

],

1052

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

1053

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

1054

},

1055

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

1056

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

1057

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

1058

# LocationType#LOCALITY.

Bu Sun Kim

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

[diff] [blame]

1059

},

1060

},

Bu Sun Kim

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

[diff] [blame]

1061

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

Bu Sun Kim

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

[diff] [blame]

1062

# public availability by the service when job content appears suspicious,

1063

# abusive, or spammy.

Bu Sun Kim

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

[diff] [blame]

1064

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

1065

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

1066

# roles.

Bu Sun Kim

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

[diff] [blame]

1067

#

Bu Sun Kim

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

[diff] [blame]

1068

# The maximum number of allowed characters is 500.

1069

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

1070

#

1071

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

1072

# company is created.

1073

#

1074

# The format is "projects/{project_id}/companies/{company_id}", for example,

1075

# "projects/api-test-project/companies/foo".

Bu Sun Kim

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

[diff] [blame^]

1076

"imageUri": "A String", # Optional. A URI that hosts the employer's company logo.

Bu Sun Kim

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

[diff] [blame]

1077

},

Bu Sun Kim

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

[diff] [blame^]

1078

"updateMask": "A String", # Optional but strongly recommended for the best service

1079

# experience.

1080

#

1081

# If update_mask is provided, only the specified fields in

1082

# company are updated. Otherwise all the fields are updated.

1083

#

1084

# A field mask to specify the company fields to be updated. Only

1085

# top level fields of Company are supported.

Bu Sun Kim

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

[diff] [blame]

1086

}

1087

1088

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1095

1096

{ # A Company resource represents a company in the service. A company is the

1097

# entity that owns job postings, that is, the hiring entity responsible for

1098

# employing applicants for the job position.

Bu Sun Kim

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

[diff] [blame]

1099

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

1100

# employers.

Bu Sun Kim

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

[diff] [blame]

1101

#

Bu Sun Kim

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

[diff] [blame]

1102

# Defaults to false if not provided.

1103

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

1104

# for example, "https://www.google.com".

Bu Sun Kim

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

[diff] [blame]

1105

#

Bu Sun Kim

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

[diff] [blame]

1106

# The maximum number of allowed characters is 255.

Bu Sun Kim

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

[diff] [blame^]

1107

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

Bu Sun Kim

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

[diff] [blame]

1108

"externalId": "A String", # Required. Client side company identifier, used to uniquely identify the

1109

# company.

1110

#

1111

# The maximum number of allowed characters is 255.

Bu Sun Kim

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

[diff] [blame^]

1112

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

1113

# site, for example, "https://careers.google.com".

Bu Sun Kim

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

[diff] [blame]

1114

"displayName": "A String", # Required. The display name of the company, for example, "Google LLC".

1115

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

Bu Sun Kim

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

[diff] [blame]

1116

# different from the job location. The service attempts

1117

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

1118

# location wherever possible in DerivedInfo.headquarters_location.

Bu Sun Kim

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

[diff] [blame]

1119

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

1120

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

1121

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

1122

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

1123

# parenthesis, brackets and special symbols won't be properly searchable,

1124

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

1125

"A String",

1126

],

1127

"derivedInfo": { # Derived details about the company. # Output only. Derived details about the company.

1128

"headquartersLocation": { # Output only. # A structured headquarters location of the company, resolved from

Bu Sun Kim

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

[diff] [blame]

1129

# Company.hq_location if provided.

1130

#

1131

# A resource that represents a location with full geographic information.

Bu Sun Kim

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

[diff] [blame^]

1132

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

1133

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

1134

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

1135

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

1136

# 6.17 miles.

1137

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

1138

# of doubles representing degrees latitude and degrees longitude. Unless

1139

# specified otherwise, this must conform to the

1140

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

1141

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

1142

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

1143

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

1144

},

Bu Sun Kim

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

[diff] [blame]

1145

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

1146

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

1147

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

1148

# delivery location.

1149

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

1150

# Box or similar.

1151

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

1152

# mountains).

1153

#

1154

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

1155

# existing data, depending on the type of process.

1156

#

1157

# Advice on address input / editing:

1158

# - Use an i18n-ready address widget such as

Dan O'Meara

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

[diff] [blame]

1159

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

Bu Sun Kim

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

[diff] [blame]

1160

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

1161

# fields outside countries where that field is used.

1162

#

1163

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

1164

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

Bu Sun Kim

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

[diff] [blame]

1165

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

1166

# the latest revision.

Bu Sun Kim

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

[diff] [blame]

1167

#

Bu Sun Kim

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

[diff] [blame]

1168

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

1169

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

Bu Sun Kim

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

[diff] [blame]

1170

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

1171

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

1172

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

Bu Sun Kim

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

[diff] [blame]

1173

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

Bu Sun Kim

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

[diff] [blame]

1174

# addresses of a country or region.

1175

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

1176

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

Bu Sun Kim

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

[diff] [blame]

1177

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

1178

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

Bu Sun Kim

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

[diff] [blame]

1179

# in Switzerland this should be left unpopulated.

Bu Sun Kim

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

[diff] [blame]

1180

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

1181

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

1182

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

1183

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

1184

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

1185

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

1186

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

Bu Sun Kim

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

[diff] [blame]

1187

#

1188

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

1189

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

Bu Sun Kim

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

[diff] [blame]

1190

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

1191

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

Bu Sun Kim

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

[diff] [blame]

1192

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

1193

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

1194

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

1195

# an address can be selected based on the language.

1196

#

1197

# The minimum permitted structural representation of an address consists

1198

# of a region_code with all remaining information placed in the

1199

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

1200

# approximately without geocoding, but no semantic reasoning could be

1201

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

1202

# partially resolved.

1203

#

1204

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

1205

# then geocoding is the recommended way to handle completely unstructured

1206

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

1207

# localities or administrative areas).

Bu Sun Kim

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

[diff] [blame]

1208

"A String",

Bu Sun Kim

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

[diff] [blame]

1209

],

Bu Sun Kim

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

[diff] [blame]

1210

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

1211

# postal codes to be present, but where they are used, they may trigger

1212

# additional validation with other parts of the address (e.g. state/zip

1213

# validation in the U.S.A.).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1214

"languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if

1215

# known). This is often the UI language of the input form or is expected

1216

# to match one of the languages used in the address' country/region, or their

1217

# transliterated equivalents.

1218

# This can affect formatting in certain countries, but is not critical

1219

# to the correctness of the data and will never affect any validation or

1220

# other non-formatting related operations.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1221

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1222

# If this value is not known, it should be omitted (rather than specifying a

1223

# possibly incorrect default).

1224

#

1225

# Examples: "zh-Hant", "ja", "ja-Latn", "en".

1226

"sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used

1227

# in most regions. Where it is used, the value is either a string like

1228

# "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number

1229

# alone, representing the "sector code" (Jamaica), "delivery area indicator"

1230

# (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

1231

"recipients": [ # Optional. The recipient at the address.

1232

# This field may, under certain circumstances, contain multiline information.

1233

# For example, it might contain "care of" information.

1234

"A String",

1235

],

1236

"sublocality": "A String", # Optional. Sublocality of the address.

1237

# For example, this can be neighborhoods, boroughs, districts.

1238

},

1239

"locationType": "A String", # The type of a location, which corresponds to the address lines field of

1240

# PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of

1241

# LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of

1242

# LocationType#LOCALITY.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1243

},

1244

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1245

"suspended": True or False, # Output only. Indicates whether a company is flagged to be suspended from

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1246

# public availability by the service when job content appears suspicious,

1247

# abusive, or spammy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1248

"eeoText": "A String", # Optional. Equal Employment Opportunity legal disclaimer text to be

1249

# associated with all jobs, and typically to be displayed in all

1250

# roles.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1251

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1252

# The maximum number of allowed characters is 500.

1253

"name": "A String", # Required during company update.

1254

#

1255

# The resource name for a company. This is generated by the service when a

1256

# company is created.

1257

#

1258

# The format is "projects/{project_id}/companies/{company_id}", for example,

1259

# "projects/api-test-project/companies/foo".

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1260

"imageUri": "A String", # Optional. A URI that hosts the employer's company logo.

Bu Sun Kim