Method: projects.tenants.complete

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/*/tenants/*}:complete

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. Resource name of tenant the completion is performed within.

The format is "projects/{project_id}/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

string

Required. The query used to generate suggestions.

The maximum number of allowed characters is 255.

languageCodes

string

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.

For CompletionType.JOB_TITLE type, only open jobs with the same languageCodes are returned.

For CompletionType.COMPANY_NAME type, only companies having open jobs with the same languageCodes are returned.

For CompletionType.COMBINED type, only open jobs with the same languageCodes or companies having open jobs with the same languageCodes are returned.

The maximum number of allowed characters is 255.

pageSize

number

Required. Completion result count.

The maximum allowed page size is 10.

company

string

If provided, restricts completion to specified company.

The format is "projects/{project_id}/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

enum (CompletionScope)

The scope of the completion. The defaults is CompletionScope.PUBLIC.

type

enum (CompletionType)

The completion topic. The default is CompletionType.COMBINED.

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.

Try it!

Was this page helpful? Let us know how we did:

Send feedback about...

Job Search documentation
Need help? Visit our support page.