QRコードジェネレーターAPIを使用して、さまざまなフォーマット(PNG、SVG、EPSなど)やスタイルでレンダリングされるディープリンクのQRコードを生成します。ディープリンクパラメーターを通じてリンクの動作を定義し、QRコードの外観をカスタマイズできます。
事前準備
QRコードジェネレーターを使用する前に、以下をご確認ください。
要件
- 全てのディープリンクジェネレーターAPIの前提条件は、QRコードジェネレーターAPIにも適用されます。
- リンク生成ペイロードプロトコルを使用して、有効なペイロードを提供する必要があります。
レスポンスヘッダー
それぞれの正常なレスポンスには、生成された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
サポート対象の形式: SVG
、PNG
、 EPS
リクエストボディ:
パラメーター | データタイプ |
---|---|
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
サポート対象の形式: SVG
、PNG
、 EPS
リクエストボディ:
パラメーター | データタイプ |
---|---|
data* | リンク生成ペイロード |
qr_code_params* | QRコードの設定 |
レスポンス: バイトストリーム(バイナリーPNGまたはEPSデータなど)
例
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_code_params
に、以下のいずれかを使用してください。
フィールド | 種類 | 説明 |
---|---|---|
file_type * | string | 出力フォーマット。次のいずれかを使用:png 、eps 、 svg |
error_correction | string | QRコードエラー修正レベル:low 、medium 、high 、quartile 。デフォルト:medium 。 |
version | int | null | サイズの指定(1〜40)。自動サイズ変更にはnull とfit: true を使用します。 |
fit | boolean | コンテンツに合わせてバージョンを自動的に調整。デフォルトはtrue です。 |
box_size | int | ピクセル単位の各ボックスのサイズ。デフォルトは10 です。 |
border | int | ボックスの枠の幅。デフォルトは4 です。 |
fill_color | string | RGB、16進数、または指定された色形式(例:rgb(0,0,0) 、#000000 、"black" )によるQRコードの色。 |
back_color | string | RGB、16進数、または指定された色形式(例:rgb(255,255,255) 、#FFFFFF 、"white" )による背景色。 |
style | object | スタイル設定(下記を参照)。 |
スタイルパラメーター
名前 | 追加パラメーター | サポート対象の形式 | 説明 |
---|---|---|---|
default | - | svg 、png 、 eps | 標準の四角形モジュール |
gapped | size_ratio (デフォルトは0.8 ) | svg 、png 、 eps | モジュールサイズを縮小してギャップを作成 |
circle | size_ratio (デフォルトは0.8 ) | svg 、png 、 eps | 円形モジュールをレンダリング |
rounded | - | png 、 eps | 角丸を使用 |
vertical_bars | - | png 、 eps | 縦棒型のモジュール |
horizontal_bars | - | png 、 eps | 横棒型のモジュール |