בדף הזה מוסבר איך לבצע משימות נפוצות באמצעות ה-API.
יצירת משתמשים
UserService מאפשר למשתמשים עם הרשאות אדמין ליצור משתמש ישירות ברשת. כל מפתח יכול לעשות זאת מבלי לדרוש מהמשתמש החדש להירשם קודם. לדוגמה, אם אתם מנסים את ה-API בפעם הראשונה, במקום לבצע כל קריאה ל-API כאדמין (ברירת המחדל לכתובת האימייל שלכם), כדאי ליצור כמה משתמשים עם תפקידים כמו 'איש מכירות', 'מנהל טראפיק' או 'מפרסם' כדי לבדוק את תהליכי העבודה בעולם האמיתי.
- ליצור כמה כתובות Gmail חדשות כמו
my.name.dfp.salesperson@gmail.com. לחלופין, אפשר לרשום כתובת קיימת שאינה ב-Gmail כחשבון Google חדש. - התקשרות אל
createUsersעם הכתובת החדשה הזו ועםRoleשבחרת. - אפשר לבצע אימות בתור המשתמש החדש באמצעות OAuth 2.0 כדי ליצור את אסימון הגישה שלכם.
קבלת יחידת המודעות הבסיסית
גם ה-AdUnit העליונים שאליהם אפשר להוסיף צומתי צאצא וגם העומק המותר של ההיררכיה תלויים בסוג החשבון (עסק קטן או פרימיום). ה-AdUnit העליון ביותר שתומך בשינוי צומתי הצאצא שלו נקרא הרמה הבסיסית (root) בפועל AdUnit.
כדי לאחזר את השורש האפקטיבי, צריך לקרוא ל-NetworkService.getCurrentNetwork() ולבחון את השדה effectiveRootAdUnitId באובייקט Network שהוחזר.
הערה: סוגי חשבונות שונים תומכים בדפוסים שונים של היררכיה.
שאילתות על אובייקט
חיפוש אובייקטים לפי קריטריונים של חיפוש באמצעות השיטה getObjectsByStatement() שנחשפה על ידי שירותים רבים, כאשר Object הוא סוג אובייקט ספציפי. השיטה הזו משתמשת בשאילתת PQL, שדומה לשאילתת SQL בכך שהיא מאפשרת לציין שדות לחיפוש (שבהם שמות השדות ממופים למאפיינים באובייקט), למיין, להגביל ולקזז את תוצאות החיפוש. במדריך
PQL יש מידע נוסף על PQL, ומידע על שדות האובייקטים שלפיהם אפשר לסנן.
יצירת הזמנה
כדי ליצור הזמנה, פשוט יוצרים אובייקט Order ומגדירים את מזהי המפרסם,
אנשי המכירות ומנהלי הטראפיק למשתמשים המתאימים,
מקצים שם ייחודי
וקוראים ל-createOrders(). התוצאה תכלול את Order החדש שנוצר או שיש בו שגיאה.
דוגמה
אפשר לראות דוגמה לקוד Java ליצירת הזמנה.
יצירת פריט
אלה השלבים ליצירת פריט חדש:
- יוצרים אובייקט
Orderחדש או משתמשים באובייקט קיים. - יצירת אובייקט
LineItemחדש, והגדרת סוג הסבב, מערך הגודל של הקריאייטיב, תאריכי ההתחלה והסיום ומאפיינים נוספים. - יוצרים אובייקט
InventoryTargetingחדש ומציינים אילו אובייקטים מסוגPlacementאוAdUnitרוצים לטרגט או להחריג. - צריך לכלול את האובייקט
InventoryTargetingבתוך אובייקטTargetingחדש, ולהקצות אותו למאפיין הטירגוט שלLineItem. - קוראים לשיטת שירות הפריטים
createLineItems()עם האובייקט החדש, ובודקים את התוצאה כדי לראות אם האובייקט נוצר.
דוגמה
ראו דוגמה לקוד Java ליצירת פריט.
יצירת קריאייטיב
סוגים שונים של קריאייטיבים תומכים ברכיבים שונים: לדוגמה, קריאייטיב של תמונות תומך בקובץ מקור יחיד של התמונה, וקריאייטיב Flash תומך
בשני קובצי נכסים בסיסיים: קובץ Flash וקובץ תמונה לגיבוי, במקרה שלא ניתן להציג את קובץ ה-Flash. עבור קריאייטיבים שמתארחים באתרים של צד שלישי, יש להעלות רק קטע קוד HTML שמפנה לקובץ בשרת של צד שלישי. יש לעיין
במחלקה המשנית הספציפית של Creative כדי לראות אילו נכסים צריך להעלות
כדי ליצור את הקריאייטיב.
דוגמה
ראו לדוגמה קוד Java ליצירת קריאייטיב של תמונה.
שינוי אובייקט קיים
כדי לשנות אובייקט קיים, שולחים שאילתה לאובייקט על ידי קריאה ל-getObjectsByStatement(), מעדכנים את הערכים באובייקטים שהוחזרו ולאחר מכן קוראים ל-updateObjects().
הערה: אובייקטים מעודכנים יחליפו לגמרי את האובייקטים הקיימים, כך שאם לא מגדירים ערך למאפיין באובייקט ששולחים, האובייקט השמור יקבל את ערך ברירת המחדל של המאפיין הזה, ולא את הערך הקודם.
שינוי סטטוס של אובייקט
כדי לשנות את סטטוס האובייקט, קוראים לשיטה performObjectAction() שנחשפה על ידי השירות שלכם. לשיטה הזו יש שני פרמטרים:
- מופע של אובייקט הפעולה שמתאר את מה שאתם רוצים לעשות. לדוגמה, שירות ההזמנות חושף מספר פעולות, כולל
ApproveOrders,PauseOrdersו-ArchiveOrders. אובייקטי פעולה נגזרים כולם מסיווג פעולה בסיסי שמתאים לשירות שלכם. - שאילתת PQL שמתארת אילו אובייקטים לשנות. אפשר לשנות את הסטטוס של אובייקט אחד או יותר בכל פעם על ידי ציון הצהרת PQL מתאימה.
יצירת תגי מודעות
לא ניתן ליצור תגי מודעות באמצעות ה-API. במקום זאת, יש להשתמש באתר Google Ad Manager. מידע נוסף זמין בקטע תיוג במרכז העזרה.
דוגמאות נוספות
אפשר למצוא דוגמאות רבות נוספות בקוד לדוגמה של ספריית הלקוח שלנו, במספר שפות תכנות שונות. קישור לדוגמאות בשפת התכנות שלך זמין בדף ספריות לקוח וקוד לדוגמה .