oas_add: Add Items in API Database

In ReportMort/roas: Open Ad Stream API from R

Description

This function adds items in Xaxis for Publishers.

Usage

oas_add(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'),
                     add_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
add_data	an XML document specifying the data to add when creating the request_type
verbose	a boolean indicating whether messages should be printed while making the request

Value

A logical being TRUE if the add was successful

Note

We recommend using the oas_list function to first understand what attributes are available on each object type in Xaxis for Publishers before attempting to add existing objects, especially for complicated types, such as, Campaigns which have many configurable attributes.

Examples

## Not run: 
my_credentials <- oas_build_credentials('myaccount', 
                                        'myusername', 
                                        'mypassword')
                                    
adver_add <- oas_add(credentials=my_credentials, 
                           request_type='Advertiser', 
                           update_data=list(addChildren(
                                            newXMLNode('Advertiser'), 
                                               list(newXMLNode('Id', 'MyAdvertiserId'), 
                                                    newXMLNode('ContactTitle', 'new Title')))))
                                            

## End(Not run)

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