Authentication
Zadbaj o dobrą organizację dzięki kolekcji
Zapisuj i kategoryzuj treści zgodnie ze swoimi preferencjami.
Z tego dokumentu dowiesz się, jak uwierzytelnić się w interfejsie Ad Manager API. Sposób uwierzytelniania zależy od interfejsu, którego używasz, i środowiska, w którym działa Twój kod, ale wszystkie żądania interfejsu API muszą zawierać token dostępu z zakresem interfejsu Ad Manager API.
Biblioteki klienta Ad Managera używają domyślnych danych logowania aplikacji do generowania tokenów dostępu z zakresem interfejsu Ad Managera API. W tym przewodniku widać,
jak skonfigurować domyślne dane logowania aplikacji.
Nawet jeśli nie korzystasz z biblioteki klienta, musisz utworzyć dane logowania
i używać ich do
autoryzowania żądań.
Więcej informacji o uwierzytelnianiu i autoryzowaniu znajdziesz w
Przewodnik po używaniu protokołu OAuth 2.0.
Określanie typu uwierzytelniania
Typ uwierzytelniania |
Opis |
Konto usługi
|
Wybierz tę opcję, jeśli chcesz uwierzytelnić się za pomocą dedykowanego konta, a nie konkretnej osoby.
Więcej informacji |
Aplikacja internetowa
|
Wybierz tę opcję, jeśli chcesz uwierzytelnić się jako dowolny użytkownik, który przyznaje Twojej aplikacji uprawnienia dostępu do swoich danych w usłudze Ad Manager.
Więcej informacji |
Lokalny proces programowania
|
Wybierz tę opcję, jeśli chcesz się uwierzytelnić jako własne
konta Google lub konta usługi z lokalnego
w środowisku programistycznym. |
Włączanie interfejsu Ad Manager API
Włącz interfejs Ad Manager API w projekcie Cloud w Google API Console.
Jeśli pojawi się taka prośba, wybierz projekt lub utwórz nowy.
Utwórz dane logowania
Kliknij kartę odpowiedniego typu uwierzytelniania i postępuj zgodnie z instrukcjami
utwórz swoje dane logowania:
Konto usługi
W Google Cloud
Do uwierzytelnienia zadania uruchomionego w Google Cloud użyjesz danych logowania
konto usługi połączone z zasobem obliczeniowym, w którym znajduje się Twój kod
w domu.
Możesz na przykład dołączyć konto usługi do instancji maszyny wirtualnej Compute Engine, usługi Cloud Run lub zadania Dataflow. To podejście
to preferowana metoda uwierzytelniania w przypadku kodu działającego w Google Cloud
zasobów obliczeniowych.
Aby uzyskać informacje o zasobach, do których możesz dołączyć konto usługi,
i pomoc dotyczącą dołączania konta usługi do zasobu, zapoznaj się z
dokumentacji dotyczącej dołączania konta usługi.
lokalnie lub u innego dostawcy usług w chmurze;
Preferowaną metodą konfigurowania uwierzytelniania spoza Google Cloud jest użycie federacji tożsamości zadań. Należy utworzyć plik konfiguracji danych logowania i ustawić zmienną środowiskową GOOGLE_APPLICATION_CREDENTIALS
, aby wskazywała na ten plik. To rozwiązanie jest bezpieczniejsze niż
przez utworzenie klucza konta usługi.
Jeśli nie możesz skonfigurować federacji tożsamości zadań, musisz
utwórz konto usługi i utwórz dla niego klucz:
Otwórz stronę Dane logowania Konsoli interfejsów API Google.
Na stronie Dane logowania wybierz Utwórz dane logowania, a następnie
wybierz Service Account (Konto usługi).
Kliknij adres e-mail konta usługi, które chcesz utworzyć.
klucz.
Kliknij kartę Klucze.
Kliknij menu Dodaj klucz i wybierz Utwórz nowy klucz.
W polu Typ klucza wybierz JSON i kliknij Utwórz.
Ustaw zmienną środowiskową GOOGLE_APPLICATION_CREDENTIALS
na ścieżkę pliku JSON.
Linux lub macOS
export GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH
Windows
set GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH
Aplikacja internetowa
Otwórz stronę Dane logowania w Konsoli interfejsów API Google.
Jeśli pojawi się taka prośba, wybierz projekt, w którym włączono interfejs API Ad Managera.
Na stronie Dane logowania wybierz Utwórz dane logowania, a następnie
wybierz Identyfikator klienta OAuth.
Jako typ aplikacji wybierz Aplikacja internetowa.
Wypełnij formularz i kliknij Utwórz. Aplikacje, które używają języków
platformy takie jak PHP, Java, Python, Ruby i .NET muszą określić autoryzowane
identyfikatory URI przekierowania. Identyfikatory URI przekierowania to punkty końcowe, do których OAuth 2.0
serwer może wysyłać odpowiedzi. Te punkty końcowe muszą być zgodne z regułami walidacji Google.
Po utworzeniu danych logowania pobierz plik client_secret.json. Bezpiecznie przechowuj plik w lokalizacji, do której ma dostęp tylko Twoja aplikacja.
Następnie wykonaj czynności umożliwiające uzyskanie tokenów dostępu OAuth 2.0.
Programowanie lokalne
Skonfiguruj domyślne dane logowania aplikacji (ADC) w swoim środowisku lokalnym.
Zainstaluj Google Cloud CLI, a następnie zainicjuj go, uruchamiając to
polecenie:
gcloud init
Utwórz lokalne dane logowania do konta Google i ustaw identyfikator projektu jako projekt, w którym włączono interfejs Ad Manager API:
gcloud auth application-default login --scopes="https://www.googleapis.com/auth/admanager"
gcloud auth application-default set-quota-project PROJECT_ID
Możesz też uwierzytelnić się jako konto usługi i ustawić środowisko
GOOGLE_APPLICATION_CREDENTIALS
do ścieżki pliku klucza.
Linux lub macOS
export GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH
Windows
set GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH
Konto usługi
- Otwórz sieć Ad Managera.
- Kliknij kartę Administrator.
- Upewnij się, że Dostęp API jest włączony.
- Kliknij przycisk Dodaj użytkownika konta usługi.
- Wypełnij formularz, używając adresu e-mail konta usługi.
użytkownika konta usługi należy dodać do odpowiednich ról i zespołów
integracji z interfejsem API.
- Kliknij przycisk Zapisz. Powinien pojawić się komunikat potwierdzający dodanie konta usługi.
- Aby wyświetlić istniejących użytkowników konta usługi, otwórz kartę Użytkownicy, a następnie
klikając filtr Konto usługi.
Aplikacja internetowa
- Otwórz sieć Ad Managera.
- Kliknij kartę Administrator.
- Upewnij się, że Dostęp API jest włączony.
Programowanie lokalne
- Otwórz sieć Ad Managera.
- Kliknij kartę Administrator.
- Upewnij się, że Dostęp API jest włączony.
Bez biblioteki klienta
Jeśli nie korzystasz z biblioteki klienta, zdecydowanie zalecamy użycie
biblioteki OAuth2 do uwierzytelniania.
Szczegółowe instrukcje uzyskiwania tokenów dostępu znajdziesz w artykule Używanie protokołu OAuth 2 w interfejsach API Google.
Tokeny dostępu
Umieść swój token dostępu w żądaniu do interfejsu API, umieszczając w nim
Parametr zapytania access_token
lub wartość nagłówka HTTP Bearer
Authorization
.
W miarę możliwości preferowany jest nagłówek HTTP, ponieważ ciągi znaków zapytania są zwykle widoczne w dziennikach serwera.
Na przykład:
GET /v1/networks/1234
Host: admanager.googleapis.com
Authorization: Bearer ya29.a0Ad52N3_shYLX
GET https://admanager.googleapis.com/v1/networks/1234?access_token=1/fFAGRNJru1FTz70BzhT3Zg
Zakres
Każdy token dostępu jest powiązany z co najmniej 1 zakresem. Zakres kontroluje
zbiór zasobów i operacji, na które zezwala token dostępu. Interfejs Ad Managera API ma tylko 1 zakres. Autoryzacja powinna być wykonywana na poziomie użytkownika
na poziomie usługi.
Zakres |
Uprawnienia |
https://www.googleapis.com/auth/admanager
|
Wyświetlanie kampanii i zarządzanie nimi
o usłudze Google Ad Manager. |
O ile nie stwierdzono inaczej, treść tej strony jest objęta licencją Creative Commons – uznanie autorstwa 4.0, a fragmenty kodu są dostępne na licencji Apache 2.0. Szczegółowe informacje na ten temat zawierają zasady dotyczące witryny Google Developers. Java jest zastrzeżonym znakiem towarowym firmy Oracle i jej podmiotów stowarzyszonych.
Ostatnia aktualizacja: 2025-08-31 UTC.
[null,null,["Ostatnia aktualizacja: 2025-08-31 UTC."],[[["\u003cp\u003eGoogle Ad Manager API authentication depends on the interface and environment but always requires an access token.\u003c/p\u003e\n"],["\u003cp\u003eChoose between service account, web application, or local development authentication based on your needs.\u003c/p\u003e\n"],["\u003cp\u003eEnable the Ad Manager API in your Google API Console and create the necessary credentials for your chosen authentication type.\u003c/p\u003e\n"],["\u003cp\u003eConfigure your Ad Manager network settings and add the service account user or enable API access depending on authentication type.\u003c/p\u003e\n"],["\u003cp\u003eInclude your access token in API requests using either a query parameter or an HTTP header.\u003c/p\u003e\n"]]],["To access the Ad Manager API, you need an access token, generated using Application Default Credentials (ADC) or custom credentials. First, enable the Ad Manager API in your Google Cloud project. Then, choose an authentication type: Service Account, Web application, or Local development. Create credentials via the Google API Console, selecting the appropriate method. If not using a client library, use an OAuth2 library. Finally, include the access token in API requests, preferably in the `Authorization` HTTP header. Each access token should be associated with the `https://www.googleapis.com/auth/admanager` scope.\n"],null,["# Authentication\n\nThis document describes how to authenticate to the Ad Manager API. How you\nauthenticate depends on the interface you use and the environment where your\ncode is running, but all API requests must include an access token with the\nAd Manager API [scope](#scope).\n\nThe Ad Manager client libraries use [Application Default Credentials](//cloud.google.com/docs/authentication/application-default-credentials)\nto generate access tokens with the Ad Manager API scope. This guide shows\nhow to configure Application Default Credentials.\n\nIf you aren't using a client library, you still need to create credentials\nand use them to authorize your requests.\n\nFor more information about authentication and authorization, see the\n[Using OAuth 2.0](/identity/protocols/oauth2) guide.\n\nDetermine your authentication type\n----------------------------------\n\n| Authentication type | Description |\n|---------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| Service Account | Choose this if you want to authenticate as dedicated account rather than a particular person. [Learn more](//cloud.google.com/iam/docs/service-account-overview). |\n| Web application | Choose this if you want to authenticate as any user who grants permission to your application to access their Ad Manager data. [Learn more](/identity/oauth2/web/guides/overview) |\n| Local development | Choose this if you want to authenticate as your own Google Account or a Service Account from your local development environment. |\n\nEnable the Ad Manager API\n-------------------------\n\n1. Enable the [Ad Manager API](https://console.cloud.google.com/apis/library/admanager.googleapis.com) in your\n Google API Console Cloud Project.\n\n2. If prompted, select a project, or create a new one.\n\nCreate credentials\n------------------\n\nClick the tab for your authentication type and follow the instructions to\ncreate your credentials: \n\n### Service Account\n\n### On Google Cloud\n\nTo authenticate a workload running on Google Cloud, you use the credentials of\nthe service account attached to the compute resource where your code is\nrunning.\n\nFor example, you can attach a service account to a Compute Engine virtual\nmachine (VM) instance, a Cloud Run service, or a Dataflow job. This approach\nis the preferred authentication method for code running on a Google Cloud\ncompute resource.\n\nFor information about which resources you can attach a service account to,\nand help with attaching the service account to the resource, see the\n[documentation on attaching a service account](//cloud.google.com/iam/docs/attach-service-accounts).\n\n### On-premises or on a different cloud provider\n\nThe preferred method to set up authentication from outside of Google Cloud is\nto use [workload identity federation](//cloud.google.com/iam/docs/workload-identity-federation); you create a\ncredential configuration file and set the `GOOGLE_APPLICATION_CREDENTIALS`\nenvironment variable to point to it. This approach is more secure than\ncreating a service account key.\n\nIf you are not able to configure workload identity federation, then you must\ncreate a service account and create a key for the service account:\n\n1. Open the [Google API Console Credentials page](https://console.cloud.google.com/apis/credentials).\n\n2. On the Credentials page, select **Create credentials** , then\n select **Service Account**.\n\n3. Click the email address of the service account that you want to create\n a key for.\n\n4. Click the **Keys** tab.\n\n5. Click the **Add key** drop-down menu, then select **Create new key**.\n\n6. Select **JSON** as the **Key type** and click **Create**.\n\n7. Set the environment variable `GOOGLE_APPLICATION_CREDENTIALS` to the path\n of the JSON file.\n\n#### Linux or macOS\n\n export GOOGLE_APPLICATION_CREDENTIALS=\u003cvar label=\"key file\" translate=\"no\"\u003eKEY_FILE_PATH\u003c/var\u003e\n\n#### Windows\n\n set GOOGLE_APPLICATION_CREDENTIALS=\u003cvar label=\"key file\" translate=\"no\"\u003eKEY_FILE_PATH\u003c/var\u003e\n\n### Web application\n\n1. Open the [Google API Console Credentials page](https://console.cloud.google.com/apis/credentials).\n\n2. If prompted, select the project where you enabled the Ad Manager API.\n\n3. On the Credentials page, select **Create credentials** , then\n select **OAuth client ID**.\n\n4. Select the **Web application** application type.\n\n5. Fill in the form and click **Create** . Applications that use languages and\n frameworks like PHP, Java, Python, Ruby, and .NET must specify authorized\n **redirect URIs** . The redirect URIs are the endpoints to which the OAuth 2.0\n server can send responses. These endpoints must adhere to [Google's\n validation rules](/identity/protocols/oauth2/web-server#uri-validation).\n\n6. After creating your credentials, download the **client_secret.json** file. Securely store the file in a location that only your application can access.\n\nFrom here, follow the steps to [obtain OAuth 2.0 access tokens](/identity/protocols/oauth2/web-server#obtainingaccesstokens)\n\n### Local development\n\nSet up Application Default Credentials (ADC) in your local environment.\n\nInstall the Google Cloud CLI, then initialize it by running the following\ncommand: \n\n gcloud init\n\nCreate local authentication credentials for your Google Account and set\nthe project ID to a project where the Ad Manager API is enabled: \n\n gcloud auth application-default login --scopes=\"https://www.googleapis.com/auth/admanager\"\n gcloud auth application-default set-quota-project \u003cvar label=\"project id\" translate=\"no\"\u003ePROJECT_ID\u003c/var\u003e\n\nAlternatively, authenticate as a Service Account setting the environment\nvariable `GOOGLE_APPLICATION_CREDENTIALS` to the path of your key file.\n\n#### Linux or macOS\n\n export GOOGLE_APPLICATION_CREDENTIALS=\u003cvar label=\"key file\" translate=\"no\"\u003eKEY_FILE_PATH\u003c/var\u003e\n\n#### Windows\n\n set GOOGLE_APPLICATION_CREDENTIALS=\u003cvar label=\"key file\" translate=\"no\"\u003eKEY_FILE_PATH\u003c/var\u003e\n\nConfigure your Ad Manager network\n---------------------------------\n\n**Tip:** If you are a third-party developer, ask your client to complete this step for you. Send them to [Add a service account user for API access](//support.google.com/admanager/answer/6078734) and provide the email address of your service account. \n\n### Service Account\n\n1. Go to your [Ad Manager network](//admanager.google.com).\n2. Click the **Admin** tab.\n3. Ensure that **API access** is enabled.\n4. Click the **Add a service account user** button.\n5. Fill in the form using the service account email. The service account user must be added to appropriate roles and teams for your API integration.\n6. Click the **Save** button. A message should appear, confirming the addition of your service account.\n7. View existing service account users by going to the Users tab and then clicking the **Service Account** filter.\n\n### Web application\n\n1. Go to your [Ad Manager network](//admanager.google.com).\n2. Click the **Admin** tab.\n3. Ensure that **API access** is enabled.\n\n### Local Development\n\n1. Go to your [Ad Manager network](//admanager.google.com).\n2. Click the **Admin** tab.\n3. Ensure that **API access** is enabled.\n\nWithout a client library\n------------------------\n\nIf you are not using a client library, we still strongly recommend using\nan OAuth2 library for authentication.\n\nFor detailed instructions on obtaining access tokens, see\n[Using OAuth2 with Google APIs](/identity/protocols/oauth2).\n\n### Access tokens\n\nInclude your access token in a request to the API by including either an\n`access_token` query parameter or an `Authorization` HTTP header `Bearer` value.\nWhen possible, the HTTP header is preferable, because query strings tend to be\nvisible in server logs.\n\nFor example: \n\n GET /v1/networks/1234\n Host: admanager.googleapis.com\n Authorization: Bearer ya29.a0Ad52N3_shYLX\n\n GET https://admanager.googleapis.com/v1/networks/1234?access_token=1/fFAGRNJru1FTz70BzhT3Zg\n\n### Scope\n\nEach access token is associated with one or more scopes. A scope controls the\nset of resources and operations that an access token permits. The Ad Manager\nAPI has only one scope. Authorization should be performed at the user\nlevel within the product.\n\n| Scope | Permissions |\n|---------------------------------------------|------------------------------------------------------|\n| `https://www.googleapis.com/auth/admanager` | View and manage your campaigns on Google Ad Manager. |"]]