この機能はエンタープライズのお客様にご利用いただけます。
新しいSingular Links APIを使用して、新しいSingular Linksを作成したり、既存のSingular Linksを表示することができます。
主なフロー
APIを使ってパートナーリンクを作成する
APIを使ってパートナーリンクを作成するには
1 |
以下を呼び出す。 Get Apps を呼び出して、シンギュラーリンクを作成したいアプリのapp_id とapp_site_id を取得します。 |
2 |
コール Get Configured Partners に電話して、シンギュラーリンクを作成したい広告ネットワークパートナーのpartner_id 。 ヒントフィルタリングされていないこのクエリは、組織が各app_site_idに対して設定したすべてのパートナーを返します。 前のステップで取得したapp_site_idを使用して、クエリをフィルタリングできます。 |
3 | を呼び出す。 Get Link Domains を呼び出して、リンクに使用できるsubdomains とdns_zones を取得します。 |
4 | オプションで Get All Partners を呼び出して、複数のOSで同じリンクを使用することをサポートしているかどうか、リエンゲージメントリンクをサポートしているかどうか、CTVをサポートしているかどうかなど、リンクを作成するパートナーに関する詳細情報を取得します。partner_id でクエリをフィルタリングできます。 |
5 |
コール Create Link 前のステップで取得したapp_id, app_site_id, partner_id, subdomain 、およびdns_zone を使用します。 注:パートナーが複数のOSで同じリンクの使用をサポートしている場合、同じSingular LinkにAndroid用とiOS用のリンク先を入力できます。そうでない場合は、OSごとに個別のリンクを作成する必要があります。 パートナーがリエンゲージメントおよび/またはCTVをサポートしている場合、Singular Linkでこれらのオプションをtrueに設定できます。 |
APIを使用してカスタムリンクを作成する
APIを使用してカスタムリンクを作成するには
1 |
を呼び出します。 Get Apps を呼び出して、シンギュラーリンクを作成したいアプリの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 | ||
ヘルパー・エンドポイント | |||
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 | |
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キーに進みます。
認証HTTPヘッダーにAPIキーを記述します(コード例を参照)。
制限
これらのAPIエンドポイントの取得リクエストのURLは8000文字までです。これより長いURLではエラーメッセージが表示されます。
リンク作成エンドポイント
POST | https://api.singular.net/api/v1/singular_links/links |
使用方法
このエンドポイントを使用して、パートナーネットワークまたはカスタムソース用の新しいSingularリンクを作成します。リンクを作成すると、そのネットワークまたはカスタムソースを使ったキャンペーンでトラッキングリンクとして使用できます。
詳しくは Creating Singular Linksをご覧ください 。
注意事項
- SingularプラットフォームでSingularリンクを表示する場合、APIで作成されたリンクはデフォルトでは表示されません。表示するにはShow API links オプションを切り替えてください。
- これは既存のリンクを表示するときに使用するエンドポイントURLと同じですが、ここではGETリクエストの代わりにPOSTリクエストを使用し、必要なパラメータが増えます。
サンプルクエリ(パートナーリンクの作成)
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 | シングラーリンクを後でシングラーレポートで識別するためにつける名前です。ほとんどの組織ではキャンペーン名またはそのバリエーションを使用します。tracking_link_nameはSingularレポートに「トラッカー名」として表示されます。 | 必須 | 必須 |
link_dns_zone | https://[SUBDOMAIN].[DNS_ZONE]/[PARAMETERS] DNSゾーンは "sng.link" です。 | 必須 | 必須 |
link_subdomain | サブドメイン]は組織によって選択されます。https://[SUBDOMAIN].[DNS_ZONE]/[PARAMETERS] 組織に設定されたサブドメインのリストについては、Get Link Domains までお問い合わせください。 | 必須 | 必須 |
destination_fallback_url | これは、ディープリンクが失敗した場合にユーザーを移動させたい移動先です。通常、ユーザーがアプリの広告をクリックした場合、ディープリンクによってアプリ内の特定の画面に移動するようにします。しかし、ユーザーがまだアプリをインストールしていない場合は、代わりにアプリストアにリダイレクトしてアプリをダウンロードしてもらいたい。 | 必須 | 必須 |
android_redirection |
Androidデバイスのリンク先を指定するパラメータを含むオブジェクト:
注意:android_redirectionまたはios_redirectionのどちらかを指定する必要があります。ネットワークパートナーが1つのSingular Linkで複数のOSを許可している場合のみ、両方を指定できます。 |
必須 |
必須 |
ios_redirection |
iOSデバイスのリンク先を指定するパラメータを含むオブジェクト:
注意:android_redirectionまたはios_redirectionのどちらかを指定する必要があります。ネットワークパートナーが1つのSingular Linkで複数のOSを許可している場合にのみ、両方を指定できます。 |
必須 |
必須 |
enable_reengagement |
このリンクをリエンゲージメントキャンペーンに属するものとしてマークするには、trueを設定します(リエンゲージメントに関するFAQを参照)。 |
オプション。 すべてのパートナーがこのオプションをサポートしているわけではありません。特定のパートナーが何をサポートしているかは、[すべてのパートナーを取得]クエリを使用してパートナー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 |
リエンゲージメントキャンペーンにおけるクリックスルーのアトリビューションウィンドウ。 これはenable_reengagementが trueに設定されている場合にのみ関連します。0-30日を指定できます。 |
オプション。パートナーリンクの場合、パートナーごとにデフォルト値が設定されていますが、別の値を指定することもできます。 |
オプション。カスタムリンクの場合、デフォルトは7日間です。 |
enable_ctv |
CTVキャンペーンをサポートするにはtrueを設定します。これは、ネットワークパートナーが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> 値がサポートされていない | 属性ウィンドウの1つにサポートされていない値が設定されています。 |
パートナーがリンクごとに複数のOSをサポートしていない | 1つのトラッキングリンクを複数のOSで使用することをサポートしていないネットワークパートナーに対して、Androidリダイレクト値とiOSリダイレクト値の両方を設定しようとしました。 |
パートナーXはトラッキングリンクを許可していません | FacebookやGoogleなどの自己帰属型ネットワーク(SAN)はトラッキングリンクをサポートしていません。 |
リンクエンドポイントを見る
GET | https://api.singular.net/api/v1/singular_links/links |
使用方法
既存のSingular Linksの詳細を見るにはこのエンドポイントを使います。
app_id, app_site_id, partner_id, source_name, tracking_link_id の1つ以上のフィールドでリクエストをフィルタリングできます。これらのIDを取得するには、Get Apps とGet Configured Partners エンドポイントを呼び出します。
注:これは、新しいリンクを作成するときに使用するのと同じエンドポイント(URL)ですが、POSTリクエストの代わりにGETリクエストを使用します。
サンプルクエリ
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 | [オプション]リンク・タイプを1つだけ表示したい場合は、"custom"、"partner"、または"mobile_web_to_app"を入力します。 |
partner_id | [オプション]特定のパートナー用に構成されたパートナーリンクのみを表示する場合は、その パートナーの単一内部 ID を入力します。 |
source_name |
[オプション] 特定のソース用に構成されたカスタムリンクのみを表示する場合は、そのソー スの単一内部 ID を入力します。 |
app_id | [オプション]特定のアプリ用に構成されたリンクのみを表示する場合は、アプリのSingular内部IDを入力します。 |
app_site_id | [オプション] 特定のアプリサイト用に構成されたリンクのみを表示する場合は、アプリサイトのSingular内部IDを入力します。 |
tracking_link_id | [オプション]特定のSingularリンクの詳細のみを表示したい場合は、リンクのIDを入力します。IDはトラッキングリンクURLで確認できます: 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 |
以下のパラメータを含むオブジェクト:
|
ios_redirection |
以下のパラメータを含むオブジェクト:
|
destination_fallback_url | これは、ディープリンクが失敗した場合にユーザーを移動させたい移動先です。通常、ユーザーがアプリの広告をクリックした場合、ディープリンクによってアプリ内の特定の画面に移動させたいでしょう。しかし、ユーザーがまだアプリをインストールしていない場合は、代わりにアプリストアにリダイレクトしてアプリをダウンロードさせたい。 |
オプション機能 | |
enable_reengagement | リンクがリエンゲージメント/リターゲティングキャンペーンに使用されるリンクとしてマークされている場合は真。 |
enabled_ctv | リンクがCTVキャンペーンでサポートされている場合、True。 |
アトリビューションウィンドウの設定 | |
click_deterministic_window | 決定論的手法(クリックに使用されたデバイス ID とアプリのインストールに使用されたデバイス ID を一致させるなど)でアトリビューションする場合の、クリックスルー キャンペーンにおけるこのリンクのアトリビューション ウィンドウ。 |
click_probabilistic_window | 確率的手法(デバイスの場所、オペレーティングシステムなど)によりアトリビューションされる場合の、クリックスルーキャンペーンにおけるこのリンクのアトリビューションウィンドウ |
view_deterministic_window | 決定論的手法(クリックに使用されたデバイス ID とアプリのインストールに使用されたデバイス ID のマッチングなど)によりアトリビューションされる場合の、ビュースルーキャンペーンにおけるこのリンクのアトリビューションウィンドウ |
view_probabilistic_window | 確率的手法(デバイスの場所、オペレーティングシステムなど)によりアトリビューションされる場合のビュースルーキャンペーンにおけるこのリンクのアトリビューションウィンドウ |
click_reengagement_window | クリックスルーリエンゲージメントキャンペーンにおけるこのリンクのアトリビューションウィンドウ。このパラメータは、このSingular Linkでリエンゲージメントが有効になっている場合にのみ含まれます。 |
アプリ取得エンドポイント
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(アプリ+OS+バンドル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 | Apps ページで設定されたアプリ名。 |
設定済みパートナーエンドポイントの取得
GET | https://api.singular.net/api/v1/singular_links/configured_partners |
使用方法
各アプリサイトに設定したパートナー(広告ネットワーク)のリストを取得します。特定のアプリサイトとパートナーにリクエストをフィルタリングできます。
注:リストには、Facebook、Google Ads、またはSingular Linksをサポートしていないその他の自己アトリビュートネットワーク(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 "でフィルタリングされたリクエストのサンプル出力です。 このアプリ・サイトには2つのパートナーが設定されています。
{
'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、またはSingular Linksをサポートしていないその他の自己帰属ネットワーク(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。パートナーがサポートしている場合、1つのSingularリンクを作成し、両方のOSのキャンペーンで使用することができます。 |
support_reengagement | パートナーがリエンゲージメントリンクをサポートしている場合、Trueになります。パートナーがサポートしている場合、リエンゲージメントリンクとしてマークされたSingular Linkを作成し、リターゲティングキャンペーンで使用できます。 |
support_ctv | パートナーがCTVをサポートしている場合は真。パートナーによってサポートされている場合、CTV対応のリンクを作成できます。 |
リンクドメインの取得エンドポイント
GET | https://api.singular.net/api/v1/singular_links/domains |
使用方法
シンギュラーリンクのドメインのリストを取得します。シンギュラートラッキングリンクは以下の構造を持ちます。[SUBDOMAIN]はお客様が選択し、DNSゾーンは"sng.link"です:
https://[SUBDOMAIN].sng.link/[PARAMETERS]
シンギュラーリンクを作成する際、リンクURLに使用するサブドメインとDNSゾーンを指定する必要があります。
ヒント リンクのドメインはSingularプラットフォームの「属性」>「リンクの管理」で作成します。Singularリンクを作成する前に、少なくとも1つのドメインを定義する必要があります。
サンプルクエリ
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 Linksドメインのリストを返します。
{
'available_domains': [
{
'subdomain': 'myorg',
'dns_zone': 'sng.link'
},
{
'subdomain': 'awesomeapp',
'dns_zone': 'sng.link'
}
]
}
出力パラメータ
パラメータ | 説明 |
---|---|
サブドメイン | あなたがサブドメインにつけた名前、例えばあなたの会社の名前。 dns_zoneと一緒に、Singular Linksで使われるドメインを作成します。 |
dns_zone | "sng.link" |