این صفحه یادداشتهای انتشار را برای API مدیریت AdSense ارائه میکند.
نسخه 2
این نسخه تغییرات زیر را به منظور حذف عملکرد منسوخ و تراز کردن API مدیریت AdSense با استانداردهای فعلی Google API معرفی می کند. بر اساس طرح نسخهسازی Google API ، این نسخه در طول زمان بهروزرسانی میشود تا شامل عملکردهای اضافی (سازگار با عقب) باشد تا اینکه عملکرد جدیدی در نسخههای جزئی جداگانه منتشر شود.
2025-02-24
مسائل مربوط به سیاست
- یک فیلد
policyTopics[].type
اضافه کرد تا مشخص کند آیا موضوع خطمشی نشاندهنده یک موضوع خطمشی، موضوع نظارتی، یا ترجیح تبلیغکننده است . این جایگزینpolicyTopics[].must_fix
می شود که اکنون به عنوان یک فیلد منسوخ علامت گذاری شده است.
03-04-2024
مسائل مربوط به سیاست
- مجموعه جدیدی برای گزارش تخلفات خطمشی فعلی و هشدارهای موجود برای یک حساب اضافه شد.
19-06-2023
پرداخت ها
- Pays.list اکنون جزئیات پرداختهای ناشران ممتاز را برمیگرداند.
13-06-2023
گزارش ها
- معیارهای
FUNNEL_REQUESTS
،FUNNEL_IMPRESSIONS
،FUNNEL_CLICKS
وFUNNEL_RPM
اضافه شد که اطلاعاتی درباره عملکرد واحدهای غیر تبلیغاتی (به عنوان مثال، واحدهای جستجوی مرتبط) ارائه میکنند.
30-03-2023
گزارش ها
- بعد
PAGE_URL
اضافه شد، که اجازه میدهد معیارها بر اساس URL صفحه تجزیه شوند (با برخی احتیاطها، به تفکیک URL صفحه مراجعه کنید).
2022-09-21
AdUnits
- متدهای ایجاد و وصله اضافه شد. توجه داشته باشید که این روشها را فقط میتوان توسط پروژههایی که برای محصول AdSense for Platforms فعال هستند، استفاده کرد.
کانال های سفارشی
- روش های ایجاد، وصله و به روز رسانی اضافه شد. توجه داشته باشید که این روشها را فقط میتوان توسط پروژههایی که برای محصول AdSense for Platforms فعال هستند، استفاده کرد.
- فیلد فعال را به منبع اضافه کرد.
حساب ها
- متد getAdBlockingRecoveryTag اضافه شد.
2022-08-25
گزارش ها
- بعد
HOSTED_AD_CLIENT_ID
اضافه شد که به ناشران میزبان و پلتفرم اجازه میدهد معیارها را بر اساس حسابهای ناشر خود (ناشر میزبان) و حسابهای فرعی (ناشران پلتفرم) تجزیه و تحلیل کنند.
03-05-2022
AdClient
- روش دریافت اضافه شد.
گزارش ها
- روش getSaved اضافه شد.
کانال های URL
- روش دریافت اضافه شد.
2022-03-31
حساب
- حسابهای غیرفعال اکنون توسط API بازگردانده میشوند، با یک فیلد
state
که وضعیت حساب را نشان میدهد .
AdClient
- مشابه تغییرات حساب در بالا، مشتریان تبلیغات غیرفعال اکنون توسط API بازگردانده می شوند، با یک فیلد
state
که وضعیت مشتری آگهی را نشان می دهد .
2022-02-24
پرداخت
- قالب نام منبع برای پشتیبانی از منابع جداگانه برای درآمدهای YouTube گسترش یافته است. این تغییر قبل از عرضه تدریجی تجربه بهبودیافته AdSense برای سازندگان YouTube است که در آن درآمدهای YouTube به حساب پرداخت خود جدا می شود. هنگامی که یک حساب پرداخت اختصاصی برای درآمد YouTube داشته باشید، اطلاعات پرداخت YouTube نیز از روش لیست پرداخت ها بازگردانده می شود. درآمدهای YouTube دارای قالب نام منبع زیر خواهد بود:
- حسابها/{account}/payments/youtube-unpaid برای درآمدهای پرداخت نشده (جاری) YouTube.
- accounts/{account}/payments/youtube-yyyy-MM-dd برای درآمدهای YouTube پولی.
توجه: نام منابع برای درآمد AdSense بدون تغییر باقی می ماند:- accounts/{account}/payments/unpaid for unpaid (جاری) درآمد AdSense.
- accounts/{account}/payments/yyyy-MM-dd برای درآمدهای پرداختی AdSense.
30-06-2021
گزارش دهید
- ابعاد
AD_FORMAT_NAME
وAD_FORMAT_CODE
اضافه شده است، که نشان دهنده نحوه نمایش یک تبلیغ به کاربران در سایت شما است (در داخل صفحه، وینیت، و غیره). توجه داشته باشید که نسخه 1.4 دارای ابعاد (منسوخ شده) با نام های یکسان اما اعضای مختلف بود. دو بعد اضافه شده در v2 از ابعاد موجود در v1.4 متمایز است.
19-04-2021 (نسخه اولیه)
ژنرال
- همه روش های منسوخ شده در نسخه 1.4 حذف شده اند. این شامل روشهای منبعی است که
accountId
نیازی ندارند. در v2،accountId
در قسمتparent
مشخص شده است. - طبق استانداردهای Google API، منابع اکنون با یک فیلد
name
شناسایی می شوند. برای مثال، نام یک AdClient شبیهaccounts/{accountId}/adclients/{adClientId}
است. علاوه بر این، در نسخه 1.4 از شناسه منبع به عنوان یک بعد گزارش استفاده شد، اما در نسخه 2 این مقدار اکنون از طریق یک فیلدreporting_dimension_id
در چندین منبع در دسترس است. - فیلد
kind
از همه منابع حذف شده است.
حساب
- فیلد
name
بهdisplay_name
تغییر یافته است. - فیلد منطقه
timezone
از رشته بهgoogle.type.TimeZone
تغییر کرده است. - فیلد
creation_time
(نوع int64) بهcreate_time
تغییر کرده است (نوعgoogle.protobuf.Timestamp
). - یک قسمت
pending_tasks
اضافه شد که لیستی از کارهای برجسته است که باید به عنوان بخشی از فرآیند ثبت نام برای یک حساب جدید تکمیل شود. برای مثال، وظایف میتواند به نمایه صورتحساب یا تأیید تلفن شما مرتبط باشد. - قسمت
sub_accounts
حذف شده است. عملکرد مشابهی را می توان در نسخه 2 با روش سفارشیlistChildAccounts
به دست آورد. درخت حساب فرزند کامل را می توان با فراخوانیlistChildAccounts
به صورت بازگشتی در نسخه 2 ایجاد کرد.
AdClient
- فیلد
arc_opt_in
را حذف کرد زیرا قبلاً از رابط کاربری AdSense حذف شده است. - فیلد
supports_reporting
با فیلدreporting_dimension_id
جایگزین میشود که نشاندهنده شناسه منحصربهفرد مشتری آگهی است که در بعد گزارشAD_CLIENT_ID
استفاده میشود. اگرreporting_dimension_id
خالی باشد، AdClient از گزارش پشتیبانی نمیکند.
AdUnit
- فیلد
status
بهstate
تغییر نام داده است. همچنین، وضعیتACTIVE
دیگر نشان نمی دهد که آیا در هفت روز گذشته فعالیتی در این واحد تبلیغاتی صورت گرفته است یا خیر. در v2، به این معنی است که واحد تبلیغات توسط کاربر فعال شده است و می تواند تبلیغات را ارائه دهد. - قسمت
code
حذف شده است. این مقدار همچنان در انتهای فیلدname
(پس از آخرین اسلش رو به جلو) یافت می شود. - قسمت
contentAdsSettings.backupOption
حذف شده است. - فیلد
type
به مقادیرTYPE_UNSPECIFIED
,DISPLAY
,FEED
,ARTICLE
,MATCHED_CONTENT
وLINK
محدود شده است . - سایر قسمتهایی که قبلاً در رابط کاربری AdSense حذف شدهاند نیز حذف میشوند:
custom_style
،saved_style_id
،mobile_content_ads_settings
،feed_ads_settings
.
هشدار
- روش
delete
حذف شده است. - فیلد
is_dismissible
حذف شده است. - فیلد
locale
بهlanguage_code
تغییر نام داده است.
CustomChannel
- قسمت
code
حذف شده است. این مقدار همچنان در انتهای فیلدname
(پس از آخرین اسلش رو به جلو) یافت می شود. - فیلد
targeting_info
حذف شده است زیرا قبلاً از رابط کاربری AdSense حذف شده است.
پرداخت
- فیلد
payment_date
بهdate
تغییر نام داده و از نوع رشته به نوعgoogle.type.Date
تغییر یافته است. - فیلد
payment_amount
و فیلدpayment_amount_currency_code
در یک فیلدpayment
ترکیب شده اند (به عنوان مثال، «1235 ین»، «57/1234 دلار»، «87.65 پوند»).
گزارش دهید
- با نسخه 2، دادههای گزارش API مدیریت AdSense اکنون با رابط کاربری AdSense همسو میشوند. این بدان معناست که ویژگیهای AdMob و YouTube دیگر پشتیبانی نمیشوند. علاوه بر این، API فقط از داده های گزارش مربوط به 3 سال گذشته پشتیبانی می کند.
- منبع
Metadata.dimensions
و منبعMetadata.metrics
حذف شده اند. - روشهای جدیدی برای تولید یک نسخه CSV از گزارش اضافه شده است که جایگزین پارامترهای پرس و جو در نسخه 1.4 شده است. توجه: برای فشردهسازی، همچنان میتوانید از هدر HTTP «Accept-Encoding: gzip» استفاده کنید.
- برخی از فیلدها در تولید گزارش موقت تغییر کرده اند.
- فیلد
account_id
بهaccount
تغییر نام داده است. - فیلد
dimension
بهdimensions
تغییر نام داده است. - فیلد
metric
بهmetrics
تغییر نام داده است. - فیلد
filter
بهfilters
تغییر نام داده است. - فیلد
sort
بهorder_by
تغییر نام داده است. - فیلد
locale
بهlanguage_code
تغییر نام داده است. - فیلد
currency
بهcurrency_code
تغییر نام داده است. - اکنون میتوانید چندین محدوده متداول را با
date_range
مشخص کنید (به عنوان مثال،TODAY
،YESTERDAY
،MONTH_TO_DATE
،YEAR_TO_DATE
،LAST_7_DAYS
وLAST_30_DAYS
)، یا میتوانید با تنظیمdate_range
CUSTOM
start_date
وend_date
تعیین کنید. - فیلدهای
start_date
وend_date
از نوع string به نوعgoogle.type.Date
تغییر یافته است. توجه: در نتیجه، کلمات کلیدی تاریخ نسبی (به عنوان مثال، "today-6d") دیگر پشتیبانی نمی شوند. - فیلد بولی
use_timezone_reporting
باreporting_time_zone
جایگزین شده است که می تواند یکی از دو مقدار را داشته باشد:ACCOUNT_TIME_ZONE
یاGOOGLE_TIME_ZONE
(به معنی PST/PDT). پیشفرض در نسخه 2ACCOUNT_TIME_ZONE
است که با پیشفرض نسخه 1.4 متفاوت است. - قسمت
start_index
حذف شده است. - قسمت
max_results
بهlimit
تغییر نام داده است.
- فیلد
- برخی از فیلدها در تولید گزارش ذخیره شده تغییر کرده اند.
- فیلدهای تاریخ اضافه شد (
date_range
،start_date
،end_date
،reporting_time_zone
). - یک قسمت
currency_code
اضافه شد. - فیلد
locale
بهlanguage_code
تغییر نام داده است. - قسمت
start_index
حذف شده است. - قسمت
max_results
حذف شده است.
- فیلدهای تاریخ اضافه شد (
SavedAdStyle
-
SavedAdStyle
حذف شده است زیرا قبلاً از رابط کاربری AdSense حذف شده است.
سایت
-
Sites
برای واکشی دادههای مربوط به وبسایتهایی که به حساب AdSense خود اضافه کردهاید، اضافه شدهاند. - فیلد
state
نشان میدهد که آیا سایت یکی از حالتهای زیر است:REQUIRES_REVIEW
،GETTING_READY
،READY
،NEEDS_ATTENTION
. - فیلد
auto_ads_enabled
یک بولین است که نشان می دهد آیا تبلیغات خودکار در یک سایت خاص فعال شده اند یا خیر.
نسخه 1.4
این نسخه عملکرد زیر را معرفی می کند:
- اکنون میتوانید پرداختهای حساب AdSense خود را به ارز مربوطه فهرست کنید.
- اکنون می توانید با فراخوانی روش
delete
که هشدار را در رابط وب API و AdSense پنهان می کند، هشدار را رد کنید. - پاسخ گزارش اکنون شامل تاریخ شروع و پایان است. اگر از تاریخهای نسبی هنگام تولید گزارشها استفاده میکنید (مانند
today
،yesterday
،firstDayOfMonth-1m
)، این پاسخ اکنون شامل محدوده تاریخی است که درخواست کردهاید.
مسائل شناخته شده
فیلد currency
در گزارشها در این نسخه پشتیبانی نمیشود.
نسخه 1.3
این نسخه عملکرد زیر را معرفی می کند:
- امکان بازیابی هشدارها.
- توانایی بازیابی متادیتاهای متریک و ابعاد.
- امکان اجرای گزارش ها در منطقه زمانی محلی حساب.
مسائل شناخته شده
فیلد currency
در گزارشها در این نسخه پشتیبانی نمیشود.
نسخه 1.2
این نسخه عملکرد زیر را معرفی می کند:
- امکان بازیابی سبک های تبلیغاتی.
- امکان بازیابی و اجرای گزارش های ذخیره شده تعریف شده در فرانت اند.
مسائل شناخته شده
فیلد currency
در گزارشها در این نسخه پشتیبانی نمیشود.
نسخه 1.1
این نسخه عملکرد زیر را معرفی می کند:
- امکان فهرست کردن حساب هایی که کاربر به آنها دسترسی دارد
- امکان انجام تماس GET در یک حساب خاص
- امکان انجام تماس های GET در واحدهای تبلیغاتی و کانال های سفارشی
- امکان تعیین ارتباط بین واحدهای تبلیغاتی و کانال های سفارشی
- کانالهای سفارشی حاوی دادههای بیشتری درباره اطلاعات هدفگیری هستند
علاوه بر این، اکنون می توانید به داده ها یا در حساب پیش فرض خود یا در یک حساب خاص دسترسی داشته باشید.
مسائل شناخته شده
فیلد currency
در گزارشها در این نسخه پشتیبانی نمیشود.
نسخه 1
این اولین نسخه از API است. این شامل پشتیبانی برای بازیابی کلاینت های تبلیغاتی، واحدهای تبلیغاتی، کانال های سفارشی، کانال های url و همچنین اجرای گزارش ها می باشد.
مسائل شناخته شده
فیلد currency
در گزارشها در این نسخه پشتیبانی نمیشود.