تنفيذ عروض الأسعار المخصصة

تتيح لك "مساحة العرض والفيديو 360 API" الإدارة الكاملة لعمليات تنفيذ عروض الأسعار المخصّصة. يمكنك إنشاء خوارزميات عروض أسعار مخصّصة، وتحميل نصوص برمجية فردية والتحقق منها، وتعيين خوارزمية معيّنة لمورد معيّن كاستراتيجية عروض الأسعار الخاصة به.

توضّح هذه الصفحة كيفية إنشاء خوارزميات عروض الأسعار المخصّصة وتعديلها وتعيينها باستخدام "مساحة العرض والفيديو 360 API". يقدّم كل قسم نموذجًا لرمز برمجي.

إنشاء خوارزمية عروض أسعار مخصّصة

يمثّل عنصر CustomBiddingAlgorithm خوارزمية فردية يمكنك تحديدها لعنصر معيّن من أجل استخدامها في استراتيجية عروض الأسعار المتعلّقة به. يحتوي هذا الكائن على تفاصيل عن الخوارزمية، مثل customBiddingAlgorithmType وentityStatus، بالإضافة إلى readinessState وsuspensionState للنموذج الذي أنشأه المعلن ذو الصلة. يمكنك إنشاء عناصر CustomBiddingScript و CustomBiddingAlgorithmRules كموارد ثانوية لتستخدمها الخوارزمية.

في ما يلي مثال على كيفية إنشاء خوارزمية عروض أسعار مخصّصة مستندة إلى نص برمجي:

Java

// Create the custom bidding algorithm structure.
CustomBiddingAlgorithm customBiddingAlgorithm =
    new CustomBiddingAlgorithm()
        .setAdvertiserId(advertiser-id)
        .setDisplayName(display-name)
        .setEntityStatus("ENTITY_STATUS_ACTIVE")
        .setCustomBiddingAlgorithmType("SCRIPT_BASED");

// Configure the create request.
CustomBiddingAlgorithms.Create request =
    service.customBiddingAlgorithms().create(customBiddingAlgorithm);

// Create the custom bidding algorithm.
CustomBiddingAlgorithm response = request.execute();

// Display the new custom bidding algorithm name.
System.out.printf(
    "Custom bidding algorithm %s was created.%n",
    response.getName()
);

Python

# Create a custom bidding algorithm object.
custom_bidding_algorithm_obj = {
    'advertiserId': advertiser-id,
    'displayName': display-name,
    'entityStatus': 'ENTITY_STATUS_ACTIVE',
    'customBiddingAlgorithmType': 'SCRIPT_BASED'
}

# Create the custom bidding algorithm.
response = service.customBiddingAlgorithms().create(
    body=custom_bidding_algorithm_obj
).execute()

# Display the new custom bidding algorithm.
print(f'The following Custom Bidding Algorithm was created: {response}')

PHP

// Create a custom bidding algorithm object.
$customBiddingAlgorithm =
    new Google_Service_DisplayVideo_CustomBiddingAlgorithm();
$customBiddingAlgorithm->setAdvertiserId(advertiser-id);
$customBiddingAlgorithm->setDisplayName(display-name);
$customBiddingAlgorithm->setEntityStatus('ENTITY_STATUS_ACTIVE');
$customBiddingAlgorithm->setCustomBiddingAlgorithmType('SCRIPT_BASED');

// Create the custom bidding algorithm.
$result =
    $this->service->customBiddingAlgorithms->create($customBiddingAlgorithm);

// Display the new custom bidding algorithm name.
printf('Custom Bidding Algorithm %s was created.\n', $result['name']);

إدارة الوصول إلى الخوارزمية

يمكن أن تكون خوارزميات عروض الأسعار المخصّصة مملوكة لشريك أو معلِن. يمكن الوصول إلى الخوارزميات التي يملكها شريك وتعديلها من خلال ذلك الشريك وأي معلِنين فرعيين مدرَجين في الحقل sharedAdvertiserIds. يمكن لهذا المعلِن وشريكه الرئيسي الوصول إلى الخوارزميات التي يملكها أحد المعلِنين وتعديلها، ولكن لا يمكن مشاركتها مع المعلِنين الآخرين.

