REST Resource: inventorySources

משאב: InventorySource

מקור מלאי.

ייצוג ב-JSON 
{
  "name": string,
  "inventorySourceId": string,
  "displayName": string,
  "inventorySourceType": enum (InventorySourceType),
  "inventorySourceProductType": enum (InventorySourceProductType),
  "commitment": enum (InventorySourceCommitment),
  "deliveryMethod": enum (InventorySourceDeliveryMethod),
  "dealId": string,
  "status": {
    object (InventorySourceStatus)
  },
  "exchange": enum (Exchange),
  "updateTime": string,
  "rateDetails": {
    object (RateDetails)
  },
  "publisherName": string,
  "timeRange": {
    object (TimeRange)
  },
  "creativeConfigs": [
    {
      object (CreativeConfig)
    }
  ],
  "guaranteedOrderId": string,
  "readWriteAccessors": {
    object (InventorySourceAccessors)
  },
  "readAdvertiserIds": [
    string
  ],
  "readPartnerIds": [
    string
  ]
}
שדות
name

string

פלט בלבד. שם המשאב של מקור המלאי.
inventorySourceId

string (int64 format)

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

string

השם המוצג של מקור מלאי שטחי הפרסום.

הקידוד חייב להיות UTF-8, והגודל המקסימלי הוא 240 בייטים.
inventorySourceType

enum (InventorySourceType)

מציין את הסוג של מקור המלאי.
inventorySourceProductType

enum (InventorySourceProductType)

פלט בלבד. סוג המוצר של מקור המלאי, שמציין את הדרך שבה המלאי נמכר.
commitment

enum (InventorySourceCommitment)

האם מקור המלאי כולל משלוח מובטח או לא מובטח.
deliveryMethod

enum (InventorySourceDeliveryMethod)

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

  • במקורות מלאי שטחים פרסומיים לא מובטחים, הערך הקביל היחיד הוא INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC.
  • במקורות מלאי מובטח, הערכים הקבילים הם INVENTORY_SOURCE_DELIVERY_METHOD_TAG ו-INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC.
dealId

string

המזהה במרחב הבורסה שמזהה באופן ייחודי את מקור מלאי שטחי הפרסום.

המזהה צריך להיות ייחודי בקרב הקונים בכל בורסת פרסום, אבל לא בהכרח ייחודי בין בורסות פרסום שונות.
status

object (InventorySourceStatus)

הגדרות הסטטוס של מקור המלאי.
exchange

enum (Exchange)

הבורסה שאליה שייך מקור מלאי שטחי הפרסום.
updateTime

string (Timestamp format)

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

הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה בפורמט Z עם 0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".
rateDetails

object (RateDetails)

חובה. פרטי התמחור של מקור מלאי שטחי הפרסום.
publisherName

string

השם של בעל התוכן הדיגיטלי או המוכר של מקור מלאי שטחי הפרסום.
timeRange

object (TimeRange)

טווח הזמן שבו מקור מלאי שטחי הפרסום הזה מתחיל להציג מודעות ומפסיק להציג מודעות.
creativeConfigs[]

object (CreativeConfig)

הדרישות לגבי קריאייטיב של מקור המלאי.

לא רלוונטי לחבילות של ערוצים שמשתתפים במכרזים.
guaranteedOrderId

string

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

ההגדרה רלוונטית רק אם הערך של commitment הוא INVENTORY_SOURCE_COMMITMENT_GUARANTEED.
readWriteAccessors

object (InventorySourceAccessors)

השותף או המפרסמים שיש להם גישת קריאה/כתיבה למקור מלאי שטחי הפרסום.

הפלט יופיע רק אם commitment הוא INVENTORY_SOURCE_COMMITMENT_GUARANTEED, ובמקרה כזה, הרשאות הגישה לקריאה ולכתיבה עוברות בירושה מהסדר המובטח של הרכיב העליון.

חובה אם הערך של commitment הוא INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED.

אם הערך של commitment הוא INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED ושותף מוגדר בשדה הזה, לכל המפרסמים שמשתמשים בשותף הזה תהיה באופן אוטומטי הרשאת קריאה בלבד למקור מלאי שטחי הפרסום. המפרסמים האלה לא ייכללו בreadAdvertiserIds.
readAdvertiserIds[]

string (int64 format)

פלט בלבד. המזהים של המפרסמים שיש להם הרשאת קריאה בלבד למקור מלאי שטחי הפרסום.
readPartnerIds[]

