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

2020-10-06 16:46:05 -0700

[diff] [blame]

78

<code><a href="#close">close()</a></code></p>

79

<p class="firstline">Close httplib2 connections.</p>

80

Dan O'Meara

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

[diff] [blame]

81

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

82

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

83

84

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

85

<p class="firstline">Deletes specified company. Prerequisite: The company has no jobs associated with it.</p>

Bu Sun Kim

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

[diff] [blame]

86

87

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

88

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

89

Yoshi Automation Bot

0bf565c

2020-12-09 08:56:03 -0800

[diff] [blame]

90

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

Bu Sun Kim

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

[diff] [blame]

91

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

92

93

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

94

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

95

Dan O'Meara

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

[diff] [blame]

96

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

97

<p class="firstline">Updates specified company. Company names can't be updated. To update a company name, delete the company and all jobs associated with it, and only then re-create them.</p>

Bu Sun Kim

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

[diff] [blame]

98

<h3>Method Details</h3>

99

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

100

<code class="details" id="close">close()</code>

101

<pre>Close httplib2 connections.</pre>

</div>

Dan O'Meara

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

[diff] [blame]

105

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

106

<pre>Creates a new company entity.

107

108

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

109

parent: string, Required. Resource name of the project under which the company is created. The format is "projects/{project_id}", for example, "projects/api-test-project". (required)

Dan O'Meara

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

[diff] [blame]

110

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

111

The object takes the form of:

112

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

113

{ # Input only. The Request of the CreateCompany method.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

114

"company": { # A Company resource represents a company in the service. A company is the entity that owns job postings, that is, the hiring entity responsible for employing applicants for the job position. # Required. The company to be created.

115

"careerSiteUri": "A String", # Optional. The URI to employer's career site or careers page on the employer's web site, for example, "https://careers.google.com".

116

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

117

"headquartersLocation": { # Output only. A resource that represents a location with full geographic information. # A structured headquarters location of the company, resolved from Company.hq_location if provided.

yoshi-code-bot

2021-05-23 03:48:02 -0700

[diff] [blame]

118

"latLng": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # An object representing a latitude/longitude pair.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

119

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

120

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

121

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

122

"locationType": "A String", # The type of a location, which corresponds to the address lines field of PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType#LOCALITY.

123

"postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location.

124

"addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).

125

"A String",

126

],

127

"administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.

128

"languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".

129

"locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.

130

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

131

"postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).

132

"recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.

133

"A String",

134

],

135

"regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.

136

"revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.

137

"sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

138

"sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.

139

},

140

"radiusInMiles": 3.14, # Radius in miles of the job location. This value is derived from the location bounding box in which a circle with the specified radius centered from LatLng covers the area associated with the job location. For example, currently, "Mountain View, CA, USA" has a radius of 6.17 miles.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

141

},

Bu Sun Kim

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

[diff] [blame]

142

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

143

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

144

"eeoText": "A String", # Optional. Equal Employment Opportunity legal disclaimer text to be associated with all jobs, and typically to be displayed in all roles. The maximum number of allowed characters is 500.

145

"externalId": "A String", # Required. Client side company identifier, used to uniquely identify the company. The maximum number of allowed characters is 255.

146

"headquartersAddress": "A String", # Optional. The street address of the company's main headquarters, which may be different from the job location. The service attempts to geolocate the provided address, and populates a more specific location wherever possible in DerivedInfo.headquarters_location.

147

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

148

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

149

"keywordSearchableJobCustomAttributes": [ # Optional. A list of keys of filterable Job.custom_attributes, whose corresponding `string_values` are used in keyword search. Jobs with `string_values` under these specified field keys are returned if any of the values matches the search keyword. Custom field values with parenthesis, brackets and special symbols won't be properly searchable, and those keyword queries need to be surrounded by quotes.

150

"A String",

151

],

152

"name": "A String", # Required during company update. The resource name for a company. This is generated by the service when a company is created. The format is "projects/{project_id}/companies/{company_id}", for example, "projects/api-test-project/companies/foo".

153

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

154

"suspended": True or False, # Output only. Indicates whether a company is flagged to be suspended from public availability by the service when job content appears suspicious, abusive, or spammy.

155

"websiteUri": "A String", # Optional. The URI representing the company's primary web site or home page, for example, "https://www.google.com". The maximum number of allowed characters is 255.

