REST Resource: customBiddingAlgorithms

संसाधन: Custom BiddingAlgorithm

कस्टम बिडिंग का एक एल्गोरिदम.

JSON के काेड में दिखाना 
{
  "name": string,
  "customBiddingAlgorithmId": string,
  "displayName": string,
  "entityStatus": enum (EntityStatus),
  "customBiddingAlgorithmType": enum (CustomBiddingAlgorithmType),
  "sharedAdvertiserIds": [
    string
  ],
  "modelDetails": [
    {
      object (CustomBiddingModelDetails)
    }
  ],

  // Union field owner can be only one of the following:
  "partnerId": string,
  "advertiserId": string
  // End of list of possible types for union field owner.
}
फ़ील्ड
name

string

सिर्फ़ आउटपुट के लिए. कस्टम बिडिंग एल्गोरिदम का संसाधन नाम.
customBiddingAlgorithmId

string (int64 format)

सिर्फ़ आउटपुट के लिए. कस्टम बिडिंग एल्गोरिदम का यूनीक आईडी. सिस्टम ने असाइन किया है.
displayName

string

ज़रूरी है. कस्टम बिडिंग एल्गोरिदम का डिसप्ले नेम.

यह UTF-8 कोड में होना चाहिए और इसका साइज़ 240 बाइट से ज़्यादा नहीं होना चाहिए.
entityStatus

enum (EntityStatus)

इससे यह कंट्रोल किया जाता है कि कस्टम बिडिंग एल्गोरिदम का इस्तेमाल, बिडिंग की रणनीति के तौर पर किया जा सकता है या नहीं.

स्वीकार की गई वैल्यू ये हैं:

  • ENTITY_STATUS_ACTIVE
  • ENTITY_STATUS_ARCHIVED
customBiddingAlgorithmType

enum (CustomBiddingAlgorithmType)

ज़रूरी है. इम्यूटेबल. कस्टम बिडिंग एल्गोरिदम का टाइप.
sharedAdvertiserIds[]

string (int64 format)

विज्ञापन देने वाले उन लोगों या कंपनियों के आईडी जिनके पास इस एल्गोरिदम का ऐक्सेस है. अगर advertiserId सेट है, तो इस फ़ील्ड में सिर्फ़ वह वैल्यू होगी.

अगर एल्गोरिदम owner एक पार्टनर है और विज्ञापन देने वाले accessor का इस्तेमाल करके उसे वापस पाया जा रहा है, तो यह फ़ील्ड सेट नहीं होगा.
modelDetails[]

object (CustomBiddingModelDetails)

सिर्फ़ आउटपुट के लिए. विज्ञापन देने वाले हर उस व्यक्ति या कंपनी के लिए कस्टम बिडिंग मॉडल की जानकारी जिसके पास ऐक्सेस है.

इस फ़ील्ड में, विज्ञापन देने वाले की जानकारी सिर्फ़ तब शामिल हो सकती है, जब एल्गोरिदम owner एक पार्टनर हो और उसे किसी विज्ञापन देने वाले accessor का इस्तेमाल करके फिर से हासिल किया जा रहा हो.
यूनियन फ़ील्ड owner. उस DV360 इकाई की पहचान करता है जिसके पास कस्टम बिडिंग वाले एल्गोरिदम का मालिकाना हक है. यह कोई पार्टनर या विज्ञापन देने वाला व्यक्ति या कंपनी हो सकती है. owner इनमें से सिर्फ़ एक हो सकता है:
partnerId

string (int64 format)

इम्यूटेबल. कस्टम बिडिंग एल्गोरिदम का मालिकाना हक रखने वाले पार्टनर का यूनीक आईडी.
advertiserId

string (int64 format)

इम्यूटेबल. विज्ञापन देने वाले उस व्यक्ति या कंपनी का यूनीक आईडी जिसके पास कस्टम बिडिंग वाले एल्गोरिदम का मालिकाना हक है.

CustomBiddingAlgorithmType

कस्टम बिडिंग वाले एल्गोरिदम के संभावित टाइप.

Enums
CUSTOM_BIDDING_ALGORITHM_TYPE_UNSPECIFIED इस वर्शन में, एल्गोरिदम का टाइप नहीं बताया गया है या यह अज्ञात है.
SCRIPT_BASED यह एल्गोरिदम, ग्राहक की अपलोड की गई कस्टम बिडिंग वाली स्क्रिप्ट फ़ाइलों से जनरेट होता है.
ADS_DATA_HUB_BASED Ads Data Hub प्रॉडक्ट की मदद से बनाया गया एल्गोरिदम.
GOAL_BUILDER_BASED DV3 यूज़र इंटरफ़ेस (यूआई) में, लक्ष्य बिल्डर की मदद से बनाया गया एल्गोरिदम.
RULE_BASED

तय किए गए नियमों पर आधारित एल्गोरिदम. इन नियमों को एपीआई में AlgorithmRules ऑब्जेक्ट का इस्तेमाल करके तय किया जाता है.