إذا كنت تستخدم الخوارزمية لمعلِن واحد فقط، عليك تحديد المعلن بصفته المالك باستخدام الحقل advertiserId. في الحالات الأخرى، يتم تعيين الشريك الرئيسي للمعلنين بصفته المالك باستخدام الحقل partnerId، وامنح المعلنين إذن الوصول من خلال الحقل sharedAdvertiserIds.

تحميل منطق الخوارزمية

اعتمادًا على نوع خوارزمية عروض الأسعار المخصّصة، عليك بعد ذلك إنشاء عنصر نص برمجي أو قواعد حيث يمكنك توفير المنطق للخوارزمية لكي تستخدمه.

تحميل نص برمجي

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

توضّح لك الأقسام التالية كيفية إضافة نص برمجي جديد أو معدَّل إلى خوارزمية عروض أسعار مخصّصة.

استرداد موقع مورد نص برمجي

أولاً، استرِد موقعًا جغرافيًا متاحًا للمورد ضمن مورد خوارزمية عروض الأسعار المخصّصة باستخدام طريقة customBiddingAlgorithms.uploadScript. ويعرض هذا الطلب عنصر CustomBiddingScriptRef يحمل اسم المورد. يمكنك تحميل ملف النص البرمجي إلى الموقع الذي يحدده اسم المورد. بعد ذلك، عليك استخدام العنصر المرجعي للنص البرمجي لعروض الأسعار المخصّصة من أجل إنشاء مورد النص البرمجي.

في ما يلي مثال على كيفية استرداد موقع مورد متوفّر:

Java

// Retrieve a usable custom bidding script
// reference.
CustomBiddingScriptRef scriptRef =
    service
        .customBiddingAlgorithms()
        .uploadScript(custom-bidding-algorithm-id)
        .setAdvertiserId(advertiser-id)
        .execute();

// Display the custom bidding script reference resource path.
System.out.printf(
    "The script can be uploaded to the following resource path: %s%n",
    scriptRef.getResourceName()
);

Python

# Retrieve a usable custom bidding script reference
# object.
custom_bidding_script_ref = service.customBiddingAlgorithms().uploadScript(
    customBiddingAlgorithmId=custom-bidding-algorithm-id,
    advertiserId=advertiser-id
).execute()

# Display the new custom bidding script reference object.
print('The following custom bidding script reference object was retrieved:'
      f'{custom_bidding_script_ref}')

PHP

// Set parent advertiser ID of custom bidding
// algorithm in optional parameters array for request.
$optParams = array('advertiserId' => advertiser-id);

// Retrieve a usable custom bidding script reference.
$scriptRefResponse = $this->service->customBiddingAlgorithms->uploadScript(
    custom-bidding-algorithm-id,
    $optParams
);

// Display the new custom bidding script reference object.
printf(
    'The script can be uploaded to the following resource path: %s\n',
    $scriptRefResponse->getResourceName()
);

تحميل ملف نص برمجي

بعد استرداد موقع مورد متوفّر، حمِّل ملف النص البرمجي إلى ذلك الموقع في نظام "مساحة العرض والفيديو 360" باستخدام طريقة media.upload. وتتيح هذه الطريقة إجراء عملية تحميل بسيطة تتطلب معلمة طلب البحث uploadType=media.

في ما يلي مثال على كيفية تحميل ملف نص برمجي بالاستناد إلى كائن مرجعي لنص برمجي لعرض الأسعار المخصّص تم استرداده:

Java

// Create media object.
GoogleBytestreamMedia media = new GoogleBytestreamMedia();
media.setResourceName(resource-name);

// Create input stream for the script file.
InputStreamContent scriptFileStream =
    new InputStreamContent(
        null, new FileInputStream(script-path));

// Create media.upload request.
Media.Upload uploadRequest =
        service
            .media()
            .upload(
                resource-name,
                media,
                scriptFileStream);

// Retrieve uploader from the request and set it to us a simple
// upload request.
MediaHttpUploader uploader = uploadRequest.getMediaHttpUploader();
uploader.setDirectUploadEnabled(true);

