URL リダイレクトには、ソース URL、ターゲット URL、ステータスコード、および URL 一致と実行時の動作に影響する追加パラメーターがあります。
API フィールド: source_url String
リダイレクトを適用するには、受信リクエストの URL がこの URL 文字列に一致する必要があります。このプロパティは必須です。ソース URL の最大長は 32 KB です。
値は有効な URL である必要があります。ただし URL スキーム(https など)は必須ではありません。スキームを省略すると、http と https の両方にリダイレクトが適用されます。
1 つの Bulk Redirect List に、まったく同じソース URL の URL リダイレクトを複数含められません。 受信リクエストとリダイレクトのソース URL を照合する URL マッチングアルゴリズム の正確な動作は、サブドメインを含める と サブパスマッチング の値によって決まります。
対応している URL コンポーネントの詳細は、Bulk Redirects で使える URL コンポーネント を参照してください。
API フィールド: target_url String
URL リダイレクトが一致したときに、クライアントを転送する先の URL です。このプロパティは必須です。ターゲット URL の最大長は 32 KB です。
値は有効な URL である必要があります。最終的なターゲット URL は、クエリ文字列を保持 と パスサフィックスを保持 の値によって決まります。
対応している URL コンポーネントの詳細は、Bulk Redirects で使える URL コンポーネント を参照してください。
API フィールド: subpath_matching Boolean default: false
true の場合、現在の URL リダイレクトに一致するかを判定するとき、リクエスト URL にサブパスマッチングアルゴリズムを適用します。
たとえば、/my-folder/ から /other-folder/ への URL リダイレクトで サブパスマッチング を有効にすると、/my-folder/item へのリクエストも /other-folder/item へリダイレクトします。ただし、item 部分が含まれるのは パスサフィックスを保持 が true のときだけです。
詳細は リダイレクトのソース URL の一致 を参照してください。
API フィールド: include_subdomains Boolean default: false
true の場合、ソース URL のホスト名はサブドメインにも適用されます。ソース URL のドメイン部分の左側にあるすべてのサブドメインと、指定したドメイン自体にリダイレクトが一致します。
たとえば、ソース URL を http://example.com/about としたリダイレクトは、http://a.example.com/about や http://a.b.example.com/about のリクエストにも適用されます。
詳細は リダイレクトのソース URL の一致 を参照してください。
API フィールド: preserve_query_string Boolean default: false
true の場合、リダイレクト URL は元のリクエストのクエリ文字列を保持します。
たとえば、/my-folder/ から /other-folder/ への URL リダイレクトで クエリ文字列を保持 を有効にすると、/my-folder/?name=value のリクエストは /other-folder/?name=value へリダイレクトされます。クエリ文字列を保持 が無効の場合、同じリクエストは /other-folder/ へリダイレクトされます。
API フィールド: preserve_path_suffix Boolean default: true
サブパスマッチング が有効なときだけ使えます。true の場合、ソース URL のうち一致しなかった残りのパス要素(ある場合)をリダイレクト URL に含めます。
たとえば、サブパスマッチング と パスサフィックスを保持 の両方が有効なとき、/my-folder/ から /another-folder/ への URL リダイレクトは、/my-folder/foo の受信リクエストを /another-folder/foo へリダイレクトします。パスサフィックスを保持 が無効でも同じリクエストは一致しますが、リダイレクト先は /another-folder/ になります。
API フィールド: status_code Integer default: 301
API の値: 301、302、307、または 308。
リダイレクト時にクライアントへ返す HTTP ステータスコードです。
- 301 - Permanent Redirect: ページが新しいアドレスへ恒久的に移動しました。
POSTリクエストでは、リダイレクトをたどるときにクライアントまたはブラウザーが HTTP メソッドをGETに切り替えることがあります。 - 302 - Temporary Redirect: ページが新しいアドレスへ一時的に移動しました。
POSTリクエストでは、リダイレクトをたどるときにクライアントまたはブラウザーが HTTP メソッドをGETに切り替えることがあります。 - 307 - Advanced: Temporary, HTTP method preserved: ページが新しいアドレスへ一時的に移動しました。リダイレクトをたどるとき、クライアントまたはブラウザーは元の HTTP メソッド(例:
POST)を維持する必要があります。 - 308 - Advanced: Permanent, HTTP method preserved: ページが新しいアドレスへ恒久的に移動しました。リダイレクトをたどるとき、クライアントまたはブラウザーは元の HTTP メソッド(例:
POST)を維持する必要があります。