REST Resource: sellers.adUnits

משאב: יחידת מודעות

יחידת מודעות יחידה.

ייצוג JSON 
{
  "name": string,
  "externalId": string,
  "displayName": string,
  "description": string,
  "labels": {
    string: string,
    ...
  },
  "attributes": [
    enum (AdUnitAttribute)
  ],
  "creatives": [
    {
      object (CreativeSpecification)
    }
  ],
  "createTime": string,
  "updateTime": string,
  "state": enum (AdUnitState),
  "rejectedReason": string,
  "location": {
    object (LatLng)
  },
  "directionSet": boolean,
  "direction": integer,
  "elevationMetersSet": boolean,
  "elevationMeters": number,
  "physicalWidthMetersSet": boolean,
  "physicalWidthMeters": number,
  "physicalHeightMetersSet": boolean,
  "physicalHeightMeters": number,
  "venue": enum (OutOfHomeVenue),
  "fixedLocation": boolean,
  "indoors": boolean,
  "photoUris": [
    string
  ],
  "products": [
    string
  ]
}
שדות
name

string

שם המשאב של יחידת המודעות בפורמט: sellers/{seller}/adUnits/{adUnit}. לדוגמה sellers/seller321/adUnits/adUnit123.
externalId

string

המזהה המנוהל על ידי בית העסק כנראה במערכת שלו. אם לא יוגדר שינוי, הוא לא ישתנה.
displayName

string

חובה. השם המוצג של יחידת המודעות.

חייב להיות בקידוד UTF-8 ובגודל מקסימלי של 240 בייטים.
description

string

שדה נוסף בפורמט חופשי לתיאור יחידת המודעות.
labels

map (key: string, value: string)

קבוצת התוויות בפריסה גמישה לתיאור יחידת המודעות הזו.

אובייקט שמכיל רשימה של "key": value זוגות. לדוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
attributes[]

enum (AdUnitAttribute)

מאפיינים שמגדירים את יחידת המודעות הזו בצורה מפורטת יותר.
creatives[]

object (CreativeSpecification)

רשימת קריאייטיבים מותרים שניתן להציג עבור יחידת מודעות זו. אפשר להגדיר את זה גם ברמת המוצר.
createTime

string (Timestamp format)

פלט בלבד. חותמת הזמן של יצירת יחידת המודעות.

חותמת זמן ב-RFC3339 UTC 'Zulu' בפורמט של רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

פלט בלבד. חותמת הזמן של העדכון האחרון של יחידת המודעות.

חותמת זמן ב-RFC3339 UTC 'Zulu' בפורמט של רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".
state

enum (AdUnitState)

פלט בלבד. המצב של יחידת המודעות. אם AD_UNIT_STATE_REJECTED הסיבה שנדחתה תכלול את הסיבה.
rejectedReason

string

פלט בלבד. אם approval_status הוא AD_UNIT_APPROVAL_STATUS_REJECTED, השדה הזה יכיל את הסיבה.
location

object (LatLng)

חובה. בלתי ניתן לשינוי. קו הרוחב וקו האורך של יחידת המודעות בפורמט מעלות חתומות.
directionSet

boolean

אם True, שדה הכיוון יכיל את ערך הכיוון. אם False, הכיוון צריך להיות אפס.
direction

integer

בלתי ניתן לשינוי. הכיוון הקרדינלי במעלות כאשר הצפון מייצג 0. [0-360).
elevationMetersSet

boolean

אם True, שדה הגובה יכלול את הגובה במטרים. אם False, הגובה צריך להיות אפס.
elevationMeters

number

בלתי ניתן לשינוי. המרחק בין החלק התחתון של יחידת המודעות לקרקע במטרים.
physicalWidthMetersSet

boolean

אם הערך הוא True, השדה פיזי רוחב מטרים יכלול את הרוחב הפיזי במטרים. אם הערך הוא False, הערך של הפרמטר, , , , תבוטל, צריך להיות 0.
physicalWidthMeters

number

בלתי ניתן לשינוי. הרוחב הפיזי של יחידת המודעות במטרים.
physicalHeightMetersSet

boolean

אם הערך הוא True, השדה פיזי גובה-מטרים יכלול את הגובה הפיזי במטרים. אם הערך הוא False, הערך של המצב הפיזיקלי במד צריך להיות אפס.
physicalHeightMeters

number

בלתי ניתן לשינוי. הגובה הפיזי של יחידת המודעות במטרים.
venue

enum (OutOfHomeVenue)

סוג האירוע 'מחוץ לבית' בהתאם לתקני ה-DPAA. זהו שדה מידע שמוצג למפרסמים, ואפשר להשתמש בו גם לסינון יחידות של מודעות.
fixedLocation