156

},

157

}

Bu Sun Kim

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

[diff] [blame]

158

159

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

166

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

167

{ # A Company resource represents a company in the service. A company is the entity that owns job postings, that is, the hiring entity responsible for employing applicants for the job position.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

168

"careerSiteUri": "A String", # Optional. The URI to employer's career site or careers page on the employer's web site, for example, "https://careers.google.com".

169

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

170

"headquartersLocation": { # Output only. A resource that represents a location with full geographic information. # A structured headquarters location of the company, resolved from Company.hq_location if provided.

yoshi-code-bot

2021-05-23 03:48:02 -0700

[diff] [blame]

171

"latLng": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # An object representing a latitude/longitude pair.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

172

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

173

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

174

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

175

"locationType": "A String", # The type of a location, which corresponds to the address lines field of PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType#LOCALITY.

176

"postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location.

177

"addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).

178

"A String",

179

],

180

"administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.

181

"languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".

182

"locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.

183

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

184

"postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).

185

"recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.

186

"A String",

187

],

188

"regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.

189

"revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.

190

"sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

191

"sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.

192

},

193

"radiusInMiles": 3.14, # Radius in miles of the job location. This value is derived from the location bounding box in which a circle with the specified radius centered from LatLng covers the area associated with the job location. For example, currently, "Mountain View, CA, USA" has a radius of 6.17 miles.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

194

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

195

},

196

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

197

"eeoText": "A String", # Optional. Equal Employment Opportunity legal disclaimer text to be associated with all jobs, and typically to be displayed in all roles. The maximum number of allowed characters is 500.

198

"externalId": "A String", # Required. Client side company identifier, used to uniquely identify the company. The maximum number of allowed characters is 255.

199

"headquartersAddress": "A String", # Optional. The street address of the company's main headquarters, which may be different from the job location. The service attempts to geolocate the provided address, and populates a more specific location wherever possible in DerivedInfo.headquarters_location.

200

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

201

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

202

"keywordSearchableJobCustomAttributes": [ # Optional. A list of keys of filterable Job.custom_attributes, whose corresponding `string_values` are used in keyword search. Jobs with `string_values` under these specified field keys are returned if any of the values matches the search keyword. Custom field values with parenthesis, brackets and special symbols won't be properly searchable, and those keyword queries need to be surrounded by quotes.

203

"A String",

204

],

205

"name": "A String", # Required during company update. The resource name for a company. This is generated by the service when a company is created. The format is "projects/{project_id}/companies/{company_id}", for example, "projects/api-test-project/companies/foo".

206

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

207

"suspended": True or False, # Output only. Indicates whether a company is flagged to be suspended from public availability by the service when job content appears suspicious, abusive, or spammy.

208

"websiteUri": "A String", # Optional. The URI representing the company's primary web site or home page, for example, "https://www.google.com". The maximum number of allowed characters is 255.

209

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

214

<pre>Deletes specified company. Prerequisite: The company has no jobs associated with it.

Bu Sun Kim

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

[diff] [blame]

215

216

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

217

name: string, Required. The resource name of the company to be deleted. The format is "projects/{project_id}/companies/{company_id}", for example, "projects/api-test-project/companies/foo". (required)

Bu Sun Kim

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

[diff] [blame]

218

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

225

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

226

{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

227

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

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

232

<pre>Retrieves specified company.

233

234

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

235

name: string, Required. The resource name of the company to be retrieved. The format is "projects/{project_id}/companies/{company_id}", for example, "projects/api-test-project/companies/foo". (required)

Bu Sun Kim

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

[diff] [blame]

236

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

243

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

244

{ # A Company resource represents a company in the service. A company is the entity that owns job postings, that is, the hiring entity responsible for employing applicants for the job position.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

245

"careerSiteUri": "A String", # Optional. The URI to employer's career site or careers page on the employer's web site, for example, "https://careers.google.com".

246

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

247

"headquartersLocation": { # Output only. A resource that represents a location with full geographic information. # A structured headquarters location of the company, resolved from Company.hq_location if provided.

yoshi-code-bot

2021-05-23 03:48:02 -0700

[diff] [blame]

248

"latLng": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # An object representing a latitude/longitude pair.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

249

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

250

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

251

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

252

"locationType": "A String", # The type of a location, which corresponds to the address lines field of PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType#LOCALITY.

253

"postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location.

254

"addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).

255

"A String",

256

],

257

"administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.

258

"languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".

259

"locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.

260

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

261

"postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).

262

"recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.

263

"A String",

264

],

265

"regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.

266

"revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.

267

"sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

268

"sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.

269

},

