Linkly (プレビュー)
Linklyはリンク短縮とクリックトラッカーです。 カスタム ドメインを使用してブランド化された短いリンクを作成し、UTM パラメーターを追加し、ピクセルを再ターゲットし、コンバージョンをレポートし、国、プラットフォーム、参照元、キャンペーンごとにグループ化されたプル クリック分析を行います。
このコネクタは、次の製品とリージョンで使用できます。
| サービス | クラス | Regions |
|---|---|---|
| コピロット スタジオ | Premium | 次を除くすべての Power Automate リージョン : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運営する China Cloud - 米国国防総省 (DoD) |
| ロジック アプリ | Standard | 次を除くすべての Logic Apps リージョン : - Azure Government リージョン - Azure China リージョン - 米国国防総省 (DoD) |
| Power Apps | Premium | 次を除くすべての Power Apps リージョン : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運営する China Cloud - 米国国防総省 (DoD) |
| Power Automate(パワーオートメート) | Premium | 次を除くすべての Power Automate リージョン : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運営する China Cloud - 米国国防総省 (DoD) |
| お問い合わせ | |
|---|---|
| Name | Linkly サポート |
| URL | https://linklyhq.com/support |
| support@linklyhq.com |
| コネクタ メタデータ | |
|---|---|
| 発行元 | Linkly |
| Web サイト | https://linklyhq.com |
| プライバシー ポリシー | https://linklyhq.com/support/privacy |
| カテゴリ | マーケティング;ウェブサイト |
Linkly
Linklyはリンク短縮とクリックトラッカーです。 独自のドメインにブランド化された短いリンクを作成し、国、プラットフォーム、参照元の内訳を含むすべてのクリックを追跡し、再ターゲット ピクセルを起動し、変換を生成したリンクに記録します。 このコネクタを使用すると、フローでリンクの作成と管理、クリック分析のプル、Linkly ワークスペースでの変換のレポートを作成できます。
Publisher: Linkly
Prerequisites
Linkly アカウント。 このコネクタのすべてのアクションを使用するには、無料プランで十分です。 レポート変換と一覧表示変換では、ワークスペースで Linkly コンバージョントラッキング機能を有効にする必要もあります。
サポートされている操作
ワークスペースを一覧表示する
この接続で使用できるワークスペースを返します。 これを使用して、他のアクションに必要なワークスペースを見つけます。
リンクを作成または更新する
新しい短いリンクを作成するか、リンク ID が指定されたときに既存のリンクを更新します。 カスタム ドメインとスラッグ、UTM パラメーター、ピクセルの再ターゲット、および Open Graph メタデータをサポートします。
リンクを取得
リンク先、短い URL、構成など、ID で 1 つのリンクを取得します。
リンクを一覧表示する
クリック統計情報を含む、ワークスペース内のリンクのページ分割された一覧を返します。 検索と並べ替えをサポートします。
タスクを削除する
リンクをごみ箱に移動します。 その短い URL はリダイレクトを停止し、後でごみ箱からリンクを復元できます。
クリック分析を取得する
ワークスペースまたは特定のリンクのクリック数を返します。必要に応じて、日付範囲、国、ブラウザー、プラットフォーム、参照元、ISP でフィルター処理されます。
ディメンション別のクリック数を取得する
国、市区町村、プラットフォーム、参照元、UTM パラメーターなどのディメンション別にグループ化されたクリック数を、降順で並べ替えたクリック数を返します。
カスタム ドメインを一覧表示する
ワークスペース用に構成されたカスタム ドメインを返します。 これらのドメイン名は、リンクの作成時に使用できます。
コンバージョンを報告する
購入、サインアップ、カスタム イベントなどの変換を記録し、属性トークンが指定されたときにクリックされたリンクに属性を付けます。
変換を一覧表示する
ワークスペースに記録された最新の変換を返します。
資格情報の取得
このコネクタでは OAuth 2.0 を使用します。 API キーは必要ありません。
- Linkly アカウントをまだお持ちでない場合は、 https://linklyhq.comにサインアップしてください。 無料プランは機能します。
- 接続を作成するときに、[ Linkly でサインイン ] を選択し、Linkly アカウントでサインインします。
- この接続でプロンプトが表示されたときに使用するワークスペースを選択し、要求を承認します。
接続は、選択したワークスペースにバインドされます。 別のワークスペースで作業するには、2 つ目の接続を作成します。
はじめに
- 上記の手順に従って接続を作成します。
- [ Create or update a link action to a flow]\(リンクの作成または更新\) アクションをフローに追加し、宛先 URL を入力し、必要に応じてカスタム ドメインとスラッグを入力します。 このアクションは、短い URL とリンク ID を返します。
- リスト リンク、クリック分析の取得、ディメンション別のクリック数の取得を使用して、クリック データを読み取ります。 ワークスペースを実行するアクションを使用すると、リスト ワークスペースによって設定されるリストから選択できます。
- 購入またはサインアップをリンクに属性付けするには、ランディング ページの URL から
linkly_cid値を属性トークンとして コンバージョンを報告 する値を渡します。
既知の問題と制限事項
- 接続は、サインイン時に選択された 1 つの Linkly ワークスペースにバインドされます。 ワークスペースごとに 1 つの接続を作成します。
- コンバージョンを報告 し、 コンバージョンを一覧表示するには 、Linkly コンバージョントラッキング機能が必要です。 ワークスペースがない場合は、これらのアクションからエラーが発生します。
- リアルタイム クリック Webhook はトリガーとして公開されません。 代わりに、HTTP によってトリガーされるフローで Linkly の webhook 機能を使用してください。
- リンクの一括作成、リンク エクスポート、およびドメイン管理は Linkly API で使用できますが、このコネクタには含まれません。
- API はレート制限されています。 ディメンション別のクリック数を取得 すると、制限を超えたときにレート制限エラーが返されます。少し遅れた後に再試行してください。
よく寄せられる質問
アクションはどのワークスペースで実行されますか?
Workspace パラメーターを受け取るアクションは、接続で使用できるワークスペースの一覧を表示します。 リンクを取得する、コンバージョンを報告する、コンバージョンを一覧表示するなどのアクションは、接続にバインドされたワークスペースを使用します。
カスタム ドメインを使用する方法
最初に Linkly にドメインを追加し、[リンクの作成または更新] の [ドメイン] フィールドにその名前を渡します。 カスタム ドメインを一覧表示すると、 ワークスペースで使用できる名前が返されます。
リンクを削除するとリンクは完全に削除されますか?
No. リンクはごみ箱に移動され、リダイレクトを停止します。 Linkly のごみ箱から復元できます。
デプロイ手順
- メーカー ポータルで[ カスタム コネクタ]を開き、[ 新しいカスタム コネクタ ]、[ OpenAPI ファイルのインポート] の順に選択します。
apiDefinition.swagger.jsonを選択します。 - [セキュリティ] タブで、汎用 Oauth 2 ID プロバイダーを使用して OAuth 2.0 を選択します。 Linkly によって発行されたクライアント ID とクライアント シークレットを入力し、承認 URL を
https://app.linklyhq.com/oauth/authorizeに設定し、トークン URL と更新 URL の両方をhttps://app.linklyhq.com/oauth/tokenに設定します。 - コネクタを作成し、[セキュリティ] タブに表示されているリダイレクト URL をコピーし、そのクライアント ID に対して Linkly に登録します。
- Linkly アカウントでサインインして接続を作成し、 ワークスペースの一覧表示などのアクションをテストします。
アクション
| カスタム ドメインを一覧表示する |
ワークスペース用に構成されたカスタム ドメインを返します。 これらのドメイン名は、リンクの作成時に使用できます。 |
| クリック分析を取得する |
ワークスペースまたは特定のリンクのクリック数を返します。必要に応じて、日付範囲、国、ブラウザー、プラットフォーム、参照元、ISP でフィルター処理されます。 |
| コンバージョンを報告する |
購入、サインアップ、カスタム イベントなどの変換を記録し、属性トークンが指定されたときにクリックされたリンクに属性を付けます。 |
| タスクを削除する |
リンクをごみ箱に移動します。 その短い URL はリダイレクトを停止し、後でごみ箱からリンクを復元できます。 |
| ディメンション別のクリック数を取得する |
国、市区町村、プラットフォーム、参照元、UTM パラメーターなどのディメンション別にグループ化されたクリック数を、降順で並べ替えたクリック数を返します。 |
| リンクを一覧表示する |
クリック統計情報を含む、ワークスペース内のリンクのページ分割された一覧を返します。 検索と並べ替えをサポートします。 |
| リンクを作成または更新する |
新しい短いリンクを作成するか、リンク ID が指定されたときに既存のリンクを更新します。 カスタム ドメインとスラッグ、UTM パラメーター、ピクセルの再ターゲット、および Open Graph メタデータをサポートします。 |
| リンクを取得 |
リンク先、短い URL、構成など、ID で 1 つのリンクを取得します。 |
| ワークスペースを一覧表示する |
この接続で使用できるワークスペースを返します。 これを使用して、他のアクションに必要なワークスペースを見つけます。 |
| 変換を一覧表示する |
ワークスペースに記録された最新の変換を返します。 |
カスタム ドメインを一覧表示する
ワークスペース用に構成されたカスタム ドメインを返します。 これらのドメイン名は、リンクの作成時に使用できます。
パラメーター
| Name | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Workspace
|
workspace_id | True | string |
作業するワークスペース。 一覧から選択するか、その ID を入力します。 |
返品
| Name | パス | 型 | 説明 |
|---|---|---|---|
|
Domains
|
domains | array of object |
ワークスペース内のカスタム ドメイン。 |
|
ドメイン名
|
domains.name | string |
ドメイン名 (go.yourcompany.com など)。 |
クリック分析を取得する
ワークスペースまたは特定のリンクのクリック数を返します。必要に応じて、日付範囲、国、ブラウザー、プラットフォーム、参照元、ISP でフィルター処理されます。
パラメーター
| Name | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Workspace
|
workspace_id | True | string |
作業するワークスペース。 一覧から選択するか、その ID を入力します。 |
|
リンク ID
|
link_id | string |
フィルター処理する 1 つのリンクの ID。 |
|
|
リンク ID
|
link_ids | string |
フィルター処理するリンク ID のハイフンで区切られたリスト。 |
|
|
開始日
|
start | string |
日付範囲の開始 (YYYY-MM-DD 形式)。 |
|
|
終了日
|
end | string |
日付範囲の末尾 (YYYY-MM-DD 形式)。 |
|
|
国
|
country | string |
米国などの 2 文字の ISO 3166-1 国コード。 |
|
|
Browser
|
browser | string |
フィルター処理するブラウザー名 (Chrome、Firefox、Safari など)。 |
|
|
Platform
|
platform | string |
Windows、Mac、iOS、Android など、フィルター処理するプラットフォームまたはオペレーティング システム。 |
|
|
参照元
|
referer | string |
フィルター処理する参照ドメイン。 |
|
|
ISP
|
isp | string |
フィルター処理するインターネット サービス プロバイダー名。 |
|
|
ボットを含める
|
bots | boolean |
ボットとして識別されたクリックを含めるかどうか。 それらを除外するには false に設定します。 |
|
|
一意のみ
|
unique | boolean |
一意のクリックのみをカウントするかどうか。 |
|
|
タイム ゾーン
|
timezone | string |
日付の計算に使用される IANA タイム ゾーン (ヨーロッパやロンドンなど)。 |
|
|
頻度
|
frequency | string |
時系列の細分性 (日または時間)。 |
返品
| Name | パス | 型 | 説明 |
|---|---|---|---|
|
Traffic
|
traffic | array of object |
クリックは時間の経過と同時にカウントされます。 |
|
バケットの開始
|
traffic.t | string |
バケットの開始: 毎日のバケットの場合は YYYY-MM-DD、時間単位のバケットの場合は YYYY-MM-DDTHH:MM:SS。 |
|
クリック数
|
traffic.y | integer |
バケット内のクリック数。 |
コンバージョンを報告する
購入、サインアップ、カスタム イベントなどの変換を記録し、属性トークンが指定されたときにクリックされたリンクに属性を付けます。
パラメーター
| Name | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
金額 (セント)
|
amount_cents | integer |
最小通貨単位の値。 払い戻しやチャージバックを記録すると負の場合があります。これは、以前の収益に対して純額になります。 |
|
|
国
|
country | string |
変換の 2 文字の国コード。 ブラウザー側の呼び出しに対して推論される。は、接続アドレスが顧客のインフラストラクチャではなく、独自のインフラストラクチャであるサーバー側の統合から明示的に提供します。 |
|
|
通貨
|
currency | string |
ISO 4217 通貨コード。 既定値は USD です。 |
|
|
イベント ID
|
event_id | string |
このイベントの識別子。 べき等キーとして使用されます。同じ値を 2 回レポートすると、2 番目の変換は作成されません。 購入だけでなく、任意の種類のイベントに適用されます。 |
|
|
イベント名
|
event_name | True | string |
購入、サインアップ、trial_startedなど、何が起こったか。 |
|
イベントの種類
|
event_type | string |
じょうごを駆動する粗いタイプ。 リードは顧客 ID を確立し、売上記録の収益を記録します。 既定値は custom です。 |
|
|
顧客ID
|
external_id | string |
顧客の識別子。 すべてのイベントで送信します。これは、後のサーバー側販売を、サインアップを生成したクリックに戻すものです。 |
|
|
属性トークン
|
linkly_cid | string |
ランディング ページ URL からキャプチャされた属性トークン。 使用できない場合は省略します。その後、コンバージョンはリンク属性なしで記録されます。 |
|
|
Metadata
|
metadata | object |
最大 10,000 バイトのエンコードされた任意の JSON。 |
|
|
発生日
|
occurred_at | date-time |
変換が発生したとき。 既定値は現在時点です。 |
|
|
ビジター IP
|
visitor_ip | string |
エンド カスタマーの IP (サーバーに IP がある場合)。 省略する場合を除きます。サーバー側の呼び出しの場合 Linkly は、接続アドレスを顧客ではなくサーバーとして記録し、地理的なレポートから除外します。 このアサートを送信すると、それを共有するための法的根拠があります。 API によって返されることはありません。 |
返品
| Name | パス | 型 | 説明 |
|---|---|---|---|
|
金額 (セント)
|
amount_cents | integer |
最小通貨単位の値。 払い戻しを記録する場合は負の可能性があります。 |
|
ID をクリックします
|
click_id | string |
属性付きクリックの ID。 |
|
国
|
country | string |
米国などの 2 文字の ISO 3166-1 国コード。 |
|
通貨
|
currency | string |
ISO 4217 通貨コード。 既定値は USD です。 |
|
イベント ID
|
event_id | string |
イベントの識別子。 同じ値を 2 回報告しても、2 回目の変換は作成されません。 |
|
イベント名
|
event_name | string |
購入、サインアップ、trial_startedなど、何が起こったか。 |
|
イベントの種類
|
event_type | string |
粗いイベントの種類。 リードを使用して顧客 ID と販売を確立し、収益を記録します。 既定値は custom です。 |
|
顧客ID
|
external_id | string |
顧客の識別子。 後の売上を元のクリックにリンクできるように、すべてのイベントで送信します。 |
|
変換 ID
|
id | string |
変換の一意識別子。 ID は時系列で並べ替えられます。 |
|
挿入位置
|
inserted_at | date-time |
変換が記録されたとき。 |
|
IP ソース
|
ip_source | string |
記録された住所: 訪問者、サーバー、不明。 サーバーは、接続アドレスがバックエンドまたはプラットフォーム リレーに属することを意味するため、地理的なレポートから除外されます。 |
|
リンク ID
|
link_id | integer |
属性付きリンクの ID。変換をリンクに属性付けできなかった場合は null。 |
|
Metadata
|
metadata | object |
任意の JSON メタデータ(最大 10,000 バイト)。 |
|
発生日
|
occurred_at | date-time |
変換が行われると、ISO 8601 形式で表示されます。 既定値は現在時点です。 |
|
Source
|
source | string |
どの統合によって報告されましたか。 |
タスクを削除する
リンクをごみ箱に移動します。 その短い URL はリダイレクトを停止し、後でごみ箱からリンクを復元できます。
パラメーター
| Name | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Workspace
|
workspace_id | True | string |
作業するワークスペース。 一覧から選択するか、その ID を入力します。 |
|
リンク ID
|
id | True | integer |
リンクの ID。 |
返品
確認メッセージ。
- response
- string
ディメンション別のクリック数を取得する
国、市区町村、プラットフォーム、参照元、UTM パラメーターなどのディメンション別にグループ化されたクリック数を、降順で並べ替えたクリック数を返します。
パラメーター
| Name | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Workspace
|
workspace_id | True | string |
作業するワークスペース。 一覧から選択するか、その ID を入力します。 |
|
ディメンション
|
counter | True | string |
クリックをグループ化するディメンション (国、市区町村、プラットフォーム、参照元、utm_campaignなど)。 |
|
リンク ID
|
link_id | string |
フィルター処理する 1 つのリンクの ID。 |
|
|
リンク ID
|
link_ids | string |
フィルター処理するリンク ID のハイフンで区切られたリスト。 |
|
|
開始日
|
start | string |
日付範囲の開始 (YYYY-MM-DD 形式)。 |
|
|
終了日
|
end | string |
日付範囲の末尾 (YYYY-MM-DD 形式)。 |
|
|
国
|
country | string |
米国などの 2 文字の ISO 3166-1 国コード。 |
|
|
ボットを含める
|
bots | boolean |
ボットとして識別されたクリックを含めるかどうか。 それらを除外するには false に設定します。 |
|
|
一意のみ
|
unique | boolean |
一意のクリックのみをカウントするかどうか。 |
返品
| Name | パス | 型 | 説明 |
|---|---|---|---|
|
Total
|
total | integer |
値で返されないものも含め、すべてのグループ全体の合計クリック数。 結果が切り捨てられると、これは値のカウントの合計よりも大きいので、count /total は正確なパーセンテージを引き続き与えます。 |
|
Values
|
values | array of object |
カウントの降順で並べ替えられた、グループ化されたカウント。 上位 10,000 個の値に切り捨てられます。ディメンションの値がそれより大きい場合、残りの値は返されません。 |
|
数える
|
values.count | integer |
この値のクリック数。 |
|
価値
|
values.value | string |
ディメンションの値 (国コードなど)。 |
リンクを一覧表示する
クリック統計情報を含む、ワークスペース内のリンクのページ分割された一覧を返します。 検索と並べ替えをサポートします。
パラメーター
| Name | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Workspace
|
workspace_id | True | string |
作業するワークスペース。 一覧から選択するか、その ID を入力します。 |
|
Search
|
search | string |
名前、URL、またはスラッグでリンクをフィルター処理する検索用語。 |
|
|
ページ
|
page | integer |
返されるページ番号 (1 から始まる)。 |
|
|
ページサイズ
|
page_size | integer |
ページごとに返されるリンクの数。 |
|
|
並べ替え順
|
sort_by | string |
並べ替えの基準となるフィールド (clicks_total、名前、inserted_atなど)。 |
|
|
並び順
|
sort_dir | string |
並べ替えの方向 (asc または desc)。 |
|
|
削除済み
|
deleted | boolean |
アクティブなリンクではなくごみ箱にあるリンクを返すかどうか。 |
返品
| Name | パス | 型 | 説明 |
|---|---|---|---|
|
Links
|
links | array of object |
このページのリンク。 |
|
メタ ピクセル ID
|
links.fb_pixel_id | string |
リンクがクリックされたときに起動する Meta (Facebook) ピクセル ID。 |
|
Human Clicks Total
|
links.human_clicks_total | integer |
ボットシグナルのない有効期間のクリック。ボット ユーザー エージェントと検証済みボット カテゴリのどちらも検出されなかったclicks_totalのサブセット。 2019年より収録。 |
|
クリック数 (30 日)
|
links.clicks_thirty_days | integer |
過去 30 日間のクリック (ボット トラフィックを含む)。 |
|
TikTok ピクセル ID
|
links.tiktok_pixel_id | string |
リンクがクリックされたときに起動する TikTok ピクセル ID。 |
|
参照元を非表示にする
|
links.hide_referrer | boolean |
参照元を宛先サイトから非表示にするかどうかを指定します。 |
|
クローキング
|
links.cloaking | boolean |
フレーム内で開いて宛先を非表示にするかどうかを指定します。 |
|
短い URL
|
links.full_url | uri |
完全な短いリンク URL。 |
|
今日のクリック数
|
links.clicks_today | integer |
ボット トラフィックを含む、今日 (UTC) までのクリック数。 |
|
グラフの説明を開く
|
links.og_description | string |
リンクがソーシャル メディアで共有されるときに表示される説明。 |
|
本文タグ
|
links.body_tags | string |
リダイレクト ページの本文に挿入されたカスタム HTML または追跡タグ。 |
|
グラフ タイトルを開く
|
links.og_title | string |
ソーシャル メディアでリンクが共有されたときに表示されるタイトル。 |
|
Note
|
links.note | string |
リンクに関するプライベート ノート。 |
|
Name
|
links.name | string |
ダッシュボードに表示されるリンクのニックネーム。 |
|
リンク ID
|
links.id | integer |
リンクの一意識別子。 |
|
Google タグ マネージャー ID
|
links.gtm_id | string |
リンクがクリックされたときに読み込む Google タグ マネージャーのコンテナー ID。 |
|
グラフ イメージを開く
|
links.og_image | string |
ソーシャル メディアでリンクが共有されたときに表示される画像 URL。 |
|
ボットをブロックする
|
links.block_bots | boolean |
既知のボットがリンクに従うのをブロックするかどうか。 |
|
合計クリック数
|
links.clicks_total | integer |
ボット トラフィックを含む有効期間のクリック。 |
|
人間のクリック数 (30 日)
|
links.human_clicks_thirty_days | integer |
過去 30 日間にボットシグナルなしでクリックします。clicks_thirty_daysのサブセット。 |
|
UTM コンテンツ
|
links.utm_content | string |
宛先 URL に追加された utm_content パラメーター。 |
|
今日の人間のクリック数
|
links.human_clicks_today | integer |
ボットシグナルなしで今日 (UTC) までクリックします。 |
|
Enabled
|
links.enabled | boolean |
リンクがアクティブかどうか。 |
|
送信先 URL
|
links.url | uri |
短いリンクがリダイレクトする宛先 URL。 |
|
削除済み
|
links.deleted | boolean |
リンクがごみ箱内にあるかどうか。 |
|
ワークスペース ID
|
links.workspace_id | integer |
ワークスペースの ID。 |
|
Public Analytics
|
links.public_analytics | boolean |
リンクの分析ページがパブリックに表示可能かどうか。 |
|
UTM ソース
|
links.utm_source | string |
宛先 URL に追加された utm_source パラメーター。 |
|
スラッグ
|
links.slug | string |
短いリンクのカスタム パス。 スラッシュで始まる必要があります。 |
|
Domain
|
links.domain | string |
末尾にスラッシュを付けずに、短いリンクに使用するカスタム ドメイン。 |
|
前方パラメーター
|
links.forward_params | boolean |
短いリンクから宛先にクエリ パラメーターを転送するかどうかを指定します。 |
|
UTM Medium
|
links.utm_medium | string |
宛先 URL に追加された utm_medium パラメーター。 |
|
ヘッド タグ
|
links.head_tags | string |
リダイレクト ページの先頭に挿入されたカスタム HTML または追跡タグ。 |
|
Google Analytics 4 タグ ID
|
links.ga4_tag_id | string |
リンクがクリックされたときに起動する Google Analytics 4 測定 ID。 |
|
UTM 用語
|
links.utm_term | string |
宛先 URL に追加された utm_term パラメーター。 |
|
UTM キャンペーン
|
links.utm_campaign | string |
宛先 URL に追加された utm_campaign パラメーター。 |
|
昨日の人間のクリック数
|
links.human_clicks_previous_day | integer |
ボットシグナルなしで昨日 (UTC) をクリックします。 |
|
ページ番号
|
page_number | integer |
現在のページ番号。 |
|
ページサイズ
|
page_size | integer |
ページごとに返されるリンクの数。 |
|
合計エントリ数
|
total_entries | integer |
要求に一致するリンクの合計数。 |
|
合計ページ数
|
total_pages | integer |
使用可能なページの合計数。 |
|
総行数
|
total_rows | integer |
行の合計数。 |
|
ワークスペース のリンク数
|
workspace_link_count | integer |
ワークスペース内のリンクの合計数。 |
リンクを作成または更新する
新しい短いリンクを作成するか、リンク ID が指定されたときに既存のリンクを更新します。 カスタム ドメインとスラッグ、UTM パラメーター、ピクセルの再ターゲット、および Open Graph メタデータをサポートします。
パラメーター
| Name | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
送信先 URL
|
url | uri |
短いリンクがリダイレクトする宛先 URL。 新しいリンクを作成するために必要です。 |
|
|
リンク ID
|
id | integer |
更新する既存のリンクの ID。 新しいリンクを作成するには、空白のままにします。 |
|
|
Name
|
name | string |
ダッシュボードに表示されるリンクのニックネーム。 |
|
|
Domain
|
domain | string |
末尾にスラッシュを付けずに、短いリンクに使用するカスタム ドメイン。 |
|
|
スラッグ
|
slug | string |
短いリンクのカスタム パス。 スラッシュで始まる必要があります。 |
|
|
Enabled
|
enabled | boolean |
リンクがアクティブかどうか。 |
|
|
Note
|
note | string |
リンクに関するプライベート ノート。 |
|
|
UTM ソース
|
utm_source | string |
宛先 URL に追加された utm_source パラメーター。 |
|
|
UTM Medium
|
utm_medium | string |
宛先 URL に追加された utm_medium パラメーター。 |
|
|
UTM キャンペーン
|
utm_campaign | string |
宛先 URL に追加された utm_campaign パラメーター。 |
|
|
UTM コンテンツ
|
utm_content | string |
宛先 URL に追加された utm_content パラメーター。 |
|
|
UTM 用語
|
utm_term | string |
宛先 URL に追加された utm_term パラメーター。 |
|
|
メタ ピクセル ID
|
fb_pixel_id | string |
リンクがクリックされたときに起動する Meta (Facebook) ピクセル ID。 |
|
|
Google Analytics 4 タグ ID
|
ga4_tag_id | string |
リンクがクリックされたときに起動する Google Analytics 4 測定 ID。 |
|
|
Google タグ マネージャー ID
|
gtm_id | string |
リンクがクリックされたときに読み込む Google タグ マネージャーのコンテナー ID。 |
|
|
ボットをブロックする
|
block_bots | boolean |
既知のボットがリンクに従うのをブロックするかどうか。 |
|
|
本文タグ
|
body_tags | string |
リダイレクト ページの本文に挿入されたカスタム HTML または追跡タグ。 |
|
|
クローキング
|
cloaking | boolean |
フレーム内で開いて宛先を非表示にするかどうかを指定します。 |
|
|
前方パラメーター
|
forward_params | boolean |
短いリンクから宛先にクエリ パラメーターを転送するかどうかを指定します。 |
|
|
ヘッド タグ
|
head_tags | string |
リダイレクト ページの先頭に挿入されたカスタム HTML または追跡タグ。 |
|
|
参照元を非表示にする
|
hide_referrer | boolean |
参照元を宛先サイトから非表示にするかどうかを指定します。 |
|
|
グラフの説明を開く
|
og_description | string |
リンクがソーシャル メディアで共有されるときに表示される説明。 |
|
|
グラフ イメージを開く
|
og_image | string |
ソーシャル メディアでリンクが共有されたときに表示される画像 URL。 |
|
|
グラフ タイトルを開く
|
og_title | string |
ソーシャル メディアでリンクが共有されたときに表示されるタイトル。 |
|
|
TikTok ピクセル ID
|
tiktok_pixel_id | string |
リンクがクリックされたときに起動する TikTok ピクセル ID。 |
返品
| Name | パス | 型 | 説明 |
|---|---|---|---|
|
メタ ピクセル ID
|
fb_pixel_id | string |
リンクがクリックされたときに起動する Meta (Facebook) ピクセル ID。 |
|
LinkedIn パートナー ID
|
linkedin_partner_id | string |
リンクがクリックされたときに発生するLinkedIn Insight Tag パートナー ID。 |
|
UET タグ ID のMicrosoft
|
microsoft_uet_tag_id | string |
リンクがクリックされたときに発生する Microsoft Advertising UET タグ ID。 |
|
Reddit ピクセル ID
|
reddit_pixel_id | string |
リンクがクリックされたときに発生する Reddit ピクセル ID。 |
|
TikTok ピクセル ID
|
tiktok_pixel_id | string |
リンクがクリックされたときに起動する TikTok ピクセル ID。 |
|
参照元を非表示にする
|
hide_referrer | boolean |
参照元を宛先サイトから非表示にするかどうかを指定します。 |
|
有効期限
|
expiry_datetime | string |
リンクが動作しなくなった場合は、ISO 8601 形式です。 |
|
有効期限の宛先
|
expiry_destination | uri |
リンクの有効期限が切れた後にリダイレクトする URL。 見つからないページを返すには、空白のままにします。 |
|
X ピクセル ID
|
twitter_pixel_id | string |
リンクがクリックされたときに発生する X (Twitter) ピクセル ID。 |
|
クローキング
|
cloaking | boolean |
フレーム内で開いて宛先を非表示にするかどうかを指定します。 |
|
短い URL
|
full_url | uri |
完全な短いリンク URL。 |
|
グラフの説明を開く
|
og_description | string |
リンクがソーシャル メディアで共有されるときに表示される説明。 |
|
ソーシャル クローラー追跡をスキップする
|
skip_social_crawler_tracking | boolean |
ソーシャル メディア プレビュー クローラーをクリック追跡から除外するかどうかを指定します。 |
|
本文タグ
|
body_tags | string |
リダイレクト ページの本文に挿入されたカスタム HTML または追跡タグ。 |
|
グラフ タイトルを開く
|
og_title | string |
ソーシャル メディアでリンクが共有されたときに表示されるタイトル。 |
|
Note
|
note | string |
リンクに関するプライベート ノート。 |
|
Name
|
name | string |
ダッシュボードに表示されるリンクのニックネーム。 |
|
リンク ID
|
id | integer |
更新する既存のリンクの ID。 新しいリンクを作成するには、空白のままにします。 |
|
Google タグ マネージャー ID
|
gtm_id | string |
リンクがクリックされたときに読み込む Google タグ マネージャーのコンテナー ID。 |
|
グラフ イメージを開く
|
og_image | string |
ソーシャル メディアでリンクが共有されたときに表示される画像 URL。 |
|
ボットをブロックする
|
block_bots | boolean |
既知のボットがリンクに従うのをブロックするかどうか。 |
|
Snapchat ピクセル ID
|
snapchat_pixel_id | string |
リンクがクリックされたときに起動する Snapchat ピクセル ID。 |
|
UTM コンテンツ
|
utm_content | string |
宛先 URL に追加された utm_content パラメーター。 |
|
Enabled
|
enabled | boolean |
リンクがアクティブかどうか。 |
|
送信先 URL
|
url | uri |
短いリンクがリダイレクトする宛先 URL。 新しいリンクを作成するために必要です。 |
|
削除済み
|
deleted | boolean |
リンクがごみ箱内にあるかどうか。 |
|
Webhooks
|
webhooks | array of string |
このリンクをクリックすると、サブスクライブしている Webhook URL が表示されます。 |
|
[Expiry Clicks]\(有効期限\) のクリック数
|
expiry_clicks | integer |
リンクが動作を停止した後のクリックの数。 |
|
Slack に通知する
|
notify_slack | boolean |
リンクがクリックされたときに Slack 通知を送信するかどうか。 |
|
ワークスペース ID
|
workspace_id | integer |
ワークスペースの ID。 |
|
Public Analytics
|
public_analytics | boolean |
リンクの分析ページがパブリックに表示可能かどうか。 |
|
Pinterest タグ ID
|
pinterest_tag_id | string |
リンクがクリックされたときに発生する Pinterest タグ ID。 |
|
UTM ソース
|
utm_source | string |
宛先 URL に追加された utm_source パラメーター。 |
|
スラッグ
|
slug | string |
短いリンクのカスタム パス。 スラッシュで始まる必要があります。 |
|
Domain
|
domain | string |
末尾にスラッシュを付けずに、短いリンクに使用するカスタム ドメイン。 |
|
前方パラメーター
|
forward_params | boolean |
短いリンクから宛先にクエリ パラメーターを転送するかどうかを指定します。 |
|
UTM Medium
|
utm_medium | string |
宛先 URL に追加された utm_medium パラメーター。 |
|
ヘッド タグ
|
head_tags | string |
リダイレクト ページの先頭に挿入されたカスタム HTML または追跡タグ。 |
|
Google Analytics 4 タグ ID
|
ga4_tag_id | string |
リンクがクリックされたときに起動する Google Analytics 4 測定 ID。 |
|
UTM 用語
|
utm_term | string |
宛先 URL に追加された utm_term パラメーター。 |
|
UTM キャンペーン
|
utm_campaign | string |
宛先 URL に追加された utm_campaign パラメーター。 |
リンクを取得
リンク先、短い URL、構成など、ID で 1 つのリンクを取得します。
パラメーター
| Name | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
リンク ID
|
id | True | string |
リンクの ID。 |
返品
| Name | パス | 型 | 説明 |
|---|---|---|---|
|
メタ ピクセル ID
|
fb_pixel_id | string |
リンクがクリックされたときに起動する Meta (Facebook) ピクセル ID。 |
|
LinkedIn パートナー ID
|
linkedin_partner_id | string |
リンクがクリックされたときに発生するLinkedIn Insight Tag パートナー ID。 |
|
UET タグ ID のMicrosoft
|
microsoft_uet_tag_id | string |
リンクがクリックされたときに発生する Microsoft Advertising UET タグ ID。 |
|
Reddit ピクセル ID
|
reddit_pixel_id | string |
リンクがクリックされたときに発生する Reddit ピクセル ID。 |
|
TikTok ピクセル ID
|
tiktok_pixel_id | string |
リンクがクリックされたときに起動する TikTok ピクセル ID。 |
|
参照元を非表示にする
|
hide_referrer | boolean |
参照元を宛先サイトから非表示にするかどうかを指定します。 |
|
有効期限
|
expiry_datetime | string |
リンクが動作しなくなった場合は、ISO 8601 形式です。 |
|
有効期限の宛先
|
expiry_destination | uri |
リンクの有効期限が切れた後にリダイレクトする URL。 見つからないページを返すには、空白のままにします。 |
|
X ピクセル ID
|
twitter_pixel_id | string |
リンクがクリックされたときに発生する X (Twitter) ピクセル ID。 |
|
クローキング
|
cloaking | boolean |
フレーム内で開いて宛先を非表示にするかどうかを指定します。 |
|
短い URL
|
full_url | uri |
完全な短いリンク URL。 |
|
グラフの説明を開く
|
og_description | string |
リンクがソーシャル メディアで共有されるときに表示される説明。 |
|
ソーシャル クローラー追跡をスキップする
|
skip_social_crawler_tracking | boolean |
ソーシャル メディア プレビュー クローラーをクリック追跡から除外するかどうかを指定します。 |
|
本文タグ
|
body_tags | string |
リダイレクト ページの本文に挿入されたカスタム HTML または追跡タグ。 |
|
グラフ タイトルを開く
|
og_title | string |
ソーシャル メディアでリンクが共有されたときに表示されるタイトル。 |
|
Note
|
note | string |
リンクに関するプライベート ノート。 |
|
Name
|
name | string |
ダッシュボードに表示されるリンクのニックネーム。 |
|
リンク ID
|
id | integer |
リンクの一意識別子。 |
|
Google タグ マネージャー ID
|
gtm_id | string |
リンクがクリックされたときに読み込む Google タグ マネージャーのコンテナー ID。 |
|
グラフ イメージを開く
|
og_image | string |
ソーシャル メディアでリンクが共有されたときに表示される画像 URL。 |
|
ボットをブロックする
|
block_bots | boolean |
既知のボットがリンクに従うのをブロックするかどうか。 |
|
Snapchat ピクセル ID
|
snapchat_pixel_id | string |
リンクがクリックされたときに起動する Snapchat ピクセル ID。 |
|
UTM コンテンツ
|
utm_content | string |
宛先 URL に追加された utm_content パラメーター。 |
|
Enabled
|
enabled | boolean |
リンクがアクティブかどうか。 |
|
送信先 URL
|
url | uri |
短いリンクがリダイレクトする宛先 URL。 |
|
削除済み
|
deleted | boolean |
リンクがごみ箱内にあるかどうか。 |
|
Webhooks
|
webhooks | array of string |
このリンクをクリックすると、サブスクライブしている Webhook URL が表示されます。 |
|
[Expiry Clicks]\(有効期限\) のクリック数
|
expiry_clicks | integer |
リンクが動作を停止した後のクリックの数。 |
|
Slack に通知する
|
notify_slack | boolean |
リンクがクリックされたときに Slack 通知を送信するかどうか。 |
|
ワークスペース ID
|
workspace_id | integer |
ワークスペースの ID。 |
|
Public Analytics
|
public_analytics | boolean |
リンクの分析ページがパブリックに表示可能かどうか。 |
|
Pinterest タグ ID
|
pinterest_tag_id | string |
リンクがクリックされたときに発生する Pinterest タグ ID。 |
|
UTM ソース
|
utm_source | string |
宛先 URL に追加された utm_source パラメーター。 |
|
スラッグ
|
slug | string |
短いリンクのカスタム パス。 スラッシュで始まる必要があります。 |
|
Domain
|
domain | string |
末尾にスラッシュを付けずに、短いリンクに使用するカスタム ドメイン。 |
|
前方パラメーター
|
forward_params | boolean |
短いリンクから宛先にクエリ パラメーターを転送するかどうかを指定します。 |
|
UTM Medium
|
utm_medium | string |
宛先 URL に追加された utm_medium パラメーター。 |
|
ヘッド タグ
|
head_tags | string |
リダイレクト ページの先頭に挿入されたカスタム HTML または追跡タグ。 |
|
Google Analytics 4 タグ ID
|
ga4_tag_id | string |
リンクがクリックされたときに起動する Google Analytics 4 測定 ID。 |
|
UTM 用語
|
utm_term | string |
宛先 URL に追加された utm_term パラメーター。 |
|
UTM キャンペーン
|
utm_campaign | string |
宛先 URL に追加された utm_campaign パラメーター。 |
ワークスペースを一覧表示する
この接続で使用できるワークスペースを返します。 これを使用して、他のアクションに必要なワークスペースを見つけます。
返品
| Name | パス | 型 | 説明 |
|---|---|---|---|
|
|
array of object | ||
|
ワークスペース ID
|
id | integer |
ワークスペースの一意識別子。 |
|
ワークスペース名
|
name | string |
ワークスペースの名前。 |
変換を一覧表示する
ワークスペースに記録された最新の変換を返します。
パラメーター
| Name | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Limit
|
limit | integer |
返される変換の最大数 (1 ~ 1000)。 |
返品
| Name | パス | 型 | 説明 |
|---|---|---|---|
|
Conversions
|
conversions | array of object |
変換。最も新しい順。 |
|
金額 (セント)
|
conversions.amount_cents | integer |
最小通貨単位の値。 払い戻しを記録する場合は負の可能性があります。 |
|
ID をクリックします
|
conversions.click_id | string |
属性付きクリックの ID。 |
|
国
|
conversions.country | string |
米国などの 2 文字の ISO 3166-1 国コード。 |
|
通貨
|
conversions.currency | string |
ISO 4217 通貨コード。 既定値は USD です。 |
|
イベント ID
|
conversions.event_id | string |
イベントの識別子。 同じ値を 2 回報告しても、2 回目の変換は作成されません。 |
|
イベント名
|
conversions.event_name | string |
購入、サインアップ、trial_startedなど、何が起こったか。 |
|
イベントの種類
|
conversions.event_type | string |
粗いイベントの種類。 リードを使用して顧客 ID と販売を確立し、収益を記録します。 既定値は custom です。 |
|
顧客ID
|
conversions.external_id | string |
顧客の識別子。 後の売上を元のクリックにリンクできるように、すべてのイベントで送信します。 |
|
変換 ID
|
conversions.id | string |
変換の一意識別子。 ID は時系列で並べ替えられます。 |
|
挿入位置
|
conversions.inserted_at | date-time |
変換が記録されたとき。 |
|
IP ソース
|
conversions.ip_source | string |
記録された住所: 訪問者、サーバー、不明。 サーバーは、接続アドレスがバックエンドまたはプラットフォーム リレーに属することを意味するため、地理的なレポートから除外されます。 |
|
リンク ID
|
conversions.link_id | integer |
属性付きリンクの ID。変換をリンクに属性付けできなかった場合は null。 |
|
Metadata
|
conversions.metadata | object |
任意の JSON メタデータ(最大 10,000 バイト)。 |
|
発生日
|
conversions.occurred_at | date-time |
変換が行われると、ISO 8601 形式で表示されます。 既定値は現在時点です。 |
|
Source
|
conversions.source | string |
どの統合によって報告されましたか。 |
定義
文字列
これは基本的なデータ型 'string' です。