यह एल्गोरिदम टाइप सिर्फ़ उन ग्राहकों के लिए उपलब्ध है जिन्हें अनुमति मिली है. इस तरह के उपहार कार्ड का इस्तेमाल करने वाले अन्य ग्राहकों को गड़बड़ी का मैसेज मिलेगा.

CustomBiddingModelDetails

शेयर किए गए विज्ञापन देने वाले किसी एक व्यक्ति या कंपनी के लिए, कस्टम बिडिंग एल्गोरिदम मॉडल की जानकारी.

JSON के काेड में दिखाना 
{
  "advertiserId": string,
  "readinessState": enum (ReadinessState),
  "suspensionState": enum (SuspensionState)
}
फ़ील्ड
advertiserId

string (int64 format)

विज्ञापन देने वाले का यूनीक आईडी.
readinessState

enum (ReadinessState)

कस्टम बिडिंग मॉडल की तैयारी की स्थिति.
suspensionState

enum (SuspensionState)

सिर्फ़ आउटपुट के लिए. कस्टम बिडिंग मॉडल के निलंबन की स्थिति.

ReadinessState

मॉडल के तैयार होने की संभावित स्थितियां.

Enums
READINESS_STATE_UNSPECIFIED इस वर्शन में, स्थिति की जानकारी नहीं दी गई है या यह जानकारी मौजूद नहीं है.
READINESS_STATE_ACTIVE मॉडल को ट्रेनिंग दे दी गई है और वह इस्तेमाल के लिए तैयार है.
READINESS_STATE_INSUFFICIENT_DATA सर्विंग मॉडल को ट्रेनिंग देने के लिए, ज़रूरत के मुताबिक डेटा उपलब्ध नहीं है.
READINESS_STATE_TRAINING मॉडल की ट्रेनिंग चल रही है और वह इस्तेमाल के लिए तैयार नहीं है.
READINESS_STATE_NO_VALID_SCRIPT मॉडल को ट्रेन करने के लिए, कोई मान्य कस्टम बिडिंग स्क्रिप्ट नहीं दी गई है. यह स्टेटस सिर्फ़ उन एल्गोरिदम पर लागू होगा जिनका customBiddingAlgorithmType SCRIPT_BASED है.
READINESS_STATE_EVALUATION_FAILURE मान्य स्क्रिप्ट दी गई थी, लेकिन इवैलुएशन में पास नहीं हुई. यह उन स्क्रिप्ट पर लागू होता है जिनका आकलन तय समय में नहीं किया जा सका.

SuspensionState

कस्टम बिडिंग मॉडल की निलंबन की संभावित स्थितियां.

Enums
SUSPENSION_STATE_UNSPECIFIED इस वर्शन में, स्थिति की जानकारी नहीं दी गई है या यह जानकारी मौजूद नहीं है.
SUSPENSION_STATE_ENABLED मॉडल चालू हो, हाल ही में इस्तेमाल किया गया हो, फ़िलहाल इस्तेमाल किया जा रहा हो या इस्तेमाल करने के लिए शेड्यूल किया गया हो. एल्गोरिदम, विज्ञापन देने वाले इस व्यक्ति या कंपनी के लिए इंप्रेशन को लगातार स्कोर कर रहा है.
SUSPENSION_STATE_DORMANT मॉडल का हाल ही में इस्तेमाल नहीं किया गया है. हालांकि, यह मॉडल अब भी ENABLED के तौर पर काम करता है, लेकिन अगर इसका इस्तेमाल नहीं किया जाता है, तो इसे निलंबित कर दिया जाएगा.
SUSPENSION_STATE_SUSPENDED मॉडल को इंप्रेशन स्कोर करने से निलंबित कर दिया गया है और उसे विज्ञापन नहीं दिखाया जा सकता. अगर एल्गोरिदम को विज्ञापन देने वाले के किसी लाइन आइटम को असाइन किया जाता है या किसी अन्य तरीके से अपडेट किया जाता है, तो यह ENABLED स्टेटस पर वापस स्विच हो जाएगा. साथ ही, विज्ञापन दिखाने वाले मॉडल को फिर से तैयार करने में समय लगेगा.

तरीके

create

 नया कस्टम बिडिंग एल्गोरिदम बनाता है.

get

 कस्टम बिडिंग एल्गोरिदम मिलता है.

list

 उन कस्टम बिडिंग एल्गोरिदम की सूची दिखाता है जिन्हें मौजूदा उपयोगकर्ता ऐक्सेस कर सकता है और जिनका इस्तेमाल बिडिंग की रणनीतियों में किया जा सकता है.

patch

 कस्टम बिडिंग के मौजूदा एल्गोरिदम को अपडेट करता है.

uploadRules

 AlgorithmRules फ़ाइल के लिए, नियमों का रेफ़रंस ऑब्जेक्ट बनाता है.

uploadScript

 स्क्रिप्ट फ़ाइल के लिए, कस्टम बिडिंग स्क्रिप्ट रेफ़रंस ऑब्जेक्ट बनाता है.