@maxim_mazurok/gapi.client.firebasedynamiclinks-v1 v0.0.20240502

TypeScript typings for Firebase Dynamic Links API v1

Programmatically creates and manages Firebase Dynamic Links. For detailed description please check documentation.

Installing

Install typings for Firebase Dynamic Links API:

npm install @types/gapi.client.firebasedynamiclinks-v1 --save-dev

Usage

You need to initialize Google API client in your code:

gapi.load('client', () => {
  // now we can use gapi.client
  // ...
});

Then load api client wrapper:

gapi.client.load(
  'https://firebasedynamiclinks.googleapis.com/$discovery/rest?version=v1',
  () => {
    // now we can use:
    // gapi.client.firebasedynamiclinks
  }
);

// Deprecated, use discovery document URL, see https://github.com/google/google-api-javascript-client/blob/master/docs/reference.md#----gapiclientloadname----version----callback--
gapi.client.load('firebasedynamiclinks', 'v1', () => {
  // now we can use:
  // gapi.client.firebasedynamiclinks
});

Don't forget to authenticate your client before sending any request to resources:

// declare client_id registered in Google Developers Console
var client_id = '',
  scope = [
    // View and administer all your Firebase data and settings
    'https://www.googleapis.com/auth/firebase',
  ],
  immediate = true;
// ...

gapi.auth.authorize(
  {client_id: client_id, scope: scope, immediate: immediate},
  authResult => {
    if (authResult && !authResult.error) {
      /* handle successful authorization */
    } else {
      /* handle authorization error */
    }
  }
);

After that you can use Firebase Dynamic Links API resources:

/*
Creates a managed short Dynamic Link given either a valid long Dynamic Link or details such as Dynamic Link domain, Android and iOS app information. The created short Dynamic Link will not expire. This differs from CreateShortDynamicLink in the following ways: - The request will also contain a name for the link (non unique name for the front end). - The response must be authenticated with an auth token (generated with the admin service account). - The link will appear in the FDL list of links in the console front end. The Dynamic Link domain in the request must be owned by requester's Firebase project.
*/
await gapi.client.firebasedynamiclinks.managedShortLinks.create({});

/*
Creates a short Dynamic Link given either a valid long Dynamic Link or details such as Dynamic Link domain, Android and iOS app information. The created short Dynamic Link will not expire. Repeated calls with the same long Dynamic Link or Dynamic Link information will produce the same short Dynamic Link. The Dynamic Link domain in the request must be owned by requester's Firebase project.
*/
await gapi.client.firebasedynamiclinks.shortLinks.create({});

/*
Fetches analytics stats of a short Dynamic Link for a given duration. Metrics include number of clicks, redirects, installs, app first opens, and app reopens.
*/
await gapi.client.firebasedynamiclinks.getLinkStats({
  dynamicLink: 'dynamicLink',
});

/*
Get iOS strong/weak-match info for post-install attribution.
*/
await gapi.client.firebasedynamiclinks.installAttribution({});

/*
Get iOS reopen attribution for app universal link open deeplinking.
*/
await gapi.client.firebasedynamiclinks.reopenAttribution({});