string (int64 format)

פלט בלבד. המזהים של שותפים עם גישת קריאה בלבד למקור המלאי.

כל המפרסמים של השותפים בשדה הזה יורשים הרשאת קריאה בלבד למקור מלאי שטחי הפרסום.

InventorySourceType

סוגים אפשריים של מקורות מלאי שטחי פרסום.

טיפוסים בני מנייה (enum)
INVENTORY_SOURCE_TYPE_UNSPECIFIED סוג מקור המלאי לא צוין או לא ידוע בגרסה הזו.
INVENTORY_SOURCE_TYPE_PRIVATE מקור מלאי פרטי.
INVENTORY_SOURCE_TYPE_AUCTION_PACKAGE חבילה למכירה פומבית.

InventorySourceProductType

סוגי המוצרים האפשריים במקור מלאי.

טיפוסים בני מנייה (enum)
INVENTORY_SOURCE_PRODUCT_TYPE_UNSPECIFIED סוג המוצר לא צוין או לא ידוע בגרסה הזו. שינוי מקורות מלאי של סוג המוצר הזה לא אפשרי באמצעות API.
PREFERRED_DEAL מקור מלאי שטחי הפרסום מוכר מלאי באמצעות דיל מועדף.
PRIVATE_AUCTION מקור מלאי שטחי הפרסום מוכר מלאי שטחי פרסום באמצעות מכרז פרטי.
PROGRAMMATIC_GUARANTEED מקור מלאי שטחי הפרסום מוכר מלאי שטחי פרסום באמצעות קמפיינים פרוגרמטיים מובטחים.
TAG_GUARANTEED מקור המלאי מוכר מלאי באמצעות Tag Guaranteed.
YOUTUBE_RESERVE מקור מלאי שטחי הפרסום מוכר מלאי שטחי פרסום דרך YouTube Reserve.
INSTANT_RESERVE מקור המלאי מוכר מלאי באמצעות הזמנה מיידית. שינוי מקורות מלאי של סוג המוצר הזה לא אפשרי באמצעות API.
GUARANTEED_PACKAGE מקור מלאי שטחי הפרסום מוכר מלאי באמצעות חבילה מובטחת. שינוי מקורות מלאי של סוג המוצר הזה לא אפשרי באמצעות API.
PROGRAMMATIC_TV מקור מלאי שטחי הפרסום מוכר מלאי שטחי פרסום דרך קנייה פרוגרמטית בטלוויזיה. שינוי מקורות מלאי של סוג המוצר הזה לא אפשרי באמצעות API.
AUCTION_PACKAGE מקור מלאי שטחי הפרסום מוכר מלאי באמצעות חבילה למכירה פומבית. שינוי מקורות מלאי של סוג המוצר הזה לא אפשרי באמצעות API.

InventorySourceCommitment

סוגי ההתחייבויות האפשריים למקור מלאי שטחי פרסום.

טיפוסים בני מנייה (enum)
INVENTORY_SOURCE_COMMITMENT_UNSPECIFIED ההתחייבות לא צוינה או לא ידועה בגרסה הזו.
INVENTORY_SOURCE_COMMITMENT_GUARANTEED ההתחייבות היא מסירה מובטחת.
INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED ההתחייבות היא למשלוח לא מובטח.

InventorySourceDeliveryMethod

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

טיפוסים בני מנייה (enum)
INVENTORY_SOURCE_DELIVERY_METHOD_UNSPECIFIED שיטת המסירה לא צוינה או לא ידועה בגרסה הזו.
INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC שיטת הצגת המודעות היא פרוגרמטית.
INVENTORY_SOURCE_DELIVERY_METHOD_TAG שיטת הצגת המודעות היא תג.

InventorySourceStatus

ההגדרות שקשורות לסטטוס של מקור המלאי.

ייצוג ב-JSON 
{
  "entityStatus": enum (EntityStatus),
  "entityPauseReason": string,
  "sellerStatus": enum (EntityStatus),
  "sellerPauseReason": string,
  "configStatus": enum (InventorySourceConfigStatus)
}
שדות
entityStatus

enum (EntityStatus)

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

הערכים הקבילים הם ENTITY_STATUS_ACTIVE,‏ ENTITY_STATUS_ARCHIVED ו-ENTITY_STATUS_PAUSED. ערך ברירת המחדל הוא ENTITY_STATUS_ACTIVE.
entityPauseReason

