リンク作成エンドポイント

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 のいずれかを指定する必要があります。両方を指定できるのは、ネットワークパートナーが 1 つの Singular リンクで複数の OS をサポートしている場合のみです。

必須 必須
ios_redirection

iOS デバイスでリンクの遷移先を指定するパラメータを含むオブジェクト:

  • app_site_id
  • destination_url
  • destination_deeplink_url (オプション、デフォルトは null)
  • destination_deferred_deeplink_url (オプション、デフォルトは null)

注: android_redirection または ios_redirection のいずれかを指定する必要があります。両方を指定できるのは、ネットワークパートナーが 1 つの Singular リンクで複数の OS をサポートしている場合のみです。

必須 必須
enable_reengagement このリンクをリエンゲージメントキャンペーンに属するものとしてマークするには true に設定します (リエンゲージメント FAQ を参照)。 オプション。 すべてのパートナーがこのオプションをサポートしているわけではありません。特定のパートナーがサポートする内容は、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

CTV キャンペーンをサポートするには true に設定します。これは、ネットワークパートナーが 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 の下に集約されます。