Blame - docs/dyn/jobs_v3.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

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

Bu Sun Kim

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

[diff] [blame]

115

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

116

# roles.

117

#

118

# The maximum number of allowed characters is 500.

Bu Sun Kim

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

[diff] [blame]

119

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

120

#

121

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

122

# company is created.

123

#

124

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

125

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

126

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

127

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

128

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

129

# employers.

130

#

131

# Defaults to false if not provided.

132

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

133

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

134

#

135

# The maximum number of allowed characters is 255.

136

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

137

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

138

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

139

# company.

140

#

141

# The maximum number of allowed characters is 255.

142

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

143

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

144

# different from the job location. The service attempts

145

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

146

# location wherever possible in DerivedInfo.headquarters_location.

147

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

148

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

149

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

150

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

151

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

152

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

153

"A String",

154

],

155

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

156

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

Bu Sun Kim

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

[diff] [blame]

157

# Company.hq_location if provided.

158

#

159

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

Bu Sun Kim

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

[diff] [blame]

160

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

Bu Sun Kim

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

[diff] [blame]

161

# of doubles representing degrees latitude and degrees longitude. Unless

162

# specified otherwise, this must conform to the

Bu Sun Kim

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

[diff] [blame]

163

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

Dan O'Meara

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

[diff] [blame]

164

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

Bu Sun Kim

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

[diff] [blame]

165

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

166

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

167

},

Bu Sun Kim

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

[diff] [blame]

168

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

169

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

170

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

171

# delivery location.

172

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

173

# Box or similar.

174

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

175

# mountains).

176

#

177

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

178

# existing data, depending on the type of process.

179

#

180

# Advice on address input / editing:

181

# - Use an i18n-ready address widget such as

Dan O'Meara

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

[diff] [blame]

182

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

Bu Sun Kim

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

[diff] [blame]

183

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

184

# fields outside countries where that field is used.

185

#

186

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

187

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

Bu Sun Kim

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

[diff] [blame]

188

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

189

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

190

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

191

# the latest revision.

Bu Sun Kim

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

[diff] [blame]

192

#

Bu Sun Kim

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

[diff] [blame]

193

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

194

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

195

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

196

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

197

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

Bu Sun Kim

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

[diff] [blame]

198

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

Bu Sun Kim

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

[diff] [blame]

199

# addresses of a country or region.

200

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

201

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

Bu Sun Kim

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

[diff] [blame]

202

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

203

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

204

# in Switzerland this should be left unpopulated.

Bu Sun Kim

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

[diff] [blame]

205

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

206

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

207

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

208

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

209

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

210

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

211

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

Bu Sun Kim

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

[diff] [blame]

212

#

213

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

214

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

Bu Sun Kim

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

[diff] [blame]

215

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

216

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

Bu Sun Kim

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

[diff] [blame]

217

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

218

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

219

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

220

# an address can be selected based on the language.

221

#

222

# The minimum permitted structural representation of an address consists

223

# of a region_code with all remaining information placed in the

224

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

225

# approximately without geocoding, but no semantic reasoning could be

226

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

227

# partially resolved.

228

#

229

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

230

# then geocoding is the recommended way to handle completely unstructured

231

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

232

# localities or administrative areas).

Bu Sun Kim

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

[diff] [blame]

233

"A String",

Bu Sun Kim

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

[diff] [blame]

234

],

Bu Sun Kim

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

[diff] [blame]

235

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

236

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

237

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

238

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

Bu Sun Kim

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

[diff] [blame]

239

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

240

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

241

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

242

# transliterated equivalents.

243

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

244

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

245

# other non-formatting related operations.

Bu Sun Kim

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

[diff] [blame]

246

#

Bu Sun Kim

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

[diff] [blame]

247

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

248

# possibly incorrect default).

249

#

250

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

251

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

252

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

253

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

254

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

255

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

256

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

257

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

258

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

259

"A String",

260

],

Bu Sun Kim

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

