google-dfp-api 0.17.0 → 0.19.0

data/examples/v201511/user_team_association_service/update_user_team_associations.rb

@@ -1,98 +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 updates user team associations. It updates a user team
-# association by setting the overridden access type to read only for the first
-# 500 teams that the user belongs to. To determine which users exists, run
-# get_all_users.rb.
-
-require 'dfp_api'
-
-
-API_VERSION = :v201511
-
-def update_user_team_associations()
-  # 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 UserTeamAssociationService.
-  uta_service = dfp.service(:UserTeamAssociationService, API_VERSION)
-
-  # Set the user to set to read only access within its teams.
-  user_id = 'INSERT_USER_ID_HERE'.to_i
-
-  # Create filter text to select user team associations by the user ID.
-  statement = DfpApi::FilterStatement.new(
-      'WHERE userId = :user_id ORDER BY id ASC',
-      [
-          {:key => 'user_id',
-           :value => {:value => user_id, :xsi_type => 'NumberValue'}},
-      ]
-  )
-
-  # Get user team associations by statement.
-  page = uta_service.get_user_team_associations_by_statement(
-      statement.toStatement())
-
-  if page[:results] and !page[:results].empty?
-    associations = page[:results]
-    associations.each do |association|
-      # Update local user team association to read-only access.
-      association[:overridden_team_access_type] = 'READ_ONLY'
-    end
-
-    # Update the user team association on the server.
-    return_associations =
-        uta_service.update_user_team_associations(associations)
-
-    # Display results.
-    return_associations.each do |association|
-      puts ("User team association between user ID %d and team ID %d was " +
-          "updated with access type '%s'") %
-          [association[:user_id], association[:team_id],
-           association[:overridden_team_access_type]]
-    end
-  else
-    puts 'No user team associations were updated.'
-  end
-end
-
-if __FILE__ == $0
-  begin
-    update_user_team_associations()
-
-  # 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/v201602/activity_group_service/create_activity_groups.rb

@@ -1,90 +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 creates new activity groups. To determine which activity groups
-# exist, run get_all_activity_groups.rb.
-
-require 'dfp_api'
-
-API_VERSION = :v201602
-
-def create_activity_groups()
-  # 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 ActivityGroupService.
-  activity_group_service = dfp.service(:ActivityGroupService, API_VERSION)
-
-  # Set the ID of the advertiser company this activity group is associated
-  # with.
-  advertiser_company_id = 'INSERT_ADVERTISER_COMPANY_ID_HERE';
-
-  # Create a short-term activity group.
-  short_term_activity_group = {
-    :name => 'Short-term activity group',
-    :company_ids => [advertiser_company_id],
-    :clicks_lookback => 1,
-    :impressions_lookback => 1
-  }
-
-  # Create a long-term activity group.
-  long_term_activity_group = {
-    :name => 'Long-term activity group',
-    :company_ids => [advertiser_company_id],
-    :clicks_lookback => 30,
-    :impressions_lookback => 30
-  }
-
-  # Create the activity groups on the server.
-  return_activity_groups = activity_group_service.create_activity_groups([
-      short_term_activity_group, long_term_activity_group])
-
-  if return_activity_groups
-    return_activity_groups.each do |activity_group|
-      puts "An activity group with ID: %d and name: %s was created." %
-          [activity_group[:id], activity_group[:name]]
-    end
-  else
-    raise 'No activity groups were created.'
-  end
-end
-
-if __FILE__ == $0
-  begin
-    create_activity_groups()
-
-  # 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/v201602/activity_group_service/get_active_activity_groups.rb

