Autoryzacja i nagłówki HTTP

Podczas wywoływania interfejsu Search Ads 360 Reporting API potrzebne są dane uwierzytelniające aplikacji OAuth 2.0. Jeśli wysyłasz wywołania interfejsu API jako konto menedżera Search Ads 360, musisz też dołączać do każdego żądania nagłówek login-customer-id. Na tej stronie opisujemy, jak ustawić te wartości, oraz dokumentujemy kilka dodatkowych nagłówków HTTP specyficznych dla interfejsu API, które są wysyłane i odbierane podczas korzystania z interfejsu REST.

Dane logowania OAuth 2.0

Interfejs Search Ads 360 Reporting API używa danych logowania aplikacji do identyfikowania i autoryzowania żądań interfejsu API. Można skonfigurować klientów OAuth 2.0. Wszystkie wywołania interfejsu Search Ads 360 Reporting API muszą być autoryzowane za pomocą OAuth2. OAuth2 umożliwia aplikacji klienckiej Search Ads 360 Reporting API dostęp do konta Search Ads 360 użytkownika bez konieczności obsługiwania lub przechowywania informacji logowania użytkownika.

Jeśli dopiero zaczynasz korzystać z interfejsów API Google, możesz użyć narzędzia oauth2l lub OAuth 2.0 Playground, aby przetestować dane logowania aplikacji i interfejs Search Ads 360 Reporting API przed napisaniem kodu aplikacji. Możesz też wygenerować token odświeżania OAuth, uruchamiając podany skrypt generowania danych logowania użytkownika.

Generowanie nowych tokenów dostępu

Gdy uzyskasz identyfikator klienta, tajny klucz klienta i token odświeżania, możesz wygenerować nowy token dostępu do użycia w wywołaniach interfejsu API za pomocą narzędzia wiersza poleceń curl:

curl \
  --data "grant_type=refresh_token" \
  --data "client_id=CLIENT_ID" \
  --data "client_secret=CLIENT_SECRET" \
  --data "refresh_token=REFRESH_TOKEN" \
  https://www.googleapis.com/oauth2/v3/token

Następnie użyj tokena dostępu zwróconego przez żądanie curl w nagłówku HTTP każdego wywołania interfejsu Search Ads 360 Reporting API:Authorization

GET /v0/customers:listAccessibleCustomers HTTP/1.1
Host: searchads360.googleapis.com
Authorization: Bearer ACCESS_TOKEN

Nagłówki żądania

Identyfikator klienta logującego się

W przypadku wywołań interfejsu Search Ads 360 Reporting API wykonywanych przez menedżera na koncie klienta (czyli gdy logujesz się jako menedżer, aby wykonywać wywołania interfejsu API na jednym ze swoich kont klientów), musisz też podać nagłówek HTTP login-customer-id. Ta wartość to identyfikator klienta Search Ads 360 konta menedżera, które wysyła wywołanie interfejsu API.

Dodanie tego nagłówka jest równoznaczne z wybraniem konta w interfejsie Search Ads 360 po zalogowaniu się lub kliknięciu zdjęcia profilowego w prawym górnym rogu strony. Podając identyfikator klienta, usuń wszystkie łączniki (–), np. 1234567890, a nie 123-456-7890.

GET /v0/customers:listAccessibleCustomers HTTP/1.1
Host: searchads360.googleapis.com
Authorization: Bearer ACCESS_TOKEN
login-customer-id: MANAGER_CUSTOMER_ID

Nagłówki odpowiedzi

W odpowiedziach HTTP z interfejsu API zwracane są te nagłówki:

Identyfikator żądania

request-id to ciąg znaków, który jednoznacznie identyfikuje żądanie interfejsu API. Podczas debugowania lub rozwiązywania problemów z konkretnymi wywołaniami interfejsu API warto mieć pod ręką identyfikator request-id, który jest przydatny podczas kontaktowania się z zespołem pomocy dla deweloperów Google.

request-id: 2a5Cj89VV7CNhya1DZjjrC