Pobierz zasoby PartnerLink, wysyłając SearchPartnerLinksRequest.
Pole parent w żądaniu 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, element SearchPartnerLinksResponse zawiera wszystkie zasoby PartnerLink, w których element parent w żądaniu jest:
- Konto zidentyfikowane w polu
owner_account - Konto zidentyfikowane w polu
partner_account
Ustaw nagłówki żądań, jeśli uzyskujesz dostęp do konta parent za pomocą linku partnerskiego, nadrzędnego konta menedżera Google Ads lub nadrzędnego konta partnerskiego Display & Video 360.
Filtrować wyniki, aby ograniczyć odpowiedź do zasobów o określonych atrybutach.
Metoda Search zwraca strony z wynikami. Aby pobrać wszystkie zasoby dla żądania, sprawdź next_page_token i stronicuj wyniki.
Ustawianie nagłówków żądań
Metoda Search obsługuje nagłówki login-account i linked-account, aby zdefiniować ścieżkę dostępu danych logowania do konta parent w żądaniu. Szczegółowe informacje i instrukcje dotyczące ustawiania nagłówków w różnych scenariuszach dostępu znajdziesz w sekcji Miejsca docelowe i nagłówki.
Filtruj wyniki
Użyj pola filter w żądaniu, aby pobrać konkretne linki partnerskie. Pole filter to ciąg znaków, który określa zbiór warunków, jakie chcesz zastosować, oraz sposób, w jaki interfejs API ma łączyć warunki – za pomocą operatora AND lub OR.
Więcej informacji o opcjach filtrowania i składni znajdziesz w AIP-160: Filtering.
Możesz zdefiniować filter za pomocą 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.
Przykład: oto filter, który zwraca wszystkie linki partnerskie, w których konto będące właścicielem ma identyfikator OWNING_ACCOUNT_ID:
owning_account.account_id = OWNING_ACCOUNT_ID
Oto kolejny przykład filter. Zwraca wszystkie połączenia partnerów, w których konto właściciela ma identyfikator OWNING_ACCOUNT_ID lub konto partnera ma identyfikator PARTNER_ACCOUNT_ID:
owning_account.account_id = OWNING_ACCOUNT_ID OR partner_account.account_id = PARTNER_ACCOUNT_ID
Zmiana tego warunku filter na AND zamiast OR ogranicza zwracane zasoby do linków partnerskich, w 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 określić liczbę wyników zwracanych w pojedynczej odpowiedzi. Jeśli na przykład ustawisz wartość page_size na 10, interfejs API zwróci maksymalnie 10 wyników w odpowiedzi. Jeśli liczba wyników pasujących do Twojego żądania jest mniejsza niż 10, interfejs API może zwrócić mniej niż 10 wyników.
Domyślna wartość page_size to 50, a maksymalna to 1000.
Jeśli wyników jest więcej niż można zmieścić w jednej odpowiedzi, będzie ona zawierać 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 w odpowiedzi nie ma pola next_page_token, oznacza to, że nie ma więcej wyników.