סקירה כללית

ספריית הלקוח של Python מתארחת ב-GitHub, והחבילה זמינה ב-PyPI.

דרישות

הספרייה דורשת Python 3.8 ואילך.

דרישות מוקדמות

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

תאימות של זמן ריצה ותלות

ספריית הלקוח של Python שומרת על תאימות לזמני הריצה של Python שמפורטים בקטע גרסאות נתמכות שפורסם על ידי Python Software Foundation, למעט גרסאות עם סטטוס 'תכונה' או 'גרסת טרום-הפצה'.

כשמאמצים גרסאות חדשות של Python runtime, אנחנו שואפים לפרסם גרסה חדשה של ספריית הלקוח של Python שתואמת ל-runtime העדכני עד סוף הרבעון שאחרי הפרסום. לדוגמה, אם סביבת זמן ריצה חדשה תושק באוקטובר, גרסה תואמת של ספריית הלקוח של Python תהיה זמינה עד סוף מרץ בשנה שלאחר מכן.

אין תמיכה בסביבות זמן ריצה של Python שהגיעו לסוף החיים (EOL) אחרי תאריך סוף החיים שמופיע בקטע Unsupported Versions באתר python.org.

יכול להיות שנשיק גרסה של ספריית הלקוח של Python שלא תהיה תואמת לזמני ריצה של Python שלא נתמכים בכל שלב אחרי שהם יגיעו לסוף החיים (EOL).

במקרה של תלות (במיוחד, כל החבילות ש-Google מתחזקת ומופיעות כחובה בספריית הלקוח של Google API ל-Python), נשמור על תאימות לחבילות ש-Google מתחזקת ונחשבות כ'נתמכות' בהתאם למדיניות של Google בנושא שינויים שוברים ב-OSS.

רשימה מלאה של סביבות זמן ריצה ותלויות נתמכות של Python זמינה בדף תלויות.

התקנה

פועלים לפי ההוראות במסמכי התיעוד בנושא התקנה כדי להתקין את הספרייה מ-PyPi, ואז חוזרים לדף הזה.

תצורה

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

אימות

אחרי שבוחרים סוג הגדרה, אפשר להמשיך ליצירת האסימונים הנותרים של OAuth2 שנדרשים כדי לשלוח בקשות ל-API. יש כמה תהליכי OAuth2 נתמכים, שמפורטים ברשימה הבאה. פרטים על ההבדלים בין תהליכי העבודה ועזרה בהחלטה איזה תהליך הכי מתאים לאפליקציה שלכם זמינים בתיעוד בנושא OAuth.

שליחת בקשת API

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

כדי להריץ את הדוגמה get_campaigns.py, בספריית הבסיס של ספריית הלקוח googleads-python שהתקנתם באופן מקומי, מריצים את הפקודה הבאה:

$ python examples/basic_operations/get_campaigns.py -c \
  INSERT_YOUR_CUSTOMER_ID_HERE

מקורות מידע נוספים

אחרי שתוכלו לשלוח בקשת API, תוכלו להמשיך לשימושים הבאים בספריית הלקוח: