AgentBay:モバイルアプリケーションライフサイクル管理

概要

Mobile Use モジュールは、Android モバイルデバイス向けにアプリケーション管理機能を提供します。これらの機能には、以下が含まれます。

1. アプリケーション検出 — デバイスにインストールされているアプリケーションのリストを照会します。

2. アプリケーションライフサイクル管理 — パッケージ名を使用してモバイルアプリケーションを起動および停止します。

3. アクティビティ管理 — 特定の Android アクティビティを起動します。

4. プロセス監視 — 実行中のアプリケーションとそれに関連するプロセスを追跡します。

セッションの作成

import os
from agentbay import AgentBay
from agentbay.session_params import CreateSessionParams

api_key = os.getenv("AGENTBAY_API_KEY")
if not api_key:
    raise ValueError("AGENTBAY_API_KEY environment variable is required")

agent_bay = AgentBay(api_key=api_key)

params = CreateSessionParams(image_id="mobile_latest")
result = agent_bay.create(params)

if result.success:
    session = result.session
    print(f"Session created: {session.session_id}")
else:
    print(f"Failed to create session: {result.error_message}")
    exit(1)

# Actual output:
# Session created: session-04bdw8o39c9uiwet4

インストール済みアプリケーションの取得

モバイルデバイスにインストールされているアプリケーションのリストを照会します。

result = session.mobile.get_installed_apps(
    start_menu=True,
    desktop=False,
    ignore_system_apps=True
)

if result.success:
    apps = result.data
    print(f"Found {len(apps)} installed applications")
   
    for app in apps[:5]:
        print(f"Name: {app.name}")
        print(f"Start command: {app.start_cmd}")
        print(f"Stop command: {app.stop_cmd if app.stop_cmd else 'N/A'}")
        print(f"Working directory: {app.work_directory if app.work_directory else 'N/A'}")
        print("---")
else:
    print(f"Error: {result.error_message}")

# Actual output (using current mobile_latest image):
# Found 0 installed applications

パラメーター：

• start_menu (bool)：スタートメニューのアプリケーションを含めるかどうか。

• desktop (bool)：デスクトップアプリケーションを含めるかどうか。

• ignore_system_apps (bool)：システムアプリケーションを除外するかどうか。

戻り値：

• InstalledAppListResult には、InstalledApp オブジェクトのリストが含まれます。

アプリケーションの起動

monkey -p <package_name> コマンド形式を使用してモバイルアプリケーションを起動します。

# Launch an Android application using the "monkey -p" format
start_cmd = "monkey -p com.android.settings"

result = session.mobile.start_app(start_cmd)

if result.success:
    processes = result.data
    print(f"Application launched, {len(processes)} processes found")

    for process in processes:
        print(f"Process: {process.pname} (PID: {process.pid})")
else:
    print(f"Failed to launch application: {result.error_message}")

# Actual output:
# Application launched, 1 process found
# Process: com.android.settings (PID: 2805)

start_cmd = "monkey -p com.android.settings"
activity = ".Settings"

result = session.mobile.start_app(
    start_cmd=start_cmd,
    activity=activity
)

if result.success:
    processes = result.data
    print(f"Application launched, Activity is {activity}")
    print(f"Found {len(processes)} processes")
    
    for process in processes:
        print(f"Process: {process.pname} (PID: {process.pid})")
else:
    print(f"Failed to launch application: {result.error_message}")

# Actual output:
# Application launched, Activity is .Settings
# Found 1 process
# Process: com.android.settings (PID: 2921)

アプリケーションの停止

# Launch an application
start_result = session.mobile.start_app("monkey -p com.android.settings")

if start_result.success:
    print("Application launched successfully")
    for process in start_result.data:
        print(f"  Process: {process.pname} (PID: {process.pid})")

    # Stop the application using its package name
    result = session.mobile.stop_app_by_cmd("com.android.settings")

    if result.success:
        print("Application stopped successfully")
    else:
        print(f"Failed to stop application: {result.error_message}")

# Actual output:
# Application launched successfully
#   Process: com.android.settings (PID: 3042)
# Application stopped successfully

完全なワークフローの例

import os
import time
from agentbay import AgentBay
from agentbay.session_params import CreateSessionParams

api_key = os.getenv("AGENTBAY_API_KEY")
if not api_key:
    raise ValueError("AGENTBAY_API_KEY environment variable is required")

agent_bay = AgentBay(api_key=api_key)

# Create a mobile session
params = CreateSessionParams(image_id="mobile_latest")
result = agent_bay.create(params)

if not result.success:
    print(f"Failed to create session: {result.error_message}")
    exit(1)

session = result.session
print(f"Session created: {session.session_id}")

# Step 1: Launch application
print("Step 1: Launch Settings application...")
start_result = session.mobile.start_app("monkey -p com.android.settings")

if not start_result.success:
    print(f"Failed to launch application: {start_result.error_message}")
    agent_bay.delete(session)
    exit(1)

print(f"Application launched, {len(start_result.data)} processes found")
for process in start_result.data:
    print(f"  - {process.pname} (PID: {process.pid})")

# Step 2: Wait for application to load
print("Step 2: Wait for application to load...")
time.sleep(3)

# Step 3: Stop application
print("Step 3: Stop application...")
stop_result = session.mobile.stop_app_by_cmd("com.android.settings")
if stop_result.success:
    print("Application stopped successfully")
else:
    print(f"Failed to stop application: {stop_result.error_message}")

# Clean up
print("Cleaning up session...")
agent_bay.delete(session)
print("Workflow complete!")

# Actual output:
# Session created: session-04bdwfj7tnhfnzibx
# Step 1: Launch Settings application...
# Application launched, 1 process found
#   - com.android.settings (PID: 3268)
# Step 2: Wait for application to load...
# Step 3: Stop application...
# Application stopped successfully
# Cleaning up session...
# Workflow complete

API リファレンス

session.mobile.start_app("monkey -p com.android.settings")

session.mobile.stop_app_by_cmd("com.android.settings")

session.mobile.start_app(
    start_cmd="monkey -p com.android.settings",
    activity=".Settings"
)