PDFのフッター

PDF フッターセクションに画像やテキストを追加すると、ドキュメントにブランド情報や法的情報を追加するなど、さまざまなシナリオで役立ちます。多くの業界では、ドキュメントの各ページの下部に会社のロゴや免責事項を追加することが一般的な要件となっています。また、ドキュメントを整理したり識別したりするために、ページ番号やその他のメタデータを追加する必要がある場合もあります。具体的なユースケースに関係なく、PDF ドキュメントのフッターセクションに画像やテキストを追加する機能は、多くの企業や組織にとって重要な機能です。この記事では、Python Cloud SDK を使用して PDF ドキュメントのフッターセクションに画像やテキストを追加する方法について説明します。

フッターに使用される別の用語は「ランニング フット」と呼ばれます。これは出版業界でよく使用され、記事の短縮版や記事に関するその他の情報が含まれることからこのように呼ばれています。

Python クラウド SDK

Aspose.PDF Cloud SDK for Python は、PDF ドキュメントのフッター セクションに画像やテキストを追加する機能など、PDF ドキュメントを操作するための強力な機能を提供します。この SDK は、さまざまな PDF 関連のタスクをプログラムで簡単に実行できるシンプルで直感的なインターフェイスを提供します。この SDK を使用すると、任意の PDF ドキュメントのフッターにカスタム テキストや画像をすばやく簡単に追加して、ドキュメントにプロフェッショナルでカスタマイズされた外観を与えることができます。

SDKはPIPおよびGitHubリポジトリからダウンロードできます。ただし、ターミナル/コマンドプロンプトで次のコマンドを実行するだけで、最新バージョンのSDKをシステムにインストールできます。

pip install asposepdfcloud

次の重要なステップは、クラウドダッシュボードからクライアントの資格情報を取得することです。GitHubまたはGoogleアカウントをお持ちの場合は、サインアップするか、新しいアカウントの作成ボタンをクリックして必要な情報を入力します。

クライアントの資格情報

画像 1: Aspose.Cloud ダッシュボード上のクライアント資格情報。

Python コード スニペットを使用して PDF ドキュメントにテキスト フッターを追加するには、以下の手順に従ってください。

  • 最初のステップは、引数としてクライアント ID とクライアント シークレットを必要とする ApiClient クラスのインスタンスを作成することです。
  • 次に、入力引数として ApiClient オブジェクトを必要とする PdfApi クラスのインスタンスを作成します。
  • 3 番目に、水平方向の配置を Center、不透明度を 0.7、回転角度を 356、下余白を 5 に指定した TextFooter オブジェクトを作成します。
  • TextFooter のテキスト書式を設定するには、前景色、フォント サイズ、フォント名などを定義する TextState のオブジェクトを作成します。
  • ここで、テキスト フッターを配置するために、PDF ドキュメントの開始ページと終了ページを定義する 2 つのオプション パラメーターの値を設定する必要があります。
  • 最後に、postdocumenttextfooter(..) メソッドを呼び出して PDF ドキュメントにテキスト フッターを追加し、結果のファイルをクラウド ストレージに保存します。
def addTextFooter():
    try:
        #Client credentials
        client_secret = "1c9379bb7d701c26cc87e741a29987bb"
        client_id = "bbf94a2c-6d7e-4020-b4d2-b9809741374e"

        #initialize PdfApi client instance using client credetials
        pdf_api_client = asposepdfcloud.api_client.ApiClient(client_secret, client_id)

        # PdfApiClient を引数として渡しながら PdfApi インスタンスを作成します。
        pdf_api = PdfApi(pdf_api_client)

        # 入力PDFファイル
        input_file = 'marketing.pdf'

        # TextFooterインスタンスを作成する
        textFooter = asposepdfcloud.TextFooter()
        textFooter.background = True
        # フッターの水平方向の配置を中央に設定する
        textFooter.horizontal_alignment = 'Center'
        # フッターの不透明度を0.7に設定する
        textFooter.opacity = 0.7
        textFooter.rotate = None
        # 回転角度を5度に設定する
        textFooter.rotate_angle = 5
        textFooter.x_indent = 100
        textFooter.y_indent = 100
        textFooter.zoom = .8
        # フッターセクションに表示されるテキスト値
        textFooter.value = 'Aspose.PDF Cloud SDK for Python'

        # テキストの書式を定義する TextState のインスタンスを作成する
        textState = asposepdfcloud.TextState(font_size=15, font='Arial', foreground_color=
              {"A": 0,
              "R": 66,
              "G": 111,
              "B": 245},
              background_color= {
              "A": 10,
              "R": 179,
              "G": 245,
              "B": 66},
              font_style=1)
        # TextStateオブジェクトをTextFooterに割り当てる
        textFooter.text_state = textState
        
        # フッターのPDFの開始ページ
        startPage = 2
        # フッターのPDFの最終ページ
        endPage = 3

        # APIを呼び出して、PDFファイルの2ページ目と3ページ目にテキストフッターを追加します。
        response = pdf_api.post_document_text_footer(name = input_file, text_footer= textFooter, start_page_number = startPage, end_page_number=endPage)
        
        # コンソールに応答コードを出力する
        print(response)
        
        # コンソールにメッセージを出力する(オプション)
        print('Text Footer successfully added to PDF !')    
    except ApiException as e:
        print("Exception while calling PdfApi: {0}".format(e))
        print("Code:" + str(e.code))
        print("Message:" + e.message)
