google-dfp-api 0.4.0 → 0.5.0

data/examples/v201211/user_team_association_service/delete_user_team_associations.rb

@@ -0,0 +1,111 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Author:: api.dklimkin@gmail.com (Danial Klimkin)
+#
+# 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 removes the user from all its teams. To determine which users
+# exist, run get_all_users.rb.
+#
+# Tags: UserTeamAssociationService.getUserTeamAssociationsByStatement
+# Tags: UserTeamAssociationService.performUserTeamAssociationAction
+
+require 'dfp_api'
+
+API_VERSION = :v201211
+PAGE_SIZE = 500
+
+def delete_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 remove from its teams.
+  user_id = 'INSERT_USER_ID_HERE'.to_i
+
+  # Create filter text to remove association by user ID.
+  statement_text = 'WHERE userId = :user_id'
+  statement = {
+      :values => [
+          {:key => 'user_id',
+           :value => {:value => user_id, :xsi_type => 'NumberValue'}}
+      ]
+  }
+
+  offset = 0
+  page = {}
+
+  begin
+    # Update statement with the current offset.
+    statement[:query] = statement_text + " LIMIT %d OFFSET %d" %
+        [PAGE_SIZE, offset]
+
+    # Get user team associations by statement.
+    page = uta_service.get_user_team_associations_by_statement(statement)
+
+    if page[:results]
+      # Increase query offset by page size.
+      offset += PAGE_SIZE
+
+      page[:results].each do |association|
+        puts ("User team association of user ID %d with team ID %d will be " +
+            "deleted.") % [association[:user_id], association[:team_id]]
+      end
+    end
+  end while offset < page[:total_result_set_size]
+
+  # Update statement for deletion.
+  statement[:query] = statement_text
+
+  # Perform the action.
+  result = uta_service.perform_user_team_association_action(
+      {:xsi_type => 'DeleteUserTeamAssociations'}, statement)
+
+  # Display results.
+  if result and result[:num_changes] > 0
+    puts "Number of user team associations deleted: %d" % result[:num_changes]
+  else
+    puts 'No user team associations were deleted.'
+  end
+end
+
+if __FILE__ == $0
+  begin
+    delete_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/{v201108/label_service/get_all_labels.rb → v201211/user_team_association_service/get_all_user_team_associations.rb}

@@ -1,8 +1,9 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
-# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
+# 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.
@@ -17,18 +18,17 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example gets all labels. To create labels, run create_labels.rb
+# This example gets all user team associations. To create user team
+# associations, run create_user_team_assocations.rb.
 #
-# This feature is only available to DFP premium solution networks.
-#
-# Tags: LabelService.getLabelsByStatement
+# Tags: UserTeamAssociationService.getUserTeamAssociationsByStatement
 
 require 'dfp_api'
 
-API_VERSION = :v201108
+API_VERSION = :v201211
 PAGE_SIZE = 500
 
-def get_all_labels()
+def get_all_user_team_associations()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
   dfp = DfpApi::Api.new
 
@@ -36,8 +36,8 @@ def get_all_labels()
   # 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)
+  # Get the UserTeamAssociationService.
+  uta_service = dfp.service(:UserTeamAssociationService, API_VERSION)
 
   # Define initial values.
   offset = 0
