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

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

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

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

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

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

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

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

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

  1. در کنسول Google Cloud، به منو > APIs & Services > Credentials بروید.

    به Credentials بروید

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

شناسه مشتری OAuth

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

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

برنامه تحت وب

  1. در کنسول Google Cloud، به منو > APIs & Services > Credentials بروید.

    به Credentials بروید

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

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

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

اندروید

  1. در کنسول Google Cloud، به منو > APIs & Services > Credentials بروید.

    به Credentials بروید

  2. روی ایجاد اعتبارنامه > شناسه مشتری OAuth کلیک کنید.
  3. روی نوع برنامه > Android کلیک کنید.
  4. در قسمت "Name" یک نام برای اعتبارنامه تایپ کنید. این نام فقط در کنسول Google Cloud نشان داده می شود.
  5. در قسمت «نام بسته»، نام بسته را از فایل AndroidManifest.xml خود وارد کنید.
  6. در قسمت "اثر انگشت گواهی SHA-1"، اثر انگشت گواهینامه SHA-1 تولید شده خود را وارد کنید.
  7. روی ایجاد کلیک کنید. صفحه ایجاد شده سرویس گیرنده OAuth ظاهر می شود که شناسه مشتری جدید شما را نشان می دهد.
  8. روی OK کلیک کنید. اعتبار جدید ایجاد شده در زیر "OAuth 2.0 Client IDs" ظاهر می شود.

iOS

  1. در کنسول Google Cloud، به منو > APIs & Services > Credentials بروید.

    به Credentials بروید

  2. روی ایجاد اعتبارنامه > شناسه مشتری OAuth کلیک کنید.
  3. روی نوع برنامه > iOS کلیک کنید.
  4. در قسمت "Name" یک نام برای اعتبارنامه تایپ کنید. این نام فقط در کنسول Google Cloud نشان داده می شود.
  5. در قسمت "Bundle ID"، شناسه بسته را همانطور که در فایل Info.plist برنامه ذکر شده است وارد کنید.
  6. اختیاری: اگر برنامه شما در Apple App Store ظاهر شد، شناسه فروشگاه App را وارد کنید.
  7. اختیاری: در قسمت "تیم ID"، رشته 10 کاراکتری منحصر به فرد را وارد کنید که توسط اپل تولید شده و به تیم شما اختصاص داده شده است.
  8. روی ایجاد کلیک کنید. صفحه ایجاد شده توسط سرویس گیرنده OAuth ظاهر می شود که شناسه مشتری و راز مشتری جدید شما را نشان می دهد.
  9. روی OK کلیک کنید. اعتبار جدید ایجاد شده در زیر "OAuth 2.0 Client IDs" ظاهر می شود.

برنامه کروم

  1. در کنسول Google Cloud، به منو > APIs & Services > Credentials بروید.

    به Credentials بروید

  2. روی ایجاد اعتبارنامه > شناسه مشتری OAuth کلیک کنید.
  3. روی نوع برنامه > برنامه Chrome کلیک کنید.
  4. در قسمت "Name" یک نام برای اعتبارنامه تایپ کنید. این نام فقط در کنسول Google Cloud نشان داده می شود.
  5. در قسمت «شناسه برنامه»، رشته شناسه منحصربه‌فرد 32 نویسه‌ای برنامه خود را وارد کنید. می‌توانید این مقدار شناسه را در URL فروشگاه وب Chrome برنامه خود و در داشبورد برنامه‌نویس فروشگاه وب Chrome پیدا کنید.
  6. روی ایجاد کلیک کنید. صفحه ایجاد شده توسط سرویس گیرنده OAuth ظاهر می شود که شناسه مشتری و راز مشتری جدید شما را نشان می دهد.
  7. روی OK کلیک کنید. اعتبار جدید ایجاد شده در زیر "OAuth 2.0 Client IDs" ظاهر می شود.

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

  1. در کنسول Google Cloud، به منو > APIs & Services > Credentials بروید.

    به Credentials بروید

  2. روی ایجاد اعتبار > شناسه مشتری OAuth کلیک کنید.
  3. روی نوع برنامه > برنامه دسکتاپ کلیک کنید.
  4. در قسمت نام ، نامی را برای اعتبارنامه تایپ کنید. این نام فقط در کنسول Google Cloud نشان داده می شود.
  5. روی ایجاد کلیک کنید. صفحه ایجاد شده توسط سرویس گیرنده OAuth ظاهر می شود که شناسه مشتری و راز مشتری جدید شما را نشان می دهد.
  6. روی OK کلیک کنید. اعتبار جدید ایجاد شده در شناسه های مشتری OAuth 2.0 ظاهر می شود.

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

  1. در کنسول Google Cloud، به منو > APIs & Services > Credentials بروید.

    به Credentials بروید

  2. روی ایجاد اعتبار > شناسه مشتری OAuth کلیک کنید.
  3. روی نوع برنامه > تلویزیون‌ها و دستگاه‌های ورودی محدود کلیک کنید.
  4. در قسمت "Name" یک نام برای اعتبارنامه تایپ کنید. این نام فقط در کنسول Google Cloud نشان داده می شود.
  5. روی ایجاد کلیک کنید. صفحه ایجاد شده توسط سرویس گیرنده OAuth ظاهر می شود که شناسه مشتری و راز مشتری جدید شما را نشان می دهد.
  6. روی OK کلیک کنید. اعتبار جدید ایجاد شده در زیر "OAuth 2.0 Client IDs" ظاهر می شود.

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

  1. در کنسول Google Cloud، به منو > APIs & Services > Credentials بروید.

    به Credentials بروید

  2. روی ایجاد اعتبار > شناسه مشتری OAuth کلیک کنید.
  3. روی نوع برنامه > Universal Windows Platform (UWP) کلیک کنید.
  4. در قسمت "Name" یک نام برای اعتبارنامه تایپ کنید. این نام فقط در کنسول Google Cloud نشان داده می شود.
  5. در قسمت «Store ID»، مقدار شناسه فروشگاه مایکروسافت 12 کاراکتری منحصر به فرد برنامه خود را وارد کنید. می‌توانید این شناسه را در URL فروشگاه مایکروسافت برنامه‌تان و در مرکز شریک پیدا کنید.
  6. روی ایجاد کلیک کنید. صفحه ایجاد شده توسط سرویس گیرنده OAuth ظاهر می شود که شناسه مشتری و راز مشتری جدید شما را نشان می دهد.
  7. روی OK کلیک کنید. اعتبار جدید ایجاد شده در زیر "OAuth 2.0 Client IDs" ظاهر می شود.

اعتبار حساب خدمات

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

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

کنسول Google Cloud

  1. در کنسول Google Cloud، به منو > IAM & Admin > حساب‌های سرویس بروید.

    به حساب های خدماتی بروید

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

gcloud CLI

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

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

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

  1. در کنسول Google Admin، به منو > حساب > نقش‌های سرپرست بروید.

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

  2. به نقشی که می‌خواهید اختصاص دهید اشاره کنید و سپس روی Assign admin کلیک کنید.

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

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

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

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

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

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

  1. در کنسول Google Cloud، به منو > IAM & Admin > حساب‌های سرویس بروید.

    به حساب های خدماتی بروید

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

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

  5. روی Close کلیک کنید.

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

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

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

  1. در کنسول Google Cloud، به منو > IAM & Admin > حساب‌های سرویس بروید.

    به حساب های خدماتی بروید

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

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

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

    1. در کنسول Google Admin، به منو > امنیت > کنترل دسترسی و داده > کنترل‌های API بروید.

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

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

گام بعدی

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