テキストフッターのプレビュー

画像 2: PDF に追加された TextFooter のプレビュー。

入力marketing.pdfと結果のmarketing-TextFooter.pdfをダウンロードするには、次のリンクにアクセスしてください。

API は、PDF ファイルにイメージ フッターを追加する機能も提供します。この要件を満たすには、以下の手順に従ってください。

  • 最初のステップは、引数としてクライアント ID とクライアント シークレットを必要とする ApiClient クラスのインスタンスを作成することです。
  • 次に、入力引数として ApiClient オブジェクトを必要とする PdfApi クラスのインスタンスを作成します。
  • 3 番目に、水平方向の配置を Center、不透明度を 0.7、回転角度を 10 に設定し、画像ファイル名、余白の詳細、その他のプロパティを指定した ImageFooter オブジェクトを作成します。
  • フッターはドキュメントの最初のページに追加するだけでよいため、オプション パラメータの startpagenumber と endpagenumber の値を設定しました。
  • 最後に、postdocumentimagefooter(..) メソッドを呼び出して PDF ドキュメントにテキスト フッターを追加し、結果のファイルをクラウド ストレージに保存します。
def addImageFooter():
    try:
        #Client credentials
        client_secret = "1c9379bb7d701c26cc87e741a29987bb"
        client_id = "bbf94a2c-6d7e-4020-b4d2-b9809741374e"

        #initialize PdfApi client instance using client credetials
        pdf_api_client = asposepdfcloud.api_client.ApiClient(client_secret, client_id)

        # PdfApiClient を引数として渡しながら PdfApi インスタンスを作成します。
        pdf_api = PdfApi(pdf_api_client)

        # 入力PDF文書
        input_file = 'marketing.pdf'
        
        # ImageFooterインスタンスを作成する
        imageFooter = asposepdfcloud.ImageFooter()
        
        # PDFコンテンツの上にヘッダーをレンダリングする
        imageFooter.background = False
        # 配置を左に設定する
        imageFooter.horizontal_alignment = 'Left'
        # 不透明度を70%に設定する
        imageFooter.opacity = 0.7
        imageFooter.rotate = None
        imageFooter.rotate_angle = 10
        imageFooter.x_indent = 10
        imageFooter.y_indent = 10
        imageFooter.zoom = .7
        
        # 入力画像ファイル
        imageFooter.file_name = 'Koala.jpg'
        # 画像の幅と高さの詳細を設定する
        imageFooter.width = 100
        imageFooter.height = 100
        # フッター画像の余白の詳細を指定する
        imageFooter.bottom_margin = 2
        imageFooter.left_margin = 1
        imageFooter.right_margin = 10

        # フッターを追加するドキュメントの開始ページ
        startPage = 1
        # フッターを追加するドキュメントの開始ページ
        endPage = 1

        # PDF ファイルの画像フッターをレンダリングするための API を呼び出す
        response = pdf_api.post_document_image_footer(name = input_file, image_footer= imageFooter, start_page_number = startPage, end_page_number=endPage)
        
        # コンソールに応答コードを出力する
        print(response)
        
        # コンソールにメッセージを出力する(オプション)
        print('Image Footer successfully added to PDF !')    
    except ApiException as e:
        print("Exception while calling PdfApi: {0}".format(e))
        print("Code:" + str(e.code))
        print("Message:" + e.message)
