google-dfp-api 0.18.0 → 0.19.0

data/examples/v201605/custom_field_service/create_custom_fields.rb

@@ -1,82 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# 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.
-
-require 'dfp_api'
-
-API_VERSION = :v201605
-
-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/v201605/custom_field_service/deactivate_all_line_item_custom_fields.rb

@@ -1,97 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# 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.
-
-require 'dfp_api'
-
-
-API_VERSION = :v201605
-
-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 = DfpApi::FilterStatement.new(
-      'WHERE entityType = :entity_type AND isActive = :is_active',
-      [
-          {:key => 'entity_type',
-           :value => {:value => 'LINE_ITEM', :xsi_type => 'TextValue'}},
-          {:key => 'is_active',
-           :value => {:value => true, :xsi_type => 'BooleanValue'}}
-      ]
-  )
-
-  begin
-    # Get custom fields by statement.
-    page = custom_field_service.get_custom_fields_by_statement(
-        statement.toStatement())
-
-    if page[:results]
-      page[:results].each_with_index do |custom_field, index|
-        puts "%d) Custom field with ID: %d and name: '%s' will be deactivated" %
-            [index + statement.offset, custom_field[:id], custom_field[:name]]
-      end
-    end
-    statement.offset += DfpApi::SUGGESTED_PAGE_LIMIT
-  end while statement.offset < page[:total_result_set_size]
-
-  # Update statement for action.
-  statement.toStatementForAction()
-
-  # Perform action.
-  result = custom_field_service.perform_custom_field_action(
-        {:xsi_type => 'DeactivateCustomFields'}, statement.toStatement())
-
-  # 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/v201605/custom_field_service/get_all_custom_fields.rb

@@ -1,90 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# 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.
-
-require 'dfp_api'
-
-
-API_VERSION = :v201605
-
-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)
-
-  # Create a statement to get one page with current offset.
-  statement = DfpApi::FilterStatement.new('ORDER BY id')
-
-  begin
-    # Get custom fields by statement.
-    page = custom_field_service.get_custom_fields_by_statement(
-        statement.toStatement())
-
-    if page[:results]
-      # 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_strings = custom_field.include?(:options) ?
-              custom_field[:options].map {|option| option[:display_name]} : []
-          puts ("%d) Drop-down custom field with ID %d, name '%s', and " +
-              "options [%s] was found.") %
-              [index + statement.offset, 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 + statement.offset, custom_field[:id], custom_field[:name]]
-        end
-      end
-    end
-    statement.offset += DfpApi::SUGGESTED_PAGE_LIMIT
-  end while statement.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/v201605/custom_field_service/get_all_line_item_custom_fields.rb

@@ -1,87 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# 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.
-
-require 'dfp_api'
-
-
-API_VERSION = :v201605
-
-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 = DfpApi::FilterStatement.new(
-     'WHERE entityType = :entity_type ORDER BY id ASC',
-     [
-         {:key => 'entity_type',
-          :value => {:value => 'LINE_ITEM', :xsi_type => 'TextValue'}}
-     ]
-  )
-
-  begin
-    # Get custom fields by statement.
-    page = custom_field_service.get_custom_fields_by_statement(
-        statement.toStatement())
-
-    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 + statement.offset, custom_field[:id], custom_field[:name]]
-      end
-    end
-    statement.offset += DfpApi::SUGGESTED_PAGE_LIMIT
-  end while statement.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_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/v201605/custom_field_service/set_line_item_custom_field_value.rb

