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

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

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

object (InventorySourceStatus)

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

enum (Exchange)

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

string (Timestamp format)

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

חותמת זמן ב-RFC3339 UTC 'Zulu' בפורמט של רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "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

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

טיפוסים בני מנייה (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 מקור המלאי מוכר מלאי שטחי פרסום דרך 'אומת על ידי תג'.
YOUTUBE_RESERVE מקור מלאי שטחי הפרסום מוכר מלאי שטחי פרסום דרך YouTube Reserve.
INSTANT_RESERVE מקור המלאי מוכר מלאי שטחי פרסום דרך הזמנה מיידית. אי אפשר לשנות את מקורות המלאי של סוג המוצר הזה באמצעות API.
GUARANTEED_PACKAGE מקור המלאי מוכר מלאי באמצעות מובטח חבילה. אי אפשר לשנות את מקורות המלאי של סוג המוצר הזה דרך API.
PROGRAMMATIC_TV מקור מלאי שטחי הפרסום מוכר מלאי שטחי פרסום דרך Programmtic 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 סוג התעריף הוא עלות לאלף חשיפות (קבוע).
INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR סוג המחיר הוא עלות לאלף חשיפות (CPM).
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 יחידה = 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)

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

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

string (Timestamp format)

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

חותמת זמן בפורמט UTC 'Zulu' של RFC3339, עם רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "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

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