OfficeScript package

インターフェイス

OfficeScript.EmailAttachment	電子メールで送信する添付ファイル。 to 、cc、または bcc パラメーターの少なくとも 1 つに値を指定する必要があります。 受信者が指定されていない場合は、次のエラーが表示されます。 少なくとも 1 つの "to"、"cc"、または "bcc" パラメーターの値を入力してください。
OfficeScript.FileProperties	ダウンロードするファイル。
OfficeScript.MailProperties	送信する電子メールのプロパティ。

列挙型

OfficeScript.EmailContentType	コンテンツの種類。 指定できる値はテキストまたは HTML です。
OfficeScript.EmailImportance	電子メールの重要度の値。 Outlook UI で使用できる "高"、"標準"、および "低" の重要度の値に対応します。

関数

OfficeScript.convertToPdf()	ドキュメントを PDF に変換し、そのテキスト エンコードを返します。 注: Excel on the webのブックに加えられた最近の変更は、Office スクリプトまたは Excel UI を使用して PDF にキャプチャされない場合があります。
OfficeScript.downloadFile(fileProperties)	指定したファイルを、ローカル コンピューターで指定された既定のダウンロード場所にダウンロードします。
OfficeScript.Metadata.getScriptName()	現在実行中のスクリプトの名前を取得します。
OfficeScript.saveCopyAs(filename)	指定したファイル名を持つ元のファイルと同じディレクトリに、現在のブックのコピーを OneDrive に保存します。
OfficeScript.sendMail(mailProperties)	Office スクリプトを使用してメールを送信する。 MailPropertiesを使用して、メールの内容と受信者を指定します。

関数の詳細

OfficeScript.convertToPdf()

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

ドキュメントを PDF に変換し、そのテキスト エンコードを返します。 注: Excel on the webのブックに加えられた最近の変更は、Office スクリプトまたは Excel UI を使用して PDF にキャプチャされない場合があります。

export function convertToPdf(): string;

戻り値

string

PDF 形式の文字列としてのブックの内容。

スロー: ConvertToPdfEmptyWorkbook ドキュメントが空の場合にスローされるエラー。

スロー: ConvertToPdfProtectedWorkbook ドキュメントが保護されている場合にスローされるエラー。

スロー: ExternalApiTimeout API がタイムアウト制限の 30 秒に達した場合にスローされるエラー。

例

/**
 * This script saves a worksheet as a PDF and emails that PDF to a recipient.
 */
function main(workbook: ExcelScript.Workbook) {    
    // Create the PDF.
    const pdfObject = OfficeScript.convertToPdf();
    const pdfFile = { name: "report.pdf", content: pdfObject }; // Enter your desired PDF name here.

    // Email the PDF.
    OfficeScript.sendMail({
        to: "name@email.com", // Enter your recipient email address here.
        subject: "[Demo] Monthly Sales Report", // This is the subject of your email.
        content: "Here's the Monthly Sales Report", // This is the content within your email.
        attachments: [pdfFile]
    })    
}

OfficeScript.downloadFile(fileProperties)

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

指定したファイルを、ローカル コンピューターで指定された既定のダウンロード場所にダウンロードします。

export function downloadFile(fileProperties: FileProperties): void;

パラメーター

fileProperties

OfficeScript.FileProperties

ダウンロードするファイル。

スロー: DownloadFileNameMissing 名前が空の場合にスローされるエラー。

スロー: DownloadFileContentMissing コンテンツが空の場合にスローされるエラー。

スロー: DownloadFileInvalidExtension ファイル名拡張子が ".txt" または ".pdf" でない場合にスローされるエラー。

スロー: ExternalApiTimeout API がタイムアウト制限の 30 秒に達した場合にスローされるエラー。

戻り値

void

OfficeScript.Metadata.getScriptName()

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

現在実行中のスクリプトの名前を取得します。

export function getScriptName(): string;

戻り値

string

OfficeScript.saveCopyAs(filename)

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

指定したファイル名を持つ元のファイルと同じディレクトリに、現在のブックのコピーを OneDrive に保存します。

export function saveCopyAs(filename: string): void;

パラメーター

filename

string

コピーおよび保存されたファイルのファイル名。 ファイル名は".xlsx" で終わる必要があります。

スロー: InvalidExtensionError ファイル名が ".xlsx" で終わらない場合にスローされるエラー。

スロー: SaveCopyAsFileMayAlreadyExistError コピーのファイル名が既に存在する場合にスローされるエラー。

スロー: SaveCopyAsErrorInvalidCharacters ファイル名に無効な文字が含まれている場合にスローされるエラー。

スロー: SaveCopyAsFileNotOnOneDriveError ドキュメントが OneDrive に保存されていない場合にスローされるエラー。

スロー: ExternalApiTimeout API がタイムアウト制限の 30 秒に達した場合にスローされるエラー。 コピーは引き続き作成される可能性があることに注意してください。

戻り値

void

OfficeScript.sendMail(mailProperties)

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

Office スクリプトを使用してメールを送信する。 MailPropertiesを使用して、メールの内容と受信者を指定します。

export function sendMail(mailProperties: MailProperties): void;

パラメーター

mailProperties

OfficeScript.MailProperties

戻り値

void