ドメインを更新する

パラメーター

trackingHoststring | null

トラッキングリンクと開封ピクセルに使うサブドメイン。最大 512 文字です。トリムして小文字化され、先頭の `https://` や `http://`、パス、末尾のドットはチェック前に取り除かれます。新しい値は現在のトラッキングドメインを置き換え、現在の値を送るとチェックを再実行し、`null` または空文字列は削除、フィールドを省略すればそのままです。

storageHoststring | null

ファイルのダウンロードリンクに使うサブドメイン。同じように整形され、同じ 512 文字の制限が適用されます。新しい値は現在のファイルドメインを置き換え、現在の値を送るとチェックを再実行し、`null` または空文字列は削除、フィールドを省略すればそのままです。

hoststring | null

トラッキングドメイン。設定がない場合は null。

status'none' | 'pending' | 'active' | 'failed'

`none` はトラッキングドメインが設定されていないことを意味します。`pending` は設定済みだがチェックにまだ一度も通っていないこと、`active` は新しいメールがそれを使っていること、`failed` は以前チェックに通ったが現在は使われなくなったことを意味します。

activeboolean

`status` が `active` のときだけ true になります。すなわち、そのドメインからの新しいメールのトラッキングリンクと開封ピクセルがそのホストを使っている状態です。

targetstring

CNAME レコードが指すアドレスで、このトラッキングドメイン専用に用意されたものです。`host` が null の間、および新しいホスト用のアドレスを準備中の間は空文字列になります。

record{ type: 'CNAME'; name: string; value: string } | null

公開すべきレコード。名前は `host`、値は `target` です。トラッキングドメインがない場合、および新しいホスト用のアドレスを準備中の場合は null になります。

checkedAtstring | null

ホストが最後にチェックされた日時（ISO-8601）。最初のチェックまでは null です。

verifiedAtstring | null

最後にチェックに通った日時（ISO-8601）。一度も通っていないホストでは null です。

errorstring | null

直近のチェックで判明したことを、ドメイン所有者が対処できる言葉で示します。直近のチェックに通った場合、またはまだ一度も実行されていない場合は null です。1〜2 回チェックに失敗したホストはまだ `active` のままで、その理由がここに入ります。

hoststring | null

ファイルドメイン。設定がない場合は null。

status'none' | 'pending' | 'active' | 'failed'

`none` はファイルドメインが設定されていないことを意味します。`pending` は設定済みだがチェックにまだ一度も通っていないこと、`active` は新しいメールがそれを使っていること、`failed` は以前チェックに通ったが現在は使われなくなったことを意味します。

activeboolean

`status` が `active` のときだけ true になります。すなわち、そのドメインから送られたファイルのダウンロードリンクがそのホストを使っている状態です。

targetstring

CNAME レコードが指すアドレスで、このファイルドメイン専用に用意されたものです。`host` が null の間、および新しいホスト用のアドレスを準備中の間は空文字列になります。

record{ type: 'CNAME'; name: string; value: string } | null

公開すべきレコード。名前は `host`、値は `target` です。ファイルドメインがない場合、および新しいホスト用のアドレスを準備中の場合は null になります。

checkedAtstring | null

ホストが最後にチェックされた日時（ISO-8601）。最初のチェックまでは null です。

verifiedAtstring | null

最後にチェックに通った日時（ISO-8601）。一度も通っていないホストでは null です。

errorstring | null

直近のチェックで判明したことを、ドメイン所有者が対処できる言葉で示します。直近のチェックに通った場合、またはまだ一度も実行されていない場合は null です。1〜2 回チェックに失敗したホストはまだ `active` のままで、その理由がここに入ります。