// Execute the upload using an Upload URL with the destination resource
// name.
uploader
    .upload(
        new GenericUrl(
            "https://displayvideo.googleapis.com/upload/media/"
                + resource-name));

Python

# Create a media upload object.
media = MediaFileUpload(script-path)

# Create upload request.
upload_request = service.media().upload(
    resourceName=resource-name, media_body=media)

# Override response handler to expect null response.
upload_request.postproc = HttpRequest.null_postproc

# Upload script to resource location given in retrieved custom bidding
# script reference object.
upload_request.execute()

PHP

// Create a media object.
$mediaBody = new Google_Service_DisplayVideo_GoogleBytestreamMedia();
$mediaBody->setResourceName(resource-name);

// Set parameters for upload request.
$optParams = array(
    'data' => file_get_contents(script-path),
    'uploadType' => 'media',
    'resourceName' => resource-name
);

// Upload script file to given resource location.
$this->service->media->upload(
    resource-name,
    $mediaBody,
    $optParams
);

cURL

curl --request POST 'https://displayvideo.googleapis.com/upload/media/resource-name?uploadType=media' 
  -H 'authorization: Bearer access-token'
  -H 'Content-Type: text/plain'
  --data-binary @script-path

إنشاء كائن نص برمجي

بعد تحميل ملف النص البرمجي، أنشئ مورد نص برمجي مخصّصًا لعروض الأسعار باستخدام طريقة customBiddingAlgorithms.scripts.create. يجب أن يتضمّن العنصر CustomBiddingScript الذي تم تمريره في الطلب العنصر CustomBiddingScriptRef فقط بصفته القيمة المخصّصة للحقل script. يؤدي هذا إلى ربط ملف النص البرمجي الذي تم تحميله بمورد النص البرمجي الجديد.

في ما يلي مثال على كيفية إنشاء مورد نص برمجي:

Java

// Create the custom bidding script structure.
CustomBiddingScript customBiddingScript =
    new CustomBiddingScript()
        .setScript(custom-bidding-script-ref);

// Create the custom bidding script.
CustomBiddingScript response =
    service
        .customBiddingAlgorithms()
        .scripts()
        .create(custom-bidding-algorithm-id, customBiddingScript)
        .setAdvertiserId(advertiser-id)
        .execute();

// Display the new script resource name
System.out.printf(
    "The following script was created: %s%n",
    response.getName());

Python

# Create a custom bidding script object.
script_obj = {
    'script': custom-bidding-script-ref
}

# Create the custom bidding script.
response = service.customBiddingAlgorithms().scripts().create(
    customBiddingAlgorithmId=custom-bidding-algorithm-id,
    advertiserId=advertiser-id,
    body=script_obj).execute()

# Display the new custom bidding script object.
print(f'The following custom bidding script was created: {response}')

PHP

// Create the custom bidding script object.
$customBiddingScript =
    new Google_Service_DisplayVideo_CustomBiddingScript();
$customBiddingScript->setScript(custom-bidding-script-ref);

// Set parameters for create script request.
$optParams = array(
    'advertiserId' => advertiser-id
);

// Create the custom bidding script.
$result = $this->service->customBiddingAlgorithms_scripts->create(
    custom-bidding-algorithm-id,
    $customBiddingScript,
    $optParams
);

// Display the new script resource name.
printf('The following script was created: %s.\n', $result->getName());

بعد إنشاء مورد نص برمجي لعروض الأسعار المخصّصة، تعالج "مساحة العرض والفيديو 360" النص البرمجي للتأكّد من إمكانية استخدامه بنجاح لتسجيل مرات الظهور. يمكنك استرداد حالة هذه المعالجة من خلال حقل state لكائن النص البرمجي. بعد قبول النص البرمجي الجديد، تبدأ خوارزمية عروض الأسعار المخصّصة في استخدام النص البرمجي لتسجيل قيم مرات الظهور. يحدث هذا على الفور، لذا تأكد من أنك تريد تحديث الخوارزمية قبل إنشاء مورد نص برمجي جديد.

قواعد التحميل

