Method: lookupByExternalId

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

  • הפונקציה מחזירה את קוד השגיאה NOT_FOUND אם מזהים לא תואמים לנכס.
  • הפונקציה מחזירה את קוד השגיאה FAILED_PRECONDITION אם נמצאו מספר ישויות עם אותו מזהה חיצוני.

בקשת HTTP

POST https://dv360outofhomeseller.googleapis.com/v1beta1:lookupByExternalId

בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

ייצוג JSON 
{
  "lineExternalIds": [
    string
  ],
  "orderExternalIds": [
    string
  ],
  "productExternalIds": [
    string
  ],
  "adUnitExternalIds": [
    string
  ],
  "creativeAssetsExternalIds": [
    string
  ],
  "assignmentsExternalIds": [
    string
  ]
}
שדות
lineExternalIds[]

string

המזהים החיצוניים שעבורם צריך לאחזר את השמות מטבלת השורות.
orderExternalIds[]

string

המזהים החיצוניים שעבורם צריך לאחזר את השמות מטבלת ההזמנות.
productExternalIds[]

string

המזהים החיצוניים שעבורם צריך לאחזר שמות מטבלת המוצרים.
adUnitExternalIds[]

string

המזהים החיצוניים שעבורם צריך לאחזר שמות מהטבלה 'יחידות מודעות'.
creativeAssetsExternalIds[]

string

המזהים החיצוניים שעבורם צריך לאחזר שמות מהטבלה CreativeAsset.
assignmentsExternalIds[]

string

המזהים החיצוניים שעבורם צריך לאחזר שמות מטבלת המטלות.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:

ייצוג JSON 
{
  "lines": {
    string: string,
    ...
  },
  "orders": {
    string: string,
    ...
  },
  "products": {
    string: string,
    ...
  },
  "adUnits": {
    string: string,
    ...
  },
  "creativeAssets": {
    string: string,
    ...
  },
  "assignments": {
    string: string,
    ...
  }
}
שדות
lines

map (key: string, value: string)

מיפוי של מזהים חיצוניים לשמות שורות.

אובייקט שמכיל רשימה של "key": value זוגות. לדוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
orders

map (key: string, value: string)

מפה של מזהים חיצוניים לשמות של הזמנות.

אובייקט שמכיל רשימה של "key": value זוגות. לדוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
products

map (key: string, value: string)

מיפוי של מזהים חיצוניים לשמות מוצרים.

אובייקט שמכיל רשימה של "key": value זוגות. לדוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
adUnits

map (key: string, value: string)

מיפוי של מזהים חיצוניים לשמות של יחידות מודעות.

אובייקט שמכיל רשימה של "key": value זוגות. לדוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
creativeAssets

map (key: string, value: string)

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

אובייקט שמכיל רשימה של "key": value זוגות. לדוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
assignments

map (key: string, value: string)

מיפוי של המזהים החיצוניים לשמות המטלות.

אובייקט שמכיל רשימה של "key": value זוגות. לדוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/doubleclickbidmanager

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.