企业客户可使用此功能。

使用新的 Singular Links API 创建新的 Singular Links 并查看现有的 Singular Links。

主要流程

使用 API 创建合作伙伴链接

Screen_Shot_2023-01-31_at_13.23.43.png

使用 API 创建合作伙伴链接：

1	调用 Get Apps 检索您要为其创建奇异链接的应用程序的app_id 和app_site_id 。
2	调用 Get Configured Partners 以获取要为其制作 Singular Link 的广告网络合作伙伴的partner_id 。提示：未经过滤，此查询会返回贵组织为每个应用程序站点 ID 配置的所有合作伙伴。您可以使用上一步检索的应用程序站点 ID 过滤查询。
3	调用 Get Link Domains 检索可用于链接的subdomains 和dns_zones 。
4	可选择调用 Get All Partners 以获取有关创建链接的合作伙伴的更多信息，如是否支持在多个操作系统上使用同一链接、是否支持重新参与链接以及是否支持 CTV。您可以通过partner_id 过滤查询。
5	调用 Create Link 使用app_id, app_site_id, partner_id, subdomain 和dns_zone 。注意：如果合作伙伴支持在多个操作系统中使用相同的链接，则可以在同一个单一链接中输入 Android 和 iOS 的链接目的地。否则，你需要为每个操作系统创建一个单独的链接。如果合作伙伴支持重新参与和/或 CTV，则可以将这些选项设置为 "真"。

使用 API 创建自定义链接

1	调用 Get Apps 检索要创建 Singular Link 的应用程序的app_id 和app_site_id 。
2	调用 Get Link Domains 以获取可用于链接的subdomains 和dns_zones 。
3	调用 Create Link app_id, app_site_id, subdomain 和dns_zone 。注意：响应还包括链接的缩写版本。

奇异链接 API 概述

端点

以下是可用的 API 端点：

主端点
Create Link	POST	https://api.singular.net/api/v1/singular_links/links
View Links	GET	https://api.singular.net/api/v1/singular_links/links
辅助端点
Get Apps	GET	https://api.singular.net/api/v1/singular_links/apps	用于在调用Create Link 或View Links 之前获取必要信息。
Get Configured Partners	GET	https://api.singular.net/api/v1/singular_links/configured_partners	用于在调用Create Link 或View Links 之前获取必要信息。
Get Link Domains	GET	https://api.singular.net/api/v1/singular_links/domains	用于在调用Create Link 之前获取必要信息。
Get All Partners	GET	https://api.singular.net/api/v1/singular_links/all_partners	用于了解每个合作伙伴支持哪些选项。

身份验证

所有 Singular API 调用都需要您的 Singular API 密钥。要获取密钥，请登录 Singular 平台，进入 "开发工具">"报告 API 密钥"。

将 API 密钥放入授权 HTTP 标头（参见代码示例）。

限制

这些 API 端点的获取请求 URL 最长可达 8000 个字符。更长的 URL 会导致错误信息。

创建链接端点

POST

https://api.singular.net/api/v1/singular_links/links

使用方法

使用此端点可为您的一个合作伙伴网络或自定义来源创建一个新的奇异链接。创建链接后，您就可以将其用作与该网络或自定义来源相关的营销活动中的跟踪链接。

更多信息，请参阅 Creating Singular Links 和 奇异链接常见问题解答的 其余部分 。

注意：

在 Singular 平台查看 Singular 链接时，默认情况下不显示 API 创建的链接。要显示它们，请切换Show API links 选项。
这与查看现有链接时使用的端点 URL 相同，但此处使用的是 POST 请求而非 GET 请求，而且需要的参数也更多。

示例查询（创建合作伙伴链接）

import requests
  import json
  
  url = "https://api.singular.net/api/v1/singular_links/links"
  
  api_key = <...> # Retrieve API Key from Singular platform at Developer Tools > Reporting API Keys
  
  params = json.dumps({
    "app_id": <APP_ID>, # From Get Apps call
    "partner_id": <PARTNER_ID>, # From Get Configured Partners call
    "link_type": "partner",
    "tracking_link_name": "my tracking link",
    "link_subdomain": "<SUBDOMAIN>", # From Get Link Domains call
    "link_dns_zone": "sng.link",
    "destination_fallback_url": "https://www.example.com/",
    "android_redirection": {
      "app_site_id": <APP_SITE_ID>, # From Get Apps call
      "destination_url": "https://play.google.com/store/apps/details?id=com.my.app",
      "destination_deeplink_url": "https://www.example.com/",
      "destination_deferred_deeplink_url": "https://www.example.com/"
    }
  })
  
  response = requests.post(url, data=params, headers={'Authorization':api_key})

curl --location --request POST 'https://api.singular.net/api/v1/singular_links/links' \
  --header 'authorization: <API KEY>' \
  --header 'Content-Type: application/json' \
  --data-raw '{
      "app_id": ,
      "partner_id": ,
      "link_type": "partner",
      "tracking_link_name": "",
      "link_subdomain": "prod_test",
      "link_dns_zone": "sng.link",
      "destination_fallback_url": "https://google.co.il",
      "ios_redirection": {
          "app_site_id": ,
          "destination_url": "",
          "destination_deeplink_url": "",
          "destination_deferred_deeplink_url": ""
      }
  }'

示例查询（创建自定义链接）

import requests
  import json
  
  url = "https://api.singular.net/api/v1/singular_links/links"
  
  payload = json.dumps({
    "app_id": <...>,
    "partner_id": <...>,
    "link_type": "custom",
    "source_name": "social",
    "enable_reengagement": "false",
    "tracking_link_name": "test-link-custom",
    "link_subdomain": "mydomain",
    "link_dns_zone": "sng.link",
    "destination_fallback_url": "https://fallback.com",
    "click_deterministic_window": 8,
    "click_probabilistic_window": 9,
    "enable_ctv": "false",
    "link_parameter": {
      "this": "is",
      "a": "test"
    },
    "android_redirection": {
      "app_site_id": 609747,
      "destination_url": "https://play.google.com/store/apps/details?id=com.my.app",
      "destination_deeplink_url": "https://example.com",
      "destination_deferred_deeplink_url": "https://example.com"
    }
  })
  headers = {
    'Authorization': '<...>',
    'Content-Type': 'application/json'
  }
  
  response = requests.request("POST", url, headers=headers, data=payload)
  
  print(response.text)

curl --location --request POST 'https://api.singular.net/api/v1/singular_links/links' \
  --header 'Authorization: <...>' \ --header 'Content-Type: application/json' \ --data-raw '{ "app_id": <...>, "partner_id": <...>, "link_type": "custom", "source_name":"social", "enable_reengagement":"false", "tracking_link_name": "test-link-custom", "link_subdomain": "mydomain", "link_dns_zone": "sng.link", "destination_fallback_url": "https://fallback.com", "click_deterministic_window":8, "click_probabilistic_window":9, "enable_ctv":"false", "link_parameter":{ "this":"is", "a":"test" }, "android_redirection": { "app_site_id": 609747, "destination_url": "https://play.google.com/store/apps/details?id=com.my.app", "destination_deeplink_url":"https://example.com", "destination_deferred_deeplink_url": "https://example.com" } }'

查询参数

