@corca-ai/ads

Installation

NPM

Install @corca-ai/ads with your package manager.

yarn add @corca-ai/ads

npm install @corca-ai/ads

pnpm add @corca-ai/ads

Usage

Initialize CorcaAds

Initialize the class CorcaAds with your storeId and customerId. You can find storeId in the account management page.

import { CorcaAds } from "@corca-ai/ads";

const corcaAds = new CorcaAds({ storeId: "...", customerId: "..." });

Set Customer ID

You can set customerId to track the user's behavior.

corcaAds.setCustomerId("...");

Log Collection

Page view

await corcaAds.onPageView({ productId: "1234" });

Add to cart

await corcaAds.onAddToCart({ productId: "1234", quantity: 1 });

Purchase

await corcaAds.onPurchase({
  orderId: "20231114010101",
  amount: 29900,
  items: [
    { productId: "1234", quantity: 1 },
  ],
});

Example

import { corcaAds } from "@corca-ai/ads";

const useCorcaAds = () => {
  const [corcaAds, setCorcaAds] = useState<CorcaAds>();
  const { me } = useFetchMe();

  useEffect(() => {
    const corcaAds = new CorcaAds({ storeId: "..." });
    setCorcaAds(corcaAds);
  }, []);

  useEffect(() => {
    if (corcaAds && me) {
      corcaAds.setCustomerId(me?.id);
    }
  }, [corcaAds, me]);

  return corcaAds;
};

export function ProductDetailPage(props: { params: { productId: string } }) {
  const corcaAds = useCorcaAds();

  useEffect(() => {
    if (corcaAds) {
      corcaAds.onPageView({ productId: props.params.productId });
    }
  }, [corcaAds]);

  return (
    <div>
      ...
    </div>
  );
}