google-dfp-api 0.9.2 → 0.9.3

data/examples/v201311/company_service/get_company.rb

@@ -1,72 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# Author:: api.dklimkin@gmail.com (Danial Klimkin)
-#
-# Copyright:: Copyright 2011, 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 a company by its ID. To determine which companies exist, run
-# get_all_companies.rb.
-#
-# Tags: CompanyService.getCompany
-
-require 'dfp_api'
-
-API_VERSION = :v201311
-
-def get_company()
-  # 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 CompanyService.
-  company_service = dfp.service(:CompanyService, API_VERSION)
-
-  # Set the ID of the company to get.
-  company_id = 'INSERT_COMPANY_ID_HERE'.to_i
-
-  # Get the company.
-  company = company_service.get_company(company_id)
-
-  if company
-    puts "Company with ID: %d, name: %s and type: %s was found." %
-        [company[:id], company[:name], company[:type]]
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_company()
-
-  # 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/v201311/creative_service/get_creative.rb

@@ -1,72 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# Author:: api.dklimkin@gmail.com (Danial Klimkin)
-#
-# Copyright:: Copyright 2011, 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 a creative by its ID. To determine which creatives exist,
-# run get_all_creatives.rb.
-#
-# Tags: CreativeService.getCreative
-
-require 'dfp_api'
-
-API_VERSION = :v201311
-
-def get_creative()
-  # 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 CreativeService.
-  creative_service = dfp.service(:CreativeService, API_VERSION)
-
-  # Set the ID of the creative to get.
-  creative_id = 'INSERT_CREATIVE_ID_HERE'.to_i
-
-  # Get the creative.
-  creative = creative_service.get_creative(creative_id)
-
-  if creative
-    puts "Creative with ID: %d, name: %s and type: %s was found." %
-        [creative[:id], creative[:name], creative[:creative_type]]
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_creative()
-
-  # 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/v201311/creative_template_service/get_creative_template.rb

@@ -1,74 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# Author:: api.dklimkin@gmail.com (Danial Klimkin)
-#
-# Copyright:: Copyright 2011, 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 a creative template by its ID. To determine which creative
-# templates exist, run get_all_creative_templates.rb.
-#
-# Tags: CreativeTemplateService.getCreativeTemplate
-
-require 'dfp_api'
-
-API_VERSION = :v201311
-
-def get_creative_template()
-  # 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 CreativeTemplateService.
-  creative_template_service = dfp.service(:CreativeTemplateService, API_VERSION)
-
-  # Set the ID of the creative_template to get.
-  creative_template_id = 'INSERT_CREATIVE_ID_HERE'.to_i
-
-  # Get the creative_template.
-  creative_template =
-      creative_template_service.get_creative_template(creative_template_id)
-
-  if creative_template
-    puts "Creative template with ID: %d, name: '%s' and type: '%s' was found." %
-        [creative_template[:id], creative_template[:name],
-         creative_template[:type]]
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_creative_template()
-
-  # 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/v201311/inventory_service/get_ad_unit.rb

@@ -1,72 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# Author:: api.dklimkin@gmail.com (Danial Klimkin)
-#
-# Copyright:: Copyright 2011, 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 an ad unit by its ID. To determine which ad units
-# exist, run get_inventory_tree.rb or get_all_ad_units.rb.
-#
-# Tags: InventoryService.getAdUnit
-
-require 'dfp_api'
-
-API_VERSION = :v201311
-
-def get_ad_unit()
-  # 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 InventoryService.
-  inventory_service = dfp.service(:InventoryService, API_VERSION)
-
-  # Set the ID of the ad unit to get.
-  ad_unit_id = 'INSERT_AD_UNIT_ID_HERE'.to_i
-
-  # Get the ad unit.
-  ad_unit = inventory_service.get_ad_unit(ad_unit_id)
-
-  if ad_unit
-    puts "Ad unit with ID: %d, name: %s and status: %s was found." %
-        [ad_unit[:id], ad_unit[:name], ad_unit[:status]]
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_ad_unit()
-
-  # 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/v201311/label_service/get_label.rb

@@ -1,76 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# Author:: api.dklimkin@gmail.com (Danial Klimkin)
-#
-# Copyright:: Copyright 2011, 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 a label by its ID. To determine which labels exist,
-# run get_all_labels.rb.
-#
-# This feature is only available to DFP premium solution networks.
-#
-# Tags: LabelService.getLabel
-
-require 'dfp_api'
-
-API_VERSION = :v201311
-
-def get_label()
-  # 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 LabelService.
-  label_service = dfp.service(:LabelService, API_VERSION)
-
-  # Set the ID of the label to get.
-  label_id = 'INSERT_LABEL_ID_HERE'.to_i
-
-  # Get the label.
-  label = label_service.get_label(label_id)
-
-  if label
-    puts "Label with ID: %d, name: '%s' and types '%s' was found." %
-        [label[:id], label[:name], label[:types].join(', ')]
-  else
-    puts 'No label found for this ID.'
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_label()
-
-  # 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/v201311/line_item_creative_association_service/get_lica.rb

@@ -1,77 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# Author:: api.dklimkin@gmail.com (Danial Klimkin)
-#
-# Copyright:: Copyright 2011, 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 a line item creative association (LICA) by the line item and
-# creative ID. To determine which line items exist, run get_all_line_items.rb.
-# To determine which creatives exit, run get_all_creatives.rb.
-#
-# Tags: LineItemCreativeAssociationService.getLineItemCreativeAssociation
-
-require 'dfp_api'
-
-API_VERSION = :v201311
-
-def get_lica()
-  # 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 LineItemCreativeAssociationService.
-  lica_service = dfp.service(:LineItemCreativeAssociationService, API_VERSION)
-
-  # Set the line item and creative IDs to use to retrieve the LICA.
-  line_item_id = 'INSERT_LINE_ITEM_ID_HERE'.to_i
-  creative_id = 'INSERT_CREATIVE_ID_HERE'.to_i
-
-  # Get the LICA.
-  lica =
-      lica_service.get_line_item_creative_association(line_item_id, creative_id)
-
-  if lica
-    puts ("LICA with line item ID: %d, creative ID: %d and status: %s was " +
-        "found.") % [lica[:line_item_id], lica[:creative_id], lica[:status]]
-  else
-    puts 'No lica found for this ID.'
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_lica()
-
-  # 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