BitlyIP (独立系発行元)

  • リファレンス

Bitly は、世界で最も広く信頼されているリンク管理プラットフォームです。 Bitly API を使用すると、自動リンクカスタマイズ、モバイル ディープリンク、クリック分析を通じて、リンクの全機能を活用できます。

このコネクタは、次の製品および地域で利用可能です:

Service クラス 地域
Logic Apps 標準 以下を除くすべての Logic Apps 地域 :
     -   Azure 政府の地域
     -   Azure 中国の地域
     -   国防総省 (DoD)
Power Automate プレミアム 以下を除くすべての Power Automate 地域 :
     -   米国政府 (GCC)
     -   米国政府 (GCC High)
     -   21Vianet が運用する中国のクラウド
     -   国防総省 (DoD)
Power Apps プレミアム 以下を除くすべての Power Apps 地域 :
     -   米国政府 (GCC)
     -   米国政府 (GCC High)
     -   21Vianet が運用する中国のクラウド
     -   米国国防総省 (DoD)
お問い合わせ先
件名 Troy Taylor
[URL] https://www.hitachisolutions.com
メール ttaylor@hitachisolutions.com
Connector Metadata
発行者 Troy Taylor
Web サイト https://bitly.com/
プライバシー ポリシー https://bitly.com/pages/privacy
カテゴリ ソーシャル メディア、Web サイト

接続の作成

コネクタは、次の認証タイプをサポートしています。
既定 接続を作成するためのパラメーター。 すべての地域 共有不可

既定

適用できるもの: すべての領域

接続を作成するためのパラメーター。

これは共有可能な接続ではありません。 パワー アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。

件名 タイプ 内容 必要
API キー securestring この API の API キー True

調整制限

名前 呼び出し 更新期間
接続ごとの API 呼び出し 100 60 秒

アクション

Bitlink QR コードを取得する

Bitlink の QR コードを生成します。
Bitlink のクリックを取得

日付に基づいて、配列内の指定されたリンクのクリック数を返します。
Bitlink のクリック概要を取得する

1 つのフィールドにロールアップされた指定されたリンクのクリック数を返します。
Bitlink の更新

指定されたリンクでフィールドを更新します。
Bitlink を作成

長い URL をビットリンクに変換します。
Bitlink を取得する

指定したリンクの情報を返します。
BSD の カスタム Bitlink を取得する

BSD によってフィルタリングされた組織のカスタム Bitlink を取得します。
BSD を取得する

すべてのブランド ショート ドメインを取得します。
OAuth App を取得する

提供された OAuth アプリ クライアント ID の詳細を取得します。
ウェブフック の作成

ウェブフック を作成します。
ウェブフック の取得

ウェブフック を返します。
ウェブフック の更新

ウェブフック を更新する
ウェブフック を削除する

ウェブフック を削除します。
ウェブフック を取得する

組織で利用可能なすべての ウェブフック を取得します
ウェブフック を検証する

ウェブフック 構成をテストするために ping イベントを送信します。
カスタム Bitlink のクリックを取得

指定されたリンクのクリック数を返します。 これにより、日付に基づくクリック数の配列が返されます。
カスタム Bitlink の追加

カスタム ドメインを持つビットリンクにキーワード (またはカスタムの後半) を追加します。 このエンドポイントは、リンクへの最初のリダイレクトにも使用できます。
カスタム Bitlink を取得する

指定されたリンクの詳細と履歴を返します。
カスタム Bitlink を更新する

キーワード (またはカスタムの後半) を別の Bitlink に移動します。
キャンペーンを作成

新しいキャンペーンを作成します。
キャンペーンを取得する

キャンペーンの詳細を返します。
キャンペーンを取得する

現在認証されているユーザーのキャンペーンを返します。
キャンペーンを更新する

キャンペーンの詳細を更新します。
グループ クリックを取得する

グループ内の Bitlink のクリック数を取得します。
グループ タグを取得する

指定されたグループで現在使用されているタグを返します。 最大: 1000。
グループで Bitlinks を取得する

グループの Bitlink のページ付けされたコレクションを返します。
グループの取得

組織のグループの一覧を返します。
グループの基本設定を更新します

グループの基本設定を更新します。
グループの更新

グループの詳細を更新します。
グループを取得する

グループの詳細を返します。
グループ別に Bitlinks を更新する

一括更新では、タグを追加または削除したり、一度に最大100個のリンクをアーカイブしたりできます。応答には、更新されたビットリンクIDのリストが含まれます。
グループ短縮カウントを取得する

グループのすべての短縮カウントを返します。
グループ設定を取得する

指定したグループの基本設定を返します。
ソートされた Bitlink を取得する

グループでソートされた Bitlink のリストを返します。
チャネルの作成

新規チャネルを作成します。
チャネルの更新

既存のチャネルを更新します。
チャネルを取得する

チャネルの詳細を返します。
チャネルを取得する

ユーザーが利用できるチャネルを返します。
チャンネルにビットリンクを一括追加

複数のキャンペーン チャンネルにビットリンクを一括追加
デバイスごとのグループ指標を取得する

指定されたグループのリンクへのクリックトラフィックを生成するデバイス タイプを返します。
デバイスごとのビットリンクの指標を取得する

指定されたリンクへのクリックトラフィックを生成するデバイス タイプを返します。
ドメインごとのビットリンクの指標を取得する

指定されたリンクの参照別のクリック メトリックスを返します。
ネットワークを参照してグループ メトリックを取得する

