Skip to content

Latest commit

 

History

History
43 lines (34 loc) · 7.44 KB

OnPageContentParsingLiveRequestInfo.md

File metadata and controls

43 lines (34 loc) · 7.44 KB

OnPageContentParsingLiveRequestInfo

Properties

Name Type Description Notes
url str URL of the content to parse required field URL of the page to parse example: https://www.fujielectric.com/ [optional]
custom_user_agent str custom user agent optional field custom user agent for crawling a website example: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/83.0.4103.116 Safari/537.36 default value: Mozilla/5.0 (compatible; RSiteAuditor) [optional]
custom_js str custom javascript optional field Note that the execution time for the script you enter here should be 700 ms maximum, for example, you can use the following JS snippet to check if the website contains Google Tag Manager as a scr attribute: let meta = { haveGoogleAnalytics: false, haveTagManager: false };\r\nfor (var i = 0; i < document.scripts.length; i++) {\r\n let src = document.scripts[i].getAttribute(\&quot;src\&quot;);\r\n if (src != undefined) {\r\n if (src.indexOf(\&quot;analytics.js\&quot;) >= 0)\r\n meta.haveGoogleAnalytics = true;\r\n\tif (src.indexOf(\&quot;gtm.js\&quot;) >= 0)\r\n meta.haveTagManager = true;\r\n }\r\n}\r\nmeta;the returned value depends on what you specified in this field. For instance, if you specify the following script: meta = {}; meta.url = document.URL; meta.test = 'test'; meta; as a response you will receive the following data: &quot;custom_js_response&quot;: { &quot;url&quot;: &quot;https://dataforseo.com/\", &quot;test&quot;: &quot;test&quot; } Note: if you use this parameter, additional charges will apply; learn more about the cost of tasks with this parameter in our help article; the cost can be calculated on the Pricing Page [optional]
browser_preset str preset for browser screen parameters optional field if you use this field, you don’t need to indicate browser_screen_width, browser_screen_height, browser_screen_scale_factor possible values: desktop, mobile, tablet desktop preset will apply the following values: browser_screen_width: 1920 browser_screen_height: 1080 browser_screen_scale_factor: 1 mobile preset will apply the following values: browser_screen_width: 390 browser_screen_height: 844 browser_screen_scale_factor: 3 tablet preset will apply the following values: browser_screen_width: 1024 browser_screen_height: 1366 browser_screen_scale_factor: 2 Note: to use this parameter, set enable_javascript or enable_browser_rendering to true [optional]
browser_screen_width int browser screen width optional field you can set a custom browser screen width to perform audit for a particular device; if you use this field, you don’t need to indicate browser_preset as it will be ignored; Note: to use this parameter, set enable_javascript or enable_browser_rendering to true minimum value, in pixels: 240 maximum value, in pixels: 9999 [optional]
browser_screen_height int browser screen height optional field you can set a custom browser screen height to perform audit for a particular device; if you use this field, you don’t need to indicate browser_preset as it will be ignored; Note: to use this parameter, set enable_javascript or enable_browser_rendering to true minimum value, in pixels: 240 maximum value, in pixels: 9999 [optional]
browser_screen_scale_factor float browser screen scale factor optional field you can set a custom browser screen resolution ratio to perform audit for a particular device; if you use this field, you don’t need to indicate browser_preset as it will be ignored; Note: to use this parameter, set enable_javascript or enable_browser_rendering to true minimum value: 0.5 maximum value: 3 [optional]
store_raw_html bool store HTML of a crawled page optional field set to true if you want to get the HTML of the page using the OnPage Raw HTML endpoint default value: false [optional]
disable_cookie_popup bool disable the cookie popup optional field set to true if you want to disable the popup requesting cookie consent from the user; default value: false [optional]
accept_language str language header for accessing the website optional field all locale formats are supported (xx, xx-XX, xxx-XX, etc.) Note: if you do not specify this parameter, some websites may deny access; in this case, pages will be returned with the &quot;type&quot;:&quot;broken in the response array [optional]
enable_javascript bool load javascript on a page optional field set to true if you want to load the scripts available on a page default value: false Note: if you use this parameter, additional charges will apply; learn more about the cost of tasks with this parameter in our help article; the cost can be calculated on the Pricing Page [optional]
enable_browser_rendering bool emulate browser rendering to measure Core Web Vitals optional field by using this parameter you will be able to emulate a browser when loading a web page; enable_browser_rendering loads styles, images, fonts, animations, videos, and other resources on a page; default value: false set to true to obtain Core Web Vitals (FID, CLS, LCP) metrics in the response; if you use this field, enable_javascript, and load_resources parameters must be set to true Note: if you use this parameter, additional charges will apply; learn more about the cost of tasks with this parameter in our help article; the cost can be calculated on the Pricing Page [optional]
enable_xhr bool enable XMLHttpRequest on a page optional field set to true if you want our crawler to request data from a web server using the XMLHttpRequest object default value: false if you use this field, enable_javascript must be set to true; [optional]
switch_pool bool switch proxy pool optional field if true, additional proxy pools will be used to obtain the requested data; the parameter can be used if a multitude of tasks is set simultaneously, resulting in occasional rate-limit and/or site_unreachable errors [optional]
ip_pool_for_scan str proxy pool optional field you can choose a location of the proxy pool that will be used to obtain the requested data; the parameter can be used if page content is inaccessible in one of the locations, resulting in occasional site_unreachable errors possible values: us, de [optional]

Example

from dataforseo_client.models.on_page_content_parsing_live_request_info import OnPageContentParsingLiveRequestInfo

# TODO update the JSON string below
json = "{}"
# create an instance of OnPageContentParsingLiveRequestInfo from a JSON string
on_page_content_parsing_live_request_info_instance = OnPageContentParsingLiveRequestInfo.from_json(json)
# print the JSON string representation of the object
print OnPageContentParsingLiveRequestInfo.to_json()

# convert the object into a dict
on_page_content_parsing_live_request_info_dict = on_page_content_parsing_live_request_info_instance.to_dict()
# create an instance of OnPageContentParsingLiveRequestInfo from a dict
on_page_content_parsing_live_request_info_form_dict = on_page_content_parsing_live_request_info.from_dict(on_page_content_parsing_live_request_info_dict)

[Back to Model list] [Back to API list] [Back to README]