Wywołania interfejsu Search Ads 360 Reporting API zwykle są wykonywane za pomocą biblioteki klienta. Więcej informacji znajdziesz w artykule Omówienie bibliotek klienta. Jednak wiedza o strukturze szczegółów żądania może być przydatna podczas testowania i debugowania.
Search Ads 360 Reporting API to interfejs API gRPC z powiązaniami REST. Oznacza to, że możesz wywoływać interfejs API na 2 sposoby:
- Preferowana metoda
- Użyj biblioteki klienta:
- Utwórz treść żądania jako bufor protokołu.
- Wyślij żądanie do serwera, korzystając z protokołu HTTP/2.
- Deserializuj odpowiedź na bufor protokołu.
- Zinterpretuj wyniki.
- Opcjonalna alternatywna metoda
- Użyj funkcji REST:
- Utwórz treść żądania jako obiekt JSON.
- Wyślij żądanie do serwera za pomocą protokołu HTTP 1.1.
- Deserializuj odpowiedź jako obiekt JSON.
- Zinterpretuj wyniki.
Więcej informacji znajdziesz na stronie o interfejsach Google Cloud APIs.
Poniższe sekcje dotyczą protokołów gRPC i REST.
Nazwy zasobów
Większość obiektów w interfejsie API jest identyfikowana przez ciągi nazw zasobów. Ciągi te służą też jako adresy URL w interfejsie REST.
Więcej informacji o obsługiwanych zasobach i reprezentacji ich ścieżek znajdziesz w sekcji Dokumentacja > REST. Ten sam format jest używany w innych usługach.
Identyfikatory złożone
Jeśli identyfikator obiektu nie jest unikalny globalnie, tworzy się dla niego identyfikator złożony przez dodanie na początku identyfikatora nadrzędnego i tyldy (~).
Na przykład identyfikator reklamy w grupie reklam nie jest globalnie unikalny, więc do identyfikatora zostaje dołączony identyfikator obiektu nadrzędnego (grupy reklam), co skutkuje unikalnym identyfikatorem złożonym.
Przykład: AdGroupId z 123 + ~ + AdGroupAdId z 45678
= identyfikator reklamy zbiorczej w grupie reklam 123~45678.
Nagłówki żądania
Nagłówki HTTP (lub metadane gRPC) podane w poniższych sekcjach powinny zostać uwzględnione w treści żądania.
Upoważnienie
Musisz podać w tym formularzu token dostępu OAuth2:
Authorization: Bearer [OAUTH_2.0_ACCESS_TOKEN]
Token powinien wskazywać konto menedżera działające w imieniu klienta lub reklamodawca bezpośrednio zarządzający własnym podrzędnym kontem menedżera lub kontem klienta. Więcej informacji znajdziesz w artykułach Konta menedżera Search Ads 360 i Uwierzytelnianie.
Nagłówek identyfikatora klienta logowania
Nagłówek login-customer-id jest wymagany, gdy do uzyskiwania dostępu do podrzędnego konta menedżera lub konta klienta używasz konta menedżera. Nie jest on wymagany w przypadku bezpośredniego dostępu do podrzędnego konta menedżera lub konta klienta. Chociaż nie jest to ściśle wymagane, zalecamy zawsze określanie właściwości login-customer-id w przypadku uwierzytelnionych użytkowników, którzy mają dostęp do więcej niż 1 konta. Pozwala to uniknąć niejasności i zapobiega przypadkowemu ustawieniu kontekstu na niewłaściwym koncie.
Żądanie powinno zawierać identyfikator klienta autoryzowanego użytkownika bez łączników (-), na przykład:
https://searchads360.googleapis.com/VERSION_NUMBER/customers/CUSTOMER_ID/campaignBudgets
Ustawienie login-customer-id jest równoważne z wybraniem konta w interfejsie Search Ads 360 po zalogowaniu się lub kliknięciu zdjęcia profilowego w prawym górnym rogu.
Nagłówki odpowiedzi
Te nagłówki (lub końcowe metadane gRPC) są zwracane z treścią odpowiedzi. Zalecamy rejestrowanie tych wartości na potrzeby debugowania.
Identyfikator zgłoszenia
Nagłówek request-id to ciąg znaków, który jednoznacznie identyfikuje żądanie.