تستخدِم خوارزميات عروض الأسعار المخصّصة المستندة إلى القواعد المنطق المقدَّم في عنصر AlgorithmRules لتقييم قيمة مرّة ظهور.

يتم تحميل عناصر AlgorithmRules في ملف JSON ثم ربطها بخوارزمية عروض أسعار مخصّصة من خلال عنصر CustomBiddingAlgorithmRules.

استرداد موقع مورد القواعد

أولاً، استرِد موقعًا جغرافيًا متاحًا للمورد ضمن مورد خوارزمية عروض الأسعار المخصّصة باستخدام طريقة customBiddingAlgorithms.uploadRules. ويعرض هذا الطلب عنصر CustomBiddingAlgorithmsRulesRef يحمل اسم المورد. يمكنك تحميل ملف القواعد إلى الموقع الذي يحدده اسم المورد. وبعد ذلك، استخدِم العنصر المرجعي لقواعد خوارزمية عروض الأسعار المخصّصة من أجل إنشاء مورد القواعد.

في ما يلي مثال على كيفية استرداد موقع مورد متوفّر:

Java

// Create the custom bidding algorithm structure.
CustomBiddingAlgorithmRulesRef rulesRef =
    service
        .customBiddingAlgorithms()
        .uploadRules(custom-bidding-algorithm-id)
        .setAdvertiserId(advertiser-id)
        .execute();

System.out.printf(
    "The rules can be uploaded to the following resource path: %s%n",
    rulesRef.getResourceName()
);

Python

# Retrieve a usable custom bidding algorithm rules reference
# object.
custom_bidding_algorithm_rules_ref = service.customBiddingAlgorithms().uploadRules(
    customBiddingAlgorithmId=custom-bidding-algorithm-id,
    advertiserId=advertiser-id
).execute()

# Display the new custom bidding algorithm rules reference object.
print('The following custom bidding algorithm rules reference object was retrieved:'
      f' {custom_bidding_algorithm_rules_ref}')

PHP

// Set parent advertiser ID of custom bidding algorithm
// in optional parameters array for request.
$optParams = array('advertiserId' => advertiser-id);

// Retrieve a usable custom bidding algorithm rules reference.
$rulesRefResponse = $this->service->customBiddingAlgorithms->uploadRules(
    custom-bidding-algorithm-id,
    $optParams
);

// Display the new custom bidding algorithm rules reference object resource path.
printf(
    'The rules can be uploaded to the following resource path: %s\n',
    $rulesRefResponse->getResourceName()
);

تحميل ملف AlgorithmRules

بعد استرداد موقع مورد متوفّر، حمِّل ملف القواعد إلى ذلك الموقع في نظام "مساحة العرض والفيديو 360" باستخدام طريقة media.upload. وتتيح هذه الطريقة إجراء عملية تحميل بسيطة تتطلب معلمة طلب البحث uploadType=media.

في ما يلي مثال على كيفية تحميل ملف AlgorithmRules بعنصر مرجعي لقواعد خوارزمية عروض الأسعار المخصّصة تم استرداده:

Java

// Create media object.
GoogleBytestreamMedia media = new GoogleBytestreamMedia();
media.setResourceName(resource-name);

// Create input stream for the rules file.
InputStreamContent rulesFileStream =
    new InputStreamContent(
        null, new FileInputStream(rules-file-path));

// Create media.upload request.
 Media.Upload uploadRequest =
    service
        .media()
        .upload(
            resource-name,
            media,
            rulesFileStream);

// Retrieve uploader from the request and set it to us a simple
// upload request.
MediaHttpUploader uploader = uploadRequest.getMediaHttpUploader();
uploader.setDirectUploadEnabled(true);

// Execute the upload using an Upload URL with the destination resource
// name.
uploader
    .upload(
        new GenericUrl(
            "https://displayvideo.googleapis.com/upload/media/"
                + resource-name));

Python

# Create a media upload object.
media = MediaFileUpload(rules-file-path)

# Create upload request.
upload_request = service.media().upload(
    resourceName=resource-name, media_body=media)

# Override response handler to expect null response.
upload_request.postproc = HttpRequest.null_postproc

# Upload rules file to resource location given in retrieved custom bidding
# algorithm rules reference object.
upload_request.execute()

