איך מתחילים להשתמש ב-CSS API

כך משתמשים ב-CSS API:

הרשאות

כדי לעבוד עם CSS API, צריך להגדיר הרשאות בשני מקומות: ב-Google Cloud וב-CSS Center.

  1. ‫Google Cloud IAM:

    • יוצרים חשבון שירות במסוף Google Cloud. כדי ליצור ולהוריד את קובץ פרטי הכניסה בפורמט JSON, פועלים לפי ההוראות שדומות לאלה של Content API. בשלב הזה מתבצע אימות של חשבון השירות כישות תקפה ב-Google Cloud.
    • אם אתם משתמשים בגישת REST ישירה או בספריות הלקוח של Google API, אתם צריכים גם מפתח API שנוצר במסוף Google Cloud.

  2. CSS Center:

    • כתובת האימייל של חשבון השירות (לדוגמה, your-service-account-name@your-project-id.iam.gserviceaccount.com) צריך להוסיף אותו כמשתמש עם גישת אדמין לחשבון CSS Center. בשלב הזה מאשרים לחשבון השירות לגשת לנתונים שלכם במרכז של שירות השוואת המחירים ולנהל אותם.
    • אתם יכולים להעניק גישה ברמת קבוצת ה-CSS (לגישה לכל הדומיינים) או לחשבונות ספציפיים של דומיינים ב-CSS. בגישה ל-API, נהוג להעניק גישה ברמת קבוצת ה-CSS.
    • כדי להוסיף את חשבון השירות:
      • נכנסים ל-CSS Center בתור משתמש עם הרשאת אדמין.
      • עוברים אל גישה לחשבון (מתחת לסמל גלגל השיניים ⚙️).
      • לוחצים על + הוספת משתמש ומזינים את כתובת האימייל של חשבון השירות.
      • מגדירים את רמת הגישה לאדמין.
    • יכולות לעבור עד 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 (מומלץ) REST
  1. יוצרים את גוף הבקשה כמאגר פרוטוקולים.
  2. שליחת גוף הבקשה לשרת באמצעות HTTP/2.
  3. מבטלים את הסריאליזציה של התגובה ל-Protocol Buffer.
  4. פרש את התוצאות.
  1. יוצרים את תוכן הבקשה כאובייקט JSON.
  2. שולחים אותו לשרת באמצעות HTTP 1.1.
  3. מבטלים את הסריאליזציה של התגובה כאובייקט JSON.
  4. פרש את התוצאות.

עזרה

כדי לקבל תמיכה, אפשר לפנות לנציג Google או להשתמש בטופס המשוב כדי לדווח על בעיות.

אם נתקלתם בבעיות, תוכלו לשלוח לנו משוב נוסף:

שליחת משוב

כדי לשלוח משוב, אפשר להשתמש באחת מהאפשרויות הבאות:

  • תכונות של ה-API: שליחת טופס המשוב
  • מסמכי תיעוד: אפשר להשתמש בדירוג באמצעות סימני לייק ודיסלייק בדף ובכפתור שליחת משוב.
  • דוגמאות וספריות: משתמשים בכפתור New issue (בעיה חדשה) ב-GitHub.

כדי לשלוח משוב כללי אחרי שמבצעים כל משימה, אפשר להשתמש בטופס המשוב.

הקודם
סקירה כללית
הבא
שיטות מומלצות