Python SDK クイックスタート

この記事では、Python SDK を使用して一般的な操作を実行するためのクイックスタートガイドを提供します。 SDK のインストール方法、アクセス認証情報の設定方法、最新のアップグレード情報の取得などの基本操作を学びます。

注意事項

• Python SDK を使用してリクエストを送信するには、Client インスタンスを初期化する必要があります。この記事では、デフォルト設定を読み込むことで Client を作成します。クライアントの詳細な設定オプションについては、「クライアントの設定」を参照してください。

前提条件

• UpgradeLink アカウントを登録していること。
• AccessKey と AccessSecret を取得していること。
• URL アプリケーションのアップグレード戦略を設定していること。

認証情報の取得

Python SDK のインストール

• まず、Python コンパイルおよび実行環境をインストールしてください。次のコマンドを使用して、Python が正常にインストールされているか確認します：

  python --version

現在適切な Python コンパイルおよび実行環境がない場合は、Python のインストールを参照してダウンロードおよびインストールしてください。

• 次のコマンドを実行して、Python SDK コードパッケージをインストールします。

pip install upgradelink-api-python

• 次のコードを使用して、Python SDK コードパッケージをインポートします。

import upgradelink_api_python

クイック使用法

次のサンプルプログラムは、Client を初期化して URL アプリケーションの最新のアップグレード情報を取得する方法を示しています。

URL アプリケーションの最新アップグレード情報を取得する

from upgradelink_api_python import models as upgrade_link_models
from upgradelink_api_python.client import Client

def main():
    # 設定オブジェクトを作成
    config = upgrade_link_models.Config(
        access_key="mui2W50H1j-OC4xD6PgQag",  # 例のキー、実際のキーに置き換えてください
        access_secret="PEbdHFGC0uO_Pch7XWBQTMsFRxKPQAM2565eP8LJ3gc",  # 例のキー、実際のキーに置き換えてください
        protocol="HTTPS",
        endpoint="api.upgrade.toolsetlink.com"
    )
    
    # クライアントを作成
    client = Client(config)
    
    # リクエストパラメータを設定
    url_key = "uJ47NPeT7qjLa1gL3sVHqw"  # URL アプリケーションの一意の識別子
    version_code = 1  # 現在のアプリケーションバージョン番号
    appoint_version_code = 0  # 指定されたバージョン番号、0 は最新バージョンを示す
    dev_model_key = ""  # デバイスモデル識別子、オプション
    dev_key = ""  # デバイス識別子、オプション
    
    # リクエストオブジェクトを構築
    request = upgrade_link_models.UrlUpgradeRequest(
        url_key=url_key,
        version_code=version_code,
        appoint_version_code=appoint_version_code,
        dev_model_key=dev_model_key,
        dev_key=dev_key
    )
    
    try:
        # API インターフェースを呼び出す
        response = client.url_upgrade(request)
        
        # レスポンス結果を処理
        if response.code == 200:
            print("リクエストが成功しました！")
            print(f"メッセージ: {response.msg}")
            print(f"トレース ID: {response.trace_id}")
            
            # アップグレードデータを処理
            if response.data:
                data = response.data
                print("\nアップグレード情報:")
                print(f"URL キー: {data.url_key}")
                print(f"バージョン名: {data.version_name}")
                print(f"バージョンコード: {data.version_code}")
                print(f"URL パス: {data.url_path}")
                print(f"アップグレードタイプ: {data.upgrade_type}")  # 1: 強制アップグレード, 2: 推奨アップグレード, 3: オプションアップグレード
                print(f"アップグレードプロンプト内容: {data.prompt_upgrade_content}")
                
                # 異なるアップグレードタイプを処理
                if data.upgrade_type == 1:
                    print("\nこれは強制アップグレードです。アプリケーションをすぐにアップグレードしてください。")
                    # 強制アップグレードロジックを実行
                elif data.upgrade_type == 2:
                    print("\nこれは推奨アップグレードです。ユーザーにアプリケーションのアップグレードを推奨します。")
                    # 推奨アップグレードロジックを実行
                elif data.upgrade_type == 3:
                    print("\nこれはオプションアップグレードです。ユーザーはアップグレードするかどうかを選択できます。")
                    # オプションアップグレードロジックを実行
        else:
            print(f"リクエストに失敗しました、エラーコード: {response.code}")
            print(f"エラーメッセージ: {response.msg}")
            print(f"トレース ID: {response.trace_id}")
            
    except Exception as e:
        print(f"API を呼び出すときにエラーが発生しました: {e}")

if __name__ == "__main__":
    main()