Method: projects.locations.obtainCrawlRate

Obtient les données de série temporelle du taux d'exploration naturel ou dédié pour la surveillance. Si le taux d'exploration dédié n'est pas défini, la série temporelle du taux d'exploration naturel de Vertex AI est 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 du taux d'exploration dédié de Vertex AI est renvoyée.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
location

string

Obligatoire. Ressource d'emplacement où la gestion du taux 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. Champ d'application du taux d'exploration que l'utilisateur souhaite surveiller. Pour le moment, 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 le taux d'exploration dédié ou organique pour la surveillance, selon que le taux d'exploration dédié est défini 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)
  },

  // 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.
}
Champs
state

enum (State)

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

object (Status)

Erreurs du service lors du traitement de la demande.
Champ d'union crawl_rate_time_series. 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. crawl_rate_time_series ne peut être qu'un des éléments suivants :
organicCrawlRateTimeSeries

object (OrganicCrawlRateTimeSeries)

Données de série temporelle sur le taux d'exploration naturelle historique, utilisées pour la surveillance.
dedicatedCrawlRateTimeSeries

object (DedicatedCrawlRateTimeSeries)

Données de série temporelle sur le taux d'exploration dédié historique, utilisées pour la surveillance.

Niveaux d'accès des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

Pour plus d'informations, consultez la Authentication Overview.

OrganicCrawlRateTimeSeries

Données de série temporelle sur le taux d'exploration naturelle historique, utilisées 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. Le taux d'exploration correspond au RPS de requêtes d'exploration 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 du taux d'exploration naturel de Google, qui correspond à la somme du taux 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 du taux d'exploration naturel de Vertex AI, qui correspond au taux 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

Données de série temporelle sur le taux d'exploration historique, utilisées pour la surveillance.

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

object (TimeSeries)

RPS de la fréquence d'exploration.

DedicatedCrawlRateTimeSeries

Données de série temporelle sur le taux d'exploration dédié historique, utilisées 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 au taux d'exploration de Vertex AI pour l'exploration déclenchée par l'utilisateur correspond au taux d'exploration de Google-CloudVertexBot lorsque l'exploration dédiée est définie. Le taux d'exploration déclenchée par l'utilisateur est destiné aux cas d'utilisation déterministes, comme l'exploration d'URL ou de sitemaps spécifiés par les utilisateurs.
autoRefreshCrawlRate

object (CrawlRateTimeSeries)

Série temporelle dédiée au taux d'exploration de Vertex AI avec actualisation automatique, qui correspond au taux d'exploration de Google-CloudVertexBot lorsque l'exploration dédiée est définie. Le taux d'exploration est destiné 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".