راه اندازی اولیه

راه اندازی برای یک توسعه دهنده

مجموعه API را برای پروژه ابری فعال کنید

  • به کنسول Cloud بروید: https://console.cloud.google.com/ .
  • پروژه ابری موجود را انتخاب کنید یا یک پروژه جدید ایجاد کنید.
  • به APIs & Services > Enable APIs and Services بروید.
  • «Chrome» را جستجو کنید.
  • «Chrome Management API» را انتخاب کنید.
  • با شرایط خدمات آشنا شوید.
  • Enable کلیک کنید.

اعتبارنامه ایجاد کنید

جایگزین 1: شناسه های مشتری OAuth 2.0

  • قبل از اینکه بتوانید "OAuth 2.0 Client ID" را ایجاد کنید، ابتدا باید صفحه رضایت OAuth را با اطلاعات مربوط به برنامه خود پیکربندی کنید. در Cloud Console، به APIs & Services > OAuth consent screen بروید.

  • در صفحه پیکربندی صفحه رضایت خود، محدوده‌های زیر را وارد کنید:

    • برای گزارش‌های API اضافه کنید: https://www.googleapis.com/auth/chrome.management.reports.readonly
    • برای جزئیات برنامه 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 Client".

نیازی به تنظیم خاصی نیست.

کاربران برنامه به امتیازات مدیریت مناسب نیاز دارند (نگاه کنید به چگونه ).

کاربران برنامه باید با صفحه رضایت بازشو OAuth برنامه موافقت کنند. به صورت اختیاری، می‌توانید به این برنامه اجازه دهید از Delegation گسترده دامنه استفاده کند (نگاه کنید به چگونه )، که صفحه رضایت بازشو OAuth را برای کاربران حذف می‌کند.

به صورت اختیاری بررسی کنید که آیا برنامه مسدود نشده است، یا صریحاً به برنامه اعتماد کنید (نگاه کنید به چگونه ).

برنامه های "حساب سرویس".

حساب سرویس باید دارای امتیازات مدیریت مناسب باشد. شما می توانید این کار را به یکی از دو روش انجام دهید:

  • به نمایندگی از دامنه گسترده اجازه دهید تا حساب سرویس بتواند هویت مدیری را جعل کند که دارای امتیازات مناسب است (نگاه کنید به چگونه ).
  • به طور مستقیم نقش‌های سرپرست را برای حساب سرویس اعطا کنید (نگاه کنید به چگونه ).

راهنمای "چگونه"

نحوه مسدود کردن یا اعتماد کردن یک برنامه

  • به عنوان سرپرست مشتری، به Admin Console (https://admin.google.com/) بروید.
  • به Security > Access and data control > API controls بروید.
  • در بخش App access control ، روی Manage third party app access کلیک کنید.
  • اگر برنامه را در لیست «برنامه‌های متصل» نمی‌بینید، می‌توانید برنامه جدیدی را پیکربندی کنید.
  • اکنون می توانید برنامه را مسدود کنید یا صریحاً به برنامه اعتماد کنید.

نحوه فعال کردن تفویض اختیار در سطح دامنه

  • به عنوان سرپرست مشتری، به Admin Console (https://admin.google.com/) بروید.
  • به Security > Access and data control > API controls > Domain-wide delegation بروید.
  • روی Add new کلیک کنید.
  • شناسه مشتری ("شناسه منحصر به فرد حساب سرویس" یا "شناسه مشتری برنامه") را وارد کنید.
  • تمام دامنه های OAuth لازم را وارد کنید. بسته به برنامه، ممکن است لازم باشد محدوده هایی را برای مواردی بیش از فقط Chrome Management API وارد کنید. به عنوان مثال Directory API برای مدیریت دستگاه‌ها، کاربران، مرورگرها، OU، گروه‌ها و غیره.
  • Authorize کلیک کنید.

نحوه مدیریت امتیازات ادمین

برای بخش‌های مختلف APIهای مدیریت Chrome، امتیازات سرپرست متفاوتی مورد نیاز است. ببینید کدام امتیازات سرپرست برای Reports API ، App Details API یا Telemetry API مورد نیاز است.

برای اعطای امتیازات:

  • به عنوان سرپرست مشتری، به Admin Console (https://admin.google.com/) بروید.
  • به صفحه Admin roles بروید.
  • یک نقش موجود را پیدا کنید یا یک نقش جدید با امتیازات لازم ایجاد کنید.
  • این نقش را به آدرس ایمیل کاربر یا آدرس ایمیل حساب سرویس اختصاص دهید.

چگونه برنامه خود را در OAuth Playground آزمایش کنید

  • در Cloud Console، هنگام ایجاد شناسه مشتری OAuth برای برنامه خود (به بخش OAuth 2.0 Client IDs مراجعه کنید) نوع برنامه "Web Applications" را انتخاب کنید.
  • یک "نام" را وارد کنید.
  • برای آزمایش برنامه خود، https://developers.google.com/oauthplayground به قسمت «URIs تغییر مسیر مجاز» اضافه کنید. پس از اتمام آزمایش، می‌توانید URI تغییر مسیر را از برنامه خود حذف کنید.
  • روی Create کلیک کنید و "شناسه مشتری" و "محرمانه مشتری" را کپی کنید.
  • به 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 دیگر) را در قسمت ورودی scope اضافه کنید و روی «Authorize APIs» کلیک کنید. با استفاده از حساب مدیریت مشتری مجوز دهید. با شرایط موافقت کنید.

    • تبادل کد مجوز برای توکن ها.

      روی Exchange authorization code for tokens کلیک کنید. در صورت تمایل، Auto-refresh the token before it expires کلیک کنید.

    • درخواست را برای API پیکربندی کنید.

      URL API خود را در کادر متنی «درخواست URI» وارد کنید. "روش HTTP"، "Enter request body" و غیره را طبق مشخصات API تغییر دهید. به عنوان مثال، از URL زیر برای شمارش برنامه های نصب شده در سازمان خود استفاده کنید: https://chromemanagement.googleapis.com/v1alpha1/customers/my_customer/reports:countInstalledApps