初期設定

デベロッパーのセットアップ

クラウド プロジェクトで API スイートを有効にする

  • Cloud コンソール(https://console.cloud.google.com/)に移動します。
  • 既存のクラウド プロジェクトを選択するか、新しいプロジェクトを作成します。
  • APIs & Services > Enable APIs and Services に移動します。
  • 「Chrome」を検索します。
  • [Chrome Management API] を選択します。
  • 利用規約をよく読みます。
  • [Enable] をクリックします。

認証情報を作成

方法 1: OAuth 2.0 クライアント ID

  • 「OAuth 2.0 クライアント ID」を作成するには、まずアプリケーションに関する情報で OAuth 同意画面を設定する必要があります。 Cloud コンソールで、APIs & Services > OAuth consent screen に移動します。
  • 同意画面の設定ページで、スコープを入力します。

    • Reports API の場合は https://www.googleapis.com/auth/chrome.management.reports.readonly を追加します。
    • App Details API の場合は、https://www.googleapis.com/auth/chrome.management.appdetails.readonly を追加します。
    • Telemetry API の場合は https://www.googleapis.com/auth/chrome.management.telemetry.readonly を追加します。

    追加されたスコープは機密性が高いため、アプリを提出して検証することが必要になる場合があります。そうしないと、アプリが内部でない場合に、セキュリティ警告画面が表示されることがあります。

  • APIs & Services > Credentials > Create Credentials > OAuth client ID に移動し、手順に沿って認証情報を作成します。

  • 必要に応じて、OAuth Playground でアプリをテストします(方法を参照)。

方法 2: サービス アカウント

  • APIs & Services > Credentials > Create Credentials > Service account に移動します。
  • サービス アカウント名を入力して [Create] をクリックします。
  • サービス アカウント用のキーを作成します。[Add Key] をクリックして「json」キーを作成します。安全な場所にファイルを保管してください。
  • お客様用の適切な管理者権限があるサービス アカウントを使用します。
    • お客様がドメイン全体の委任を設定すると、サービス アカウントが適切な権限を持つユーザー/管理者に成り代わることができる(方法を参照)
    • お客様がサービス アカウントに対して適切な権限を持つ管理者ロールを直接付与することもできます(方法を参照)。

お客様のセットアップ

デベロッパーが作成したアプリケーションの種類によって、顧客管理者の設定オプションは異なります。

「OAuth 2.0 クライアント」アプリ

特別なセットアップは必要ありません。

アプリ ユーザーには適切な管理者権限が必要です(詳細)。

アプリのユーザーは、アプリの OAuth ポップアップ同意画面に同意する必要があります。必要に応じて、このアプリにドメイン全体の委任の使用を許可することができます(方法を参照)。この場合、ユーザーに対して OAuth ポップアップ同意画面は表示されません。

必要に応じて、アプリがブロックされていないかどうかを確認するか、アプリを明示的に信頼します(方法を参照)。

「サービス アカウント」のアプリ

サービス アカウントには、適切な管理者権限を付与する必要があります。これには、次の 2 つの方法があります。

  • ドメイン全体の委任を許可して、サービス アカウントが適切な権限を持つ管理者になりすます(方法をご覧ください)。
  • サービス アカウントの管理者ロールを直接付与します(方法をご覧ください)。

「入門」ガイド

アプリをブロックまたは信頼する方法

  • 顧客管理者として管理コンソール(https://admin.google.com/)に移動します。
  • Security > Access and data control > API controls に移動します。
  • [App access control] セクションで Manage third party app access をクリックします。
  • [接続済みのアプリ] リストにアプリが表示されない場合は、新しいアプリを設定できます。
  • これで、アプリを明示的にブロックしたり、アプリを信頼したりできます。

ドメイン全体の委任を有効にする方法

  • 顧客管理者として管理コンソール(https://admin.google.com/)に移動します。
  • Security > Access and data control > API controls > Domain-wide delegation に移動します。
  • [Add new] をクリックします。
  • クライアント ID(「サービス アカウントの一意の ID」または「アプリのクライアント ID」)を入力します。
  • 必要なすべての OAuth スコープを入力します。アプリによっては、Chrome Management API 以外のスコープを入力する必要があります(デバイス、ユーザー、ブラウザ、組織部門、グループなどを管理する Directory API など)。
  • [Authorize] をクリックします。

管理者権限を管理する方法

Chrome Management API の各部分には、それぞれ異なる管理者権限が必要です。Reports APIApp Details APITelemetry API に必要な管理者権限を確認する。

権限を付与するには:

  • 顧客管理者として管理コンソール(https://admin.google.com/)に移動します。
  • Admin roles ページに移動します。
  • 既存のロールを検索するか、必要な権限を持つ新しいロールを作成します。
  • このロールは、ユーザーのメールアドレスまたはサービス アカウントのメールアドレスに割り当てます。

OAuth Playground でアプリをテストする方法

  • Cloud コンソールで、アプリの OAuth クライアント ID を作成する際に(上記の OAuth 2.0 クライアント ID のセクションを参照)、アプリケーションの種類として [ウェブ アプリケーション] を選択します。
  • [名前] を入力します。
  • アプリをテストするには、[承認済みのリダイレクト URI] に https://developers.google.com/oauthplayground を追加します。テストが完了したら、アプリからリダイレクト URI を削除できます。
  • Create をクリックして、「client ID」と「client secret」をコピーします。
  • OAuth Playground に移動します。
  • 右上の歯車アイコン([OAuth 2.0 Configuration])をクリックし、[Use your own OAuth credentials] を選択して、[OAuth Client ID] と [OAuth Client secret] を入力します。
  • OAuth Playground での手順

    • API を選択して承認します。

      スコープの入力フィールドに https://www.googleapis.com/auth/chrome.management.reports.readonly(または他の API スコープ)を追加して、[Authorize APIs] をクリックします。顧客管理者アカウントを使用して承認します。利用規約に同意します。

    • 認証コードをトークンと交換します。

      [Exchange authorization code for tokens] をクリックします。必要に応じて、[Auto-refresh the token before it expires] をクリックします。

    • API へのリクエストを構成します。

      [リクエスト URI] テキスト ボックスに API の URL を入力します。API 仕様に従って、「HTTP Method」、「Enter request body」などを変更します。たとえば、組織内でインストール済みのアプリの数をカウントするには、https://chromemanagement.googleapis.com/v1alpha1/customers/my_customer/reports:countInstalledApps という URL を使用します。