指定されたグループのリンクのネットワークを参照してメトリックを返します。
ビットリンクを展開する

指定されたリンクの短いリンクと長い URL を返します。
フル Bitlink を作成

長い URL をビットリンクに変換し、追加のパラメータを設定します。
プラットフォームの制限

組織で使用可能なすべてのプラットフォームの制限とカウントを返します
プランの制限を取得する

組織で使用可能なすべてのプランの制限とカウントを返します。
ユーザーの更新

ユーザーのフィールドを更新する
ユーザーを取得する

現在の認証済みユーザーの情報を返します。
参照ごとのビットリンクの指標を取得する

指定されたリンクの参照クリック数を返します。
参照ドメインごとのビットリンクの指標を取得する

指定されたリンクの参照ドメイン クリック数を返します。
国ごとのグループ指標を取得する

指定されたグループの国ごとのクリック トラフィックの地理的な起点を返します。
国ごとのビットリンクの指標を取得する

指定されたリンクのクリック トラフィックの国の起点を返します。
宛先ごとにカスタム Bitlink メトリックを取得する

指定されたリンクのクリック メトリックを、その履歴の宛先別に返します。
組織を取得する

指定された組織の詳細を取得します。
組織を取得する

組織のリストを取得します。
組織短縮カウントを取得する

指定された期間における特定の組織の短縮カウントを返します。
都市ごとのグループ指標を取得する

指定されたグループの都市ごとのクリック トラフィックの地理的な起点を返します。
都市ごとのビットリンクの指標を取得する

指定されたリンクのクリック トラフィックの街の起点を返します。
操作 ID:
GetBitlinkQRCode

Bitlink の QR コードを生成します。

パラメーター

名前 キー 必須 型 説明
Bitlink
 bitlink True string

ドメインとハッシュで構成された Bitlink
Color
 color string

16 進数の RGB 形式で示される色
Bitly ロゴを除外する
 exclude_bitly_logo boolean

生成された QR 画像の中央から Bitly ロゴを削除します
Image Format
 image_format string

返される QR コードの画像形式を決定します

戻り値

BitlinkQR
BitlinkQR
操作 ID:
GetClicksForBitlink

日付に基づいて、配列内の指定されたリンクのクリック数を返します。

パラメーター

名前 キー 必須 型 説明
Bitlink
 bitlink True string

ドメインとハッシュで構成された Bitlink
単位
 unit True string

時間の単位
単位
 units True integer

データを照会する時間単位を表す整数。 -1 を渡すと、すべての時間単位が返されます。
ユニット参照
 unit_reference string

ISO-8601 タイムスタンプ。メトリックをプルする最新の時刻を示します。 既定は現在の時刻になります。

戻り値

Clicks
Clicks
操作 ID:
GetClicksSummaryForBitlink

1 つのフィールドにロールアップされた指定されたリンクのクリック数を返します。

パラメーター

名前 キー 必須 型 説明
Bitlink
 bitlink True string

ドメインとハッシュで構成された Bitlink
単位
 unit True string

時間の単位
単位
 units True integer

データを照会する時間単位を表す整数。 -1 を渡すと、すべての時間単位が返されます。
ユニット参照
 unit_reference string

ISO-8601 タイムスタンプ。メトリックをプルする最新の時刻を示します。 既定は現在の時刻になります。

戻り値

ClicksSummary
ClicksSummary
操作 ID:
UpdateBitlink

指定されたリンクでフィールドを更新します。

パラメーター

名前 キー 必須 型 説明
Bitlink
 bitlink True string

ドメインとハッシュで構成された Bitlink
参照
 references object
archived
 archived boolean
tags
 tags array of string
created_at
 created_at string
肩書き
 title string
bitlink
 bitlink string
install_url
 install_url string
created
 created string

ISO タイムスタンプ
app_uri_path
 app_uri_path string
修正日時
 modified string

ISO タイムスタンプ
install_type
 install_type string
app_guid
 app_guid string
guid
 guid string
os (オーエス)
 os string
brand_guid
 brand_guid string
created_by
 created_by string
long_url
 long_url string
client_id
 client_id string
custom_bitlinks
 custom_bitlinks array of string
link
 link string
launchpad_ids
 launchpad_ids array of string
id
 id string

戻り値

BitlinkBody
BitlinkBody
操作 ID:
CreateBitlink

長い URL をビットリンクに変換します。

パラメーター

名前 キー 必須 型 説明
group_guid
 group_guid string
ドメイン
 domain string
long_url
 long_url True string

戻り値

ShortenBitlinkBody
ShortenBitlinkBody
操作 ID:
GetBitlink

指定したリンクの情報を返します。

パラメーター

名前 キー 必須 型 説明
Bitlink
 bitlink True string

ドメインとハッシュで構成された Bitlink

戻り値

BitlinkBody
BitlinkBody
操作 ID:
GetCustomBitlinksForBSDs

BSD によってフィルタリングされた組織のカスタム Bitlink を取得します。

パラメーター

名前 キー 必須 型 説明
Group GUID
 group_guid True string

Bitly グループの GUID
作成後
 created_after integer

整数 UNIX エポックとしてのタイムスタンプ
Limit
 limit integer

返される結果の量を制限します
オフセット
 offset integer

結果セットの開始インデックスを設定します
BSD
 bsd array

結果をフィルタリングするためのブランド化された短いドメイン

戻り値

BitlinkOverridesData
BitlinkOverridesData

BSD を取得する

