google-dfp-api 0.2.8 → 0.3.0

data/examples/{v201103/company_service/get_company.rb → v201203/third_party_slot_service/create_third_party_slot.rb}

@@ -17,16 +17,16 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example gets a company by its ID. To determine which companies exist, run
-# get_all_companies.rb.
+# This example creates a new third party slot. To determine which third party
+# slots exist, run get_all_third_party_slots.rb.
 #
-# Tags: CompanyService.getCompany
+# Tags: ThirdPartySlotService.createThirdPartySlot
 
 require 'dfp_api'
 
-API_VERSION = :v201103
+API_VERSION = :v201203
 
-def get_company()
+def create_third_party_slot()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
   dfp = DfpApi::Api.new
 
@@ -34,24 +34,43 @@ def get_company()
   # the configuration file or provide your own logger:
   # dfp.logger = Logger.new('dfp_xml.log')
 
-  # Get the CompanyService.
-  company_service = dfp.service(:CompanyService, API_VERSION)
+  # Get the ThirdPartySlotService.
+  third_party_slot_service = dfp.service(:ThirdPartySlotService, API_VERSION)
 
-  # Set the ID of the company to get.
+  # Set the company ID to associate with this third party slot.
   company_id = 'INSERT_COMPANY_ID_HERE'.to_i
 
-  # Get the company.
-  company = company_service.get_company(company_id)
+  # Set the external unique ID and name to associate with this third party slot.
+  external_unique_id = 'INSERT_EXTERNAL_UNIQUE_ID_HERE'.to_i
+  external_unique_name = 'INSERT_EXTERNAL_UNIQUE_NAME_HERE'.to_s
 
-  if company
-    puts "Company with ID: %d, name: %s and type: %s was found." %
-        [company[:id], company[:name], company[:type]]
+  # Set the creative IDs to associate with this third party slot.
+  creative_ids = ['INSERT_CREATIVE_ID_HERE'.to_i]
+
+  # Create the ThirdPartySlot object.
+  third_party_slot = {
+      :company_id => company_id,
+      :description => 'Third party slot description.',
+      :external_unique_id => external_unique_id,
+      :external_unique_name => external_unique_name,
+      :creative_ids => creative_ids
+  }
+
+  # Create the third party slot.
+  return_slot =
+      third_party_slot_service.create_third_party_slot(third_party_slot)
+
+  if return_slot
+    puts "Third party slot with ID: %d and name: '%s' was created." %
+          [return_slot[:id], return_slot[:name]]
+  else
+    raise 'No third party slots were created.'
   end
 end
 
 if __FILE__ == $0
   begin
-    get_company()
+    create_third_party_slot()
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/{v201103/order_service/get_all_orders.rb → v201203/third_party_slot_service/get_all_third_party_slots.rb}

@@ -17,16 +17,17 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example gets all orders. To create orders, run create_orders.rb.
+# This example gets all third party slots. To create third party slots, run
+# create_third_party_slot.rb.
 #
-# Tags: OrderService.getOrdersByStatement
+# Tags: ThirdPartySlotService.getThirdPartySlotsByStatement
 
 require 'dfp_api'
 
-API_VERSION = :v201103
+API_VERSION = :v201203
 PAGE_SIZE = 500
 
-def get_all_orders()
+def get_all_third_party_slots()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
   dfp = DfpApi::Api.new
 
@@ -34,8 +35,8 @@ def get_all_orders()
   # the configuration file or provide your own logger:
   # dfp.logger = Logger.new('dfp_xml.log')
 
-  # Get the OrderService.
-  order_service = dfp.service(:OrderService, API_VERSION)
+  # Get the ThirdPartySlotService.
+  third_party_slot_service = dfp.service(:ThirdPartySlotService, API_VERSION)
 
   # Define initial values.
   offset = 0
