هنگام تماس با Search Ads 360 Reporting API به اعتبارنامه برنامه OAuth 2.0 نیاز دارید. اگر تماس‌های API را به‌عنوان یک حساب مدیریتی 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 API ها تازه کار هستید، می توانید از oauth2l یا OAuth 2.0 Playground برای آزمایش اعتبار برنامه و Search Ads 360 Reporting API قبل از نوشتن کد برای برنامه خود استفاده کنید. همچنین می‌توانید با اجرای اسکریپت تولید اعتبار کاربر ارائه‌شده، یک نشانه تازه‌سازی OAuth ایجاد کنید.
تولید نشانه های دسترسی جدید
هنگامی که یک شناسه کلاینت ، رمز سرویس گیرنده ، و توکن تازه‌سازی دارید، می‌توانید یک نشانه دسترسی جدید برای استفاده در تماس‌های 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 به 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 که توسط یک مدیر با حساب مشتری برقرار می‌شود (یعنی هنگام ورود به عنوان مدیر برای برقراری تماس‌های API با یکی از حساب‌های مشتری خود)، همچنین باید هدر HTTP login-customer-id را ارائه کنید. . این مقدار نشان دهنده شناسه مشتری Search Ads 360 مدیری است که تماس API را انجام می دهد.
گنجاندن این سرصفحه معادل انتخاب یک حساب کاربری در Search Ads 360 UI پس از ورود به سیستم یا کلیک بر روی تصویر نمایه خود در گوشه سمت راست بالای صفحه است. هنگام تعیین شناسه مشتری، مطمئن شوید که خط فاصله (-) را حذف کنید، به عنوان مثال: 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 را به طور منحصربه‌فرد شناسایی می‌کند. هنگام اشکال‌زدایی یا عیب‌یابی مشکلات مربوط به تماس‌های API خاص، request-id یک شناسه مهم است که هنگام تماس با پشتیبانی توسعه‌دهنده Google باید از آن استفاده کنید.
request-id: 2a5Cj89VV7CNhya1DZjjrC