- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- CompletionScope
- CompletionType
- CompletionResult
- 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/v4/{tenant=projects/*/tenants/*}:completeQuery
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
tenant |
Required. Resource name of tenant the completion is performed within. The format is "projects/{projectId}/tenants/{tenantId}", for example, "projects/foo/tenants/bar". |
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". |
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 data with the following structure:
Response of auto-complete query.
JSON representation |
---|
{ "completionResults": [ { object ( |
Fields | |
---|---|
completionResults[] |
Results of the matching job/company candidates. |
metadata |
Additional information for the API invocation, such as the request tracking id. |
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.
CompletionScope
Enum to specify the scope of completion.
Enums | |
---|---|
COMPLETION_SCOPE_UNSPECIFIED |
Default value. |
TENANT |
Suggestions are based only on the data provided by the client. |
PUBLIC |
Suggestions are based on all jobs data in the system that's visible to the client |
CompletionType
Enum to specify auto-completion topics.
Enums | |
---|---|
COMPLETION_TYPE_UNSPECIFIED |
Default value. |
JOB_TITLE |
Suggest job titles for jobs autocomplete. For |
COMPANY_NAME |
Suggest company names for jobs autocomplete. For |
COMBINED |
Suggest both job titles and company names for jobs autocomplete. For |
CompletionResult
Resource that represents completion results.
JSON representation |
---|
{
"suggestion": string,
"type": enum ( |
Fields | |
---|---|
suggestion |
The suggestion for the query. |
type |
The completion topic. |
imageUri |
The URI of the company image for |