操作 ID:
GetBSDs

すべてのブランド ショート ドメインを取得します。

戻り値

BSDsResponse
BSDsResponse

OAuth App を取得する

操作 ID:
GetOAuthApp

提供された OAuth アプリ クライアント ID の詳細を取得します。

パラメーター

名前 キー 必須 型 説明
Click ID
 client_id True string

OAuth アプリのクライアント ID

戻り値

OAuthApp
OAuthApp

ウェブフック の作成

操作 ID:
CreateWebhook

ウェブフック を作成します。

パラメーター

名前 キー 必須 型 説明
名前
 name True string
url
 url True string
group_guid
 group_guid string
fetch_tags
 fetch_tags boolean
is_active
 is_active boolean
organization_guid
 organization_guid True string
client_id
 client_id string
client_secret
 client_secret string
oauth_url
 oauth_url string
イベント
 event True string

戻り値

ウェブフック
Webhook

ウェブフック の取得

操作 ID:
GetWebhook

ウェブフック を返します。

パラメーター

名前 キー 必須 型 説明
ウェブフック GUID
 webhook_guid True string

Bitly ウェブフック キャンペーンの GUID

戻り値

ウェブフック
Webhook

ウェブフック の更新

操作 ID:
UpdateWebhook

ウェブフック を更新する

パラメーター

名前 キー 必須 型 説明
ウェブフック GUID
 webhook_guid True string

Bitly ウェブフック キャンペーンの GUID
名前
 name string
url
 url string
group_guid
 group_guid string
fetch_tags
 fetch_tags boolean
is_active
 is_active boolean
organization_guid
 organization_guid string
client_id
 client_id string
client_secret
 client_secret string
oauth_url
 oauth_url string
guid
 guid True string
イベント
 event string

戻り値

ウェブフック
Webhook

ウェブフック を削除する

操作 ID:
DeleteWebhook

ウェブフック を削除します。

パラメーター

名前 キー 必須 型 説明
ウェブフック GUID
 webhook_guid True string

Bitly ウェブフック キャンペーンの GUID

ウェブフック を取得する

操作 ID:
GetWebhooks

組織で利用可能なすべての ウェブフック を取得します

パラメーター

名前 キー 必須 型 説明
Organization GUID
 organization_guid True string

Bitly 組織の GUID

戻り値

ウェブフックs
Webhooks

ウェブフック を検証する

操作 ID:
VerifyWebhook

ウェブフック 構成をテストするために ping イベントを送信します。

パラメーター

名前 キー 必須 型 説明
ウェブフック GUID
 webhook_guid True string

Bitly ウェブフック キャンペーンの GUID

戻り値

ウェブフック
Webhook
操作 ID:
GetClicksForCustomBitlink

指定されたリンクのクリック数を返します。 これにより、日付に基づくクリック数の配列が返されます。

パラメーター

名前 キー 必須 型 説明
Custom Bitlink
 custom_bitlink True string

ドメインとキーワードで構成されたカスタム Bitlink
単位
 unit True string

時間の単位
単位
 units True integer

データを照会する時間単位を表す整数。 -1 を渡すと、すべての時間単位が返されます。
ユニット参照
 unit_reference string

ISO-8601 タイムスタンプ。メトリックをプルする最新の時刻を示します。 既定は現在の時刻になります。

戻り値

Clicks
Clicks
操作 ID:
AddCustomBitlink

カスタム ドメインを持つビットリンクにキーワード (またはカスタムの後半) を追加します。 このエンドポイントは、リンクへの最初のリダイレクトにも使用できます。

パラメーター

名前 キー 必須 型 説明
bitlink_id
 bitlink_id string
custom_bitlink
 custom_bitlink string

戻り値

CustomBitlink
CustomBitlink
操作 ID:
GetCustomBitlink

指定されたリンクの詳細と履歴を返します。

パラメーター

名前 キー 必須 型 説明
Custom Bitlink
 custom_bitlink True string

ドメインとキーワードで構成されたカスタム Bitlink

戻り値

CustomBitlink
CustomBitlink
操作 ID:
UpdateCustomBitlink

キーワード (またはカスタムの後半) を別の Bitlink に移動します。

パラメーター

名前 キー 必須 型 説明
Custom Bitlink
 custom_bitlink True string

ドメインとキーワードで構成されたカスタム Bitlink
bitlink_id
 bitlink_id string

戻り値

CustomBitlink
CustomBitlink

キャンペーンを作成

操作 ID:
CreateCampaign

新しいキャンペーンを作成します。

パラメーター

名前 キー 必須 型 説明
group_guid
 group_guid string
channel_guids
 channel_guids array of string
説明
 description string
名前
 name string

戻り値

Campaign
Campaign

キャンペーンを取得する

操作 ID:
GetCampaign

キャンペーンの詳細を返します。

パラメーター

名前 キー 必須 型 説明
Campaign GUID
 campaign_guid True string

Bitly キャンペーンの GUID

戻り値

Campaign
Campaign

キャンペーンを取得する

操作 ID:
GetCampaigns

現在認証されているユーザーのキャンペーンを返します。

パラメーター

名前 キー 必須 型 説明
Group GUID
 group_guid string

Bitly グループの GUID

戻り値

Campaigns
Campaigns

キャンペーンを更新する

操作 ID:
UpdateCampaign

キャンペーンの詳細を更新します。

パラメーター

名前 キー 必須 型 説明
Campaign GUID
 campaign_guid True string

Bitly キャンペーンの GUID
group_guid
 group_guid string
channel_guids
 channel_guids array of string
説明
 description string
名前
 name string

戻り値

Campaign
Campaign

グループ クリックを取得する

操作 ID:
GetGroupClicks

グループ内の Bitlink のクリック数を取得します。

パラメーター

名前 キー 必須 型 説明
Group GUID
 group_guid True string

Bitly グループの GUID
単位
 unit True string

時間の単位
単位
 units True integer

データを照会する時間単位を表す整数。 -1 を渡すと、すべての時間単位が返されます。
ユニット参照
 unit_reference string

ISO-8601 タイムスタンプ。メトリックをプルする最新の時刻を示します。 既定は現在の時刻になります。

戻り値

GroupClicks
GroupClicks

グループ タグを取得する

操作 ID:
GetGroupTags

指定されたグループで現在使用されているタグを返します。 最大: 1000。

パラメーター

名前 キー 必須 型 説明
Group GUID
 group_guid True string

Bitly グループの GUID

戻り値

タグ
Tags
操作 ID:
GetBitlinksByGroup

グループの Bitlink のページ付けされたコレクションを返します。

パラメーター

名前 キー 必須 型 説明
Group GUID
 group_guid True string

Bitly グループの GUID
サイズ
 size integer

返品されるアイテムの数量
ページ
 page integer

開始する番号付きの結果を指定する整数
Keyword
 keyword string

履歴エントリでフィルタリングするカスタム キーワード
クエリ
 query string

検索したい値
Created Before
 created_before integer

整数 UNIX エポックとしてのタイムスタンプ
作成後
 created_after integer

整数 UNIX エポックとしてのタイムスタンプ
修正後
 modified_after integer

整数 UNIX エポックとしてのタイムスタンプ
Archived
 archived string

アーカイブされたビットリンクを含めるかどうか
Deeplinks
 deeplinks string

ディープリンクを含むビットリンクのみにフィルタリングする
ドメイン ディープリンク
 domain_deeplinks string

カスタムドメインで構成されたディープリンクを含むビットリンクのみにフィルタリングする
Campaign GUID
 campaign_guid string

指定されたキャンペーン GUID のリンクのみを返すフィルターが提供できます
Channel GUILD
 channel_guid string

指定されたチャネル GUID のリンクのみを返すようにフィルタリングし、提供でき、他のすべてのパラメーターをオーバーライドします
Custom Bitlink
 custom_bitlink string

ドメインとキーワードで構成されたカスタム Bitlink
タグ
 tags array

与えられたタグ別にフィルター
Launchpad IDs
 launchpad_ids array

発射台 ID 別にフィルター
Encoding Login
 encoding_login array

ビットリンクを作成した認証済みユーザーのログインでフィルタリングする

戻り値

Bitlinks
Bitlinks

グループの取得

操作 ID:
GetGroups

組織のグループの一覧を返します。

パラメーター

名前 キー 必須 型 説明
Organization GUID
 organization_guid string

Bitly 組織の GUID

戻り値

Groups
Groups

グループの基本設定を更新します

操作 ID:
UpdateGroupPreferences

グループの基本設定を更新します。

パラメーター

名前 キー 必須 型 説明
Group GUID
 group_guid True string

Bitly グループの GUID
group_guid
 group_guid string
domain_preference
 domain_preference string

戻り値

GroupPreferences
GroupPreferences

グループの更新

操作 ID:
UpdateGroup

グループの詳細を更新します。

パラメーター

名前 キー 必須 型 説明
Group GUID
 group_guid True string

Bitly グループの GUID
bsds
 bsds array of string
名前
 name string
organization_guid
 organization_guid string

戻り値

Group
Group

グループを取得する

操作 ID:
GetGroup

グループの詳細を返します。

パラメーター

名前 キー 必須 型 説明
Group GUID
 group_guid True string

Bitly グループの GUID

戻り値

Group
Group
操作 ID:
UpdateBitlinksByGroup

一括更新では、タグを追加または削除したり、一度に最大100個のリンクをアーカイブしたりできます。応答には、更新されたビットリンクIDのリストが含まれます。

パラメーター

名前 キー 必須 型 説明
Group GUID
 group_guid True string

Bitly グループの GUID
Action
 action string
remove_tags
 remove_tags array of string
archive
 archive boolean
links
 links array of string

これは 100 個の Bitlink ID に制限されています
add_tags
 add_tags array of string

戻り値

BulkUpdate
BulkUpdate

グループ短縮カウントを取得する

操作 ID:
GetGroupShortenCounts

グループのすべての短縮カウントを返します。

パラメーター

名前 キー 必須 型 説明
Group GUID
 group_guid True string

Bitly グループの GUID
単位
 unit True string

時間の単位
単位
 units True integer

データを照会する時間単位を表す整数。 -1 を渡すと、すべての時間単位が返されます。
ユニット参照
 unit_reference string

ISO-8601 タイムスタンプ。メトリックをプルする最新の時刻を示します。 既定は現在の時刻になります。

戻り値

Metrics
Metrics

グループ設定を取得する

操作 ID:
GetGroupPreferences

指定したグループの基本設定を返します。

パラメーター

名前 キー 必須 型 説明
Group GUID
 group_guid True string

Bitly グループの GUID

戻り値

GroupPreferences
GroupPreferences
操作 ID:
GetSortedBitlinks

グループでソートされた Bitlink のリストを返します。

パラメーター

名前 キー 必須 型 説明
Group GUID
 group_guid True string

Bitly グループの GUID
並び替え
 sort True string

おこないたい並べ替えの種類
単位
 unit string

時間の単位
単位
 units integer

データを照会する時間単位を表す整数。 -1 を渡すと、すべての時間単位が返されます。
ユニット参照
 unit_reference string

ISO-8601 タイムスタンプ。メトリックをプルする最新の時刻を示します。 既定は現在の時刻になります。
サイズ
 size integer

返品されるアイテムの数量

戻り値

SortedLinks
SortedLinks

チャネルの作成

操作 ID:
CreateChannel

新規チャネルを作成します。

パラメーター

名前 キー 必須 型 説明
group_guid
 group_guid string
guid
 guid string
名前
 name string
修正日時
 modified string

ISO_TIMESTAMP
created
 created string

ISO TIMESTAMP
campaign_guid
 campaign_guid string
bitlink_id
 bitlink_id string

戻り値

チャネル
Channel

チャネルの更新

操作 ID:
UpdateChannel

既存のチャネルを更新します。

パラメーター

名前 キー 必須 型 説明
Channel GUID
 channel_guid True string

Bitly チャネルの GUID
group_guid
 group_guid string
guid
 guid string
名前
 name string
修正日時
 modified string

ISO_TIMESTAMP
created
 created string

ISO TIMESTAMP
campaign_guid
 campaign_guid string
bitlink_id
 bitlink_id string

戻り値

Channel
Channel

チャネルを取得する

操作 ID:
GetChannel

チャネルの詳細を返します。

パラメーター

名前 キー 必須 型 説明
Channel GUID
 channel_guid True string

Bitly チャネルの GUID

戻り値

Channel
Channel

チャネルを取得する

操作 ID:
GetChannels

ユーザーが利用できるチャネルを返します。

パラメーター

名前 キー 必須 型 説明
Group GUID
 group_guid string

Bitly グループの GUID
Campaign GUID
 campaign_guid string

Bitly キャンペーンの GUID

戻り値

Channels
Channels

チャンネルにビットリンクを一括追加

操作 ID:
BulkAdd

複数のキャンペーン チャンネルにビットリンクを一括追加

パラメーター

名前 キー 必須 型 説明
Campaign GUID
 campaign_guid True string

Bitly キャンペーンの GUID
コンテンツ タイプ
 Content-Type string

コンテンツのタイプ。
File
 file file

ファイル。

戻り値

BulkAddResponse
BulkAddResponse

デバイスごとのグループ指標を取得する

操作 ID:
GetGroupMetricsByDevices

指定されたグループのリンクへのクリックトラフィックを生成するデバイス タイプを返します。

パラメーター

名前 キー 必須 型 説明
Group GUID
 group_guid True string

Bitly グループの GUID
単位
 unit True string

時間の単位
単位
 units True integer

データを照会する時間単位を表す整数。 -1 を渡すと、すべての時間単位が返されます。
サイズ
 size integer

返品されるアイテムの数量
ユニット参照
 unit_reference string

ISO-8601 タイムスタンプ。メトリックをプルする最新の時刻を示します。 既定は現在の時刻になります。

戻り値

DeviceMetrics
DeviceMetrics

デバイスごとのビットリンクの指標を取得する

操作 ID:
GetMetricsForBitlinkByDevices

指定されたリンクへのクリックトラフィックを生成するデバイス タイプを返します。

パラメーター

名前 キー 必須 型 説明
Bitlink
 bitlink True string

ドメインとハッシュで構成された Bitlink
単位
 unit True string

時間の単位
単位
 units True integer

データを照会する時間単位を表す整数。 -1 を渡すと、すべての時間単位が返されます。
サイズ
 size integer

返品されるアイテムの数量
ユニット参照
 unit_reference string

ISO-8601 タイムスタンプ。メトリックをプルする最新の時刻を示します。 既定は現在の時刻になります。

戻り値

DeviceMetrics
DeviceMetrics

ドメインごとのビットリンクの指標を取得する

操作 ID:
GetMetricsForBitlinkByReferrersByDomains

指定されたリンクの参照別のクリック メトリックスを返します。

パラメーター

名前 キー 必須 型 説明
Bitlink
 bitlink True string

ドメインとハッシュで構成された Bitlink
単位
 unit True string

時間の単位
単位
 units True integer

データを照会する時間単位を表す整数。 -1 を渡すと、すべての時間単位が返されます。
サイズ
 size integer

返品されるアイテムの数量
ユニット参照
 unit_reference string

ISO-8601 タイムスタンプ。メトリックをプルする最新の時刻を示します。 既定は現在の時刻になります。

戻り値

ReferrersByDomains
ReferrersByDomains

ネットワークを参照してグループ メトリックを取得する

操作 ID:
GetGroupMetricsByReferringNetworks

指定されたグループのリンクのネットワークを参照してメトリックを返します。

パラメーター

名前 キー 必須 型 説明
Group GUID
 group_guid True string

Bitly グループの GUID

戻り値

ClickMetrics
ClickMetrics

ビットリンクを展開する

操作 ID:
ExpandBitlink

指定されたリンクの短いリンクと長い URL を返します。

パラメーター

名前 キー 必須 型 説明
bitlink_id
 bitlink_id string

戻り値

ExpandedBitlink
ExpandedBitlink
操作 ID:
CreateFullBitlink

長い URL をビットリンクに変換し、追加のパラメータを設定します。

パラメーター

