Releasing v19.0.0

Author: David Wihl

ChangeLog

@@ -1,3 +1,8 @@
+19.0.0 -- 05/09/2019
+* Added support for Ad Manager v201905
+* Removed support for Ad Manager v201805
+* Removed examples for Ad Manager v201808
+
 18.1.0 -- 04/03/2018
 * Upgrade PyYAML to 5.1 >= 6.0
 * Update comment in get_all_images_and_videos examples

examples/ad_manager/v201905/activity_group_service/__init__.py

@@ -0,0 +1,15 @@
+#!/usr/bin/env python
+#
+# Copyright 2015 Google Inc. All Rights Reserved.
+#
+# 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.

examples/ad_manager/v201905/activity_group_service/create_activity_groups.py

@@ -0,0 +1,71 @@
+#!/usr/bin/env python
+#
+# Copyright 2015 Google Inc. All Rights Reserved.
+#
+# 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 code example creates new activity groups.
+
+To determine which activity groups exist, run get_all_activity_groups.py.
+
+The LoadFromStorage method is pulling credentials and properties from a
+"googleads.yaml" file. By default, it looks for this file in your home
+directory. For more information, see the "Caching authentication information"
+section of our README.
+
+"""
+
+
+import uuid
+
+# Import appropriate modules from the client library.
+from googleads import ad_manager
+
+# Set the ID of the advertiser company this activity group is associated with.
+ADVERTISER_COMPANY_ID = 'INSERT_ADVERTISER_COMPANY_ID_HERE'
+
+
+def main(client, advertiser_company_id):
+  # Initialize appropriate service.
+  activity_group_service = client.GetService('ActivityGroupService',
+                                             version='v201905')
+
+  # Create a short-term activity group.
+  short_term_activity_group = {
+      'name': 'Short-term activity group #%s' % uuid.uuid4(),
+      'companyIds': [advertiser_company_id],
+      'clicksLookback': '1',
+      'impressionsLookback': '1'
+  }
+
+  # Create a long-term activity group.
+  long_term_activity_group = {
+      'name': 'Long-term activity group #%s' % uuid.uuid4(),
+      'companyIds': [advertiser_company_id],
+      'clicksLookback': '30',
+      'impressionsLookback': '30'
+  }
+
+  # Create the activity groups on the server.
+  activity_groups = activity_group_service.createActivityGroups([
+      short_term_activity_group, long_term_activity_group])
+
+  # Display results.
+  for activity_group in activity_groups:
+    print ('Activity group with ID "%s" and name "%s" was created.'
+           % (activity_group['id'], activity_group['name']))
+
+if __name__ == '__main__':
+  # Initialize client object.
+  ad_manager_client = ad_manager.AdManagerClient.LoadFromStorage()
+  main(ad_manager_client, ADVERTISER_COMPANY_ID)

examples/ad_manager/v201905/activity_group_service/get_active_activity_groups.py

@@ -0,0 +1,52 @@
+#!/usr/bin/env python
+#
+# Copyright 2016 Google Inc. All Rights Reserved.
+#
+# 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.
+"""
+
+# Import appropriate modules from the client library.
+from googleads import ad_manager
+
+
+def main(client):
+  # Initialize appropriate service.
+  activity_group_service = client.GetService(
+      'ActivityGroupService', version='v201905')
+  # Create a statement to select activity groups.
+  statement = (ad_manager.StatementBuilder(version='v201905')
+               .Where('status = :status')
+               .WithBindVariable('status', 'ACTIVE'))
+
+  # Retrieve a small amount of activity groups at a time, paging
+  # through until all activity groups have been retrieved.
+  while True:
+    response = activity_group_service.getActivityGroupsByStatement(
+        statement.ToStatement())
+    if 'results' in response and len(response['results']):
+      for activity_group in response['results']:
+        # Print out some information for each activity group.
+        print('Activity group with ID "%d" and name "%s" was found.\n' %
+              (activity_group['id'], activity_group['name']))
+      statement.offset += statement.limit
+    else:
+      break
+
+  print '\nNumber of results found: %s' % response['totalResultSetSize']
+
+
+if __name__ == '__main__':
+  # Initialize client object.
+  ad_manager_client = ad_manager.AdManagerClient.LoadFromStorage()
+  main(ad_manager_client)

examples/ad_manager/v201905/activity_group_service/get_all_activity_groups.py

