در این صفحه جزئیاتی در مورد نحوه انجام وظایف رایج با استفاده از API ارائه می شود.
ایجاد کاربران
UserService به کاربر با حقوق Administrator اجازه می دهد تا کاربر را مستقیماً در شبکه خود ایجاد کند . هر توسعه‌دهنده‌ای می‌تواند این کار را بدون ثبت نام کاربر جدید انجام دهد. به عنوان مثال، اگر برای اولین بار است که API را امتحان می کنید، به جای انجام هر تماس API به عنوان مدیر (پیش فرض برای آدرس ایمیل شما)، ممکن است بخواهید چند کاربر با نقش هایی مانند فروشنده، قاچاقچی یا تبلیغ کننده برای آزمایش گردش کار در دنیای واقعی.
- چند آدرس جدید جیمیل مانند
my.name.salesperson@gmail.comایجاد کنید. از طرف دیگر، یک آدرس غیر gmail موجود را به عنوان یک حساب Google جدید ثبت کنید. -
createUsersبا آن آدرس جدید وRoleانتخاب شده فراخوانی کنید. - با استفاده از OAuth 2.0 می توانید به عنوان آن کاربر جدید احراز هویت کنید تا رمز دسترسی خود را ایجاد کنید.
دریافت Root AdUnit
هم بالاترین AdUnit که می توانید گره های فرزند را به آن اضافه کنید و هم عمق مجاز سلسله مراتب شما به نوع حساب شما (Small Business یا Premium) بستگی دارد. بالاترین AdUnit که از اصلاح گره های فرزند خود پشتیبانی می کند AdUnit ریشه موثر نامیده می شود.
برای بازیابی ریشه موثر، NetworkService.getCurrentNetwork() را فراخوانی کنید و فیلد effectiveRootAdUnitId را در شیء برگشتی Network بررسی کنید.
توجه: انواع حساب های مختلف از الگوهای سلسله مراتبی متفاوتی پشتیبانی می کنند.
پرس و جو برای یک شی
شما با استفاده از روش get Objects ByStatement() که توسط بسیاری از سرویس ها در معرض دید قرار می گیرد، اشیا را با معیارهای جستجو جستجو می کنید، جایی که Object یک نوع شی خاص است. این روش یک پرس و جو PQL را دریافت می کند، که شبیه به یک پرس و جوی SQL است که به شما امکان می دهد فیلدهایی را برای جستجو تعیین کنید (جایی که نام فیلدها به ویژگی های روی شی نشان داده می شوند)، مرتب سازی، محدود کردن و جبران نتایج جستجوی خود را انجام دهید. برای کسب اطلاعات بیشتر در مورد PQL، و همچنین برای اطلاع از اینکه کدام فیلدهای شی را می‌توانید فیلتر کنید، به راهنمای PQL مراجعه کنید.
ایجاد یک سفارش
برای ایجاد یک سفارش، به سادگی یک شی Order ایجاد کنید و شناسه های تبلیغ کننده، فروشنده و قاچاقچی را روی کاربران مناسب تنظیم کنید، یک نام منحصر به فرد اختصاص دهید، و createOrders() را فراخوانی کنید. نتیجه شامل Order جدید ایجاد شده یا یک خطا خواهد بود.
مثال
به مثال کد جاوا برای ایجاد یک سفارش مراجعه کنید.
ایجاد یک آیتم خط
در اینجا مراحل ایجاد یک آیتم خط جدید آمده است:
- یک شی
Orderجدید ایجاد کنید یا از یک موجود استفاده کنید. - یک شی
LineItemجدید ایجاد کنید و نوع چرخش، آرایه اندازه خلاقانه، تاریخ شروع و پایان و سایر خصوصیات را تنظیم کنید. - یک شیء
InventoryTargetingجدید ایجاد کنید و مشخص کنید کدام اشیاءPlacementیاAdUnitرا هدف قرار داده یا حذف کنید. - شی
InventoryTargetingخود را در داخل یک شیءTargetingجدید قرار دهید و آن را به ویژگی هدف گذاریLineItemخود اختصاص دهید. - متد سرویس lineitem
createLineItems()با شی جدید خود فراخوانی کنید و نتیجه را بررسی کنید تا ببینید آیا شیء شما ایجاد شده است یا خیر.
مثال
به مثال کد جاوا برای ایجاد یک آیتم خط مراجعه کنید.
ایجاد یک خلاق
انواع مختلف خلاقیت‌ها از اجزای مختلف پشتیبانی می‌کنند: برای مثال، یک تصویر خلاق از یک فایل منبع واحد برای تصویر پشتیبانی می‌کند. یک فلش خلاق از دو فایل دارایی اصلی پشتیبانی می کند: یک فایل فلش و یک فایل تصویر پشتیبان، در صورتی که فایل فلش قابل ارائه نباشد. برای خلاقیت‌هایی که در سایت‌های شخص ثالث میزبانی می‌شوند، فقط یک قطعه HTML را آپلود می‌کنید که به فایل در سرور شخص ثالث ارجاع می‌دهد. برای اینکه بدانید برای ایجاد خلاقیت خود باید چه دارایی هایی را آپلود کنید، زیر کلاس Creative خاص خود را ببینید.
مثال
به مثال کد جاوا برای ایجاد یک تصویر خلاق مراجعه کنید.
اصلاح یک شی موجود
برای تغییر یک شی موجود، با فراخوانی get Objects ByStatement() برای شی مورد نظر خود پرس و جو کنید، مقادیر موجود در اشیاء برگشتی را به روز کنید و سپس update Objects () را فراخوانی کنید.
توجه: اشیاء به روز شده به طور کامل جایگزین اشیاء موجود می شوند، بنابراین اگر از تنظیم مقدار خاصیت در شی ای که ارسال می کنید غفلت کنید، شی ذخیره شده مقدار پیش فرض آن ویژگی را دریافت می کند، نه مقدار قبلی.
تغییر وضعیت شی
وضعیت شیء با فراخوانی متد perform Object Action() توسط سرویس شما در معرض دید قرار می گیرد تغییر می کند. این روش دو پارامتر دارد:
- نمونه ای از شی اکشن که آنچه را که می خواهید انجام دهید را توصیف می کند. به عنوان مثال، سرویس سفارش چندین عملکرد از جمله
ApproveOrders،PauseOrdersوArchiveOrdersرا در معرض نمایش قرار می دهد. اشیاء اکشن همگی از یک کلاس اکشن پایه مناسب برای سرویس شما مشتق می شوند. - یک پرس و جو PQL که توضیح می دهد کدام اشیاء را باید تغییر داد. شما می توانید وضعیت یک یا چند شی را در یک زمان با تعیین یک عبارت PQL مناسب تغییر دهید.
تولید برچسب های تبلیغاتی
شما نمی توانید برچسب های تبلیغاتی را با استفاده از API ایجاد کنید. در عوض باید از وب سایت Google Ad Manager استفاده کنید. برای اطلاعات بیشتر به بخش Tagging Help Center مراجعه کنید.
نمونه های بیشتر
شما می توانید نمونه های بیشتری را در کد نمونه کتابخانه مشتری ما، در چندین زبان برنامه نویسی مختلف بیابید. برای پیوند به نمونه هایی در زبان برنامه نویسی خود، صفحه Client Libraries & Example Code را ببینید.