PHP

// Create a media object.
$mediaBody = new Google_Service_DisplayVideo_GoogleBytestreamMedia();
$mediaBody->setResourceName(resource-name);

// Set parameters for upload request.
$optParams = array(
    'data' => file_get_contents(rules-file-path),
    'uploadType' => 'media',
    'resourceName' => resource-name
);

// Upload rules file to given resource location.
$this->service->media->upload(
    resource-name,
    $mediaBody,
    $optParams
);

cURL

curl --request POST 'https://displayvideo.googleapis.com/upload/media/resource-name?uploadType=media' 
  -H 'authorization: Bearer access-token'
  -H 'Content-Type: text/plain'
  --data-binary @rules-file-path

إنشاء عنصر قواعد

بعد تحميل ملف AlgorithmRules بتنسيق JSON، أنشِئ موردًا لقواعد خوارزمية عروض الأسعار المخصّصة باستخدام طريقة customBiddingAlgorithms.rules.create. يجب أن يتضمّن العنصر CustomBiddingAlgorithmRules الذي تم تمريره في الطلب العنصر CustomBiddingAlgorithmRulesRef فقط بصفته القيمة المخصّصة للحقل rules. يؤدي ذلك إلى ربط ملف JSON AlgorithmRules الذي تم تحميله بمورد القواعد الجديد.

في ما يلي مثال على كيفية إنشاء مورد قواعد:

Java

// Create the custom bidding algorithm rules structure.
CustomBiddingAlgorithmRules customBiddingAlgorithmRules =
    new CustomBiddingAlgorithmRules()
        .setRules(custom-bidding-algorithm-rules-ref);

// Create the rules resource.
CustomBiddingAlgorithmRules response =
    service
        .customBiddingAlgorithms()
        .rules()
        .create(custom-bidding-algorithm-id, customBiddingAlgorithmRules)
        .setAdvertiserId(advertiser-id)
        .execute();

// Display the new rules resource name.
System.out.printf(
    "The following custom bidding algorithm rules object was created: %s%n",
    response.getName());

Python

# Create the custom bidding algorithm rules object.
rules_obj = {
    'rules': custom-bidding-algorithm-rules-ref
}

# Create the rules resource.
response = service.customBiddingAlgorithms().rules().create(
    customBiddingAlgorithmId=custom-bidding-algorithm-id,
    advertiserId=advertiser-id,
    body=rules_obj).execute()

# Display the new custom bidding algorithm rules object.
print(f'The following custom bidding algorithm rules resource was created: {response}')

PHP

// Create the custom bidding algorithm rules object.
$customBiddingAlgorithmRules =
    new Google_Service_DisplayVideo_CustomBiddingAlgorithmRules();
$customBiddingAlgorithmRules->setRules(custom-bidding-algorithm-rules-ref);

// Set parameters for create rules request.
$optParams = array(
    'advertiserId' => advertiser-id
);

// Create the custom bidding algorithm rules resource.
$result = $this->service->customBiddingAlgorithms_rules->create(
    custom-bidding-algorithm-id,
    $customBiddingAlgorithmRules,
    $optParams
);

// Display the new custom bidding algorithm rules resource name.
printf('The following rules resource was created: %s.\n', $result->getName());

بعد إنشاء مورد القواعد، تعالج "مساحة العرض والفيديو 360" مجموعة القواعد لضمان إمكانية استخدامها بنجاح لتسجيل مرات الظهور. يمكنك استرداد حالة هذه المعالجة من خلال حقل state لكائن القواعد. بعد قبول القواعد الجديدة، تبدأ خوارزمية عروض الأسعار المخصّصة في استخدام القواعد لتسجيل قيم مرات الظهور على الفور.

إذا تم رفض القواعد، استرِد سبب الرفض من error لكائن القواعد. في حال الرفض، عدِّل العنصر AlgorithmRules لإصلاح الخطأ، وكرِّر عملية التحميل بدءًا من استرداد العنصر المرجعي للقواعد.

تعيين خوارزمية عرض أسعار مخصّص

