Method: projects.locations.obtainCrawlRate

Ottiene i dati delle serie temporali della frequenza di scansione organica o dedicata per il monitoraggio. Quando la frequenza di scansione dedicata non è impostata, vengono restituite le serie temporali della frequenza di scansione organica di Vertex AI. La scansione organica significa che Google esegue automaticamente la scansione di internet quando lo ritiene opportuno. Quando viene impostata una frequenza di scansione dedicata, vengono restituite le serie temporali della frequenza di scansione dedicata di Vertex AI.

Richiesta HTTP


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

Gli URL utilizzano la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
location

string

Obbligatorio. La risorsa di 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 dominio e il nome host. Un esempio di nome di dominio: example.com. Un esempio di nome host: www.example.com. Non includere / nel nome di dominio o nome host.

Corpo della risposta

Messaggio di risposta per il metodo CrawlRateManagementService.ObtainCrawlRate. La risposta contiene dati delle serie temporali sulla frequenza di scansione organica o dedicata per il monitoraggio, a seconda che sia impostata una 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)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "organicCrawlRateTimeSeries": {
    object (OrganicCrawlRateTimeSeries)
  },
  "dedicatedCrawlRateTimeSeries": {
    object (DedicatedCrawlRateTimeSeries)
  }
  // End of mutually exclusive fields.
}
Campi
state

enum (State)

Solo output. Lo stato della risposta.
error

object (Status)

Errori del servizio durante la gestione della richiesta.
Una volta impostata 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. Di seguito è riportato un elenco di campi che si escludono a vicenda. In una risposta verrà impostato al massimo uno dei campi:
organicCrawlRateTimeSeries

object (OrganicCrawlRateTimeSeries)

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

object (DedicatedCrawlRateTimeSeries)

I dati delle serie temporali della frequenza di scansione dedicata storica, utilizzati per il monitoraggio.
Fine dei campi che si escludono a vicenda.

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 storica, utilizzati per il monitoraggio. La scansione organica viene determinata automaticamente da Google per eseguire la scansione del sito web dell'utente quando non è impostata una scansione dedicata. La frequenza di scansione è il QPS delle richieste di scansione che Google invia al sito web dell'utente.

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

object (CrawlRateTimeSeries)

Serie temporale 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)

La serie temporale della frequenza di scansione organica di Vertex AI, ovvero la frequenza di scansione di Google-CloudVertexBot quando la scansione dedicata non è impostata. 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 storica, 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 storica, 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)

La serie temporale 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)

La serie temporale 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 i casi d'uso di tipo "best effort", come l'aggiornamento periodico degli URL.
userTriggeredCrawlErrorRate

object (CrawlRateTimeSeries)

Serie temporale del tasso di errore di Vertex AI della scansione dedicata attivata dall'utente.
autoRefreshCrawlErrorRate

object (CrawlRateTimeSeries)

Serie temporale del tasso di errore di Vertex AI della scansione dedicata all'aggiornamento automatico.

Stato

Diversi stati della risposta.

Enum
STATE_UNSPECIFIED Lo stato non è specificato.
SUCCEEDED Lo stato è riuscito.
FAILED Lo stato è Non riuscito.