Felo API PlatformFelo API Platform
Všechny endpointy DataForSEO
v0.2.0-beta
OpenAPI 3.1.0

Vytváření úloh organického SERP Google

Felo API Support
MIT
Server:https://openapi.felo.ai
Klientské knihovny
Shell Curl

DataForSEO

​

SEO, search-engine results, keyword research, backlinks and AI visibility data.

DataForSEO Operace

Vytváření úloh organického SERP Google

​

Zařadí výsledky v pořadí pro klíčové slovo v Google do fronty a vrátí id úlohy v tasks[0].id. Zabaleno do obálky DataForSEO: data v tasks[0].result, výsledek v tasks[0].status_code — odmítnutý požadavek stále vrací HTTP 200. Živá varianta odpovídá okamžitě a u jediného dotazu je jednodušší; do fronty zařaďte, když by dávka přesáhla trvání volání nástroje.

Cenová reference

  • Účtování: nahlášené náklady na odpověď.
  • Referenční odhad požadavku: USD 0.02.
  • Referenční multiplikátor zákazníka: 1.0. Znovu jej neaplikujte na již zúčtovanou částku zákazníka.

Pouze referenční metadata, nikoli nabídka pro účet, garantovaná cena či limit utrácení. Kredity prostředků nejsou kredity Felo. Konečné účtování se řídí fakturačními záznamy Felo.

