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

מאחזרים משאבי 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 ומחלקים את התוצאות לדפים.

הגדרת כותרות של בקשות

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

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

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