270

"radiusInMiles": 3.14, # Radius in miles of the job location. This value is derived from the location bounding box in which a circle with the specified radius centered from LatLng covers the area associated with the job location. For example, currently, "Mountain View, CA, USA" has a radius of 6.17 miles.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

271

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

272

},

273

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

274

"eeoText": "A String", # Optional. Equal Employment Opportunity legal disclaimer text to be associated with all jobs, and typically to be displayed in all roles. The maximum number of allowed characters is 500.

275

"externalId": "A String", # Required. Client side company identifier, used to uniquely identify the company. The maximum number of allowed characters is 255.

276

"headquartersAddress": "A String", # Optional. The street address of the company's main headquarters, which may be different from the job location. The service attempts to geolocate the provided address, and populates a more specific location wherever possible in DerivedInfo.headquarters_location.

277

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

278

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

279

"keywordSearchableJobCustomAttributes": [ # Optional. A list of keys of filterable Job.custom_attributes, whose corresponding `string_values` are used in keyword search. Jobs with `string_values` under these specified field keys are returned if any of the values matches the search keyword. Custom field values with parenthesis, brackets and special symbols won't be properly searchable, and those keyword queries need to be surrounded by quotes.

280

"A String",

281

],

282

"name": "A String", # Required during company update. The resource name for a company. This is generated by the service when a company is created. The format is "projects/{project_id}/companies/{company_id}", for example, "projects/api-test-project/companies/foo".

283

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

284

"suspended": True or False, # Output only. Indicates whether a company is flagged to be suspended from public availability by the service when job content appears suspicious, abusive, or spammy.

285

"websiteUri": "A String", # Optional. The URI representing the company's primary web site or home page, for example, "https://www.google.com". The maximum number of allowed characters is 255.

286

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

290

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

Bu Sun Kim

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

[diff] [blame]

291

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

292

293

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

294

parent: string, Required. Resource name of the project under which the company is created. The format is "projects/{project_id}", for example, "projects/api-test-project". (required)

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

295

pageSize: integer, Optional. The maximum number of companies to be returned, at most 100. Default is 100 if a non-positive number is provided.

Yoshi Automation Bot

b6971b0

2020-11-26 17:16:03 -0800

[diff] [blame]

296

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

Yoshi Automation Bot

0bf565c

2020-12-09 08:56:03 -0800

[diff] [blame]

297

requireOpenJobs: boolean, Optional. Set to true if the companies requested must have open jobs. Defaults to false. If true, at most page_size of companies are fetched, among which only those with open jobs are returned.

Bu Sun Kim

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

[diff] [blame]

298

x__xgafv: string, V1 error format.

299

Allowed values

300

1 - v1 error format

301

2 - v2 error format

Bu Sun Kim

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

[diff] [blame]

302

303

Returns:

304

An object of the form:

305

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

306

{ # Output only. The List companies response object.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

307

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

308

{ # A Company resource represents a company in the service. A company is the entity that owns job postings, that is, the hiring entity responsible for employing applicants for the job position.

309

"careerSiteUri": "A String", # Optional. The URI to employer's career site or careers page on the employer's web site, for example, "https://careers.google.com".

310

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

311

"headquartersLocation": { # Output only. A resource that represents a location with full geographic information. # A structured headquarters location of the company, resolved from Company.hq_location if provided.

yoshi-code-bot

2021-05-23 03:48:02 -0700

[diff] [blame]

312

"latLng": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # An object representing a latitude/longitude pair.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

313

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

314

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

315

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

316

"locationType": "A String", # The type of a location, which corresponds to the address lines field of PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType#LOCALITY.

317

"postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location.

318

"addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).

319

"A String",

320

],

321

"administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.

322

"languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".

323

"locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.

324

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

325

"postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).

326

"recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.

327

"A String",

328

],

329

"regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.

330

"revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.

331

"sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

332

"sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.

333

},

334

"radiusInMiles": 3.14, # Radius in miles of the job location. This value is derived from the location bounding box in which a circle with the specified radius centered from LatLng covers the area associated with the job location. For example, currently, "Mountain View, CA, USA" has a radius of 6.17 miles.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

