Skip to content

Google Apps Script client wrapper for the SWGoH.help API

License

Notifications You must be signed in to change notification settings

PopGoesTheWza/swgoh-help-api

Repository files navigation

SWGoH.help API client for GAS v1.0.5_beta clasp

Google Apps Script client wrapper for the SWGoH.help API.

For API access and support, please visit us on Discord.

Getting Started

Within your Google document:

  1. open the menu Resources and select the option Libraries...
  2. add the library by using this script ID 1bMXMdwJmhTBxb4tBMEyEtw3jPVTzMZQz6NZ9Wm5-5b2MPWWFfqJVGa6n and selecting the latest version
  3. use the following snippet for simple testing:
function Test() {
  // Fill in with your swgoh.help API credentials
  var settings = {
     username: "???",
     password: "???"
  };
  var client = new swgohhelpapi.module.exports.Client(settings);
  var allycodes = [213176142];
  var json = client.fetchPlayer({
    allycodes: allycodes,
    project: {
      allyCode: true,
      name: true,
      updated: true
    }
  });
  debugger;
}

Documentation

TypeDoc documentation

Promotion

This client is powered by alt text.

Consider donating to its Patreon.

Help us continue to scale and support more players across a wider range of tools! Every dollar helps us to boost resources and increase stability. Your donation will help ensure a continued data stream for your favourite swgoh tools.

Build your own copy

Prerequisite:

npm install -g @google/clasp typescript

Steps:

  1. Make a local copy of the GitHub repository.
  2. run the command yarn install
  3. Edit the file .clasp.json with the scriptId of your own copy of the Territory Battles spreadsheet
  4. If needed, edit the source .ts files under the src/ directory
  5. Use Clasp CLI to push the transpiled TypeScript into your Google script
  6. (Optional) issue a Pull Request for your changes to be added to the official release

About the Developer

Reach him on Discord

Contributions

Contributions and feature requests are welcome.

License

MIT License (c) Guillaume Contesso a.k.a. PopGoesTheWza