هنگام تماس با Google Ads API به اعتبارنامه برنامه OAuth 2.0 و یک توکن توسعه دهنده نیاز دارید. اگر با یک حساب مدیر Google Ads تماس‌های API برقرار می‌کنید، باید با هر درخواست یک هدر login-customer-id نیز مشخص کنید. این صفحه نحوه تنظیم این مقادیر را توضیح می‌دهد و چندین هدر HTTP ویژه API را که هنگام استفاده از رابط REST ارسال و دریافت می‌شوند، مستند می‌کند.
اعتبارنامه OAuth 2.0
Google Ads API از اعتبار برنامه‌ها برای شناسایی و تأیید درخواست‌های API استفاده می‌کند. هم مشتریان OAuth 2.0 و هم حساب های سرویس را می توان پیکربندی کرد. برای جزئیات بیشتر درباره پیکربندی مجوز سمت سرویس گیرنده، به OAuth2 در Google Ads API مراجعه کنید.
اگر با Google API ها تازه کار هستید، می توانید از oauth2l یا OAuth 2.0 Playground برای آزمایش اعتبار برنامه و Google Ads API قبل از نوشتن کد برنامه خود استفاده کنید.
استفاده از جریان های دسکتاپ یا برنامه های وب
مراحل را برای پیکربندی پروژه Google API Console برای Google Ads API دنبال کنید. شناسه مشتری و راز مشتری را ضبط کنید، سپس به این صفحه بازگردید.
هنگامی که یک سرویس گیرنده OAuth ایجاد کردید، دستورالعمل‌های جریان برنامه دسکتاپ یا دستورالعمل‌های جریان برنامه وب را دنبال کنید تا یک نشانه تازه‌سازی و یک نشانه دسترسی ایجاد کنید.
استفاده از حساب های خدماتی
دستورالعمل‌های رایج در راهنمای حساب‌های سرویس را برای تنظیم دسترسی به حساب سرویس برای Google Ads API دنبال کنید.
هنگامی که یک حساب سرویس برای دسترسی به حساب Google Ads خود راه اندازی کردید، راهنمای Using OAuth 2.0 for Server to Server Applications را دنبال کنید و حتماً برگه HTTP/REST را انتخاب کنید. scope مورد استفاده برای دسترسی به API Google Ads https://www.googleapis.com/auth/adwords است.
تولید نشانه های دسترسی جدید
هنگامی که یک شناسه کلاینت ، رمز سرویس گیرنده ، و توکن تازه‌سازی دارید، می‌توانید یک نشانه دسترسی جدید برای استفاده در تماس‌های API با ابزار خط فرمان 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
سپس از نشانه دسترسی بازگردانده شده توسط درخواست curl در سرصفحه Authorization HTTP هر تماس API با Google Ads API استفاده می کنید:
GET /v17/customers:listAccessibleCustomers HTTP/1.1
Host: googleads.googleapis.com
Authorization: Bearer ACCESS_TOKEN
developer-token: DEVELOPER_TOKEN
درخواست سرصفحه ها
توکن توسعه دهنده
Google Ads API همچنین برای برقراری تماس با API به توکن توسعه دهنده نیاز دارد. می‌توانید مستقیماً از رابط کاربری Google Ads برای یک رمز برای حساب مدیر خود درخواست دهید. برای جزئیات بیشتر درباره راه‌اندازی با توکن توسعه‌دهنده، به دریافت رمز توسعه‌دهنده خود مراجعه کنید.
باید مقدار رمز توسعه‌دهنده خود را در هدر HTTP developer-token هر تماس API با Google Ads API قرار دهید:
GET /v17/customers:listAccessibleCustomers HTTP/1.1
Host: googleads.googleapis.com
Authorization: Bearer ACCESS_TOKEN
developer-token: DEVELOPER_TOKEN
ورود به سیستم شناسه مشتری
برای تماس‌های Google Ads API که توسط یک مدیر با حساب مشتری برقرار می‌شود (یعنی هنگام ورود به عنوان مدیر برای برقراری تماس‌های API با یکی از حساب‌های مشتری خود)، همچنین باید هدر HTTP login-customer-id ارائه کنید. این مقدار نشان دهنده شناسه مشتری Google Ads مدیری است که تماس API را انجام می دهد.
گنجاندن این هدر معادل انتخاب یک حساب کاربری در رابط کاربری Google Ads پس از ورود به سیستم یا کلیک بر روی تصویر نمایه خود در گوشه سمت راست بالای صفحه است. هنگام تعیین شناسه مشتری، مطمئن شوید که خط فاصله (-) را حذف کنید، به عنوان مثال: 1234567890 ، نه 123-456-7890 .
GET /v17/customers:listAccessibleCustomers HTTP/1.1
Host: googleads.googleapis.com
Authorization: Bearer ACCESS_TOKEN
developer-token: DEVELOPER_TOKEN
login-customer-id: MANAGER_CUSTOMER_ID
شناسه مشتری مرتبط
این سرصفحه تنها توسط ارائه‌دهندگان تجزیه و تحلیل برنامه شخص ثالث هنگام آپلود تبدیل‌ها به یک حساب Google Ads مرتبط استفاده می‌شود. برای جزئیات بیشتر به راهنمای ساختار تماس API مراجعه کنید.
...
Authorization: Bearer ACCESS_TOKEN
developer-token: DEVELOPER_TOKEN
login-customer-id: MANAGER_CUSTOMER_ID
linked-customer-id: LINKED_CUSTOMER_ID
سرصفحه های پاسخ
سرصفحه های زیر در پاسخ های HTTP از API بازگردانده می شوند.
شناسه درخواست
request-id رشته‌ای است که درخواست API را به طور منحصربه‌فرد شناسایی می‌کند. هنگام اشکال‌زدایی یا عیب‌یابی مشکلات مربوط به تماس‌های API خاص، request-id یک شناسه مهم است که هنگام تماس با پشتیبانی توسعه‌دهنده Google باید از آن استفاده کنید.
request-id: 2a5Cj89VV7CNhya1DZjjrC