Lista de instruções

Explore as instruções de navegação disponíveis para automatizar navegação dinâmica com o Web Scraper API.

Argumentos gerais

Todas as instruções definidas abaixo possuem um conjunto consistente de argumentos. Os argumentos são os seguintes.

type

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

• Descrição: Tipo de instrução do navegador.

timeout_s

• Tipo: int

• Descrição: Quanto tempo até a ação ser ignorada se não for concluída a tempo.

• Restrições: 0 < timeout_s <= 60

• Valor padrão: 5

wait_time_s

• Tipo: int

• Descrição: Quanto tempo esperar antes de executar a próxima ação.

• Restrições: 0 < wait_time_s <= 60

• Valor padrão: 0

on_error

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

• Descrição: Indicador do que fazer com as instruções caso esta instrução falhe:

  • "error": Interrompe a execução das instruções do navegador.

  • "skip": Continua com a próxima instrução.

• Valor padrão: "error"

Exemplo com argumentos gerais

{
    "type": "wait_for_element",
    "selector": {
        "type": "text",
        "value": "Carregar mais itens"
    },
    "timeout_s": 5,
    "wait_time_s": 2,
    "on_error": "skip"

}

Instruções

click

• Descrição: Clica em um elemento e espera uma contagem definida de segundos.

• Args:

  • type: str = "click"

  • selector: dict

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

    • value: str

• Exemplo:

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

input

• Descrição: Insere um texto em um elemento selecionado.

• Args:

  • type: str = "input"

  • selector: dict

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

    • value: str

  • value: str

  • Exemplo:

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

scroll

• Descrição: Rola uma quantidade definida de pixels.

• Args:

  • type: str = "scroll"

  • x: int

  • y: int

• Exemplo:

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

scroll_to_bottom

• Descrição: Rola até o final por uma contagem definida de segundos.

• Args:

  • type: str = "scroll_to_bottom"

• Exemplo:

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

wait

• Descrição: Aguarda uma contagem definida de segundos.

• Args:

  • type: str = "wait"

• Exemplo:

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

wait_for_element

• Descrição: Espera o elemento carregar por uma contagem definida de segundos.

• Args:

  • type: str = "wait_for_element"

  • selector: dict

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

    • value: str

  • Exemplo:

{
    "type": "wait_for_element",
    "selector": {
        "type": "text",
        "value": "Carregar mais itens"
    },
    "timeout_s": 5
}

fetch_resource

O fetch_resource a instrução deve ser a instrução final na lista de instruções do navegador; quaisquer instruções subsequentes não serão executadas.

• Descrição: Busca a primeira ocorrência de um recurso Fetch/XHR que corresponda ao padrão definido.

• Args:

  • type: str = "fetch_resource"

  • filter: str(RegEx expression)

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

• Exemplo:

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

Validação das instruções

Qualquer inconsistência em relação ao formato da instrução resultará em um 400 código de status e uma mensagem de erro correspondente.

Por exemplo, payload como este:

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

Resultará em:

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