参数	说明	合作伙伴链接注意事项	自定义链接备注
app_id	您要创建链接的应用程序的 ID。要查看应用程序列表，请使用Get Apps 端点。	必填	必填
link_type	"partner" 或 "custom" （了解有关合作伙伴链接与自定义链接的更多信息）。	必填	必填
partner_id	您要创建链接的合作伙伴网络的 ID。要查看为该特定应用程序配置的合作伙伴列表，请使用Get Configured Partners 端点。	必填
source_name	指定"crosspromo", "email", "sms", "social", "affiliates", or "influencers".		必填
tracking_link_name	您给 Singular Link 起的名称，以便以后在 Singular 报告中识别。大多数组织使用活动名称或活动名称的变体。在 Singular 报告中，tracking_link_name 将显示为 "跟踪器名称"。	必填	必填
link_dns_zone	Singular 跟踪链接的结构如下：https://[SUBDOMAIN].[DNS_ZONE]/[PARAMETERS] DNS 区域为 "sng.link"。	必填	必须填写
link_subdomain	单个跟踪链接的结构如下，其中 [SUBDOMAIN] 由组织选择：https://[SUBDOMAIN].[DNS_ZONE]/[PARAMETERS] 有关为组织配置的子域列表，请致电Get Link Domains 。	必须	必填
destination_fallback_url	这是在深层链接失败时要将用户带到的目的地。通常情况下，如果用户点击了您应用程序的广告，您希望深层链接将他们发送到应用程序内的特定屏幕。但是，如果用户尚未安装应用程序，您希望将用户重定向到应用程序商店下载您的应用程序。	需要	必填
android_redirection	对象，包含指定链接在 Android 设备上应指向何处的参数： app_site_id destination_url destination_deeplink_url (可选，默认为空 destination_deferred_deeplink_url (可选，默认为空注意：必须指定 android_redirection 或 ios_redirection。只有当网络合作伙伴允许在一个奇异链接中使用多个操作系统时，才能同时指定这两种操作系统。	必须	必填
ios_redirection	包含参数的对象，用于指定链接在 iOS 设备上的指向： app_site_id destination_url destination_deeplink_url (可选，默认为空 destination_deferred_deeplink_url (可选，默认为空注意：必须指定 android_redirection 或 ios_redirection。只有当网络合作伙伴允许在一个单一链接中使用多个操作系统时，才能同时指定这两种操作系统。	必须	必须
enable_reengagement	设置为 true 可将此链接标记为属于再参与营销活动（请参阅再参与常见问题	可选。请注意，并非所有合作伙伴都支持此选项。您可以使用 "获取所有合作伙伴"查询并指定合作伙伴 ID，查看特定合作伙伴支持哪些选项。	可选。点击支持再参与，需要配置深链接重定向。
click_deterministic_window	使用确定性归因的点击归因窗口。可以指定 0-30 天。	可选。对于合作伙伴链接，默认值是在 "合作伙伴配置"页面中为每个应用网站和合作伙伴设置的。	可选。对于自定义链接，默认为 7 天。
click_probabilistic_window	使用概率归因的点击归因窗口。可指定 0-24 小时。	可选。对于合作伙伴链接，默认值是在 "合作伙伴配置"页面中为每个应用网站和合作伙伴设置的。	可选。对于自定义链接，默认值为 24 小时。
view_deterministic_window	使用确定性归因的浏览量（印象）归因窗口。可指定 0-24 小时。	可选。对于合作伙伴链接，默认值是在 "合作伙伴配置"页面中为每个应用网站和合作伙伴设置的。	可选。对于自定义链接，默认值为 24 小时。
view_probabilistic_window	使用概率归因的浏览量（印象）归因窗口。默认为 8 小时。可指定 0-24 小时。	可选	可选
click_reengagement_window	再参与营销活动中点击量的归因窗口，只有在启用再参与功能设置为true 时才相关。可以指定 0-30 天。	可选。对于合作伙伴链接，每个合作伙伴都有一个默认值，但您也可以指定不同的值。	可选。对于自定义链接，默认值为 7 天。
enable_ctv	设置为 true 以支持 CTV 活动。这只有在网络合作伙伴支持 CTV 活动时才有意义。根据合作伙伴的不同，enable_ctv 的默认值可能为 true。	可选	可选

输出示例

{
    "tracking_link_id": "<...>",
    "tracking_link_name": "jr us and ca spring 2022",
    "click_tracking_link": "https://mysubdomain.sng.link/<...>/<...>?idfa=$IDA&and5=$UDID&aifa=$GPID&s=$SITE_APP_ID&psid=$SITE_APP_ID&psn=$SITE_NAME&cl=impId&pcrn=$CREATIVE_NAME&pcrid=$CREATIVE_ID&pcid=$CAMPAIGN_ID&pc=$CAMPAIGN_ID&pcn=$CAMPAIGN_NAME&pscid=$ADGROUP_ID&cr=$CREATIVE_ID&andi1=$O1&pscn=$ADGROUP_NAME&impid=$IMP_ID&pshid=$BLINDED_SITE_ID",
    "impression_tracking_link": "https://i.sng.link/<...>/<...>?idfa=$IDA&and5=$UDID&aifa=$GPID&s=$SITE_APP_ID&psid=$SITE_APP_ID&psn=$SITE_NAME&cl=impId&pcrn=$CREATIVE_NAME&pcrid=$CREATIVE_ID&pcid=$CAMPAIGN_ID&pc=$CAMPAIGN_ID&pcn=$CAMPAIGN_NAME&pscid=$ADGROUP_ID&cr=$CREATIVE_ID&andi1=$O1&pscn=$ADGROUP_NAME&impid=$IMP_ID&pshid=$BLINDED_SITE_ID",
  "short_link": "https://prod_test.sng.link/D75p1/mbm7/961w"
    "extra_info": [
      "partner's default value was used, instead of given argument enable_ctv",
      "partner's default value was used, instead of given argument enable_reengagement"
    ]
  }

输出参数

如果奇异链接创建成功，响应将包含以下参数：

参数	说明
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。
extra_info	即使链接创建成功，Singular 也可能会向您提出警告和说明。这些信息都收集在 extra_info 下。

错误信息

如果由于配置问题没有成功创建链接，你会收到一条说明问题的信息。请修复问题并再次调用创建链接。

错误信息	备注
app_site_id 不存在
合作伙伴 x 未为应用程序 y 配置
link_domain 未定义
<attribution_window> 不支持的值	您为其中一个归属窗口设置了不支持的值。
合作伙伴不支持每个链接使用多个操作系统	您尝试为网络合作伙伴同时设置 Android 重定向值和 iOS 重定向值，但该合作伙伴不支持将单个跟踪链接用于多个操作系统。
合作伙伴 X 不允许跟踪链接	Facebook 和 Google 等自归属网络 (SAN) 不支持跟踪链接，因此 Singular 不允许您为这些合作伙伴创建 Singular 链接。

查看链接端点

GET

https://api.singular.net/api/v1/singular_links/links

使用方法

使用该端点可查看现有 Singular 链接的详细信息。

你可以通过以下一个或多个字段过滤请求：app_id、app_site_id、partner_id、source_name 和 tracking_link_id。要获取这些 ID，请调用Get Apps 和Get Configured Partners 端点。

注意：这与创建新链接时使用的端点（URL）相同，但使用的是 GET 请求而不是 POST 请求。

查询示例

import requests
  
  url = "https://api.singular.net/api/v1/singular_links/links"
  api_key = <...> # Retrieve API Key from Singular platform at Developer Tools > Reporting API Keys
          
  # All the parameters are optional. They are used to filter the list of links
  params = {
      "link_type": "partner",
      "partner_id": "<...>",
      "app_id": "<...>",
      "app_site_id": "<...>",
      "tracking_link_id": "abcde"
  }
  
  response = requests.get(url=url, params=params, headers={'Authorization':api_key})

curl --location --request GET 'https://api.singular.net/api/v1/singular_links/links' \
  --header 'authorization: <API KEY>'

查询参数

参数	说明
link_type	[可选]如果只想查看一种链接类型，请输入 "custom"、"partner"或 "mobile_web_to_app"。
partner_id	[可选]如果只想查看为特定合作伙伴配置的合作伙伴链接，请输入该合作伙伴的奇异内部 ID。
source_name	[可选] 如果只想查看为特定来源配置的自定义链接。
app_id	[可选]如果只想查看为特定应用程序配置的链接，请输入该应用程序的奇异内部 ID。
app_site_id	[可选] 如果只想查看为特定应用程序站点配置的链接，请输入应用程序站点的奇异内部 ID。
tracking_link_id	[可选]如果只想查看某个特定 Singular 链接的详细信息，请输入该链接的 ID。您可以在跟踪链接 URL 中找到 ID： https://myapp.sng.link/sdfsdf/abcde?...

输出示例

输出包含一个数组，其中包含与您的筛选参数相匹配的所有奇异链接（如果您没有输入任何筛选参数，则会显示您现有的所有奇异链接）。

[
  {
    'tracking_link_id': '<...>',
    'tracking_link_name': 'My App Android Summer 22',
    'click_tracking_link': 'https://myapp.sng.link/<...>/<...>?idfa={IDFA}&aifa={IDFA}&did={DID}&ip={IP}&pcrn={AD_NAME}&pcid={CAMPAIGN_ID}&pcn={CAMPAIGN_NAME}&pcrid={AD_ID}&pshid={APP_ID}',
    'impression_tracking_link':'https://myapp.sng.link/<...>/<...>?idfa={IDFA}&aifa={IDFA}&did={DID}&ip={IP}&pcrn={AD_NAME}&pcid={CAMPAIGN_ID}&pcn={CAMPAIGN_NAME}&pcrid={AD_ID}&pshid={APP_ID}',
    'created_utc': 'Tue, 23 Aug 2022 12:22:58 GMT',
    'modified_utc': 'Thu, 24 Nov 2022 11:13:41 GMT',
    'link_type': 'partner',
    'partner_id': <...>,
    'app_id': <...>,,
    'android_redirection': {
      'app_site_id': <...>,
      'destination_url': 'https://play.google.com/store/apps/details?id=...',
      'destination_deeplink_url': None,
      'destination_deferred_deeplink': None
    },
    'destination_fallback_url': 'https://www.mywebsite.com',
    'click_deterministic_window': '7 Days',
    'view_deterministic_window': '24 Hours',
    'enable_reengagement': False,
    'enabled_ctv': False,
  },
  ...
]

输出参数

每个链接包含以下参数的数组：

参数	说明
常规参数
tracking_link_id	跟踪链接的唯一标识符。
tracking_link_name	链接创建时的名称。
click_tracking_link	跟踪链接的点击 URL。
impression_tracking_link	用于浏览的跟踪链接 URL。
created_utc	创建链接时的 UTC 时间戳。
modified_utc	链接最后修改的 UTC 时间戳。
link_type	"partner" 或 "custom"
partner_id	合作伙伴的唯一单数内部 ID。
app_id	应用程序的内部奇异 ID。
链接目的地
android_redirection	包含以下参数的对象： app_site_id destination_url destination_deeplink_url (可选，默认为空） destination_deferred_deeplink_url (链接目的地（可选，默认为空）
ios_redirection	包含以下参数的对象： app_site_id destination_url destination_deeplink_url (可选，默认为空） destination_deferred_deeplink_url (可选，默认为空）
destination_fallback_url	这是在深层链接失败时要将用户带到的目的地。通常情况下，如果用户点击了您应用程序的广告，您希望深层链接将其发送到应用程序内的特定屏幕。但是，如果用户尚未安装应用，您希望将用户重定向到应用商店下载您的应用。
可选功能
enable_reengagement	如果链接被标记为用于再参与/重定向活动的链接，则为 True。
enabled_ctv	如果该链接支持 CTV 营销活动，则为 True。
归因窗口设置
click_deterministic_window	通过确定性方法（例如，将用于点击的设备 ID 与用于安装应用程序的设备 ID 进行匹配）进行归因时，此链接在点击式营销活动中的归因窗口
click_probabilistic_window	通过概率方法（如设备位置、操作系统等）进行归因时，该链接在点击式营销活动中的归因窗口
view_deterministic_window	通过确定性方法（如将用于点击的设备 ID 与用于安装应用程序的设备 ID 进行匹配）进行归因时，该链接在直通式营销活动中的归因窗口
view_probabilistic_window	通过概率方法（如设备位置、操作系统等）归因时，直通式营销活动中该链接的归因窗口
click_reengagement_window	点击再参与营销活动中该链接的归因窗口。只有在此奇异链接启用了再参与时，才会包含此参数。

获取应用程序端点

GET

https://api.singular.net/api/v1/singular_links/apps

使用方法

使用此端点可获得在 Singular 中配置的所有应用程序网站的列表（请参阅应用程序和应用程序网站之间有什么区别？

查询示例

import requests

url = "https://api.singular.net/api/v1/singular_links/apps"
api_key = <...> # Retrieve API Key from Singular platform at Developer Tools > Reporting API Keys

response = requests.get(url=url, headers={'Authorization': api_key})

curl --location --request GET 'https://api.singular.net/api/v1/singular_links/apps?api_key=<API KEY>'

输出示例

{
  'available_apps': [
    {
      'app_site_id': <...>,
      'app_platform': 'ios',
      'app_store_url': 'https://itunes.apple.com/us/app/…',
      'site_public_id': '<...>',
      'app_id': <...>,
      'app': 'My App'
    },
    {
      'app_site_id': <...>,
      'app_platform': 'android',
      'app_store_url': 'https://play.google.com/store/apps/details?id=...',
      'site_public_id': 'com.rovio.baba',
      'app_id': <...>,
      'app': 'My App'
    }
  ]
}

输出参数

响应是一个应用程序站点数组，每个应用程序站点的参数如下：

参数	说明
app_site_id	应用程序站点的 Singular 内部 ID（应用程序 + 操作系统 + 捆绑 ID）（请参阅 "应用程序和应用程序站点之间有什么区别？
app_platform	为应用程序网站定义的平台，如 iOS。
app_store_url	应用程序在 Google Play 或 Apple App Store 中的 URL。
site_public_id	这是应用程序在 Apple App Store 或 Google Play 中的 ID（请参阅 "应用程序和应用程序网站有何区别？对于网站，这是网站 URL。
app_bundle_id	应用程序的内部标识符，例如 "com.myapp"。
app_id	应用程序在 Singular 中的内部 ID。
app	应用程序页面中配置的应用程序名称。

获取配置的合作伙伴端点

GET	https://api.singular.net/api/v1/singular_links/configured_partners

使用方法

读取为每个应用程序网站配置的合作伙伴（广告网络）列表。您可以将请求过滤为特定的应用程序站点和合作伙伴。

注意：该列表不包括 Facebook、Google Ads 或其他不支持奇异链接的自归属网络 (SAN) 等合作伙伴。

查询示例

import requests        
        
url = "https://api.singular.net/api/v1/singular_links/configured_partners"
api_key = <...> # Retrieve API Key from Singular platform at Developer Tools > Reporting API Keys
        
params = {
  # The app sites for which you want to see which partners are configured
  "app_site_id": "<APP_SITE_ID1>,<APP_SITE_ID2>",

  # Optional filtering parameter
  "partner_id": "<PARTNER_ID1>,<PARTNER_ID2>" 
}

response = requests.get(url=url, params=params, headers={'Authorization': api_key})

curl --location --request GET 'https://api.singular.net/api/v1/singular_links/configured_partners?api_key=<api_key>&app_site_id=<app_site_id>'

查询参数

参数	说明
app_site_id	[可选]应用程序站点 ID 或用逗号分隔的应用程序站点 ID 列表，用于筛选列表。
partner_id	[可选]合作伙伴 ID 或以逗号分隔的合作伙伴 ID 列表，用于筛选列表。

输出示例

以下是通过 app_site_id = "22334" 过滤的请求输出示例。该应用程序站点配置了两个合作伙伴。

{
  'available_partners': [
    {
      'app_site_id': <...>,
      'app_id': <...>,
      'singular_partner_display_name':'AdWords',
      'singular_partner_id':<...>
    },
    {
      'app_site_id': <...>,
      'app_id': <...>,
      'singular_partner_display_name':'SplitMetrics',
      'singular_partner_id':<...>,

    }
  ] 
}

输出参数

应用程序站点数组，每个应用程序站点的参数如下：：

参数	说明
app_site_id	应用程序站点的 Singular 内部 ID。
app_id	应用程序的 Singular 内部 ID。
singular_partner_display_name	合作伙伴在 Singular 中的名称，如 "IronSource"。
singular_partner_id	合作伙伴在 Singular 中的内部 ID。

获取所有合作伙伴端点

GET

https://api.singular.net/api/v1/singular_links/all_partners

使用方法

检索为贵组织配置的合作伙伴的详细信息。

您可以通过一个合作伙伴 ID 或多个合作伙伴 ID 过滤请求，以便只获取特定合作伙伴的详细信息。

注意：该列表不包括 Facebook、Google Ads 或其他不支持奇异链接的自归属网络 (SAN) 等合作伙伴。

查询示例

import requests        

url = "https://api.singular.net/api/v1/singular_links/all_partners"
api_key = <...> # Retrieve API Key from Singular platform at Developer Tools > Reporting API Keys

params = {
  #Optional: filter to see specific partner(s)
  "partner_id": "<PARTNER_ID1>,<PARTNER_ID2>" 
}

response = requests.get(url=url, params=params, headers={'Authorization':api_key})

curl --location --request GET 'https://api.singular.net/api/v1/singular_links/all_partners' \
--header 'authorization: <API KEY>'

查询参数

参数	说明
singular_partner_id	[以逗号分隔的要显示详细信息的合作伙伴 ID 列表。

输出示例

{
  'partners': [
    {
      'singular_partner_id': <...>,
      'singular_partner_display_name': 'One Network',
      'support_multiple_os': True,
      'support_reengagement': True,
      'support_ctv': False,
    },
    {
      'singular_partner_id': <...>,
      'singular_partner_display_name': 'Other Network',
      'support_multiple_os': False,
      'support_reengagement': True,
      'support_ctv': True,
    },

    ...
         
  ]
}

输出参数

合作伙伴数组，每个合作伙伴包含以下参数：

参数	参数
singular_partner_id	合作伙伴的 Singular 内部 ID。
singular_partner_display_name	合作伙伴在 Singular 中的名称，例如 "IronSource"。
support_multiple_os	如果合作伙伴支持在同一跟踪链接中定义 iOS 目的地和 Android 目的地，则为 True。如果合作伙伴支持，您就可以创建一个单一链接，用于两个操作系统的营销活动。
support_reengagement	如果合作伙伴支持再参与链接，则为 True。如果合作伙伴支持，您就可以创建一个标记为再参与链接的单一链接，并将其用于重定向营销活动。
support_ctv	如果合作伙伴支持 CTV，则为 True。如果合作伙伴支持，您就可以创建支持 CTV 的链接。

获取链接域终端

GET

https://api.singular.net/api/v1/singular_links/domains

使用方法

读取奇异链接域列表。奇异跟踪链接具有以下结构，其中 [SUBDOMAIN] 由您选择，DNS 区域为 "sng.link"：

https://[SUBDOMAIN].sng.link/[PARAMETERS]

创建奇异链接时，必须在链接 URL 中指定要使用的子域和 DNS 区域。

提示： 链接域名在 Singular 平台的 "属性">"管理链接"下创建。在创建任何 Singular 链接之前，必须至少定义一个域。

查询示例

import requests        

url = "https://api.singular.net/api/v1/singular_links/domains"
api_key = <...> # Retrieve API Key from Singular platform at Developer Tools > Reporting API Keys

response = requests.get(url=url, headers={'Authorization': api_key})

curl --location --request GET 'https://api.singular.net/api/v1/singular_links/domains?api_key=<api_key>'

输出示例

此请求将返回为贵组织创建的 Singular 链接域列表。

{
  'available_domains': [
    {
      'subdomain': 'myorg',
      'dns_zone': 'sng.link'
    }, 
    {
      'subdomain': 'awesomeapp',
      'dns_zone': 'sng.link'
      }
  ]
}

输出参数

参数	说明
子域	您赋予子域的名称，例如公司名称。它与 dns_zone 一起创建了将在 Singular Links 中使用的域。
dns_zone	"sng.link"

Singular 跟踪链接 API

主要流程

使用 API 创建合作伙伴链接

使用 API 创建自定义链接

奇异链接 API 概述

端点

身份验证

限制

创建链接端点

使用方法

示例查询（创建合作伙伴链接）

示例查询（创建自定义链接）

查询参数

输出示例

输出参数

错误信息

查看链接端点

使用方法

查询示例

查询参数

输出示例

输出参数

获取应用程序端点

使用方法

查询示例

输出示例

输出参数

获取配置的合作伙伴端点

使用方法

查询示例

查询参数

输出示例

输出参数

获取所有合作伙伴端点

使用方法

查询示例

查询参数

输出示例

输出参数

获取链接域终端

使用方法

查询示例

输出示例

输出参数