[diff] [blame]

261

},

Bu Sun Kim

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

[diff] [blame]

262

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

263

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

264

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

265

# LocationType#LOCALITY.

266

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

267

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

268

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

269

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

270

# 6.17 miles.

Bu Sun Kim

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

[diff] [blame]

271

},

272

},

Bu Sun Kim

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

[diff] [blame]

273

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

274

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

275

# abusive, or spammy.

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

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

Bu Sun Kim

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

[diff] [blame]

291

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

292

# roles.

293

#

294

# The maximum number of allowed characters is 500.

Bu Sun Kim

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

[diff] [blame]

295

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

296

#

297

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

298

# company is created.

299

#

300

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

301

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

302

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

303

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

304

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

305

# employers.

306

#

307

# Defaults to false if not provided.

308

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

309

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

310

#

311

# The maximum number of allowed characters is 255.

312

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

313

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

314

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

315

# company.

316

#

317

# The maximum number of allowed characters is 255.

318

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

319

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

320

# different from the job location. The service attempts

321

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

322

# location wherever possible in DerivedInfo.headquarters_location.

323

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

324

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

325

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

326

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

327

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

328

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

329

"A String",

330

],

331

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

332

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

Bu Sun Kim

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

[diff] [blame]

333

# Company.hq_location if provided.

334

#

335

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

Bu Sun Kim

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

[diff] [blame]

336

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

Bu Sun Kim

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

[diff] [blame]

337

# of doubles representing degrees latitude and degrees longitude. Unless

338

# specified otherwise, this must conform to the

Bu Sun Kim

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

[diff] [blame]

339

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

Dan O'Meara

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

[diff] [blame]

340

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

Bu Sun Kim

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

[diff] [blame]

341

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

342

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

343

},

Bu Sun Kim

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

[diff] [blame]

344

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

345

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

346

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

347

# delivery location.

348

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

349

# Box or similar.

350

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

351

# mountains).

352

#

353

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

354

# existing data, depending on the type of process.

355

#

356

# Advice on address input / editing:

357

# - Use an i18n-ready address widget such as

Dan O'Meara

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

[diff] [blame]

358

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

Bu Sun Kim

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

[diff] [blame]

359

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

360

# fields outside countries where that field is used.

361

#

362

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

363

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

Bu Sun Kim

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

[diff] [blame]

364

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

365

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

366

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

367

# the latest revision.

Bu Sun Kim

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

[diff] [blame]

368

#

Bu Sun Kim

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

[diff] [blame]

369

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

370

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

371

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

372

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

373

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

Bu Sun Kim

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

[diff] [blame]

374

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

Bu Sun Kim

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

[diff] [blame]

375

# addresses of a country or region.

376

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

377

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

Bu Sun Kim

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

[diff] [blame]

378

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

379

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

380

# in Switzerland this should be left unpopulated.

Bu Sun Kim

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

[diff] [blame]

381

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

382

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

383

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

384

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

385

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

386

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

387

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

Bu Sun Kim

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

[diff] [blame]

388

#

389

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

390

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

Bu Sun Kim

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

[diff] [blame]

391

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

392

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

Bu Sun Kim

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

[diff] [blame]

393

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

394

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

395

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

396

# an address can be selected based on the language.

397

#

398

# The minimum permitted structural representation of an address consists

399

# of a region_code with all remaining information placed in the

400

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

401

# approximately without geocoding, but no semantic reasoning could be

402

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

403

# partially resolved.

404

#

405

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

406

# then geocoding is the recommended way to handle completely unstructured

407

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

408

# localities or administrative areas).

Bu Sun Kim

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

[diff] [blame]

409

"A String",

Bu Sun Kim

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

[diff] [blame]

410

],

Bu Sun Kim

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

[diff] [blame]

411

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

412

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

413

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

414

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

Bu Sun Kim

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

[diff] [blame]

415

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

416

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

417

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

418

# transliterated equivalents.

419

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

420

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

421

