创建链接端点

Avatar
Product Team
Updated

创建链接端点

查询参数

参数 描述 合作伙伴链接的备注 自定义链接的备注
app_id 您要创建链接的应用的 ID。要查看您的应用列表,请使用 Get Apps 端点。 必填 必填
link_type "partner" 或 "custom"(详细了解合作伙伴链接与自定义链接)。 必填 必填
partner_id 您要创建链接的合作伙伴网络的 ID。要查看为此特定应用配置的合作伙伴列表,请使用 Get Configured Partners 端点。 必填
source_name 指定 "crosspromo"、"email"、"sms"、"social"、"affiliates" 或 "influencers"。
必填
tracking_link_name 您为 Singular 链接指定的名称,以便稍后在 Singular 报告中识别它。大多数组织使用活动名称或活动名称的变体。tracking_link_name 将在您的 Singular 报告中显示为 "Tracker Name"。 必填 必填
link_dns_zone Singular 追踪链接具有以下结构:https://[SUBDOMAIN].[DNS_ZONE]/[PARAMETERS] DNS 区域为 "sng.link"。 必填 必填
link_subdomain Singular 追踪链接具有以下结构,其中 [SUBDOMAIN] 由组织选择:https://[SUBDOMAIN].[DNS_ZONE]/[PARAMETERS] 要获取为您的组织配置的子域列表,请调用 Get Link Domains。 必填 必填
destination_fallback_url 这是您希望在深度链接失败时引导用户前往的目的地。通常,如果用户点击您应用的广告,您希望深度链接将他们带入应用内的特定屏幕。但如果用户尚未安装该应用,您希望改为将用户再营销到应用商店以下载您的应用。 必填 必填
android_redirection

一个对象,包含指定链接在 Android 设备上应跳转到何处的参数:

  • app_site_id
  • destination_url
  • destination_deeplink_url (可选,默认为 null)
  • destination_deferred_deeplink_url (可选,默认为 null)

注意: 必须指定 android_redirection 或 ios_redirection 之一。只有当网络合作伙伴允许在一个 Singular 链接中支持多个操作系统时,您才能同时指定两者。

必填 必填
ios_redirection

一个对象,包含指定链接在 iOS 设备上应跳转到何处的参数:

  • app_site_id
  • destination_url
  • destination_deeplink_url (可选,默认为 null)
  • destination_deferred_deeplink_url (可选,默认为 null)

注意: 必须指定 android_redirection 或 ios_redirection 之一。只有当网络合作伙伴允许在一个 Singular 链接中支持多个操作系统时,您才能同时指定两者。

必填 必填
enable_reengagement 设置为 true 以将此链接标记为属于再互动活动 (参见再互动常见问题)。 可选。 请注意,并非所有合作伙伴都支持此选项。您可以使用 Get All Partners 查询并指定合作伙伴 ID 来查看特定合作伙伴支持的内容。 可选。 再互动支持点击,需要配置深度链接再营销。
click_deterministic_window

使用确定性归因的点击穿透的归因窗口。您可以指定 0-30 天。

可选。对于合作伙伴链接 ,默认值在Partner Configuration页面中为每个应用站点和合作伙伴单独设置。 可选。对于自定义链接 ,默认值为 7 天。
click_probabilistic_window

使用概率归因的点击穿透的归因窗口。您可以指定 0-24 小时。

可选。对于合作伙伴链接 ,默认值在Partner Configuration页面中为每个应用站点和合作伙伴单独设置。 可选。对于自定义链接 ,默认值为 24 小时。
View_deterministic_window

使用确定性归因的展示穿透(展示)的归因窗口。您可以指定 0-24 小时。 可选。对于合作伙伴链接 ,默认值在Partner Configuration页面中为每个应用站点和合作伙伴单独设置。 可选。对于自定义链接 ,默认值为 24 小时。
view_probabilistic_window

使用概率归因的展示穿透(展示)的归因窗口。默认值为 8 小时。您可以指定 0-24 小时。 可选 可选
click_reengagement_window

再互动活动中点击穿透的归因窗口。仅当 enable_reengagement 设置为 true 时才相关。您可以指定 0-30 天。 可选。对于合作伙伴链接 ,每个合作伙伴都设置了默认值,但您可以指定其他值。 可选。对于自定义链接 ,默认值为 7 天。
enable_ctv

设置为 true 以支持 CTV 活动。仅当网络合作伙伴支持 CTV 活动时才相关。根据合作伙伴的不同,enable_ctv 的值可能默认为 true。 可选 可选
og_tags 允许链接显示社交着陆页预览。
值示例
{
"title": "my Title",
"description": "my Description",
"image_url": "https://www.wikipedia.org/portal/wikipedia.org/assets/img/Wikipedia-logo-v2@2x.png"
}

所有字段必须有值。 		不可用 可选
disable_short_link_parameters_overrides 当设置为 true 时,基础链接中已设置的再营销和深度链接参数不能通过在点击时将其附加到短链接来覆盖。基础链接中未设置的参数仍可以作为新值附加。当为 false(默认)时,附加的参数可以覆盖已保存的链接设置。请参阅禁用短链接的参数覆盖了解完整详情。 不可用 可选。 默认值:false。仅在启用链接缩短时适用。

输出参数

如果 Singular 链接创建成功,响应将包含以下参数:

参数 描述
tracking_link_id 追踪链接的内部 ID。它也包含在追踪链接 URL 中。
tracking_link_name 您为追踪链接指定的名称。
click_tracking_link 用于点击穿透活动的追踪链接 URL。该 URL 包含宏,当链接被提供时,合作伙伴网络将用实际值替换这些宏。
impression_tracking_link 用于展示穿透活动的追踪链接 URL (如果支持)。
short_link

链接的缩短 URL 版本 (仅适用于自定义链接)。

注意:此链接是使用我们的短链接服务创建的,而不是我们的推荐追踪服务。这些短链接不会过期。

在上面的示例中,短链接是 "https://prod_test.sng.link/D75p1/mbm7/961w",其中 "961w" 是短链接 ID。

disable_short_link_parameters_overrides 创建链接上此设置的值。true 表示基础链接中已设置的再营销和深度链接参数已锁定,无法覆盖;false(默认)表示可以通过将其附加到短链接来覆盖它们。
extra_info 即使链接创建成功,Singular 可能也会向您提供警告和说明。这些信息收集在 extra_info 下。