اعتبار دسترسی ایجاد کنید

از اعتبارنامه‌ها برای دریافت توکن دسترسی از سرورهای مجوز گوگل استفاده می‌شود تا برنامه شما بتواند APIهای Google Workspace را فراخوانی کند. این راهنما نحوه انتخاب و تنظیم اعتبارنامه‌های مورد نیاز برنامه شما را شرح می‌دهد.

برای تعاریف اصطلاحات موجود در این صفحه، به نمای کلی احراز هویت و مجوز مراجعه کنید.

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

اعتبارنامه‌های مورد نیاز به نوع داده، پلتفرم و روش دسترسی برنامه شما بستگی دارد. سه نوع اعتبارنامه در دسترس است:

مورد استفاده روش احراز هویت درباره این روش احراز هویت
به داده‌های عمومی موجود در برنامه خود به صورت ناشناس دسترسی پیدا کنید. کلیدهای API قبل از استفاده از این روش احراز هویت، بررسی کنید که API مورد نظر شما از کلیدهای API پشتیبانی می‌کند.
به داده‌های کاربر مانند آدرس ایمیل یا سن آنها دسترسی پیدا کنید. شناسه کلاینت OAuth برنامه شما را ملزم به درخواست و دریافت رضایت از کاربر می‌کند.
به داده‌هایی که متعلق به برنامه خودتان است دسترسی داشته باشید یا از طرف کاربران Google Workspace یا Cloud Identity از طریق واگذاری اختیارات در سطح دامنه، به منابع دسترسی داشته باشید. حساب کاربری خدمات وقتی یک برنامه به عنوان یک حساب سرویس احراز هویت می‌شود، به تمام منابعی که حساب سرویس اجازه دسترسی به آنها را دارد، دسترسی پیدا می‌کند.

اعتبارنامه‌های کلید API

کلید API یک رشته طولانی است که شامل حروف بزرگ و کوچک، اعداد، زیرخط و خط فاصله است، مانند AIzaSyDaGmWKa4JsXZ-HjGw7ISLn_3namBGewQe . این روش احراز هویت برای دسترسی ناشناس به داده‌های عمومی، مانند فایل‌های Google Workspace که با استفاده از تنظیم اشتراک‌گذاری «هر کسی در اینترنت با این لینک» به اشتراک گذاشته شده است، استفاده می‌شود. برای جزئیات بیشتر، به استفاده از کلیدهای API مراجعه کنید.

برای ایجاد کلید API:

  1. در کنسول گوگل کلود، به Menu > APIs & Services > Credentials بروید.

    به اعتبارنامه‌ها بروید

  2. روی ایجاد اعتبارنامه > کلید API کلیک کنید.
  3. کلید API جدید شما نمایش داده می‌شود.
    • برای کپی کردن کلید API خود جهت استفاده در کد برنامه، روی گزینه کپی کردن کلیک کنید. کلید API را می‌توانید در بخش «کلیدهای API» در اعتبارنامه‌های پروژه خود نیز پیدا کنید.
    • برای جلوگیری از استفاده غیرمجاز، توصیه می‌کنیم مکان و نوع APIهایی که کلید API می‌تواند استفاده شود را محدود کنید. برای جزئیات بیشتر، به افزودن محدودیت‌های API مراجعه کنید.

اعتبارنامه‌های شناسه کلاینت OAuth

برای احراز هویت کاربران نهایی و دسترسی به داده‌های کاربر در برنامه خود، باید یک یا چند شناسه کلاینت OAuth 2.0 ایجاد کنید. شناسه کلاینت برای شناسایی یک برنامه واحد به سرورهای OAuth گوگل استفاده می‌شود. اگر برنامه شما روی چندین پلتفرم اجرا می‌شود، باید برای هر پلتفرم یک شناسه کلاینت جداگانه ایجاد کنید.

برای دستورالعمل‌های خاص در مورد نحوه ایجاد شناسه کلاینت OAuth ، نوع برنامه خود را انتخاب کنید:

برنامه وب

  1. در کنسول گوگل کلود، به Menu > برویدGoogle Auth platform > مشتریان .

    به بخش مشتریان بروید

  2. روی ایجاد کلاینت کلیک کنید.
  3. روی نوع برنامه > برنامه وب کلیک کنید.
  4. در فیلد نام ، نامی برای اعتبارنامه تایپ کنید. این نام فقط در کنسول Google Cloud نمایش داده می‌شود.
  5. URI های مجاز مربوط به برنامه خود را اضافه کنید:
    • برنامه‌های سمت کلاینت (جاوااسکریپت) – در قسمت Authorized JavaScript origins ، روی Add URI کلیک کنید. سپس، یک URI برای استفاده در درخواست‌های مرورگر وارد کنید. این دامنه‌هایی را که برنامه شما می‌تواند از آنها درخواست‌های API را به سرور OAuth 2.0 ارسال کند، مشخص می‌کند.
    • برنامه‌های سمت سرور (جاوا، پایتون و موارد دیگر) – در زیر Authorized redirect URIs ، روی Add URI کلیک کنید. سپس، یک URI نقطه پایانی که سرور OAuth 2.0 می‌تواند به آن پاسخ ارسال کند را وارد کنید.
  6. روی ایجاد کلیک کنید.

    اعتبارنامه‌ی تازه ایجاد شده در زیر شناسه‌های کلاینت OAuth 2.0 ظاهر می‌شود.

    به شناسه کلاینت توجه کنید. از رمزهای کلاینت برای برنامه‌های وب استفاده نمی‌شود.

اندروید

  1. در کنسول گوگل کلود، به Menu > برویدGoogle Auth platform > مشتریان .

    به بخش مشتریان بروید

  2. روی ایجاد کلاینت کلیک کنید.
  3. روی نوع برنامه > اندروید کلیک کنید.
  4. در فیلد «نام»، نامی برای اعتبارنامه تایپ کنید. این نام فقط در کنسول Google Cloud نمایش داده می‌شود.
  5. در فیلد "Package name"، نام بسته را از فایل AndroidManifest.xml خود وارد کنید.
  6. در فیلد «اثر انگشت گواهی SHA-1»، اثر انگشت گواهی SHA-1 تولید شده خود را وارد کنید.
  7. روی ایجاد کلیک کنید.

    اعتبارنامه‌ی تازه ایجاد شده در زیر «OAuth 2.0 Client IDs» ظاهر می‌شود.

آی‌او‌اس

  1. در کنسول گوگل کلود، به Menu > برویدGoogle Auth platform > مشتریان .

    به بخش مشتریان بروید

  2. روی ایجاد کلاینت کلیک کنید.
  3. روی نوع برنامه > iOS کلیک کنید.
  4. در فیلد «نام»، نامی برای اعتبارنامه تایپ کنید. این نام فقط در کنسول Google Cloud نمایش داده می‌شود.
  5. در فیلد «شناسه بسته»، شناسه بسته را مطابق با آنچه در فایل Info.plist برنامه ذکر شده است، وارد کنید.
  6. اختیاری: اگر برنامه شما در فروشگاه اپل اپ استور (Apple App Store) نمایش داده می‌شود، شناسه فروشگاه اپ (App Store ID) را وارد کنید.
  7. اختیاری: در فیلد «شناسه تیم»، رشته ۱۰ کاراکتری منحصر به فردی را که توسط اپل تولید شده و به تیم شما اختصاص داده شده است، وارد کنید.
  8. روی ایجاد کلیک کنید.

    اعتبارنامه‌ی تازه ایجاد شده در زیر «OAuth 2.0 Client IDs» ظاهر می‌شود.

افزونه کروم

  1. در کنسول گوگل کلود، به Menu > برویدGoogle Auth platform > مشتریان .

    به بخش مشتریان بروید

  2. روی ایجاد کلاینت کلیک کنید.
  3. روی نوع برنامه > افزونه کروم کلیک کنید.
  4. در فیلد «نام»، نامی برای اعتبارنامه تایپ کنید. این نام فقط در کنسول Google Cloud نمایش داده می‌شود.
  5. در فیلد «شناسه کالا»، رشته شناسه ۳۲ کاراکتری منحصر به فرد برنامه خود را وارد کنید. می‌توانید این مقدار شناسه را در نشانی اینترنتی فروشگاه وب کروم برنامه خود و در داشبورد توسعه‌دهندگان فروشگاه وب کروم پیدا کنید.
  6. روی ایجاد کلیک کنید.

    اعتبارنامه‌ی تازه ایجاد شده در زیر «OAuth 2.0 Client IDs» ظاهر می‌شود.

برنامه دسکتاپ

  1. در کنسول گوگل کلود، به Menu > برویدGoogle Auth platform > مشتریان .

    به بخش مشتریان بروید

  2. روی ایجاد کلاینت کلیک کنید.
  3. روی نوع برنامه > برنامه دسکتاپ کلیک کنید.
  4. در فیلد نام ، نامی برای اعتبارنامه تایپ کنید. این نام فقط در کنسول Google Cloud نمایش داده می‌شود.
  5. روی ایجاد کلیک کنید.

    اعتبارنامه‌ی تازه ایجاد شده در زیر «OAuth 2.0 Client IDs» ظاهر می‌شود.

تلویزیون‌ها و دستگاه‌های ورودی محدود

  1. در کنسول گوگل کلود، به Menu > برویدGoogle Auth platform > مشتریان .

    به بخش مشتریان بروید

  2. روی ایجاد کلاینت کلیک کنید.
  3. روی نوع برنامه > تلویزیون‌ها و دستگاه‌های ورودی محدود کلیک کنید.
  4. در فیلد «نام»، نامی برای اعتبارنامه تایپ کنید. این نام فقط در کنسول Google Cloud نمایش داده می‌شود.
  5. روی ایجاد کلیک کنید.

    اعتبارنامه‌ی تازه ایجاد شده در زیر «OAuth 2.0 Client IDs» ظاهر می‌شود.

پلتفرم جهانی ویندوز (UWP)

  1. در کنسول گوگل کلود، به Menu > برویدGoogle Auth platform > مشتریان .

    به بخش مشتریان بروید

  2. روی ایجاد کلاینت کلیک کنید.
  3. روی نوع برنامه > پلتفرم جهانی ویندوز (UWP) کلیک کنید.
  4. در فیلد «نام»، نامی برای اعتبارنامه تایپ کنید. این نام فقط در کنسول Google Cloud نمایش داده می‌شود.
  5. در فیلد «شناسه فروشگاه»، مقدار منحصر به فرد ۱۲ کاراکتری شناسه فروشگاه مایکروسافت برنامه خود را وارد کنید. می‌توانید این شناسه را در آدرس اینترنتی فروشگاه مایکروسافت برنامه خود و در مرکز شرکا پیدا کنید.
  6. روی ایجاد کلیک کنید.

    اعتبارنامه‌ی تازه ایجاد شده در زیر «OAuth 2.0 Client IDs» ظاهر می‌شود.

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

حساب کاربری سرویس، نوع خاصی از حساب کاربری است که توسط یک برنامه کاربردی استفاده می‌شود، نه یک شخص. می‌توانید از یک حساب کاربری سرویس برای دسترسی به داده‌ها یا انجام اقدامات توسط حساب کاربری ربات، یا برای دسترسی به داده‌ها از طرف کاربران Google Workspace یا Cloud Identity استفاده کنید. برای اطلاعات بیشتر، به بخش «درک حساب‌های کاربری سرویس» مراجعه کنید.

ایجاد حساب کاربری سرویس

کنسول گوگل کلود

  1. در کنسول گوگل کلود، به Menu > IAM & Admin > Service Accounts بروید.

    به حساب‌های سرویس بروید

  2. روی ایجاد حساب سرویس کلیک کنید.
  3. جزئیات حساب سرویس را پر کنید، سپس روی ایجاد و ادامه کلیک کنید.
  4. اختیاری: برای اعطای دسترسی به منابع پروژه Google Cloud خود، نقش‌هایی را به حساب سرویس خود اختصاص دهید. برای جزئیات بیشتر، به بخش اعطای، تغییر و لغو دسترسی به منابع مراجعه کنید.
  5. روی ادامه کلیک کنید.
  6. اختیاری: کاربران یا گروه‌هایی را که می‌توانند با این حساب سرویس، اقدامات را مدیریت و انجام دهند، وارد کنید. برای جزئیات بیشتر، به مدیریت جعل هویت حساب سرویس مراجعه کنید.
  7. روی «انجام شد» کلیک کنید. آدرس ایمیل حساب سرویس را یادداشت کنید.

رابط خط فرمان جی‌کلاود

  1. ایجاد حساب کاربری سرویس: 
    gcloud iam service-accounts create SERVICE_ACCOUNT_NAME \
  --display-name="SERVICE_ACCOUNT_NAME"
  2. اختیاری: برای اعطای دسترسی به منابع پروژه Google Cloud خود، نقش‌هایی را به حساب سرویس خود اختصاص دهید. برای جزئیات بیشتر، به بخش اعطای، تغییر و لغو دسترسی به منابع مراجعه کنید.

اختصاص یک نقش به یک حساب سرویس

شما باید یک نقش از پیش ساخته شده یا سفارشی را توسط یک حساب کاربری مدیر ارشد به یک حساب کاربری سرویس اختصاص دهید.

  1. در کنسول مدیریت گوگل، به Menu > Account > Admin roles بروید.

    به نقش‌های مدیریتی بروید

  2. نشانگر را روی نقشی که می‌خواهید اختصاص دهید قرار دهید و سپس روی «اختصاص مدیر» کلیک کنید.

  3. روی اختصاص حساب‌های سرویس کلیک کنید.

  4. آدرس ایمیل حساب سرویس را وارد کنید.

  5. روی افزودن > اختصاص نقش کلیک کنید.

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

شما باید اعتبارنامه‌هایی را به شکل یک جفت کلید عمومی/خصوصی دریافت کنید. این اعتبارنامه‌ها توسط کد شما برای تأیید اقدامات حساب سرویس در برنامه‌تان استفاده می‌شوند.

برای دریافت اعتبارنامه برای حساب سرویس خود:

  1. در کنسول گوگل کلود، به Menu > IAM & Admin > Service Accounts بروید.

    به حساب‌های سرویس بروید

  2. حساب کاربری سرویس خود را انتخاب کنید.
  3. روی کلیدها > افزودن کلید > ایجاد کلید جدید کلیک کنید.
  4. JSON را انتخاب کنید، سپس روی ایجاد کلیک کنید.

    جفت کلید عمومی/خصوصی جدید شما ایجاد و به عنوان یک فایل جدید در دستگاه شما دانلود می‌شود. فایل JSON دانلود شده را با نام credentials.json در دایرکتوری کاری خود ذخیره کنید. این فایل تنها کپی از این کلید است. برای اطلاعات بیشتر در مورد نحوه ذخیره ایمن کلید خود، به مدیریت کلیدهای حساب سرویس مراجعه کنید.

  5. روی بستن کلیک کنید.

اختیاری: تنظیم نمایندگی در سطح دامنه برای یک حساب کاربری سرویس

برای فراخوانی APIها از طرف کاربران در یک سازمان Google Workspace، حساب سرویس شما باید در کنسول مدیریت Google Workspace توسط یک حساب کاربری مدیر ارشد، تفویض اختیار در سطح دامنه را دریافت کند. برای اطلاعات بیشتر، به بخش تفویض اختیار در سطح دامنه به یک حساب کاربری سرویس مراجعه کنید.

برای تنظیم واگذاری اختیارات در سطح دامنه برای یک حساب کاربری سرویس:

  1. در کنسول گوگل کلود، به Menu > IAM & Admin > Service Accounts بروید.

    به حساب‌های سرویس بروید

  2. حساب کاربری سرویس خود را انتخاب کنید.
  3. روی نمایش تنظیمات پیشرفته کلیک کنید.
  4. در قسمت «واگذاری در سطح دامنه»، «شناسه کلاینت» حساب سرویس خود را پیدا کنید. برای کپی کردن مقدار شناسه کلاینت در کلیپ‌بورد، روی «کپی کردن » کلیک کنید.

  5. اگر به حساب کاربری گوگل ورک‌اسپیس مربوطه دسترسی مدیر ارشد (super administrator) دارید، روی «مشاهده کنسول مدیریت گوگل ورک‌اسپیس» (View Google Workspace Admin Console) کلیک کنید، سپس با استفاده از یک حساب کاربری مدیر ارشد (super administrator) وارد سیستم شوید و مراحل زیر را ادامه دهید.

    اگر به حساب کاربری مربوطه در گوگل ورک‌اسپیس دسترسی مدیر ارشد ندارید، با یکی از مدیران ارشد آن حساب تماس بگیرید و شناسه کلاینت حساب کاربری سرویس خود و لیست محدوده‌های OAuth را برای آنها ارسال کنید تا بتوانند مراحل زیر را در کنسول مدیریت انجام دهند.

    1. در کنسول مدیریت گوگل، به Menu > Security > Access and data control > API controls بروید.

      به کنترل‌های API بروید

    2. روی مدیریت نمایندگی در سطح دامنه کلیک کنید.
    3. روی افزودن جدید کلیک کنید.
    4. در فیلد «شناسه کلاینت»، شناسه کلاینتی که قبلاً کپی کرده‌اید را جایگذاری کنید.
    5. در فیلد "محدوده‌های OAuth"، فهرستی از محدوده‌های مورد نیاز برنامه خود را که با کاما از هم جدا شده‌اند، وارد کنید. این همان مجموعه‌ای از محدوده‌هایی است که هنگام پیکربندی صفحه رضایت OAuth تعریف کرده‌اید.
    6. روی تأیید کلیک کنید.

مرحله بعدی

شما آماده توسعه در Google Workspace هستید! فهرست محصولات توسعه‌دهندگان Google Workspace و نحوه یافتن کمک را مرور کنید.