Pobierz zasoby PartnerLink, wysyłając SearchPartnerLinksRequest.
Pole parent żądania jest wymagane. Ustaw parent na nazwę zasobu konkretnego konta w formacie:
accountTypes/{account_type}/accounts/{account}
Aby zapewnić elastyczność w różnych przypadkach użycia, SearchPartnerLinksResponse zawiera wszystkie zasoby PartnerLink, w których parent w żądaniu to:
- Konto określone w polu
owner_account - Konto określone w polu
partner_account
Ustaw nagłówki żądania, jeśli uzyskujesz dostęp do konta parent za pomocą linku partnera, nadrzędnego konta menedżera Google Ads lub nadrzędnego konta partnera Display & Video 360.
Filtrowanie wyników, aby ograniczyć odpowiedź do zasobów o określonych atrybutach.
Metoda Search zwraca strony wyników. Aby pobrać wszystkie zasoby dla żądania, sprawdź next_page_token i podziel wyniki na strony.
Ustawianie nagłówków żądań
Metoda Search obsługuje nagłówek login-account, który umożliwia zdefiniowanie w żądaniu ścieżki dostępu danych logowania do konta parent. Nagłówek linked-account nie jest obsługiwany w przypadku metod PartnerLinkService.
Szczegółowe informacje i instrukcje dotyczące ustawiania nagłówków w różnych scenariuszach dostępu znajdziesz w artykule Miejsca docelowe i nagłówki.
Filtruj wyniki
Aby pobrać konkretne linki partnerów, użyj pola filter żądania. Pole filter to ciąg znaków, który definiuje zestaw warunków, które chcesz zastosować, oraz określa, czy interfejs API powinien połączyć warunki za pomocą AND czy OR.
Więcej informacji o opcjach i składni filtrowania znajdziesz w artykule AIP-160: filtrowanie.
Możesz zdefiniować filter, używając account_id konta właściciela lub konta partnera:
owning_account.account_id:account_idkonta właściciela.partner_account.account_id:account_idkonta partnera.
Oto na przykład filter, który zwraca wszystkie linki partnera, w przypadku których konto właściciela ma identyfikator konta OWNING_ACCOUNT_ID:
owning_account.account_id = OWNING_ACCOUNT_ID
Oto inny przykład: filter. Spowoduje to zwrócenie wszystkich linków partnera, w przypadku których konto właściciela ma identyfikator konta OWNING_ACCOUNT_ID lub konto partnera ma identyfikator konta PARTNER_ACCOUNT_ID:
owning_account.account_id = OWNING_ACCOUNT_ID OR partner_account.account_id = PARTNER_ACCOUNT_ID
Jeśli zmodyfikujesz ten parametr filter, aby używać AND zamiast OR, zwrócone zasoby zostaną ograniczone do linków partnera, w przypadku których zarówno konto właściciela ma identyfikator konta OWNING_ACCOUNT_ID, jak i konto partnera ma identyfikator konta PARTNER_ACCOUNT_ID:
owning_account.account_id = OWNING_ACCOUNT_ID AND partner_account.account_id = PARTNER_ACCOUNT_ID
Podział wyników na strony
Użyj pola page_size, aby kontrolować liczbę wyników zwracanych w jednej odpowiedzi. Jeśli na przykład ustawisz parametr page_size na 10, interfejs API zwróci maksymalnie 10 wyników na odpowiedź. Jeśli Twoje żądanie pasuje do mniej niż 10 wyników, interfejs API może zwrócić mniej niż 10 wyników.
Domyślna wartość page_size to 50, a maksymalna – 1000.
Jeśli wyników jest więcej, niż może się zmieścić w jednej odpowiedzi, odpowiedź będzie zawierać parametr next_page_token. Aby pobrać następną stronę lub zestaw wyników, wyślij ponownie to samo żądanie z polem page_token ustawionym na tę wartość. Wszystkie pozostałe parametry muszą być takie same jak w poprzednim żądaniu.
Jeśli pole next_page_token nie jest uwzględnione w odpowiedzi, oznacza to, że nie ma więcej wyników.