# other non-formatting related operations.

Bu Sun Kim

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

[diff] [blame]

422

#

Bu Sun Kim

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

[diff] [blame]

423

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

424

# possibly incorrect default).

425

#

426

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

427

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

428

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

429

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

430

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

431

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

432

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

433

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

434

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

435

"A String",

436

],

Bu Sun Kim

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

[diff] [blame]

437

},

Bu Sun Kim

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

[diff] [blame]

438

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

439

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

440

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

441

# LocationType#LOCALITY.

442

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

443

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

444

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

445

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

446

# 6.17 miles.

Bu Sun Kim

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

[diff] [blame]

447

},

448

},

Bu Sun Kim

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

[diff] [blame]

449

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

450

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

451

# abusive, or spammy.

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

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

Bu Sun Kim

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

[diff] [blame]

506

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

507

# roles.

508

#

509

# The maximum number of allowed characters is 500.

Bu Sun Kim

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

[diff] [blame]

510

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

511

#

512

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

513

# company is created.

514

#

515

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

516

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

517

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

518

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

519

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

520

# employers.

521

#

522

# Defaults to false if not provided.

523

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

524

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

525

#

526

# The maximum number of allowed characters is 255.

527

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

528

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

529

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

530

# company.

531

#

532

# The maximum number of allowed characters is 255.

533

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

534

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

535

# different from the job location. The service attempts

536

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

537

# location wherever possible in DerivedInfo.headquarters_location.

538

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

539

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

540

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

541

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

542

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

543

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

544

"A String",

545

],

546

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

547

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

Bu Sun Kim

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

[diff] [blame]

548

# Company.hq_location if provided.

549

#

550

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

Bu Sun Kim

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

[diff] [blame]

551

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

Bu Sun Kim

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

[diff] [blame]

552

# of doubles representing degrees latitude and degrees longitude. Unless

553

# specified otherwise, this must conform to the

Bu Sun Kim

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

[diff] [blame]

554

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

Dan O'Meara

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

[diff] [blame]

555

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

Bu Sun Kim

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

[diff] [blame]

556

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

557

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

558

},

Bu Sun Kim

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

[diff] [blame]

559

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

560

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

561

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

562

# delivery location.

563

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

564

# Box or similar.

565

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

566

# mountains).

567

#

568

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

569

# existing data, depending on the type of process.

570

#

571

# Advice on address input / editing:

572

# - Use an i18n-ready address widget such as

Dan O'Meara

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

[diff] [blame]

573

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

Bu Sun Kim

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

[diff] [blame]

574

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

575

# fields outside countries where that field is used.

576

#

577

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

578

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

Bu Sun Kim

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

[diff] [blame]

579

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

580

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

581

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

582

# the latest revision.

Bu Sun Kim

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

[diff] [blame]

583

#

Bu Sun Kim

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

[diff] [blame]

584

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

585

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

586

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

587

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

588

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

Bu Sun Kim

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

[diff] [blame]

589

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

Bu Sun Kim

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

[diff] [blame]

590

# addresses of a country or region.

591

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

592

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

Bu Sun Kim

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

[diff] [blame]

593

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

594

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

595

# in Switzerland this should be left unpopulated.

Bu Sun Kim

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

[diff] [blame]

596

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

597

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

598

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

599

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

600

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

601

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

602

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

Bu Sun Kim

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

[diff] [blame]

603

#

604

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

605

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

Bu Sun Kim

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

[diff] [blame]

606

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

607

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

Bu Sun Kim

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

[diff] [blame]

608

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

609

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

610

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

611

# an address can be selected based on the language.

612

#

613

# The minimum permitted structural representation of an address consists

614

# of a region_code with all remaining information placed in the

615

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

616

# approximately without geocoding, but no semantic reasoning could be

617

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

618

# partially resolved.

619

#

620

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

621

# then geocoding is the recommended way to handle completely unstructured

622

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

623

# localities or administrative areas).

