/
CompanyService.R
94 lines (91 loc) · 4.18 KB
/
CompanyService.R
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
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
#' CompanyService
#'
#' Provides operations for creating, updating and retrieving Company objects.
#'
#' createCompanies
#'
#' Creates new Company objects.
#'
#' @seealso \href{https://developers.google.com/ad-manager/api/reference/v201905/CompanyService#createCompanies}{Google Documentation for createCompanies}
#'
#' @param request_data a \code{list} or \code{data.frame} of data elements
#' to be formatted for a SOAP
#' request (XML format, but passed as character string)
#' @param as_df a boolean indicating whether to attempt to parse the result into
#' a \code{data.frame}
#' @param verbose a boolean indicating whether to print the service URL and POSTed XML
#' @return a \code{data.frame} or \code{list} containing all the elements of a createCompaniesResponse
#' @examples
#' \dontrun{
#' request_data <- list(companies=list(name="TestCompany1",
#' type='HOUSE_ADVERTISER',
#' address='123 Main St Hometown, FL USA',
#' email='testcompany1@@gmail.com',
#' comment='API Test'))
#' result <- dfp_createCompanies(request_data)
#' }
#' @export
dfp_createCompanies <- function(request_data, as_df=TRUE, verbose=FALSE){
request_body <- form_request_body(service='CompanyService', root_name='createCompanies', data=request_data)
httr_response <- execute_soap_request(request_body=request_body, verbose=verbose)
result <- parse_soap_response(httr_response=httr_response, resp_element='createCompaniesResponse', as_df=as_df)
return(result)
}
#'
#' getCompaniesByStatement
#'
#' Gets a CompanyPage of Company objects that satisfy the given Statement query. The following fields are supported for filtering:
#' \itemize{
#' \item{id}
#' \item{name}
#' \item{type}
#' \item{lastModifiedDateTime}
#' }
#'
#' @seealso \href{https://developers.google.com/ad-manager/api/reference/v201905/CompanyService#getCompaniesByStatement}{Google Documentation for getCompaniesByStatement}
#'
#' @param request_data a \code{list} or \code{data.frame} of data elements
#' to be formatted for a SOAP
#' request (XML format, but passed as character string)
#' @param as_df a boolean indicating whether to attempt to parse the result into
#' a \code{data.frame}
#' @param verbose a boolean indicating whether to print the service URL and POSTed XML
#' @return a \code{data.frame} or \code{list} containing all the elements of a getCompaniesByStatementResponse
#' @examples
#' \dontrun{
#' dat <- list(filterStatement=list('query'="WHERE status='ACTIVE'"))
#' res <- dfp_getCompaniesByStatement(dat)
#' }
#' @export
dfp_getCompaniesByStatement <- function(request_data, as_df=TRUE, verbose=FALSE){
request_body <- form_request_body(service='CompanyService', root_name='getCompaniesByStatement', data=request_data)
httr_response <- execute_soap_request(request_body=request_body, verbose=verbose)
result <- parse_soap_response(httr_response=httr_response, resp_element='getCompaniesByStatementResponse', as_df=as_df)
return(result)
}
#'
#' updateCompanies
#'
#' Updates the specified Company objects.
#'
#' @seealso \href{https://developers.google.com/ad-manager/api/reference/v201905/CompanyService#updateCompanies}{Google Documentation for updateCompanies}
#'
#' @param request_data a \code{list} or \code{data.frame} of data elements
#' to be formatted for a SOAP
#' request (XML format, but passed as character string)
#' @param as_df a boolean indicating whether to attempt to parse the result into
#' a \code{data.frame}
#' @param verbose a boolean indicating whether to print the service URL and POSTed XML
#' @return a \code{data.frame} or \code{list} containing all the elements of a updateCompaniesResponse
#' @examples
#' \dontrun{
#' res <- dfp_updateCompanies(request_data)
#' }
#' @export
dfp_updateCompanies <- function(request_data, as_df=TRUE, verbose=FALSE){
request_body <- form_request_body(service='CompanyService', root_name='updateCompanies', data=request_data)
httr_response <- execute_soap_request(request_body=request_body, verbose=verbose)
result <- parse_soap_response(httr_response=httr_response, resp_element='updateCompaniesResponse', as_df=as_df)
return(result)
}
#'