אחזור קישורים של שותפים

אחזור משאבי PartnerLink באמצעות שליחת SearchPartnerLinksRequest.

השדה parent בבקשה הוא שדה חובה. מגדירים את parent לשם המשאב של חשבון ספציפי, בפורמט:

accountTypes/{account_type}/accounts/{account}

כדי לאפשר גמישות בתרחישים שונים לדוגמה, SearchPartnerLinksResponse מכיל את כל המשאבים של PartnerLink שבהם parent בבקשה הוא:

• החשבון שזוהה בשדה owner_account
• החשבון שזוהה בשדה partner_account

מגדירים כותרות של בקשות אם אתם ניגשים לחשבון parent באמצעות קישור שותף, חשבון ניהול ראשי ב-Google Ads או חשבון שותף ראשי ב-Display & Video 360.

לסנן את התוצאות כדי להגביל את התגובה למשאבים עם מאפיינים ספציפיים.

השיטה Search מחזירה דפים של תוצאות. כדי לאחזר את כל המשאבים של בקשה, צריך לבדוק את next_page_token ולחלק את התוצאות לדפים.

הגדרת כותרות של בקשות (request headers)

ה-method‏ Search תומכת בכותרת login-account כדי להגדיר את נתיב הגישה של פרטי הכניסה לחשבון parent בבקשה. הכותרת linked-account לא נתמכת בשיטות PartnerLinkService.

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

סינון התוצאות

כדי לאחזר קישורים ספציפיים של שותפים, משתמשים בשדה filter של הבקשה. השדה filter הוא מחרוזת שמגדירה את קבוצת התנאים שרוצים להחיל, וגם אם ה-API צריך לשלב את התנאים באמצעות AND או OR. מידע נוסף על אפשרויות הסינון והתחביר זמין במאמר AIP-160: Filtering.

אפשר להגדיר את filter באמצעות account_id של החשבון שמוגדר כבעלים או של חשבון השותף:

• ‫owning_account.account_id: account_id של החשבון שמוגדר כבעלים.
• ‫partner_account.account_id: account_id של חשבון השותף.

לדוגמה, הנה filter שמחזיר את כל הקישורים לשותפים שבהם החשבון שבבעלותו הוא מזהה החשבון OWNING_ACCOUNT_ID:

owning_account.account_id = OWNING_ACCOUNT_ID

הנה דוגמה נוספת לfilter. הפעולה הזו מחזירה את כל הקישורים לשותפים שבהם החשבון שמוגדר כבעלים הוא עם מספר החשבון OWNING_ACCOUNT_ID או שחשבון השותף הוא עם מספר החשבון PARTNER_ACCOUNT_ID:

owning_account.account_id = OWNING_ACCOUNT_ID OR partner_account.account_id = PARTNER_ACCOUNT_ID

אם משנים את filter כך שישתמש ב-AND במקום ב-OR, המשאבים שיוחזרו יוגבלו לקישורי השותפים שבהם גם לחשבון שמוגדר כבעלים יש את מזהה החשבון OWNING_ACCOUNT_ID וגם לחשבון השותף יש את מזהה החשבון PARTNER_ACCOUNT_ID:

owning_account.account_id = OWNING_ACCOUNT_ID AND partner_account.account_id = PARTNER_ACCOUNT_ID

תוצאות בחלוקה לדפים

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

ערך ברירת המחדל של page_size הוא 50 והערך המקסימלי הוא 1,000.

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

אם השדה next_page_token לא נכלל בתגובה, סימן שאין יותר תוצאות.