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)

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

חותמת זמן בפורמט "זולו" 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 מקור המלאי מוכר מלאי באמצעות פרוגרמטי מובטח.
TAG_GUARANTEED מקור המלאי מוכר מלאי באמצעות 'אומת תג'.
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 סוג התעריף הוא 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", אז יחידה אחת היא דולר ארה"ב אחד.
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

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