Method: projects.locations.obtainCrawlRate

Recebe os dados de série temporal da taxa de rastreamento orgânica ou dedicada para monitoramento. Quando a taxa de rastreamento dedicada não é definida, ela retorna a série temporal da taxa de rastreamento orgânico da Vertex AI. O rastreamento orgânico significa que o Google rastreia automaticamente a Internet quando quiser. Quando a taxa de rastreamento dedicada é definida, ela retorna a série temporal da taxa de rastreamento dedicada da Vertex AI.

Solicitação HTTP

POST https://discoveryengine.googleapis.com/v1alpha/{location=projects/*/locations/*}:obtainCrawlRate

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

Parâmetros de caminho

Parâmetros
location

string

Obrigatório. O recurso de local em que o gerenciamento da taxa de rastreamento será realizado. Formato: projects/{project}/locations/{location}

Corpo da solicitação

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

Representação JSON 
{
  "crawlRateScope": string
}
Campos
crawlRateScope

string

Obrigatório. O escopo da taxa de rastreamento que o usuário quer monitorar. No momento, apenas o domínio e o nome do host são aceitos. Exemplo de nome de domínio: example.com. Exemplo de nome de host: www.example.com. Não inclua / no nome de domínio ou host.

Corpo da resposta

Mensagem de resposta para o método CrawlRateManagementService.ObtainCrawlRate. A resposta contém dados de série temporal de taxa de rastreamento orgânica ou dedicada para monitoramento, dependendo se a taxa de rastreamento dedicada está definida.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "state": enum (State),
  "error": {
    object (Status)
  },

  // Union field crawl_rate_time_series can be only one of the following:
  "organicCrawlRateTimeSeries": {
    object (OrganicCrawlRateTimeSeries)
  },
  "dedicatedCrawlRateTimeSeries": {
    object (DedicatedCrawlRateTimeSeries)
  }
  // End of list of possible types for union field crawl_rate_time_series.
}
Campos
state

enum (State)

Apenas saída. O estado da resposta.
error

object (Status)

Erros do serviço ao processar a solicitação.
Campo de união crawl_rate_time_series. Depois que o usuário definir a taxa de rastreamento dedicada, ela vai retornar a série temporal da taxa de rastreamento dedicada. Caso contrário, vai retornar a série temporal da taxa de rastreamento orgânica. crawl_rate_time_series pode ser apenas de um dos tipos a seguir:
organicCrawlRateTimeSeries

object (OrganicCrawlRateTimeSeries)

Os dados de série temporal da taxa de rastreamento orgânico histórica, usados para monitoramento.
dedicatedCrawlRateTimeSeries

object (DedicatedCrawlRateTimeSeries)

Os dados de série temporal históricos da taxa de rastreamento dedicada, usados para monitoramento.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

OrganicCrawlRateTimeSeries

Os dados de série temporal da taxa de rastreamento orgânico histórica, usados para monitoramento. O rastreamento orgânico é determinado automaticamente pelo Google para rastrear o site do usuário quando o rastreamento dedicado não está definido. A taxa de rastreamento é a QPS da solicitação de rastreamento que o Google envia ao site do usuário.

Representação JSON 
{
  "googleOrganicCrawlRate": {
    object (CrawlRateTimeSeries)
  },
  "vertexAiOrganicCrawlRate": {
    object (CrawlRateTimeSeries)
  }
}
Campos
googleOrganicCrawlRate

object (CrawlRateTimeSeries)

Série temporal da taxa de rastreamento orgânico do Google, que é a soma da taxa de rastreamento de todos os googlebots. Consulte https://developers.google.com/search/docs/crawling-indexing/overview-google-crawlers para mais detalhes sobre os googlebots.
vertexAiOrganicCrawlRate

object (CrawlRateTimeSeries)

Série temporal da taxa de rastreamento orgânico da Vertex AI, que é a taxa de rastreamento do Google-CloudVertexBot quando o rastreamento dedicado não está definido. Consulte https://developers.google.com/search/docs/crawling-indexing/google-common-crawlers#google-cloudvertexbot para mais detalhes sobre o Google-CloudVertexBot.

CrawlRateTimeSeries

Os dados de série temporal da taxa de rastreamento histórica, usados para monitoramento.

Representação JSON 
{
  "qpsTimeSeries": {
    object (TimeSeries)
  }
}
Campos
qpsTimeSeries

object (TimeSeries)

A QPS da taxa de rastreamento.

DedicatedCrawlRateTimeSeries

Os dados de série temporal históricos da taxa de rastreamento dedicada, usados para monitoramento. O rastreamento dedicado é usado pela Vertex AI para rastrear o site do usuário quando essa opção está ativada.

Representação JSON 
{
  "userTriggeredCrawlRate": {
    object (CrawlRateTimeSeries)
  },
  "autoRefreshCrawlRate": {
    object (CrawlRateTimeSeries)
  },
  "userTriggeredCrawlErrorRate": {
    object (CrawlRateTimeSeries)
  },
  "autoRefreshCrawlErrorRate": {
    object (CrawlRateTimeSeries)
  }
}
Campos
userTriggeredCrawlRate

object (CrawlRateTimeSeries)

Série temporal de taxa de rastreamento dedicada da Vertex AI de rastreamento acionado pelo usuário, que é a taxa de rastreamento do Google-CloudVertexBot quando o rastreamento dedicado está definido, e a taxa de rastreamento acionada pelo usuário é para casos de uso determinísticos, como rastrear URLs ou sitemaps especificados pelos usuários.
autoRefreshCrawlRate

object (CrawlRateTimeSeries)

Série temporal dedicada da taxa de rastreamento da Vertex AI de atualização automática, que é a taxa de rastreamento do Google-CloudVertexBot quando o rastreamento dedicado está definido. A taxa de rastreamento é para casos de uso de melhor esforço, como a atualização periódica de URLs.
userTriggeredCrawlErrorRate

object (CrawlRateTimeSeries)

Série temporal da taxa de erros da Vertex AI de rastreamento dedicado acionado pelo usuário.
autoRefreshCrawlErrorRate

object (CrawlRateTimeSeries)

Série temporal da taxa de erros da Vertex AI de rastreamento dedicado com atualização automática.

Estado

Diferentes estados da resposta.

Tipos enumerados
STATE_UNSPECIFIED O estado não foi especificado.
SUCCEEDED O estado é "sucesso".
FAILED O estado é "Falha".