@@ -45,8 +46,8 @@ def get_all_orders()
     # Create statement for one page with current offset.
     statement = {:query => "LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]}
 
-    # Get orders by statement.
-    page = order_service.get_orders_by_statement(statement)
+    # Get third party slots by statement.
+    page = third_party_slot_service.get_third_party_slots_by_statement(statement)
 
     if page[:results]
       # Increase query offset by page size.
@@ -55,24 +56,23 @@ def get_all_orders()
       # Get the start index for printout.
       start_index = page[:start_index]
 
-      # Print details about each order in results page.
-      page[:results].each_with_index do |order, index|
-        puts "%d) Order ID: %d, name: %s, advertiser ID: %d" %
-            [index + start_index, order[:id], order[:name],
-             order[:advertiser_id]]
+      # Print details about each third party slot in results page.
+      page[:results].each_with_index do |slot, index|
+        puts "%d) Third party slot ID: %d, name: '%s'" %
+            [index + start_index, slot[:id], slot[:name]]
       end
     end
   end while offset < page[:total_result_set_size]
 
   # Print a footer
   if page.include?(:total_result_set_size)
-    puts "Total number of orders: %d" % page[:total_result_set_size]
+    puts "Total number of third party slots: %d" % page[:total_result_set_size]
   end
 end
 
 if __FILE__ == $0
   begin
-    get_all_orders()
+    get_all_third_party_slots()
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/{v201104/placement_service/get_placements_by_statement.rb → v201203/third_party_slot_service/get_third_party_slot_by_statement.rb}

@@ -17,17 +17,17 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example gets all active placements. The statement retrieves up to the
-# maximum page size limit of 500. To create a placement, run
-# create_placements.rb.
+# This example gets archived third party slots. The statement retrieves up to
+# the maximum page size limit of 500. To create third party slots, run
+# create_third_party_slot.rb.
 #
-# Tags: PlacementService.getPlacementsByStatement
+# Tags: ThirdPartySlotService.getThirdPartySlotsByStatement
 
 require 'dfp_api'
 
-API_VERSION = :v201104
+API_VERSION = :v201203
 
-def get_placements_by_statement()
+def get_third_party_slot_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
   dfp = DfpApi::Api.new
 
@@ -35,25 +35,25 @@ def get_placements_by_statement()
   # the configuration file or provide your own logger:
   # dfp.logger = Logger.new('dfp_xml.log')
 
-  # Get the PlacementService.
-  placement_service = dfp.service(:PlacementService, API_VERSION)
+  # Get the ThirdPartySlotService.
+  third_party_slot_service = dfp.service(:ThirdPartySlotService, API_VERSION)
 
-  # Create a statement to only select active placements.
+  # Create a statement to get all slots with status 'ARCHIVED'.
   statement = {
       :query => 'WHERE status = :status LIMIT 500',
       :values => [
           {:key => 'status',
-           :value => {:value => 'ACTIVE', :xsi_type => 'TextValue'}}
+           :value => {:value => 'ARCHIVED', :xsi_type => 'TextValue'}}
       ]
   }
 
-  # Get placements by statement.
-  page = placement_service.get_placements_by_statement(statement)
+  # Get third party slots by statement.
+  page = third_party_slot_service.get_third_party_slots_by_statement(statement)
 
   if page and page[:results]
-    page[:results].each_with_index do |placement, index|
-      puts "%d) Placement ID: %d, name: %s, status: %s." % [index,
-          placement[:id], placement[:name], placement[:status]]
+    page[:results].each_with_index do |slot, index|
+      puts "%d) Third party slot ID: %d, name: '%s'" %
+          [index, slot[:id], slot[:name]]
     end
   end
 
@@ -65,7 +65,7 @@ end
 
 if __FILE__ == $0
   begin
-    get_placements_by_statement()
+    get_third_party_slot_by_statement()
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/{v201103/placement_service/get_placements_by_statement.rb → v201203/third_party_slot_service/update_third_party_slots.rb}

@@ -17,17 +17,17 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example gets all active placements. The statement retrieves up to the
-# maximum page size limit of 500. To create a placement, run
-# create_placements.rb.
+# This example updates the first third party slot description.
 #
-# Tags: PlacementService.getPlacementsByStatement
+# Tags: ThirdPartySlotService.getThirdPartySlotsByStatement,
+#       ThirdPartySlotService.updateThirdPartySlots
 
 require 'dfp_api'
 
