Send Requests

    • This page demonstrates how to send requests to the Display & Video 360 API after setup.

    • Code samples are provided for creating a line item and retrieving a specific line item.

    • The reference documentation link offers a full list of available methods.

    After you've set everything up, you can send requests to the Display & Video 360 API.

    The following code samples demonstrate how to send a few simple requests:

    • Create a line item.
    • Retrieve a specific line item.

    For a full list of methods, see the reference documentation .

    Create a resource

    Here's an example of create a line item :

    Java

     // Create a line item object. 
 LineItem 
  
 lineItem 
  
 = 
  
 new 
  
 LineItem 
 (); 
 lineItem 
 . 
 setInsertionOrderId 
 ( 
  insertion 
 - 
 order 
 - 
 id 
 
 ); 
 lineItem 
 . 
 setDisplayName 
 ( 
  display 
 - 
 name 
 
 ); 
 lineItem 
 . 
 setLineItemType 
 ( 
 "LINE_ITEM_TYPE_DISPLAY_DEFAULT" 
 ); 
 lineItem 
 . 
 setEntityStatus 
 ( 
 "ENTITY_STATUS_DRAFT" 
 ); 
 // Create and set the line item flight. 
 LineItemFlight 
  
 lineItemFlight 
  
 = 
  
 new 
  
 LineItemFlight 
 (); 
 lineItemFlight 
  
 . 
 setFlightDateType 
 ( 
 "LINE_ITEM_FLIGHT_DATE_TYPE_INHERITED" 
 ); 
 lineItem 
 . 
 setFlight 
 ( 
 lineItemFlight 
 ); 
 // Create and set the line item budget. 
 LineItemBudget 
  
 lineItemBudget 
  
 = 
  
 new 
  
 LineItemBudget 
 (); 
 lineItemBudget 
  
 . 
 setBudgetAllocationType 
 ( 
 "LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED" 
 ); 
 lineItem 
 . 
 setBudget 
 ( 
 lineItemBudget 
 ); 
 // Create and set the pacing setting. 
 Pacing 
  
 pacing 
  
 = 
  
 new 
  
 Pacing 
 (); 
 pacing 
 . 
 setPacingPeriod 
 ( 
 "PACING_PERIOD_DAILY" 
 ); 
 pacing 
 . 
 setPacingType 
 ( 
 "PACING_TYPE_EVEN" 
 ); 
 pacing 
 . 
 setDailyMaxMicros 
 ( 
 10000L 
 ); 
 lineItem 
 . 
 setPacing 
 ( 
 pacing 
 ); 
 // Create and set the frequency cap. 
 FrequencyCap 
  
 frequencyCap 
  
 = 
  
 new 
  
 FrequencyCap 
 (); 
 frequencyCap 
 . 
 setTimeUnit 
 ( 
 "TIME_UNIT_DAYS" 
 ); 
 frequencyCap 
 . 
 setTimeUnitCount 
 ( 
 1 
 ); 
 frequencyCap 
 . 
 setMaxImpressions 
 ( 
 10 
 ); 
 lineItem 
 . 
 setFrequencyCap 
 ( 
 frequencyCap 
 ); 
 // Create and set the partner revenue model. 
 PartnerRevenueModel 
  
 partnerRevenueModel 
  
 = 
  
 new 
  
 PartnerRevenueModel 
 (); 
 partnerRevenueModel 
  
 . 
 setMarkupType 
 ( 
 "PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM" 
 ); 
 partnerRevenueModel 
 . 
 setMarkupAmount 
 ( 
 10000L 
 ); 
 lineItem 
 . 
 setPartnerRevenueModel 
 ( 
 partnerRevenueModel 
 ); 
 // Set the list of IDs of the creatives associated with the line item. 
 lineItem 
 . 
 setCreativeIds 
 ( 
  creative 
 - 
 ids 
 
 ); 
 // Create and set the bidding strategy. 
 BiddingStrategy 
  
 biddingStrategy 
  
 = 
  
 new 
  
 BiddingStrategy 
 (); 
 biddingStrategy 
  
 . 
 setFixedBid 
 ( 
 new 
  
 FixedBidStrategy 
 (). 
 setBidAmountMicros 
 ( 
 100000L 
 )); 
 lineItem 
 . 
 setBidStrategy 
 ( 
 biddingStrategy 
 ); 
 // Declare whether or not the line item will serve EU political ads. 
 lineItem 
 . 
 setContainsEuPoliticalAds 
 ( 
  eu 
 - 
 political 
 - 
 advertising 
 - 
 status 
 
 ); 
 // Create the line item. 
 LineItem 
  
 response 
  
 = 
  
 service 
 . 
 advertisers 
 (). 
 lineItems 
 (). 
 create 
 ( 
  advertiser 
 - 
 id 
 
 , 
  
 lineItem 
 ). 
 execute 
 ();

    Python

     # Create a line item object. 
 line_item_obj 
 = 
 { 
 'insertionOrderId' 
 : 
  insertion 
 - 
 order 
 - 
 id 
 
 , 
 'displayName' 
 : 
  display 
 - 
 name 
 
 , 
 'lineItemType' 
 : 
 'LINE_ITEM_TYPE_DISPLAY_DEFAULT' 
 , 
 'entityStatus' 
 : 
 'ENTITY_STATUS_DRAFT' 
 , 
 'flight' 
 : 
 { 
 'flightDateType' 
 : 
 'LINE_ITEM_FLIGHT_DATE_TYPE_INHERITED' 
 }, 
 'budget' 
 : 
 { 
 'budgetAllocationType' 
 : 
 'LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED' 
 }, 
 'pacing' 
 : 
 { 
 'pacingPeriod' 
 : 
 'PACING_PERIOD_DAILY' 
 , 
 'pacingType' 
 : 
 'PACING_TYPE_EVEN' 
 , 
 'dailyMaxMicros' 
 : 
 10000 
 }, 
 'frequencyCap' 
 : 
 { 
 'timeUnit' 
 : 
 'TIME_UNIT_DAYS' 
 , 
 'timeUnitCount' 
 : 
 1 
 , 
 'maxImpressions' 
 : 
 10 
 }, 
 'partnerRevenueModel' 
 : 
 { 
 'markupType' 
 : 
 'PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM' 
 , 
 'markupAmount' 
 : 
 10000 
 }, 
 'creativeIds' 
 : 
  creative 
 - 
 ids 
 
 , 
 'bidStrategy' 
 : 
 { 
 'fixedBid' 
 : 
 { 
 'bidAmountMicros' 
 : 
 100000 
 } 
 }, 
 'containsEuPoliticalAds' 
 : 
  eu 
 - 
 political 
 - 
 advertising 
 - 
 status 
 
 } 
 # Create the line item. 
 lineItem 
 = 
 service 
 . 
 advertisers 
 () 
 . 
 lineItems 
 () 
 . 
 create 
 ( 
 advertiserId 
 = 
  advertiser 
 - 
 id 
 
 , 
 body 
 = 
 line_item_obj 
 ) 
 . 
 execute 
 ()

    PHP

     // Create a line item object. 
 $lineItem = new Google_Service_DisplayVideo_LineItem(); 
 $lineItem->setInsertionOrderId( insertion-order-id 
); 
 $lineItem->setDisplayName( display-name 
); 
 $lineItem->setLineItemType('LINE_ITEM_TYPE_DISPLAY_DEFAULT'); 
 $lineItem->setEntityStatus('ENTITY_STATUS_DRAFT'); 
 // Create and set the line item flight. 
 $flight = new Google_Service_DisplayVideo_LineItemFlight(); 
 $flight->setFlightDateType('LINE_ITEM_FLIGHT_DATE_TYPE_INHERITED'); 
 $lineItem->setFlight($flight); 
 // Create and set the line item budget. 
 $budget = new Google_Service_DisplayVideo_LineItemBudget(); 
 $budget->setBudgetAllocationType( 
 'LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED' 
 ); 
 $lineItem->setBudget($budget); 
 // Create and set the pacing setting. 
 $pacing = new Google_Service_DisplayVideo_Pacing(); 
 $pacing->setPacingPeriod('PACING_PERIOD_DAILY'); 
 $pacing->setPacingType('PACING_TYPE_EVEN'); 
 $pacing->setDailyMaxMicros(10000); 
 $lineItem->setPacing($pacing); 
 // Create and set the frequency cap. 
 $frequencyCap = new Google_Service_DisplayVideo_FrequencyCap(); 
 $frequencyCap->setMaxImpressions(10); 
 $frequencyCap->setTimeUnit('TIME_UNIT_DAYS'); 
 $frequencyCap->setTimeUnitCount(1); 
 $lineItem->setFrequencyCap($frequencyCap); 
 // Create and set the partner revenue model. 
 $partnerRevenueModel = 
 new Google_Service_DisplayVideo_PartnerRevenueModel(); 
 $partnerRevenueModel->setMarkupType( 
 'PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM' 
 ); 
 $partnerRevenueModel->setMarkupAmount(10000); 
 $lineItem->setPartnerRevenueModel($partnerRevenueModel); 
 // Set the list of IDs of the creatives associated with the line item. 
 lineItem >setCreativeIds( creative-ids 
); 
 // Create and set the bidding strategy. 
 $biddingStrategy =  new Google_Service_DisplayVideo_BiddingStrategy(); 
 $fixedBidStrategy = new Google_Service_DisplayVideo_FixedBidStrategy(); 
 $fixedBidStrategy->setBidAmountMicros(100000); 
 $biddingStrategy->setFixedBid($fixedBidStrategy); 
 $lineItem->setBidStrategy($biddingStrategy); 
 // Declare whether or not the line item will serve EU political ads. 
 $lineItem->setContainsEuPoliticalAds( eu-political-advertising-status 
); 
 // Create the line item. 
 $result = $this->service->advertisers_lineItems->create( 
  advertiser-id 
, 
 $lineItem 
 );

    Retrieve a specific resource

    Here's an example of retrieve a specific line item :

    Java

     // Get the line item. 
 LineItem 
  
 lineItem 
  
 = 
  
 service 
  
 . 
 advertisers 
 () 
  
 . 
 lineItems 
 () 
  
 . 
 get 
 ( 
  advertiser 
 - 
 id 
 
 , 
  
  line 
 - 
 item 
 - 
 id 
 
 ) 
  
 . 
 execute 
 ();

    Python

     # Get the line item. 
 lineItem 
 = 
 service 
 . 
 advertisers 
 () 
 . 
 lineItems 
 . 
 get 
 ( 
 advertiserId 
 = 
  advertiser 
 - 
 id 
 
 , 
 lineItemId 
 = 
  line 
 - 
 item 
 - 
 id 
 
 ) 
 . 
 execute 
 ()

    PHP

     // Get the line item. 
 $lineItem = $this->service->advertisers_lineItems->get( 
  advertiser-id 
, 
  line-item-id 
 
 );
    Previous
    Configure your client
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: