google-dfp-api 0.7.1 → 0.8.0

data/examples/v201302/company_service/update_companies.rb

@@ -1,102 +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 updates the names of all companies that are advertisers by
-# appending "LLC." up to the first 500. To determine which companies exist, run
-# get_all_companies.rb.
-#
-# Tags: CompanyService.getCompaniesByStatement, CompanyService.updateCompanies
-
-require 'dfp_api'
-
-API_VERSION = :v201302
-
-def update_companies()
-  # 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)
-
-  # Create a statement to only select companies that are advertisers.
-  statement = {
-      :query => "WHERE type = :type LIMIT 500",
-      :values => [
-          {:key => 'type',
-           :value => {:value => 'ADVERTISER', :xsi_type => 'TextValue'}}
-      ]
-  }
-
-  # Get companies by statement.
-  page = company_service.get_companies_by_statement(statement)
-
-  if page[:results]
-    companies = page[:results]
-
-    # Update each local company object by appending ' LLC.' to its name.
-    companies.each do |company|
-      company[:name] += ' LLC.'
-      # Workaround for issue #94.
-      [:address, :email, :fax_phone, :primary_phone,
-          :external_id, :comment].each do |item|
-        company[item] = "" if company[item].nil?
-      end
-    end
-
-    # Update the companies on the server.
-    return_companies = company_service.update_companies(companies)
-
-    if return_companies
-      return_companies.each do |company|
-        puts "A company with ID [%d], name: %s and type %s was updated." %
-            [company[:id], company[:name], company[:type]]
-      end
-    else
-      raise 'No companies were updated.'
-    end
-  else
-    puts 'No companies found to update.'
-  end
-end
-
-if __FILE__ == $0
-  begin
-    update_companies()
-
-  # 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/v201302/contact_service/create_contacts.rb

@@ -1,95 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# Author:: api.davidtorres@gmail.com (David Torres)
-#
-# 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 creates new contacts. To determine which contacts exist, run
-# get_all_contacts.rb.
-#
-# Tags: ContactService.createContacts
-
-require 'dfp_api'
-
-API_VERSION = :v201302
-
-def create_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)
-
-  # Set the ID of the advertiser company this contact is associated with.
-  advertiser_company_id = 'INSERT_ADVERTISER_COMPANY_ID_HERE'
-
-  # Set the ID of the agency company this contact is associated with.
-  agency_company_id = 'INSERT_AGENCY_COMPANY_ID_HERE'
-
-  # Create an advertiser contact.
-  advertiser_contact = {
-      :name => 'Mr. Advertiser',
-      :email => 'advertiser@advertising.com',
-      :company_id => advertiser_company_id
-  }
-
-  # Create an agency contact.
-  agency_contact = {
-      :name => 'Ms. Agency',
-      :email => 'agency@agencies.com',
-      :company_id => agency_company_id
-  }
-
-  # Create the contacts on the server.
-  return_contacts = contact_service.create_contacts([advertiser_contact,
-      agency_contact])
-
-  # Display results.
-  if return_contacts
-    return_contacts.each do |contact|
-      puts 'A contact with ID %d and name %s was created.' % [contact[:id],
-          contact[:name]]
-    end
-  else
-    raise 'No contacts were created.'
-  end
-end
-
-if __FILE__ == $0
-  begin
-    create_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/v201302/contact_service/get_all_contacts.rb

@@ -1,92 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# Author:: api.davidtorres@gmail.com (David Torres)
-#
-# 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.
-#
-# Tags: ContactService.getContactsByStatement.
-
-require 'dfp_api'
-
-API_VERSION = :v201302
-PAGE_SIZE = 500
-
-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)
-
-  # Define initial values.
-  offset = 0
-  page = {}
-
-  begin
-    # Create statement for one page with current offset.
-    statement = {:query => "LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]}
-
-    # Get contacts by statement.
-    page = contact_service.get_contacts_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 content object in results page.
-      page[:results].each_with_index do |contact, index|
-        puts "%d) Contact ID: %d, name: %s." % [index + start_index,
-            contact[:id], contact[:name]]
-      end
-    end
-  end while 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/v201302/contact_service/get_uninvited_contacts.rb

@@ -1,102 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# Author:: api.davidtorres@gmail.com (David Torres)
-#
-# 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.
-#
-# Tags: ContactService.getContactsByStatement.
-
-require 'dfp_api'
-
-API_VERSION = :v201302
-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 LIMIT %d OFFSET %d'
-
-  # Create statement.
-  statement = {
-    :values => [
-      {:key => 'status',
-       :value => {:value => 'UNINVITED', :xsi_type => 'TextValue'}}
-    ]
-  }
-
-  begin
-    # Update statement for one page with current offset.
-    statement[:query] = query_base % [PAGE_SIZE, offset]
-
-    # Get contacts by statement.
-    page = contact_service.get_contacts_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 content object in results page.
-      page[:results].each_with_index do |contact, index|
-        puts "%d) Contact ID: %d, name: %s." % [index + start_index,
-            contact[:id], contact[:name]]
-      end
-    end
-  end while 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/v201302/content_service/get_content_by_category.rb

@@ -1,143 +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 all active content categorized as "comedy" using the
-# network's content browse custom targeting key.
-#
-# This feature is only available to DFP video publishers.
-#
-# Tags: NetworkService.getCurrentNetwork
-# Tags: ContentService.getContentByStatementAndCustomTargetingValue
-# Tags: CustomTargetingService.getCustomTargetingValuesByStatement
-
-require 'dfp_api'
-
-API_VERSION = :v201302
-PAGE_SIZE = 500
-
-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 = {
-      :query => 'WHERE customTargetingKeyId = :targeting_key_id' +
-          ' and name = :category LIMIT 1',
-      :values => [
-          {:key => 'targeting_key_id',
-           :value => {:value => content_browse_custom_targeting_key_id,
-                      :xsi_type => 'NumberValue'}},
-          {:key => 'category',
-           :value => {:value => 'comedy',
-                      :xsi_type => 'TextValue'}},
-      ]
-  }
-
-  # Get categories matching the filter statement.
-  page = custom_targeting_service.get_custom_targeting_values_by_statement(
-      statement)
-
-  # 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)
-
-    # Define initial values.
-    offset = 0
-    page = {}
-
-    statement_text = 'WHERE status = :status'
-    statement = {
-        :query => statement_text,
-        :values => [
-            {:key => 'status',
-             :value => {:value => 'ACTIVE', :xsi_type => 'TextValue'}}
-        ]
-    }
-
-    begin
-      # Create a statement to get one page with current offset.
-      statement[:query] = statement_text +
-          " LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]
-
-      # Get content by statement.
-      page =
-          content_service.get_content_by_statement_and_custom_targeting_value(
-              statement, category_custom_targeting_value_id)
-
-      if page[:results]
-        # Increase query offset by page size.
-        offset += PAGE_SIZE
-
-        page[:results].each_with_index do |content, index|
-          puts "%d) Content ID: %d, name: %s, status: %s." %
-              [index + start_index, content[:id], content[:name],
-               content[:status]]
-        end
-      end
-    end while 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