入门

安装

bun add @capgo/capacitor-install-referrer
bunx cap sync

导入

import { InstallReferrer } from '@capgo/capacitor-install-referrer';

阅读属性详情

const result = await InstallReferrer.getReferrer();

if (result.platform === 'android') {
  console.log('Install referrer:', result.referrer);
  console.log('Click timestamp:', result.clickTimestampSeconds);
  console.log('Install timestamp:', result.installBeginTimestampSeconds);
}

if (result.platform === 'ios') {
  console.log('AdServices token:', result.attributionToken);
}

在 iOS 上获取 Apple 属性

如果您希望本地 code 调用 Apple 的属性端点，请传递 fetchAppleAttribution.

const result = await InstallReferrer.getReferrer({
  fetchAppleAttribution: true,
  appleAttributionRetryCount: 3,
  appleAttributionRetryDelayMs: 5000,
});

// result.appleAttribution is the parsed Apple attribution response.
// See the iOS attribution page for the Apple-provided payload fields.
console.log(result.appleAttribution);

苹果可以返回 404 当有有效令牌时， attribution 数据仍在准备中。 重试选项控制原生插件在拒绝之前多久重试。 请参阅 iOS 属性 获取平台详细信息。

兼容性别名

GetReferrer() 可用于从 cap-play-install-referrer.

const result = await InstallReferrer.GetReferrer();

New code should use getReferrer().