google-dfp-api 0.6.3 → 0.7.0

data/examples/{v201206/inventory_service/get_ad_unit_sizes.rb → v201308/contact_service/create_contacts.rb}

@@ -1,9 +1,9 @@
 #!/usr/bin/env ruby
 # Encoding: utf-8
 #
-# Author:: api.dklimkin@gmail.com (Danial Klimkin)
+# Author:: api.davidtorres@gmail.com (David Torres)
 #
-# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
+# Copyright:: Copyright 2013, Google Inc. All Rights Reserved.
 #
 # License:: Licensed under the Apache License, Version 2.0 (the "License");
 #           you may not use this file except in compliance with the License.
@@ -18,15 +18,16 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This code example gets all web target platform ad unit sizes.
+# This example creates new contacts. To determine which contacts exist, run
+# get_all_contacts.rb.
 #
-# Tags: InventoryService.getAdUnitSizesByStatement
+# Tags: ContactService.createContacts
 
 require 'dfp_api'
 
-API_VERSION = :v201206
+API_VERSION = :v201308
 
-def get_all_ad_unit_sizes()
+def create_contacts()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
   dfp = DfpApi::Api.new
 
@@ -34,38 +35,47 @@ def get_all_ad_unit_sizes()
   # the configuration file or provide your own logger:
   # dfp.logger = Logger.new('dfp_xml.log')
 
-  # Get the InventoryService.
-  inventory_service = dfp.service(:InventoryService, API_VERSION)
+  # Get the ContactService.
+  contact_service = dfp.service(:ContactService, API_VERSION)
 
-  target_platform = 'WEB'
+  # Set the ID of the advertiser company this contact is associated with.
+  advertiser_company_id = 'INSERT_ADVERTISER_COMPANY_ID_HERE'
 
-  # Create statement object to only select web ad unit sizes.
-  statement = {
-     :query => 'WHERE targetPlatform = :target_platform',
-     :values => [
-         {:key => 'target_platform',
-          :value => {:value => target_platform,
-                     :xsi_type => 'TextValue'}}
-     ]
+  # Set the ID of the agency company this contact is associated with.
+  agency_company_id = 'INSERT_AGENCY_COMPANY_ID_HERE'
+
+  # Create an advertiser contact.
+  advertiser_contact = {
+      :name => 'Mr. Advertiser',
+      :email => 'advertiser@advertising.com',
+      :company_id => advertiser_company_id
+  }
+
+  # Create an agency contact.
+  agency_contact = {
+      :name => 'Ms. Agency',
+      :email => 'agency@agencies.com',
+      :company_id => agency_company_id
   }
 
-  # Get ad unit sizes by statement.
-  ad_unit_sizes = inventory_service.get_ad_unit_sizes_by_statement(statement)
+  # Create the contacts on the server.
+  return_contacts = contact_service.create_contacts([advertiser_contact,
+      agency_contact])
 
-  if ad_unit_sizes
-    # Print details about each ad unit in results.
-    ad_unit_sizes.each_with_index do |ad_unit_size, index|
-      puts "%d) Web ad unit size of dimensions %d x %d was found." % [index,
-          ad_unit_size[:size][:width], ad_unit_size[:size][:height]]
+  # Display results.
+  if return_contacts
+    return_contacts.each do |contact|
+      puts 'A contact with ID %d and name %s was created.' % [contact[:id],
+          contact[:name]]
     end
   else
-    puts 'No ad unit sizes found.'
+    raise 'No contacts were created.'
   end
 end
 
 if __FILE__ == $0
   begin
-    get_all_ad_unit_sizes()
+    create_contacts()
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/{v201206/content_service/get_all_content.rb → v201308/contact_service/get_all_contacts.rb}

@@ -1,9 +1,9 @@
 #!/usr/bin/env ruby
 # Encoding: utf-8
 #
-# Author:: api.dklimkin@gmail.com (Danial Klimkin)
+# Author:: api.davidtorres@gmail.com (David Torres)
 #
-# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
+# Copyright:: Copyright 2013, Google Inc. All Rights Reserved.
 #
 # License:: Licensed under the Apache License, Version 2.0 (the "License");
 #           you may not use this file except in compliance with the License.
@@ -18,18 +18,16 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example gets all content.
+# This example gets all contacts. To create contacts, run create_contacts.rb.
 #
-# This feature is only available to DFP video publishers.
-#
-# Tags: ContentService.getContentByStatement
+# Tags: ContactService.getContactsByStatement.
 
 require 'dfp_api'
 
-API_VERSION = :v201206
+API_VERSION = :v201308
 PAGE_SIZE = 500
 
-def get_all_content()
+def get_all_contacts()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
   dfp = DfpApi::Api.new
 
@@ -37,8 +35,8 @@ def get_all_content()
   # the configuration file or provide your own logger:
   # dfp.logger = Logger.new('dfp_xml.log')
 
-  # Get the ContentService.
-  content_service = dfp.service(:ContentService, API_VERSION)
+  # Get the ContactService.
+  contact_service = dfp.service(:ContactService, API_VERSION)
 
   # Define initial values.
   offset = 0
@@ -48,8 +46,8 @@ def get_all_content()
     # Create statement for one page with current offset.
     statement = {:query => "LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]}
 
-    # Get content by statement.
-    page = content_service.get_content_by_statement(statement)
+    # Get contacts by statement.
+    page = contact_service.get_contacts_by_statement(statement)
 
     if page[:results]
       # Increase query offset by page size.
@@ -59,9 +57,9 @@ def get_all_content()
       start_index = page[:start_index]
 
       # Print details about each content object in results page.
-      page[:results].each_with_index do |content, index|
-        puts "%d) Content ID: %d, name: %s, status: %s." % [index + start_index,
-             content[:id], content[:name], content[:status]]
+      page[:results].each_with_index do |contact, index|
+        puts "%d) Contact ID: %d, name: %s." % [index + start_index,
+            contact[:id], contact[:name]]
       end
     end
   end while offset < page[:total_result_set_size]
@@ -74,7 +72,7 @@ end
 
 if __FILE__ == $0
   begin
-    get_all_content()
+    get_all_contacts()
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/v201308/contact_service/get_uninvited_contacts.rb

@@ -0,0 +1,102 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Author:: api.davidtorres@gmail.com (David Torres)
+#
+# Copyright:: Copyright 2013, Google Inc. All Rights Reserved.
+#
+# License:: Licensed under the Apache License, Version 2.0 (the "License");
+#           you may not use this file except in compliance with the License.
+#           You may obtain a copy of the License at
+#
+#           http://www.apache.org/licenses/LICENSE-2.0
+#
+#           Unless required by applicable law or agreed to in writing, software
+#           distributed under the License is distributed on an "AS IS" BASIS,
+#           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+#           implied.
+#           See the License for the specific language governing permissions and
+#           limitations under the License.
+#
+# This example gets uninvited contacts. To create contacts, run
+# create_contacts.rb.
+#
+# Tags: ContactService.getContactsByStatement.
+
+require 'dfp_api'
+
+API_VERSION = :v201308
+PAGE_SIZE = 500
+
+def get_uninvited_contacts()
+  # Get DfpApi instance and load configuration from ~/dfp_api.yml.
+  dfp = DfpApi::Api.new
+
+  # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
+  # the configuration file or provide your own logger:
+  # dfp.logger = Logger.new('dfp_xml.log')
+
+  # Get the ContactService.
+  contact_service = dfp.service(:ContactService, API_VERSION)
+
+  # Define initial values.
+  offset = 0
+  page = {}
+  query_base = 'WHERE status = :status ORDER BY id LIMIT %d OFFSET %d'
+
+  # Create statement.
+  statement = {
+    :values => [
+      {:key => 'status',
+       :value => {:value => 'UNINVITED', :xsi_type => 'TextValue'}}
+    ]
+  }
+
+  begin
+    # Update statement for one page with current offset.
+    statement[:query] = query_base % [PAGE_SIZE, offset]
+
+    # Get contacts by statement.
+    page = contact_service.get_contacts_by_statement(statement)
+
+    if page[:results]
+      # Increase query offset by page size.
+      offset += PAGE_SIZE
+
+      # Get the start index for printout.
+      start_index = page[:start_index]
+
+      # Print details about each content object in results page.
+      page[:results].each_with_index do |contact, index|
+        puts "%d) Contact ID: %d, name: %s." % [index + start_index,
+            contact[:id], contact[: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 results: %d" % page[:total_result_set_size]
+  end
+end
+
+if __FILE__ == $0
+  begin
+    get_uninvited_contacts()
+
+  # HTTP errors.
+  rescue AdsCommon::Errors::HttpError => e
+    puts "HTTP Error: %s" % e
+
+  # API errors.
+  rescue DfpApi::Errors::ApiException => e
+    puts "Message: %s" % e.message
+    puts 'Errors:'
+    e.errors.each_with_index do |error, index|
+      puts "\tError [%d]:" % (index + 1)
+      error.each do |field, value|
+        puts "\t\t%s: %s" % [field, value]
+      end
+    end
+  end
+end

data/examples/{v201206/company_service/create_companies.rb → v201308/contact_service/update_contacts.rb}

@@ -1,9 +1,9 @@
 #!/usr/bin/env ruby
 # Encoding: utf-8
 #
-# Author:: api.dklimkin@gmail.com (Danial Klimkin)
+# Author:: api.davidtorres@gmail.com (David Torres)
 #
-# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
+# Copyright:: Copyright 2013, Google Inc. All Rights Reserved.
 #
 # License:: Licensed under the Apache License, Version 2.0 (the "License");
 #           you may not use this file except in compliance with the License.
@@ -18,18 +18,16 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example creates new companies. To determine which companies exist, run
-# get_all_companies.rb.
+# This example updates contact comments. To determine which contacts exist,
+# run get_all_contacts.rb.
 #
-# Tags: CompanyService.createCompanies
+# Tags: ContactService.updateContacts
 
 require 'dfp_api'
 
-API_VERSION = :v201206
-# Number of companies to create.
-ITEM_COUNT = 5
+API_VERSION = :v201308
 
-def create_companies()
+def update_contacts()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
   dfp = DfpApi::Api.new
 
@@ -37,31 +35,36 @@ def create_companies()
   # 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 ContactService.
+  contact_service = dfp.service(:ContactService, API_VERSION)
 
-  # Create an array to store local company objects.
-  companies = (1..ITEM_COUNT).map do |index|
-    {:name => "Advertiser #%d" % index, :type => 'ADVERTISER'}
-  end
+  contact_id = 'INSERT_CONTACT_ID_HERE'
+
+  # Get contact.
+  contact = contact_service.get_contact(contact_id)
+
+  # Update the comment of the contact.
+  contact[:address] = '123 New Street, New York, NY, 10011'
 
-  # Create the companies on the server.
-  return_companies = company_service.create_companies(companies)
+  # Update the contact on the server.
+  return_contacts = contact_service.update_contacts([contact])
 
-  if return_companies
-    return_companies.each do |company|
-      puts "Company with ID: %d, name: %s and type: %s was created." %
-          [company[:id], company[:name], company[:type]]
+  # Display results.
+  if return_contacts
+    return_contacts.each do |updated_contact|
+      puts "Contact with ID: %d, name: %s and comment: '%s' was updated." %
+          [updated_contact[:id], updated_contact[:name],
+           updated_contact[:comment]]
     end
   else
-    raise 'No companies were created.'
+    raise 'No contacts were updated.'
   end
 
 end
 
 if __FILE__ == $0
   begin
-    create_companies()
+    update_contacts()
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/{v201204 → v201308}/content_service/get_all_content.rb

@@ -26,7 +26,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201204
+API_VERSION = :v201308
 PAGE_SIZE = 500
 
 def get_all_content()

data/examples/{v201204 → v201308}/content_service/get_content_by_category.rb

@@ -29,7 +29,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201204
+API_VERSION = :v201308
 PAGE_SIZE = 500
 
 def get_content_by_statement()
@@ -70,47 +70,54 @@ def get_content_by_statement()
       statement)
 
   # Get the custom targeting value ID for the comedy category.
-  category_custom_targeting_value_id = page[:results].first()[:id]
-
-  # Get the ContentService.
-  content_service = dfp.service(:ContentService, API_VERSION)
-
-  # Define initial values.
-  offset = 0
-  page = {}
-
-  statement_text = 'WHERE status = :status'
-  statement = {
-      :query => statement_text,
-      :values => [
-          {:key => 'status',
-           :value => {:value => 'ACTIVE', :xsi_type => 'TextValue'}}
-      ]
-  }
-
-  begin
-    # Create a statement to get one page with current offset.
-    statement[:query] = statement_text +
-        " LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]
-
-    # Get content by statement.
-    page = content_service.get_content_by_statement_and_custom_targeting_value(
-        statement, category_custom_targeting_value_id)
-
-    if page[:results]
-      # Increase query offset by page size.
-      offset += PAGE_SIZE
-
-      page[:results].each_with_index do |content, index|
-        puts "%d) Content ID: %d, name: %s, status: %s." % [index + start_index,
-             content[:id], content[:name], content[:status]]
+  if page[:results]
+    category_custom_targeting_value_id = page[:results].first()[:id]
+
+    # Get the ContentService.
+    content_service = dfp.service(:ContentService, API_VERSION)
+
+    # Define initial values.
+    offset = 0
+    page = {}
+
+    statement_text = 'WHERE status = :status'
+    statement = {
+        :query => statement_text,
+        :values => [
+            {:key => 'status',
+             :value => {:value => 'ACTIVE', :xsi_type => 'TextValue'}}
+        ]
+    }
+
+    begin
+      # Create a statement to get one page with current offset.
+      statement[:query] = statement_text +
+          " LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]
+
+      # Get content by statement.
+      page =
+          content_service.get_content_by_statement_and_custom_targeting_value(
+              statement, category_custom_targeting_value_id)
+
+      if page[:results]
+        # Increase query offset by page size.
+        offset += PAGE_SIZE
+
+        page[:results].each_with_index do |content, index|
+          puts "%d) Content ID: %d, name: %s, status: %s." %
+              [index + start_index, content[:id], content[:name],
+               content[:status]]
+        end
       end
-    end
-  end while offset < page[:total_result_set_size]
+    end while offset < page[:total_result_set_size]
 
-  # Print a footer.
-  if page.include?(:total_result_set_size)
-    puts "Number of results found: %d" % page[:total_result_set_size]
+    # Print a footer.
+    if page.include?(:total_result_set_size)
+      puts "Number of results found: %d" % page[:total_result_set_size]
+    end
+  else
+    puts "Category was not found for targeting key ID %d." %
+        content_browse_custom_targeting_key_id
   end
 end