以規則為準的演算法是由 AlgorithmRules JSON 物件定義。透過 JSON 檔案將規則上傳至 Display & Video 360。
建構規則物件
以規則為準的自訂出價演算法會採用規則,評估回應信號的價值。
AlgorithmRules 物件包含一或多個規則集。每個規則集都會評估不同類型的回應信號,例如曝光。每個規則集都有一份規則清單。每項規則都會根據設定的條件評估信號,並傳回值。信號會由一組中的所有規則評估。
然後合併每項規則傳回的值。這會產生信號的評估值。
將 AlgorithmRules 物件儲存至本機,並存為 JSON 檔案。
產生規則參照物件
參考物件用於將上傳的檔案與規則資源建立關聯。使用 uploadRules 要求,在演算法下產生參照物件。
以下說明如何產生 rules 參照物件:
Java
// Provide the ID of the advertiser that owns the algorithm. long advertiserId = advertiser-id; // Provide the ID of the algorithm. long customBiddingAlgorithmId = algorithm-id; // Generate an AlgorithmRules reference object under the algorithm. CustomBiddingAlgorithmRulesRef response = service .customBiddingAlgorithms() .uploadRules(customBiddingAlgorithmId) .setAdvertiserId(advertiserId) .execute(); // Display the generated resource path. System.out.printf( "The generated AlgorithmRules reference object provided the following resource path: %s.", response.getResourceName());
Python
# Provide the ID of the advertiser that owns the algorithm. advertiser_id = advertiser-id # Provide the ID of the algorithm. algorithm_id = algorithm-id # Generate an AlgorithmRules reference object under the algorithm. custom_bidding_algorithm_rules_ref = ( service.customBiddingAlgorithms() .uploadRules( customBiddingAlgorithmId=algorithm_id, advertiserId=advertiser_id ) .execute() ) # Print the resource path provided in the generated rules reference object. print( "The generated rules reference object provided the following resource" f' path: {custom_bidding_algorithm_rules_ref["resourceName"]}.' )
PHP
// Provide the ID of the advertiser that owns the algorithm. $advertiserId = advertiser-id; // Provide the ID of the algorithm. $algorithmId = algorithm-id; $uploadRulesOptParams = array( 'advertiserId' => $advertiserId ); try { // Generate an AlgorithmRules reference object under the algorithm. $rulesRefResponse = $this->service->customBiddingAlgorithms->uploadRules( $customBiddingAlgorithmId, $uploadRulesOptParams ); } catch (\Exception $e) { $this->renderError($e); return; } // Print the retrieved resource path. printf( '<p>The generated AlgorithmRules reference object provided the ' . 'following resource path: %s</p>', $rulesRefResponse->getResourceName() );
上傳 AlgorithmRules 檔案
使用媒體 upload 要求,將規則檔案上傳至參考物件中的資源路徑。使用簡單上傳,並搭配查詢參數 uploadType=media。
上傳規則檔案的方法如下:
Java
// Provide the local path to the AlgorithmRules file to upload. String rulesPath = rules-path; // Provide the resource path to upload the AlgorithmRules file to. String resourcePath = resource-path; // Create media object. GoogleBytestreamMedia media = new GoogleBytestreamMedia(); media.setResourceName(resourcePath); // Create input stream for the Algorithm file. InputStreamContent rulesFileStream = new InputStreamContent(null, new FileInputStream(rulesPath)); // Create media.upload request. Media.Upload uploadRequest = service.media().upload(resourcePath, 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/" + resourcePath));
Python
# Import HTTP objects used for file upload. from apiclient.http import HttpRequest from apiclient.http import MediaFileUpload # Provide the local path to the AlgorithmRules file to upload. rules_path = rules-path # Provide the resource path to upload the AlgorithmRules file to. resource_path = resource-path # Create a media upload object. media = MediaFileUpload(rules_path) # Create upload request. upload_request = service.media().upload( resourceName=resource_path, media_body=media ) # Override response handler to expect null response. upload_request.postproc = HttpRequest.null_postproc # Upload AlgorithmRules to given resource path. upload_request.execute()
PHP
// Provide the local path to the AlgorithmRules file to upload. $rulesPath = rules-path; // Provide the resource path to upload the AlgorithmRules file to. $resourcePath = resource-path; // Create the media body. $mediaBody = new Google_Service_DisplayVideo_GoogleBytestreamMedia(); $mediaBody->setResourceName($resourceName); // Build params array for the upload request. $mediaUploadOptParams = array( 'data' => file_get_contents($rulesPath), 'uploadType' => 'media', 'resourceName' => $resourceName ); try { // Call the API, uploading the rules file to Display & Video 360. $this->service->media->upload( $resourceName, $mediaBody, $mediaUploadOptParams ); } catch (\Exception $e) { $this->renderError($e); }
建立規則物件
建立規則物件的方法如下:
Java
// Provide the ID of the advertiser that owns the parent algorithm. long advertiserId = advertiser-id; // Provide the ID of the parent algorithm. long algorithmId = algorithm-id; // Provide the resource path the AlgorithmRules file was uploaded to. String resourcePath = resource-path; // Create the custom bidding algorithm rules structure. CustomBiddingAlgorithmRules customBiddingAlgorithmRules = new CustomBiddingAlgorithmRules() .setRules(new CustomBiddingAlgorithmRulesRef().setResourceName(resourcePath)); // Create the custom bidding algorithm rules. CustomBiddingAlgorithmRules response = service .customBiddingAlgorithms() .rules() .create(algorithmId, customBiddingAlgorithmRules) .setAdvertiserId(advertiserId) .execute(); // Print ID of new custom bidding algorithm rules. System.out.printf("Rules were created with ID %s.", response.getCustomBiddingAlgorithmRulesId());
Python
# Provide the ID of the advertiser that owns the parent algorithm. advertiser_id = advertiser-id # Provide the ID of the parent algorithm. algorithm_id = algorithm-id # Provide the resource path the AlgorithmRules file was uploaded to. resource_path = resource-path # Build algorithm rules object. rules_obj = {"rules": {"resourceName": resource_path}} # Build and execute request. rules_response = ( service.customBiddingAlgorithms() .rules() .create( customBiddingAlgorithmId=algorithm_id, advertiserId=advertiser_id, body=rules_obj, ) .execute() ) # Print ID of new custom bidding algorithm rules. print( f'Rules were created with ID {rules_response["customBiddingAlgorithmRulesId"]}.' )
PHP
// Provide the ID of the advertiser that owns the parent algorithm. $advertiserId = advertiser-id; // Provide the ID of the parent algorithm. $algorithmId = algorithm-id; // Provide the resource path the AlgorithmRules file was uploaded to. $resourcePath = resource-path; // Build algorithm rules object. $customBiddingRules = new Google_Service_DisplayVideo_CustomBiddingAlgorithmRules(); $rulesRef = new Google_Service_DisplayVideo_CustomBiddingAlgorithmRulesRef(); $rulesRef->setResourceName($resourcePath); $customBiddingRules->setRules($rulesRef); $createRulesOptParams = array( 'advertiserId' => $advertiserId ); // Call the API, creating the custom bidding algorithm rules using the // rules file and under the custom bidding algorithm given. try { $result = $this->service->customBiddingAlgorithms_rules->create( $customBiddingAlgorithmId, $algorithmId, $createRulesOptParams ); } catch (\Exception $e) { $this->renderError($e); return; } // Print ID of new custom bidding algorithm rules. printf('<p>Rules was created with ID %s.</p>', $result['customBiddingAlgorithmRulesId']);