名前 キー 必須 型 説明
ドメイン
 domain string
肩書き
 title string
group_guid
 group_guid string

短縮通話には、常に特定のグループとカスタム ドメインを含めてください。
タグ
 tags array of string
app_uri_path
 app_uri_path string
install_type
 install_type string
install_url
 install_url string
app_id
 app_id string
long_url
 long_url True string

戻り値

BitlinkBody
BitlinkBody

プラットフォームの制限

操作 ID:
GetPlatformLimits

組織で使用可能なすべてのプラットフォームの制限とカウントを返します

パラメーター

名前 キー 必須 型 説明
パス
 path string

情報が要求される特定のパス

戻り値

PlatformLimits
PlatformLimits

プランの制限を取得する

操作 ID:
GetPlanLimits

組織で使用可能なすべてのプランの制限とカウントを返します。

パラメーター

名前 キー 必須 型 説明
Organization GUID
 organization_guid True string

Bitly 組織の GUID

戻り値

PlanLimits
PlanLimits

ユーザーの更新

操作 ID:
UpdateUser

ユーザーのフィールドを更新する

パラメーター

名前 キー 必須 型 説明
default_group_guid
 default_group_guid string
名前
 name string

戻り値

ユーザー
User

ユーザーを取得する

操作 ID:
GetUser

現在の認証済みユーザーの情報を返します。

戻り値

ユーザー
User

参照ごとのビットリンクの指標を取得する

操作 ID:
GetMetricsForBitlinkByReferrers

指定されたリンクの参照クリック数を返します。

パラメーター

名前 キー 必須 型 説明
Bitlink
 bitlink True string

ドメインとハッシュで構成された Bitlink
単位
 unit True string

時間の単位
単位
 units True integer

データを照会する時間単位を表す整数。 -1 を渡すと、すべての時間単位が返されます。
サイズ
 size integer

返品されるアイテムの数量
ユニット参照
 unit_reference string

ISO-8601 タイムスタンプ。メトリックをプルする最新の時刻を示します。 既定は現在の時刻になります。

戻り値

ClickMetrics
ClickMetrics

参照ドメインごとのビットリンクの指標を取得する

操作 ID:
GetMetricsForBitlinkByReferringDomains

指定されたリンクの参照ドメイン クリック数を返します。

パラメーター

名前 キー 必須 型 説明
Bitlink
 bitlink True string

ドメインとハッシュで構成された Bitlink
単位
 unit True string

時間の単位
単位
 units True integer

データを照会する時間単位を表す整数。 -1 を渡すと、すべての時間単位が返されます。
サイズ
 size integer

返品されるアイテムの数量
ユニット参照
 unit_reference string

ISO-8601 タイムスタンプ。メトリックをプルする最新の時刻を示します。 既定は現在の時刻になります。

戻り値

ClickMetrics
ClickMetrics

国ごとのグループ指標を取得する

操作 ID:
GetGroupMetricsByCountries

指定されたグループの国ごとのクリック トラフィックの地理的な起点を返します。

パラメーター

名前 キー 必須 型 説明
Group GUID
 group_guid True string

Bitly グループの GUID
単位
 unit True string

時間の単位
単位
 units True integer

データを照会する時間単位を表す整数。 -1 を渡すと、すべての時間単位が返されます。
サイズ
 size integer

返品されるアイテムの数量
ユニット参照
 unit_reference string

ISO-8601 タイムスタンプ。メトリックをプルする最新の時刻を示します。 既定は現在の時刻になります。

戻り値

ClickMetrics
ClickMetrics

国ごとのビットリンクの指標を取得する

操作 ID:
GetMetricsForBitlinkByCountries

指定されたリンクのクリック トラフィックの国の起点を返します。

パラメーター

名前 キー 必須 型 説明
Bitlink
 bitlink True string

ドメインとハッシュで構成された Bitlink
単位
 unit True string

時間の単位
単位
 units True integer

データを照会する時間単位を表す整数。 -1 を渡すと、すべての時間単位が返されます。
サイズ
 size integer

返品されるアイテムの数量
ユニット参照
 unit_reference string

ISO-8601 タイムスタンプ。メトリックをプルする最新の時刻を示します。 既定は現在の時刻になります。

戻り値

ClickMetrics
ClickMetrics
操作 ID:
GetCustomBitlinkMetricsByDestination

指定されたリンクのクリック メトリックを、その履歴の宛先別に返します。

パラメーター

名前 キー 必須 型 説明
Custom Bitlink
 custom_bitlink True string

ドメインとキーワードで構成されたカスタム Bitlink
単位
 unit True string

時間の単位
単位
 units True integer

データを照会する時間単位を表す整数。 -1 を渡すと、すべての時間単位が返されます。
ユニット参照
 unit_reference string

ISO-8601 タイムスタンプ。メトリックをプルする最新の時刻を示します。 既定は現在の時刻になります。

戻り値

ClickMetrics
ClickMetrics

組織を取得する

操作 ID:
GetOrganization

指定された組織の詳細を取得します。

パラメーター

名前 キー 必須 型 説明
Organization GUID
 organization_guid True string

Bitly 組織の GUID

戻り値

組織
Organization

組織を取得する

操作 ID:
GetOrganizations

組織のリストを取得します。

戻り値

組織
Organizations

組織短縮カウントを取得する

操作 ID:
GetOrganizationShortenCounts

指定された期間における特定の組織の短縮カウントを返します。

パラメーター