Tělo
application/json
  • Typ: array (object | null)[]
    • browser_screen_height
      Typ: integer | null

      výška obrazovky prohlížeče

      volitelné pole

      můžete nastavit vlastní výšku obrazovky prohlížeče pro výpočet pixelového pořadí pro konkrétní zařízení;

      lze ji zadat v následujícím rozsahu: 240-9999;

      ve výchozím nastavení je parametr nastaven na:

      1080 pro desktop;

      640 pro mobile na android;

      812 pro mobile na iOS;

      Poznámka: pro použití tohoto parametru nastavte calculate_rectangles na true

    • browser_screen_resolution_ratio
      Typ: integer | null

      faktor měřítka obrazovky prohlížeče

      volitelné pole

      můžete nastavit vlastní faktor měřítka obrazovky prohlížeče pro výpočet pixelového pořadí pro konkrétní zařízení;

      lze jej zadat v následujícím rozsahu: 0.5-3;

      ve výchozím nastavení je parametr nastaven na:

      1 pro desktop;

      3 pro mobile na android;

      3 pro mobile na iOS;

      Poznámka: pro použití tohoto parametru nastavte calculate_rectangles na true

    • browser_screen_width
      Typ: integer | null Formát: int64

      šířka obrazovky prohlížeče

      volitelné pole

      můžete nastavit vlastní šířku obrazovky prohlížeče pro výpočet pixelového pořadí pro konkrétní zařízení;

      lze ji zadat v následujícím rozsahu: 240-9999;

      ve výchozím nastavení je parametr nastaven na:

      1920 pro desktop;

      360 pro mobile na android;

      375 pro mobile na iOS;

      Poznámka: pro použití tohoto parametru nastavte calculate_rectangles na true

    • calculate_rectangles
      Typ: boolean | null

      vypočítat pixelové pořadí prvků SERP v rozšířených výsledcích

      volitelné pole

      pixelové pořadí označuje vzdálenost mezi úryvkem výsledku a levým horním rohem obrazovky;

      Další informace najdete v Centru nápovědy>>

      ve výchozím nastavení je parametr nastaven na false

      Poznámka: za použití tohoto parametru bude účtován příplatek $0.0006

    • depth
      Typ: integer | null

      hloubka parsování

      volitelné pole

      počet výsledků v SERP

      výchozí hodnota: 10

      maximální hodnota: 700


      Váš účet bude účtován za každý SERP obsahující až 10 výsledků;

      Nastavení hloubky nad 10 může vést k dodatečným poplatkům pokud vyhledávač vrátí více než 10 výsledků;

      Náklady lze vypočítat na stránce Ceny.

    • device
      Typ: string | null

      typ zařízení

      volitelné pole

      vracet výsledky pro určitý typ zařízení

      může nabývat hodnot:desktop, mobile

      výchozí hodnota: desktop

    • expand_ai_overview
      Typ: boolean | null

      rozbalit přehled AI

      volitelné pole

      nastavte true pro rozbalení položky ai_overview;

      výchozí hodnota: false;

      Poznámka: tento parametr se vztahuje pouze na výsledky úloh HTML

    • find_targets_in
      Typ: array string[] | null

      typy prvků SERP ke kontrole cílů

      volitelné pole

      pro povolení tohoto parametru musí být povolen také stop_crawl_on_match

      určuje, které typy prvků SERP mají být kontrolovány na shody cílů

      pokud není zadáno, všechny prvky první úrovně s poli url a domain jsou kontrolovány na cíle

      možné hodnoty: organic, paid, local_pack, featured_snippet, events, google_flights, images, jobs, knowledge_graph, local_service, map, scholarly_articles, third_party_reviews, twitter

      Poznámka: nesmí obsahovat stejné typy prvků jako ignore_targets_in

      příklad:

      "find_targets_in": ["organic", "featured_snippet"]

      více o tomto parametru najdete v našem Centru nápovědy

    • group_organic_results
      Typ: boolean | null

      zobrazit související výsledky

      volitelné pole

      pokud je nastaveno na true, prvek related_result v odpovědi bude poskytnut jako úryvek nadřazeného organického výsledku;

      pokud je nastaveno na false, prvek related_result bude poskytnut jako samostatný organický výsledek;

      výchozí hodnota: true

    • ignore_targets_in
      Typ: array string[] | null

      typy prvků SERP k vyloučení z hledání cílů

      volitelné pole

      pro povolení tohoto parametru musí být povolen také stop_crawl_on_match

      určuje, které typy prvků SERP mají být při hledání shod cílů vyloučeny

      možné hodnoty: organic, paid, local_pack, featured_snippet, events, google_flights, images, jobs, knowledge_graph, local_service, map, scholarly_articles, third_party_reviews, twitter

      Poznámka: nesmí obsahovat stejné typy prvků jako find_targets_in

      příklad:

      "ignore_targets_in": ["paid", "images"]

      více o tomto parametru najdete v našem Centru nápovědy

    • keyword
      Typ: string

      klíčové slovo

      povinné pole

      můžete zadat až 700 znaků v poli keyword

      všechny výskyty %## budou dekódovány (znak ‘+’ bude dekódován jako mezera)

      pokud potřebujete použít znak „%” v poli keyword, zadejte jej jako „%25”;

      pokud potřebujete použít znak „+” v poli keyword, zadejte jej jako „%2B”;

      pokud toto pole obsahuje parametry jako ‘allinanchor:’, ‘allintext:’, ‘allintitle:’, ‘allinurl:’, ‘cache:’, ‘define:’, ‘filetype:’, ‘id:’, ‘inanchor:’, ‘info:’, ‘intext:’, ‘intitle:’, ‘inurl:’, ‘link:’, ‘site:’, poplatek za úlohu bude vynásoben 5

      další informace o pravidlech a omezeních polí keyword a keywords v rozhraních API DataForSEO najdete v tomto článku Centra nápovědy

    • language_code
      Typ: string

      kód jazyka vyhledávače

      povinné pole, pokud nezadáte language_name

      pokud toto pole použijete, nemusíte zadávat language_name

      seznam dostupných jazyků vyhledávače s jejich language_code získáte samostatným požadavkem na https://api.dataforseo.com/v3/serp/google/languages

      příklad:

      en

    • language_name
      Typ: string

      úplný název jazyka vyhledávače

      povinné pole, pokud nezadáte language_code

      pokud toto pole použijete, nemusíte zadávat language_code

      seznam dostupných jazyků vyhledávače s jejich language_name získáte samostatným požadavkem na https://api.dataforseo.com/v3/serp/google/languages

      příklad:

      English

    • load_async_ai_overview
      Typ: boolean | null

      načíst asynchronní přehled AI

      volitelné pole

      nastavte true, abyste získali položky ai_overview v SERP, i když se načítají asynchronně;

      pokud je nastaveno false, získáte položky ai_overview pouze z mezipaměti;

      výchozí hodnota: false

      Poznámka: za použití tohoto parametru bude účtován příplatek $0.0006;

      pokud prvek chybí nebo obsahuje "asynchronous_ai_overview": false, všechny dodatečné poplatky vám budou vráceny na zůstatek účtu

    • location_code
      Typ: integer

      kód lokality vyhledávače

      povinné pole, pokud nezadáte location_name nebo location_coordinate

      pokud toto pole použijete, nemusíte zadávat location_name nebo location_coordinate

      seznam dostupných lokalit vyhledávačů s jejich location_code získáte samostatným požadavkem na https://api.dataforseo.com/v3/serp/google/locations

      příklad:

      2840

    • location_coordinate
      Typ: string

      GPS souřadnice lokality

      povinné pole, pokud nezadáte location_name nebo location_code

      pokud toto pole použijete, nemusíte zadávat location_name nebo location_code

      parametr location_coordinate je nutné zadat ve formátu "latitude,longitude,radius"

      maximální počet desetinných míst pro "latitude" a "longitude": 7

      minimální hodnota pro "radius": 199 (mm)

      maximální hodnota pro "radius": 199999 (mm)

      příklad:

      53.476225,-2.243572,200

    • location_name
      Typ: string

      úplný název lokality vyhledávače

      povinné pole, pokud nezadáte location_code nebo location_coordinate

      pokud toto pole použijete, nemusíte zadávat location_code nebo location_coordinate

      seznam dostupných lokalit vyhledávače s jejich location_name získáte samostatným požadavkem na https://api.dataforseo.com/v3/serp/google/locations

      příklad:

      London,England,United Kingdom

    • match_type
      Typ: string

      typ shody cíle

      povinné pole, pokud je zadáno stop_crawl_on_match

      typ shody pro match_value

      možné hodnoty:

      domain – konkrétní doména nebo subdoména

      with_subdomains – hlavní doména a subdomény

      wildcard – vzor se zástupnými znaky

    • match_value
      Typ: string

      cílová doména, subdoména nebo hodnota se zástupnými znaky

      povinné pole, pokud je zadáno stop_crawl_on_match

      zadejte cílovou doménu, subdoménu nebo hodnotu se zástupnými znaky;

      Poznámka: doménu nebo subdoménu je nutné zadat bez protokolu požadavku;

      příklad: "match_value": "dataforseo.com",

      "match_value": "/blog/post-*"

    • max_crawl_pages
      Typ: integer | null

      limit procházení stránek

      volitelné pole

      počet stránek výsledků vyhledávání k procházení

      maximální hodnota: 100

      Poznámka: za každou procházenou stránku bude účtován poplatek (10 organických výsledků na stránku);

      další informace o cenách najdete na stránce Ceny;

      Poznámka#2: parametry max_crawl_pages a depth se vzájemně doplňují;

      další informace najdete v našem Centru nápovědy

    • os
      Typ: string | null

      operační systém zařízení

      volitelné pole

      pokud v poli device zadáte desktop, vyberte z následujících hodnot: windows, macos

      výchozí hodnota: windows

      pokud v poli device zadáte mobile, vyberte z následujících hodnot: android, ios

      výchozí hodnota: android

    • people_also_ask_click_depth
      Typ: integer | null

      kliknutí na odpovídající prvek

      volitelné pole

      zadejte hloubku kliknutí na prvek people_also_ask pro získání dalších položek people_also_ask_element;

      Poznámka: váš účet bude účtován dodatečně $0.00015 za každé kliknutí bez ohledu na prioritu úlohy;

      pokud prvek chybí nebo provedeme méně kliknutí, než jste zadali, všechny dodatečné poplatky vám budou vráceny na zůstatek účtu

      možné hodnoty: od 1 do 4

    • pingback_url
      Typ: string | null

      URL oznámení o dokončené úloze

      volitelné pole

      po dokončení úlohy vás upozorníme požadavkem GET odeslaným na zadanou URL

      řetězec ‘$id’ můžete použít jako proměnnou $id a ‘$tag’ jako proměnnou $tag kódovanou v URL. Před odesláním požadavku nastavíme potřebné hodnoty.

      příklad:

      http://your-server.com/pingscript?id=$id

      http://your-server.com/pingscript?id=$id&tag=$tag

      Poznámka: speciální znaky v pingback_url budou kódovány v URL;

      např. znak # bude zakódován jako %23


      další informace najdete v našem Centru nápovědy

    • postback_data
      Typ: string

      datový typ postback_url

      povinné pole, pokud zadáte postback_url

      odpovídá datovému typu, který bude odeslán na váš server

      možné hodnoty:

      regular, advanced, html

    • postback_url
      Typ: string | null

      URL pro odesílání výsledků úlohy

      volitelné pole

      po dokončení úlohy odešleme požadavek POST s výsledky komprimovanými ve formátu gzip na zadanou postback_url

      řetězec ‘$id’ můžete použít jako proměnnou $id a ‘$tag’ jako proměnnou $tag kódovanou v URL. Před odesláním požadavku nastavíme potřebné hodnoty.

      příklad:

      http://your-server.com/postbackscript?id=$id

      http://your-server.com/postbackscript?id=$id&tag=$tag

      Poznámka: speciální znaky v postback_url budou kódovány v URL;

      mj. znak # bude zakódován jako %23


      další informace najdete v Centru nápovědy

    • priority
      Typ: integer | null

      priorita úlohy

      volitelné pole

      může nabývat následujících hodnot:

      1 – normální priorita provedení (ve výchozím nastavení);

      2 – vysoká priorita provedení


      Za úlohy s vysokou prioritou provedení bude účtován příplatek.

      Náklady lze vypočítat na stránce Ceny.

    • remove_from_url
      Typ: array string[] | null

      odebrat konkrétní parametry z adres URL

      volitelné pole

      pomocí tohoto pole můžete určit až 10 parametrů, které se mají z adres URL ve výsledku odebrat

      příklad:

      "remove_from_url": ["srsltid"]

    • se_domain
      Typ: string | null

      doména vyhledávače

      volitelné pole

      relevantní doménu vyhledávače vybíráme automaticky podle zadané lokality a jazyka

      v tomto poli však můžete nastavit vlastní doménu vyhledávače

      příklad:

      google.co.uk, google.com.au, google.de atd.

    • search_param
      Typ: string | null

      další parametry vyhledávacího dotazu

      volitelné pole

      seznam dostupných parametrů a další podrobnosti najdete zde


      Poznámka: následující parametry vyhledávače nejsou podporovány a budou automaticky zrušeny, pokud jsou zadány: lr, cr, as_qdr, as_sitesearch, as_occt, as_filetype.
    • stop_crawl_on_match
      Typ: array (object | null)[] | null

      pole cílových hodnot pro zastavení procházení volitelné pole pokud je zadáno, odpověď bude obsahovat výsledky SERP až do zadané hodnoty match_value včetně; v tomto poli můžete zadat až 10 cílových hodnot příklad: "stop_crawl_on_match":[{"match_value":"dataforseo.com","match_type":"with_subdomains"}] další informace o tomto parametru najdete v našem Centru nápovědy — https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api Váš účet bude účtován za každý SERP procházený přes zadané cíle

      • match_type
        Typ: string | null

        typ shody cíle povinné pole, pokud je zadáno stop_crawl_on_match; typ shody pro match_value možné hodnoty: domain, with_subdomains, wildcard

      • match_value
        Typ: string | null

        cílová doména nebo hodnota se zástupným znakem povinné pole, pokud je zadáno stop_crawl_on_match; zadejte cílovou doménu nebo hodnotu se zástupným znakem; Poznámka: název domény je nutné zadat bez protokolu požadavku; příklad: dataforseo.com

    • tag
      Typ: string | null

      identifikátor úlohy definovaný uživatelem

      volitelné pole

      limit znaků je 255

      tento parametr můžete použít k identifikaci úlohy a jejímu spárování s výsledkem

      zadanou hodnotu tag najdete v objektu data odpovědi

    • target_search_mode
      Typ: string | null

      režim porovnávání cílů

      volitelné pole

      pro povolení tohoto parametru musí být povolen také stop_crawl_on_match

      určuje, jak se má procházení zastavit, když je v stop_crawl_on_match zadáno více cílů

      možné hodnoty: all, any

      all – procházení se zastaví pouze tehdy, když jsou nalezeny všechny zadané cíle

      any – procházení se zastaví, když je nalezen kterýkoli jeden cíl

      výchozí hodnota: any

      další informace o tomto parametru najdete v našem Centru nápovědy

    • url
      Typ: string | null

      přímá URL vyhledávacího dotazu

      volitelné pole

      můžete zadat přímou URL a my ji rozebereme do potřebných polí. Upozorňujeme, že tato metoda je pro naše API nejnáročnější na zpracování a vyžaduje zadání přesného jazyka a lokality v URL. Ve většině případů tuto metodu nedoporučujeme.

      příklad:

      https://www.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS


      Poznámka: následující parametry vyhledávače nejsou podporovány a budou automaticky zrušeny, pokud jsou v URL zadány: lr, cr, as_qdr, as_sitesearch, as_occt, as_filetype.
