oas_update: Update Items in API Database

Description Usage Arguments Value Note Examples

Description

This function updates items in Xaxis for Publishers.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
oas_update(credentials, 
                    request_type=c('Advertiser', 'AdvertiserCategory', 'Affiliate',
                                   'Agency', 'CampaignGroup', 'CompanionPosition',
                                   'CompetitiveCategory', 'ConversionProcess', 
                                   'CreativeType',
                                   'Event', 'InsertionOrder', 'Notification',
                                   'Page', 'Product', 'RichMediaTemplate', 
                                   'SalesPerson', 'Section', 'Site',
                                   'SiteGroup', 'Transaction', 'Position',
                                   'Keyword', 'Keyname', 'Publisher', 
                                   'Campaign', 
                                   'CreativeTarget', 'Creative'),
                     update_data, verbose = FALSE)

Arguments

credentials

a character string as returned by oas_build_credentials

request_type

a character string in one of the supported object types for the API database list action

update_data

an XML document specifying the data to be updated based on the request_type

verbose

a boolean indicating whether messages should be printed while making the request

Value

A logical being TRUE if the update was successful

Note

We recommend using the oas_list function to first understand what attributes are available to be updated on each object type in Xaxis for Publishers before attempting to update existing objects.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
## Not run: 
my_credentials <- oas_build_credentials('myaccount', 
                                        'myusername', 
                                        'mypassword')
                                    
adver_update <- oas_update(credentials=my_credentials, 
                           request_type='Advertiser', 
                           update_data=list(addChildren(
                                            newXMLNode('Advertiser'), 
                                               list(newXMLNode('Id', 'thisadvertiserid'), 
                                                    newXMLNode('ContactTitle', 'new Title')))))
                                            
campaign_update <- oas_update(credentials=my_credentials, 
                              request_type='Campaign', 
                              update_data=list(addChildren(
                                 newXMLNode('Overview'), 
                                 list(newXMLNode('Id', 'myExistingCampaignId'), 
                                 newXMLNode('Status', 'L'),
                                 addChildren(
                                 newXMLNode('CompetitiveCategories'),
                                 list(newXMLNode('CompetitiveCategoryId','Airlines'), 
                                      newXMLNode('CompetitiveCategoryId','Travel')))))))
                                            

## End(Not run)

ReportMort/roas documentation built on May 9, 2019, 9:45 a.m.