Authentication
קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
במסמך הזה מוסבר איך לבצע אימות ב-Ad Manager API. איך את/ה
האימות תלוי בממשק שבו אתם משתמשים ובסביבה שבה
פועל, אבל כל בקשות ה-API חייבות לכלול אסימון גישה עם
היקף Ad Manager API.
ספריות הלקוח של Ad Manager משתמשות ב-Application Default Credentials כדי ליצור אסימוני גישה ברמת ההיקף של Ad Manager API. במדריך הזה מוסבר איך להגדיר את Application Default Credentials.
גם אם אתם לא משתמשים בספריית לקוח, עדיין תצטרכו ליצור פרטי כניסה ולהשתמש בהם כדי לאשר את הבקשות.
למידע נוסף על אימות ועל מתן הרשאות, קראו את המדריך שימוש ב-OAuth 2.0.
איך קובעים את סוג האימות
| סוג אימות |
תיאור |
| חשבון שירות
|
צריך לבחור באפשרות הזו אם רוצים לבצע אימות כמיועד
ולא לאדם ספציפי.
למידע נוסף |
| אפליקציית אינטרנט
|
צריך לבחור באפשרות הזו אם רוצים לבצע אימות בתור משתמש כלשהו
שמעניק לאפליקציה שלכם הרשאת גישה
בנתונים שלהם ב-Ad Manager.
למידע נוסף |
| פיתוח מקומי
|
צריך לבחור באפשרות הזו אם ברצונך לבצע אימות כשלך
חשבון Google או חשבון שירות מהמכשיר המקומי שלך
סביבת פיתוח. |
הפעלת Ad Manager API
מפעילים את Ad Manager API בפרויקט ב-Cloud במסוף Google API.
אם מתבקשים, בוחרים פרויקט או יוצרים פרויקט חדש.
יצירת פרטי כניסה
לוחצים על הכרטיסייה של סוג האימות ופועלים לפי ההוראות כדי
יוצרים את פרטי הכניסה:
חשבון שירות
ב-Google Cloud
כדי לאמת עומס עבודה שפועל ב-Google Cloud, צריך להשתמש בפרטי הכניסה של
חשבון השירות שמקושר למשאב המחשוב שבו הקוד
ריצה.
לדוגמה, אפשר לצרף חשבון שירות לחשבון וירטואלי של Compute Engine
מכונה (VM), שירות Cloud Run או משימת Dataflow. זאת הגישה המועדפת לאימות בקוד שפועל במשאב מחשוב של Google Cloud.
כדי לקבל מידע על המשאבים שאליהם אפשר לצרף חשבונות שירות:
ולקבל עזרה בצירוף חשבון השירות למשאב, אפשר לקרוא את
מסמכים בנושא צירוף חשבון שירות.
בארגון או אצל ספק אחר של שירותי ענן
השיטה המועדפת להגדרת אימות מחוץ ל-Google Cloud היא
כדי להשתמש באיחוד שירותי אימות הזהות של עומסי עבודה; אתם יוצרים
קובץ התצורה של פרטי הכניסה ולהגדיר את GOOGLE_APPLICATION_CREDENTIALS
במשתנה הסביבה שיצביע אליו. גישה זו בטוחה יותר מ
ליצור מפתח לחשבון שירות.
אם אין לך אפשרות להגדיר את איחוד שירותי אימות הזהות של עומסי עבודה,
יוצרים חשבון שירות ויוצרים מפתח לחשבון השירות:
פותחים את דף פרטי הכניסה ב-Google API Console.
בדף Credentials, בוחרים באפשרות Create credentials ואז באפשרות Service Account.
לוחצים על כתובת האימייל של חשבון השירות שרוצים ליצור.
כוונון עדין של מפתח.
לוחצים על הכרטיסייה Keys.
לוחצים על התפריט הנפתח Add key ובוחרים באפשרות Create new key.
בוחרים באפשרות JSON בתור Key type ולוחצים על Create.
מגדירים את משתנה הסביבה GOOGLE_APPLICATION_CREDENTIALS לנתיב של קובץ ה-JSON.
Linux או macOS
export GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH
Windows
set GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH
אפליקציית אינטרנט
פותחים את דף פרטי הכניסה ב-Google API Console.
אם מופיעה בקשה, בוחרים את הפרויקט שבו הפעלתם את Ad Manager API.
בדף Credentials, בוחרים באפשרות Create credentials ואז באפשרות OAuth client ID.
בוחרים בסוג האפליקציה Web application.
ממלאים את הטופס ולוחצים על Create. אפליקציות שמשתמשות בשפות
פלטפורמות כמו PHP, Java, Python, Ruby ו-NET .חייבים לציין
הפניות URI להפניה אוטומטית. מזהי ה-URI להפניה אוטומטית הם נקודות הקצה שאליהן שרת OAuth 2.0 יכול לשלוח תגובות. נקודות הקצה האלה חייבות לעמוד בכללים של Google לאימות.
אחרי שיוצרים את פרטי הכניסה, מורידים את הקובץ client_secret.json. יש לאחסן את הקובץ באופן מאובטח במיקום שרק לאפליקציה שלכם יש גישה אליו.
מכאן, צריך לפעול לפי השלבים לקבלת אסימוני גישה מסוג OAuth 2.0
פיתוח מקומי
מגדירים את Application Default Credentials (ADC) בסביבה המקומית.
מתקינים את ה-CLI של Google Cloud ומפעילים את הפקודה הבאה כדי לאתחל אותו:
gcloud init
יוצרים פרטי כניסה לאימות מקומי בחשבון Google ומגדירים את מזהה הפרויקט לפרויקט שבו Ad Manager API מופעל:
gcloud auth application-default login --scopes="https://www.googleapis.com/auth/admanager"
gcloud auth application-default set-quota-project PROJECT_ID
לחלופין, אפשר לבצע אימות כחשבון שירות, שמגדיר את הסביבה
במשתנה GOOGLE_APPLICATION_CREDENTIALS לנתיב של קובץ המפתח.
Linux או macOS
export GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH
Windows
set GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH
חשבון שירות
- נכנסים לרשת Ad Manager.
- לוחצים על הכרטיסייה אדמין.
- חשוב לוודא שהגישה ל-API מופעלת.
- לוחצים על הלחצן Add a service account user.
- ממלאים את הטופס באמצעות כתובת האימייל של חשבון השירות.
צריך להוסיף משתמש בחשבון שירות לתפקידים ולצוותים מתאימים
לשילוב של ה-API.
- לוחצים על הלחצן שמירה. אמורה להופיע הודעה עם אישור
ההוספה של חשבון השירות.
- כדי להציג משתמשים קיימים בחשבון שירות, עוברים לכרטיסייה Users ולוחצים על המסנן Service Account.
אפליקציית אינטרנט
- נכנסים לרשת Ad Manager.
- לוחצים על הכרטיסייה אדמין.
- חשוב לוודא שהגישה ל-API מופעלת.
פיתוח מקומי
- נכנסים לרשת Ad Manager.
- לוחצים על הכרטיסייה אדמין.
- חשוב לוודא שהגישה ל-API מופעלת.
ללא ספריית לקוח
גם אם אתם לא משתמשים בספריית לקוח, מומלץ מאוד להשתמש
ספריית OAuth2 לצורך אימות.
להוראות מפורטות לקבלת אסימוני גישה, ראו שימוש ב-OAuth2 עם Google APIs.
אסימוני גישה
כלול את אסימון הגישה שלך בבקשה ל-API על ידי הוספת
פרמטר של שאילתת access_token או ערך Bearer של כותרת HTTP ב-Authorization.
כשהדבר אפשרי, עדיף להשתמש בכותרת HTTP כי מחרוזות השאילתה נוטות
גלוי ביומני השרת.
לדוגמה:
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
היקף
כל אסימון גישה משויך להיקף אחד או יותר. היקף שולט
קבוצת משאבים ופעולות שמותר על ידי אסימון גישה. מנהל המודעות
ל-API יש רק היקף אחד. צריך לבצע את ההרשאה ברמת המשתמש בתוך המוצר.
| היקף |
הרשאות |
https://www.googleapis.com/auth/admanager
|
הצגה וניהול של הקמפיינים ב-Google Ad Manager. |
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 4.0 ודוגמאות הקוד הן ברישיון Apache 2.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2025-08-31 (שעון UTC).
[null,null,["עדכון אחרון: 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. |"]]
