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)

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

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

חובה אם הערך של 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_CPH סוג התעריף הוא עלות לשעה.
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)

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

הפורמט הוא 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),

  // 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

 עדכון של מקור מלאי קיים.