Method: projects.locations.obtainCrawlRate

Obtiene los datos de series temporales de la tasa de rastreo orgánica o dedicada para la supervisión. Cuando no se establece una tasa de rastreo dedicada, se devolverá la serie temporal de la tasa de rastreo orgánica de Vertex AI. El rastreo orgánico significa que Google rastrea automáticamente Internet cuando le resulta conveniente. Cuando se establece una tasa de rastreo dedicada, se mostrará la serie temporal de la tasa de rastreo dedicada de Vertex AI.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
location

string

Obligatorio. Es el recurso de ubicación en el que se realizará la administración de la velocidad de rastreo. Formato: projects/{project}/locations/{location}

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación JSON 
{
  "crawlRateScope": string
}
Campos
crawlRateScope

string

Obligatorio. Es el alcance de la tasa de rastreo que el usuario desea supervisar. Actualmente, solo se admiten el dominio y el nombre de host. Un ejemplo de nombre de dominio es example.com. Un ejemplo de nombre de host es www.example.com. No incluyas / en el nombre de dominio o de host.

Cuerpo de la respuesta

Mensaje de respuesta para el método CrawlRateManagementService.ObtainCrawlRate. La respuesta contiene datos de series temporales de la frecuencia de rastreo orgánica o dedicada para la supervisión, según si se configuró la frecuencia de rastreo dedicada.

Si se ejecuta correctamente, el cuerpo de la respuesta contiene datos con la siguiente estructura:

Representación 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)

Solo salida. Es el estado de la respuesta.
error

object (Status)

Son los errores del servicio cuando se controla la solicitud.
Campo de unión crawl_rate_time_series. Una vez que el usuario establece la tasa de rastreo dedicada, se devolverá la serie temporal de la tasa de rastreo dedicada. De lo contrario, se devolverá la serie temporal de la tasa de rastreo orgánica. crawl_rate_time_series puede ser solo uno de los siguientes:
organicCrawlRateTimeSeries

object (OrganicCrawlRateTimeSeries)

Son los datos de series temporales del porcentaje de rastreo orgánico histórico, que se usan para la supervisión.
dedicatedCrawlRateTimeSeries

object (DedicatedCrawlRateTimeSeries)

Son los datos de series temporales del porcentaje de rastreo dedicado histórico, que se utilizan para la supervisión.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.

OrganicCrawlRateTimeSeries

Son los datos de series temporales del porcentaje de rastreo orgánico histórico, que se usan para la supervisión. El rastreo orgánico se determina automáticamente para rastrear el sitio web del usuario cuando no se configura el rastreo dedicado. La tasa de rastreo es la cantidad de QPS de solicitudes de rastreo que Google envía al sitio web del usuario.

Representación JSON 
{
  "googleOrganicCrawlRate": {
    object (CrawlRateTimeSeries)
  },
  "vertexAiOrganicCrawlRate": {
    object (CrawlRateTimeSeries)
  }
}
Campos
googleOrganicCrawlRate

object (CrawlRateTimeSeries)

Serie temporal de la frecuencia de rastreo orgánica de Google, que es la suma de la frecuencia de rastreo de todos los Googlebots. Consulta https://developers.google.com/search/docs/crawling-indexing/overview-google-crawlers para obtener más detalles sobre los Googlebots.
vertexAiOrganicCrawlRate

object (CrawlRateTimeSeries)

Es la serie temporal de la tasa de rastreo orgánica de Vertex AI, que es la tasa de rastreo de Google-CloudVertexBot cuando no se establece el rastreo dedicado. Consulta https://developers.google.com/search/docs/crawling-indexing/google-common-crawlers#google-cloudvertexbot para obtener más detalles sobre Google-CloudVertexBot.

CrawlRateTimeSeries

Son los datos de series temporales del historial de la frecuencia de rastreo, que se usan para la supervisión.

Representación JSON 
{
  "qpsTimeSeries": {
    object (TimeSeries)
  }
}
Campos
qpsTimeSeries

object (TimeSeries)

Es la QPS de la frecuencia de rastreo.

DedicatedCrawlRateTimeSeries

Son los datos de series temporales del porcentaje de rastreo dedicado histórico, que se utilizan para la supervisión. Vertex AI usa el rastreo dedicado para rastrear el sitio web del usuario cuando se configura el rastreo dedicado.

Representación JSON 
{
  "userTriggeredCrawlRate": {
    object (CrawlRateTimeSeries)
  },
  "autoRefreshCrawlRate": {
    object (CrawlRateTimeSeries)
  },
  "userTriggeredCrawlErrorRate": {
    object (CrawlRateTimeSeries)
  },
  "autoRefreshCrawlErrorRate": {
    object (CrawlRateTimeSeries)
  }
}
Campos
userTriggeredCrawlRate

object (CrawlRateTimeSeries)

Es la serie temporal de la tasa de rastreo dedicada de Vertex AI del rastreo activado por el usuario, que es la tasa de rastreo de Google-CloudVertexBot cuando se establece el rastreo dedicado, y la tasa de rastreo activada por el usuario es para casos de uso determinísticos, como rastrear URLs o mapas del sitio especificados por los usuarios.
autoRefreshCrawlRate

object (CrawlRateTimeSeries)

Es la serie temporal de la frecuencia de rastreo dedicada de Vertex AI de actualización automática, que es la frecuencia de rastreo de Google-CloudVertexBot cuando se establece el rastreo dedicado. La frecuencia de rastreo es para casos de uso de mejor esfuerzo, como la actualización periódica de URLs.
userTriggeredCrawlErrorRate

object (CrawlRateTimeSeries)

Es la serie temporal de la tasa de error de Vertex AI del rastreo dedicado activado por el usuario.
autoRefreshCrawlErrorRate

object (CrawlRateTimeSeries)

Es la serie temporal de la tasa de errores de Vertex AI del rastreo dedicado a la actualización automática.

Estado

Son los diferentes estados de la respuesta.

Enums
STATE_UNSPECIFIED El estado no se especifica.
SUCCEEDED El estado es correcto.
FAILED El estado es con error.