- チームは、Enterprise プランのアカウントでのみ使用できます。
- API を使用してチームを管理、モニタリングするには、チームルート権限または管理者権限が必要です。
AppSheet API を使用すると、以下のタスクを行えます。
- メールでアプリの使用状況をモニタリングする
- ユーザーごとのアプリの使用状況をモニタリングする
- チームのメンバーシップをモニタリングする
- チームのユーザー アカウントの削除を自動化する
チームのユーザー アカウントが Google Workspace 組織により管理されている場合は、API を使用してチームのユーザー アカウントの削除を自動化しないでください。組織のユーザーによる AppSheet へのアクセスを制御するには、ユーザー向けに AppSheet を有効または無効にするをご覧ください。
以降のセクションでは、AppSheet API を使用してチームをモニタリング、管理するときの一般的な注意事項を示します。
必須ヘッダー
AppSheet のチーム API を呼び出すには、以下のヘッダーを渡す必要があります。
|
ヘッダー |
説明 |
|
|
API キー。 API キーを生成するには:
|
|
|
ユーザー アカウント ID。 |
curl を使用する
このドキュメントの例では、curl を使用して、AppSheet API を使用する方法を示します。curl は URL 構文を使用してデータを転送できるオープンソースのコマンドライン ツールで、HTTP や HTTPS などの一般的なプロトコルをサポートしています。
次の表は、以降の例で使用している curl のコマンドライン オプションの要約を示しています。
|
オプション |
説明 |
|
|
リクエスト ヘッダーを定義します。必須ヘッダーをご覧ください。 |
|
|
リクエストの種類（GET、POST など）を指定します。 |
以下は、curl を使用した AppSheet API 呼び出しの例です。
curl https://{appsheet-region}/api/v2/admin/reports/usage \
-X GET \
-H "AccessKey: DcTx1-TFq3c-7ka6t-PcnnI-7d0dO-M4wTm-vWwx0-1KBte" \
-H "UserId: 1234567"
各要素の意味は次のとおりです。
| 変数 | 説明 |
|
|
サポートされるデータ所在地のリージョンに基づいて API を呼び出すために使用されるドメイン。有効な値は次のとおりです。
注: |