בדף הזה מפורטות הערות המוצר של AdSense Management API.
גרסה 2
בגרסה הזו הוכנסו השינויים הבאים כדי להסיר פונקציונליות שהוצאה משימוש וליישר קו בין AdSense Management API לבין הסטנדרטים הנוכחיים של Google API. בהתאם לסכימה של Google API לגרסאות, הגרסה הזו תתעדכן עם הזמן כדי לכלול פונקציונליות נוספת (שתהיה תואמת לאחור) במקום שתופקו תכונות חדשות בגרסאות משניות נפרדות.
2025-02-24
PolicyIssues
- הוספנו את השדה
policyTopics[].type
כדי לזהות אם נושא מדיניות מייצג בעיה שקשורה למדיניות, בעיה רגולטורית או העדפת מפרסם. השדה הזה מחליף את השדהpolicyTopics[].must_fix
, שמסומן עכשיו כשדה שהוצא משימוש.
2024-04-03
PolicyIssues
- הוספנו קולקציה חדשה לדיווח על ההתראות וההפרות הקיימות של המדיניות בחשבון.
2023-06-19
תשלומים
- הפונקציה payments.list מחזירה עכשיו פרטים על תשלומים לבעלי תוכן דיגיטלי בתוכנית Premium.
2023-06-13
דוחות
- נוספו המדדים
FUNNEL_REQUESTS
,FUNNEL_IMPRESSIONS
,FUNNEL_CLICKS
ו-FUNNEL_RPM
, שמספקים מידע על הביצועים של יחידות שאינן מודעות (לדוגמה, יחידות חיפוש קשורות).
2023-03-30
דוחות
- הוספנו את המאפיין
PAGE_URL
, שמאפשר לפלח מדדים לפי כתובת URL של דף (עם כמה תנאים, ראו פירוט לפי כתובת URL של דף).
2022-09-21
AdUnits
- נוספו שיטות create ו-patch. חשוב לדעת שאפשר להשתמש בשיטות האלה רק בפרויקטים שהופעלה בהם התמיכה במוצר AdSense לפלטפורמות.
CustomChannels
- נוספו שיטות ליצירה, לתיקון ולעדכון. חשוב לדעת שאפשר להשתמש בשיטות האלה רק בפרויקטים שהופעלה בהם התמיכה במוצר AdSense לפלטפורמות.
- הוספת השדה active למשאב.
חשבונות
- נוספה השיטה getAdBlockingRecoveryTag.
2022-08-25
דוחות
- הוספנו את המאפיין
HOSTED_AD_CLIENT_ID
, שמאפשר לבעלי תוכן דיגיטלי שמארחים תוכן ולבעלי פלטפורמות לפלח את המדדים לפי החשבונות של בעלי התוכן הדיגיטלי (בעלי תוכן דיגיטלי שמארחים תוכן) ולפי חשבונות משנה (בעלי פלטפורמות).
2022-05-03
AdClient
- נוספה שיטת get.
דוחות
- נוספה השיטה getSaved.
UrlChannels
- נוספה שיטת get.
2022-03-31
חשבון
- ה-API מחזיר עכשיו חשבונות לא פעילים, עם השדה
state
שמציין את סטטוס החשבון.
AdClient
- בדומה לשינויים בחשבון שצוינו למעלה, ה-API מחזיר עכשיו לקוחות מודעות לא פעילים, עם השדה
state
שמציין את המצב של לקוח המודעות.
2022-02-24
תשלום
-
הפורמט של שם המשאב הורחב כדי לתמוך במשאבים נפרדים להכנסות מ-YouTube. השינוי הזה מתבצע לפני ההשקה המדורגת של חוויית המשתמש המשופרת של AdSense ליוצרים ב-YouTube, שבמסגרתה הרווחים מ-YouTube יופרדו לחשבון תשלומים נפרד. פרטי התשלומים מ-YouTube יחזרו גם מהשיטה של רשימת התשלומים, אחרי שיהיה לכם חשבון תשלומים ייעודי לרווחים מ-YouTube.
הפורמט של שם המשאב של הרווחים מ-YouTube הוא:
- accounts/{account}/payments/youtube-unpaid לרווחים (עכשוויים) מ-YouTube שטרם שולמו.
- accounts/{account}/payments/youtube-yyyy-MM-dd לרווחים בתשלום מ-YouTube.
הערה: שמות המשאבים של הרווחים מ-AdSense לא השתנו:- accounts/{account}/payments/unpaid לרווחים (נוכחיים) שלא שולמו ב-AdSense.
- accounts/{account}/payments/yyyy-MM-dd לרווחים מ-AdSense ששולמו.
2021-06-30
דיווח
- נוספו המאפיינים
AD_FORMAT_NAME
ו-AD_FORMAT_CODE
, שמציינים את האופן שבו מודעה מסוימת מוצגת למשתמשים באתר (בדף, מודעת ביניים וכו'). לתשומת ליבכם, בגרסה 1.4 היו מאפיינים (בגרסה הקודמת) עם אותם שמות אבל עם חברים שונים. שני המאפיינים שנוספו בגרסה 2 שונים מהמאפיינים שהיו בגרסה 1.4.
19 באפריל 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
. אפשר ליצור את העץ המלא של חשבונות הצאצאים בגרסה 2 על ידי קריאה רפרסיבית ל-listChildAccounts
.
AdClient
- הוסר השדה
arc_opt_in
כי הוא כבר הוסר מממשק המשתמש של AdSense. - השדה
supports_reporting
מוחלף בשדהreporting_dimension_id
, שמייצג את המזהה הייחודי של לקוח המודעות כפי שהוא מופיע במאפיין הדיווחAD_CLIENT_ID
. אם השדהreporting_dimension_id
ריק, המשמעות היא שהלקוח לא תומך בדיווח.
AdUnit
- השם של השדה
status
השתנה ל-state
. בנוסף, המצבACTIVE
לא מציין יותר אם הייתה פעילות ביחידת המודעות הזו ב-7 הימים האחרונים. בגרסה 2, המשמעות היא שהמשתמש הפעיל את יחידת המודעות והיא יכולה להציג מודעות. - השדה
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
וסוגו השתנה מ-string ל-google.type.Date
. - השדה
payment_amount
והשדהpayment_amount_currency_code
אוחדו לשדהpayment
אחד (למשל, '¥1,235 JPY', '$1,234.57', '£87.65').
דיווח
- בגרסה 2, נתוני הדיווח של AdSense Management API תואמים עכשיו לממשק המשתמש של 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
), או שאפשר לצייןstart_date
ו-end_date
על ידי הגדרתdate_range
כ-CUSTOM
. - השדות
start_date
ו-end_date
השתנו מסוג מחרוזת לסוגgoogle.type.Date
. הערה: כתוצאה מכך, מילות מפתח עם תאריך יחסי (למשל, "today-6d") כבר לא נתמכים. - השדה הבוליאני
use_timezone_reporting
הוחלף בשדהreporting_time_zone
, שיכול לקבל אחד משני ערכים:ACCOUNT_TIME_ZONE
אוGOOGLE_TIME_ZONE
(כלומר PST/PDT). ערך ברירת המחדל בגרסה 2 הואACCOUNT_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 במטבע המתאים.
- עכשיו אפשר לבטל התראה על ידי קריאה ל-method
delete
, שתעלים את ההתראה ב-API ובממשק האינטרנט של AdSense. - התשובה לדוח כוללת עכשיו תאריכי התחלה וסיום. חשוב לדעת: אם משתמשים בתאריכים יחסיים בזמן יצירת הדוחות (כמו
today
, yesterday
, firstDayOfMonth-1m
), התגובה תכלול עכשיו את טווח התאריכים שביקשת.
בעיות מוכרות
השדה currency
בדוחות לא נתמך בגרסה הזו.
גרסה 1.3
בגרסה הזו נוספו הפונקציונליות הבאה:
- היכולת לאחזר התראות.
- היכולת לאחזר מטא-נתונים של מדדים ומאפיינים.
- היכולת להריץ דוחות לפי אזור הזמן המקומי של החשבון.
בעיות מוכרות
השדה currency
בדוחות לא נתמך בגרסה הזו.
גרסה 1.2
בגרסה הזו נוספו הפונקציונליות הבאה:
- היכולת לאחזר סגנונות של מודעות.
- היכולת לאחזר ולהריץ את הדוחות השמורים שהוגדרו בחזית.
בעיות מוכרות
השדה currency
בדוחות לא נתמך בגרסה הזו.
גרסה 1.1
בגרסה הזו נוספו הפונקציונליות הבאה:
- היכולת לציין את רשימת החשבונות שלגביהם למשתמש יש גישה
- היכולת לבצע קריאת GET בחשבון ספציפי
- היכולת לבצע קריאות GET ביחידות של מודעות ובערוצים מותאמים אישית
- היכולת לקבוע את החיבורים בין יחידות המודעות לערוצים מותאמים אישית
- ערוצים מותאמים אישית מכילים נתונים נוספים על פרטי הטירגוט
בנוסף, מעכשיו אפשר לגשת לנתונים דרך חשבון ברירת המחדל או דרך חשבון ספציפי.
בעיות מוכרות
השדה currency
בדוחות לא נתמך בגרסה הזו.
גרסה 1
זוהי הגרסה הראשונה של ה-API. היא כוללת תמיכה באחזור של לקוחות מודעות, יחידות של מודעות, ערוצים מותאמים אישית, ערוצים של כתובות אתרים וגם בהרצת דוחות.
בעיות מוכרות
השדה currency
בדוחות לא נתמך בגרסה הזו.