Skip to content

Instantly share code, notes, and snippets.

@JulienDev
Last active March 21, 2023 17:25
Show Gist options
  • Save JulienDev/df5a3b66e899c224fa1b2dc90acfa2ae to your computer and use it in GitHub Desktop.
Save JulienDev/df5a3b66e899c224fa1b2dc90acfa2ae to your computer and use it in GitHub Desktop.
Track your Instagram followers over time with Google Sheets Scripts
// Your sheet name in the document
var sheetName = "Data";
// Your instagram user id
var user_id = "CHANGE-ME"; //find your id here : https://codeofaninja.com/tools/find-instagram-user-id
var instagram_base_url = "https://www.instagram.com/graphql/query/";
var following = "?query_hash=58712303d941c6855d4e888c5f0cd22f&variables=%7B%22id%22%3A%22" + user_id + "%22%2C%22first%22%3A24%7D"
var followers = "?query_hash=37479f2b8209594dde7facb0d904896a&variables=%7B%22id%22%3A%22" + user_id + "%22%2C%22first%22%3A24%7D"
var medias = "?query_hash=f2405b236d85e8296cf30347c9f08c2a&variables=%7B%22id%22%3A%22" + user_id + "%22%2C%22first%22%3A12%7D"
function insertFollowerCount() {
var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheetByName(this.sheetName);
var followers = getFollowers();
var folloging = getFollowing();
var medias = getMedias();
var engagement = getEngagement(medias, followers);
sheet.appendRow([Utilities.formatDate(new Date(), "GMT", "yyyy-MM-dd"), followers, folloging, medias.count, engagement.totalLikes, engagement.totalComments, engagement.EngagementRatio]);
};
function getFollowers() {
return parseInt(fetch(instagram_base_url + followers)['data']['user']['edge_followed_by']['count']);
}
function getFollowing() {
return parseInt(fetch(instagram_base_url + following)['data']['user']['edge_follow']['count']);
}
function getMedias() {
return fetch(instagram_base_url + medias)['data']['user']['edge_owner_to_timeline_media'];
}
function getEngagement(medias, followers) {
var totalComments = 0,
totalLikes = 0;
for (var i = 0; i < 12; i++) {
totalComments += parseInt(medias.edges[i].node.edge_media_to_comment.count);
};
for (var l = 0; l < 12; l++) {
totalLikes += parseInt(medias.edges[l].node.edge_media_preview_like.count);
};
var engagementRatio = (((totalLikes + totalComments)) / followers) / 12;
return {
mediaCount: parseInt(medias.count),
totalComments: totalComments,
totalLikes: totalLikes,
EngagementRatio: engagementRatio
}
}
function fetch(url) {
var ignoreError = {
"validateHttpsCertificates":false,
"muteHttpExcecptions": true
};
var source = UrlFetchApp.fetch(url, ignoreError).getContentText();
var data = JSON.parse(source);
return data;
}
@louisg90
Copy link

I am getting the error:
SyntaxError: Unexpected token < in JSON at position 0 (line 64, file "Instagram Automation")

@syrinx32123
Copy link

I keep getting this error

Exception: Request failed for https://www.instagram.com returned code 429. Truncated server response: <!DOCTYPE html> <html lang="en" class="no-js not-logged-in "> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" ... (use muteHttpExceptions option to examine full response)

@bbakalov
Copy link

bbakalov commented Nov 18, 2020

