- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization Scopes
- Try it!
Completes the specified prefix with keyword suggestions. Intended for use by a job search auto-complete search box.
HTTP request
GET https://jobs.googleapis.com/v4beta1/{parent=projects/*}:complete
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
parent |
Required. Resource name of tenant the completion is performed within. The format is "projects/{projectId}/tenants/{tenantId}", for example, "projects/foo/tenant/bar". If tenant id is unspecified, the default tenant is used, for example, "projects/foo". |
Query parameters
Parameters | |
---|---|
query |
Required. The query used to generate suggestions. The maximum number of allowed characters is 255. |
languageCodes |
The list of languages of the query. This is the BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see Tags for Identifying Languages. The maximum number of allowed characters is 255. |
pageSize |
Required. Completion result count. The maximum allowed page size is 10. |
company |
If provided, restricts completion to specified company. The format is "projects/{projectId}/tenants/{tenantId}/companies/{company_id}", for example, "projects/foo/tenants/bar/companies/baz". If tenant id is unspecified, the default tenant is used, for example, "projects/foo". |
scope |
The scope of the completion. The defaults is |
type |
The completion topic. The default is |
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of CompleteQueryResponse
.
Authorization Scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/jobs
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.