Bu Sun Kim

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

[diff] [blame]

624

"A String",

Bu Sun Kim

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

[diff] [blame]

625

],

Bu Sun Kim

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

[diff] [blame]

626

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

627

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

628

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

629

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

Bu Sun Kim

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

[diff] [blame]

630

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

631

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

632

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

633

# transliterated equivalents.

634

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

635

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

636

# other non-formatting related operations.

Bu Sun Kim

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

[diff] [blame]

637

#

Bu Sun Kim

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

[diff] [blame]

638

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

639

# possibly incorrect default).

640

#

641

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

642

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

643

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

644

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

645

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

646

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

647

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

648

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

649

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

650

"A String",

651

],

Bu Sun Kim

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

[diff] [blame]

652

},

Bu Sun Kim

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

[diff] [blame]

653

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

654

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

655

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

656

# LocationType#LOCALITY.

657

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

658

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

659

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

660

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

661

# 6.17 miles.

Bu Sun Kim

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

[diff] [blame]

662

},

663

},

Bu Sun Kim

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

[diff] [blame]

664

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

665

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

666

# abusive, or spammy.

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

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

700

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

Bu Sun Kim

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

[diff] [blame]

701

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

702

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

703

# employing applicants for the job position.

Bu Sun Kim

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

[diff] [blame]

704

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

Bu Sun Kim

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

[diff] [blame]

705

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

706

# roles.

707

#

708

# The maximum number of allowed characters is 500.

Bu Sun Kim

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

[diff] [blame]

709

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

710

#

711

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

712

# company is created.

713

#

714

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

715

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

716

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

717

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

718

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

719

# employers.

720

#

721

# Defaults to false if not provided.

722

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

723

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

724

#

725

# The maximum number of allowed characters is 255.

726

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

727

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

728

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

729

# company.

730

#

731

# The maximum number of allowed characters is 255.

732

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

733

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

734

# different from the job location. The service attempts

735

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

736

# location wherever possible in DerivedInfo.headquarters_location.

737

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

738

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

739

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

740

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

741

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

742

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

743

"A String",

744

],

745

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

746

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

Bu Sun Kim

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

[diff] [blame]

747

# Company.hq_location if provided.

748

#

749

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

Bu Sun Kim

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

[diff] [blame]

750

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

Bu Sun Kim

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

[diff] [blame]

751

# of doubles representing degrees latitude and degrees longitude. Unless

752

# specified otherwise, this must conform to the

Bu Sun Kim

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

[diff] [blame]

753

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

Dan O'Meara

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

[diff] [blame]

754

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

Bu Sun Kim

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

[diff] [blame]

755

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

756

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

757

},

Bu Sun Kim

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

[diff] [blame]

758

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

759

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

760

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

761

# delivery location.

762

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

763

# Box or similar.

764

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

765

# mountains).

766

#

767

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

768

# existing data, depending on the type of process.

769

#

770

# Advice on address input / editing:

771

# - Use an i18n-ready address widget such as

Dan O'Meara

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

[diff] [blame]

772

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

Bu Sun Kim

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

[diff] [blame]

773

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

774

# fields outside countries where that field is used.

775

#

776

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

777

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

Bu Sun Kim

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

[diff] [blame]

778

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

779

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

780

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

781

# the latest revision.

Bu Sun Kim

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

[diff] [blame]

782

#

Bu Sun Kim

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

[diff] [blame]

783

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

784

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

785

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

786

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

787

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

Bu Sun Kim

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

[diff] [blame]

788

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

Bu Sun Kim

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

[diff] [blame]

789

# addresses of a country or region.

790

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

791

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

Bu Sun Kim

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

[diff] [blame]

792

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

793

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

794

# in Switzerland this should be left unpopulated.

Bu Sun Kim

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

[diff] [blame]

795

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

796

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

797

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

798

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

799

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

800

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

801

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

Bu Sun Kim

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

[diff] [blame]

802

#

803

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

804

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