335

},

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

336

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

337

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

338

"eeoText": "A String", # Optional. Equal Employment Opportunity legal disclaimer text to be associated with all jobs, and typically to be displayed in all roles. The maximum number of allowed characters is 500.

339

"externalId": "A String", # Required. Client side company identifier, used to uniquely identify the company. The maximum number of allowed characters is 255.

340

"headquartersAddress": "A String", # Optional. The street address of the company's main headquarters, which may be different from the job location. The service attempts to geolocate the provided address, and populates a more specific location wherever possible in DerivedInfo.headquarters_location.

341

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

342

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

343

"keywordSearchableJobCustomAttributes": [ # Optional. A list of keys of filterable Job.custom_attributes, whose corresponding `string_values` are used in keyword search. Jobs with `string_values` under these specified field keys are returned if any of the values matches the search keyword. Custom field values with parenthesis, brackets and special symbols won't be properly searchable, and those keyword queries need to be surrounded by quotes.

344

"A String",

345

],

346

"name": "A String", # Required during company update. The resource name for a company. This is generated by the service when a company is created. The format is "projects/{project_id}/companies/{company_id}", for example, "projects/api-test-project/companies/foo".

347

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

348

"suspended": True or False, # Output only. Indicates whether a company is flagged to be suspended from public availability by the service when job content appears suspicious, abusive, or spammy.

349

"websiteUri": "A String", # Optional. The URI representing the company's primary web site or home page, for example, "https://www.google.com". The maximum number of allowed characters is 255.

Yoshi Automation Bot

b6971b0

2020-11-26 17:16:03 -0800

[diff] [blame]

350

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

351

],

352

"metadata": { # Output only. Additional information returned to client, such as debugging information. # Additional information for the API invocation, such as the request tracking id.

353

"requestId": "A String", # A unique id associated with this call. This id is logged for tracking purposes.

354

},

355

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

356

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

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

361

<pre>Retrieves the next page of results.

362

363

Args:

364

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

365

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

366

367

Returns:

Bu Sun Kim

6502091

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

[diff] [blame]

368

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]

369

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]

374

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

375

<pre>Updates specified company. Company names can't be updated. To update a company name, delete the company and all jobs associated with it, and only then re-create them.

Bu Sun Kim

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

[diff] [blame]

376

377

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

378

name: string, Required during company update. The resource name for a company. This is generated by the service when a company is created. The format is "projects/{project_id}/companies/{company_id}", for example, "projects/api-test-project/companies/foo". (required)

Dan O'Meara

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

[diff] [blame]

379

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

380

The object takes the form of:

381

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

382

{ # Input only. Request for updating a specified company.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

383

"company": { # A Company resource represents a company in the service. A company is the entity that owns job postings, that is, the hiring entity responsible for employing applicants for the job position. # Required. The company resource to replace the current resource in the system.

384

"careerSiteUri": "A String", # Optional. The URI to employer's career site or careers page on the employer's web site, for example, "https://careers.google.com".

385

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

386

"headquartersLocation": { # Output only. A resource that represents a location with full geographic information. # A structured headquarters location of the company, resolved from Company.hq_location if provided.

yoshi-code-bot

2021-05-23 03:48:02 -0700

[diff] [blame]

387

"latLng": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # An object representing a latitude/longitude pair.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

388

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

389

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

390

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

391

"locationType": "A String", # The type of a location, which corresponds to the address lines field of PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType#LOCALITY.

392

"postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location.

393

"addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).

394

"A String",

395

],

396

"administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.

397

"languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".

398

"locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.

399

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

400

"postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).

401

"recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.

402

"A String",

403

],

404

"regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.

405

"revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.

406

"sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

407

"sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.

408

},

409

"radiusInMiles": 3.14, # Radius in miles of the job location. This value is derived from the location bounding box in which a circle with the specified radius centered from LatLng covers the area associated with the job location. For example, currently, "Mountain View, CA, USA" has a radius of 6.17 miles.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

410

},

Bu Sun Kim

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

[diff] [blame]

411

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

412

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

413

"eeoText": "A String", # Optional. Equal Employment Opportunity legal disclaimer text to be associated with all jobs, and typically to be displayed in all roles. The maximum number of allowed characters is 500.

414

"externalId": "A String", # Required. Client side company identifier, used to uniquely identify the company. The maximum number of allowed characters is 255.

