إعداد التفويض
تنظيم صفحاتك في مجموعات
يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.
تتطلّب Search Ads 360 API من جميع الطلبات تحديد رمز دخول OAuth 2.0
للمصادقة. يمكنك اتّباع أيّ عملية سير عمل عادية لمصادقة OAuth 2.0
لإنشاء الرمز المميّز ونقله إلى Search Ads 360 API. ننصحك بالعملية الموضّحة أدناه لأنّها مناسبة لتحميل الإحالات الناجحة وتنزيل التقارير بشكلٍ مبرمَج بالكامل.
للحصول على بدائل لسير العمل الموضّح أدناه، يُرجى الاطّلاع على مقالتَي استخدام
بروتوكول OAuth 2.0 للتطبيقات المثبَّتة أو
استخدام بروتوكول OAuth 2.0 للتطبيقات من خادم إلى خادم. إذا كنت تستخدم سير عمل بديلاً،
حدِّد القيمة التالية كمَعلمة scope عند طلب رمز تفويض
2.0 لبروتوكول OAuth:
https://www.googleapis.com/auth/doubleclicksearch
إذا اتّبعت مسار الخادم إلى الخادم، أضِف حساب الخدمة كمستخدم في "إعلانات شبكة البحث 360".
سير عمل التفويض المقترَح
- انتقِل إلى وحدة تحكّم واجهة برمجة تطبيقات Google واختَر مشروعك.
إذا لم يسبق لك إنشاء مشروع على Google API Console وبيانات اعتماد OAuth، اتّبِع
التعليمات الواردة في مقالة إنشاء مشروع على Google API
Console وبيانات اعتماد OAuth لعميلك.
للعثور على معرّف عميل OAuth وسرّه لمشروعك، اتّبِع الخطوات التالية:
- افتح صفحة "بيانات الاعتماد".
- في عمود الاسم، انقر على اسم عميل OAuth.
- يتم إدراج معرّف العميل وسرّه في الصفحة.
- افتح متصفّح ويب وسجِّل الدخول إلى Google
باستخدام حساب Google لديه
إذن بالوصول إلى البيانات في "إعلانات شبكة البحث 360".
هذا هو حساب Google الذي سيستخدمه برنامج "إعلانات شبكة البحث 360" لتسجيل الدخول باستخدام واجهة برمجة التطبيقات.
إذا غادر صاحب حساب Google شركتك وأزلت إذن الوصول إلى "إعلانات شبكة البحث 360"
من الحساب، عليك تكرار سير عمل التفويض هذا وتحديد
حساب Google مختلف.
- احصل على رمز إعادة التنشيط من خلال استدعاء نصّ الأداة في "إعلانات شبكة البحث 360" على النحو التالي:
sa360Api.py --login
يرشدك النص البرمجي خلال عملية استخدام معرّف عميل OAuth وسرّه للحصول على رمز مميز لإعادة التحميل. لا يكون رمز إعادة التنشيط صالحًا إلا لحساب Google الذي سجّلت
الدخول إليه خلال الخطوة السابقة.
كجزء من هذه العملية، ينشئ النص البرمجي عنوان URL ويطلب منك
الانتقال إلى عنوان URL في متصفّح ويب.
-
عندما يطلب منك المتصفّح السماح لعميل OAuth بالوصول إلى بيانات "إعلانات شبكة البحث 360"،
تأكَّد من ظهور حساب Google الذي سجّلت الدخول إليه سابقًا. (إذا سجّلت الدخول إلى عدة
حسابات على Google، قد يظهر لك حساب مختلف.)
في نهاية العملية، يُخرج نص sa360Api.py سلسلة مُحدَّدة بفواصل. القيمة الأولى هي معرّف العميل الذي قدّمته، والقيمة الثانية هي سر العميل
الذي قدّمته، والقيمة الثالثة هي رمز إعادة التنشيط. في المثال التالي، يظهر الرمز المميّز لإعادة التحميل بنص غامق:
123456789123.apps.googleusercontent.com,ABCDEFGHIJKLMNOPQR_abcdef,1/HIJklM01OPQR23NOP456rst890uvw
- تخزين معرّف العميل وسرّ العميل والرمز المميّز لإعادة التحميل في قاعدة بيانات خلفية أو
مكان آمن آخر يمكن لتطبيقك الوصول إليه
احتفظ بالسلسلة بأكملها المحدّدة بفواصل في مكان مناسب إذا كنت تخطّط لاستخدام
sa360Api.py لإرسال نماذج طلبات JSON إلى Search Ads 360 API. عليك تمرير السلسلة بأكملها كمَعلمة في كل مرة يتم فيها استدعاء النص البرمجي.
- أضِف رمزًا إلى تطبيقك لتنفيذ ما يلي:
- استخدِم معرّف العميل وسرّ العميل والرمز المميّز لإعادة التحميل للحصول على
رمز وصول جديد لبروتوكول OAuth 2.0.
- أرسِل طلبات إلى Search Ads 360 API باستخدام رمز الأمان الجديد.
إذا كنت تستخدم مكتبات العملاء، يوضّح القسم التالي، إعداد تطبيقك،
كيفية إضافة رمز التفويض هذا إلى تطبيقك.
إذا لم تكن تستخدِم إحدى مكتبات البرامج، يمكنك الاطّلاع على مقالة استخدام بروتوكول OAuth 2.0 للتطبيقات المثبَّتة للحصول على
اقتراحات حول الحصول على رمز مميز جديد للوصول.
إنّ محتوى هذه الصفحة مرخّص بموجب ترخيص Creative Commons Attribution 4.0 ما لم يُنصّ على خلاف ذلك، ونماذج الرموز مرخّصة بموجب ترخيص Apache 2.0. للاطّلاع على التفاصيل، يُرجى مراجعة سياسات موقع Google Developers. إنّ Java هي علامة تجارية مسجَّلة لشركة Oracle و/أو شركائها التابعين.
تاريخ التعديل الأخير: 2024-11-07 (حسب التوقيت العالمي المتفَّق عليه)
[null,null,["تاريخ التعديل الأخير: 2024-11-07 (حسب التوقيت العالمي المتفَّق عليه)"],[[["\u003cp\u003eThe Search Ads 360 API requires OAuth 2.0 access tokens for authentication, obtainable through standard OAuth 2.0 workflows or the recommended workflow outlined in the document.\u003c/p\u003e\n"],["\u003cp\u003eThe recommended workflow involves obtaining a refresh token using the provided utility script and storing it securely along with the client ID and secret.\u003c/p\u003e\n"],["\u003cp\u003eApplications should be designed to use the stored credentials to obtain fresh access tokens for API requests, as detailed in the "Set Up Your Application" section or relevant OAuth 2.0 documentation.\u003c/p\u003e\n"],["\u003cp\u003eAlternative workflows for installed or server-to-server applications are available with specific scope requirements and user management considerations.\u003c/p\u003e\n"]]],["The Search Ads 360 API requires OAuth 2.0 access tokens for authentication. The recommended workflow involves creating a Google API Console project and obtaining OAuth credentials. Users sign into a Google Account with Search Ads 360 access, then use the `sa360Api.py` script to generate a refresh token. The script outputs client ID, client secret, and refresh token. Store these securely, and use them in your application to obtain a fresh OAuth access token for API requests.\n"],null,["# Set Up Authorization\n\nThe Search Ads 360 API requires all requests to specify an [OAuth 2.0](/accounts/docs/OAuth2)\naccess token for authentication. You can follow any standard OAuth 2.0 authentication workflow\nto generate the token and pass it to the Search Ads 360 API. We recommend the workflow described\nbelow because it is suitable for fully automated conversion uploads and report downloads.\n\n\nFor alternatives to the workflow described below, see [Using\nOAuth 2.0 for Installed Applications](https://developers.google.com/accounts/docs/OAuth2InstalledApp) or\n[Using OAuth 2.0 for Server to Server Applications](https://developers.google.com/identity/protocols/OAuth2ServiceAccount). If you use an alternate workflow,\nspecify the following value as the `scope` parameter when you request an OAuth\n2.0 authorization code: \n\n`https://www.googleapis.com/auth/doubleclicksearch`\n\nIf you follow the server to server route, add the service account as a Search Ads 360 user.\n\nRecommended authorization workflow\n----------------------------------\n\n1. Go to the [Google API Console](https://console.cloud.google.com/) and select your project.\n\n\n If you haven't already created a Google API Console project and OAuth credentials, follow\n the instructions in [Create a Google API\n Console project and OAuth credentials for your client](/search-ads/v2/prereqs#project).\n\n To find your project's OAuth client ID and secret, do the following:\n 1. Open the [Credentials page](https://console.cloud.google.com/apis/credentials).\n 2. In the **Name** column, click the name of your OAuth client.\n 3. The client ID and secret are listed on the page.\n2. Open a web browser and [sign into Google](https://accounts.google.com/ServiceLogin)with a Google Account that [has\n permission to access data](/search-ads/v2/prereqs#permissions) in Search Ads 360.\n\n This is the Google Account your API client will use to authenticate with Search Ads 360.\n If the Google Account holder leaves your company and you remove Search Ads 360 access\n from the account, you will need to repeat this authorization workflow and specify a\n different Google Account.\n3. Obtain a refresh token by invoking the [Search Ads 360 utility script](/search-ads/v2/prereqs#ds3py) as follows:\n\n\n `sa360Api.py --login`\n\n\n The script takes you through the process of using the Oauth client ID and secret to\n obtain a refresh token. The refresh token is valid only for the Google Account you signed\n into during the previous step.\n\n As part of this process, the script generates a URL and instructs you to\n visit the URL in a web browser.\n4. When the browser asks you to allow OAuth client access to Search Ads 360 data,\n make sure the Google Account you signed into earlier appears. (If you're signed into multiple\n Google Accounts, you might be presented with a different account.)\n\n\n At the end of the process, the `sa360Api.py` script outputs a comma-delimited\n string. The first value is the client ID you provided, the second value is the client\n secret you provided, and the third value is the refresh token. In the following example\n output, the refresh token is in **bold text** : \n\n `123456789123.apps.googleusercontent.com,ABCDEFGHIJKLMNOPQR_abcdef,`**1/HIJklM01OPQR23NOP456rst890uvw**\n5. Store the client ID, client secret, and refresh token in a backend database or other secure location that's accessible to your application.\n Keep the entire comma-delimited string in a convenient location if you plan to use\n `sa360Api.py` to send sample JSON requests to the Search Ads 360 API. You'll pass the\n entire string as a parameter each time you invoke the script.\n\n6. Add code to your application that does the following:\n 1. Use the client ID, client secret, and refresh token to obtain a fresh OAuth 2.0 access token.\n 2. Send requests to the Search Ads 360 API using the fresh access token.\n\n\n If you're using the client libraries, the next section, [Set Up Your Application](/search-ads/v2/configure),\n describes how to add this authorization code to your application.\n\n\n If you're not using one of the client libraries, see [Using OAuth 2.0 for Installed Applications](https://developers.google.com/accounts/docs/OAuth2InstalledApp) for\n suggestions on obtaining a fresh access token."]]