-API_VERSION = :v201103
+API_VERSION = :v201203
+PAGE_SIZE = 500
 
-def get_placements_by_statement()
+def update_third_party_slots()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
   dfp = DfpApi::Api.new
 
@@ -35,37 +35,46 @@ def get_placements_by_statement()
   # the configuration file or provide your own logger:
   # dfp.logger = Logger.new('dfp_xml.log')
 
-  # Get the PlacementService.
-  placement_service = dfp.service(:PlacementService, API_VERSION)
+  # Get the ThirdPartySlotService.
+  third_party_slot_service = dfp.service(:ThirdPartySlotService, API_VERSION)
 
-  # Create a statement to only select active placements.
+  # Create statement to get one active third party slot.
   statement = {
-      :query => 'WHERE status = :status LIMIT 500',
+      :query => 'WHERE status = :status LIMIT 1',
       :values => [
           {:key => 'status',
-           :value => {:value => 'ACTIVE', :xsi_type => 'TextValue'}}
+           :value => {:value => 'ACTIVE', :xsi_type => 'TextValue'}},
       ]
   }
 
-  # Get placements by statement.
-  page = placement_service.get_placements_by_statement(statement)
+  # Get third party slots by statement.
+  page = third_party_slot_service.get_third_party_slots_by_statement(statement)
 
-  if page and page[:results]
-    page[:results].each_with_index do |placement, index|
-      puts "%d) Placement ID: %d, name: %s, status: %s." % [index,
-          placement[:id], placement[:name], placement[:status]]
-    end
-  end
+  if page[:results] and !page[:results].empty?
+    slot = page[:results].first
+
+    # Update local third party slot by changing its description.
+    slot[:description] = 'Updated description'
 
-  # Print a footer.
-  if page.include?(:total_result_set_size)
-    puts "Number of results found: %d" % page[:total_result_set_size]
+    # Update the third party slot on the server.
+    return_slot = third_party_slot_service.update_third_party_slot(slot)
+
+    # Display results.
+    if return_slot
+      puts ("Third party slot with ID %d and name '%s' was updated with " +
+            "description '%s'.") %
+          [return_slot[:id], return_slot[:name], return_slot[:description]]
+    else
+      puts 'No third party slots were updated.'
+    end
+  else
+    puts 'No third party slots found to update.'
   end
 end
 
 if __FILE__ == $0
   begin
-    get_placements_by_statement()
+    update_third_party_slots()
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/{v201104 → v201203}/user_service/create_users.rb

@@ -24,7 +24,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201104
+API_VERSION = :v201203
 
 def create_users()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201104 → v201203}/user_service/deactivate_users.rb

@@ -26,7 +26,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201104
+API_VERSION = :v201203
 PAGE_SIZE = 500
 
 def deactivate_users()

data/examples/{v201103 → v201203}/user_service/get_all_roles.rb

@@ -24,7 +24,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201103
+API_VERSION = :v201203
 
 def get_all_roles()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201104 → v201203}/user_service/get_all_users.rb

@@ -24,7 +24,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201104
+API_VERSION = :v201203
 PAGE_SIZE = 500
 
 def get_all_users()

data/examples/{v201107 → v201203}/user_service/get_current_user.rb

@@ -23,7 +23,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201107
+API_VERSION = :v201203
 
 def get_current_user()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201103 → v201203}/user_service/get_user.rb

@@ -23,7 +23,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201103
+API_VERSION = :v201203
 
 def get_user()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201103 → v201203}/user_service/get_users_by_statement.rb

@@ -24,7 +24,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201103
+API_VERSION = :v201203
 
 def get_users_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201107 → v201203}/user_service/update_users.rb

@@ -25,7 +25,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201107
+API_VERSION = :v201203
 
 def update_users()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/lib/dfp_api/api_config.rb

@@ -20,8 +20,6 @@
 # Helper methods for loading and managing the available services in the DFP
 # API.
 
-require 'savon'
-
 require 'ads_common/api_config'
 
 require 'dfp_api/version'
@@ -36,9 +34,9 @@ module DfpApi
     end
 
     # Set defaults
