リンク
備考
エキスパートレベル
APIキーは、リクエストのAuthorizationヘッダーのBearerトークンとして送信されなければならない。 APIキーを取得する.
リスト
APIエンドポイント:
GET
https://goo.vc/api/v1/links?ja
リクエスト例:
curl --location --request GET 'https://goo.vc/api/v1/links?ja' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
パラメータ
タイプ
説明
searchオプション string
検索クエリ。
search_byオプション string
で検索. 可能な値は以下の通り：000タイトル用, 000別名用, 000URL用. デフォルトは
title.statusオプション integer
ステータスで絞り込む。 可能な値は以下の通り：000すべて用, 000アクティブ用, 000期限切れ用, 000無効用. デフォルトは
0.space_idオプション integer
スペースIDで絞り込む。
domain_idオプション integer
ドメインIDでフィルタリングする。
pixel_idオプション integer
ピクセルIDでフィルタリングする。
sort_byオプション string
並べ替え. 可能な値は以下の通り：000作成日用, 000クリック用, 000タイトル用, 000別名用, 000URL用. デフォルトは
id.sortオプション string
ソート. 可能な値は以下の通り：000下降用, 000上昇用. デフォルトは
desc.per_pageオプション integer
ページあたりの結果. 可能な値は以下の通り：
10, 25, 50, 100. デフォルトは10.ショー
APIエンドポイント:
GET
https://goo.vc/api/v1/links/{id}?ja
リクエスト例:
curl --location --request GET 'https://goo.vc/api/v1/links/{id}?ja' \ --header 'Accept: application/json' \ --header 'Authorization: Bearer {api_key}'
店舗
APIエンドポイント:
POST
https://goo.vc/api/v1/links?ja
リクエスト例:
curl --location --request POST 'https://goo.vc/api/v1/links?ja' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Bearer {api_key}' \ --data-urlencode 'url={url}' \ --data-urlencode 'domain={id}'
パラメータ
タイプ
説明
url必須 string
短縮されるリンク。
domain_id必須 integer
リンクを保存するドメインID。
aliasオプション string
リンクの別名。
passwordオプション string
リンクのパスワード。
space_idオプション integer
保存するリンクのスペースID。
pixel_idsオプション array
The pixel IDs to be integrated in the link.
disabledオプション integer
リンクが無効かどうか。 可能な値は以下の通り：000アクティブ用, 000無効用. デフォルトは
0.privacyオプション integer
リンクの統計が公開されているかどうか。 可能な値は以下の通り：000パブリック用, 000プライベート用, 000パスワード用. デフォルトは
0.privacy_passwordオプション string
統計ページのパスワード。 000__を
2に設定した場合のみ機能する。expiration_urlオプション string
リンクの有効期限が切れると、ユーザーがリダイレクトされるリンク。
expiration_dateオプション string
リンクの有効期限を
YYYY-MM-DD フォーマットで指定します。expiration_timeオプション string
000__フォーマットのリンク有効期限。
expiration_clicksオプション integer
リンクの有効期限が切れるまでのクリック数。
target_typeオプション integer
ターゲットの種類。 可能な値は以下の通り：000なし用, 000地理的用, 000プラットフォーム用, 000ローテーション用.
country[index][value]オプション string
ユーザーがリダイレクトされるリンク。
platform[index][key]オプション string
対象となるプラットフォームの名前。 可能な値は以下の通り：
iOS, Android, Windows, OS X, Linux, Ubuntu, Chrome OS.platform[index][value]オプション string
ユーザーがリダイレクトされるリンク。
language[index][value]オプション string
ユーザーがリダイレクトされるリンク。
rotation[index][value]オプション string
ユーザーがリダイレクトされるリンク。
更新
APIエンドポイント:
PUT PATCH
https://goo.vc/api/v1/links/{id}?ja
リクエスト例:
curl --location --request PUT 'https://goo.vc/api/v1/links/{id}?ja' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Bearer {api_key}' \ --data-urlencode 'url={url}'
パラメータ
タイプ
説明
urlオプション string
短縮されるリンク。
aliasオプション string
リンクの別名。
passwordオプション string
リンクのパスワード。
space_idオプション integer
保存するリンクのスペースID。
pixel_idsオプション array
The pixel IDs to be integrated in the link.
disabledオプション integer
リンクが無効かどうか。 可能な値は以下の通り：000アクティブ用, 000無効用.
privacyオプション integer
リンクの統計が公開されているかどうか。 可能な値は以下の通り：000パブリック用, 000プライベート用, 000パスワード用.
privacy_passwordオプション string
統計ページのパスワード。 000__を
2に設定した場合のみ機能する。expiration_urlオプション string
リンクの有効期限が切れると、ユーザーがリダイレクトされるリンク。
expiration_dateオプション string
リンクの有効期限を
YYYY-MM-DD フォーマットで指定します。expiration_timeオプション string
000__フォーマットのリンク有効期限。
expiration_clicksオプション integer
リンクの有効期限が切れるまでのクリック数。
target_typeオプション integer
ターゲットの種類。 可能な値は以下の通り：000なし用, 000地理的用, 000プラットフォーム用, 000ローテーション用.
country[index][value]オプション string
ユーザーがリダイレクトされるリンク。
platform[index][key]オプション string
対象となるプラットフォームの名前。 可能な値は以下の通り：
iOS, Android, Windows, OS X, Linux, Ubuntu, Chrome OS.platform[index][value]オプション string
ユーザーがリダイレクトされるリンク。
language[index][value]オプション string
ユーザーがリダイレクトされるリンク。
rotation[index][value]オプション string
ユーザーがリダイレクトされるリンク。
削除
APIエンドポイント:
DELETE
https://goo.vc/api/v1/links/{id}?ja
リクエスト例:
curl --location --request DELETE 'https://goo.vc/api/v1/links/{id}?ja' \ --header 'Authorization: Bearer {api_key}'