Odpovědi
  • 200
    Typ: object | null · Response36Afe1097B20_SerpGoogleOrganicTaskPostResponseInfo
    • cost
      Typ: number | null Formát: double

      celkové náklady na úlohy, USD

    • status_code
      Typ: integer | null

      obecný kód stavu úplný seznam kódů odpovědí najdete zde

    • status_message
      Typ: string | null

      obecná informační zpráva úplný seznam obecných informačních zpráv najdete zde

    • tasks
      Typ: array (object | null)[] | null

      pole úloh

      • Typ: object | null · Response36Afe1097B20_SerpGoogleOrganicTaskPostTaskInfo
        • cost
          Typ: number | null Formát: double

          celkové náklady na úlohy, USD

        • data
          Typ: object | null

          obsahuje stejné parametry, které jste zadali v požadavku POST

          • propertyName
            Typ: object | null
        • id
          Typ: string | null

          identifikátor úlohy jedinečný identifikátor úlohy v našem systému ve formátu UUID

        • path
          Typ: array (string | null)[] | null

          cesta URL

        • result
          Typ: object | null

          pole výsledků
          v tomto případě bude hodnota null

        • result_count
          Typ: integer | null Formát: int64

          počet prvků v poli result

        • status_code
          Typ: integer | null

          stavový kód úlohy vygenerovaný DataForSEO; může být v následujícím rozsahu: 10000-60000 úplný seznam kódů odpovědí najdete zde

        • status_message
          Typ: string | null

          informační zpráva úlohy úplný seznam obecných informačních zpráv najdete zde

        • time
          Typ: string | null

          doba provedení, sekundy

    • tasks_count
      Typ: integer | null Formát: int64

      počet úloh v poli tasks

    • tasks_error
      Typ: integer | null Formát: int64

      počet úloh v poli tasks vrácených s chybou

    • time
      Typ: string | null

      celková doba provádění, sekundy

    • version
      Typ: string | null

      aktuální verze API

    application/json
  • 400

    Požadavek se nepodařilo zpracovat. Zkontrolujte parametry požadavku.

  • 401

    Je vyžadován platný API klíč Felo.

  • 402

    V požadavku nelze pokračovat, protože není splněn požadavek na fakturaci.

  • 403

    Účet nemá oprávnění tuto operaci provést.

  • 429

    Byl dosažen limit požadavků nebo útraty.

  • 502

    Služba nemohla požadavek dokončit.

  • 503

    API nebo fakturační služba je dočasně nedostupná.

  • 504

    Při zpracování požadavku vypršel časový limit služby.

  • default

    Chybová odpověď; odpovědi předávané přímo od upstream poskytovatele mohou používat formáty poskytovatele

    application/json
Request Example for post/v1/beta/dataforseo/serp/google/organic/task_post
curl https://openapi.felo.ai/v1/beta/dataforseo/serp/google/organic/task_post \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {
    "language_code": "en",
    "location_code": 2840,
    "keyword": "albert einstein"
  },
  {
    "language_name": "English",
    "location_name": "United States",
    "keyword": "albert einstein",
    "priority": 2,
    "tag": "some_string_123",
    "pingback_url": "https://your-server.com/pingscript?id=$id&tag=$tag"
  },
  {
    "url": "https://www.google.co.uk/search?q=albert%20einstein&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS",
    "postback_data": "html",
    "postback_url": "https://your-server.com/postbackscript"
  }
]'

{
  "version": null,
  "status_code": null,
  "status_message": null,
  "time": null,
  "cost": null,
  "tasks_count": null,
  "tasks_error": null,
  "tasks": [
    {
      "id": null,
      "status_code": null,
      "status_message": null,
      "time": null,
      "cost": null,
      "result_count": null,
      "path": [
        null
      ],
      "data": null,
      "result": null
    }
  ]
}

Úspěšná operace

Setting Google Organic SERP Tasks