Aby pobrać zasoby PartnerLink, wyślij SearchPartnerLinksRequest.
Pole parent w żądaniu jest wymagane. Ustaw parent na nazwę zasobu konkretnego konta w tym 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
albo:
- konto zidentyfikowane przez pole
owner_account - konto zidentyfikowane przez pole
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.
Filtruj wyniki aby ograniczyć odpowiedź do zasobów z określonymi atrybutami.
Metoda Search zwraca strony z wynikami. Aby pobrać wszystkie zasoby dla a
żą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 określa ścieżkę dostępu danych uwierzytelniających do konta parent w żądaniu. 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.
Filtrowanie wyników
Aby pobrać konkretne linki partnera, użyj pola filter w żądaniu. Pole filter to ciąg znaków, który określa zestaw warunków, które chcesz zastosować, oraz to, czy interfejs API ma łączyć warunki za pomocą operatora AND czy OR.
Więcej informacji o opcjach i składni filtrowania 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.
Oto na przykład filter, który zwraca wszystkie linki partnera, w których konto właściciela ma identyfikator OWNING_ACCOUNT_ID:
owning_account.account_id = OWNING_ACCOUNT_ID
Oto kolejny przykład filter. Zwraca on wszystkie linki partnera, 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 filter na używanie AND zamiast OR ogranicza zwracane zasoby do linków partnera, w których zarówno konto właściciela ma identyfikator OWNING_ACCOUNT_ID, jak i konto partnera ma identyfikator PARTNER_ACCOUNT_ID:
owning_account.account_id = OWNING_ACCOUNT_ID AND partner_account.account_id = PARTNER_ACCOUNT_ID
Dzielenie wyników na strony
Użyj pola page_size, aby określić liczbę wyników zwracanych w jednej odpowiedzi. Jeśli na przykład ustawisz page_size na 10, interfejs API zwróci co najwyżej 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 liczba wyników jest większa niż liczba, która może się zmieścić w jednej odpowiedzi, odpowiedź będzie zawierać next_page_token. Aby pobrać następną stronę lub zestaw wyników, ponownie wyślij 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.