پس زمینه

قبل از شروع

1. از نماینده حساب خود بخواهید مجوزهای مناسبی را برای حساب هایی که برنامه شما به آنها دسترسی دارد تنظیم کند.
2. اگر با مفاهیم خریداران مجاز آشنا نیستید، از مرکز راهنمایی خریداران مجاز دیدن کنید و رابط کاربری را آزمایش کنید. اگر انتظار می‌رود که درخواست شما در زمان واقعی مناقصه انجام دهد، اسناد پروتکل RTB را بخوانید.
3. برای راه اندازی یک پروژه جدید، از کنسول APIs دیدن کنید. یا به حساب Google توسعه دهنده خود وارد شوید یا یک حساب ایجاد کنید. سپس از شما خواسته می شود که یک پروژه ایجاد کنید و چند شرایط خدمات را امضا کنید.

حساب والدین و فرزند

اگر در ساختار حسابی کار می‌کنید که شامل حساب‌های والدین و فرزند است، اگر نحوه تعامل آنها را درک کنید، ممکن است بتوانید مؤثرتر کار کنید. در زیر خلاصه ای کوتاه آورده شده است:

حساب های کودک

کاربر با اعتبارنامه‌ای که اجازه دسترسی به حساب فرزند را می‌دهد، فقط می‌تواند منابع مرتبط با حساب خود را مشاهده و اصلاح کند. حساب‌های فرزند نمی‌توانند منابع متعلق به سایر حساب‌های فرزند یا والدین را مشاهده یا تغییر دهند.

حساب های والدین

کاربر با اعتباری که اجازه دسترسی به حساب والد را می‌دهد، می‌تواند علاوه بر همه حساب‌های فرزند مرتبط، منابع حساب والد را مشاهده و تغییر دهد. برای عملیاتی که همه یک منبع معین را فهرست می کند، این کاربر پاسخی شامل داده های حساب خود و همه حساب های فرزند خود را دریافت می کند. توجه داشته باشید که برای انواع دیگر درخواست‌هایی که منابع را برای صندلی کودک هدف قرار می‌دهند، یک حساب والدین باید یک پارامتر مسیر accountId برای حساب فرزند به جای accountId خود مشخص کند.

توجه: اگر می‌خواهید ساختار حساب را با حساب‌های والدین و فرزند پیکربندی کنید، باید با مدیر حساب فنی خود تماس بگیرید.

مدل داده REST API

یک منبع یک موجودیت داده منفرد با یک شناسه منحصر به فرد است. منبع حساب‌ها نشان‌دهنده ورودی حساب مجاز خریداران است و کلاس داده ریشه برای Ad Exchange Buyer API است. روش‌های API بر روی منابع حساب‌های فردی و مجموعه‌ای از منابع حساب‌ها عمل می‌کنند.

یک منبع حساب‌ها شامل: شناسه حساب، اطلاعات مورد استفاده در تطبیق کوکی‌ها، مکان‌های پیشنهاددهنده، نشانی اینترنتی که درخواست‌های پیشنهاد قیمت به آن ارسال می‌شود، و درخواستی برای تعیین حداکثر درخواست‌ها در ثانیه برای ارسال توسط صرافی تبلیغاتی است.

علاوه بر منبع و مجموعه حساب‌ها، Ad Exchange Buyer API ساختارهای داده زیر را تعریف می‌کند:

محل مناقصه گزار

مکان‌های مناقصه‌دهنده ساختارهایی هستند که با منابع حساب‌ها بازگردانده می‌شوند تا نشانی اینترنتی را که بورس آگهی باید درخواست‌های پیشنهادی را به آن ارسال کند و حداکثر تعداد درخواست‌ها در ثانیه را که تبادل آگهی باید ارسال کند، ارائه می‌کند. در اینجا نمونه ای از مکان پیشنهاد دهنده، بیان شده در JSON آمده است:

"bidderLocation": [
    {
      "url": "http://bid.url.com/bidder",
      "maximumQps": 1500
    }
  ],

موارد

