סקירה כללית

ספריית הלקוח של 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 מופיעה בדף Dependencies.

התקנה

פועלים לפי ההוראות במסמכי העזרה שלנו בנושא התקנה כדי להתקין את הספרייה מ-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, תוכלו להשתמש בספריית הלקוח בדרכים הבאות: