Lista de instrucciones

Explora las instrucciones de navegación disponibles para automatizar la navegación dinámica con Web Scraper API.

Argumentos generales

Todas las instrucciones definidas a continuación comparten un conjunto consistente de argumentos. Los argumentos son los siguientes.

tipo

• Tipo: Enum["click", "input", "scroll", "scroll_to_bottom", "wait", "wait_for_element", "fetch_resource"]

• Descripción: Tipo de instrucción del navegador.

timeout_s

• Tipo: int

• Descripción: Tiempo hasta que la acción se omite si no se completa a tiempo.

• Restricciones: 0 < timeout_s <= 60

• Valor por defecto: 5

wait_time_s

• Tipo: int

• Descripción: Tiempo de espera antes de ejecutar la siguiente acción.

• Restricciones: 0 < wait_time_s <= 60

• Valor por defecto: 0

on_error

• Tipo: Enum["error", "skip"]

• Descripción: Indicador de qué hacer con las instrucciones en caso de que esta instrucción falle:

  • "error": Detiene la ejecución de las instrucciones del navegador.

  • "skip": Continúa con la siguiente instrucción.

• Valor por defecto: "error"

Ejemplo con argumentos generales

{
    "type": "wait_for_element",
    "selector": {
        "type": "text",
        "value": "Load More Items"
    },
    "timeout_s": 5,
    "wait_time_s": 2,
    "on_error": "skip"

}

Instrucciones

click

• Descripción: Hace clic en un elemento y espera una cantidad determinada de segundos.

• Args:

  • type: str = "click"

  • selector: dict

    • type: Enum["xpath", "css", "text"]

    • value: str

• Para usar esta función, incluya un array JSON con objetos JSON que contengan los siguientes datos::

{
    "type": "click",
    "selector": {
        "type": "xpath",
        "value": "//button"
    }
}

input

• Descripción: Introduce un texto en un elemento seleccionado.

• Args:

  • type: str = "input"

  • selector: dict

    • type: Enum["xpath", "css", "text"]

    • value: str

  • value: str

  • Ejemplo:

{
    "type": "input",
    "selector": {
        "type": "xpath",
        "value": "//input"
    },
    "value": "pizza boxes"
}

scroll

• Descripción: Desplaza una cantidad determinada de píxeles.

• Args:

  • type: str = "scroll"

  • x: int

  • y: int

• Ejemplo:

{
    "type": "scroll",
    "x": 0,
    "y": 100
}

scroll_to_bottom

• Descripción: Desplaza hasta el final durante una cantidad determinada de segundos.

• Args:

  • type: str = "scroll_to_bottom"

• Para usar esta función, incluya un array JSON con objetos JSON que contengan los siguientes datos::

{
    "type": "scroll_to_bottom",
    "timeout_s": 10
}

wait

• Descripción: Espera una cantidad determinada de segundos.

• Args:

  • type: str = "wait"

• Para usar esta función, incluya un array JSON con objetos JSON que contengan los siguientes datos::

{
    "type": "wait",
    "wait_time_s": 2
}

wait_for_element

• Descripción: Espera a que un elemento se cargue durante una cantidad determinada de segundos.

• Args:

  • type: str = "wait_for_element"

  • selector: dict

    • type: Enum["xpath", "css", "text"]

    • value: str

  • Ejemplo:

{
    "type": "wait_for_element",
    "selector": {
        "type": "text",
        "value": "Load More Items"
    },
    "timeout_s": 5
}

fetch_resource

El fetch_resource la instrucción debe ser la instrucción final en la lista de instrucciones del navegador; cualquier instrucción posterior no se ejecutará.

• Descripción: Recupera la primera aparición de un recurso Fetch/XHR que coincida con el patrón establecido.

• Args:

  • type: str = "fetch_resource"

  • filter: str(Expresión RegEx)

  • on_error: Enum["error", "skip"]

• Ejemplo:

{
    "type": "fetch_resource",
    "filter": "/graphql/item/"
}

Validación de las instrucciones

Cualquier inconsistencia con respecto al formato de la instrucción resultará en un 400 código de estado y un mensaje de error correspondiente.

Por ejemplo, una carga útil como la siguiente:

{
    "source": "universal",
    "url": "https://www.example.com/",
    "render": "html",
    "browser_instructions": [
        {
            "type": "unsupported-wait",
            "wait_time_s": 5
        }
    ]
}

Resultará en:

{    
    "errors": {
        "message": "Unsupported action type `unsupported-wait`, choose from 'click,fetch_resource,input,scroll,scroll_to_bottom,wait,wait_for_element'"
    }
}