{"id":15376463,"url":"https://github.com/tomayac/adwords-reports-nodejs-lib","last_synced_at":"2025-04-15T16:34:39.980Z","repository":{"id":57173826,"uuid":"63868568","full_name":"tomayac/adwords-reports-nodejs-lib","owner":"tomayac","description":"The project adwords-reports-nodejs-lib provides a simple AdWords reporting library for pulling ad hoc reports described in the AdWords Query Lanaguage (AWQL) directly from the AdWords API.","archived":false,"fork":false,"pushed_at":"2020-02-05T21:38:29.000Z","size":39,"stargazers_count":2,"open_issues_count":1,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-09-24T09:11:50.198Z","etag":null,"topics":["adwords","adwords-api","adwords-query-lanaguage","awql"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tomayac.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-07-21T12:45:28.000Z","updated_at":"2023-12-20T09:46:37.000Z","dependencies_parsed_at":"2022-08-24T13:31:10.958Z","dependency_job_id":null,"html_url":"https://github.com/tomayac/adwords-reports-nodejs-lib","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tomayac%2Fadwords-reports-nodejs-lib","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tomayac%2Fadwords-reports-nodejs-lib/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tomayac%2Fadwords-reports-nodejs-lib/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tomayac%2Fadwords-reports-nodejs-lib/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tomayac","download_url":"https://codeload.github.com/tomayac/adwords-reports-nodejs-lib/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249108946,"owners_count":21214089,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["adwords","adwords-api","adwords-query-lanaguage","awql"],"created_at":"2024-10-01T14:07:39.756Z","updated_at":"2025-04-15T16:34:39.960Z","avatar_url":"https://github.com/tomayac.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"## AdWords Reports Node.js Library\n\nThe project ```adwords-reports-nodejs-lib``` provides a simple AdWords reporting\nlibrary for pulling ad hoc [reports](https://developers.google.com/adwords/api/docs/guides/reporting)\ndescribed in the AdWords Query Lanaguage\n([AWQL](https://developers.google.com/adwords/api/docs/guides/awql#adhoc-reports))\ndirectly from the [AdWords API](https://developers.google.com/adwords/api/docs/guides/start).\n\n# Installation\n\nIf you haven’t already, first, install [Node.js](https://nodejs.org/en/) for your\nplatform of choice (macOS, Windows, UNIX-like). For macOS and Windows,\njust use the particular downloadable installers,\nfor UNIX-like systems, the easiest may be to install the Node Version Manager\n([nvm](https://github.com/creationix/nvm#install-script)),\nand then have nvm install Node.js via ```nvm install node```.\n\nWith Node.js comes the Node Package Manager ([npm](https://www.npmjs.com/))\nthat serves for managing projects and their dependencies.\nIn an empty folder, initialize a new project via ```npm init``` and follow npm’s initialization wizard.\nYou can then install the ```adwords-reports-nodejs-lib``` library as a new dependency\nof your freshly created project with the npm command below.\n\n```bash\n\u003e$ npm install --save adwords-reports-nodejs-lib\n```\n\n# Requirements\n\nIn order to use the library you will need:\n\n- **AdWords API Developer Token:** This token can be obtained by\n[signing up for access](https://developers.google.com/adwords/api/docs/guides/signup).\n- **Client ID and Client Secret:**\n[Create a project](https://developers.google.com/adwords/api/docs/guides/first-api-call#set_up_oauth2_authentication)\nin the Developer Console to obtain these.\n\nDuring first use, you will be prompted to create a hidden ```.env``` file into\nwhich these three required values should be placed,\nas well as a custom password that serves for encrypting your authentication details.\n\n# Usage\n\nUpon the first run, the library will guide you through the necessary\n[OAuth](https://developers.google.com/adwords/api/docs/guides/authentication)\nauthentication steps. This is a one-time process,\nthe library automatically takes care of refreshing expired authentication tokens.\nThe library is [Promise](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Promise)-based\nand can be used as outlined in the example below.\n\n```javascript\nconst adwords = require('adwords-reports-nodejs-lib');\n\n// Options are optional and can be omitted\nconst options = {\n  format: 'TSV',\n  skipReportHeader: true,\n  skipColumnHeader: true,\n  skipReportSummary: true,\n  useRawEnumValues: true,\n  includeZeroImpressions: true\n};\nadwords.getReport({\n  cid: '123-456-7890',\n  awql: 'SELECT Criteria, Clicks FROM KEYWORDS_PERFORMANCE_REPORT DURING TODAY'\n}, options)\n.then(data =\u003e {\n  console.log(data);\n})\n.catch(err =\u003e {\n  console.error(err);\n});\n```\n\n# License\n\nCopyright 2017 Thomas Steiner (@tomayac, tomac@google.com)\n\nLicensed under the Apache License, Version 2.0 (the \"License\"); you may not use\nthis file except in compliance with the License. You may obtain a copy of the License at\n\nhttp://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software distributed under\nthe License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,\neither express or implied. See the License for the specific language governing permissions\nand limitations under the License.\n\n[![NPM](https://nodei.co/npm/adwords-reports-nodejs-lib.png?downloads=true)](https://nodei.co/npm/adwords-reports-nodejs-lib/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftomayac%2Fadwords-reports-nodejs-lib","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftomayac%2Fadwords-reports-nodejs-lib","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftomayac%2Fadwords-reports-nodejs-lib/lists"}