Bu Sun Kim

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

[diff] [blame]

805

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

806

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

Bu Sun Kim

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

[diff] [blame]

807

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

808

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

809

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

810

# an address can be selected based on the language.

811

#

812

# The minimum permitted structural representation of an address consists

813

# of a region_code with all remaining information placed in the

814

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

815

# approximately without geocoding, but no semantic reasoning could be

816

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

817

# partially resolved.

818

#

819

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

820

# then geocoding is the recommended way to handle completely unstructured

821

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

822

# localities or administrative areas).

Bu Sun Kim

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

[diff] [blame]

823

"A String",

Bu Sun Kim

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

[diff] [blame]

824

],

Bu Sun Kim

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

[diff] [blame]

825

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

826

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

827

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

828

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

Bu Sun Kim

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

[diff] [blame]

829

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

830

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

831

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

832

# transliterated equivalents.

833

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

834

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

835

# other non-formatting related operations.

Bu Sun Kim

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

[diff] [blame]

836

#

Bu Sun Kim

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

[diff] [blame]

837

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

838

# possibly incorrect default).

839

#

840

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

841

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

842

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

843

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

844

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

845

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

846

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

847

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

848

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

849

"A String",

850

],

Bu Sun Kim

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

[diff] [blame]

851

},

Bu Sun Kim

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

[diff] [blame]

852

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

853

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

854

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

855

# LocationType#LOCALITY.

856

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

857

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

858

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

859

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

860

# 6.17 miles.

Bu Sun Kim

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

[diff] [blame]

861

},

862

},

Bu Sun Kim

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

[diff] [blame]

863

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

864

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

865

# abusive, or spammy.

Bu Sun Kim

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

[diff] [blame]

866

},

867

],

Bu Sun Kim

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

[diff] [blame]

868

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

869

# tracking id.

870

#

871

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

Bu Sun Kim

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

[diff] [blame]

872

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

Bu Sun Kim

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

[diff] [blame]

873

# This id is logged for tracking purposes.

},

}</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

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

Bu Sun Kim

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

[diff] [blame]

916

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

917

# roles.

918

#

919

# The maximum number of allowed characters is 500.

Bu Sun Kim

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

[diff] [blame]

920

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

921

#

922

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

923

# company is created.

924

#

925

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

926

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

927

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

928

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

929

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

930

# employers.

931

#

932

# Defaults to false if not provided.

933

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

934

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

935

#

936

# The maximum number of allowed characters is 255.

937

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

938

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

939

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

940

# company.

941

#

942

# The maximum number of allowed characters is 255.

943

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

944

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

945

# different from the job location. The service attempts

946

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

947

# location wherever possible in DerivedInfo.headquarters_location.

948

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

949

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

950

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

951

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

952

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

953

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

954

"A String",

955

],

956

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

957

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

Bu Sun Kim

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

[diff] [blame]

958

# Company.hq_location if provided.

959

#

960

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

Bu Sun Kim

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

[diff] [blame]

961

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

Bu Sun Kim

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

[diff] [blame]

962

# of doubles representing degrees latitude and degrees longitude. Unless

963

# specified otherwise, this must conform to the

Bu Sun Kim

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

[diff] [blame]

964

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

Dan O'Meara

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

[diff] [blame]

965

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

Bu Sun Kim

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

[diff] [blame]

966

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

967

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

968

},

Bu Sun Kim

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

[diff] [blame]

969

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

970

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

971

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

972

# delivery location.

973

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

974

# Box or similar.

975

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

976

# mountains).

977

#

978

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

979

# existing data, depending on the type of process.

980

#

981

# Advice on address input / editing:

982

# - Use an i18n-ready address widget such as

Dan O'Meara

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

[diff] [blame]

983

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

Bu Sun Kim

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

[diff] [blame]

984

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

985

# fields outside countries where that field is used.

986

#

987

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

988

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

Bu Sun Kim

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

[diff] [blame]

989

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

990

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

