Method: projects.locations.obtainCrawlRate

Ottiene i dati delle serie temporali della frequenza di scansione organica o dedicata per il monitoraggio. Se la frequenza di scansione dedicata non è impostata, verranno restituite le serie temporali della frequenza di scansione organica di Vertex AI. La scansione organica significa che Google esegue automaticamente la scansione di internet a sua discrezione. Se la frequenza di scansione dedicata è impostata, verranno restituite le serie temporali della frequenza di scansione dedicata di Vertex AI.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
location

string

Obbligatorio. La risorsa della località in cui verrà eseguita la gestione della frequenza di scansione. Formato: projects/{project}/locations/{location}

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "crawlRateScope": string
}
Campi
crawlRateScope

string

Obbligatorio. L'ambito della frequenza di scansione che l'utente vuole monitorare. Al momento sono supportati solo il nome di dominio e il nome host. Esempio di nome di dominio: example.com. Esempio di nome host: www.example.com. Non includere / nel nome di dominio o host.

Corpo della risposta

Messaggio di risposta per il metodo CrawlRateManagementService.ObtainCrawlRate. La risposta contiene i dati delle serie temporali della frequenza di scansione organica o dedicata per il monitoraggio, a seconda che sia impostata la frequenza di scansione dedicata.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione 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.
}
Campi
state

enum (State)

Solo output. Lo stato della risposta.
error

object (Status)

Errori del servizio durante la gestione della richiesta.
Campo unione crawl_rate_time_series. Una volta che l'utente imposta la frequenza di scansione dedicata, verranno restituite le serie temporali della frequenza di scansione dedicata, altrimenti verranno restituite le serie temporali della frequenza di scansione organica. crawl_rate_time_series può essere solo uno dei seguenti tipi:
organicCrawlRateTimeSeries

object (OrganicCrawlRateTimeSeries)

I dati delle serie temporali della frequenza di scansione organica storici, utilizzati per il monitoraggio.
dedicatedCrawlRateTimeSeries

object (DedicatedCrawlRateTimeSeries)

I dati delle serie temporali della frequenza di scansione dedicata storici, utilizzati per il monitoraggio.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per saperne di più, consulta la Authentication Overview.

OrganicCrawlRateTimeSeries

I dati delle serie temporali della frequenza di scansione organica storici, utilizzati per il monitoraggio. La scansione organica viene determinata automaticamente da Google per eseguire la scansione del sito web dell'utente quando non è impostata la scansione dedicata. La frequenza di scansione è il QPS della richiesta di scansione che Google invia al sito web dell'utente.

Rappresentazione JSON 
{
  "googleOrganicCrawlRate": {
    object (CrawlRateTimeSeries)
  },
  "vertexAiOrganicCrawlRate": {
    object (CrawlRateTimeSeries)
  }
}
Campi
googleOrganicCrawlRate

object (CrawlRateTimeSeries)

Le serie temporali della frequenza di scansione organica di Google, ovvero la somma della frequenza di scansione di tutti i googlebot. Per ulteriori dettagli sui googlebot, consulta la pagina https://developers.google.com/search/docs/crawling-indexing/overview-google-crawlers.
vertexAiOrganicCrawlRate

object (CrawlRateTimeSeries)

Le serie temporali della frequenza di scansione organica di Vertex AI, ovvero la frequenza di scansione di Google-CloudVertexBot quando non è impostata la scansione dedicata. Per ulteriori dettagli su Google-CloudVertexBot, consulta la pagina https://developers.google.com/search/docs/crawling-indexing/google-common-crawlers#google-cloudvertexbot.

CrawlRateTimeSeries

I dati delle serie temporali della frequenza di scansione storici, utilizzati per il monitoraggio.

Rappresentazione JSON 
{
  "qpsTimeSeries": {
    object (TimeSeries)
  }
}
Campi
qpsTimeSeries

object (TimeSeries)

Il QPS della frequenza di scansione.

DedicatedCrawlRateTimeSeries

I dati delle serie temporali della frequenza di scansione dedicata storici, utilizzati per il monitoraggio. La scansione dedicata viene utilizzata da Vertex AI per eseguire la scansione del sito web dell'utente quando è impostata la scansione dedicata.

Rappresentazione JSON 
{
  "userTriggeredCrawlRate": {
    object (CrawlRateTimeSeries)
  },
  "autoRefreshCrawlRate": {
    object (CrawlRateTimeSeries)
  },
  "userTriggeredCrawlErrorRate": {
    object (CrawlRateTimeSeries)
  },
  "autoRefreshCrawlErrorRate": {
    object (CrawlRateTimeSeries)
  }
}
Campi
userTriggeredCrawlRate

object (CrawlRateTimeSeries)

Le serie temporali della frequenza di scansione dedicata di Vertex AI della scansione attivata dall'utente, ovvero la frequenza di scansione di Google-CloudVertexBot quando è impostata la scansione dedicata e la frequenza di scansione attivata dall'utente è per casi d'uso deterministici come la scansione di URL o Sitemap specificati dagli utenti.
autoRefreshCrawlRate

object (CrawlRateTimeSeries)

Le serie temporali della frequenza di scansione dedicata di Vertex AI dell'aggiornamento automatico, ovvero la frequenza di scansione di Google-CloudVertexBot quando è impostata la scansione dedicata e la frequenza di scansione è per casi d'uso di tipo "best effort" come l'aggiornamento periodico degli URL.
userTriggeredCrawlErrorRate

object (CrawlRateTimeSeries)

Le serie temporali del tasso di errore di Vertex AI della scansione dedicata attivata dall'utente.
autoRefreshCrawlErrorRate

object (CrawlRateTimeSeries)

Le serie temporali del tasso di errore di Vertex AI della scansione dedicata con aggiornamento automatico.

Stato

Diversi stati della risposta.

Enum
STATE_UNSPECIFIED Lo stato non è specificato.
SUCCEEDED Lo stato è "Riuscita".
FAILED Lo stato è "Non riuscita".