بعد إنشاء خوارزمية عروض أسعار مخصّصة، وتحميل المنطق المقبول وتلبية المتطلبات اللازمة، يمكنك تحديد خوارزمية عروض الأسعار المخصّصة لاستراتيجية عروض الأسعار لعنصر أو طلب إدراج.

يمكنك استخدام خوارزميات عروض الأسعار المخصّصة في استراتيجيتَي عروض الأسعار زيادة الإنفاق وهدف الأداء من خلال تخصيص BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO ورقم تعريف خوارزمية عروض الأسعار المخصّصة للحقلَين performanceGoalType وcustomBiddingAlgorithmId على التوالي. استنادًا إلى استراتيجية عروض الأسعار، قد تكون مَعلمات عروض الأسعار الأخرى متاحة أو مطلوبة.

في ما يلي مثال على كيفية تعديل عنصر لاستخدام استراتيجية عروض أسعار الحد الأقصى للإنفاق مع خوارزمية عروض أسعار مخصّصة معيّنة:

Java

// Create the line item structure.
LineItem lineItem = new LineItem();

// Create and set the bidding strategy structure.
BiddingStrategy biddingStrategy = new BiddingStrategy();
MaximizeSpendBidStrategy maxSpendBidStrategy =
    new MaximizeSpendBidStrategy()
        .setPerformanceGoalType(
            "BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO")
        .setCustomBiddingAlgorithmId(custom-bidding-algorithm-id);
biddingStrategy.setMaximizeSpendAutoBid(maxSpendBidStrategy);
lineItem.setBidStrategy(biddingStrategy);

// Configure the patch request and set update mask to only update
// the bid strategy.
LineItems.Patch request =
    service
        .advertisers()
        .lineItems()
        .patch(advertiser-id, line-item-id, lineItem)
        .setUpdateMask("bidStrategy");

// Update the line item.
LineItem response = request.execute();

// Display the custom bidding algorithm ID used in the new
// bid strategy.
System.out.printf(
    "LineItem %s now has a bid strategy utilizing custom "
        + "bidding algorithm %s%n",
    response.getName(),
    response
        .getBidStrategy()
        .getMaximizeSpendAutoBid()
        .getCustomBiddingAlgorithmId());

Python

# Create the new bid strategy object.
bidding_strategy = {
    'maximizeSpendAutoBid': {
        'performanceGoalType':
            'BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO',
        'customBiddingAlgorithmId': custom-bidding-algorithm-id
    }
}

# Create a line item object assigning the new bid strategy.
line_item_obj = {'bidStrategy': bidding_strategy}

# Update the line item with a new bid strategy.
response = service.advertisers().lineItems().patch(
    advertiserId=advertiser-id,
    lineItemId=line-item-id,
    updateMask='bidStrategy',
    body=line_item_obj).execute()

# Display the line item's new bid strategy
print(f'Line Item {response["name"]} is now using the following bid'
     f' strategy: {response["bidStrategy"]}.')

PHP

// Create the line item structure.
$lineItem = new Google_Service_DisplayVideo_LineItem();

// Create and set the bidding strategy structure.
$biddingStrategy =  new Google_Service_DisplayVideo_BiddingStrategy();
$maximizeSpendBidStrategy =
    new Google_Service_DisplayVideo_MaximizeSpendBidStrategy();
$maximizeSpendBidStrategy->setPerformanceGoalType(
    'BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO'
);
$maximizeSpendBidStrategy->setCustomBiddingAlgorithmId(
    custom-bidding-algorithm-id
);
$biddingStrategy->setMaximizeSpendAutoBid($maximizeSpendBidStrategy);
$lineItem->setBidStrategy($biddingStrategy);

// Set update mask.
$optParams = array('updateMask' => 'bidStrategy');

// Update the line item.
$result = $this->service->advertisers_lineItems->patch(
    advertiser-id,
    line-item-id,
    $lineItem,
    $optParams
);

// Display the custom bidding algorithm ID used in the new bid strategy.
printf(
    'Line Item %s now has a bid strategy utilizing custom bidding algorithm %s.\n',
    $result['name'],
    $result['bidStrategy']['maximizeSpendBidStrategy']['customBiddingAlgorithmId']
);