Method: exchanges.auctionPackages.patch

تعديلات على حزمة مزاد

طلب HTTP

PATCH https://dv360seller.googleapis.com/v1beta1/{auctionPackage.name=exchanges/*/auctionPackages/*}

يستخدم عنوان URL بنية تحويل الترميز إلى gRPC.

مَعلمات المسار

المعلمات
auctionPackage.name

string

المعرّف. اسم المسار النسبي لحزمة المزاد هذه. يجب أن يكون بالصيغة التالية: "exchanges/{seller_id}/auctionpackages/{auction_package_id} Example: "exchanges/1234/auctionPackage/5678".

نص الطلب

يتضمن نص الطلب بيانات بالبنية التالية:

تمثيل JSON
{
  "auctionPackage": {
    "name": string,
    "displayName": string,
    "status": enum (DiscoveryObjectStatus),
    "description": string,
    "format": enum (Format),
    "forecast": {
      "weeklyImpressions": string,
      "weeklyUniques": string,
      "breakdowns": [
        {
          object (TargetingDimensionBreakdown)
        }
      ],
      "appsBreakdown": [
        {
          object (MobileAppSlice)
        }
      ]
    },
    "externalDealId": string,
    "logoUrl": string,
    "floorPrice": {
      "currencyCode": string,
      "units": string,
      "nanos": integer
    },
    "startTime": string,
    "endTime": string,
    "mediumType": enum (MediumType),
    "urgOwners": [
      enum (UnderRepresentedGroup)
    ],
    "dv3MarketplaceUri": string
  },
  "updateMask": string
}
الحقول
auctionPackage.displayName

string

الحقل مطلوب. الاسم المعروض لحزمة المزاد هذه. يجب أن يكون بترميز UTF-8 وبحد أقصى 240 حرفًا.

auctionPackage.status

enum (DiscoveryObjectStatus)

الحقل مطلوب. حالة حزمة المزاد هذه. لا تظهر الحزم التي تكون حالتها PAUSED أو REMOVED للمعلِنين على "مساحة العرض والفيديو 360".

auctionPackage.description

string

الحقل مطلوب. نص الوصف لهذه الحزمة. يجب أن يكون بترميز UTF-8 وبحد أقصى 2000 حرف.

auctionPackage.format

enum (Format)

الحقل مطلوب. غير قابل للتغيير. نوع شكل الإعلان الأساسي. لا يُسمح بإجراء تعديلات بعد الإنشاء.

auctionPackage.forecast

object (SellerProvidedInventoryAvailabilityEstimate)

اختياريّ. تفاصيل التوقّعات لمخزون حزمة المزاد هذه. يمكن للمعلِنين على "مساحة العرض والفيديو 360" الاطّلاع على هذه التفاصيل واستخدامها كفلتر.

auctionPackage.externalDealId

string

الحقل مطلوب. غير قابل للتغيير. رقم تعريف صفقة التبادل المستخدَم في طلبات عروض الأسعار. يجب ألا يزيد عن 100 حرف. الأحرف المسموح بها هي الأحرف الأبجدية الرقمية والشرطة السفلية والشرطة والنقطة. لا يُسمح بإجراء تعديلات بعد الإنشاء.

auctionPackage.logoUrl

string

الناتج فقط. عنوان URL لشعار حزمة المزاد هذه.

auctionPackage.floorPrice

object (Money)

الحقل مطلوب. السعر الأدنى لحزمة المزاد هذه.

auctionPackage.startTime

string (Timestamp format)

الحقل مطلوب. الوقت الذي يصبح فيه هذا المنتج نشطًا. يجب أن يكون قبل `endTime`. لا يمكن أن يكون وقت البدء بعد أكثر من عام واحد من الوقت الحالي.

يستخدم المعيار 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".

auctionPackage.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".

auctionPackage.mediumType

enum (MediumType)

الحقل مطلوب. نوع الوسيط لحزمة المزاد.

auctionPackage.urgOwners[]

enum (UnderRepresentedGroup)

اختياريّ. المجموعات الممثَّلة تمثيلاً ناقصًا التي ينتمي إليها المالك، إن وُجدت.

updateMask

string (FieldMask format)

اختياريّ. القناع الذي يتحكّم في الحقول التي سيتم تعديلها.

هذه قائمة قيم مفصولة بفاصلة تتضمّن أسماء الحقول المؤهَّلة بالكامل. مثال: "user.displayName,photo".

auctionPackage.dv3MarketplaceUri

string

الناتج فقط. رابط "مساحة العرض والفيديو 360" لحزمة المزاد في السوق.

نص الاستجابة

إذا كانت الاستجابة ناجحة، سيحتوي نصها على مثال AuctionPackage.

نطاقات الأذونات

يجب توفير نطاق OAuth التالي:

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

لمزيد من المعلومات، يُرجى الاطّلاع على OAuth 2.0 Overview.