כפי שמתואר במדריך למבנה ה-API, לכל משאב ברמה העליונה ב-Google Ads API יש שירות תואם ספציפי לסוג המשאב שתומך בפעולות הבאות:
- שינוי המופעים של המשאב
- אחזור של מופע יחיד של המשאב לצורך בדיקה
במדריך הזה נשתמש ב-CampaignService
כדי להדגים שינוי ובדיקה של אובייקטים מסוג Campaign
, אבל אותם מושגים חלים על כל השירותים האחרים שספציפיים לסוג המשאב.
שינוי אובייקטים
לכל שירות ספציפי לסוג משאב תהיה שיטה mutate שמקבלת בקשת שינוי. הבקשה הזו מורכבת מ:
customerId
- אוסף של פעולות
- הגדרת סוג התוכן של התגובה, שמחליטה אם להחזיר את המשאב הניתן לשינוי או רק את שם המשאב אחרי המוטציה.
לדוגמה, השיטה MutateCampaigns
של CampaignService
מקבלת MutateCampaignsRequest
שמכיל:
customerId
- אוסף של אובייקטים מסוג
CampaignOperation
- השדה
response_content_type
שמציין את סוג התגובה המועדף.
תפעול
אובייקט פעולה כמו CampaignOperation
מאפשר לכם לציין את הפעולה שרוצים לבצע במשאב יחיד על ידי הגדרת השדה operation
שלו. השדה הזה הוא שדה oneof שמורכב מהמאפיינים הבאים, שהסוג שלהם הוא סוג המשאב:
create
- יצירת מכונה חדשה של המשאב
update
- מעדכן את המשאב כך שיתאים למאפיינים של המשאב
update
. כשמגדירים את השדה הזה, צריך להגדיר גם אתupdate_mask
של הפעולה, שמציין ל-Google Ads API אילו מאפיינים לשנות במהלך פעולת העדכון. לכל ספריית לקוח יש שיטה שימושית או שיטה מסייעת שייצרו בשבילכם אתupdate_mask
, כפי שמוצג בספריות הלקוח שלנו. remove
- הסרת המשאב.
מכיוון ששדה operation
הוא שדה oneof
, אי אפשר להשתמש בפעולה אחת כדי לשנות כמה אובייקטים. לדוגמה, אם רוצים ליצור קמפיין אחד ולהסיר קמפיין אחר, מוסיפים לבקשה שתי מופעים של CampaignOperation
: אחד עם create
מוגדר ואחד עם remove
מוגדר.
קיבוץ פעולות
פעולה אחת יכולה ליצור, לעדכן או להסיר רק משאב אחד, אבל בקשת שינוי אחת יכולה להכיל כמה פעולות. מומלץ לשלב את הפעולות בבקשת שינוי אחת במקום לשלוח כמה בקשות שינוי שכל אחת מהן מכילה פעולה אחת.
לדוגמה, אם רוצים ליצור עשרה קמפיינים, צריך לשלוח MutateCampaignsRequest
יחיד שכולל עשרה אובייקטים מסוג CampaignOperation
.
שינוי התשובות
מה שיוחזר בתגובה תלוי במה שנשלח ב-response_content_type
של בקשת ה-mutate. לדוגמה, אם צוין הערך MUTABLE_RESOURCE
, התגובה תכיל רק את השדות שניתן לשינוי בקמפיין. לאחר מכן תוכלו לבצע שינויים נוספים באובייקט המשאב הזה בלי צורך ליצור אותו מחדש.
שגיאות ב-Mutate
הפעולות שבבקשת שינוי ייכנסו לתוקף בחשבון Google Ads שלכם רק אם כל הפעולות שבבקשה יסתיימו בהצלחה. במדריך לגבי שגיאות נפוצות מפורטות רשימה של שגיאות נפוצות והצעות לפתרון שלהן.
בדיקת אובייקטים באמצעות get (הוחלפה)
בנוסף לשינוי אובייקטים, לכל שירות ספציפי לסוג משאב יש גם method get לאחזור כל המאפיינים של משאב יחיד.
השיטה הזו מקבלת בקשת get שהמאפיין היחיד שלה הוא resource_name
.
שיטות ה-get הן דרך נוחה ש-Google Ads API מציע לאחזור כל המאפיינים של אובייקט יחיד. זהו כלי מצוין ללמידת ה-API או לבדיקה של אובייקט ספציפי למטרות ניפוי באגים או למטרות לימוד, אבל לא כדאי להשתמש בשיטות get באפליקציה כדי לאחזר אובייקטים לצורך עיבוד או דיווח.
במקום זאת, כדאי להשתמש ב-GoogleAdsService
, כי הוא מאפשר לאחזר רק מאפיינים ספציפיים של אובייקטים, תומך באחזור של מדדי ביצועים ומאפשר סטרימינג של קבוצות תוצאות גדולות. אם האפליקציה שולחת מספר רב של בקשות קבלה, יכול להיות שתתקלו במגבלות קצב.