google-dfp-api 0.4.0 → 0.5.0

data/examples/v201211/custom_field_service/create_custom_field_options.rb

@@ -0,0 +1,87 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Author:: api.dklimkin@gmail.com (Danial Klimkin)
+#
+# Copyright:: Copyright 2012, 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 creates custom field options for a drop-down custom field. Once
+# created, custom field options can be found under the options fields of the
+# drop-down custom field and they cannot be deleted. To determine which custom
+# fields exist, run get_all_custom_fields.rb.
+#
+# Tags: CustomFieldService.createCustomFieldOptions
+
+require 'dfp_api'
+
+API_VERSION = :v201211
+
+def create_custom_field_options()
+  # 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 CustomFieldService.
+  custom_field_service = dfp.service(:CustomFieldService, API_VERSION)
+
+  # Set the ID of the drop-down custom field to create options for.
+  custom_field_id = 'INSERT_DROP_DOWN_CUSTOM_FIELD_ID_HERE'.to_i
+
+  # Create local custom field options.
+  custom_field_options = [
+    {
+      :display_name => 'Approved',
+      :custom_field_id => custom_field_id
+    },
+    {
+      :display_name => 'Unapproved',
+      :custom_field_id => custom_field_id
+     }
+  ]
+
+  # Create the custom field options on the server.
+  return_custom_field_options =
+      custom_field_service.create_custom_field_options(custom_field_options)
+
+  return_custom_field_options.each do |option|
+    puts "Custom field option with ID: %d and name: '%s' was created." %
+        [option[:id], option[:display_name]]
+  end
+end
+
+if __FILE__ == $0
+  begin
+    create_custom_field_options()
+
+  # 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/{v201108/company_service/get_company.rb → v201211/custom_field_service/create_custom_fields.rb}

@@ -1,8 +1,9 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
-# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
+# Copyright:: Copyright 2012, 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.
@@ -17,16 +18,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 custom fields. To determine which custom fields exist,
+# run get_all_custom_fields.rb.
 #
-# Tags: CompanyService.getCompany
+# Tags: CustomFieldService.createCustomFields
 
 require 'dfp_api'
 
-API_VERSION = :v201108
+API_VERSION = :v201211
 
-def get_company()
+def create_custom_fields()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
   dfp = DfpApi::Api.new
 
@@ -34,24 +35,38 @@ 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 CustomFieldService.
+  custom_field_service = dfp.service(:CustomFieldService, API_VERSION)
 
-  # Set the ID of the company to get.
-  company_id = 'INSERT_COMPANY_ID_HERE'.to_i
+  # Create local custom field objects.
+  custom_fields = [
+    {
+      :name => 'Customer comments',
+      :entity_type => 'LINE_ITEM',
+      :data_type => 'STRING',
+      :visibility => 'FULL'
+    },
+    {
+      :name => 'Internal approval status',
+      :entity_type => 'LINE_ITEM',
+      :data_type => 'DROP_DOWN',
+      :visibility => 'FULL'
+    }
+  ]
 
-  # Get the company.
-  company = company_service.get_company(company_id)
+  # Create the custom fields on the server.
+  return_custom_fields =
+      custom_field_service.create_custom_fields(custom_fields)
 
-  if company
-    puts "Company with ID: %d, name: %s and type: %s was found." %
-        [company[:id], company[:name], company[:type]]
+  return_custom_fields.each do |custom_field|
+    puts "Custom field with ID: %d and name: %s was created." %
+        [custom_field[:id], custom_field[:name]]
   end
 end
 
 if __FILE__ == $0
   begin
-    get_company()
+    create_custom_fields()
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/{v201201/label_service/deactivate_labels.rb → v201211/custom_field_service/deactivate_all_line_item_custom_fields.rb}

@@ -1,8 +1,9 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
-# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
+# Copyright:: Copyright 2012, 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.
@@ -17,19 +18,18 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example deactivates all active labels. To determine which labels exist,
-# run get_all_labels.rb.
+# This example deactivates all active line item custom fields. To determine
+# which custom fields exist, run get_all_custom_fields.rb.
 #
-# This feature is only available to DFP premium solution networks.
-#
-# Tags: LabelService.getLabelsByStatement, LabelService.performLabelAction
+# Tags: CustomFieldService.getCustomFieldsByStatement
+# Tags: CustomFieldService.performCustomFieldAction
 
 require 'dfp_api'
 
-API_VERSION = :v201201
+API_VERSION = :v201211
 PAGE_SIZE = 500
 
