GOgoogle
projects

GET /v4/projects/{projectsId}/tenants/{tenantsId}:completeQuery

Completes the specified prefix with keyword suggestions. Intended for use by a job search auto-complete search box.

Request

  • Base URL
    https://jobs.googleapis.com
  • Auth
    • OAuth 2 and OAuth 2
      Implicithttps://accounts.google.com/o/oauth2/auth
      Scopeshttps://www.googleapis.com/auth/cloud-platform
      Authorization codehttps://accounts.google.com/o/oauth2/auth
      Token URLhttps://accounts.google.com/o/oauth2/token
      Scopeshttps://www.googleapis.com/auth/cloud-platform
    • or OAuth 2 and OAuth 2
      Implicithttps://accounts.google.com/o/oauth2/auth
      Scopeshttps://www.googleapis.com/auth/jobs
      Authorization codehttps://accounts.google.com/o/oauth2/auth
      Token URLhttps://accounts.google.com/o/oauth2/token
      Scopeshttps://www.googleapis.com/auth/jobs

Path parameters

projectsIdstring required
tenantsIdstring required

Query parameters

companystring

If provided, restricts completion to specified company. The format is "projects/{project_id}/tenants/{tenant_id}/companies/{company_id}", for example, "projects/foo/tenants/bar/companies/baz".

languageCodesstring[]

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.

pageSizeinteger

Required. Completion result count. The maximum allowed page size is 10.

querystring

Required. The query used to generate suggestions. The maximum number of allowed characters is 255.

scope'COMPLETION_SCOPE_UNSPECIFIED' | 'TENANT' | 'PUBLIC'

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

type'COMPLETION_TYPE_UNSPECIFIED' | 'JOB_TITLE' | 'COMPANY_NAME' | 'COMBINED'

The completion topic. The default is CompletionType.COMBINED.

Response

Successful response

Changes

No recorded changes to this operation across all 4 revisions of this API.