@@ -1,87 +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 active activity groups. To create activity groups,
-# run create_activity_groups.rb.
-
-require 'dfp_api'
-
-
-API_VERSION = :v201602
-
-def get_active_activity_groups()
-  # 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 ActivityGroupService.
-  activity_group_service = dfp.service(:ActivityGroupService, API_VERSION)
-
-  # Create a statement to only select active activity groups.
-  statement = DfpApi::FilterStatement.new(
-      'status = :status ORDER BY id ASC',
-      [
-          {:key => 'status',
-           :value => {:value => 'ACTIVE', :xsi_type => 'TextValue'}}
-      ]
-  )
-
-  begin
-    # Get activity groups by statement.
-    page = activity_group_service.get_activity_groups_by_statement(
-        statement.toStatement())
-
-    if page[:results]
-      page[:results].each_with_index do |activity_group, index|
-        puts "%d) Activity group with ID: %d, name: %s." % [
-            index + statement.offset,
-            activity_group[:id], activity_group[: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_active_activity_groups()
-
-  # 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/v201602/activity_group_service/get_all_activity_groups.rb

@@ -1,81 +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 activity groups. To create activity groups,
-# run create_activity_groups.rb.
-
-require 'dfp_api'
-
-
-API_VERSION = :v201602
-
-def get_all_activity_groups()
-  # 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 ActivityGroupService.
-  activity_group_service = dfp.service(:ActivityGroupService, API_VERSION)
-
-  # Create a statement to select all activity groups.
-  statement = DfpApi::FilterStatement.new('ORDER BY id ASC')
-
-  begin
-    # Get activity groups by statement.
-    page = activity_group_service.get_activity_groups_by_statement(
-        statement.toStatement())
-
-    if page[:results]
-      page[:results].each_with_index do |activity_group, index|
-        puts "%d) Activity group with ID: %d, name: %s." % [
-            index + statement.offset,
-            activity_group[:id], activity_group[: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_activity_groups()
-
-  # 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/v201602/activity_group_service/update_activity_groups.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 updates activity groups by adding a company. To determine which
-# activity groups exist, run get_all_activity_groups.rb.
-
-require 'dfp_api'
-
-
-API_VERSION = :v201602
-
-def update_activity_groups()
-  # 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 ActivityGroupService.
-  activity_group_service = dfp.service(:ActivityGroupService, API_VERSION)
-
-  # Set the ID of the activity group and the company to update it with.
-  activity_group_id = 'INSERT_ACTIVITY_GROUP_ID_HERE'
-  advertiser_company_id = 'INSERT_ADVERTISER_COMPANY_ID_HERE'
-
-  # Create statement to select a single activity group.
-  statement = DfpApi::FilterStatement.new(
-      'WHERE id = :id ORDER BY id ASC',
-      [
-          {:key => 'id',
-           :value => {:value => activity_group_id, :xsi_type => 'NumberValue'}}
-      ],
-      1
-  )
-
-  page = activity_group_service.get_activity_groups_by_statement(
-      statement.toStatement())
-
-  if page[:results]
-    # Get the activity groups.
-    activity_groups = page[:results]
-
-    activity_groups.each do |activity_group|
-      # Update the companies.
-      activity_group[:company_ids] << advertiser_company_id
-    end
-
-    # Update the activity groups on the server.
-    return_activity_groups = activity_group_service.update_activity_groups(
-        activity_groups)
-
-    return_activity_groups.each do |updates_activity_group|
-      puts "Activity group with ID: %d and name: %s was updated." %
-          [updates_activity_group[:id], updates_activity_group[:name]]
-    end
-  end
-end
-
-if __FILE__ == $0
-  begin
-    update_activity_groups()
-
-  # 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/v201602/activity_service/create_activities.rb

@@ -1,87 +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 creates new activities. To determine which activities exist, run
-# get_all_activities.php.
-
-require 'dfp_api'
-
-API_VERSION = :v201602
-
-def create_activities()
-  # 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 ActivityService.
-  activity_service = dfp.service(:ActivityService, API_VERSION)
-
-  # Set the ID of the activity group this activity is associated with.
-  activity_group_id = 'INSERT_ACTIVITY_GROUP_ID_HERE';
-
-  # Create a daily visits activity.
-  daily_visits_activity = {
-    :name => 'Activity',
-    :activity_group_id => activity_group_id,
-    :type => 'DAILY_VISITS'
-  }
-
-  # Create a custom activity.
-  custom_activity = {
-    :name => 'Activity',
-    :activity_group_id => activity_group_id,
-    :type => 'CUSTOM'
-  }
-
-  # Create the activities on the server.
-  return_activities = activity_service.create_activities([
-      daily_visits_activity, custom_activity])
-
-  if return_activities
-    return_activities.each do |activity|
-      puts "An activity with ID: %d, name: %s and type: %s was created." %
-          [activity[:id], activity[:name], activity[:type]]
-    end
-  else
-    raise 'No activities were created.'
-  end
-end
-
-if __FILE__ == $0
-  begin
-    create_activities()
-
-  # 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/v201602/activity_service/get_active_activities.rb

@@ -1,87 +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 active activities. To create activities,
-# run create_activities.rb.
-
-require 'dfp_api'
-
-
-API_VERSION = :v201602
-
-def get_active_activities()
-  # 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 ActivityService.
-  activity_service = dfp.service(:ActivityService, API_VERSION)
-
-  # Create a statement to only select active activities.
-  statement = DfpApi::FilterStatement.new(
-      'status = :status ORDER BY id ASC',
-      [
-          {:key => 'status',
-           :value => {:value => 'ACTIVE', :xsi_type => 'TextValue'}}
-      ]
-  )
-
-  begin
-    # Get activities by statement.
-    page = activity_service.get_activities_by_statement(
-        statement.toStatement())
-
-    if page[:results]
-      page[:results].each_with_index do |activity, index|
-        puts "%d) Activity with ID: %d, name: %s, type: %s." %
-            [index + statement.offset, activity[:id], activity[:name],
-                activity[:type]]
-      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_active_activities()
-
-  # 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