-    DEFAULT_VERSION = :v201201
+    DEFAULT_VERSION = :v201203
     DEFAULT_ENVIRONMENT = :PRODUCTION
-    LATEST_VERSION = :v201201
+    LATEST_VERSION = :v201203
 
     # Set other constants
     API_NAME = 'DfpApi'
@@ -46,22 +44,6 @@ module DfpApi
 
     # Configure the services available to each version
     @@service_config = {
-      :v201103 => [:CompanyService, :CreativeService, :ForecastService,
-                   :InventoryService, :LineItemCreativeAssociationService,
-                   :LineItemService, :NetworkService, :OrderService,
-                   :PlacementService, :ReportService, :UserService,
-                   :CustomTargetingService, :PublisherQueryLanguageService],
-      :v201104 => [:CompanyService, :CreativeService, :ForecastService,
-                   :InventoryService, :LineItemCreativeAssociationService,
-                   :LineItemService, :NetworkService, :OrderService,
-                   :PlacementService, :ReportService, :UserService,
-                   :CustomTargetingService, :PublisherQueryLanguageService],
-      :v201107 => [:CompanyService, :CreativeService, :ForecastService,
-                   :InventoryService, :LineItemCreativeAssociationService,
-                   :LineItemService, :NetworkService, :OrderService,
-                   :PlacementService, :ReportService, :UserService,
-                   :CustomTargetingService, :PublisherQueryLanguageService,
-                   :LabelService],
       :v201108 => [:CompanyService, :CreativeService, :ForecastService,
                    :InventoryService, :LineItemCreativeAssociationService,
                    :LineItemService, :NetworkService, :OrderService,
@@ -82,35 +64,31 @@ module DfpApi
                    :CustomTargetingService, :PublisherQueryLanguageService,
                    :LabelService, :ThirdPartySlotService, :ContentService,
                    :SuggestedAdUnitService, :CreativeTemplateService,
-                   :TeamService]
+                   :TeamService],
+      :v201203 => [:CompanyService, :CreativeService, :ForecastService,
+                   :InventoryService, :LineItemCreativeAssociationService,
+                   :LineItemService, :NetworkService, :OrderService,
+                   :PlacementService, :ReportService, :UserService,
+                   :CustomTargetingService, :PublisherQueryLanguageService,
+                   :LabelService, :ThirdPartySlotService, :ContentService,
+                   :SuggestedAdUnitService, :CreativeTemplateService,
+                   :TeamService, :AudienceSegmentService]
     }
 
     # Configure the different environments, with the base URL for each one
     @@environment_config = {
       :PRODUCTION => {
         :oauth_scope => 'https://www.google.com/apis/ads/publisher/',
-        :v201103 => 'https://www.google.com/apis/ads/publisher/',
-        :v201104 => 'https://www.google.com/apis/ads/publisher/',
-        :v201107 => 'https://www.google.com/apis/ads/publisher/',
         :v201108 => 'https://www.google.com/apis/ads/publisher/',
         :v201111 => 'https://www.google.com/apis/ads/publisher/',
-        :v201201 => 'https://www.google.com/apis/ads/publisher/'
-      },
-      :SANDBOX => {
-        :oauth_scope => 'https://sandbox.google.com/apis/ads/publisher/',
-        :v201103 => 'https://sandbox.google.com/apis/ads/publisher/',
-        :v201104 => 'https://sandbox.google.com/apis/ads/publisher/',
-        :v201107 => 'https://sandbox.google.com/apis/ads/publisher/',
-        :v201108 => 'https://sandbox.google.com/apis/ads/publisher/',
-        :v201111 => 'https://sandbox.google.com/apis/ads/publisher/',
-        :v201201 => 'https://sandbox.google.com/apis/ads/publisher/'
+        :v201201 => 'https://www.google.com/apis/ads/publisher/',
+        :v201203 => 'https://www.google.com/apis/ads/publisher/'
       }
     }
 
     # Configure the auth servers to use for each environment
     @@auth_server_config = {
-      :PRODUCTION => 'https://www.google.com',
-      :SANDBOX => 'https://www.google.com'
+      :PRODUCTION => 'https://www.google.com'
     }
 
     @@headers_config = {