boolean

האם המודעה נמצאת במיקום הקבוע (לוח מודעות) או בתנועה (מונית).
indoors

boolean

חובה. האם יחידת המודעות נמצאת בתוך מבנה.
photoUris[]

string

מזהי ה-URI של תמונות של יחידת המודעות.
products[]

string

חובה. שמות המשאבים של מוצרים שמשויכים ליחידת המודעות הזו בפורמט: sellers/{seller}/products/{product}. לדוגמה sellers/seller111/products/product123.

AdUnitAttribute

מאפיינים אפשריים שמשמשים להגדרה מדויקת יותר של יחידת המודעות.

טיפוסים בני מנייה (enum)
AD_UNIT_ATTRIBUTE_UNSPECIFIED ערך ברירת המחדל כשהמאפיין של יחידת המודעות לא מצוין או שאינו ידוע בגרסה הזו.
AD_UNIT_ATTRIBUTE_ILLUMINATED האם יחידת המודעות גלויה בחושך אם היא בעולם הפיזי?
AD_UNIT_ATTRIBUTE_DIGITAL יחידת מודעות דיגיטלית, אם היא לא נכללת בגרסה הקלאסית, היא משתמעת.
AD_UNIT_ATTRIBUTE_PHYSICAL יחידת המודעות קיימת כאובייקט בעולם הפיזי.

AdUnitState

המצב של יחידת המודעות מנקודת המבט של המוכר.

טיפוסים בני מנייה (enum)
AD_UNIT_STATE_UNSPECIFIED ערך ברירת המחדל כשהמצב של יחידת המודעות לא צוין או שאינו ידוע בגרסה הזו.
AD_UNIT_STATE_PENDING יחידת המודעות ממתינה לאישור.
AD_UNIT_STATE_APPROVED יחידת המודעות אושרה.
AD_UNIT_STATE_REJECTED יחידת המודעות נדחתה.
AD_UNIT_STATE_DELETED יחידת המודעות נמחקה.

OutOfHomeVenue

רשימה של מקומות מחוץ לבית