@@ -1,178 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# 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 sets custom field values on a line item. To determine which
-# custom fields exist, run get_all_custom_fields.rb. To determine which line
-# items exist, run get_all_line_items.rb. To create custom field options, run
-# create_custom_field_options.rb.
-
-require 'dfp_api'
-
-
-API_VERSION = :v201605
-
-def set_line_item_custom_field_value()
-  # 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)
-
-  # Get the LineItemService.
-  line_item_service = dfp.service(:LineItemService, API_VERSION)
-
-  # Set the ID of the custom fields, custom field option, and line item.
-  custom_field_id = 'INSERT_CUSTOM_FIELD_ID_HERE'.to_i
-  drop_down_custom_field_id = 'INSERT_DROP_DOWN_CUSTOM_FIELD_ID_HERE'.to_i
-  custom_field_option_id = 'INSERT_CUSTOM_FIELD_OPTION_ID_HERE'.to_i
-  line_item_id = 'INSERT_LINE_ITEM_ID_HERE'.to_i
-
-  # Create a statement to only select a single custom field.
-  custom_field_statement = DfpApi::FilterStatement.new(
-      'WHERE id = :id ORDER BY id ASC',
-      [
-          {:key => 'id',
-           :value => {:value => custom_field_id, :xsi_type => 'NumberValue'}}
-      ],
-      1
-  )
-
-  # Create a statement to only select a single drop down custom field.
-  drop_down_custom_field_statement = DfpApi::FilterStatement.new(
-      'WHERE id = :id ORDER BY id ASC',
-      [
-          {:key => 'id',
-           :value => {:value => drop_down_custom_field_id,
-                      :xsi_type => 'NumberValue'}}
-      ],
-      1
-  )
-
-  # Create a statement to only select a single line item.
-  line_item_statement = DfpApi::FilterStatement.new(
-      'WHERE id = :id ORDER BY id ASC',
-      [
-          {:key => 'id',
-           :value => {:value => line_item_id, :xsi_type => 'NumberValue'}}
-      ],
-      1
-  )
-
-  # Get custom fields by statement.
-  custom_fields_page = custom_field_service.get_custom_fields_by_statement(
-      custom_field_statement.toStatement())
-
-  # Get drop down custom fields by statement.
-  drop_down_custom_fields_page = (
-      custom_field_service.get_custom_fields_by_statement(
-          drop_down_custom_field_statement.toStatement()))
-
-  # Get line items by statement.
-  line_items_page = line_item_service.get_line_items_by_statement(
-      line_item_statement.toStatement())
-
-  # Get singular custom field.
-  if custom_field_page[:results]
-    custom_field = custom_fields_page[:results].first
-
-  # Get singular drop down custom field.
-  if drop_down_custom_field_page[:results]
-    drop_down_custom_field = drop_down_custom_fields_page[:results].first
-
-  # Get singular line item.
-  if line_item_page[:results]
-    line_item = line_items_page[:results].first
-
-  if custom_field and drop_down_custom_field and line_item
-    # Create custom field values.
-    custom_field_value = {
-      :custom_field_id => custom_field[:id],
-      :type => 'CustomFieldValue',
-      :value => {:type => 'TextValue', :value => 'Custom field value'}
-    }
-
-    drop_down_custom_field_value = {
-      :custom_field_id => drop_down_custom_field[:id],
-      :type => 'DropDownCustomFieldValue',
-      :custom_field_option_id => custom_field_option_id
-    }
-
-    custom_field_values = [custom_field_value, drop_down_custom_field_value]
-    old_custom_field_values = line_item.include?(:custom_field_values) ?
-      line_item[:custom_field_values] : []
-
-    # Only add existing custom field values for different custom fields than the
-    # ones you are setting.
-    old_custom_field_values.each do |old_custom_field_value|
-      unless custom_field_values.map {|value| value[:id]}.include?(
-          old_custom_field_value[:custom_field_id])
-        custom_field_values << old_custom_field_value
-      end
-    end
-
-    line_item[:custom_field_values] = custom_field_values
-
-    # Update the line item on the server.
-    return_line_items = line_item_service.update_line_items([line_item])
-
-    return_line_items.each do |return_line_item|
-      custom_field_value_strings = []
-      if return_line_item.include?(:custom_field_values)
-        return_line_item[:custom_field_values].each do |value|
-          if value[:base_custom_field_value_type].eql?('CustomFieldValue')
-            custom_field_value_strings << "{ID: %d, value: '%s'}" %
-                [value[:custom_field_id], value[:value][:value]]
-          end
-          if value[:base_custom_field_value_type].eql?(
-              'DropDownCustomFieldValue')
-            custom_field_value_strings <<
-                "{ID: %d, custom field option ID: %d}" %
-                [value[:custom_field_id], value[:custom_field_option_id]]
-          end
-        end
-      end
-      puts "Line item ID %d set with custom field values: [%s]" %
-          [return_line_item[:id], custom_field_value_strings.join(', ')]
-    end
-  end
-end
-
-if __FILE__ == $0
-  begin
-    set_line_item_custom_field_value()
-
-  # 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