google-dfp-api 0.6.3 → 0.7.0

data/examples/v201206/custom_field_service/create_custom_fields.rb

@@ -1,86 +0,0 @@
-#!/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 fields. To determine which custom fields exist,
-# run get_all_custom_fields.rb.
-#
-# Tags: CustomFieldService.createCustomFields
-
-require 'dfp_api'
-
-API_VERSION = :v201206
-
-def create_custom_fields()
-  # 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)
-
-  # 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'
-    }
-  ]
-
-  # Create the custom fields on the server.
-  return_custom_fields =
-      custom_field_service.create_custom_fields(custom_fields)
-
-  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
-    create_custom_fields()
-
-  # 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/custom_field_service/deactivate_all_line_item_custom_fields.rb

@@ -1,112 +0,0 @@
-#!/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 deactivates all active line item custom fields. To determine
-# which custom fields exist, run get_all_custom_fields.rb.
-#
-# Tags: CustomFieldService.getCustomFieldsByStatement
-# Tags: CustomFieldService.performCustomFieldAction
-
-require 'dfp_api'
-
-API_VERSION = :v201206
-PAGE_SIZE = 500
-
-def deactivate_all_line_item_custom_fields()
-  # 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)
-
-  # 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'}}
-      ]
-  }
-
-  # Define initial values.
-  offset = 0
-  page = {}
-
-  begin
-    # Create a statement to get one page with the current offset.
-    statement[:query] = statement_text +
-        " LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]
-
-    # 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_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]
-
-  # Update statement for action.
-  statement[:query] = statement_text
-
-  # 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 custom fields deactivated: %d" % result[:num_changes]
-  else
-    puts 'No custom fields were deactivated.'
-  end
-end
-
-if __FILE__ == $0
-  begin
-    deactivate_all_line_item_custom_fields()
-
-  # 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/custom_field_service/get_all_custom_fields.rb

@@ -1,102 +0,0 @@
-#!/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 gets all custom fields. To create custom fields, run
-# create_custom_fields.rb.
-#
-# Tags: CustomFieldService.getCustomFieldsByStatement
-
-require 'dfp_api'
-
-API_VERSION = :v201206
-PAGE_SIZE = 500
-
-def get_all_custom_fields()
-  # 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)
-
-  # Define initial values.
-  offset = 0
-  page = {}
-
-  begin
-    # Create a statement to get one page with current offset.
-    statement = {:query => "LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]}
-
-    # 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
-
-      # Get the start index for printout.
-      start_index = page[:start_index]
-
-      # 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 custom fields: %d" % page[:total_result_set_size]
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_all_custom_fields()
-
-  # 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/custom_field_service/get_all_line_item_custom_fields.rb

@@ -1,86 +0,0 @@
-#!/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 gets all custom fields that apply to line items. To create custom
-# fields, run create_custom_fields.rb.
-#
-# Tags: CustomFieldService.getCustomFieldsByStatement
-
-require 'dfp_api'
-
-API_VERSION = :v201206
-
-def get_all_line_item_custom_fields()
-  # 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)
-
-  # Create statement to select only custom fields that apply to line items.
-  statement = {
-     :query => 'WHERE entityType = :entity_type',
-     :values => [
-         {:key => 'entity_type',
-          :value => {:value => 'LINE_ITEM', :xsi_type => 'TextValue'}}
-     ]
-  }
-
-  # Get custom fields by statement.
-  page = custom_field_service.get_custom_fields_by_statement(statement)
-
-  if page[:results]
-    # 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 custom fields: %d" % page[:total_result_set_size]
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_all_line_item_custom_fields()
-
-  # 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/custom_field_service/update_custom_fields.rb

@@ -1,83 +0,0 @@
-#!/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 updates custom field descriptions. To determine which custom
-# fields exist, run get_all_custom_fields.rb.
-#
-# Tags: CustomFieldService.updateCustomFields
-
-require 'dfp_api'
-
-API_VERSION = :v201206
-
-def update_custom_fields()
-  # 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 custom field to update.
-  custom_field_id = 'INSERT_CUSTOM_FIELD_ID_HERE'.to_i
-
-  # Get custom field.
-  custom_field = custom_field_service.get_custom_field(custom_field_id)
-
-  if custom_field
-    # Update local custom field object.
-    custom_field[:description] += ' Updated.'
-
-    # Update the custom field on the server.
-    return_custom_fields =
-        custom_field_service.update_custom_fields([custom_field])
-
-    return_custom_fields.each do |custom_field|
-      puts "Custom field ID: %d, name: '%s' and description '%s' was updated." %
-          [custom_field[:id], custom_field[:name], custom_field[:description]]
-    end
-  else
-    puts 'No custom fields were found to update.'
-  end
-end
-
-if __FILE__ == $0
-  begin
-    update_custom_fields()
-
-  # 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