string

הסיבה שהמשתמש סיפק להשהיית מקור המלאי הזה.

השם יכול להכיל עד 100 תווים.

ההגדרה הזו רלוונטית רק כש-entityStatus מוגדרת ל-ENTITY_STATUS_PAUSED.
sellerStatus

enum (EntityStatus)

פלט בלבד. הסטטוס שהמוכר הגדיר למקור המלאי.

רלוונטי רק למקורות מלאי שמסונכרנים ישירות מבעלי האתרים. הערכים הקבילים הם ENTITY_STATUS_ACTIVE ו-ENTITY_STATUS_PAUSED.
sellerPauseReason

string

פלט בלבד. הסיבה שהמוכר סיפק להשהיית המקור הזה של מלאי שטחי הפרסום.

האפשרות הזו רלוונטית רק למקורות מלאי שמסונכרנים ישירות מהבעלים של האתרים, וכשהערך של sellerStatus מוגדר כ-ENTITY_STATUS_PAUSED.
configStatus

enum (InventorySourceConfigStatus)

פלט בלבד. סטטוס ההגדרה של מקור המלאי.

רלוונטי רק למקורות מלאי שטחי פרסום מובטחים. הערכים הקבילים הם INVENTORY_SOURCE_CONFIG_STATUS_PENDING ו-INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED.

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

InventorySourceConfigStatus

מצבי ההגדרה האפשריים של מקור מלאי מובטח.

טיפוסים בני מנייה (enum)
INVENTORY_SOURCE_CONFIG_STATUS_UNSPECIFIED סטטוס האישור לא צוין או לא ידוע בגרסה הזו.
INVENTORY_SOURCE_CONFIG_STATUS_PENDING מצב ההתחלה של מקור מלאי מובטח. צריך להגדיר את מקור מלאי שטחי הפרסום במצב הזה.
INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED הסטטוס אחרי שהקונה מגדיר מקור מלאי שטחים פרסומיים מובטח.

RateDetails

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

ייצוג ב-JSON 
{
  "inventorySourceRateType": enum (InventorySourceRateType),
  "rate": {
    object (Money)
  },
  "unitsPurchased": string,
  "minimumSpend": {
    object (Money)
  }
}
שדות
inventorySourceRateType

enum (InventorySourceRateType)

סוג התעריף.

הערכים הקבילים הם INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED,‏ INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR ו-INVENTORY_SOURCE_RATE_TYPE_CPD.
rate

object (Money)

התעריף של מקור מלאי שטחי הפרסום.
unitsPurchased

string (int64 format)

נדרש למקורות מלאי מובטחים. מספר החשיפות שהמוכר מבטיח.
minimumSpend

object (Money)

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

רלוונטי רק למקורות מלאי שטחי פרסום מובטחים.

InventorySourceRateType

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

טיפוסים בני מנייה (enum)
INVENTORY_SOURCE_RATE_TYPE_UNSPECIFIED סוג התעריף לא צוין או לא ידוע בגרסה הזו.
INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED סוג התעריף הוא עלות קבועה לאלף חשיפות (CPM).
INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR סוג התעריף הוא עלות מינימלית לאלף חשיפות (CPM).
INVENTORY_SOURCE_RATE_TYPE_CPD סוג התעריף הוא עלות ליום.
INVENTORY_SOURCE_RATE_TYPE_CPH סוג התעריף הוא עלות לשעה.
INVENTORY_SOURCE_RATE_TYPE_FLAT סוג התעריף הוא קבוע.

כסף

מייצג סכום כסף עם סוג המטבע.

ייצוג ב-JSON 
{
  "currencyCode": string,
  "units": string,
  "nanos": integer
}
שדות
currencyCode

string

קוד המטבע בן שלוש אותיות שמוגדר בתקן ISO 4217.
units

string (int64 format)

מספר היחידות השלמות של הסכום. לדוגמה: אם הערך של currencyCode הוא "USD", המשמעות היא ש-1 יחידה = 1 דולר ארה"ב.
nanos

integer

מספר יחידות הננו (10‎^-9) של הסכום. הערך חייב להיות בין ‎-999,999,999 ל- ‎+999,999,999, כולל. אם הערך של units הוא חיובי, הערך של nanos חייב להיות חיובי או אפס. אם הערך של units הוא אפס, הערך של nanos יכול להיות חיובי, אפס או שלילי. אם הערך של units הוא שלילי, הערך של nanos חייב להיות שלילי או אפס. לדוגמה, עלות של ‎-1.75$‎ מיוצגת על ידי units‎=-1 וגם nanos‎=-750,000,000.

