oas_read: Read/Retrieve all details for a requested object

In ReportMort/roas: Open Ad Stream API from R

Description

This function returns a lists of all the available data points for requested data type specified in the read_request. Most elements support the READ function except Companion Position, Competitive Category and Code.

Usage

oas_read(credentials, 
                    request_type=c('Advertiser', 'AdvertiserCategory', 
                                   'Affiliate', 'Agency', 'CampaignGroup', 
                                   'ConversionProcess', 'Zone', 'CreativeType',
                                   'Event', 'InsertionOrder', 'RichMediaTemplate', 
                                   'Product', 'SalesPerson', 
                                   'Site', 'SiteGroup', 'Publisher', 
                                   'Page', 'Section', 'Transaction',
                                   'Keyname', 'Keyword', 
                                   'Campaign', 'CreativeTarget', 
                                   'Creative', 'Notification'),
                    id, campaign_id=NULL)

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 read action
id	a character string that uniquely identifies an item to retrieve. For the request of some objects Id serves as the Name (Affiliate, ConversionProcess, Event, Transaction, Keyname)
campaign_id	a character string that identifies a campaign when CreativeTarget, Creative or Notification reads are being performed, otherwise this value will be ignored

Value

A list of all fields available for the specified request type

Examples

## Not run: 
my_credentials <- build_credentials('myaccount', 
                                    'myusername', 
                                    'mypassword')
site_details <- oas_read(credentials=my_credentials, 
                                 request_type='Site', 
                                 id='www.mysite.com')
campaign_details <- oas_read(credentials=my_credentials, 
                                 request_type='Campaign', 
                                 id='one_campaign_id')
creative_details <- oas_read(credentials=my_credentials, 
                                 request_type='Creative', 
                                 id='one_creative_id', 
                                 campaign_id='one_campaign_id')

## End(Not run)

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