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)

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

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

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

Methods

create

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

editInventorySourceReadWriteAccessors

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

get

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

list

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

patch

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