415

"headquartersAddress": "A String", # Optional. The street address of the company's main headquarters, which may be different from the job location. The service attempts to geolocate the provided address, and populates a more specific location wherever possible in DerivedInfo.headquarters_location.

416

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

417

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

418

"keywordSearchableJobCustomAttributes": [ # Optional. A list of keys of filterable Job.custom_attributes, whose corresponding `string_values` are used in keyword search. Jobs with `string_values` under these specified field keys are returned if any of the values matches the search keyword. Custom field values with parenthesis, brackets and special symbols won't be properly searchable, and those keyword queries need to be surrounded by quotes.

419

"A String",

420

],

421

"name": "A String", # Required during company update. The resource name for a company. This is generated by the service when a company is created. The format is "projects/{project_id}/companies/{company_id}", for example, "projects/api-test-project/companies/foo".

422

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

423

"suspended": True or False, # Output only. Indicates whether a company is flagged to be suspended from public availability by the service when job content appears suspicious, abusive, or spammy.

424

"websiteUri": "A String", # Optional. The URI representing the company's primary web site or home page, for example, "https://www.google.com". The maximum number of allowed characters is 255.

425

},

426

"updateMask": "A String", # Optional but strongly recommended for the best service experience. If update_mask is provided, only the specified fields in company are updated. Otherwise all the fields are updated. A field mask to specify the company fields to be updated. Only top level fields of Company are supported.

427

}

Bu Sun Kim

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

[diff] [blame]

428

429

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

436

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

437

{ # A Company resource represents a company in the service. A company is the entity that owns job postings, that is, the hiring entity responsible for employing applicants for the job position.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

438

"careerSiteUri": "A String", # Optional. The URI to employer's career site or careers page on the employer's web site, for example, "https://careers.google.com".

439

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

440

"headquartersLocation": { # Output only. A resource that represents a location with full geographic information. # A structured headquarters location of the company, resolved from Company.hq_location if provided.

yoshi-code-bot

2021-05-23 03:48:02 -0700

[diff] [blame]

441

"latLng": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # An object representing a latitude/longitude pair.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

442

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

443

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

444

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

445

"locationType": "A String", # The type of a location, which corresponds to the address lines field of PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType#LOCALITY.

446

"postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location.

447

"addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).

448

"A String",

449

],

450

"administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.

451

"languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".

452

"locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.

453

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

454

"postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).

455

"recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.

456

"A String",

457

],

458

"regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.

459

"revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.

460

"sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

461

"sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.

462

},

463

"radiusInMiles": 3.14, # Radius in miles of the job location. This value is derived from the location bounding box in which a circle with the specified radius centered from LatLng covers the area associated with the job location. For example, currently, "Mountain View, CA, USA" has a radius of 6.17 miles.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

464

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

465

},

466

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

467

"eeoText": "A String", # Optional. Equal Employment Opportunity legal disclaimer text to be associated with all jobs, and typically to be displayed in all roles. The maximum number of allowed characters is 500.

468

"externalId": "A String", # Required. Client side company identifier, used to uniquely identify the company. The maximum number of allowed characters is 255.

469

"headquartersAddress": "A String", # Optional. The street address of the company's main headquarters, which may be different from the job location. The service attempts to geolocate the provided address, and populates a more specific location wherever possible in DerivedInfo.headquarters_location.

470

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

471

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

472

"keywordSearchableJobCustomAttributes": [ # Optional. A list of keys of filterable Job.custom_attributes, whose corresponding `string_values` are used in keyword search. Jobs with `string_values` under these specified field keys are returned if any of the values matches the search keyword. Custom field values with parenthesis, brackets and special symbols won't be properly searchable, and those keyword queries need to be surrounded by quotes.

473

"A String",

474

],

475

"name": "A String", # Required during company update. The resource name for a company. This is generated by the service when a company is created. The format is "projects/{project_id}/companies/{company_id}", for example, "projects/api-test-project/companies/foo".

476

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

477

"suspended": True or False, # Output only. Indicates whether a company is flagged to be suspended from public availability by the service when job content appears suspicious, abusive, or spammy.

478

"websiteUri": "A String", # Optional. The URI representing the company's primary web site or home page, for example, "https://www.google.com". The maximum number of allowed characters is 255.

479

}</pre>

Bu Sun Kim