adjust-icon

QRコードジェネレーターAPI

QRコードジェネレーターAPIを使用して、さまざまなフォーマット(PNG、SVG、EPSなど)やスタイルでレンダリングされるディープリンクのQRコードを生成します。ディープリンクパラメーターを通じてリンクの動作を定義し、QRコードの外観をカスタマイズできます。

事前準備

QRコードジェネレーターを使用する前に、以下をご確認ください。

要件

レスポンスヘッダー

それぞれの正常なレスポンスには、生成されたQRコード内でエンコードされたディープリンクを示すヘッダーが含まれます。

レスポンスヘッダー
X-QR-Code-URL: https://example.go.link/fryYl

QRコードをURIとして生成

このエンドポイントを使用してQRコードを生成し、HTMLの<img>タグへの直接埋め込みに適したURIエンコードファイルとして受信します。 高速で即時にダウンロードすることが重要でない場合は、低スループットを推奨します。

APIプロトコル

エンドポイント: https://automate.adjust.com/engage/qr-code/uri

メソッド: POST

サポート対象の形式: SVGPNGEPS

リクエストボディ:

パラメーターデータタイプ
data*リンク生成ペイロード
qr_code_params*QRコードの設定

レスポンス: ファイルのコンテンツに含まれるtext/plainタイプのロー文字列のレスポンス

QRコードをSVGとして生成

このエンドポイントを使用して、SVG形式でQRコードを生成し、印刷またはWebでの使用に適したサイズ変更と編集が可能な出力を提供します。

APIプロトコル

エンドポイント: https://automate.adjust.com/engage/qr-code/svg

メソッド: POST

サポート対象の形式: SVG

リクエストボディ:

パラメーターデータタイプ
data*リンク生成ペイロード
qr_code_params*QRコードの設定

レスポンス: ファイルのコンテンツに含まれるimage/svg+xmlタイプのロー文字列のレスポンス

QRコードをバイトストリームとして生成

このエンドポイントを使用して、QRコードをバイナリーファイルストリームとして生成します。これは、迅速なアクセスが不可欠な負荷の高いシステムに最適です。例えば、自社のCDNやストレージにファイルを保存して配信を最適化する場合などです。

APIプロトコル

エンドポイント: https://automate.adjust.com/engage/qr-code/stream

メソッド: POST

サポート対象の形式: SVGPNGEPS

リクエストボディ:

パラメーターデータタイプ
data*リンク生成ペイロード
qr_code_params*QRコードの設定

レスポンス: バイトストリーム(バイナリーPNGまたはEPSデータなど)

リクエスト - cURL
curl -o $HOME/Downloads/png_custom_test.png --location https://automate.adjust.com/engage/qr-code/stream \
--header 'Authorization: Bearer adjustApiToken' \
--header 'Content-Type: application/json' \
--data '{
"data": {
"link_token": "1k4hnyz7",
"redirect": "https://youtu.be/AyOqGRjVtls",
"fallback": "https://youtu.be/AyOqGRjVtls",
"deeplink_path": "/custom-path"
},
"qr_code_params": {
"file_type": "png",
"error_correction": "quartile",
"box_size": 12,
"border": 2,
"fill_color": "rgba(132, 51, 92, 0.74)",
"back_color": "rgba(247, 108, 180, 0.8)",
"style": {"name": "gapped", "size_ratio": "0.85"}
}
}'

結果: QRコードの例

データモデル

QRコードパラメーター

リクエストボディ内のqr_code_paramsに、以下のいずれかを使用してください。

フィールド種類説明
file_type*string出力フォーマット。次のいずれかを使用:pngepssvg
error_correctionstringQRコードエラー修正レベル:lowmediumhighquartile。デフォルト:medium
versionint | nullサイズの指定(1〜40)。自動サイズ変更にはnullfit: trueを使用します。
fitbooleanコンテンツに合わせてバージョンを自動的に調整。デフォルトはtrueです。
box_sizeintピクセル単位の各ボックスのサイズ。デフォルトは10です。
borderintボックスの枠の幅。デフォルトは4です。
fill_colorstringRGB、16進数、または指定された色形式(例:rgb(0,0,0)#000000"black")によるQRコードの色。
back_colorstringRGB、16進数、または指定された色形式(例:rgb(255,255,255)#FFFFFF"white")による背景色。
styleobjectスタイル設定(下記を参照)。

スタイルパラメーター

名前追加パラメーターサポート対象の形式説明
default-svgpngeps標準の四角形モジュール
gappedsize_ratio (デフォルトは0.8svgpngepsモジュールサイズを縮小してギャップを作成
circlesize_ratio (デフォルトは0.8svgpngeps円形モジュールをレンダリング
rounded-pngeps角丸を使用
vertical_bars-pngeps縦棒型のモジュール
horizontal_bars-pngeps横棒型のモジュール