-def deactivate_labels()
+def deactivate_all_line_item_custom_fields()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
   dfp = DfpApi::Api.new
 
@@ -37,13 +37,15 @@ def deactivate_labels()
   # the configuration file or provide your own logger:
   # dfp.logger = Logger.new('dfp_xml.log')
 
-  # Get the LabelService.
-  label_service = dfp.service(:LabelService, API_VERSION)
+  # Get the CustomFieldService.
+  custom_field_service = dfp.service(:CustomFieldService, API_VERSION)
 
-  # Create statement text and statement to select active labels.
-  statement_text = 'WHERE isActive = :is_active'
+  # Create statement text to select active ad units.
+  statement_text = 'WHERE entityType = :entity_type AND isActive = :is_active'
   statement = {
       :values => [
+          {:key => 'entity_type',
+           :value => {:value => 'LINE_ITEM', :xsi_type => 'TextValue'}},
           {:key => 'is_active',
            :value => {:value => true, :xsi_type => 'BooleanValue'}}
       ]
@@ -52,52 +54,45 @@ def deactivate_labels()
   # Define initial values.
   offset = 0
   page = {}
-  label_ids = []
 
   begin
-    # Modify the statement to get one page with current offset.
+    # Create a statement to get one page with the current offset.
     statement[:query] = statement_text +
         " LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]
 
-    # Get labels by statement.
-    page = label_service.get_labels_by_statement(statement)
+    # Get custom fields by statement.
+    page = custom_field_service.get_custom_fields_by_statement(statement)
 
     if page[:results]
       # Increase query offset by page size.
       offset += PAGE_SIZE
+      start_index = page[:start_index]
 
-      page[:results].each do |label|
-        puts ("%d) Label ID: %d, name: %s will be deactivated.") %
-            [label_ids.size, label[:id], label[:name]]
-        label_ids << label[:id]
+      page[:results].each_with_index do |custom_field, index|
+        puts "%d) Custom field with ID: %d and name: '%s' will be deactivated" %
+            [index + start_index, custom_field[:id], custom_field[:name]]
       end
     end
   end while offset < page[:total_result_set_size]
 
-  puts "Number of labels to be deactivated: %d" % label_ids.size
-
-  if !label_ids.empty?
-    # Create a statement for action.
-    statement = {:query => "WHERE id IN (%s)" % label_ids.join(', ')}
+  # Update statement for action.
+  statement[:query] = statement_text
 
-    # Perform action.
-    result = label_service.perform_label_action(
-        {:xsi_type => 'DeactivateLabels'}, statement)
+  # Perform action.
+  result = custom_field_service.perform_custom_field_action(
+        {:xsi_type => 'DeactivateCustomFields'}, statement)
 
-    # Display results.
-    if result and result[:num_changes] > 0
-      puts "Number of labels deactivated: %d" % result[:num_changes]
-    else
-      puts 'No labels were deactivated.'
-    end
+  # Display results.
+  if result and result[:num_changes] > 0
+    puts "Number of custom fields deactivated: %d" % result[:num_changes]
   else
-    puts 'No labels found to deactivate.'
+    puts 'No custom fields were deactivated.'
   end
 end
 
 if __FILE__ == $0
   begin
-    deactivate_labels()
+    deactivate_all_line_item_custom_fields()
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/{v201108/line_item_service/get_all_line_items.rb → v201211/custom_field_service/get_all_custom_fields.rb}

@@ -1,8 +1,9 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
-# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
+# Copyright:: Copyright 2012, 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.
@@ -17,17 +18,17 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example gets all line items. To create line items, run
-# create_line_items.rb.
+# This example gets all custom fields. To create custom fields, run
+# create_custom_fields.rb.
 #
-# Tags: LineItemService.getLineItemsByStatement
+# Tags: CustomFieldService.getCustomFieldsByStatement
 
 require 'dfp_api'
 
-API_VERSION = :v201108
+API_VERSION = :v201211
 PAGE_SIZE = 500
 
-def get_all_line_items()
+def get_all_custom_fields()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
   dfp = DfpApi::Api.new
 
@@ -35,8 +36,8 @@ def get_all_line_items()
   # the configuration file or provide your own logger:
   # dfp.logger = Logger.new('dfp_xml.log')
 
-  # Get the LineItemService.
-  line_item_service = dfp.service(:LineItemService, API_VERSION)
+  # Get the CustomFieldService.
+  custom_field_service = dfp.service(:CustomFieldService, API_VERSION)
 
   # Define initial values.
   offset = 0
@@ -46,8 +47,8 @@ def get_all_line_items()
     # Create a statement to get one page with current offset.
     statement = {:query => "LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]}
 
-    # Get line items by statement.
-    page = line_item_service.get_line_items_by_statement(statement)
+    # Get custom fields by statement.
+    page = custom_field_service.get_custom_fields_by_statement(statement)
 
     if page[:results]
       # Increase query offset by page size.
@@ -56,24 +57,32 @@ def get_all_line_items()
       # Get the start index for printout.
       start_index = page[:start_index]
 
-      # Print details about each line item in results.
-      page[:results].each_with_index do |line_item, index|
-        puts "%d) Line item ID: %d, order ID: %d, name: %s" %
-            [index + start_index, line_item[:id],
-             line_item[:order_id], line_item[:name]]
+      # Print details about each custom field in results.
+      page[:results].each_with_index do |custom_field, index|
+        if custom_field[:custom_field_type].eql?('DropDownCustomField')
+          drop_down_custom_field_string = custom_field.include?(:options) ?
+              custom_field[:options].map {|option| option[:display_name]} : []
+          print ("%d) Drop-down custom field with ID %d, name '%s', and " +
+              "options [%s] was found.") %
+              [index + start_index, custom_field[:id], custom_field[:name],
+               drop_down_custom_field_strings.join(', ')]
+        else
+          puts "%d) Custom field ID: %d and name: '%s' was found" %
+              [index + start_index, custom_field[:id], custom_field[:name]]
+        end
       end
     end
   end while offset < page[:total_result_set_size]
 
   # Print a footer.
   if page.include?(:total_result_set_size)
-    puts "Total number of line items: %d" % page[:total_result_set_size]
+    puts "Total number of custom fields: %d" % page[:total_result_set_size]
   end
 end
 
 if __FILE__ == $0
   begin
-    get_all_line_items()
+    get_all_custom_fields()
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/{v201108/company_service/get_companies_by_statement.rb → v201211/custom_field_service/get_all_line_item_custom_fields.rb}

@@ -1,8 +1,9 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
-# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
+# Copyright:: Copyright 2012, 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.
@@ -17,17 +18,16 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example gets all companies that are advertisers. The statement retrieves
-# up to the maximum page size limit of 500. To create companies, run
-# create_companies.rb.
+# This example gets all custom fields that apply to line items. To create custom
+# fields, run create_custom_fields.rb.
 #
-# Tags: CompanyService.getCompaniesByStatement
+# Tags: CustomFieldService.getCustomFieldsByStatement
 
 require 'dfp_api'
 
-API_VERSION = :v201108
+API_VERSION = :v201211
 
-def get_companies_by_statement()
+def get_all_line_item_custom_fields()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
   dfp = DfpApi::Api.new
 
@@ -35,39 +35,38 @@ def get_companies_by_statement()
   # 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 CustomFieldService.
+  custom_field_service = dfp.service(:CustomFieldService, API_VERSION)
 
-  # Create a statement to only select companies that are advertisers, sorted by
-  # name.
+  # Create statement to select only custom fields that apply to line items.
   statement = {
-     :query => 'WHERE type = :type ORDER BY name LIMIT 500',
+     :query => 'WHERE entityType = :entity_type',
      :values => [
-         {:key => 'type',
-          :value => {:value => 'ADVERTISER', :xsi_type => 'TextValue'}}
+         {:key => 'entity_type',
+          :value => {:value => 'LINE_ITEM', :xsi_type => 'TextValue'}}
      ]
   }
 
-  # Get companies by statement.
-  page = company_service.get_companies_by_statement(statement)
+  # Get custom fields by statement.
+  page = custom_field_service.get_custom_fields_by_statement(statement)
 
   if page[:results]
-    # Print details about each company in results.
-    page[:results].each_with_index do |company, index|
-      puts "%d) [%d] name: %s, type: %s" %
-          [index, company[:id], company[:name], company[:type]]
+    # Print details about each custom field in results.
+    page[:results].each_with_index do |custom_field, index|
+      puts "%d) Custom field with ID %d and name: '%s' was found." %
+          [index, custom_field[:id], custom_field[:name]]
     end
   end
 
   # Print a footer.
   if page.include?(:total_result_set_size)
-    puts "Total number of companies: %d" % page[:total_result_set_size]
+    puts "Total number of custom fields: %d" % page[:total_result_set_size]
   end
 end
 
 if __FILE__ == $0
   begin
-    get_companies_by_statement()
+    get_all_line_item_custom_fields()
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e