XPath is a syntax for describing nodes in an XML document. HTML being an evolution of XML, you can use XPaths to describe where the elements are located on an HTML page.
With ImportFromWeb, you can use XPaths to tell the function what content you want to retrieve from an HTML page
will output the title of the current article in Google Sheets
In this article we will see that creating an XPath to retrieve anything from a page is easy.
The minimum requirements being a basic knowledge of HTML.
XPath is specially useful when the HTML code of a page is rather complex. You don’t necessarily need to learn XPaths to get the most out of ImportFromWeb.
Instead, you can:
Let’s start with a basic example of a HTML page:
<html> <body> <p>I'm a web page</p> </body> </html>
We can isolate the <p> element by calling its XPath:
Check the result here.
Ok that’s easy! But a real page is usually more complex. Let’s study two different methods:
- Use Google Chrome
- Write it by yourself
This is the easiest method to find the XPath of an element without any knowledge of XPaths:
- Open a page you want to retrieve an element from. Try with https://www.amazon.com/s/?keywords=iphone
- Open the Chrome Developer Tool (⌥⌘I in Mac or F12 with Windows)
- Click on at the top left side of the Chrome Developer Tool
- Select an element on the page by clicking on it. The piece of code corresponding to this element should be highlighted.
- Right click on the highlighted code and select Copy > Copy XPath
- If you paste it in any document you should see something like
Great! We’ve got our XPath.
You can now try this XPath in Google Sheets by using the add-on ImportFromWeb.
Although this method works, the element referenced by this XPath might change if the page is modified. And in a dynamic world, it happens all the time.
By learning how XPaths work you will be able to create XPaths that are less sensitive to changes of the page’s code.
Creating your own XPath is easier than it seems. Here we’ll see the basic elements to create a solid XPath that should be reliable even when a page changes.
Let’s start with our previous example, adding a bit of code
<html> <body> <p class="paragraph" id="first">I'm a web page</p> <p class="paragraph" id="second"> Click here to open <a href="https://google.com">Google</a> </p> </body> </html>
We saw that we could use
/html/body/p to reference the
p element, which means listing all the parent element until we get to the element we are looking for.
However an alternative is to call
//p to bypass the parents.
//p would retrieve all the paragraphs. If we want to get only the first one we will use
Referencing an element by its attributes offers usually a better way to make a reliable XPath. Then, in our example we could retrieve the first paragraph by using
A little note about classes: In general an element can have several classes that can be listed in different orders. the previous XPath assumes that the attribute
class looks exactly like
paragraph and then would not be valid for something like
class="paragraph class2". Hence it’s a good practice to use the following
The previous examples output the HTML element. It is usually more interesting to retrieve only components of that element.
- Output text:
I'm a web page
- Output attribute:
Let’s take our previous example using amazon.com.
By analyzing the code around the search item title, we can see that:
- the parent element with a class “s-item-container” contains all the information relative to a search item
- The title is within an h2 tag
- An a element is parent of the title and has a class “s-access-detail-page”
We can easily create two XPaths that will be very useful:
- Get titles of all search items
- Get all the links to the product pages
Now that you know the basics, you can create much more flexible XPaths by using the Rosetta Stone provided by Michael Sorens.
You can play with XPaths by using a Chrome extension like XPather.