סקירה כללית

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

דרישות

בספרייה צריך להשתמש ב-Python מגרסה 3.8 ואילך.

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

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

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

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

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

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

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

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

לרשימה המלאה של יחסי התלות וזמני ריצה שנתמכים ב-Python, אפשר לעיין ב תלות.

התקנה

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

תצורה

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

אימות

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

שליחת בקשה ל-API

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

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

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

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

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