آیتم ها لیستی از حساب ها را ارائه می دهند. در اینجا نمونه ای از موارد بیان شده در JSON آمده است:

{
  "kind": "adexchangebuyer#accountsList",
  "items": [
    accounts Resource
  ]
}

عملیات پشتیبانی شده

همانطور که در جدول زیر توضیح داده شده است، می توانید از سه روش مختلف در مجموعه ها و منابع در Ad Exchange Buyer API استفاده کنید. همه عملیات نیاز به مجوز دارند.

عملیات	توضیحات	REST نگاشت HTTP
فهرست	تمام حساب‌هایی را که کاربر تأیید شده فعلی می‌تواند به آنها دسترسی داشته باشد فهرست می‌کند.	GET URI مجموعه.
دریافت کنید	یک منبع حساب خاص دریافت می کند.	GET URI منبع.
به روز رسانی کنید	یک منبع حساب خاص را به روز می کند.	یک URI منبع را PUT ، جایی که داده ها را برای منبع به روز شده ارسال می کنید.

سبک تماس

REST سبکی از معماری نرم افزار است که یک رویکرد راحت و سازگار برای درخواست و اصلاح داده ها ارائه می دهد.

اصطلاح REST مخفف " انتقال دولت نمایندگی " است. در زمینه Google API ها، به استفاده از افعال HTTP برای بازیابی و اصلاح نمایش داده های ذخیره شده توسط Google اشاره دارد.

در یک سیستم RESTful، منابع در یک فروشگاه داده ذخیره می شوند. یک سرویس گیرنده درخواستی را ارسال می کند که سرور یک عمل خاص را انجام دهد (مانند ایجاد، بازیابی، به روز رسانی یا حذف یک منبع)، و سرور این عمل را انجام می دهد و پاسخی را می فرستد، اغلب به شکل یک نمایش از منبع مشخص شده.

در API های RESTful Google، مشتری با استفاده از یک فعل HTTP مانند POST ، GET ، PUT ، یا DELETE ، اقدامی را مشخص می کند. این یک منبع را توسط یک URI منحصر به فرد جهانی به شکل زیر مشخص می کند:

https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters

از آنجایی که همه منابع API دارای URI های منحصر به فرد قابل دسترسی با HTTP هستند، REST ذخیره داده را فعال می کند و برای کار با زیرساخت های توزیع شده وب بهینه شده است.

ممکن است تعاریف روش را در مستندات استانداردهای HTTP 1.1 مفید بیابید. آنها شامل مشخصات GET ، POST ، PUT و DELETE هستند.

REST در Ad Exchange Buyer API

عملیات پشتیبانی شده مستقیماً به افعال REST HTTP، همانطور که در عملیات API توضیح داده شده است، نگاشت.

فرمت خاص برای URI های API عبارتند از:

https://www.googleapis.com/adexchangebuyer/v1.4/resourceID?parameters

که در آن resourceID شناسه یک منبع Accounts است و parameters هر پارامتری هستند که باید در پرس و جو اعمال شود. برای جزئیات بیشتر به پارامترهای پرس و جو استاندارد و مستندات مرجع مراجعه کنید.

فرمت پسوندهای مسیر resourceID به شما امکان می دهد منبعی را که در حال حاضر روی آن کار می کنید شناسایی کنید، به عنوان مثال:

https://www.googleapis.com/adexchangebuyer/v1.4/accounts
https://www.googleapis.com/adexchangebuyer/v1.4/accounts/id

مجموعه کامل URI های مورد استفاده برای هر عملیات پشتیبانی شده در API در مستندات مرجع خلاصه شده است.

در اینجا نمونه‌ای از نحوه عملکرد آن در Ad Exchange Buyer API آورده شده است.

دریافت لیست حساب های کاربری تأیید شده:

GET https://www.googleapis.com/adexchangebuyer/v1.4/accounts

فرمت داده

JSON

JSON (JavaScript Object Notation) یک قالب داده رایج و مستقل از زبان است که نمایش متنی ساده ای از ساختارهای داده دلخواه را ارائه می دهد. برای اطلاعات بیشتر، به json.org مراجعه کنید.