TimeRange

טווח זמן.

ייצוג ב-JSON 
{
  "startTime": string,
  "endTime": string
}
שדות
startTime

string (Timestamp format)

חובה. הגבול התחתון של טווח הזמן, כולל.

הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה בפורמט Z עם 0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

חובה. הגבול העליון של טווח הזמן, כולל.

הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה בפורמט Z עם 0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".

CreativeConfig

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

ייצוג ב-JSON 
{
  "creativeType": enum (CreativeType),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "displayCreativeConfig": {
    object (InventorySourceDisplayCreativeConfig)
  },
  "videoCreativeConfig": {
    object (InventorySourceVideoCreativeConfig)
  }
  // End of mutually exclusive fields.
}
שדות
creativeType

enum (CreativeType)

סוג הקריאייטיב שאפשר להקצות למקור המלאי. רק הסוגים הבאים נתמכים:

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_VIDEO

המאפיין רלוונטי אם הערך של creative_type הוא אחד מהערכים הבאים:

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_VIDEO

ההגדרה של נכסי הקריאייטיב שאפשר להקצות למקור מלאי שטחי הפרסום. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות:
displayCreativeConfig

object (InventorySourceDisplayCreativeConfig)

ההגדרה של נכסי קריאייטיב לרשת המדיה. רלוונטי אם הערך של creativeType הוא CREATIVE_TYPE_STANDARD.
videoCreativeConfig

object (InventorySourceVideoCreativeConfig)

ההגדרה של קריאייטיבים של וידאו. רלוונטי אם הערך של creativeType הוא CREATIVE_TYPE_VIDEO.
סוף השדות הבלעדיים.

InventorySourceDisplayCreativeConfig

ההגדרה של נכסי קריאייטיב לרשת המדיה.

ייצוג ב-JSON 
{
  "creativeSize": {
    object (Dimensions)
  }
}
שדות
creativeSize

object (Dimensions)

דרישות הגודל של נכסי קריאייטיב לרשת המדיה שאפשר להקצות למקור מלאי שטחי הפרסום.

InventorySourceVideoCreativeConfig

ההגדרה של קריאייטיבים של וידאו.

ייצוג ב-JSON 
{
  "duration": string
}
שדות
duration

string (Duration format)

דרישות המשך של הקריאייטיבים של הסרטונים שאפשר להקצות למקור מלאי שטחי הפרסום.

משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב-s. דוגמה: "3.5s".

InventorySourceAccessors

השותף או המפרסמים שיש להם גישה למקור מלאי שטחי הפרסום.

ייצוג ב-JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "partner": {
    object (PartnerAccessor)
  },
  "advertisers": {
    object (AdvertiserAccessors)
  }
  // End of mutually exclusive fields.
}
שדות
השותף או המפרסמים שיש להם גישה למקור מלאי שטחי הפרסום. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות:
partner

object (PartnerAccessor)

השותף שיש לו גישה למקור המלאי.
advertisers

object (AdvertiserAccessors)

המפרסמים שיש להם גישה למקור מלאי שטחי הפרסום. כל המפרסמים צריכים להיות שייכים לאותו שותף.
סוף השדות הבלעדיים.

PartnerAccessor

השותף שיש לו גישה למקור המלאי.

ייצוג ב-JSON 
{
  "partnerId": string
}
שדות
partnerId

string (int64 format)

המזהה של השותף.

AdvertiserAccessors

המפרסמים שיש להם גישה למקור מלאי שטחי הפרסום.

ייצוג ב-JSON 
{
  "advertiserIds": [
    string
  ]
}
שדות
advertiserIds[]

string (int64 format)

המזהים של המפרסמים.

Methods

create

 יצירת מקור חדש של מלאי שטחי פרסום.

editInventorySourceReadWriteAccessors

 עריכת פונקציות הגישה לקריאה ולכתיבה של מקור מלאי שטחי פרסום.

get

 אחזור של מקור מלאי.

list

 רשימה של מקורות מלאי שטחים פרסומיים שהמשתמש הנוכחי יכול לגשת אליהם.

patch

 עדכון של מקור מלאי קיים.