名前 キー 必須 型 説明
Organization GUID
 organization_guid True string

Bitly 組織の GUID
単位
 unit True string

時間の単位
単位
 units True integer

データを照会する時間単位を表す整数。 -1 を渡すと、すべての時間単位が返されます。
ユニット参照
 unit_reference string

ISO-8601 タイムスタンプ。メトリックをプルする最新の時刻を示します。 既定は現在の時刻になります。

戻り値

Metrics
Metrics

都市ごとのグループ指標を取得する

操作 ID:
GetGroupMetricsByCities

指定されたグループの都市ごとのクリック トラフィックの地理的な起点を返します。

パラメーター

名前 キー 必須 型 説明
Group GUID
 group_guid True string

Bitly グループの GUID
単位
 unit True string

時間の単位
単位
 units True integer

データを照会する時間単位を表す整数。 -1 を渡すと、すべての時間単位が返されます。
サイズ
 size integer

返品されるアイテムの数量
ユニット参照
 unit_reference string

ISO-8601 タイムスタンプ。メトリックをプルする最新の時刻を示します。 既定は現在の時刻になります。

戻り値

CityMetrics
CityMetrics

都市ごとのビットリンクの指標を取得する

操作 ID:
GetMetricsForBitlinkByCities

指定されたリンクのクリック トラフィックの街の起点を返します。

パラメーター

名前 キー 必須 型 説明
Bitlink
 bitlink True string

ドメインとハッシュで構成された Bitlink
単位
 unit True string

時間の単位
単位
 units True integer

データを照会する時間単位を表す整数。 -1 を渡すと、すべての時間単位が返されます。
サイズ
 size integer

返品されるアイテムの数量
ユニット参照
 unit_reference string

ISO-8601 タイムスタンプ。メトリックをプルする最新の時刻を示します。 既定は現在の時刻になります。

戻り値

CityMetrics
CityMetrics

定義

組織

名前 パス 型 説明
参照
 references object
名前
 name string
bsds
 bsds array of string
created
 created string
is_active
 is_active boolean
修正日時
 modified string
tier_display_name
 tier_display_name string
tier_family
 tier_family string
層
 tier string
役割
 role string
guid
 guid string

クリック

名前 パス 型 説明
単位
 units integer
unit_reference
 unit_reference string
単位
 unit Unit
link_clicks
 link_clicks array of LinkClicks

CustomBitlinkHistory

名前 パス 型 説明
ハッシュ
 hash string
uuid
 uuid string
keyword
 keyword string
created
 created string
group_guid
 group_guid string
first_created
 first_created string
is_active
 is_active boolean
long_url
 long_url string
deactivated
 deactivated string
bsd
 bsd string
login
 login string

OtherMetrics

名前 パス 型 説明
other_city_clicks
 other_city_clicks integer
no_city_clicks
 no_city_clicks integer

ウェブフックs

名前 パス 型 説明
ウェブフック
 webhooks array of Webhook

組織

名前 パス 型 説明
組織
 organizations array of Organization

LinkClicks

名前 パス 型 説明
date
 date string
clicks
 clicks integer

PlanLimit

名前 パス 型 説明
count
 count integer
limit
 limit integer
名前
 name string
説明
 description string

DeeplinkRule

名前 パス 型 説明
bitlink
 bitlink string
install_url
 install_url string
created
 created string

ISO タイムスタンプ
app_uri_path
 app_uri_path string
修正日時
 modified string

ISO タイムスタンプ
install_type
 install_type string
app_guid
 app_guid string
guid
 guid string
os (オーエス)
 os string
brand_guid
 brand_guid string

キャンペーン

名前 パス 型 説明
参照
 references object
名前
 name string
created
 created string

ISO タイムスタンプ
group_guid
 group_guid string
修正日時
 modified string

ISO タイムスタンプ
created_by
 created_by string
guid
 guid string
説明
 description string

OAuthApp

名前 パス 型 説明
link
 link string
名前
 name string
client_id
 client_id string
説明
 description string

チャネル

名前 パス 型 説明
channels
 channels array of Channel

PlatformLimits

名前 パス 型 説明
platform_limits
 platform_limits array of PlatformLimit

ページ割り付け

名前 パス 型 説明
合計
 total integer
サイズ
 size integer
prev
 prev string
ページ
 page integer
次
 next string

BSDsResponse

名前 パス 型 説明
bsds
 bsds array of string

GroupPreferences

名前 パス 型 説明
group_guid
 group_guid string
domain_preference
 domain_preference string

ClicksSummary

名前 パス 型 説明
単位
 units integer
単位
 unit Unit
total_clicks
 total_clicks integer
unit_reference
 unit_reference string

メール

名前 パス 型 説明
is_primary
 is_primary boolean
is_verified
 is_verified boolean
email
 email string

キャンペーン

名前 パス 型 説明
campaigns
 campaigns array of Campaign
名前 パス 型 説明
long_url
 long_url string
created_at
 created_at string
link
 link string
id
 id string
名前 パス 型 説明
BitlinkBody
 bitlink BitlinkBody
bitlink_history
 bitlink_history array of CustomBitlinkHistory
custom_bitlink
 custom_bitlink string
名前 パス 型 説明
sorted_links
 sorted_links array of ClickLink
links
 links array of BitlinkBody
名前 パス 型 説明
clicks
 clicks integer
id
 id string

PlatformLimit

名前 パス 型 説明
エンドポイント
 endpoint string
方法
 methods array of MethodLimit

メトリック

