ad-platform-integration

ad-platform-integration is a library for managing ad platforms, currently supporting Meta Ads (Facebook Ads). This README provides an overview of how to use the library.

Installation

npm install ad-platform-integration

Usage

Importing the necessary modules

import { createAdPlatformManager } from 'ad-platform-integration';
import { PlatformEnum } from 'ad-platform-integration/dist/enums';
import { DatasetType, MetaAdsPlatformConfig } from 'ad-platform-integration/dist/types';

Configuring the ad platform

To use the Meta Ads platform, you need to create a configuration object:

const metaAdsConfig: MetaAdsPlatformConfig = {
  accountId: 'YOUR_ACCOUNT_ID',
  appId: 'YOUR_APP_ID',
  appSecret: 'YOUR_APP_SECRET'
};

Replace YOUR_ACCOUNT_ID, YOUR_APP_ID, and YOUR_APP_SECRET with your actual Meta Ads credentials.

Creating an ad platform manager

Use the createAdPlatformManager function to create a manager for the desired platform:

const createAdManager = createAdPlatformManager(PlatformEnum.META, metaAdsConfig);

Fetching available datasets

To fetch available datasets for a specific type:

const dataset: DatasetType = 'audience';
console.log(createAdManager.fetchAvailableDataSets(dataset));

Fetching grouping data

To fetch grouping data for a specific dataset:

const accessToken = 'YOUR_ACCESS_TOKEN';
createAdManager.fetchGroupingData(accessToken, dataset)
  .then(data => {
    console.log(data);
  })
  .catch(error => {
    console.error('Error fetching grouping data:', error);
  });

Replace 'YOUR_ACCESS_TOKEN' with a valid access token for the Meta Ads API.

Supported Platforms

Currently, the library supports:

• Meta Ads (Facebook Ads)

Data Types

• DatasetType: Represents the type of dataset (e.g., 'audience')
• MetaAdsPlatformConfig: Configuration type for Meta Ads platform

Enums

• PlatformEnum: Enum for supported ad platforms (e.g., PlatformEnum.META)

Error Handling

Make sure to implement proper error handling when using the library functions, especially for asynchronous operations like fetchGroupingData.

Contributing

[Add information about how to contribute to the project]

License

This library is available under the ISC License.