Method: projects.locations.obtainCrawlRate

Obtient les données de série temporelle de la vitesse d'exploration naturelle ou dédiée pour la surveillance. Si aucun taux d'exploration dédié n'est défini, la série temporelle de la vitesse d'exploration naturelle de Vertex AI sera renvoyée. L'exploration naturelle signifie que Google explore automatiquement Internet à sa propre convenance. Lorsque le taux d'exploration dédié est défini, la série temporelle de la vitesse d'exploration dédiée de Vertex AI est renvoyée.

Requête HTTP


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

Les URL utilisent la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
location

string

Obligatoire. Ressource d'emplacement où la gestion de la vitesse d'exploration sera effectuée. Format : projects/{project}/locations/{location}

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation JSON 
{
  "crawlRateScope": string
}
Champs
crawlRateScope

string

Obligatoire. Portée de la vitesse d'exploration que l'utilisateur souhaite surveiller. Actuellement, seuls le nom de domaine et le nom d'hôte sont acceptés. Exemple de nom de domaine : example.com. Exemple de nom d'hôte : www.example.com. Veuillez ne pas inclure / dans le nom de domaine ou d'hôte.

Corps de la réponse

Message de réponse pour la méthode CrawlRateManagementService.ObtainCrawlRate. La réponse contient des données de série temporelle sur la vitesse d'exploration organique ou dédiée pour la surveillance, selon que la vitesse d'exploration dédiée est définie ou non.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation 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.
}
Champs
state

enum (State)

Uniquement en sortie. État de la réponse.
error

object (Status)

Erreurs du service lors du traitement de la demande.
Une fois que l'utilisateur a défini la vitesse d'exploration dédiée, la série temporelle correspondante est renvoyée. Sinon, c'est la série temporelle de la vitesse d'exploration naturelle qui est renvoyée. Vous trouverez ci-dessous la liste des champs mutuellement exclusifs. Au maximum, un seul des champs sera défini dans une réponse :
organicCrawlRateTimeSeries

object (OrganicCrawlRateTimeSeries)

Série temporelle des données historiques sur la vitesse d'exploration naturelle, utilisée pour la surveillance.
dedicatedCrawlRateTimeSeries

object (DedicatedCrawlRateTimeSeries)

Série temporelle historique de la vitesse d'exploration dédiée, utilisée pour la surveillance.
Fin des champs qui s'excluent mutuellement.

Niveaux d'accès des autorisations

Nécessite l'un des niveaux d'accès OAuth suivants :

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

Pour plus d'informations, consultez la Authentication Overview.

OrganicCrawlRateTimeSeries

Série temporelle des données historiques sur la vitesse d'exploration naturelle, utilisée pour la surveillance. L'exploration naturelle est déterminée automatiquement par Google pour explorer le site Web de l'utilisateur lorsque l'exploration dédiée n'est pas définie. La vitesse d'exploration correspond au nombre de requêtes par seconde que Google envoie au site Web de l'utilisateur.

Représentation JSON 
{
  "googleOrganicCrawlRate": {
    object (CrawlRateTimeSeries)
  },
  "vertexAiOrganicCrawlRate": {
    object (CrawlRateTimeSeries)
  }
}
Champs
googleOrganicCrawlRate

object (CrawlRateTimeSeries)

Série temporelle de la vitesse d'exploration naturelle de Google, qui correspond à la somme des vitesses d'exploration de tous les Googlebots. Pour en savoir plus sur les robots Google, consultez https://developers.google.com/search/docs/crawling-indexing/overview-google-crawlers.
vertexAiOrganicCrawlRate

object (CrawlRateTimeSeries)

Série temporelle de la vitesse d'exploration naturelle de Vertex AI, qui correspond à la vitesse d'exploration de Google-CloudVertexBot lorsque l'exploration dédiée n'est pas définie. Pour en savoir plus sur Google-CloudVertexBot, consultez https://developers.google.com/search/docs/crawling-indexing/google-common-crawlers#google-cloudvertexbot.

CrawlRateTimeSeries

Série temporelle de la vitesse d'exploration historique, utilisée pour la surveillance.

Représentation JSON 
{
  "qpsTimeSeries": {
    object (TimeSeries)
  }
}
Champs
qpsTimeSeries

object (TimeSeries)

RPS de la vitesse d'exploration.

DedicatedCrawlRateTimeSeries

Série temporelle historique de la vitesse d'exploration dédiée, utilisée pour la surveillance. Vertex AI utilise l'exploration dédiée pour explorer le site Web de l'utilisateur lorsque l'exploration dédiée est définie.

Représentation JSON 
{
  "userTriggeredCrawlRate": {
    object (CrawlRateTimeSeries)
  },
  "autoRefreshCrawlRate": {
    object (CrawlRateTimeSeries)
  },
  "userTriggeredCrawlErrorRate": {
    object (CrawlRateTimeSeries)
  },
  "autoRefreshCrawlErrorRate": {
    object (CrawlRateTimeSeries)
  }
}
Champs
userTriggeredCrawlRate

object (CrawlRateTimeSeries)

La série temporelle dédiée à la vitesse d'exploration de Vertex AI pour l'exploration déclenchée par l'utilisateur correspond à la vitesse d'exploration de Google-CloudVertexBot lorsque l'exploration dédiée est définie. La vitesse d'exploration déclenchée par l'utilisateur est destinée aux cas d'utilisation déterministes, comme l'exploration des URL à explorer ou des sitemaps spécifiés par les utilisateurs.
autoRefreshCrawlRate

object (CrawlRateTimeSeries)

Série temporelle dédiée à la vitesse d'exploration de Vertex AI pour l'actualisation automatique, qui correspond à la vitesse d'exploration de Google-CloudVertexBot lorsque l'exploration dédiée est définie. La vitesse d'exploration est destinée aux cas d'utilisation au mieux, comme l'actualisation périodique des URL.
userTriggeredCrawlErrorRate

object (CrawlRateTimeSeries)

Série temporelle du taux d'erreur de Vertex AI pour l'exploration dédiée déclenchée par l'utilisateur.
autoRefreshCrawlErrorRate

object (CrawlRateTimeSeries)

Série temporelle du taux d'erreur de Vertex AI pour l'exploration dédiée à l'actualisation automatique.

État

Différents états de la réponse.

Enums
STATE_UNSPECIFIED L'état n'est pas spécifié.
SUCCEEDED L'état est "Réussie".
FAILED L'état est "Échec".