Authentication
Tetap teratur dengan koleksi
Simpan dan kategorikan konten berdasarkan preferensi Anda.
Dokumen ini menjelaskan cara melakukan autentikasi ke Ad Manager API. Bagaimana Anda
otentikasi tergantung pada antarmuka
yang Anda gunakan dan lingkungan tempat
kode program berjalan, tetapi semua permintaan API harus menyertakan token akses dengan
Cakupan Ad Manager API.
Library klien Ad Manager menggunakan Kredensial Default Aplikasi
untuk membuat token akses dengan cakupan Ad Manager API. Panduan ini menunjukkan
cara mengkonfigurasi Kredensial Default Aplikasi.
Jika tidak menggunakan library klien, Anda tetap perlu membuat kredensial
dan menggunakannya untuk memberikan otorisasi pada permintaan Anda.
Untuk informasi selengkapnya tentang autentikasi dan otorisasi, lihat
panduan Menggunakan OAuth 2.0.
Menentukan jenis autentikasi
| Jenis autentikasi |
Deskripsi |
| Akun Layanan
|
Pilih ini jika Anda ingin melakukan otentikasi sebagai
akun, bukan orang tertentu.
Pelajari lebih lanjut. |
| Aplikasi web
|
Pilih ini jika Anda ingin melakukan autentikasi sebagai pengguna
yang memberikan izin kepada aplikasi Anda untuk mengakses
data Ad Manager mereka.
Pelajari lebih lanjut |
| Pengembangan lokal
|
Pilih opsi ini jika Anda ingin melakukan autentikasi sebagai Akun Google atau Akun Layanan Anda sendiri dari lingkungan pengembangan lokal. |
Mengaktifkan Ad Manager API
Aktifkan Ad Manager API di
Project Cloud Konsol API Google.
Jika diminta, pilih project, atau buat project baru.
Buat kredensial
Klik tab untuk jenis autentikasi Anda dan ikuti petunjuk untuk
membuat kredensial Anda:
Akun Layanan
Di Google Cloud
Untuk mengautentikasi beban kerja yang berjalan di Google Cloud, Anda menggunakan kredensial akun layanan yang dilampirkan ke resource komputasi tempat kode Anda berjalan.
Misalnya, Anda dapat memasang akun layanan ke instance virtual machine (VM) Compute Engine, layanan Cloud Run, atau tugas Dataflow. Pendekatan ini
adalah metode autentikasi pilihan untuk kode yang berjalan di Google Cloud
resource komputasi.
Untuk mengetahui informasi tentang resource mana
yang dapat ditambahi akun layanan,
serta membantu melampirkan akun layanan ke resource. Lihat dokumentasi
dokumentasi tentang cara melampirkan akun layanan.
Lokal atau di penyedia cloud lain
Metode yang lebih disukai untuk menyiapkan autentikasi dari luar Google Cloud adalah
menggunakan workload identity federation; Anda membuat
file konfigurasi kredensial dan menetapkan variabel lingkungan GOOGLE_APPLICATION_CREDENTIALS
untuk menunjukkannya. Pendekatan ini lebih aman dibandingkan
membuat kunci akun layanan.
Jika tidak dapat mengonfigurasi workload identity federation, Anda harus
membuat akun layanan dan membuat kunci untuk akun layanan:
Buka halaman Credentials di Konsol API Google.
Di halaman Credentials, pilih Create credentials, lalu
pilih Service Account.
Klik alamat email akun layanan yang ingin dibuat
apa kuncinya.
Klik tab Kunci.
Klik menu drop-down Kunci, lalu pilih Buat kunci baru.
Pilih JSON sebagai jenis kunci dan klik Create.
Tetapkan variabel lingkungan GOOGLE_APPLICATION_CREDENTIALS ke jalur
dari file JSON.
Linux atau macOS
export GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH
Windows
set GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH
Aplikasi web
Buka halaman Kredensial Konsol API Google.
Jika diminta, pilih project tempat Anda mengaktifkan Ad Manager API.
Di halaman Credentials, pilih Create credentials, lalu
pilih OAuth client ID.
Pilih jenis aplikasi Aplikasi web.
Isi formulir, lalu klik Buat. Aplikasi yang menggunakan bahasa dan
seperti PHP, Java, Python, Ruby, dan .NET harus menentukan
URI pengalihan. URI pengalihan adalah endpoint tempat OAuth 2.0
server dapat mengirimkan respons. Endpoint ini harus mematuhi aturan validasi Google.
Setelah membuat kredensial, download file client_secret.json. Simpan file dengan aman di lokasi yang hanya dapat diakses oleh aplikasi Anda.
Dari sini, ikuti langkah-langkah untuk mendapatkan token akses OAuth 2.0
Pengembangan lokal
Siapkan Kredensial Default Aplikasi (ADC) di lingkungan lokal Anda.
Instal Google Cloud CLI, lalu lakukan inisialisasi dengan menjalankan perintah berikut:
gcloud init
Buat kredensial autentikasi lokal untuk Akun Google Anda dan tetapkan project ID ke project tempat Ad Manager API diaktifkan:
gcloud auth application-default login --scopes="https://www.googleapis.com/auth/admanager"
gcloud auth application-default set-quota-project PROJECT_ID
Atau, lakukan autentikasi sebagai Akun Layanan yang menetapkan variabel
lingkungan GOOGLE_APPLICATION_CREDENTIALS ke jalur file kunci Anda.
Linux atau macOS
export GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH
Windows
set GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH
Akun Layanan
- Buka jaringan Ad Manager Anda.
- Klik tab Admin.
- Pastikan akses API diaktifkan.
- Klik tombol Add a service account user.
- Isi formulir menggunakan email akun layanan. Pengguna akun layanan harus ditambahkan ke peran dan tim yang sesuai untuk integrasi API Anda.
- Klik tombol Simpan. Sebuah pesan akan muncul, mengonfirmasi
penambahan akun layanan Anda.
- Lihat pengguna akun layanan yang ada dengan membuka tab Pengguna, lalu
mengklik filter Service Account.
Pengembangan Lokal
- Buka jaringan Ad Manager Anda.
- Klik tab Admin.
- Pastikan akses API diaktifkan.
Tanpa library klien
Jika Anda tidak menggunakan library klien, sebaiknya tetap gunakan
library OAuth2 untuk autentikasi.
Untuk petunjuk mendetail tentang cara mendapatkan token akses, lihat
Menggunakan OAuth2 dengan Google API.
Token akses
Sertakan token akses Anda dalam permintaan ke API dengan menyertakan
Parameter kueri access_token atau nilai Bearer header HTTP Authorization.
Jika memungkinkan, header HTTP lebih disarankan karena string kueri cenderung
terlihat di log server.
Contoh:
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
Cakupan
Setiap token akses dikaitkan dengan satu atau beberapa cakupan. Cakupan mengontrol
kumpulan resource dan operasi yang diizinkan token akses. Ad Manager
API hanya memiliki satu cakupan. Otorisasi harus dilakukan pada pengguna
level dalam produk.
| Cakupan |
Izin |
https://www.googleapis.com/auth/admanager
|
Melihat dan mengelola kampanye Anda
tentang Google Ad Manager. |
Kecuali dinyatakan lain, konten di halaman ini dilisensikan berdasarkan Lisensi Creative Commons Attribution 4.0, sedangkan contoh kode dilisensikan berdasarkan Lisensi Apache 2.0. Untuk mengetahui informasi selengkapnya, lihat Kebijakan Situs Google Developers. Java adalah merek dagang terdaftar dari Oracle dan/atau afiliasinya.
Terakhir diperbarui pada 2025-08-31 UTC.
[null,null,["Terakhir diperbarui pada 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. |"]]