@@ -0,0 +1,51 @@
+#!/usr/bin/env python
+#
+# Copyright 2016 Google Inc. All Rights Reserved.
+#
+# 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.
+"""
+
+# Import appropriate modules from the client library.
+from googleads import ad_manager
+
+
+def main(client):
+  # Initialize appropriate service.
+  activity_group_service = client.GetService(
+      'ActivityGroupService', version='v201905')
+
+  # Create a statement to select activity groups.
+  statement = ad_manager.StatementBuilder(version='v201905')
+
+  # Retrieve a small amount of activity groups at a time, paging
+  # through until all activity groups have been retrieved.
+  while True:
+    response = activity_group_service.getActivityGroupsByStatement(
+        statement.ToStatement())
+    if 'results' in response and len(response['results']):
+      for activity_group in response['results']:
+        # Print out some information for each activity group.
+        print('Activity group with ID "%d" and name "%s" was found.\n' %
+              (activity_group['id'], activity_group['name']))
+      statement.offset += statement.limit
+    else:
+      break
+
+  print '\nNumber of results found: %s' % response['totalResultSetSize']
+
+
+if __name__ == '__main__':
+  # Initialize client object.
+  ad_manager_client = ad_manager.AdManagerClient.LoadFromStorage()
+  main(ad_manager_client)

examples/ad_manager/v201905/activity_group_service/update_activity_groups.py

@@ -0,0 +1,70 @@
+#!/usr/bin/env python
+#
+# Copyright 2015 Google Inc. All Rights Reserved.
+#
+# 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 code example updates activity groups.
+
+To determine which activity groups exist, run get_all_activity_groups.py.
+
+The LoadFromStorage method is pulling credentials and properties from a
+"googleads.yaml" file. By default, it looks for this file in your home
+directory. For more information, see the "Caching authentication information"
+section of our README.
+
+"""
+
+
+# Import appropriate modules from the client library.
+from googleads import ad_manager
+
+# 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'
+
+
+def main(client, activity_group_id, advertiser_company_id):
+  # Initialize appropriate service.
+  activity_group_service = client.GetService('ActivityGroupService',
+                                             version='v201905')
+
+  # Create statement object to select a single activity groups by ID.
+  statement = (ad_manager.StatementBuilder(version='v201905')
+               .Where('id = :activityGroupId')
+               .WithBindVariable('activityGroupId', long(activity_group_id))
+               .Limit(1))
+
+  # Get activity groups by statement.
+  response = activity_group_service.getActivityGroupsByStatement(
+      statement.ToStatement())
+  if 'results' in response and len(response['results']):
+    updated_activity_groups = []
+    for activity_group in response['results']:
+      activity_group['companyIds'].append(advertiser_company_id)
+      updated_activity_groups.append(activity_group)
+    # Update the activity groups on the server.
+    activity_groups = activity_group_service.updateActivityGroups(
+        updated_activity_groups)
+
+    for activity_group in activity_groups:
+      print (('Activity group with ID "%s" and name "%s" was updated.')
+             % (activity_group['id'], activity_group['name']))
+  else:
+    print 'No activity groups found to update.'
+
+
+if __name__ == '__main__':
+  # Initialize client object.
+  ad_manager_client = ad_manager.AdManagerClient.LoadFromStorage()
+  main(ad_manager_client, ACTIVITY_GROUP_ID, ADVERTISER_COMPANY_ID)

examples/ad_manager/v201905/activity_service/__init__.py

@@ -0,0 +1,15 @@
+#!/usr/bin/env python
+#
+# Copyright 2015 Google Inc. All Rights Reserved.
+#
+# 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.

examples/ad_manager/v201905/activity_service/create_activities.py

@@ -0,0 +1,68 @@
+#!/usr/bin/env python
+#
+# Copyright 2015 Google Inc. All Rights Reserved.
+#
+# 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 code example creates new activities.
+
+To determine which activities groups exist, run get_all_activities.py.
+
+The LoadFromStorage method is pulling credentials and properties from a
+"googleads.yaml" file. By default, it looks for this file in your home
+directory. For more information, see the "Caching authentication information"
+section of our README.
+
+"""
+
+
+import uuid
+
+# Import appropriate modules from the client library.
+from googleads import ad_manager
+
+# Set the ID of the activity group this activity is associated with.
+ACTIVITY_GROUP_ID = 'INSERT_ACTIVITY_GROUP_ID_HERE'
+
+
+def main(client, activity_group_id):
+  # Initialize appropriate service.
+  activity_service = client.GetService('ActivityService', version='v201905')
+
+  # Create a daily visits activity.
+  daily_visits_activity = {
+      'name': 'Activity #%s' % uuid.uuid4(),
+      'activityGroupId': activity_group_id,
+      'type': 'DAILY_VISITS'
+  }
+
+  # Create a custom activity.
+  custom_activity = {
+      'name': 'Activity #%s' % uuid.uuid4(),
+      'activityGroupId': activity_group_id,
+      'type': 'CUSTOM'
+  }
+
+  # Create the activities on the server.
+  activities = activity_service.createActivities([
+      daily_visits_activity, custom_activity])
+
+  # Display results.
+  for activity in activities:
+    print ('An activity with ID "%s", name "%s", and type "%s" was '
+           'created.' % (activity['id'], activity['name'], activity['type']))
+
+if __name__ == '__main__':
+  # Initialize client object.
+  ad_manager_client = ad_manager.AdManagerClient.LoadFromStorage()
+  main(ad_manager_client, ACTIVITY_GROUP_ID)