טיפוסים בני מנייה (enum)
OOH_VENUE_UNSPECIFIED ערך ברירת המחדל כשהמקום OOH לא צוין או לא ידוע בגרסה הזו.
OOH_VENUE_AIRBORNE מקום מחוץ לבית שמסווג כאוויר.
OOH_VENUE_AIRPORTS_GENERAL מקום מחוץ לבית שמסווג כנמלי תעופה כלליים.
OOH_VENUE_AIRPORTS_BAGGAGE_CLAIM מקום מחוץ לבית שמסווג כאיסוף כבודה בנמלי תעופה.
OOH_VENUE_AIRPORTS_TERMINAL מקום מחוץ לבית שמסווג כטרמינל בנמלי תעופה.
OOH_VENUE_AIRPORTS_LOUNGES מקום מחוץ לבית שמסווג כטרקלינים בשדה התעופה.
OOH_VENUE_ATMS מקום מחוץ לבית שמסווג ככספומטים.
OOH_VENUE_BACKLIGHTS מקום מחוץ לבית שמסווג כתאורה אחורית.
OOH_VENUE_BARS מקום מחוץ לבית שמסווג כברים.
OOH_VENUE_BENCHES מקום מחוץ לבית שמסווג לספסלים.
OOH_VENUE_BIKE_RACKS מקום מחוץ לבית שמסווג כמתקן להשכרת אופניים.
OOH_VENUE_BULLETINS מקום מחוץ לבית שמסווג כמבזקים.
OOH_VENUE_BUSES מקום מחוץ לבית שמסווג כאוטובוסים.
OOH_VENUE_CAFES מקום מחוץ לבית שמסווג כבתי קפה.
OOH_VENUE_CASUAL_DINING_RESTAURANTS מסעדה מחוץ לבית שמסווגת כמסעדות נינוחות.
OOH_VENUE_CHILD_CARE מקום מחוץ לבית שמסווג כמעונות יום לילדים.
OOH_VENUE_CINEMA מקום מחוץ לבית שמסווג כקולנוע.
OOH_VENUE_CITY_INFORMATION_PANELS מקום מחוץ לבית שמסווג כחלוניות מידע עירוניות.
OOH_VENUE_CONVENIENCE_STORES מקום מחוץ לבית שמסווג כחנויות נוחות.
OOH_VENUE_DEDICATED_WILD_POSTING מקום מחוץ לבית שמסווג כפרסום בר השגה.
OOH_VENUE_DOCTORS_OFFICES_GENERAL מקום מחוץ לבית שמסווג כמשרדי רופאים כלליים.
OOH_VENUE_DOCTORS_OFFICES_OBSTETRICS מקום מחוץ לבית, מסווג כדואר שנשלח לרופאים.
OOH_VENUE_DOCTORS_OFFICES_PEDIATRICS מקום מחוץ לבית שמסווג כרופאי ילדים במשרדי רופאים.
OOH_VENUE_FAMILY_ENTERTAINMENT מקום מחוץ לבית שמסווג כבידור לכל המשפחה.
OOH_VENUE_FERRIES מקום מחוץ לבית שמסווג כמעבורות.
OOH_VENUE_FINANCIAL_SERVICES מקום מחוץ לבית שמסווג כשירותים פיננסיים.
OOH_VENUE_GAS_STATIONS מקום מחוץ לבית שמסווג כתחנות דלק.
OOH_VENUE_GOLF_COURSES מתחם מחוץ לבית שמסווג כמגרשי גולף.
OOH_VENUE_GYMS מקום מחוץ לבית שמסווג כמכוני כושר.
OOH_VENUE_HOSPITALS מקום מחוץ לבית המסווג כבתי חולים.
OOH_VENUE_HOTELS מקום מחוץ לבית שמסווג כמלונות.
OOH_VENUE_JUNIOR_POSTERS מקום מחוץ לבית שמסווג כפוסטרים לילדים.
OOH_VENUE_KIOSKS מקום מחוץ לבית מסווג כקיוסק.
OOH_VENUE_MALLS_GENERAL מקום שמסווג כמרכזי קניות מחוץ לבית.
OOH_VENUE_MALLS_FOOD_COURTS מקום מחוץ לבית שמסווג כמתחמי אוכל בקניון.
OOH_VENUE_MARINE אתר מחוץ לבית שמסווג בקטגוריה 'ימית'.
OOH_VENUE_MOBILE_BILLBOARDS מקום מחוץ לבית שמסווג כשלטי חוצות ניידים.
OOH_VENUE_MOVIE_THEATER_LOBBIES אולם מחוץ לבית שמסווג כלובי של בית קולנוע.
OOH_VENUE_NEWSSTANDS מקום מחוץ לבית שמסווג כדוכן עיתונים.
OOH_VENUE_OFFICE_BUILDINGS מקום מחוץ לבית שמסווג כבנייני משרדים.
OOH_VENUE_PHONE_KIOSKS מקום אחסון מחוץ לבית, שמסווג כקיוסק לטלפון.
OOH_VENUE_POSTERS מקום מחוץ לבית שמסווג כפוסטרים.
OOH_VENUE_QSR מקום מחוץ לבית מסווג כ-Qsr.
OOH_VENUE_RAIL מקום מחוץ לבית שמסווג כרכבת.
OOH_VENUE_RECEPTACLES מקום מחוץ לבית שמסווג כתיבות איסוף.
OOH_VENUE_RESORTS מקום מחוץ לבית שמסווג כאתר נופש.
OOH_VENUE_RETAIL מקום מחוץ לבית שמסווג כקמעונאי.
OOH_VENUE_SALONS מקום מחוץ לבית שמסווג כמכוני יופי.
OOH_VENUE_SHELTERS מקום מחוץ לבית שמסווג כמקלטים.
OOH_VENUE_SPORTS_ARENAS מקום מחוץ לבית שמסווג כמגרשי ספורט.
OOH_VENUE_SUBWAY מקום מחוץ לבית שמסווג כרכבת תחתית.
OOH_VENUE_TAXIS מקום מחוץ לבית שמסווג כמוניות.
OOH_VENUE_TRUCKSIDE מקום מחוץ לבית שמסווג כמשאית.
OOH_VENUE_UNIVERSITIES מקום מחוץ לבית שמסווג כאוניברסיטאות.
OOH_VENUE_URBAN_PANELS מקום מחוץ לבית שמסווג כלוחות עירוניים.
OOH_VENUE_VETERINARIAN_OFFICES מקום מחוץ לבית שמסווג כמשרדי וטרינרים.
OOH_VENUE_WALLS מקום מחוץ לבית שמסווג כקיר.
OOH_VENUE_OTHER מקום מחוץ לבית שמסווג בקטגוריה אחרת.

שיטות

create

 יוצר יחידת מודעות חדשה.

delete

 מחיקת יחידת מודעות קיימת.

get

 מאחזרת יחידת מודעות בודדת.

list

 בתיבת הדו-שיח הזו.

patch

 עדכון של יחידת מודעות קיימת.