PDF の画像フッター

画像 3: PDF での画像フッターのプレビュー。

上記の例で生成された結果ファイルは、marketing-ImageFooter.pdfからダウンロードできます。

cURL コマンドと Aspose.PDF Cloud を使用して PDF フッターにテキストと画像を追加すると、いくつかの利点があります。まず、時間がかかり、エラーが発生しやすい PDF ドキュメントの手動編集が不要になります。次に、ヘッダー テキストのフォント、サイズ、色、位置を変更できるため、ヘッダー テキストを簡単にカスタマイズできます。3 つ目に、複数の PDF ドキュメントに同時にテキストを追加できるため、時間が節約され、効率が向上します。最後に、このアプローチでは、すべてのデータが安全な接続を介して送信され、安全なサーバーで処理されるため、PDF ヘッダーにテキストを追加するための安全で信頼性の高い方法が提供されます。

ここで、前提条件として、次のコマンドを実行して JSON Web Token (JWT) を生成します。

curl -v "https://api.aspose.cloud/connect/token" \
-X POST \
-d "grant_type=client_credentials&client_id=88d1cda8-b12c-4a80-b1ad-c85ac483c5c5&client_secret=406b404b2df649611e508bbcfcd2a77f" \
-H "Content-Type: application/x-www-form-urlencoded" \
-H "Accept: application/json"

JWT トークンを生成したので、次のコマンドを実行して TextFooter を PDF ファイルに追加する必要があります。

curl -X POST "https://api.aspose.cloud/v3.0/pdf/marketing.pdf/footer/text?startPageNumber=2&endPageNumber=3" \
-H  "accept: application/json" \
-H  "authorization: Bearer <JWT Token>" \
-H  "Content-Type: application/json" \
-d "{  \"Background\": true,  \"HorizontalAlignment\": \"Center\",  \"Opacity\": 0.7,  \"Rotate\": \"None\",  \"RotateAngle\": 5,  \"XIndent\": 100,  \"YIndent\": 100,  \"Zoom\": 0.8,  \"Value\": \"Aspose.PDF Cloud SDK for Python\",  \"TextState\": {    \"FontSize\": 15,    \"Font\": \"Arial\",    \"ForegroundColor\": {      \"A\": 0,      \"R\": 66,      \"G\": 111,      \"B\": 245    },    \"BackgroundColor\": {      \"A\": 10,      \"R\": 179,      \"G\": 245,      \"B\": 66    },    \"FontStyle\": \"Regular\"  },  \"BottomMargin\": 3,  \"LeftMargin\": 3,  \"RightMargin\": 3}"

cURL コマンドを使用して PDF ファイルに画像ヘッダーを追加するには、次のコマンドを実行してください。

curl -X POST "https://api.aspose.cloud/v3.0/pdf/marketing.pdf/footer/image?startPageNumber=1&endPageNumber=1" \
-H  "accept: application/json" \
-H  "authorization: Bearer <JWT Token>" \
-H  "Content-Type: application/json" \
-d "{  \"Background\": false,  \"HorizontalAlignment\": \"Left\",  \"Opacity\": 0.7,  \"Rotate\": \"None\",  \"RotateAngle\": 10,  \"XIndent\": 10,  \"YIndent\": 10,  \"Zoom\": 0.7,  \"FileName\": \"Koala.jpg\",  \"Width\": 100,  \"Height\": 100,  \"BottomMargin\": 2,  \"LeftMargin\": 1,  \"RightMargin\": 10}"

結論

結論として、PDF ドキュメントのフッター セクションに画像やテキストを追加することは、ブランディング、法令遵守、ドキュメントの整理など、さまざまな目的に役立つ機能です。Aspose.PDF Cloud SDK for Python は、Python アプリケーションでこの機能を実装するための便利で強力な方法を提供します。一方、Aspose.PDF Cloud API で cURL コマンドを使用すると、さまざまなプログラミング言語や環境に機能を統合するための柔軟性とシンプルさが得られます。どのアプローチを選択するかに関係なく、Aspose.PDF Cloud は、PDF ドキュメントのフッター セクションに画像やテキストを追加するための堅牢で信頼性の高いツールを提供します。

便利なリンク

関連記事

以下の内容について詳しくは、次の記事を参照することをお勧めします。