Description Usage Arguments Value Note Examples
This function returns a data.frame of search inventory statistics based on Keyword
1 2 3 4 5 6 7 8 9 10 11 12 13 |
credentials |
a character string as returned by oas_build_credentials |
report_type |
a character string in of the supported keyword search inventory reports |
report_name |
a character string of the report name. Please see the dataset inventory_reports and filter to inventory_type=="search" for a complete list of available report_type and report_name combinations for this function. |
keywords |
a character string containing comma separated keywords value for filtering inventory report. |
max_row |
a character integer limiting the number of rows returned matching the supplied keywords. A character is recommended to avoid larger numbers being formatted in scientific notation and not being properly interpreted by the API. |
position |
a character vector containing position names. Multiple "position" elements can be specified at once, hence a vector is accepted instead of a string |
campaign_id |
a character vector containing campaign ids. Multiple "campaign_id" elements can be specified at once, hence a vector is accepted instead of a string |
site_domain |
a character vector containing site domains. Multiple "site_domain" elements can be specified at once, hence a vector is accepted instead of a string |
section_id |
a character vector containing section ids. Multiple "section_id" elements can be specified at once, hence a vector is accepted instead of a string |
start_date |
a character string for inquiring inventory detail report. This field is optional and must be in the yyyy-mm-dd format. |
end_date |
a character string for inquiring the inventory detail report by given schedule. This field is optional and must be in the yyyy-mm-dd format. |
A data.frame
of inventory data in the format of the specified
report_type and report_name
Search inventory requests are only available if the Search module is enabled on the account
The arguments for position, campaign_id, site_domain, section_id are optional, but helpful in narrowing the focus for the resultset to shorten request and parsing time.
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 <- build_credentials('myaccount',
'myusername',
'mypassword')
stats <- oas_search_inventory(credentials=my_credentials,
report_type='KeywordStatistics',
report_name='Statistics By Keyword',
keywords='Kw1,Kw2',
position=c('Bottom', 'Bottom1'),
section_id=c('Books'),
site_domain=c('www.mysite.com'))
booked <- oas_search_inventory(credentials=my_credentials,
report_type='KeywordBooked',
report_name='Campaign Targets',
keywords='Kw1,Kw2',
position=c('Bottom', 'Bottom1'),
campaign_id=c('Test_Campaign'),
site_domain=c('www.mysite.com'),
start_date='2015-12-01',
end_date='2015-12-31')
## End(Not run)
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.