Skip to content
adscapi
← Platforms
Real Conversions API

Yahoo! Japan setup

Set Yahoo! Japan’s tokens once. Then every ads.conversions.track() call fans the event out to Yahoo! Japan server-side — no per-platform code.

1. Install adscapi

shell
npm install adscapi
# or run without installing:
npx adscapi platforms

2. Get Yahoo! Japan's tokens

Yahoo! Japan activates once all of these are set. Run npx adscapi platforms to see them, then get each value from Yahoo! Japan’s ads or events dashboard.

YAHOOJP_PIXEL_IDYAHOOJP_TOKEN

3. Set them for adscapi

Export the tokens in the environment that runs your server or the adscapi CLI.

shell
export YAHOOJP_PIXEL_ID="…"
export YAHOOJP_TOKEN="…"

4. Verify

check confirms the secrets are present; verify calls Yahoo! Japan’s API to confirm they are valid.

shell
npx adscapi check
npx adscapi verify --platform yahoojp

5. Track a conversion

One call, sent to Yahoo! Japan and every other configured platform. Pass raw email — adscapi hashes per platform. Consent is required.

ts
import { createAdscapi } from 'adscapi';

const ads = createAdscapi();

const results = await ads.conversions.track({
  name: 'purchase',
  value: 49,
  currency: 'USD',
  user: { email: 'buyer@example.com' },
  consent: { adUserData: true, adPersonalization: true },
});

See the exact request on the Yahoo! Japan payload preview.