名前 パス 型 説明
値
 value integer
key
 key string

BitlinkOverridesData

名前 パス 型 説明
total_count
 total_count integer
上書き
 overrides array of BitlinkOverrides

ReferrersByDomains

名前 パス 型 説明
単位
 units integer
Facet2
 facet Facet2
referrers_by_domain
 referrers_by_domain array of ReferrersByDomain
unit_reference
 unit_reference string
単位
 unit string

CityMetric

名前 パス 型 説明
city
 city string
リージョン
 region string
サブリージョン
 subregion string
clicks
 clicks integer
country
 country string

Group

名前 パス 型 説明
参照
 references object
名前
 name string
bsds
 bsds array of string
created
 created string
is_active
 is_active boolean
修正日時
 modified string
organization_guid
 organization_guid string
役割
 role string
guid
 guid string

ShortenBitlinkBody

名前 パス 型 説明
参照
 references object
archived
 archived boolean
タグ
 tags array of string
created_at
 created_at string
deeplinks
 deeplinks array of DeeplinkRule
long_url
 long_url string
custom_bitlinks
 custom_bitlinks array of string
link
 link string
id
 id string
名前 パス 型 説明
ページ区切り
 pagination Pagination
links
 links array of BitlinkBody

タグ

名前 パス 型 説明
タグ
 tags array of string

ウェブフック

名前 パス 型 説明
参照
 references object
状態
 status string
modified_by
 modified_by string
名前
 name string
created
 created string
url
 url string
deactivated
 deactivated string
fetch_tags
 fetch_tags boolean
is_active
 is_active boolean
修正日時
 modified string
organization_guid
 organization_guid string
client_id
 client_id string
group_guid
 group_guid string
client_secret
 client_secret string
oauth_url
 oauth_url string
guid
 guid string
イベント
 event string

GroupClicks

名前 パス 型 説明
単位
 units integer
data
 data array of CountItem
unit_reference
 unit_reference string
単位
 unit string

Groups

名前 パス 型 説明
groups
 groups array of Group

ユーザー

名前 パス 型 説明
default_group_guid
 default_group_guid string
名前
 name string
created
 created string
is_active
 is_active boolean
修正日時
 modified string
is_sso_user
 is_sso_user boolean
is_2fa_enabled
 is_2fa_enabled boolean
login
 login string
emails
 emails array of Email

BulkAddResponse

名前 パス 型 説明
メッセージ
 message string
Data1
 data Data1

BitlinkQR

名前 パス 型 説明
qr_code
 qr_code string

QR コード画像のデータ URI
link
 link string
id
 id string

CityMetrics

名前 パス 型 説明
単位
 units integer
Facet1
 facet Facet1
unit_reference
 unit_reference string
単位
 unit string
メトリック
 metrics array of CityMetric
OtherMetrics
 other_metrics OtherMetrics

BulkUpdate

名前 パス 型 説明
links
 links array of string

MethodLimit

名前 パス 型 説明
count
 count integer
limit
 limit integer
名前
 name string

DeviceMetrics

名前 パス 型 説明
単位
 units integer
Facet1
 facet Facet1
unit_reference
 unit_reference string
単位
 unit string
メトリック
 metrics array of DeviceMetric

BitlinkBody

名前 パス 型 説明
参照
 references object
archived
 archived boolean
タグ
 tags array of string
created_at
 created_at string
肩書き
 title string
deeplinks
 deeplinks array of DeeplinkRule
created_by
 created_by string
long_url
 long_url string
client_id
 client_id string
custom_bitlinks
 custom_bitlinks array of string
link
 link string
launchpad_ids
 launchpad_ids array of string
id
 id string

ClickMetrics

名前 パス 型 説明
単位
 units integer
Facet1
 facet Facet1
unit_reference
 unit_reference string
単位
 unit string
メトリック
 metrics array of ClickMetric

チャネル

名前 パス 型 説明
group_guid
 group_guid string
guid
 guid string
名前
 name string
修正日時
 modified string

ISO_TIMESTAMP
created
 created string

ISO タイムスタンプ
参照
 references object

DeviceMetric

名前 パス 型 説明
clicks
 clicks integer
device_type
 device_type string

メトリック

名前 パス 型 説明
単位
 units integer
Facet1
 facet Facet1
unit_reference
 unit_reference string
単位
 unit string
メトリック
 metrics array of Metric

ClickMetric

名前 パス 型 説明
clicks
 clicks integer
値
 value string

CountItem

名前 パス 型 説明
count
 count integer
ts
 ts string

ReferrersByDomain

名前 パス 型 説明
referrers
 referrers array of Metric
ネットワーク
 network string

PlanLimits

名前 パス 型 説明
参照
 references object
organization_guid
 organization_guid string
plan_limits
 plan_limits array of PlanLimit

BitlinkOverrides

名前 パス 型 説明
参照
 references object
created
 created string
ルール
 rules string
group_guid
 group_guid string
修正日時
 modified string
バージョン
 version integer
link
 link string

使用する Bitly リンクであるオーバーライドへの完全修飾 URL。 例: https://foo.com/bar
id
 id string

Data1

名前 パス 型 説明
link_save_failures
 link_save_failures integer
keyword_failures
 keyword_failures integer
結果
 results array of string
成功
 successes integer
channel_bitlink_failures
 channel_bitlink_failures integer
csv_format_failures
 csv_format_failures integer

Facet1

Facet1
string

Facet2

Facet2
string

単位

単位
string