Cloud Talent Solution API . v2

Instance Methods

close()

Close httplib2 connections.

complete(pageSize=None, scope=None, languageCode=None, companyName=None, type=None, query=None, x__xgafv=None)

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

Method Details

close()
Close httplib2 connections.
complete(pageSize=None, scope=None, languageCode=None, companyName=None, type=None, query=None, x__xgafv=None)
Completes the specified prefix with job keyword suggestions. Intended for use by a job search auto-complete search box.

Args:
  pageSize: integer, Required. Completion result count. The maximum allowed page size is 10.
  scope: string, Optional. The scope of the completion. The defaults is CompletionScope.PUBLIC.
    Allowed values
      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
  languageCode: string, Required. 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](https://tools.ietf.org/html/bcp47). For CompletionType.JOB_TITLE type, only open jobs with same language_code are returned. For CompletionType.COMPANY_NAME type, only companies having open jobs with same language_code are returned. For CompletionType.COMBINED type, only open jobs with same language_code or companies having open jobs with same language_code are returned.
  companyName: string, Optional. If provided, restricts completion to the specified company.
  type: string, Optional. The completion topic. The default is CompletionType.COMBINED.
    Allowed values
      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.
  query: string, Required. The query used to generate suggestions.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Output only. Response of auto-complete query.
    "completionResults": [ # Results of the matching job/company candidates.
      { # Output only. Resource that represents completion results.
        "imageUrl": "A String", # The URL for the company logo if `type=COMPANY_NAME`.
        "suggestion": "A String", # The suggestion for the query.
        "type": "A String", # The completion topic.
      },
    ],
    "metadata": { # Output only. Additional information returned to client, such as debugging information. # Additional information for the API invocation, such as the request tracking id.
      "requestId": "A String", # A unique id associated with this call. This id is logged for tracking purposes.
      "mode": "A String", # For search response only. Indicates the mode of a performed search.
      "experimentIdList": [ # Identifiers for the versions of the search algorithm used during this API invocation if multiple algorithms are used. The default value is empty. For search response only.
        42,
      ],
    },
  }