google-dfp-api 0.17.0 → 0.19.0

data/examples/v201508/contact_service/get_all_contacts.rb

@@ -1,80 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# Copyright:: Copyright 2013, 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 contacts. To create contacts, run create_contacts.rb.
-
-require 'dfp_api'
-
-
-API_VERSION = :v201508
-
-def get_all_contacts()
-  # 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 ContactService.
-  contact_service = dfp.service(:ContactService, API_VERSION)
-
-  # Create statement for one page with current offset.
-  statement = DfpApi::FilterStatement.new('ORDER BY id ASC')
-
-  begin
-    # Get contacts by statement.
-    page = contact_service.get_contacts_by_statement(
-        statement.toStatement())
-
-    if page[:results]
-      page[:results].each_with_index do |contact, index|
-        puts "%d) Contact ID: %d, name: '%s'" %
-            [index + statement.offset,
-             contact[:id], contact[: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_contacts()
-
-  # 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/v201508/contact_service/get_uninvited_contacts.rb

@@ -1,94 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# Copyright:: Copyright 2013, 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 uninvited contacts. To create contacts, run
-# create_contacts.rb.
-
-require 'dfp_api'
-
-
-API_VERSION = :v201508
-PAGE_SIZE = 500
-
-def get_uninvited_contacts()
-  # 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 ContactService.
-  contact_service = dfp.service(:ContactService, API_VERSION)
-
-  # Define initial values.
-  offset = 0
-  page = {}
-  query_base = 'WHERE status = :status ORDER BY id ASC LIMIT %d OFFSET %d'
-
-  # Create statement.
-
-  statement = DfpApi::FilterStatement.new(
-      'WHERE status = :status ORDER BY id ASC',
-      [
-          {:key => 'status',
-           :value => {:value => 'UNINVITED', :xsi_type => 'TextValue'}}
-      ]
-  )
-
-  begin
-    # Get contacts by statement.
-    page = contact_service.get_contacts_by_statement(
-        statement.toStatement())
-
-    if page[:results]
-      page[:results].each_with_index do |contact, index|
-        puts "%d) Contact ID: %d, name: '%s'" %
-            [index + statement.offset,
-             contact[:id], contact[: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_uninvited_contacts()
-
-  # 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/v201508/contact_service/update_contacts.rb

@@ -1,96 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# Copyright:: Copyright 2013, 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 contact comments. To determine which contacts exist,
-# run get_all_contacts.rb.
-
-require 'dfp_api'
-
-
-API_VERSION = :v201508
-
-def update_contacts()
-  # 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 ContactService.
-  contact_service = dfp.service(:ContactService, API_VERSION)
-
-  contact_id = 'INSERT_CONTACT_ID_HERE'.to_i
-
-  # Create a statement to only select a single contact.
-  statement = DfpApi::FilterStatement.new(
-      'WHERE id = :id',
-      [
-          {:key => 'id',
-           :value => {:value => contact_id, :xsi_type => 'NumberValue'}}
-      ],
-      1
-  }
-
-  # Get contacts by statement.
-  page = contact_service.get_contacts_by_statement(statement.toStatement())
-
-  if page[:results]
-    contacts = page[:results]
-
-    contacts.each do |contact|
-      # Update the comment of the contact.
-      contact[:address] = '123 New Street, New York, NY, 10011'
-    end
-
-    # Update the contact on the server.
-    return_contacts = contact_service.update_contacts([contact])
-
-    # Display results.
-    if return_contacts
-      return_contacts.each do |updated_contact|
-        puts "Contact with ID: %d, name: %s and comment: '%s' was updated." %
-            [updated_contact[:id], updated_contact[:name],
-             updated_contact[:comment]]
-      end
-    else
-      raise 'No contacts were updated.'
-    end
-  end
-end
-
-if __FILE__ == $0
-  begin
-    update_contacts()
-
-  # 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/v201508/content_metadata_key_hierarchy_service/create_content_metadata_key_hierarchies.rb

@@ -1,92 +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 creates a content metadata key hierarchy.
-#
-# This feature is only available to DFP video publishers.
-
-require 'dfp_api'
-
-API_VERSION = :v201508
-
-def create_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 IDs of the custom targeting keys for the hierarchy.
-  hierarchy_level_one_key_id = 'INSERT_LEVEL_ONE_CUSTOM_TARGETING_KEY_ID_HERE'
-  hierarchy_level_two_key_id = 'INSERT_LEVEL_TWO_CUSTOM_TARGETING_KEY_ID_HERE'
-
-  hierarchy_level_1 = {
-    :custom_targeting_key_id => hierarchy_level_own_key_id,
-    :hierarchy_level => 1
-  }
-
-  hierarchy_level_2 = {
-    :custom_targeting_key_id => hierarchy_level_two_key_id,
-    :hierarchy_level => 2
-  }
-
-  hierarchy_levels = [hierarchy_level_1, hierarchy_level_2]
-
-  content_metadata_key_hierarchy = {
-    :name => 'Content Metadata Key Hierarchy #%d' % (Time.new.to_f * 1000),
-    :hierarchy_levels => hierarchy_levels
-  }
-
-  # Create the content metadata key hierarchy on the server.
-  content_metadata_key_hierarchies =
-      cmkh_service.create_content_metadata_key_hierarchies(
-          [content_metadata_key_hierarchy])
-
-  content_metadata_key_hierarchies.each do |content_metadata_key_hierarchy|
-    puts 'A content metadata key hierarchy with ID %d, name "%s", and %d ' +
-        'levels was created.' % [
-            content_metadata_key_hierarchy[:id],
-            content_metadata_key_hierarchy[:name],
-            content_metadata_key_hierarchy[:hierarchy_levels].length]
-  end
-end
-
-if __FILE__ == $0
-  begin
-    create_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/v201508/content_metadata_key_hierarchy_service/delete_content_metadata_key_hierarchies.rb

@@ -1,101 +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 deletes a single content metadata key hierarchy.
-#
-# This feature is only available to DFP video publishers.
-
-require 'dfp_api'
-
-
-API_VERSION = :v201508
-
-def delete_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 = 'CONTENT_METADATA_KEY_HIERARCHY_ID'
-
-  # 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
-  end
-
-  if content_metadata_key_hierarchy
-    puts 'Content metadata key hierarchy with ID ' +
-        '"%d" will be deleted.' % content_metadata_key_hierarchy[:id]
-
-    # Perform action.
-    result = cmkh_service.perform_content_metadata_key_hierarchy_action(
-        {:xsi_type => 'DeleteContentMetadataKeyHierarchy'},
-        statement.toStatement())
-
-    # Display results.
-    if result and result[:num_changes] > 0
-      puts 'Number of content metadata key hierarchies deleted: %d' %
-          result[:num_changes]
-    else
-      puts 'No content metadata key hierarchies were deleted.'
-    end
-  else
-    puts 'No content metadata key hierarchy found to delete.'
-  end
-end
-
-if __FILE__ == $0
-  begin
-    delete_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/v201508/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 = :v201508
-
-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/v201508/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 = :v201508
-
-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