991

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

992

# the latest revision.

Bu Sun Kim

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

[diff] [blame]

993

#

Bu Sun Kim

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

[diff] [blame]

994

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

995

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

996

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

997

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

998

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

Bu Sun Kim

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

[diff] [blame]

999

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

Bu Sun Kim

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

[diff] [blame]

1000

# addresses of a country or region.

1001

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

1002

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

Bu Sun Kim

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

[diff] [blame]

1003

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

1004

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

1005

# in Switzerland this should be left unpopulated.

Bu Sun Kim

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

[diff] [blame]

1006

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

1007

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

1008

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

1009

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

1010

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

1011

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

1012

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

Bu Sun Kim

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

[diff] [blame]

1013

#

1014

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

1015

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

Bu Sun Kim

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

[diff] [blame]

1016

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

1017

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

Bu Sun Kim

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

[diff] [blame]

1018

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

1019

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

1020

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

1021

# an address can be selected based on the language.

1022

#

1023

# The minimum permitted structural representation of an address consists

1024

# of a region_code with all remaining information placed in the

1025

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

1026

# approximately without geocoding, but no semantic reasoning could be

1027

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

1028

# partially resolved.

1029

#

1030

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

1031

# then geocoding is the recommended way to handle completely unstructured

1032

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

1033

# localities or administrative areas).

Bu Sun Kim

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

[diff] [blame]

1034

"A String",

Bu Sun Kim

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

[diff] [blame]

1035

],

Bu Sun Kim

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

[diff] [blame]

1036

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

1037

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

1038

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

1039

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

Bu Sun Kim

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

[diff] [blame]

1040

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

1041

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

1042

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

1043

# transliterated equivalents.

1044

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

1045

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

1046

# other non-formatting related operations.

Bu Sun Kim

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

[diff] [blame]

1047

#

Bu Sun Kim

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

[diff] [blame]

1048

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

1049

# possibly incorrect default).

1050

#

1051

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

1052

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

1053

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

1054

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

1055

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

1056

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

1057

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

1058

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

1059

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

1060

"A String",

1061

],

Bu Sun Kim

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

[diff] [blame]

1062

},

Bu Sun Kim

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

[diff] [blame]

1063

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

1064

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

1065

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

1066

# LocationType#LOCALITY.

1067

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

1068

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

1069

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

1070

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

1071

# 6.17 miles.

Bu Sun Kim

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

[diff] [blame]

1072

},

1073

},

Bu Sun Kim

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

[diff] [blame]

1074

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

1075

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

1076

# abusive, or spammy.

Bu Sun Kim

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

[diff] [blame]

1077

},

Bu Sun Kim

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

[diff] [blame]

1078

"updateMask": "A String", # Optional but strongly recommended for the best service

Bu Sun Kim

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

[diff] [blame]

1079

# experience.

1080

#

1081

# If update_mask is provided, only the specified fields in

1082

# company are updated. Otherwise all the fields are updated.

1083

#

1084

# A field mask to specify the company fields to be updated. Only

1085

# top level fields of Company are supported.

1086

}

1087

1088

x__xgafv: string, V1 error format.

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

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

Bu Sun Kim

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

[diff] [blame]

1100

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

1101

# roles.

1102

#

1103

# The maximum number of allowed characters is 500.

Bu Sun Kim

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

[diff] [blame]

1104

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

1105

#

1106

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

1107

# company is created.

1108

#

1109

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

1110

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

1111

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

1112

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

1113

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

1114

# employers.

1115

#

1116

# Defaults to false if not provided.

1117

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

1118

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

1119

#

1120

# The maximum number of allowed characters is 255.

1121

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

1122

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

1123

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

1124

# company.

1125

#

1126

# The maximum number of allowed characters is 255.

1127

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

1128

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

1129

# different from the job location. The service attempts

1130

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

1131

# location wherever possible in DerivedInfo.headquarters_location.

1132

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

1133

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

1134

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

1135

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

