google-dfp-api 0.18.0 → 0.19.0

data/examples/v201605/content_metadata_key_hierarchy_service/get_all_content_metadata_key_hierarchies.rb

@@ -1,85 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# Copyright:: Copyright 2014, 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 content metadata key hierarchies.
-#
-# This feature is only available to DFP video publishers.
-
-require 'dfp_api'
-
-
-API_VERSION = :v201605
-
-def get_all_content_metadata_key_hierarchies()
-  # 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 ContentMetadataKeyHierarchyService.
-  cmkh_service = dfp.service(:ContentMetadataKeyHierarchyService, API_VERSION)
-
-  # Create statement for one page with current offset.
-  statement = DfpApi::FilterStatement.new('ORDER BY id ASC')
-
-  begin
-
-    # Get content metadata key hierarchies by statement.
-    page = cmkh_service.get_content_metadata_key_hierarchies_by_statement(
-        statement.toStatement())
-
-    if page[:results]
-      page[:results].each_with_index do |content_metadata_key_hierarchy, index|
-        puts ("%d) Content Metadata Key Hierarchy ID: " +
-            "%d and name: %s was found.") % [
-                index + statement.offset,
-                content_metadata_key_hierarchy[:id],
-                content_metadata_key_hierarchy[: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 results: %d" % page[:total_result_set_size]
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_all_content_metadata_key_hierarchies()
-
-  # 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/content_metadata_key_hierarchy_service/update_content_metadata_key_hierarchies.rb

@@ -1,110 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# Copyright:: Copyright 2014, 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 a single content metadata key hierarchy.
-#
-# This feature is only available to DFP video publishers.
-
-require 'dfp_api'
-
-
-API_VERSION = :v201605
-
-def update_content_metadata_key_hierarchies()
-  # 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 ContentMetadataKeyHierarchyService.
-  cmkh_service = dfp.service(:ContentMetadataKeyHierarchyService, API_VERSION)
-
-  # Set the ID of the content metadata key hierarchy.
-  content_metadata_key_hierarchy_id =
-      'INSERT_CONTENT_METADATA_KEY_HIERARCHY_ID_HERE'
-
-  # Set the ID of the custom targeting key to be added as a hierarchy level.
-  custom_targeting_key_id = "INSERT_CUSTOM_TARGETING_KEY_ID_HERE"
-
-  # Create a statement to only select a single content metadata key hierarchy.
-  statement = DfpApi::FilterStatement.new(
-      'WHERE id = :id ORDER BY id ASC',
-      [
-          {:key => 'id',
-           :value => {:value => content_metadata_key_hierarchy_id,
-                      :xsi_type => 'NumberValue'}},
-      ],
-      1
-  }
-
-  # Get content metadata key hierarchies by statement.
-  page = cmkh_service.get_content_metadata_key_hierarchies_by_statement(
-      statement.toStatement())
-
-  if page[:results]
-    content_metadata_key_hierarchy = page[:results].first
-
-    # Update the content metadata key hierarchy by adding a hierarchy level.
-    hierarchy_levels = content_metadata_key_hierarchy[:hierarchy_levels]
-
-    hierarchy_level = {
-      :custom_targeting_key_id => custom_targeting_key_id,
-      :hierarchy_level => hierarchy_levels.length + 1
-    }
-
-    content_metadata_key_hierarchy[:hierarchy_levels] =
-        hierarchy_levels.concat([hierarchy_level])
-
-    # Update content metadata key hierarchy.
-    content_metadata_key_hierarchies =
-        cmkh_service.update_content_metadata_key_hierarchies(
-            [content_metadata_key_hierarchy])
-
-    content_metadata_key_hierarchies.each do |content_metadata_key_hierarchy|
-      puts 'Content metadata key hierarchy with ID ' +
-           '%d, name "%s" was updated.' % [
-               content_metadata_key_hierarchy[:id],
-               content_metadata_key_hierarchy[:name]]
-    end
-  else
-    puts 'No content metadata key hierarchy found to update.'
-  end
-end
-
-if __FILE__ == $0
-  begin
-    update_content_metadata_key_hierarchies()
-
-  # 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/content_service/get_all_content.rb

@@ -1,81 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# 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 all content.
-#
-# This feature is only available to DFP video publishers.
-
-require 'dfp_api'
-
-
-API_VERSION = :v201605
-
-def get_all_content()
-  # 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 ContentService.
-  content_service = dfp.service(:ContentService, API_VERSION)
-
-  # Create statement for one page with current offset.
-  statement = DfpApi::FilterStatement.new('ORDER BY id ASC')
-
-  begin
-    # Get content by statement.
-    page = content_service.get_content_by_statement(statement.toStatement())
-
-    if page[:results]
-      page[:results].each_with_index do |content, index|
-        puts "%d) Content ID: %d, name: %s, status: %s." % [
-             index + statement.offset,
-             content[:id], content[:name], content[:status]]
-      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 results: %d" % page[:total_result_set_size]
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_all_content()
-
-  # 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/content_service/get_content_by_category.rb

@@ -1,127 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# 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 all active content categorized as "comedy" using the
-# network's content browse custom targeting key.
-#
-# This feature is only available to DFP video publishers.
-
-require 'dfp_api'
-
-
-API_VERSION = :v201605
-
-def get_content_by_statement()
-  # 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 NetworkService.
-  network_service = dfp.service(:NetworkService, API_VERSION)
-
-  # Get content browse custom targeting key ID.
-  current_network = network_service.get_current_network
-  content_browse_custom_targeting_key_id =
-      current_network[:content_browse_custom_targeting_key_id]
-
-  # Get the CustomTargetingService.
-  custom_targeting_service = dfp.service(:CustomTargetingService, API_VERSION)
-
-  # Create a statement to select the categories matching the name comedy.
-  statement = DfpApi::FilterStatement.new(
-      'WHERE customTargetingKeyId = :targeting_key_id' +
-      ' and name = :category ORDER BY id ASC',
-      [
-          {:key => 'targeting_key_id',
-           :value => {:value => content_browse_custom_targeting_key_id,
-                      :xsi_type => 'NumberValue'}},
-          {:key => 'category',
-           :value => {:value => 'comedy',
-                      :xsi_type => 'TextValue'}},
-      ],
-      1
-  )
-
-  # Get categories matching the filter statement.
-  page = custom_targeting_service.get_custom_targeting_values_by_statement(
-      statement.toStatement())
-
-  # Get the custom targeting value ID for the comedy category.
-  if page[:results]
-    category_custom_targeting_value_id = page[:results].first()[:id]
-
-    # Get the ContentService.
-    content_service = dfp.service(:ContentService, API_VERSION)
-
-    statement = DfpApi::FilterStatement.new(
-        'WHERE status = :status ORDER BY id ASC',
-        [
-            {:key => 'status',
-             :value => {:value => 'ACTIVE', :xsi_type => 'TextValue'}}
-        ]
-    )
-
-    begin
-      # Get content by statement.
-      page =
-          content_service.get_content_by_statement_and_custom_targeting_value(
-              statement.toStatement(), category_custom_targeting_value_id)
-
-      if page[:results]
-        page[:results].each_with_index do |content, index|
-          puts "%d) Content ID: %d, name: %s, status: %s." %
-              [index + statement.offset, content[:id], content[:name],
-               content[:status]]
-        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 "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
-
-if __FILE__ == $0
-  begin
-    get_content_by_statement()
-
-  # 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/creative_service/copy_image_creatives.rb

@@ -1,111 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# 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 copies a given set of image creatives. This would typically be
-# done to reuse creatives in a small business network. To determine which
-# creatives exist, run get_all_creatives.rb.
-
-require 'dfp_api'
-
-require 'base64'
-
-API_VERSION = :v201605
-
-def copy_image_creatives()
-  # 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)
-
-  # Create a list of creative ids to copy.
-  image_creative_ids = [
-      'INSERT_IMAGE_CREATIVE_ID_HERE'.to_i,
-      'INSERT_IMAGE_CREATIVE_ID_HERE'.to_i,
-      'INSERT_IMAGE_CREATIVE_ID_HERE'.to_i,
-      'INSERT_IMAGE_CREATIVE_ID_HERE'.to_i
-  ]
-
-  # Create the statement to filter image creatives by ID.
-  statement = DfpApi::FilterStatement.new(
-      "WHERE id IN (%s) AND creativeType = :creative_type" %
-          image_creative_ids.join(', '),
-      [
-          {:key => 'creative_type',
-           :value => {:value => 'ImageCreative', :xsi_type => 'TextValue'}}
-      ]
-  )
-
-  # Get creatives by statement.
-  page = creative_service.get_creatives_by_statement(statement.toStatement())
-
-  if page[:results]
-    creatives = page[:results]
-
-    # Copy each local creative object and change its name.
-    new_creatives = creatives.map do |creative|
-      new_creative = creative.dup()
-      old_id = new_creative.delete(:id)
-      new_creative[:name] += " (Copy of %d)" % old_id
-      image_url = new_creative.delete(:image_url)
-      new_creative[:image_byte_array] =
-          Base64.encode64(AdsCommon::Http.get(image_url, dfp.config))
-      new_creative
-    end
-
-    # Create the creatives on the server.
-    return_creatives = creative_service.create_creatives(new_creatives)
-
-    # Display copied creatives.
-    if return_creatives
-      return_creatives.each_with_index do |creative, index|
-        puts "A creative with ID [%d] was copied to ID [%d], name: %s" %
-            [creatives[index][:id], creative[:id], creative[:name]]
-      end
-    else
-      raise 'No creatives were copied.'
-    end
-  else
-    puts 'No creatives found to copy.'
-  end
-end
-
-if __FILE__ == $0
-  begin
-    copy_image_creatives()
-
-  # 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