Method: projects.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/v3p1beta1/{name=projects/*}:complete

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

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

The format is "projects/{projectId}", for example, "projects/api-test-project".

Query parameters

Parameters
query

string

Required. The query used to generate suggestions.

The maximum number of allowed characters is 255.
languageCodes

string

Optional. 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

integer

Required. Completion result count.

The maximum allowed page size is 10.
companyName

string

Optional. If provided, restricts completion to specified company.

The format is "projects/{projectId}/companies/{company_id}", for example, "projects/api-test-project/companies/foo".
scope

enum (CompletionScope)

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

enum (CompletionType)

Optional. The completion topic. The default is CompletionType.COMBINED.
languageCode

string

Deprecated. Use languageCodes instead.

Optional.

The language 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 languageCode are returned.

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

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

The maximum number of allowed characters is 255.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

Output only.

Response of auto-complete query.

JSON representation 
{
  "completionResults": [
    {
      object (CompletionResult)
    }
  ],
  "metadata": {
    object (ResponseMetadata)
  }
}
Fields
completionResults[]

object (CompletionResult)

Results of the matching job/company candidates.
metadata

object (ResponseMetadata)

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 Only suggest job titles.
COMPANY_NAME Only suggest company names.
COMBINED Suggest both job titles and company names.

CompletionResult

Output only.

Resource that represents completion results.

JSON representation 
{
  "suggestion": string,
  "type": enum (CompletionType),
  "imageUri": string
}
Fields
suggestion

string

The suggestion for the query.
type

enum (CompletionType)

The completion topic.
imageUri

string

The URI of the company image for [CompletionType.COMPANY_NAME][].