1136

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

1137

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

1138

"A String",

1139

],

1140

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

1141

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

Bu Sun Kim

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

[diff] [blame]

1142

# Company.hq_location if provided.

1143

#

1144

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

Bu Sun Kim

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

[diff] [blame]

1145

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

Bu Sun Kim

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

[diff] [blame]

1146

# of doubles representing degrees latitude and degrees longitude. Unless

1147

# specified otherwise, this must conform to the

Bu Sun Kim

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

[diff] [blame]

1148

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

Dan O'Meara

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

[diff] [blame]

1149

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

Bu Sun Kim

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

[diff] [blame]

1150

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

1151

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

1152

},

Bu Sun Kim

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

[diff] [blame]

1153

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

1154

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

1155

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

1156

# delivery location.

1157

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

1158

# Box or similar.

1159

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

1160

# mountains).

1161

#

1162

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

1163

# existing data, depending on the type of process.

1164

#

1165

# Advice on address input / editing:

1166

# - Use an i18n-ready address widget such as

Dan O'Meara

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

[diff] [blame]

1167

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

Bu Sun Kim

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

[diff] [blame]

1168

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

1169

# fields outside countries where that field is used.

1170

#

1171

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

1172

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

Bu Sun Kim

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

[diff] [blame]

1173

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

1174

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

1175

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

1176

# the latest revision.

Bu Sun Kim

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

[diff] [blame]

1177

#

Bu Sun Kim

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

[diff] [blame]

1178

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

1179

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

1180

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

1181

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

1182

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

Bu Sun Kim

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

[diff] [blame]

1183

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

Bu Sun Kim

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

[diff] [blame]

1184

# addresses of a country or region.

1185

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

1186

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

Bu Sun Kim

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

[diff] [blame]

1187

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

1188

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

1189

# in Switzerland this should be left unpopulated.

Bu Sun Kim

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

[diff] [blame]

1190

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

1191

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

1192

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

1193

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

1194

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

1195

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

1196

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

Bu Sun Kim

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

[diff] [blame]

1197

#

1198

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

1199

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

Bu Sun Kim

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

[diff] [blame]

1200

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

1201

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

Bu Sun Kim

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

[diff] [blame]

1202

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

1203

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

1204

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

1205

# an address can be selected based on the language.

1206

#

1207

# The minimum permitted structural representation of an address consists

1208

# of a region_code with all remaining information placed in the

1209

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

1210

# approximately without geocoding, but no semantic reasoning could be

1211

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

1212

# partially resolved.

1213

#

1214

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

1215

# then geocoding is the recommended way to handle completely unstructured

1216

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

1217

# localities or administrative areas).

Bu Sun Kim

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

[diff] [blame]

1218

"A String",

Bu Sun Kim

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

[diff] [blame]

1219

],

Bu Sun Kim

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

[diff] [blame]

1220

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

Bu Sun Kim

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

[diff] [blame]

1221

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

1222

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

1223

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

Bu Sun Kim

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

[diff] [blame]

1224

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

1225

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

1226

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

1227

# transliterated equivalents.

1228

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

1229

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

1230

# other non-formatting related operations.

Bu Sun Kim

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

[diff] [blame]

1231

#

Bu Sun Kim

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

[diff] [blame]

1232

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

1233

# possibly incorrect default).

1234

#

1235

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

1236

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

1237

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

1238

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

1239

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

1240

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

1241

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

1242

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

1243

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

1244

"A String",

1245

],

Bu Sun Kim

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

[diff] [blame]

1246

},

Bu Sun Kim

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

[diff] [blame]

1247

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

1248

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

1249

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

1250

# LocationType#LOCALITY.

1251

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

1252

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

1253

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

1254

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

1255

# 6.17 miles.

Bu Sun Kim

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

[diff] [blame]

1256

},

1257

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1258

"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]

1259

# public availability by the service when job content appears suspicious,

1260

# abusive, or spammy.

Bu Sun Kim