シフトのスケジューリングの例

次の例は、認証に API キーを使用して、Python requests ライブラリで API を呼び出す方法を示しています。使用方法は次のとおりです。

• Python requests ライブラリをインストールします。コマンドラインから: pip install requests
• 次の Python プログラムをコンピュータに保存し、example.py という名前を付けます。
• example_request.json ファイルをプログラムと同じディレクトリに保存します（これは JSON リクエストのサンプルです）。
• プログラムと同じディレクトリに credentials.json ファイルを作成します。
• コマンドライン（python example.py）からサンプルを実行します。

# example.py
import json
import requests

def run_example():
    """Calls the OR API to solve a shift scheduling problem."""
    
    # Endpoint for the workforce scheduling solver in the OR API.
    end_point = "https://optimization.googleapis.com/v1/scheduling:solveShiftScheduling"
    
    # Read the API Key from a JSON file with the format:
    # {"key": "your_api_key"}
    with open("credentials.json") as f:
        credentials = json.load(f)
        api_key = credentials["key"]

    # Load the JSON file with the request.
    with open("example_request.json", "r") as f:
        json_request = json.load(f)

    # Call the API post method.
    response = requests.post(f"{end_point}?key={api_key}", json=json_request)

    # Process the response.
    if response.ok:
        solution = json.loads(response.content)
        with open("example_response.json", "w") as f:
            json.dump(solution, f, indent=2)
        print(solution)
    else:
        error = json.loads(response.content)["error"]
        print(f'Status code {error["code"]}: {error["message"]}')

if __name__ == "__main__":
    run_example()

期限の設定方法

期限は、API 呼び出しに要する最大経過時間を決定します。ユーザーはクライアントとサーバーの両方の期限を設定できます。OR API のコンテキストでは、 最も有用なタイムスタンプは、バックエンド サーバーへの リクエストを受け取って、基礎となるソルバーを実行し、 レスポンスが返されます。対照的に、クライアントの期限は、リソースへの最大応答時間を クライアント アプリケーション（OR API を呼び出すアプリケーション）は、 応答を待ってからタイムアウトします。

次のコード スニペットでは、 リクエストのセッション ヘッダー。クライアントの期限は 60 秒に設定されています。「 サーバーの期限は、クライアントの期限よりも短くする必要があります。 オーバーヘッドが増加します。ここでは、サーバーのデッドラインをクライアントのデッドラインの 95% に設定していますが、これはアプリケーションによって異なる場合があります。API には、 キーもセッション ヘッダーに移動され、session.post(...) 呼び出しを行う 洗い流します

# Call the API post method.
session = requests.Session()
client_deadline_seconds = 60
server_deadline_seconds = 0.95 * client_deadline_seconds
session.headers = {
    "Content-Type": "application/json",
    "Connection": "keep-alive",
    "Keep-Alive": f"timeout={client_deadline_seconds}, max=1",
    "X-Server-Timeout": f"{server_deadline_seconds}",
    "X-Goog-Api-Key": api_key,
}
response = session.post(end_point, json=json_request, timeout=client_deadline_seconds)