@@ -47,8 +47,8 @@ def get_all_labels()
     # Create statement for one page with current offset.
     statement = {:query => "LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]}
 
-    # Get labels by statement.
-    page = label_service.get_labels_by_statement(statement)
+    # Get the user team associations by statement.
+    page = uta_service.get_user_team_associations_by_statement(statement)
 
     if page[:results]
       # Increase query offset by page size.
@@ -57,23 +57,24 @@ def get_all_labels()
       # Get the start index for printout.
       start_index = page[:start_index]
 
-      # Print details about each label in results page.
-      page[:results].each_with_index do |label, index|
-        puts "%d) Label ID: %d, name: %s, type: %s." %
-            [index + start_index, label[:id], label[:name], label[:type]]
+      # Print details about each user team association in results page.
+      page[:results].each_with_index do |association, index|
+        puts "%d) User team association between team ID: %d and user ID %d" %
+            [index + start_index, association[:team_id], association[:user_id]]
       end
     end
   end while offset < page[:total_result_set_size]
 
   # Print a footer
   if page.include?(:total_result_set_size)
-    puts "Total number of labels: %d" % page[:total_result_set_size]
+    puts "Total number of user team associations: %d" %
+        page[:total_result_set_size]
   end
 end
 
 if __FILE__ == $0
   begin
-    get_all_labels()
+    get_all_user_team_associations()
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/{v201108/user_service/get_user.rb → v201211/user_team_association_service/get_user_team_association.rb}

@@ -1,8 +1,9 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
-# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
+# 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.
@@ -17,15 +18,17 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example gets a user by its ID. To create users, run create_users.rb.
+# This example gets a user team association by user and team IDs. To determine
+# which teams exist, run get_all_teams.rb. To determine which users exist, run
+# get_all_users.rb.
 #
-# Tags: UserService.getUser
+# Tags: UserTeamAssociationService.getUserTeamAssociation
 
 require 'dfp_api'
 
-API_VERSION = :v201108
+API_VERSION = :v201211
 
-def get_user()
+def get_user_team_association()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
   dfp = DfpApi::Api.new
 
@@ -33,26 +36,27 @@ def get_user()
   # the configuration file or provide your own logger:
   # dfp.logger = Logger.new('dfp_xml.log')
 
-  # Get the UserService.
-  user_service = dfp.service(:UserService, API_VERSION)
+  # Get the UserTeamAssociationService.
+  uta_service = dfp.service(:UserTeamAssociationService, API_VERSION)
 
-  # Set the ID of the user to get.
+  # Set the users and team to add them to.
+  team_id = 'INSERT_TEAM_ID_HERE'.to_i
   user_id = 'INSERT_USER_ID_HERE'.to_i
 
-  # Get the user.
-  user = user_service.get_user(user_id)
+  # Get the user team association.
+  association = uta_service.get_user_team_association(team_id, user_id)
 
-  if user
-    puts "User with ID: %d, name: %s, email: %s and role: %s was found." %
-        [user[:id], user[:name], user[:email], user[:role_name]]
+  if association
+    puts "User team association with team ID %d and user ID %d was found." %
+        [association[:team_id], association[:user_id]]
   else
-    puts 'No user found for this ID.'
+    puts 'No user team associations found for these IDs.'
   end
 end
 
 if __FILE__ == $0
   begin
-    get_user()
+    get_user_team_association()
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/{v201111/label_service/get_labels_by_statement.rb → v201211/user_team_association_service/get_user_team_associations_by_statement.rb}

@@ -1,8 +1,9 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
-# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
+# 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.
@@ -17,19 +18,19 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example gets all labels that are competitively excluded. The statement
-# retrieves up to the maximum page size limit of 500. To create labels, run
-# create_labels.rb.
+# This example gets all teams that the current user belongs to. The statement
+# retrieves up to the maximum page size limit of 500. To create teams, run
+# create_user_team_associations.rb.
 #
-# This feature is only available to DFP premium solution networks.
-#
-# Tags: LabelService.getLabelsByStatement
+# Tags: UserTeamAssociationService.getUserTeamAssociationsByStatement
+# Tags: UserService.getCurrentUser
 
 require 'dfp_api'
 
-API_VERSION = :v201111
+API_VERSION = :v201211
+PAGE_SIZE = 500
 
-def get_labels_by_statement()
+def get_user_team_associations_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
   dfp = DfpApi::Api.new
 
@@ -37,28 +38,31 @@ def get_labels_by_statement()
   # 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)
+  # Get the UserTeamAssociationService.
+  uta_service = dfp.service(:UserTeamAssociationService, API_VERSION)
+
+  # Get the UserService.
+  user_service = dfp.service(:UserService, API_VERSION)
+
+  # Get the current user.
+  user = user_service.get_current_user()
 
-  # Create a statement to only select active labels.
+  # Create filter text to select user team associations by the user ID.
   statement = {
-      :query => 'WHERE type = :type ORDER BY name LIMIT 500',
+      :query => "WHERE userId = :user_id LIMIT %s" % PAGE_SIZE,
       :values => [
-          {:key => 'type',
-           :value => {
-               :value => 'COMPETITIVE_EXCLUSION',
-               :xsi_type => 'TextValue'}
-          }
+          {:key => 'user_id',
+           :value => {:value => user[:id], :xsi_type => 'NumberValue'}},
       ]
   }
 
-  # Get labels by statement.
-  page = label_service.get_labels_by_statement(statement)
+  # Get user team associations by statement.
+  page = uta_service.get_user_team_associations_by_statement(statement)
 
   if page and page[:results]
-    page[:results].each_with_index do |label, index|
-      puts "%d) Label ID: %d, name: %s, type: %s." % [index,
-          label[:id], label[:name], label[:type]]
+    page[:results].each_with_index do |association, index|
+      puts "%d) Team user association between team ID %d and user ID %d." %
+          [index, association[:team_id], association[:user_id]]
     end
   end
 
@@ -70,7 +74,7 @@ end
 
 if __FILE__ == $0
   begin
-    get_labels_by_statement()
+    get_user_team_associations_by_statement()
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/v201211/user_team_association_service/update_user_team_associations.rb

@@ -0,0 +1,102 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Author:: api.dklimkin@gmail.com (Danial Klimkin)
+#
+# 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.
+#
+# Tags: UserTeamAssociationService.getUserTeamAssociationsByStatement
+# Tags: UserTeamAssociationService.updateUserTeamAssociations
+
+require 'dfp_api'
+
+API_VERSION = :v201211
+PAGE_SIZE = 500
+
+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 = {
+      :query => "WHERE userId = :user_id LIMIT %s" % PAGE_SIZE,
+      :values => [
+          {: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)
+
+  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