Aby wywołać interfejs Search Ads 360 Reporting API, musisz mieć poświadczenia aplikacji OAuth 2.0. Jeśli wywołujesz interfejs API z konta menedżera Search Ads 360, musisz też w każdej prośbie podać nagłówek login-customer-id
. Z tej strony dowiesz się, jak ustawić te wartości, oraz znajdziesz informacje o kilku dodatkowych nagłówkach HTTP dotyczących interfejsu 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 aplikacji do identyfikowania i autoryzowania żądań interfejsu API. można konfigurować klientów OAuth 2.0, Wszystkie wywołania interfejsu Search Ads 360 Reporting API muszą być autoryzowane za pomocą OAuth 2. OAuth 2 umożliwia aplikacji klienta interfejsu Search Ads 360 Reporting API dostęp do konta Search Ads 360 użytkownika bez konieczności obsługi ani przechowywania jego danych logowania.
Jeśli dopiero zaczynasz korzystać z interfejsów API Google, możesz użyć oauth2l lub platformy do testowania interfejsu OAuth 2.0, aby przed napisaniem kodu aplikacji eksperymentować z danymi logowania aplikacji i interfejsem Search Ads 360 Reporting API. Możesz też wygenerować token odświeżania OAuth, uruchamiając dostarczony skrypt do generowania danych logowania użytkownika.
Generowanie nowych tokenów dostępu
Gdy masz już identyfikator klienta, klucz tajny 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 Authorization
każdego wywołania interfejsu Search Ads 360 Reporting API:
GET /v0/customers:listAccessibleCustomers HTTP/1.1
Host: searchads360.googleapis.com
Authorization: Bearer ACCESS_TOKEN
Nagłówki żądania
Identyfikator logowania klienta
W przypadku wywołań interfejsu Search Ads 360 Reporting API przez menedżera na koncie klienta (czyli gdy zalogujesz się jako menedżer, aby wykonać wywołania interfejsu API na jednym z kont klientów) musisz też podać nagłówek HTTP login-customer-id
. Ta wartość to identyfikator klienta Search Ads 360 menedżera, który wysyła wywołanie interfejsu API.
Użycie 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. Podczas podawania identyfikatora klienta usuń wszystkie łączniki (–). Na przykład: 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
Wartość request-id
to ciąg znaków jednoznacznie identyfikujący żądanie interfejsu API. Podczas debugowania lub rozwiązywania problemów z konkretnymi wywołaniami interfejsu API request-id
jest ważnym identyfikatorem, który warto mieć pod ręką, gdy kontaktujesz się z zespołem pomocy Google dla deweloperów.
request-id: 2a5Cj89VV7CNhya1DZjjrC