Method: projects.tenants.companies.patch

Atualiza a empresa especificada.

Solicitação HTTP

PATCH https://jobs.googleapis.com/v4beta1/{company.name=projects/*/tenants/*/companies/*}

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
company.name

string

Obrigatório durante a atualização da empresa.

O nome de recurso de uma empresa. É gerado pelo serviço quando uma empresa é criada.

O formato é "projects/{projectId}/tenants/{tenantId}/companies/{company_id}", por exemplo, "projects/foo/tenants/bar/Companies/baz".

Se o ID do locatário não for especificado, será usado o locatário padrão. Por exemplo, "projects/foo/empresas/bar".

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON 
{
  "company": {
    "name": string,
    "displayName": string,
    "externalId": string,
    "size": enum (CompanySize),
    "headquartersAddress": string,
    "hiringAgency": boolean,
    "eeoText": string,
    "websiteUri": string,
    "careerSiteUri": string,
    "imageUri": string,
    "keywordSearchableJobCustomAttributes": [
      string
    ],
    "derivedInfo": {
      "headquartersLocation": {
        object (Location)
      }
    },
    "suspended": boolean
  },
  "updateMask": string
}
Campos
company.displayName

string

Obrigatório. O nome de exibição da empresa, por exemplo, "Google LLC".
company.externalId

string

Obrigatório. Identificador da empresa do lado do cliente, usado para identificar a empresa de maneira exclusiva.

O número máximo de caracteres permitido é 255.
company.size

enum (CompanySize)

O tamanho da empresa do empregador.
company.headquartersAddress

string

O endereço da sede da empresa, que pode ser diferente do local de trabalho. O serviço tenta localizar geograficamente o endereço fornecido e preenche um local mais específico sempre que possível em DerivedInfo.headquarters_location.
company.hiringAgency

boolean

Definido como "true" se for a agência contratante que posta vagas para outros empregadores.

Caso não seja fornecido, o padrão será “false”.
company.eeoText

string

Aviso de isenção de responsabilidade da Comissão de Oportunidades Iguais de Emprego a ser associado a todas as vagas de emprego, normalmente exibido em todos os papéis.

O número máximo de caracteres permitidos é 500.
company.websiteUri

string

O URI que representa a página inicial ou o principal site da empresa, por exemplo, "https://www.google.com".

O número máximo de caracteres permitido é 255.
company.careerSiteUri

string

O URI do site de empregos ou a página de carreiras no site do empregador, por exemplo, "https://careers.google.com".
company.imageUri

string

Um URI que hospeda o logotipo da empresa do empregador.
company.keywordSearchableJobCustomAttributes[]

string

Uma lista de chaves de Job.custom_attributes filtrável, com stringValues correspondente usada em pesquisas por palavra-chave. As vagas com stringValues nessas chaves de campo especificadas serão retornadas se algum dos valores corresponder à palavra-chave de pesquisa. Os valores de campos personalizados com parênteses, colchetes e símbolos especiais não são pesquisáveis no estado em que estão, e essas consultas de palavra-chave precisam estar entre aspas.
company.derivedInfo

object (DerivedInfo)

Apenas saída. Detalhes derivados da empresa.
company.suspended

boolean

Apenas saída. Indica se uma empresa está marcada para ser suspensa da disponibilidade pública pelo serviço quando o conteúdo da vaga de emprego parece suspeito, abusivo ou spam.
updateMask

string (FieldMask format)

É altamente recomendado para melhorar a experiência de atendimento.

Se updateMask for fornecido, somente os campos especificados em company serão atualizados. Do contrário, todos os campos serão atualizados.

Uma máscara de campo para especificar os campos da empresa a serem atualizados. Somente campos de nível superior de Company são aceitos.

Lista separada por vírgulas de nomes de campos totalmente qualificados. Exemplo: "user.displayName,photo".

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de Company.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/jobs
  • https://www.googleapis.com/auth/cloud-platform

Para saber mais, consulte a Visão geral da autenticação.