@syrinx32123 I have found solution. I'm not sure how long it will be working BUT it works now)

  1. Login to the instagram via browser (i'm using my usual everyday usage browser)
  2. Go to the API endpoint that you need via browser (example https://www.instagram.com/graphql/query/?query_hash=.....)
  3. Open browser console (in google chrome click F12) and go to the tab "Network"
  4. Reload the page with URL from step #2
  5. In the Network tab open request info and in the tab "Headers" you should find dropdown menu "Request headers", click on it and copy value from cookie section
  6. Go to your Google Script and modify function fetch(url)
function fetch(url) {
  var cookie = 'cookieValueFromTheStep#5';
  var header = {'Cookie':cookie};
  var opt = {
    muteHttpExcecptions: true,
    "headers":header
  };
  var source = UrlFetchApp.fetch(url, opt).getContentText();
  var data = JSON.parse(source);
  return data;
}
  1. Run script and be happy 🎉

If it was helpful, please subscribe to my IG account https://www.instagram.com/bbakalov/

@syrinx32123
Copy link

@syrinx32123 I have found solution. I'm not sure how long it will be working BUT it works now)

  1. Login to the instagram via browser (i'm using my usual everyday usage browser)
  2. Go to the API endpoint that you need via browser (example https://www.instagram.com/graphql/query/?query_hash=.....)
  3. Open browser console (in google chrome click F12) and go to the tab "Network"
  4. Reload the page with URL from step #2
  5. In the Network tab open request info and in the tab "Headers" you should find dropdown menu "Request headers", click on it and copy value from cookie section
  6. Go to your Google Script and modify function fetch(url)
function fetch(url) {
  var cookie = 'cookieValueFromTheStep#5';
  var header = {'Cookie':cookie};
  var opt = {
    muteHttpExcecptions: true,
    "headers":header
  };
  var source = UrlFetchApp.fetch(url, opt).getContentText();
  var data = JSON.parse(source);
  return data;
}
  1. Run script and be happy 🎉

If it was helpful, please subscribe to my IG account https://www.instagram.com/bbakalov/

Sorry I lost you on step 2... "Go to the API endpoint that you need via browser" ?

@bbakalov
Copy link

Please check script row by row.
You should open url in your browser that looks like this one: https://www.instagram.com/graphql/query/?query_hash=58712303d941c6855d4e888c5f0cd22f&variables=%7B%22id%22%3A%22" + user_id + "%22%2C%22first%22%3A24%7D

Instead of user_id should be you id.

In my case it's looks like: https://www.instagram.com/graphql/query/?query_hash=58712303d941c6855d4e888c5f0cd22f&variables=%7B%22id%22%3A%22231611776%22%2C%22first%22%3A24%7D

Sorry I lost you on step 2... "Go to the API endpoint that you need via browser" ?

@JulienDev
Copy link
Author

Hello, I've fixed the script, could you please let me know if it works for you? :)

@syrinx32123
Copy link

syrinx32123 commented Nov 20, 2020

Hmm still not working. Still getting this error

Exception: Request failed for https://www.instagram.com returned code 429. Truncated server response: <meta http-equiv="X-UA-Compatible" ... (use muteHttpExceptions option to examine full response) (line 58, file "Code")

This is the script I used:

`// Your sheet name in the document
var sheetName = "AmericanEagle";
// Your instagram user id
var user_id = "1935199"; //find your id here : https://codeofaninja.com/tools/find-instagram-user-id

var instagram_base_url = "https://www.instagram.com/graphql/query/";
var following = "?query_hash=58712303d941c6855d4e888c5f0cd22f&variables=%7B%22id%22%3A%22" + user_id + "%22%2C%22first%22%3A24%7D"
var followers = "?query_hash=37479f2b8209594dde7facb0d904896a&variables=%7B%22id%22%3A%22" + user_id + "%22%2C%22first%22%3A24%7D"
var medias = "?query_hash=f2405b236d85e8296cf30347c9f08c2a&variables=%7B%22id%22%3A%22" + user_id + "%22%2C%22first%22%3A12%7D"

function insertFollowerCount() {
var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheetByName(this.sheetName);

var followers = getFollowers();
var folloging = getFollowing();
var medias = getMedias();
var engagement = getEngagement(medias, followers);

sheet.appendRow([Utilities.formatDate(new Date(), "GMT", "yyyy-MM-dd"), followers, folloging, medias.count, engagement.totalLikes, engagement.totalComments, engagement.EngagementRatio]);

};

function getFollowers() {
return parseInt(fetch(instagram_base_url + followers)['data']['user']['edge_followed_by']['count']);
}

function getFollowing() {
return parseInt(fetch(instagram_base_url + following)['data']['user']['edge_follow']['count']);
}

function getMedias() {
return fetch(instagram_base_url + medias)['data']['user']['edge_owner_to_timeline_media'];
}

function getEngagement(medias, followers) {
var totalComments = 0,
totalLikes = 0;
for (var i = 0; i < 12; i++) {
totalComments += parseInt(medias.edges[i].node.edge_media_to_comment.count);
};
for (var l = 0; l < 12; l++) {
totalLikes += parseInt(medias.edges[l].node.edge_media_preview_like.count);
};
var engagementRatio = (((totalLikes + totalComments)) / followers) / 12;
return {
mediaCount: parseInt(medias.count),
totalComments: totalComments,
totalLikes: totalLikes,
EngagementRatio: engagementRatio
}
}

function fetch(url) {
var ignoreError = {
"muteHttpExcecptions": true
};
var source = UrlFetchApp.fetch(url, ignoreError).getContentText();
var data = JSON.parse(source);
return data;
}

`

@JulienDev
Copy link
Author

You missed the line I added : "validateHttpsCertificates":false,

@syrinx32123
Copy link

@JulienDev Ok i've added that in but still the same error :/

Screen Shot 2020-11-20 at 11 45 30 AM

Screen Shot 2020-11-20 at 11 45 38 AM

@rancilyo
Copy link

I'm having the issue too :(

@syrinx32123
Copy link

@JulienDev

You missed the line I added : "validateHttpsCertificates":false,

Any update? I really need this to work :/

@paulhennell
Copy link

Was just trying this out, but also getting the same error as others:

Request failed for https://www.instagram.com returned code 429. Truncated server response: <!DOCTYPE html> <html lang="en" class="no-js not-logged-in "> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" ... (use muteHttpExceptions option to examine full response). (line 58, file "Code")

Manually visiting the link in the browser gets a json response, but the payload is different in a logged in window, vs private window. Have they changed the system to avoid people scraping like this?

@bbakalov
Copy link

Guys, please READ CAREFULLY i have prepared already WORK option for you. Invest you time to understand row by row script that was prepared for you and check my small changes, that give you possibility to use this script as you wish. I'm using it already several days, with no problem.
Here is my customization https://gist.github.com/JulienDev/df5a3b66e899c224fa1b2dc90acfa2ae#gistcomment-3531268
Here is video https://streamable.com/ze9ktm , how to get cookie value from step 2, because people had a problem with it

@rancilyo
Copy link

Is there an update about this issue?

@rancilyo
Copy link

rancilyo commented Dec 1, 2020

@JulienDev

You missed the line I added : "validateHttpsCertificates":false,

Any update? I really need this to work :/

It seems there is no update so far :(

Copy link

ghost commented Dec 2, 2020

@syrinx32123 I have found solution. I'm not sure how long it will be working BUT it works now)

  1. Login to the instagram via browser (i'm using my usual everyday usage browser)
  2. Go to the API endpoint that you need via browser (example https://www.instagram.com/graphql/query/?query_hash=.....)
  3. Open browser console (in google chrome click F12) and go to the tab "Network"
  4. Reload the page with URL from step #2
  5. In the Network tab open request info and in the tab "Headers" you should find dropdown menu "Request headers", click on it and copy value from cookie section
  6. Go to your Google Script and modify function fetch(url)
function fetch(url) {
  var cookie = 'cookieValueFromTheStep#5';
  var header = {'Cookie':cookie};
  var opt = {
    muteHttpExcecptions: true,
    "headers":header
  };
  var source = UrlFetchApp.fetch(url, opt).getContentText();
  var data = JSON.parse(source);
  return data;
}
  1. Run script and be happy 🎉

If it was helpful, please subscribe to my IG account https://www.instagram.com/bbakalov/

Thank you @bbakalov

It's working fine following your updates. It will be interesting to see how long this lasts.

Please follow it line by line, especially the part about logging into the correct instagram account.

@syrinx32123
Copy link

I followed @bbakalov instructions and it worked.

@reiddossinger
Copy link

The problem with the instructions is that it requires being logged in, which is a non-starter for those of us tracking other accounts besides our own. Plus, isn't getting a cookie value something that is going to break sooner or later, and you have to go get a new cookie value? How long does that cookie last?

@syrinx32123
Copy link

The problem with the instructions is that it requires being logged in, which is a non-starter for those of us tracking other accounts besides our own. Plus, isn't getting a cookie value something that is going to break sooner or later, and you have to go get a new cookie value? How long does that cookie last?

Agreed, we need a future proof solution. Also the cookie work around seems to fail often.

@Bitesx
Copy link

Bitesx commented Dec 9, 2020

Does anyone have any idea why I'm getting this message?

TypeError: Cannot read property 'appendRow' of null (line 20, file "Code")

Row 20:

sheet.appendRow([Utilities.formatDate(new Date(), "GMT", "yyyy-MM-dd"), followers, folloging, medias.count, engagement.totalLikes, engagement.totalComments, engagement.EngagementRatio]);
};

@syrinx32123
Copy link

Does anyone have a solution that doesn't involve using the cookies? It was working for a couple of weeks but it's stopped working again.

@amblerkr
Copy link

amblerkr commented Dec 17, 2020

Please check script row by row.
You should open url in your browser that looks like this one: https://www.instagram.com/graphql/query/?query_hash=58712303d941c6855d4e888c5f0cd22f&variables=%7B%22id%22%3A%22" + user_id + "%22%2C%22first%22%3A24%7D

Instead of user_id should be you id.

In my case it's looks like: https://www.instagram.com/graphql/query/?query_hash=58712303d941c6855d4e888c5f0cd22f&variables=%7B%22id%22%3A%22231611776%22%2C%22first%22%3A24%7D

Sorry I lost you on step 2... "Go to the API endpoint that you need via browser" ?

@bbakalov thanks. It worked for 25 days and stopped after that. I renewed the cookies.

  1. Do I have to bring cookies for each account ID I want to track?
  2. document.cookie Can I use this?
    https://gist.github.com/nickboyce/06c0ff48a2892311bd9a6601baed55b0#gistcomment-3534742
  3. I tried to record the number of followers in six accounts using this method. And my account is locked. What did I do wrong?
    I'm using a Google Sheet trigger. I recorded it every hour.

@amblerkr
Copy link

amblerkr commented Dec 19, 2020

@JulienDev It works, but it stops at the trigger. I want to fill it out every hour, is there a way?

Exception: https://www.instagram.com에 대한 요청이 실패하여 코드 429이(가) 반환되었습니다. 서버 응답이 잘림: <meta http-equiv="X-UA-Compatible" ...(전체 응답을 확인하려면 muteHttpExceptions 옵션을 사용하세요.) | 10
SyntaxError: Unexpected token < in JSON at position 0

The above email has arrived to me.
Trigger Error rate = 37.5%
That's why it's hard for me to use. I'm using the cookie method. I think your method is excellent. Can you help me?
I won't be able to renew every time. So I need your method.

@DairoJunior
Copy link

DairoJunior commented Dec 28, 2020

### there is this solution, but I was unable to run it daily.

this is the code behind the spreadsheet
https://docs.google.com/spreadsheets/d/1mVaCROebN-UXnLwzt5olBA0x6kIFSJuOnrptvyj0Wto / edit? usp = compartilhamento

link tutorial:
https://martechwithme.com/monitoring-instagram-accounts-followers-and-engagement-rate-with-google-sheets/

====================================================================================================================================
ImportJSON by Brad Jasper and Trevor Lohrbeer

Version: 1.5.0
Project Page: https://github.com/bradjasper/ImportJSON
Copyright: (c) 2017-2019 by Brad Jasper
(c) 2012-2017 by Trevor Lohrbeer
License: GNU General Public License, version 3 (GPL-3.0)
http://www.opensource.org/licenses/gpl-3.0.html

A library for importing JSON feeds into Google spreadsheets. Functions include:

 ImportJSON            For use by end users to import a JSON feed from a URL 
 ImportJSONFromSheet   For use by end users to import JSON from one of the Sheets
 ImportJSONViaPost     For use by end users to import a JSON feed from a URL using POST parameters
 ImportJSONAdvanced    For use by script developers to easily extend the functionality of this library
 ImportJSONBasicAuth   For use by end users to import a JSON feed from a URL with HTTP Basic Auth (added by Karsten Lettow)

For future enhancements see https://github.com/bradjasper/ImportJSON/issues?q=is%3Aissue+is%3Aopen+label%3Aenhancement

For bug reports see https://github.com/bradjasper/ImportJSON/issues


Changelog:

1.6.0 (June 2, 2019) Fixed null values (thanks @gdesmedt1)
1.5.0 (January 11, 2019) Adds ability to include all headers in a fixed order even when no data is present for a given header in some or all rows.
1.4.0 (July 23, 2017) Transfer project to Brad Jasper. Fixed off-by-one array bug. Fixed previous value bug. Added custom annotations. Added ImportJSONFromSheet and ImportJSONBasicAuth.
1.3.0 Adds ability to import the text from a set of rows containing the text to parse. All cells are concatenated
1.2.1 Fixed a bug with how nested arrays are handled. The rowIndex counter wasn't incrementing properly when parsing.
1.2.0 Added ImportJSONViaPost and support for fetchOptions to ImportJSONAdvanced
1.1.1 Added a version number using Google Scripts Versioning so other developers can use the library
1.1.0 Added support for the noHeaders option
1.0.0 Initial release
====================================================================================================================================/

/**

  • Imports a JSON feed and returns the results to be inserted into a Google Spreadsheet. The JSON feed is flattened to create
  • a two-dimensional array. The first row contains the headers, with each column header indicating the path to that data in
  • the JSON feed. The remaining rows contain the data.
  • By default, data gets transformed so it looks more like a normal data import. Specifically:
    • Data from parent JSON elements gets inherited to their child elements, so rows representing child elements contain the values
  •  of the rows representing their parent elements.
    
    • Values longer than 256 characters get truncated.
    • Headers have slashes converted to spaces, common prefixes removed and the resulting text converted to title case.
  • To change this behavior, pass in one of these values in the options parameter:
  • noInherit: Don't inherit values from parent elements
  • noTruncate: Don't truncate values
  • rawHeaders: Don't prettify headers
  • noHeaders: Don't include headers, only the data
  • allHeaders: Include all headers from the query parameter in the order they are listed
  • debugLocation: Prepend each value with the row & column it belongs in
  • For example:
  • =ImportJSON("http://gdata.youtube.com/feeds/api/standardfeeds/most_popular?v=2&alt=json", "/feed/entry/title,/feed/entry/content",
  •           "noInherit,noTruncate,rawHeaders")
    
  • @param {url} the URL to a public JSON feed
  • @param {query} a comma-separated list of paths to import. Any path starting with one of these paths gets imported.
  • @param {parseOptions} a comma-separated list of options that alter processing of the data
  • @customfunction
  • @return a two-dimensional array containing the data, with the first row containing headers
    **/
    function ImportJSON(url, query, parseOptions) {
    return ImportJSONAdvanced(url, null, query, parseOptions, includeXPath_, defaultTransform_);
    }

/**

  • Imports a JSON feed via a POST request and returns the results to be inserted into a Google Spreadsheet. The JSON feed is
  • flattened to create a two-dimensional array. The first row contains the headers, with each column header indicating the path to
  • that data in the JSON feed. The remaining rows contain the data.
  • To retrieve the JSON, a POST request is sent to the URL and the payload is passed as the content of the request using the content
  • type "application/x-www-form-urlencoded". If the fetchOptions define a value for "method", "payload" or "contentType", these
  • values will take precedent. For example, advanced users can use this to make this function pass XML as the payload using a GET
  • request and a content type of "application/xml; charset=utf-8". For more information on the available fetch options, see
  • https://developers.google.com/apps-script/reference/url-fetch/url-fetch-app . At this time the "headers" option is not supported.
  • By default, the returned data gets transformed so it looks more like a normal data import. Specifically:
    • Data from parent JSON elements gets inherited to their child elements, so rows representing child elements contain the values
  • of the rows representing their parent elements.
    
    • Values longer than 256 characters get truncated.
    • Headers have slashes converted to spaces, common prefixes removed and the resulting text converted to title case.
  • To change this behavior, pass in one of these values in the options parameter:
  • noInherit: Don't inherit values from parent elements
  • noTruncate: Don't truncate values
  • rawHeaders: Don't prettify headers
  • noHeaders: Don't include headers, only the data
  • allHeaders: Include all headers from the query parameter in the order they are listed
  • debugLocation: Prepend each value with the row & column it belongs in
  • For example:
  • =ImportJSON("http://gdata.youtube.com/feeds/api/standardfeeds/most_popular?v=2&alt=json", "user=bob&apikey=xxxx",
  •           "validateHttpsCertificates=false", "/feed/entry/title,/feed/entry/content", "noInherit,noTruncate,rawHeaders")
    
  • @param {url} the URL to a public JSON feed
  • @param {payload} the content to pass with the POST request; usually a URL encoded list of parameters separated by ampersands
  • @param {fetchOptions} a comma-separated list of options used to retrieve the JSON feed from the URL
  • @param {query} a comma-separated list of paths to import. Any path starting with one of these paths gets imported.
  • @param {parseOptions} a comma-separated list of options that alter processing of the data
  • @customfunction
  • @return a two-dimensional array containing the data, with the first row containing headers
    **/
    function ImportJSONViaPost(url, payload, fetchOptions, query, parseOptions) {
    var postOptions = parseToObject_(fetchOptions);

if (postOptions["method"] == null) {
postOptions["method"] = "POST";
}

if (postOptions["payload"] == null) {
postOptions["payload"] = payload;
}

if (postOptions["contentType"] == null) {
postOptions["contentType"] = "application/x-www-form-urlencoded";
}

convertToBool_(postOptions, "validateHttpsCertificates");
convertToBool_(postOptions, "useIntranet");
convertToBool_(postOptions, "followRedirects");
convertToBool_(postOptions, "muteHttpExceptions");

return ImportJSONAdvanced(url, postOptions, query, parseOptions, includeXPath_, defaultTransform_);
}

/**

  • Imports a JSON text from a named Sheet and returns the results to be inserted into a Google Spreadsheet. The JSON feed is flattened to create
  • a two-dimensional array. The first row contains the headers, with each column header indicating the path to that data in
  • the JSON feed. The remaining rows contain the data.
  • By default, data gets transformed so it looks more like a normal data import. Specifically:
    • Data from parent JSON elements gets inherited to their child elements, so rows representing child elements contain the values
  •  of the rows representing their parent elements.
    
    • Values longer than 256 characters get truncated.
    • Headers have slashes converted to spaces, common prefixes removed and the resulting text converted to title case.
  • To change this behavior, pass in one of these values in the options parameter:
  • noInherit: Don't inherit values from parent elements
  • noTruncate: Don't truncate values
  • rawHeaders: Don't prettify headers
  • noHeaders: Don't include headers, only the data
  • allHeaders: Include all headers from the query parameter in the order they are listed
  • debugLocation: Prepend each value with the row & column it belongs in
  • For example:
  • =ImportJSONFromSheet("Source", "/feed/entry/title,/feed/entry/content",
  •           "noInherit,noTruncate,rawHeaders")
    
  • @param {sheetName} the name of the sheet containg the text for the JSON
  • @param {query} a comma-separated lists of paths to import. Any path starting with one of these paths gets imported.
  • @param {options} a comma-separated list of options that alter processing of the data
  • @return a two-dimensional array containing the data, with the first row containing headers
  • @customfunction
    **/
    function ImportJSONFromSheet(sheetName, query, options) {

var object = getDataFromNamedSheet_(sheetName);

return parseJSONObject_(object, query, options, includeXPath_, defaultTransform_);
}

/**

  • An advanced version of ImportJSON designed to be easily extended by a script. This version cannot be called from within a
  • spreadsheet.
  • Imports a JSON feed and returns the results to be inserted into a Google Spreadsheet. The JSON feed is flattened to create
  • a two-dimensional array. The first row contains the headers, with each column header indicating the path to that data in
  • the JSON feed. The remaining rows contain the data.
  • The fetchOptions can be used to change how the JSON feed is retrieved. For instance, the "method" and "payload" options can be
  • set to pass a POST request with post parameters. For more information on the available parameters, see
  • https://developers.google.com/apps-script/reference/url-fetch/url-fetch-app .
  • Use the include and transformation functions to determine what to include in the import and how to transform the data after it is
  • imported.
  • For example:
  • ImportJSON("http://gdata.youtube.com/feeds/api/standardfeeds/most_popular?v=2&alt=json",
  •          new Object() { "method" : "post", "payload" : "user=bob&apikey=xxxx" },
    
  •          "/feed/entry",
    
  •          "",
    
  •          function (query, path) { return path.indexOf(query) == 0; },
    
  •          function (data, row, column) { data[row][column] = data[row][column].toString().substr(0, 100); } )
    
  • In this example, the import function checks to see if the path to the data being imported starts with the query. The transform
  • function takes the data and truncates it. For more robust versions of these functions, see the internal code of this library.
  • @param {url} the URL to a public JSON feed
  • @param {fetchOptions} an object whose properties are options used to retrieve the JSON feed from the URL
  • @param {query} the query passed to the include function
  • @param {parseOptions} a comma-separated list of options that may alter processing of the data
  • @param {includeFunc} a function with the signature func(query, path, options) that returns true if the data element at the given path
  •                    should be included or false otherwise. 
    
  • @param {transformFunc} a function with the signature func(data, row, column, options) where data is a 2-dimensional array of the data
  •                    and row & column are the current row and column being processed. Any return value is ignored. Note that row 0 
    
  •                    contains the headers for the data, so test for row==0 to process headers only.
    
  • @return a two-dimensional array containing the data, with the first row containing headers
  • @customfunction
    **/
    function ImportJSONAdvanced(url, fetchOptions, query, parseOptions, includeFunc, transformFunc) {
    var jsondata = UrlFetchApp.fetch(url, fetchOptions);
    var object = JSON.parse(jsondata.getContentText());

return parseJSONObject_(object, query, parseOptions, includeFunc, transformFunc);
}

/**

  • Helper function to authenticate with basic auth informations using ImportJSONAdvanced
  • Imports a JSON feed and returns the results to be inserted into a Google Spreadsheet. The JSON feed is flattened to create
  • a two-dimensional array. The first row contains the headers, with each column header indicating the path to that data in
  • the JSON feed. The remaining rows contain the data.
  • The fetchOptions can be used to change how the JSON feed is retrieved. For instance, the "method" and "payload" options can be
  • set to pass a POST request with post parameters. For more information on the available parameters, see
  • https://developers.google.com/apps-script/reference/url-fetch/url-fetch-app .
  • Use the include and transformation functions to determine what to include in the import and how to transform the data after it is
  • imported.
  • @param {url} the URL to a http basic auth protected JSON feed
  • @param {username} the Username for authentication
  • @param {password} the Password for authentication
  • @param {query} the query passed to the include function (optional)
  • @param {parseOptions} a comma-separated list of options that may alter processing of the data (optional)
  • @return a two-dimensional array containing the data, with the first row containing headers
  • @customfunction
    **/
    function ImportJSONBasicAuth(url, username, password, query, parseOptions) {
    var encodedAuthInformation = Utilities.base64Encode(username + ":" + password);
    var header = {headers: {Authorization: "Basic " + encodedAuthInformation}};
    return ImportJSONAdvanced(url, header, query, parseOptions, includeXPath_, defaultTransform_);
    }

/**

  • Encodes the given value to use within a URL.
  • @param {value} the value to be encoded
  • @return the value encoded using URL percent-encoding
    */
    function URLEncode(value) {
    return encodeURIComponent(value.toString());
    }

/**

  • Adds an oAuth service using the given name and the list of properties.
  • @note This method is an experiment in trying to figure out how to add an oAuth service without having to specify it on each
  •   ImportJSON call. The idea was to call this method in the first cell of a spreadsheet, and then use ImportJSON in other
    
  •   cells. This didn't work, but leaving this in here for further experimentation later. 
    
  •   The test I did was to add the following into the A1:
    
  •       =AddOAuthService("twitter", "https://api.twitter.com/oauth/access_token", 
    
  •                        "https://api.twitter.com/oauth/request_token", "https://api.twitter.com/oauth/authorize", 
    
  •                        "<my consumer key>", "<my consumer secret>", "", "")
    
  •   Information on obtaining a consumer key & secret for Twitter can be found at https://dev.twitter.com/docs/auth/using-oauth
    
  •   Then I added the following into A2:
    
  •       =ImportJSONViaPost("https://api.twitter.com/1.1/statuses/user_timeline.json?screen_name=fastfedora&count=2", "",
    
  •                          "oAuthServiceName=twitter,oAuthUseToken=always", "/", "")
    
  •   I received an error that the "oAuthServiceName" was not a valid value. [twl 18.Apr.13]
    

*/
function AddOAuthService__(name, accessTokenUrl, requestTokenUrl, authorizationUrl, consumerKey, consumerSecret, method, paramLocation) {
var oAuthConfig = UrlFetchApp.addOAuthService(name);

if (accessTokenUrl != null && accessTokenUrl.length > 0) {
oAuthConfig.setAccessTokenUrl(accessTokenUrl);
}

if (requestTokenUrl != null && requestTokenUrl.length > 0) {
oAuthConfig.setRequestTokenUrl(requestTokenUrl);
}

if (authorizationUrl != null && authorizationUrl.length > 0) {
oAuthConfig.setAuthorizationUrl(authorizationUrl);
}

if (consumerKey != null && consumerKey.length > 0) {
oAuthConfig.setConsumerKey(consumerKey);
}

if (consumerSecret != null && consumerSecret.length > 0) {
oAuthConfig.setConsumerSecret(consumerSecret);
}

if (method != null && method.length > 0) {
oAuthConfig.setMethod(method);
}

if (paramLocation != null && paramLocation.length > 0) {
oAuthConfig.setParamLocation(paramLocation);
}
}

/**

  • Parses a JSON object and returns a two-dimensional array containing the data of that object.
    */
    function parseJSONObject_(object, query, options, includeFunc, transformFunc) {
    var headers = new Array();
    var data = new Array();

if (query && !Array.isArray(query) && query.toString().indexOf(",") != -1) {
query = query.toString().split(",");
}

// Prepopulate the headers to lock in their order
if (hasOption_(options, "allHeaders") && Array.isArray(query))
{
for (var i = 0; i < query.length; i++)
{
headers[query[i]] = Object.keys(headers).length;
}
}

if (options) {
options = options.toString().split(",");
}

parseData_(headers, data, "", {rowIndex: 1}, object, query, options, includeFunc);
parseHeaders_(headers, data);
transformData_(data, options, transformFunc);

return hasOption_(options, "noHeaders") ? (data.length > 1 ? data.slice(1) : new Array()) : data;
}

/**

  • Parses the data contained within the given value and inserts it into the data two-dimensional array starting at the rowIndex.
  • If the data is to be inserted into a new column, a new header is added to the headers array. The value can be an object,
  • array or scalar value.
  • If the value is an object, it's properties are iterated through and passed back into this function with the name of each
  • property extending the path. For instance, if the object contains the property "entry" and the path passed in was "/feed",
  • this function is called with the value of the entry property and the path "/feed/entry".
  • If the value is an array containing other arrays or objects, each element in the array is passed into this function with
  • the rowIndex incremeneted for each element.
  • If the value is an array containing only scalar values, those values are joined together and inserted into the data array as
  • a single value.
  • If the value is a scalar, the value is inserted directly into the data array.
    */
    function parseData_(headers, data, path, state, value, query, options, includeFunc) {
    var dataInserted = false;

if (Array.isArray(value) && isObjectArray_(value)) {
for (var i = 0; i < value.length; i++) {
if (parseData_(headers, data, path, state, value[i], query, options, includeFunc)) {
dataInserted = true;

    if (data[state.rowIndex]) {
      state.rowIndex++;
    }
  }
}

} else if (isObject_(value)) {
for (key in value) {
if (parseData_(headers, data, path + "/" + key, state, value[key], query, options, includeFunc)) {
dataInserted = true;
}
}
} else if (!includeFunc || includeFunc(query, path, options)) {
// Handle arrays containing only scalar values
if (Array.isArray(value)) {
value = value.join();
}

// Insert new row if one doesn't already exist
if (!data[state.rowIndex]) {
  data[state.rowIndex] = new Array();
}

// Add a new header if one doesn't exist
if (!headers[path] && headers[path] != 0) {
  headers[path] = Object.keys(headers).length;
}

// Insert the data
data[state.rowIndex][headers[path]] = value;
dataInserted = true;

}

return dataInserted;
}

/**

  • Parses the headers array and inserts it into the first row of the data array.
    */
    function parseHeaders_(headers, data) {
    data[0] = new Array();

for (key in headers) {
data[0][headers[key]] = key;
}
}

/**

  • Applies the transform function for each element in the data array, going through each column of each row.
    */
    function transformData_(data, options, transformFunc) {
    for (var i = 0; i < data.length; i++) {
    for (var j = 0; j < data[0].length; j++) {
    transformFunc(data, i, j, options);
    }
    }
    }

/**

  • Returns true if the given test value is an object; false otherwise.
    */
    function isObject_(test) {
    return Object.prototype.toString.call(test) === '[object Object]';
    }

/**

  • Returns true if the given test value is an array containing at least one object; false otherwise.
    */
    function isObjectArray_(test) {
    for (var i = 0; i < test.length; i++) {
    if (isObject_(test[i])) {
    return true;
    }
    }

return false;
}

/**

  • Returns true if the given query applies to the given path.
    */
    function includeXPath_(query, path, options) {
    if (!query) {
    return true;
    } else if (Array.isArray(query)) {
    for (var i = 0; i < query.length; i++) {
    if (applyXPathRule_(query[i], path, options)) {
    return true;
    }
    }
    } else {
    return applyXPathRule_(query, path, options);
    }

return false;
};

/**

  • Returns true if the rule applies to the given path.
    */
    function applyXPathRule_(rule, path, options) {
    return path.indexOf(rule) == 0;
    }

/**

  • By default, this function transforms the value at the given row & column so it looks more like a normal data import. Specifically:
    • Data from parent JSON elements gets inherited to their child elements, so rows representing child elements contain the values
  • of the rows representing their parent elements.
    
    • Values longer than 256 characters get truncated.
    • Values in row 0 (headers) have slashes converted to spaces, common prefixes removed and the resulting text converted to title
  •  case. 
    
  • To change this behavior, pass in one of these values in the options parameter:
  • noInherit: Don't inherit values from parent elements
  • noTruncate: Don't truncate values
  • rawHeaders: Don't prettify headers
  • debugLocation: Prepend each value with the row & column it belongs in
    */
    function defaultTransform_(data, row, column, options) {
    if (data[row][column] == null) {
    if (row < 2 || hasOption_(options, "noInherit")) {
    data[row][column] = "";
    } else {
    data[row][column] = data[row-1][column];
    }
    }

if (!hasOption_(options, "rawHeaders") && row == 0) {
if (column == 0 && data[row].length > 1) {
removeCommonPrefixes_(data, row);
}

data[row][column] = toTitleCase_(data[row][column].toString().replace(/[\/\_]/g, " "));

}

if (!hasOption_(options, "noTruncate") && data[row][column]) {
data[row][column] = data[row][column].toString().substr(0, 256);
}

if (hasOption_(options, "debugLocation")) {
data[row][column] = "[" + row + "," + column + "]" + data[row][column];
}
}

/**

  • If all the values in the given row share the same prefix, remove that prefix.
    */
    function removeCommonPrefixes_(data, row) {
    var matchIndex = data[row][0].length;

for (var i = 1; i < data[row].length; i++) {
matchIndex = findEqualityEndpoint_(data[row][i-1], data[row][i], matchIndex);

if (matchIndex == 0) {
  return;
}

}

for (var i = 0; i < data[row].length; i++) {
data[row][i] = data[row][i].substring(matchIndex, data[row][i].length);
}
}

/**

  • Locates the index where the two strings values stop being equal, stopping automatically at the stopAt index.
    */
    function findEqualityEndpoint_(string1, string2, stopAt) {
    if (!string1 || !string2) {
    return -1;
    }

var maxEndpoint = Math.min(stopAt, string1.length, string2.length);

for (var i = 0; i < maxEndpoint; i++) {
if (string1.charAt(i) != string2.charAt(i)) {
return i;
}
}

return maxEndpoint;
}

/**

  • Converts the text to title case.
    */
    function toTitleCase_(text) {
    if (text == null) {
    return null;
    }

return text.replace(/\w\S*/g, function(word) { return word.charAt(0).toUpperCase() + word.substr(1).toLowerCase(); });
}

/**

  • Returns true if the given set of options contains the given option.
    */
    function hasOption_(options, option) {
    return options && options.indexOf(option) >= 0;
    }

/**

  • Parses the given string into an object, trimming any leading or trailing spaces from the keys.
    */
    function parseToObject_(text) {
    var map = new Object();
    var entries = (text != null && text.trim().length > 0) ? text.toString().split(",") : new Array();

for (var i = 0; i < entries.length; i++) {
addToMap_(map, entries[i]);
}

return map;
}

/**

  • Parses the given entry and adds it to the given map, trimming any leading or trailing spaces from the key.
    */
    function addToMap_(map, entry) {
    var equalsIndex = entry.indexOf("=");
    var key = (equalsIndex != -1) ? entry.substring(0, equalsIndex) : entry;
    var value = (key.length + 1 < entry.length) ? entry.substring(key.length + 1) : "";

map[key.trim()] = value;
}

/**

  • Returns the given value as a boolean.
    */
    function toBool_(value) {
    return value == null ? false : (value.toString().toLowerCase() == "true" ? true : false);
    }

/**

  • Converts the value for the given key in the given map to a bool.
    */
    function convertToBool_(map, key) {
    if (map[key] != null) {
    map[key] = toBool_(map[key]);
    }
    }

function getDataFromNamedSheet_(sheetName) {
var ss = SpreadsheetApp.getActiveSpreadsheet();
var source = ss.getSheetByName(sheetName);

var jsonRange = source.getRange(1,1,source.getLastRow());
var jsonValues = jsonRange.getValues();

var jsonText = "";
for (var row in jsonValues) {
for (var col in jsonValues[row]) {
jsonText +=jsonValues[row][col];
}
}
Logger.log(jsonText);
return JSON.parse(jsonText);
}

@syrinx32123
Copy link

Any luck on getting this working?

@bbakalov
Copy link

bbakalov commented Jan 4, 2021

Any luck on getting this working?

man, while you waiting, my script works everyday without any problems

@rancilyo
Copy link

rancilyo commented Jan 4, 2021

Any luck on getting this working?

man, while you waiting, my script works everyday without any problems

Yeah, but your script only works if you are logged in. Let's suppose that you want to track a competitor, how would it be?

@syrinx32123
Copy link

Any luck on getting this working?

man, while you waiting, my script works everyday without any problems

It worked for a few days and then I guess the cookies changed so it stopped working. I track 50+ accounts so it is not easy to update the cookie for all of them.

@syrinx32123
Copy link

Can someone please fix this 😭

@zorayaghanem
Copy link

hello! any luck finding a solution for this :) ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment