با CSS API شروع کنید

در اینجا نحوه استفاده از CSS API آورده شده است:

مجوزها

برای کار با CSS API، باید مجوزها را در دو مکان پیکربندی کنید: Google Cloud و CSS Center.

  1. Google Cloud IAM:

    • یک حساب سرویس در Google Cloud Console ایجاد کنید. دستورالعمل‌های مشابه Content API را برای ایجاد و دانلود فایل اعتبار JSON دنبال کنید. این مرحله حساب سرویس شما را به عنوان یک موجودیت معتبر Google Cloud احراز هویت می کند.
    • اگر از دسترسی مستقیم REST یا کتابخانه های Google API Client استفاده می کنید، همچنین به یک کلید API تولید شده از Google Cloud Console نیاز دارید.

  2. مرکز CSS:

    • آدرس ایمیل حساب سرویس (به عنوان مثال، your-service-account-name@your-project-id.iam.gserviceaccount.com ) باید به عنوان کاربری با دسترسی Admin به حساب CSS Center شما اضافه شود. این مرحله به حساب سرویس اجازه دسترسی و مدیریت داده های مرکز CSS شما را می دهد.
    • می‌توانید در سطح CSS Group (برای دسترسی به همه دامنه‌ها) یا به حساب‌های خاص دامنه CSS اجازه دسترسی بدهید. برای دسترسی API، اعطای دسترسی در سطح CSS Group رایج است.
    • برای افزودن حساب سرویس:
      • با یک کاربر سرپرست وارد CSS Center شوید.
      • به دسترسی به حساب (در زیر نماد چرخ دنده ⚙️) بروید.
      • روی + افزودن کاربر کلیک کنید و ایمیل حساب سرویس را وارد کنید.
      • سطح دسترسی را روی Admin تنظیم کنید.
    • انتشار مجوزها ممکن است تا 30 دقیقه طول بکشد. اگر با خطاهای مجوز مواجه شدید، بعداً دوباره امتحان کنید.

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

محدوده مورد نیاز OAuth 2.0 برای CSS API عبارت است از:

  • https://www.googleapis.com/auth/content

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

CSS API را فعال کنید

برای استفاده از CSS API، باید آن را در پروژه Google Cloud خود فعال کنید. می‌توانید کتابخانه را در https://console.cloud.google.com/apis/library/css.googleapis.com پیدا کنید.

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

CSS API دارای نمونه‌های کد و کتابخانه‌های کلاینت است که به شما در شروع کار کمک می‌کند. ما همچنین یک صفحه بهترین روش ها داریم.

درخواست ها را ارسال کنید

درخواست ها را به URL ها در قالب زیر ارسال کنید:

https://css.googleapis.com/{version}/{resource name}:{method}…

جایی که {resource name} نام منبعی است که تماس شما بر آن تأثیر می‌گذارد.

به عنوان مثال، در اینجا نحوه حذف یک منبع با gRPC آمده است:

https://css.googleapis.com/v1/{resource name}:delete

در اینجا نحوه حذف یک منبع با REST آمده است:

DELETE https://css.googleapis.com/v1/{resource name}

برای جزئیات بیشتر در مورد خدمات خاص، به مستندات مرجع CSS API مراجعه کنید.

از gRPC یا REST استفاده کنید

CSS API از gRPC و REST پشتیبانی می کند. در اینجا دو راه برای برقراری تماس های CSS API وجود دارد:

gRPC (توصیه می شود) استراحت
  1. بدنه درخواست را به عنوان بافر پروتکل ایجاد کنید.
  2. متن درخواست را با HTTP/2 به سرور ارسال کنید.
  3. پاسخ به یک بافر پروتکل را غیراصولی کنید.
  4. نتایج را تفسیر کنید.
  1. بدنه درخواست را به عنوان یک شی JSON ایجاد کنید.
  2. آن را با استفاده از HTTP 1.1 به سرور ارسال کنید.
  3. پاسخ را به‌عنوان یک شی JSON از حالت سریال خارج کنید.
  4. نتایج را تفسیر کنید.

کمک بگیرید

برای پشتیبانی با نماینده Google خود تماس بگیرید یا از فرم بازخورد برای گزارش هرگونه مشکل استفاده کنید.

در اینجا نحوه ارائه بازخورد بیشتر در صورت بروز مشکلات آمده است:

بازخورد بدهید

برای ارائه بازخورد، یکی از موارد زیر را ارسال کنید:

  • ویژگی های API: فرم بازخورد را ارسال کنید
  • مستندات: از رتبه‌بندی انگشت شست درون صفحه و دکمه ارسال بازخورد استفاده کنید.
  • نمونه ها و کتابخانه ها: از دکمه شماره جدید در GitHub استفاده کنید.

برای ارائه بازخورد کلی پس از اجرای هر کار، از فرم بازخورد استفاده کنید.

قبلی
نمای کلی
بعدی
بهترین شیوه ها