Autoryzacja i nagłówki HTTP

Do wywoływania interfejsu Search Ads 360 Reporting API potrzebujesz danych logowania do aplikacji OAuth 2.0. Jeśli wykonujesz wywołania interfejsu API z poziomu konta menedżera Search Ads 360, musisz też przy każdym żądaniu podawać nagłówek login-customer-id. Na tej stronie opisujemy, jak ustawić te wartości i udokumentować kilka dodatkowych nagłówków HTTP związanych z interfejsem API, które są wysyłane i odbierane podczas korzystania z interfejsu REST.

Dane uwierzytelniające OAuth 2.0

Interfejs Search Ads 360 Reporting API używa danych logowania do aplikacji do identyfikowania i autoryzowania żądań do interfejsu API. Klienty OAuth 2.0 można konfigurować. Wszystkie wywołania interfejsu Search Ads 360 Reporting API muszą być autoryzowane przez OAuth2. OAuth2 umożliwia aplikacji klienckiej interfejsu Search Ads 360 Reporting API dostęp do konta Search Ads 360 użytkownika bez konieczności obsługi i przechowywania danych logowania użytkownika.

Jeśli nie masz doświadczenia z interfejsami API Google, możesz skorzystać z oauth2l lub OAuth 2.0 Playground, by poeksperymentować z danymi logowania do aplikacji i interfejsem Search Ads 360 Reporting API przed napisaniem kodu aplikacji. Możesz też wygenerować token odświeżania OAuth, uruchamiając udostępniony skrypt generowania danych logowania użytkownika.

Generowanie nowych tokenów dostępu

Gdy masz 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żywasz tokena dostępu zwróconego przez żądanie curl w nagłówku HTTP Authorization każdego wywołania interfejsu API Search Ads 360 Reporting API:

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

Nagłówki żądania

Identyfikator klienta logowania

W przypadku wywołań interfejsu Search Ads 360 Reporting API wykonywanych przez menedżera na koncie klienta (czyli podczas logowania się jako menedżer, by wywołać interfejs API na jednym z kont klientów) musisz też podać nagłówek HTTP login-customer-id. Jest to identyfikator klienta Search Ads 360 menedżera wywołującego interfejs API.

Umieszczenie 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, pamiętaj o usunięciu myślników (–), takich jak 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

Poniższe nagłówki są zwracane w odpowiedziach HTTP z interfejsu API.

Identyfikator zgłoszenia

request-id to ciąg znaków, który jednoznacznie identyfikuje żądanie do interfejsu API. Podczas debugowania konkretnych wywołań interfejsu API lub rozwiązywania problemów z nimi request-id jest ważnym identyfikatorem, który będzie przydatny podczas kontaktowania się z zespołem pomocy Google dla deweloperów.

request-id: 2a5Cj89VV7CNhya1DZjjrC