מדריך

בדף הזה מפורט מידע על ביצוע משימות נפוצות באמצעות ה-API.

יצירת משתמשים

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

  1. ליצור כמה כתובות Gmail חדשות, כמו my.name.salesperson@gmail.com. לחלופין, לרשום כתובת קיימת שאינה של Gmail ככתובת חשבון Google.
  2. התקשרות אל createUsers עם הכתובת החדשה הזו ועם Role שבחרת.
  3. אפשר לבצע אימות כמשתמש החדש באמצעות OAuth 2.0 כדי ליצור את אסימון הגישה.

קבלת יחידת המודעות הבסיסית

גם AdUnit העליונים שאליהם אפשר להוסיף צומתי צאצא וגם את העומק המותר של ההיררכיה, תלויים בסוג החשבון (עסק קטן או פרימיום). הערך העליון של AdUnit שתומך בשינוי צומתי הצאצא שלו נקרא הרמה הבסיסית (root) האפקטיבית AdUnit.

כדי לאחזר את השורש בפועל, קוראים לפונקציה NetworkService.getCurrentNetwork() ובוחנים את השדה effectiveRootAdUnitId באובייקט Network שמוחזר.

הערה: סוגי חשבונות שונים תומכים בדפוסים שונים של היררכיה.

שליחת שאילתה לאובייקט

מחפשים אובייקטים לפי קריטריוני חיפוש באמצעות השיטה getObjectsByStatement() נחשף על ידי שירותים רבים, שבהם אובייקט הוא סוג אובייקט ספציפי. הזה היא לוקחת שאילתת PQL, שדומה לשאילתת SQL בכך שהיא מאפשרת שדות לחיפוש (כאשר שמות השדות ממופים למאפיינים באובייקט), מיון, ולקזז את תוצאות החיפוש. לעיון ב-PQL מדריך לקבלת מידע נוסף על PQL וגם כדי ללמוד אילו שדות אובייקטים אפשר לסנן לפי.

יצירת הזמנה

כדי ליצור הזמנה, פשוט יוצרים אובייקט Order ומגדירים את המפרסם, אנשי מכירות ומזהים של מנהלי טראפיק למשתמשים המתאימים, להקצות שם ייחודי, ולהתקשר אל createOrders(). התוצאה תכלול את הקובץ Order החדש שנוצר, או שגיאה.

דוגמה

קוד Java לדוגמה ליצירת הזמנה

יצירת פריט

אלה השלבים ליצירת פריט חדש:

  1. יוצרים אובייקט Order חדש או משתמשים באובייקט קיים.
  2. יוצרים אובייקט LineItem חדש, ומגדירים את סוג הסבב, מערך גודל הקריאייטיב, תאריכי התחלה וסיום ונכסים אחרים.
  3. יוצרים אובייקט InventoryTargeting חדש ומציינים אילו אובייקטים מסוג Placement או AdUnit רוצים לטרגט או להחריג.
  4. צריך לעטוף את האובייקט InventoryTargeting בתוך אובייקט Targeting חדש, ולהקצות אותו לנכס הטירגוט של LineItem.
  5. קוראים ל-method createLineItems() של השירות של הפריט עם האובייקט החדש ובודקים את התוצאה כדי לראות אם האובייקט נוצר.

דוגמה

ראו קוד Java לדוגמה ליצירת פריט.

יצירת קריאייטיב

סוגים שונים של נכסי קריאייטיב תומכים ברכיבים שונים: למשל, תמונה הקריאייטיב תומך בקובץ מקור יחיד עבור התמונה; קריאייטיב Flash תומך שני קובצי נכס בסיסיים: קובץ Flash וקובץ תמונה לגיבוי, למקרה שהפלאש לא ניתן להציג את הקובץ. עבור נכסי קריאייטיב שמתארחים באתרים של צד שלישי, צריך להעלות רק קטע HTML שמפנה לקובץ בשרת של הצד השלישי. לצפייה תת-מחלקה ספציפית של Creative כדי ללמוד אילו נכסים צריך להעלות כדי כדי ליצור את הקריאייטיב.

דוגמה

ראו קוד Java לדוגמה ליצירת קריאייטיב של תמונה.

שינוי אובייקט קיים

כדי לשנות אובייקט קיים, שולחים שאילתה לאובייקט באמצעות קריאה ל-getObjectsByStatement(), מעדכנים את הערכים באובייקטים שמוחזרים, ואז קוראים ל-updateObjects().

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

שינוי סטטוס אובייקט

סטטוס האובייקט משתנה באמצעות קריאה ל-method performObjectAction() נחשפו על ידי השירות שלכם. השיטה הזו כוללת שני פרמטרים:

  • מופע של אובייקט הפעולה שמתאר את מה שרוצים לעשות. עבור למשל, שירות ההזמנות חושף מספר פעולות, כולל ApproveOrders, PauseOrders, ו-ArchiveOrders. כל האובייקטים של פעולה נגזרים מפעולה בסיסית שמתאימה לשירות שלכם.
  • שאילתת PQL שמתארת אילו אובייקטים צריך לשנות. אפשר לשנות את הסטטוס של אובייקט אחד או יותר בכל פעם על ידי ציון PQL מתאים הצהרה.

יצירת תגי מודעות

אין אפשרות ליצור תגי מודעות באמצעות ה-API. במקום זאת, יש להשתמש באתר של Google Ad Manager. מידע נוסף זמין בקטע תיוג במרכז העזרה, בקטע בנושא מידע נוסף.

דוגמאות נוספות

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