REST Resource: advertisers.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, ובמקרה כזה פונקציות ה-accessor לקריאה/כתיבה עוברות בירושה מההזמנה המובטחת ברמה ההורה.

חובה כשהערך של 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 מקור מלאי שטחי הפרסום מוכר מלאי דרך 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_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

get

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

list

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