این صفحه جزئیاتی درباره نحوه انجام کارهای رایج بااستفاده از API ارائه می‌دهد.
درحال ایجاد کاربران
UserService به کاربر دارای حقوق «سرپرست» اجازه می‌دهد مستقیماً در شبکه‌اش کاربر ایجاد کند. هر توسعه‌دهنده‌ای می‌تواند این کار را بدون نیاز به ثبت‌نام اولیه کاربر جدید انجام دهد. برای مثال، اگر برای اولین‌بار است که API را امتحان می‌کنید، به‌جای اینکه هر فراخوانی API را به‌عنوان «سرپرست» (پیش‌فرض برای نشانی ایمیل شما) انجام دهید، شاید بخواهید چند کاربر با نقش‌هایی مثل «فروشنده»، «ترافیک‌ساز»، یا «تبلیغ‌کننده» ایجاد کنید تا گردش‌های کاری دنیای واقعی را آزمایش کنید.
- چند نشانی Gmail جدید مثل
my.name.salesperson@gmail.comایجاد کنید. یا اینکه یک نشانی غیرGmail موجود را به‌عنوان حساب Google جدید ثبت کنید. - با آن نشانی جدید و
Roleانتخاب‌شده باcreateUsersتماس بگیرید. - می‌توانید بااستفاده از OAuth 2.0 برای تولید کد دسترسی، به‌عنوان آن کاربر جدید اصالت‌سنجی کنید.
دریافت Root AdUnit
هم بالاترین AdUnit که می‌توانید گره‌های فرزند را به آن اضافه کنید و هم عمق مجاز سلسله‌مراتب شما به نوع حسابتان (کسب‌وکار کوچک یا Premium) بستگی دارد. بالاترین AdUnit که از اصلاح گره‌های فرزندش پشتیبانی می‌کند، ریشه مؤثر AdUnit نامیده می‌شود.
برای بازیابی ریشه مؤثر، با NetworkService.getCurrentNetwork() تماس بگیرید و فیلد effectiveRootAdUnitId را در شیء Network برگردانده‌شده بررسی کنید.
توجه: انواع مختلف حساب از الگوهای سلسله‌مراتبی مختلفی پشتیبانی می‌کنند.
پرس‌وجو برای شیء
بااستفاده از روش getObjectsByStatement() که توسط بسیاری از سرویس‌ها ارائه می‌شود، اشیاء را براساس معیارهای جستجو جستجو می‌کنید، که در آن شیء نوع خاصی از شیء است. این
روش یک پُرسمان PQL را می‌گیرد که مشابه پُرسمان SQL است، زیرا به شما امکان می‌دهد
فیلدهایی را برای جستجو مشخص کنید (که نام فیلدها به ویژگی‌های شیء نگاشت می‌شود)، نتایج جستجو را مرتب،
محدود، و جابه‌جا کنید. برای کسب اطلاعات بیشتر درباره PQL و همچنین برای اطلاع از اینکه براساس کدام فیلدهای شیء می‌توانید فیلتر کنید، به راهنمای PQL مراجعه کنید.
ایجاد سفارش
برای ایجاد سفارش، کافی است شیء Order ایجاد کنید و شناسه‌های تبلیغ‌کننده، فروشنده، و ترافیک‌ساز را برای کاربران مناسب تنظیم کنید، نامی منحصربه‌فرد اختصاص دهید، و createOrders() را فراخوانی کنید. نتیجه شامل Order جدیداً ایجادشده،
یا خطا خواهد بود.
نمونه
نمونه کد Java برای ایجاد سفارش را ببینید.
ایجاد کردن مورد خطی
مراحل ایجاد یک ردیف آگهی جدید در اینجا آمده است:
- شیء
Orderجدیدی ایجاد کنید یا از شیء موجود استفاده کنید. - شیء
LineItemجدیدی ایجاد کنید و نوع چرخش، آرایه اندازه طرح آگهی، تاریخ شروع و پایان، و سایر ویژگی‌ها را تنظیم کنید. - شیء
InventoryTargetingجدیدی ایجاد کنید و مشخص کنید کدام شیءPlacementیاAdUnitهدف‌یابی یا مستثنی شود. - شیء
InventoryTargetingرا در شیءTargetingجدیدی قرار دهید و آن را به ویژگی هدف‌یابیLineItemاختصاص دهید. - روش سرویس مورد خطی
createLineItems()را با شیء جدیدتان فراخوانی کنید و نتیجه را بررسی کنید تا ببینید آیا شیء شما ایجاد شده است یا نه.
نمونه
نمونه کد Java برای ایجاد ردیف هدف را ببینید.
ایجاد طرح آگهی
انواع مختلف طرح‌آگهی‌ها از مؤلفه‌های مختلفی پشتیبانی می‌کنند: برای مثال، یک طرح‌آگهی تصویری از یک فایل منبع واحد برای تصویر پشتیبانی می‌کند؛ یک طرح‌آگهی فلش از دو فایل دارایی اساسی پشتیبانی می‌کند: یک فایل فلش و یک فایل تصویر پشتیبان، در صورتی که فایل فلش قابل ارائه نباشد. برای طرح‌آگهی‌هایی که در سایت‌های طرف سوم میزبانی می‌شوند، فقط یک قطعه HTML را بارگذاری خواهید کرد که به فایل موجود در سرور طرف سوم ارجاع می‌دهد. برای اطلاع از اینکه چه دارایی‌هایی را باید بارگذاری کنید تا طرح‌آگهی‌تان ایجاد شود،
زیرکلاس Creative خاص خود را
ببینید.
نمونه
نمونه کد Java برای ایجاد طرح‌آگهی تصویری را ببینید.
اصلاح شیء موجود
برای اصلاح شیء موجود، با فراخوانی getObjectsByStatement()، شیء خود را جستجو کنید،
مقادیر را در شیء برگردانده‌شده به‌روز کنید، و سپس updateObjects() را فراخوانی کنید.
توجه: اشیای به‌روزشده کاملاً جایگزین اشیای موجود خواهند شد، بنابراین اگر فراموش کنید مقدار ویژگی را در شیء ارسالی تنظیم کنید، شیء ذخیره‌شده مقدار پیش‌فرض آن ویژگی را دریافت خواهد کرد، نه مقدار قبلی را.
تغییر دادن وضعیت شیء
وضعیت شیء با فراخوانی روش performObjectAction()
که توسط سرویس شما ارائه شده است تغییر می‌کند. این روش دو پارامتر دارد:
- نمونه‌ای از شیء کنش که آنچه را می‌خواهید انجام شود توصیف می‌کند. برای
مثال، سرویس سفارش چندین کنش را نشان می‌دهد، ازجمله
ApproveOrders،PauseOrders، وArchiveOrders. همه اشیای کنش از یک کلاس کنش پایه مناسب برای سرویس شما مشتق می‌شوند. - یک پُرسمان PQL که توضیح می‌دهد کدام اشیاء باید تغییر کنند. می‌توانید وضعیت یک یا چند شیء را به‌طور هم‌زمان با مشخص کردن عبارت PQL مناسب تغییر دهید.
تولید برچسب‌های آگهی
نمی‌توانید بااستفاده از میانای برنامه‌سازی کاربردی برچسب آگهی تولید کنید؛ درعوض باید از وب‌سایت Google Ad Manager استفاده کنید. برای اطلاعات بیشتر، بخش برچسب‌گذاری در «مرکز راهنمایی» را ببینید.
نمونه‌های بیشتر
می‌توانید نمونه‌های بسیار بیشتری را در کد نمونه کتابخانه مشتری ما، به چندین زبان برنامه‌نویسی مختلف، پیدا کنید. برای دریافت پیوند نمونه‌ها به زبان برنامه‌نویسی‌تان، به صفحه کتابخانه‌های مشتری و کد نمونه مراجعه کنید.