هنگام فراخوانی Search Ads 360 Reporting API، به اعتبارنامه برنامه OAuth 2.0 نیاز دارید. اگر فراخوانی‌های میانای برنامه‌سازی کاربردی را به‌عنوان
«حساب مدیر Search Ads 360» انجام می‌دهید، باید برای هر درخواست
سرصفحه login-customer-id را نیز مشخص کنید. این صفحه نحوه تنظیم این مقادیر را شرح می‌دهد و چندین سرایند HTTP اضافی مختص API را که هنگام استفاده از میانای REST ارسال و دریافت می‌شوند مستند می‌کند.
اعتبارنامه‌های OAuth 2.0
Search Ads 360 Reporting API از اعتبارنامه برنامه برای شناسایی و صدور مجوز درخواست‌های API استفاده می‌کند. کارخواه‌های OAuth 2.0 را می‌توان پیکربندی کرد. همه فراخوانی‌های Search Ads 360 Reporting API باید ازطریق OAuth2 مجاز شوند. OAuth2 به برنامه کارخواه Search Ads 360 Reporting API شما امکان می‌دهد بدون نیاز به مدیریت یا ذخیره اطلاعات ورود به سیستم کاربر، به حساب Search Ads 360 کاربر دسترسی پیدا کند.
اگر با Google APIs آشنایی ندارید، می‌توانید از oauth2l یا OAuth 2.0 Playground برای آزمایش اعتبارنامه برنامه و Search Ads 360 Reporting API قبل‌از نوشتن کد برای برنامه‌تان استفاده کنید. همچنین می‌توانید با اجرای اسکریپت تولید اعتبارنامه کاربر ارائه‌شده، یک ژتون بازآوری OAuth تولید کنید.
درحال تولید کدهای دسترسی جدید
وقتی شناسه کارخواه، رمز کارخواه، و ژتون بازآوری را دریافت کردید، می‌توانید
بااستفاده از ابزار خط فرمان 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 به Search Ads 360 Reporting API استفاده می‌کنید:
GET /v0/customers:listAccessibleCustomers HTTP/1.1
Host: searchads360.googleapis.com
Authorization: Bearer ACCESS_TOKEN
سرایندهای درخواست
شناسه مشتری ورود به سیستم
برای فراخوانی‌های Search Ads 360 Reporting API که توسط مدیر برای حساب مشتری انجام می‌شود (یعنی زمانی که
به‌عنوان مدیر وارد سیستم می‌شوید تا فراخوانی‌های میانای برنامه‌سازی کاربردی را برای یکی از حساب‌های مشتری انجام دهید)، شما
همچنین باید سرایند HTTP login-customer-id را ارائه دهید. این مقدار نشان‌دهنده
شناسه مشتری Search Ads 360 مدیری است که فراخوانی API را انجام می‌دهد.
گنجاندن این سرصفحه معادل انتخاب حساب در میانای کاربری Search Ads 360
پس‌از ورود به سیستم یا کلیک کردن روی تصویر نمایه در گوشه بالا
صفحه است. هنگام مشخص کردن شناسه مشتری، حتماً خط تیره‌ها (—) را بردارید،
برای مثال: 1234567890، نه 123-456-7890.
GET /v0/customers:listAccessibleCustomers HTTP/1.1
Host: searchads360.googleapis.com
Authorization: Bearer ACCESS_TOKEN
login-customer-id: MANAGER_CUSTOMER_ID
سرایندهای پاسخ
سرایندهای زیر در پاسخ‌های HTTP از API برگردانده می‌شوند.
شناسه درخواست
request-id رشته‌ای است که درخواست API را به‌طور منحصربه‌فرد شناسایی می‌کند. هنگام
اشکال‌زدایی یا عیب‌یابی مشکلات مربوط به فراخوانی‌های میانای برنامه‌سازی کاربردی خاص، request-id
شناسه مهمی است که باید هنگام تماس با پشتیبانی توسعه‌دهنده Google
دردسترس باشد.
request-id: 2a5Cj89VV7CNhya1DZjjrC