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)
    }
  ],
  "subSitePropertyId": string,
  "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

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

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

object (InventorySourceStatus)

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

enum (Exchange)

מקור ה-Exchange שמקור המלאי שייך אליו.
updateTime

string (Timestamp format)

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

חותמת זמן בפורמט "זולו" RFC3339 UTC, ברזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".
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

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

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

InventorySourceProductType

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

טיפוסים בני מנייה (enums)
INVENTORY_SOURCE_PRODUCT_TYPE_UNSPECIFIED סוג המוצר לא צוין או שהוא לא ידוע בגרסה הזו. אי אפשר לשנות מקורות של מלאי שטחי פרסום מסוג המוצר הזה דרך API.
PREFERRED_DEAL מקור המלאי מוכר את המלאי באמצעות Preferred Deal.
PRIVATE_AUCTION מקור המלאי מוכר מלאי דרך מכרז פרטי.
PROGRAMMATIC_GUARANTEED מקור המלאי מוכר את המלאי באמצעות Programmatic commitmentd.
TAG_GUARANTEED מקור המלאי מוכר מלאי באמצעות 'אומת על ידי Tag'.
YOUTUBE_RESERVE מקור המלאי מוכר את המלאי דרך YouTube Reserve.
INSTANT_RESERVE מקור המלאי מוכר מלאי באמצעות הזמנה מיידית. אי אפשר לשנות מקורות של מלאי שטחי פרסום מסוג המוצר הזה דרך API.
GUARANTEED_PACKAGE מקור המלאי מוכר מלאי דרך 'חבילה מובטחת'. אי אפשר לשנות מקורות של מלאי שטחי פרסום מסוג המוצר הזה דרך API.
PROGRAMMATIC_TV מקור המלאי מוכר את המלאי דרך Programmtic TV. אי אפשר לשנות מקורות של מלאי שטחי פרסום מסוג המוצר הזה דרך API.
AUCTION_PACKAGE מקור המלאי מוכר מלאי דרך חבילת מכרזים. אי אפשר לשנות מקורות של מלאי שטחי פרסום מסוג המוצר הזה דרך API.

InventorySourceCommitment

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

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

InventorySourceDeliveryMethod

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

טיפוסים בני מנייה (enums)
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

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

טיפוסים בני מנייה (enums)
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

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

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

כסף

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

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

string

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

string (int64 format)

מספר היחידות השלמות של הסכום. לדוגמה, אם הערך של currencyCode הוא "USD", המשמעות היא ש-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)

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

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

string (Timestamp format)

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

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

CreativeConfig

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

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

  // Union field creative_config_scheme can be only one of the following:
  "displayCreativeConfig": {
    object (InventorySourceDisplayCreativeConfig)
  },
  "videoCreativeConfig": {
    object (InventorySourceVideoCreativeConfig)
  }
  // End of list of possible types for union field creative_config_scheme.
}
שדות
creativeType

enum (CreativeType)

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

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_VIDEO

שדה איחוד creative_config_scheme. רלוונטי אם creative_type הוא אחד מהתנאים הבאים:

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_VIDEO

ההגדרה של נכסי הקריאייטיב שאפשר להקצות למקור של מלאי שטחי הפרסום. הערך של creative_config_scheme יכול להיות רק אחת מהאפשרויות הבאות:
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 
{

  // Union field accessors can be only one of the following:
  "partner": {
    object (PartnerAccessor)
  },
  "advertisers": {
    object (AdvertiserAccessors)
  }
  // End of list of possible types for union field accessors.
}
שדות
שדה איחוד accessors. השותפים או המפרסמים שיש להם גישה למקור של מלאי שטחי הפרסום. הערך של accessors יכול להיות רק אחת מהאפשרויות הבאות:
partner

object (PartnerAccessor)

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

object (AdvertiserAccessors)

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

PartnerAccessor

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

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

string (int64 format)

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

AdvertiserAccessors

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

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

string (int64 format)

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

שיטות

create

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

editInventorySourceReadWriteAccessors

 עורך את רכיבי הגישה לקריאה/כתיבה של מקור מלאי.

get

 הפונקציה מקבלת מקור מלאי.

list

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

patch

 עדכון מקור קיים של מלאי שטחי פרסום.