Package 'rdfp'

Description

Authorize rdfp to access your Google user data. You will be directed to a web browser, asked to sign in to your Google account, and to grant rdfp access to user data for Double Click for Publishers. These user credentials are cached in a file named .httr-oauth in the current working directory, from where they can be automatically refreshed, as necessary.

Usage

dfp_auth(token = NULL, new_user = FALSE,
  addtl_scopes = c("https://spreadsheets.google.com/feeds",
  "https://www.googleapis.com/auth/drive",
  "https://www.googleapis.com/auth/spreadsheets",
  "https://www.googleapis.com/auth/presentations",
  "https://www.googleapis.com/auth/analytics",
  "https://www.googleapis.com/auth/yt-analytics.readonly",
  "https://www.googleapis.com/auth/gmail.readonly",
  "https://www.googleapis.com/auth/gmail.compose",
  "https://www.googleapis.com/auth/gmail.send"),
  key = getOption("rdfp.client_id"),
  secret = getOption("rdfp.client_secret"),
  cache = getOption("rdfp.httr_oauth_cache"), verbose = TRUE)

Arguments

Details

Most users, most of the time, do not need to call this function explicitly – it will be triggered by the first action that requires authorization. Even when called, the default arguments will often suffice. However, when necessary, this function allows the user to

• store a token – the token is invisibly returned and can be assigned to an object or written to an .rds file

• read the token from an .rds file or pre-existing object in the workspace

• provide your own app key and secret – this requires setting up a new project in Google Developers Console

• prevent caching of credentials in .httr-oauth-rdfp

In a call to dfp_auth, the user can provide the token, app key and secret explicitly and can dictate whether credentials will be cached in .httr-oauth-rdfp. They must be specified.

To set options in a more persistent way, predefine one or more of them with lines like this in a .Rprofile file:

options(rdfp.network_code = "12345678",
        rdfp.application_name = "MyApp",
        rdfp.client_id = "012345678901-99thisisatest99.apps.googleusercontent.com",
        rdfp.client_secret = "Th1s1sMyC1ientS3cr3t",
        rdfp.httr_oauth_cache = FALSE)

See Startup for possible locations for this file and the implications thereof.

More detail is available from Using OAuth 2.0 to Access Google APIs.

Value

an OAuth token object, specifically a Token2.0, invisibly

Description

Provides methods for creating, updating and retrieving Activity objects.

Usage

dfp_createActivities(request_data, as_df = TRUE, verbose = FALSE)

Arguments

Details

An activity group contains Activity objects. Activities have a many-to-one relationship with activity groups, meaning each activity can belong to only one activity group, but activity groups can have multiple activities. An activity group can be used to manage the activities it contains.

createActivities

Creates a new Activity objects.

Value

a data.frame or list containing all the elements of a createActivitiesResponse

See Also

Google Documentation for createActivities

Examples

## Not run: 
 res <- dfp_createActivities(request_data)

## End(Not run)

Description

Provides methods for creating, updating and retrieving ActivityGroup objects. An activity group contains Activity objects. Activities have a many-to-one relationship with activity groups, meaning each activity can belong to only one activity group, but activity groups can have multiple activities. An activity group can be used to manage the activities it contains.

Usage

dfp_createActivityGroups(request_data, as_df = TRUE, verbose = FALSE)

Arguments

Details

createActivityGroups

Creates a new ActivityGroup objects.

Value

a data.frame or list containing all the elements of a createActivityGroupsResponse

See Also

Google Documentation for createActivityGroups

Examples

## Not run: 
 res <- dfp_createActivityGroups(request_data)

## End(Not run)

Description

Provides methods for creating, updating and retrieving AdExclusionRule objects. An AdExclusionRule provides a way to block specified ads from showing on portions of your site. Each rule specifies the inventory on which the rule is in effect, and the labels to block on that inventory.

Usage

dfp_createAdExclusionRules(request_data, as_df = TRUE, verbose = FALSE)

Arguments

Details

createAdExclusionRules

Creates new AdExclusionRule objects.

Value

a data.frame or list containing all the elements of a createAdExclusionRulesResponse

See Also

Google Documentation for createAdExclusionRules

Examples

## Not run: 
 res <- dfp_createAdExclusionRules(request_data)

## End(Not run)

Description

Provides methods for creating, updating and retrieving AdRule objects.

Usage

dfp_createAdRules(request_data, as_df = TRUE, verbose = FALSE)

Arguments

Details

Ad rules contain data that the ad server uses to generate a playlist of video ads.

createAdRules

Creates new AdRule objects.

Value

a data.frame or list containing all the elements of a createAdRulesResponse

See Also

Google Documentation for createAdRules

Examples

## Not run: 
 res <- dfp_createAdRules(request_data)

## End(Not run)

Description

Provides operations for creating, updating and retrieving AdUnit objects.

Usage

dfp_createAdUnits(request_data, as_df = TRUE, verbose = FALSE)

Arguments

Details

Line items connect a creative with its associated ad unit through targeting. An ad unit represents a piece of inventory within a publisher. It contains all the settings that need to be associated with the inventory in order to serve ads. For example, the ad unit contains creative size restrictions and AdSense settings.

createAdUnits

Creates new AdUnit objects.

Value

a data.frame or list containing all the elements of a createAdUnitsResponse

See Also

Google Documentation for createAdUnits

Examples

## Not run: 
 res <- dfp_createAdUnits(request_data)

## End(Not run)

Description

Provides operations for creating, updating and retrieving AudienceSegment objects.

Usage

dfp_createAudienceSegments(request_data, as_df = TRUE, verbose = FALSE)

Arguments

Details

createAudienceSegments

Creates new RuleBasedFirstPartyAudienceSegment objects.

Value

a data.frame or list containing all the elements of a createAudienceSegmentsResponse

See Also

Google Documentation for createAudienceSegments

Examples

## Not run: 
 res <- dfp_createAudienceSegments(request_data)

## End(Not run)

Description

Provides methods for managing BaseRate objects. To use this service, you need to have the new sales management solution enabled on your network. If you do not see a "Sales" tab in <a href="https://www.google.com/dfp">DoubleClick for Publishers (DFP)</a>, you will not be able to use this service.

Usage

dfp_createBaseRates(request_data, as_df = TRUE, verbose = FALSE)

Arguments

Details

createBaseRates

Creates a list of new BaseRate objects.

Value

a data.frame or list containing all the elements of a createBaseRatesResponse

See Also

Google Documentation for createBaseRates

Examples

## Not run: 
 res <- dfp_createBaseRates(request_data)

## End(Not run)

Description

Provides methods for creating, updating and retrieving CdnConfiguration objects.

Usage

dfp_createCdnConfigurations(request_data, as_df = TRUE,
  verbose = FALSE)

Arguments

Details

createCdnConfigurations

Creates new CdnConfiguration objects. Creates new CdnConfiguration objects. Creates new CdnConfiguration objects.

Value

a data.frame or list containing all the elements of a createCdnConfigurationsResponse

See Also

Google Documentation for createCdnConfigurations

Examples

## Not run: 
 res <- dfp_createCdnConfigurations(request_data)

## End(Not run)

Description

Provides operations for creating, updating and retrieving Company objects.

Usage

dfp_createCompanies(request_data, as_df = TRUE, verbose = FALSE)

Arguments

Details

createCompanies

Creates new Company objects.

Value

a data.frame or list containing all the elements of a createCompaniesResponse

See Also

Google Documentation for createCompanies

Examples

## Not run: 
request_data <- list(companies=list(name="TestCompany1", 
                                    type='HOUSE_ADVERTISER', 
                                    address='123 Main St Hometown, FL USA', 
                                    email='[email protected]', 
                                    comment='API Test'))
result <- dfp_createCompanies(request_data)

## End(Not run)

Description

Provides methods for creating, updating and retrieving Contact objects.

Usage

dfp_createContacts(request_data, as_df = TRUE, verbose = FALSE)

Arguments

Details

createContacts

Creates new Contact objects.

Value

a data.frame or list containing all the elements of a createContactsResponse

See Also

Google Documentation for createContacts

Examples

## Not run: 
request_data <- list(contacts=list(name="TestContact1", 
                                   companyId=dfp_createCompanies_result$id, 
                                   status='UNINVITED', 
                                   cellPhone='(888) 999-7777',
                                   comment='API Test', 
                                   email='[email protected]'))
result <- dfp_createContacts(request_data)

## End(Not run)

Description

Provides methods for creating, updating and retrieving ContentBundle objects. A ContentBundle is a grouping of Content that match filter rules as well as taking into account explicitly included or excluded Content.

Usage

dfp_createContentBundles(request_data, as_df = TRUE, verbose = FALSE)

Arguments

Details

createContentBundles

Creates new ContentBundle objects.

Value

a data.frame or list containing all the elements of a createContentBundlesResponse

See Also

Google Documentation for createContentBundles

Examples

## Not run: 
 res <- dfp_createContentBundles(request_data)

## End(Not run)

Description

Provides methods for adding, updating and retrieving Creative objects.

Usage

dfp_createCreatives(request_data, as_df = TRUE, verbose = FALSE)

Arguments

Details

For a creative to run, it must be associated with a LineItem managed by the LineItemCreativeAssociationService.#' Read more about creatives on the <a href="https://support.google.com/dfp_premium/answer/3185155">DFP Help Center</a>.

createCreatives

Creates new Creative objects.

Value

a data.frame or list containing all the elements of a createCreativesResponse

See Also

Google Documentation for createCreatives

Examples

## Not run: 
 res <- dfp_createCreatives(request_data)

## End(Not run)

Description

Provides methods for adding, updating and retrieving CreativeSet objects.

Usage

dfp_createCreativeSet(request_data, as_df = TRUE, verbose = FALSE)

Arguments

Details

createCreativeSet

Creates a new CreativeSet.

Value

a data.frame or list containing all the elements of a createCreativeSetResponse

See Also

Google Documentation for createCreativeSet

Examples

## Not run: 
 res <- dfp_createCreativeSet(request_data)

## End(Not run)

Description

Provides methods for the creation and management of creative wrappers. CreativeWrapper CreativeWrappers allow HTML snippets to be served along with creatives. Creative wrappers must be associated with a LabelType#CREATIVE_WRAPPER label and applied to ad units by AdUnit#appliedLabels.

Usage

dfp_createCreativeWrappers(request_data, as_df = TRUE, verbose = FALSE)

Arguments

Details

createCreativeWrappers

Creates a new CreativeWrapper objects. The following fields are required:

• CreativeWrapper labelId

• CreativeWrapper ordering

• CreativeWrapper header or CreativeWrapper footer

Value

a data.frame or list containing all the elements of a createCreativeWrappersResponse

See Also

Google Documentation for createCreativeWrappers

Examples

## Not run: 
 res <- dfp_createCreativeWrappers(request_data)

## End(Not run)

Description

Provides methods for the creation and management of CustomField objects.

Usage

dfp_createCustomFieldOptions(request_data, as_df = TRUE,
  verbose = FALSE)

Arguments

Details

createCustomFieldOptions

Creates new CustomFieldOption objects. The following fields are required:

• CustomFieldOption displayName

• CustomFieldOption customFieldId

Value

a data.frame or list containing all the elements of a createCustomFieldOptionsResponse

See Also

Google Documentation for createCustomFieldOptions

Examples

## Not run: 
request_data <- data.frame(customFieldId=rep(dfp_createCustomFields_result$id, 3),
                           displayName=c('Morning', 'Afternoon', 'Evening'))
result <- dfp_createCustomFieldOptions(request_data)

## End(Not run)

Description

Creates new CustomField objects. The following fields are required:

• CustomField name

• CustomField entityType

• CustomField dataType

• CustomField visibility

Usage

dfp_createCustomFields(request_data, as_df = TRUE, verbose = FALSE)

Arguments

Value

a data.frame or list containing all the elements of a createCustomFieldsResponse

See Also

Google Documentation for createCustomFields

Examples

## Not run: 
request_data <- data.frame(name='Timing',
                           description='The time that this creative runs.', 
                           entityType='CREATIVE',
                           dataType='DROP_DOWN',
                           visibility='FULL')
result <- dfp_createCustomFields(request_data)

## End(Not run)

Description

Provides operations for creating, updating and retrieving CustomTargetingKey and CustomTargetingValue objects.

Usage

dfp_createCustomTargetingKeys(request_data, as_df = TRUE,
  verbose = FALSE)

Arguments

Details

createCustomTargetingKeys

Creates new CustomTargetingKey objects. The following fields are required:

• CustomTargetingKey name

• CustomTargetingKey type

Value

a data.frame or list containing all the elements of a createCustomTargetingKeysResponse

See Also

Google Documentation for createCustomTargetingKeys

Examples

## Not run: 
request_data <- list(keys=list(name="Test1", 
                               displayName="TestKey1", 
                               type='FREEFORM'))
result <- dfp_createCustomTargetingKeys(request_data)

## End(Not run)

Description

Creates new CustomTargetingValue objects. The following fields are required:

• CustomTargetingValue customTargetingKeyId

• CustomTargetingValue name

Usage

dfp_createCustomTargetingValues(request_data, as_df = TRUE,
  verbose = FALSE)

Arguments

Value

a data.frame or list containing all the elements of a createCustomTargetingValuesResponse

See Also

Google Documentation for createCustomTargetingValues

Examples

## Not run: 
request_data <- data.frame(customTargetingKeyId=rep(created_targeting_key$id,2),
                           name=c('TestValue1','TestValue2'), 
                           displayName=c('TestValue1','TestValue2'), 
                           matchType=rep('EXACT', 2))
result <- dfp_createCustomTargetingValues(request_data)

## End(Not run)

Description

Provides methods for creating, updating and retrieving DaiAuthenticationKey objects.

Usage

dfp_createDaiAuthenticationKeys(request_data, as_df = TRUE,
  verbose = FALSE)

Arguments

Details

createDaiAuthenticationKeys

Creates new DaiAuthenticationKey objects. The following fields are required:

• DaiAuthenticationKey name

Value

a data.frame or list containing all the elements of a createDaiAuthenticationKeysResponse

See Also

Google Documentation for createDaiAuthenticationKeys

Examples

## Not run: 
 res <- dfp_createDaiAuthenticationKeys(request_data)

## End(Not run)

Description

Provides methods for adding, updating and retrieving ExchangeRate objects.

Usage

dfp_createExchangeRates(request_data, as_df = TRUE, verbose = FALSE)

Arguments

Details

createExchangeRates

Creates new ExchangeRate objects. For each exchange rate, the following fields are required:

• ExchangeRate currencyCode

• ExchangeRate exchangeRate when ExchangeRate refreshRate is ExchangeRateRefreshRate FIXED

Value

a data.frame or list containing all the elements of a createExchangeRatesResponse

See Also

Google Documentation for createExchangeRates

Examples

## Not run: 
 res <- dfp_createExchangeRates(request_data)

## End(Not run)

Description

Provides methods for the creation and management of Labels.

Usage

dfp_createLabels(request_data, as_df = TRUE, verbose = FALSE)

Arguments

Details

createLabels

Creates new Label objects.

Value

a data.frame or list containing all the elements of a createLabelsResponse

See Also

Google Documentation for createLabels

Examples

## Not run: 
request_data <- data.frame(name="Auto - Competitive Exclusion",
                           description=paste0("A label to prevent two different car ",
                                              "companies from showing ads together"),
                           types='COMPETITIVE_EXCLUSION')
request_data <- list('labels'=hypothetical_label)
result <- dfp_createLabels(request_data)

## End(Not run)

Description

Provides operations for creating, updating and retrieving LineItemCreativeAssociation objects. A line item creative association (LICA) associates a Creative with a LineItem. When a line item is selected to serve, the LICAs specify which creatives can appear for the ad units that are targeted by the line item. In order to be associated with a line item, the creative must have a size that exists within the attribute LineItem#creativeSizes.#' Each LICA has a start and end date and time that defines when the creative should be displayed.#' To read more about associating creatives with line items, see this <a href="https://support.google.com/dfp_premium/answer/3187916">DFP Help Center</a> article.

Usage

dfp_createLineItemCreativeAssociations(request_data, as_df = TRUE,
  verbose = FALSE)

Arguments

Details

createLineItemCreativeAssociations

Creates new LineItemCreativeAssociation objects

Value

a data.frame or list containing all the elements of a createLineItemCreativeAssociationsResponse

See Also

Google Documentation for createLineItemCreativeAssociations

Examples

## Not run: 
 res <- dfp_createLineItemCreativeAssociations(request_data)

## End(Not run)

Description

#' Provides methods for creating, updating and retrieving LineItem objects.

Usage

dfp_createLineItems(request_data, as_df = TRUE, verbose = FALSE)

Arguments

Details

Line items define the campaign. For example, line items define:

• a budget

• a span of time to run

• ad unit targeting

In short, line items connect all of the elements of an ad campaign. Line items and creatives can be associated with each other through LineItemCreativeAssociation objects. An ad unit will host a creative through both this association and the LineItem#targeting to it.

createLineItems

Creates new LineItem objects.

Value

a data.frame or list containing all the elements of a createLineItemsResponse

See Also

Google Documentation for createLineItems

Examples

## Not run: 
 res <- dfp_createLineItems(request_data)

## End(Not run)

Description

Provides methods for creating, updating and retrieving LiveStreamEvent objects. This feature is not yet openly available for DFP Video publishers. Publishers will need to apply for access for this feature through their account managers.

Usage

dfp_createLiveStreamEvents(request_data, as_df = TRUE, verbose = FALSE)

Arguments

Details

createLiveStreamEvents

Creates new LiveStreamEvent objects. The following fields are required:

• LiveStreamEvent name

• LiveStreamEvent startDateTime

• LiveStreamEvent endDateTime

• LiveStreamEvent contentUrls

• LiveStreamEvent adTags

Value

a data.frame or list containing all the elements of a createLiveStreamEventsResponse

See Also

Google Documentation for createLiveStreamEvents

Examples

## Not run: 
 res <- dfp_createLiveStreamEvents(request_data)

## End(Not run)

Description

Provides methods for retrieving MobileApplication objects.

Usage

dfp_createMobileApplications(request_data, as_df = TRUE,
  verbose = FALSE)

Arguments

Details

createMobileApplications

Creates and claims MobileApplication mobile applications to be used for targeting in the network.

Value

a data.frame or list containing all the elements of a createMobileApplicationsResponse

See Also

Google Documentation for createMobileApplications

Examples

## Not run: 
 res <- dfp_createMobileApplications(request_data)

## End(Not run)

Description

Provides methods for creating and retrieving NativeStyle objects.

Usage

dfp_createNativeStyles(request_data, as_df = TRUE, verbose = FALSE)

Arguments

Details

createNativeStyles

Creates new NativeStyle objects.

Value

a data.frame or list containing all the elements of a createNativeStylesResponse

See Also

Google Documentation for createNativeStyles

Examples

## Not run: 
 res <- dfp_createNativeStyles(request_data)

## End(Not run)

Description

Provides methods for creating, updating and retrieving Order objects.

Usage

dfp_createOrders(request_data, as_df = TRUE, verbose = FALSE)

Arguments

Details

An order is a grouping of LineItem objects. Line items have a many-to-one relationship with orders, meaning each line item can belong to only one order, but orders can have multiple line items. An order can be used to manage the line items it contains.

createOrders

Creates new Order objects.

Value

a data.frame or list containing all the elements of a createOrdersResponse

See Also

Google Documentation for createOrders

Examples

## Not run: 
request_data <- list('filterStatement'=list('query'="WHERE name = 'TestCompany1'"))
dfp_getCompaniesByStatement_result <- dfp_getCompaniesByStatement(request_data) 

request_data <- list(list(name='TestOrder', 
                          startDateTime=list(date=list(year=2018, month=12, day=1), 
                                             hour=0,
                                             minute=0,
                                             second=0,
                                             timeZoneID='America/New_York'),
                          endDateTime=list(date=list(year=2018, month=12, day=31), 
                                           hour=23,
                                           minute=59,
                                           second=59,
                                           timeZoneID='America/New_York'), 
                          notes='API Test Order', 
                          externalOrderId=99999, 
                          advertiserId=dfp_getCompaniesByStatement_result$id, 
                          traffickerId=dfp_getCurrentUser()$id))
dfp_createOrders_result <- dfp_createOrders(request_data)

## End(Not run)

Description

Provides methods for creating, updating and retrieving Package objects.

Usage

dfp_createPackages(request_data, as_df = TRUE, verbose = FALSE)

Arguments

Details

To use this service, you need to have the new sales management solution enabled on your network. If you do not see a "Sales" tab in <a href="https://www.google.com/dfp">DoubleClick for Publishers (DFP)</a>, you will not be able to use this service.

createPackages

Creates new Package objects. For each package, the following fields are required:

• Package proposalId

• Package productPackageId

• Package name

Value

a data.frame or list containing all the elements of a createPackagesResponse

See Also

Google Documentation for createPackages

Examples

## Not run: 
 res <- dfp_createPackages(request_data)

## End(Not run)

Description

Provides methods for creating, updating and retrieving Placement objects.

Usage

dfp_createPlacements(request_data, as_df = TRUE, verbose = FALSE)

Arguments

Details

You can use a placement to group ad units. For example, you might have a placement that focuses on sports sites, which may be spread across different branches of your inventory. You might also have a "fire sale" placement that includes ad units that have not been selling and are consequently priced very attractively.

createPlacements

Creates new Placement objects.

Value

a data.frame or list containing all the elements of a createPlacementsResponse

See Also

Google Documentation for createPlacements

Examples

## Not run: 
 res <- dfp_createPlacements(request_data)

## End(Not run)

Description

Provides methods for managing PremiumRate objects. To use this service, you need to have the new sales management solution enabled on your network. If you do not see a "Sales" tab in <a href="https://www.google.com/dfp">DoubleClick for Publishers (DFP)</a>, you will not be able to use this service.

Usage

dfp_createPremiumRates(request_data, as_df = TRUE, verbose = FALSE)

Arguments

Details

createPremiumRates

Creates a list of new PremiumRate objects.

Value

a data.frame or list containing all the elements of a createPremiumRatesResponse

See Also

Google Documentation for createPremiumRates

Examples

## Not run: 
 res <- dfp_createPremiumRates(request_data)

## End(Not run)

Description

Provides methods for creating and retrieving ProductPackageItem objects.

Usage

dfp_createProductPackageItems(request_data, as_df = TRUE,
  verbose = FALSE)

Arguments

Details

A ProductPackageItem represents a product which will be associated with a ProductPackage. To use this service, you need to have the new sales management solution enabled on your network. If you do not see a "Sales" tab in <a href="https://www.google.com/dfp">DoubleClick for Publishers (DFP)</a>, you will not be able to use this service.

createProductPackageItems

Creates new ProductPackageItem objects.

Value

a data.frame or list containing all the elements of a createProductPackageItemsResponse

See Also

Google Documentation for createProductPackageItems

Examples

## Not run: 
 res <- dfp_createProductPackageItems(request_data)

## End(Not run)

Description

Provides methods for updating and retrieving ProductPackage objects. A ProductPackage represents a group of products which will be sold together.

Usage

dfp_createProductPackages(request_data, as_df = TRUE, verbose = FALSE)

Arguments

Details

To use this service, you need to have the new sales management solution enabled on your network. If you do not see a "Sales" tab in <a href="https://www.google.com/dfp">DoubleClick for Publishers (DFP)</a>, you will not be able to use this service.

createProductPackages

Creates new ProductPackage objects.

Value

a data.frame or list containing all the elements of a createProductPackagesResponse

See Also

Google Documentation for createProductPackages

Examples

## Not run: 
 res <- dfp_createProductPackages(request_data)

## End(Not run)

Description

Provides methods for creating, updating and retrieving ProductTemplate objects. A product template is used to generate a set of products. Products allow inventory managers to control what salespeople can sell.

Usage

dfp_createProductTemplates(request_data, as_df = TRUE, verbose = FALSE)

Arguments

Details

To use this service, you need to have the new sales management solution enabled on your network. If you do not see a "Sales" tab in <a href="https://www.google.com/dfp">DoubleClick for Publishers (DFP)</a>, you will not be able to use this service.

createProductTemplates

Creates new ProductTemplate objects.

Value

a data.frame or list containing all the elements of a createProductTemplatesResponse

See Also

Google Documentation for createProductTemplates

Examples

## Not run: 
 res <- dfp_createProductTemplates(request_data)

## End(Not run)

Description

Provides methods for creating, updating and retrieving ProposalLineItem objects. To use this service, you need to have the new sales management solution enabled on your network. If you do not see a "Sales" tab in <a href="https://www.google.com/dfp">DoubleClick for Publishers (DFP)</a>, you will not be able to use this service.

Usage

dfp_createProposalLineItems(request_data, as_df = TRUE,
  verbose = FALSE)

Arguments

Details

createProposalLineItems

Creates new ProposalLineItem objects.

Value

a data.frame or list containing all the elements of a createProposalLineItemsResponse

See Also

Google Documentation for createProposalLineItems

Examples

## Not run: 
 res <- dfp_createProposalLineItems(request_data)

## End(Not run)

Description

Provides methods for adding, updating and retrieving Proposal objects.

Usage

dfp_createProposals(request_data, as_df = TRUE, verbose = FALSE)

Arguments

Details

createProposals

Creates new Proposal objects. For each proposal, the following fields are required:

• Proposal name

Value

a data.frame or list containing all the elements of a createProposalsResponse

See Also

Google Documentation for createProposals

Examples

## Not run: 
 res <- dfp_createProposals(request_data)

## End(Not run)

Description

Provides methods for managing RateCard objects. To use this service, you need to have the new sales management solution enabled on your network. If you do not see a "Sales" tab in <a href="https://www.google.com/dfp">DoubleClick for Publishers (DFP)</a>, you will not be able to use this service.

Usage

dfp_createRateCards(request_data, as_df = TRUE, verbose = FALSE)

Arguments

Details

createRateCards

Creates a list of RateCard objects. Rate cards must be activated before being associated with proposal line items and products.

Value

a data.frame or list containing all the elements of a createRateCardsResponse

See Also

Google Documentation for createRateCards

Examples

## Not run: 
 res <- dfp_createRateCards(request_data)

## End(Not run)

Description

Provides methods for creating, updating, and retrieving Team objects.

Usage

dfp_createTeams(request_data, as_df = TRUE, verbose = FALSE)

Arguments

Details

Teams are used to group users in order to define access to entities such as companies, inventory and orders.

createTeams

Creates new Team objects. The following fields are required:

• Team name

Value

a data.frame or list containing all the elements of a createTeamsResponse

See Also

Google Documentation for createTeams

Examples

## Not run: 
request_data <- list(teams=list(name="TestTeam1", 
                                description='API Test Team 1', 
                                hasAllCompanies='true', 
                                hasAllInventory='true',
                                teamAccessType='READ_WRITE'))
result <- dfp_createTeams(request_data)

## End(Not run)

Description

Provides operations for creating, updating and retrieving User objects.

Usage

dfp_createUsers(request_data, as_df = TRUE, verbose = FALSE)

Arguments

Details

A user is assigned one of several different roles. Each Role type has a unique ID that is used to identify that role in an organization. Role types and their IDs can be retrieved by invoking #getAllRoles.

createUsers

Creates new User objects.

Value

a data.frame or list containing all the elements of a createUsersResponse

See Also

Google Documentation for createUsers

Examples

## Not run: 
request_data <- data.frame(name = paste0("TestUser", 1:3),
                           email = paste0('testuser', 1:3, '@gmail.com'), 
                           roleId = rep(-1, 3))
result <- dfp_createUsers(request_data)

## End(Not run)

Description

Provides methods for creating, updating, and retrieving UserTeamAssociation objects. UserTeamAssociation objects are used to add users to teams in order to define access to entities such as companies, inventory and orders and to override the team's access type to orders for a user.

Usage

dfp_createUserTeamAssociations(request_data, as_df = TRUE,
  verbose = FALSE)

Arguments

Details

createUserTeamAssociations

Creates new UserTeamAssociation objects.

Value

a data.frame or list containing all the elements of a createUserTeamAssociationsResponse

See Also

Google Documentation for createUserTeamAssociations

Examples

## Not run: 
request_data <- data.frame(teamid=rep(dfp_createTeams_result$id, 3),
                           userid=dfp_createUsers_result$id)
result <- dfp_createUserTeamAssociations(request_data)

## End(Not run)

Description

Take a datetime representation in R and convert it to the list required by DFP to indicate a datetime

Usage

dfp_date_to_list(this_date, daytime = c("beginning", "end"),
  timeZoneId = Sys.timezone(), ensure_today_works = TRUE)

Arguments

Value

a list formatted to the spec required for StartDateTime or EndDateTime

Examples

dfp_date_to_list(Sys.Date()+1)

Description

Take a report request and manage all aspects for user until returning a data.frame or error

Usage

dfp_full_report_wrapper(request_data, 
                               check_interval=3, 
                               max_tries=20, 
                               verbose=FALSE)

Arguments

Value

a data.frame of report results as specified by the request_data

See Also

dfp_runReportJob

dfp_getReportJobStatus

dfp_getReportDownloadURL

Examples

## Not run: 
request_data <- list(reportJob =
                       list(reportQuery =
                              list(dimensions = 'MONTH_AND_YEAR',
                                   dimensions = 'AD_UNIT_ID',
                                   dimensions = 'AD_UNIT_NAME',
                                   dimensions = 'ADVERTISER_NAME',
                                   dimensions = 'ORDER_NAME',
                                   dimensions = 'LINE_ITEM_NAME',
                                   adUnitView = 'FLAT',
                                   columns = 'AD_SERVER_IMPRESSIONS', 
                                   columns = 'AD_SERVER_CLICKS',
                                   dateRangeType = 'LAST_WEEK')))
report_data <- dfp_full_report_wrapper(request_data)

## End(Not run)

Description

Gets an ActivityPage of Activity objects that satisfy the given Statement query. The following fields are supported for filtering:

• id

• name

• expectedURL

• status

• activityGroupId

Usage

dfp_getActivitiesByStatement(request_data, as_df = TRUE,
  verbose = FALSE)

Arguments

Value

a data.frame or list containing all the elements of a getActivitiesByStatementResponse

See Also

Google Documentation for getActivitiesByStatement

Examples

## Not run: 
 dat <- list(filterStatement=list('query'="WHERE status='ACTIVE'")) 
 res <- dfp_getActivitiesByStatement(dat)

## End(Not run)

Description

Gets an ActivityGroupPage of ActivityGroup objects that satisfy the given Statement query. The following fields are supported for filtering:

• id

• name

• impressionsLookback

• clicksLookback

• status

Usage

dfp_getActivityGroupsByStatement(request_data, as_df = TRUE,
  verbose = FALSE)

Arguments

Value

a data.frame or list containing all the elements of a getActivityGroupsByStatementResponse

See Also

Google Documentation for getActivityGroupsByStatement

Examples

## Not run: 
 dat <- list(filterStatement=list('query'="WHERE status='ACTIVE'")) 
 res <- dfp_getActivityGroupsByStatement(dat)

## End(Not run)

Description

Gets a AdExclusionRulePage of AdExclusionRule objects that satisfy the given Statement query. The following fields are supported for filtering:

• id

• name

• status

Usage

dfp_getAdExclusionRulesByStatement(request_data, as_df = TRUE,
  verbose = FALSE)

Arguments

Value

a data.frame or list containing all the elements of a getAdExclusionRulesByStatementResponse

See Also

Google Documentation for getAdExclusionRulesByStatement

Examples

## Not run: 
 dat <- list(filterStatement=list('query'="WHERE status='ACTIVE'")) 
 res <- dfp_getAdExclusionRulesByStatement(dat)

## End(Not run)

Description

Gets an AdRulePage of AdRule objects that satisfy the given {@link Statement query}. The following fields are supported for filtering:

• id

• name

• priority

• status

Usage

dfp_getAdRulesByStatement(request_data, as_df = TRUE, verbose = FALSE)

Arguments

Value

a data.frame or list containing all the elements of a getAdRulesByStatementResponse

See Also

Google Documentation for getAdRulesByStatement

Examples

## Not run: 
 dat <- list(filterStatement=list('query'="WHERE status='ACTIVE'")) 
 res <- dfp_getAdRulesByStatement(dat)

## End(Not run)

Description

Gets a AdSpotPage of AdSpot objects that satisfy the given {@link Statement query}.

Usage

dfp_getAdSpotsByStatement(request_data, as_df = TRUE, verbose = FALSE)

Arguments

Value

a data.frame or list containing all the elements of a getAdSpotsByStatementResponse

See Also

Google Documentation for getAdSpotsByStatement

Examples

## Not run: 
 dat <- list(filterStatement=list('query'="WHERE status='ACTIVE'")) 
 res <- dfp_getAdSpotsByStatement(dat)

## End(Not run)

Description

Gets a AdUnitPage of AdUnit objects that satisfy the given Statement query. The following fields are supported for filtering:

• adUnitCode

• id

• name

• parentId

• status

• lastModifiedDateTime

Usage

dfp_getAdUnitsByStatement(request_data, as_df = FALSE, verbose = FALSE)

Arguments

Value

a data.frame or list containing all the elements of a getAdUnitsByStatementResponse

See Also

Google Documentation for getAdUnitsByStatement

Examples

## Not run: 
 dat <- list(filterStatement=list('query'="WHERE status='ACTIVE'")) 
 res <- dfp_getAdUnitsByStatement(dat)

## End(Not run)

Description

Gets a set of AdUnitSize objects that satisfy the given Statement query. The following fields are supported for filtering:

• targetPlatform

Usage

dfp_getAdUnitSizesByStatement(request_data, as_df = TRUE,
  verbose = FALSE)

Arguments

Value

a data.frame or list containing all the elements of a getAdUnitSizesByStatementResponse

See Also

Google Documentation for getAdUnitSizesByStatement

Examples

## Not run: 
 dat <- list(filterStatement=list('query'="WHERE status='ACTIVE'")) 
 res <- dfp_getAdUnitSizesByStatement(dat)

## End(Not run)

Description

Provides operations for retrieving information related to the publisher's networks. This service can be used to obtain the list of all networks that the current login has access to, or to obtain information about a specific network.

Usage

dfp_getAllNetworks(as_df = TRUE, verbose = FALSE)

Arguments

Details

getAllNetworks

Returns the list of Network objects to which the current login has access. Intended to be used without a network code in the SOAP header when the login may have more than one network associated with it.Returns the list of Network objects to which the current login has access. Intended to be used without a network code in the SOAP header when the login may have more than one network associated with it.@return the networks to which the current login has access Returns the list of Network objects to which the current login has access. Intended to be used without a network code in the SOAP header when the login may have more than one network associated with it.@return the networks to which the current login has access

Value

a data.frame or list containing all the elements of a getAllNetworksResponse

See Also

Google Documentation for getAllNetworks

Examples

## Not run: 
 res <- dfp_getAllNetworks()

## End(Not run)

Description

Returns the Role objects that are defined for the users of the network. Returns the Role objects that are defined for the users of the network. @return the roles defined for the user's network Returns the Role objects that are defined for the users of the network. @return the roles defined for the user's network

Usage

dfp_getAllRoles(as_df = TRUE, verbose = FALSE)

Arguments

Value

a data.frame or list containing all the elements of a getAllRolesResponse

See Also

Google Documentation for getAllRoles

Examples

## Not run: 
 res <- dfp_getAllRoles()

## End(Not run)

Description

Gets an AudienceSegmentPage of AudienceSegment objects that satisfy the given Statement query. The following fields are supported for filtering:

• id

• name

• status

• type

• size

• dataProviderName

• approvalStatus

• cost

• startDateTime

• endDateTime

Usage

dfp_getAudienceSegmentsByStatement(request_data, as_df = TRUE,
  verbose = FALSE)

Arguments

Value

a data.frame or list containing all the elements of a getAudienceSegmentsByStatementResponse

See Also

Google Documentation for getAudienceSegmentsByStatement

Examples

## Not run: 
 dat <- list(filterStatement=list('query'="WHERE status='ACTIVE'")) 
 res <- dfp_getAudienceSegmentsByStatement(dat)

## End(Not run)

Description

Provides methods for estimating traffic (clicks/impressions) for line items. Forecasts can be provided for LineItem objects that exist in the system or which have not had an ID set yet.

Usage

dfp_getAvailabilityForecast(request_data, as_df = TRUE,
  verbose = FALSE)

Arguments

Details

Test Network Behavior

Test networks are unable to provide forecasts that would be comparable to the production environment because forecasts require traffic history. Visit the See Also section below to proceed to Google and review the details.'

getAvailabilityForecast

Gets the availability forecast for a ProspectiveLineItem. An availability forecast reports the maximum number of available units that the line item can book, and the total number of units matching the line item's targeting.

Value

a data.frame or list containing all the elements of a getAvailabilityForecastResponse

See Also

Google Documentation for getAvailabilityForecast

Examples

## Not run: 
filter <- "WHERE Status='DELIVERING' LIMIT 1"
one_li <- dfp_getLineItemsByStatement(list(filterStatement=list(query=filter)))[[1]]
hypothetical_line_item <- list(lineItem=
                               list(id=one_li$id,
                                    startDateTime=one_li$startDateTime,
                                    endDateTime=dfp_date_to_list(Sys.Date()+100),
                                    lineItemType=one_li$lineItemType,
                                    costType=one_li$costType, 
                                    primaryGoal=one_li$primaryGoal, 
                                    targeting=one_li$targeting))
request_data <- list(lineItem=hypothetical_line_item,
                     forecastOptions=list(includeTargetingCriteriaBreakdown='true', 
                                          includeContendingLineItems='true'))
dfp_getAvailabilityForecast_result <- dfp_getAvailabilityForecast(request_data)

## End(Not run)

Description

Gets an AvailabilityForecast for an existing LineItem object. An availability forecast reports the maximum number of available units that the line item can be booked with, and also the total number of units matching the line item's targeting. Only line items having type LineItemType SPONSORSHIP or {@link LineItemType STANDARD} are valid. Other types will result in {@link ReservationDetailsError.Reason LINE_ITEM_TYPE_NOT_ALLOWED}. Gets an AvailabilityForecast for an existing LineItem object. An availability forecast reports the maximum number of available units that the line item can be booked with, and also the total number of units matching the line item's targeting. Only line items having type LineItemType SPONSORSHIP or LineItemType STANDARD are valid. Other types will result in ReservationDetailsError.Reason LINE_ITEM_TYPE_NOT_ALLOWED. @param lineItemId the ID of a LineItem to run the forecast on. @param forecastOptions options controlling the forecast Gets an AvailabilityForecast for an existing LineItem object. An availability forecast reports the maximum number of available units that the line item can be booked with, and also the total number of units matching the line item's targeting. Only line items having type LineItemType SPONSORSHIP or LineItemType STANDARD are valid. Other types will result in ReservationDetailsError.Reason LINE_ITEM_TYPE_NOT_ALLOWED. @param lineItemId the ID of a LineItem to run the forecast on. @param forecastOptions options controlling the forecast

Usage

dfp_getAvailabilityForecastById(request_data, as_df = TRUE,
  verbose = FALSE)

Arguments

Value

a data.frame or list containing all the elements of a getAvailabilityForecastByIdResponse

See Also

Google Documentation for getAvailabilityForecastById

Examples

## Not run: 
filter <- "WHERE Status='DELIVERING' LIMIT 1"
one_li <- dfp_getLineItemsByStatement(list(filterStatement=list(query=filter)))[[1]]
request_data <- list(lineItemId=one_li$id,
                     forecastOptions=list(includeTargetingCriteriaBreakdown='true', 
                                          includeContendingLineItems='true'))
result <- dfp_getAvailabilityForecastById(request_data)

## End(Not run)

Description

Gets a BaseRatePage of BaseRate objects that satisfy the given Statement query. The following fields are supported for filtering:

• rateCardId

• id

• productTemplateId

Usage

dfp_getBaseRatesByStatement(request_data, as_df = TRUE,
  verbose = FALSE)

Arguments

Value

a data.frame or list containing all the elements of a getBaseRatesByStatementResponse

See Also

Google Documentation for getBaseRatesByStatement

Examples

## Not run: 
 dat <- list(filterStatement=list('query'="WHERE status='ACTIVE'")) 
 res <- dfp_getBaseRatesByStatement(dat)

## End(Not run)

Description

Gets a CdnConfigurationPage of CdnConfiguration objects that satisfy the given Statement query. Currently only CDN Configurations of type {@link CdnConfigurationType LIVE_STREAM_SOURCE_CONTENT} will be returned. The following fields are supported for filtering:

• id

• name

Usage

dfp_getCdnConfigurationsByStatement(request_data, as_df = TRUE,
  verbose = FALSE)

Arguments

Value

a data.frame or list containing all the elements of a getCdnConfigurationsByStatementResponse

See Also

Google Documentation for getCdnConfigurationsByStatement

Examples

## Not run: 
 dat <- list(filterStatement=list('query'="WHERE status='ACTIVE'")) 
 res <- dfp_getCdnConfigurationsByStatement(dat)

## End(Not run)

Description

Provides methods for querying CMS metadata keys and values. A CMS metadata value corresponds to one key value pair ingested from a publisher's CMS and is used to target all the content with which it is associated in the CMS.

Usage

dfp_getCmsMetadataKeysByStatement(request_data, as_df = TRUE,
  verbose = FALSE)

Arguments

Details

getCmsMetadataKeysByStatement

Returns a page of CmsMetadataKeys matching the specified Statement. The following fields are supported for filtering:

• id

• cmsKey

Value

a data.frame or list containing all the elements of a getCmsMetadataKeysByStatementResponse

See Also

Google Documentation for getCmsMetadataKeysByStatement

Examples

## Not run: 
 dat <- list(filterStatement=list('query'="WHERE status='ACTIVE'")) 
 res <- dfp_getCmsMetadataKeysByStatement(dat)

## End(Not run)

Description

Returns a page of CmsMetadataValues matching the specified Statement. The following fields are supported for filtering:

• id

• cmsValue

• cmsKey

• keyValueMemberContent

Usage

dfp_getCmsMetadataValuesByStatement(request_data, as_df = TRUE,
  verbose = FALSE)

Arguments

Value

a data.frame or list containing all the elements of a getCmsMetadataValuesByStatementResponse

See Also

Google Documentation for getCmsMetadataValuesByStatement

Examples

## Not run: 
 dat <- list(filterStatement=list('query'="WHERE status='ACTIVE'")) 
 res <- dfp_getCmsMetadataValuesByStatement(dat)

## End(Not run)

Description

Gets a CompanyPage of Company objects that satisfy the given Statement query. The following fields are supported for filtering:

• id

• name

• type

• lastModifiedDateTime

Usage

dfp_getCompaniesByStatement(request_data, as_df = TRUE,
  verbose = FALSE)

Arguments

Value

a data.frame or list containing all the elements of a getCompaniesByStatementResponse

See Also

Google Documentation for getCompaniesByStatement

Examples

## Not run: 
 dat <- list(filterStatement=list('query'="WHERE status='ACTIVE'")) 
 res <- dfp_getCompaniesByStatement(dat)

## End(Not run)

Description

Gets a ContactPage of Contact objects that satisfy the given Statement query. The following fields are supported for filtering:

• name

• email

• id

• comment

• companyId

• title

• cellPhone

• workPhone

• faxPhone

• status

Usage

dfp_getContactsByStatement(request_data, as_df = TRUE, verbose = FALSE)

Arguments

Value

a data.frame or list containing all the elements of a getContactsByStatementResponse

See Also

Google Documentation for getContactsByStatement

Examples

## Not run: 
 dat <- list(filterStatement=list('query'="WHERE status='ACTIVE'")) 
 res <- dfp_getContactsByStatement(dat)

## End(Not run)

Description

Gets a ContentBundlePage of ContentBundle objects that satisfy the given Statement query. The following fields are supported for filtering:

• id

• name

• status

Usage

dfp_getContentBundlesByStatement(request_data, as_df = TRUE,
  verbose = FALSE)

Arguments

Value

a data.frame or list containing all the elements of a getContentBundlesByStatementResponse

See Also

Google Documentation for getContentBundlesByStatement

Examples

## Not run: 
 dat <- list(filterStatement=list('query'="WHERE status='ACTIVE'")) 
 res <- dfp_getContentBundlesByStatement(dat)

## End(Not run)

Description

Service for retrieving Content. Content entities can be targeted in video LineItems. You can query for content that belongs to a particular category or has assigned metadata. Categories and metadata for Content are stored in DFP as CustomCriteria. For example, to find all Content that is "genre=comedy", you would:

• Retrieve the custom targeting key corresponding to "genre" using CustomTargetingService#getCustomTargetingKeysByStatement

• Using the CustomTargetingService#getCustomTargetingValuesByStatement method and a filter like "WHERE customTargetingKeyId = :genreKeyId and name = 'comedy'", retrieve the ID for the "comedy" custom targeting value.

• Call #getContentByStatementAndCustomTargetingValue with a filter like "WHERE status = 'ACTIVE'" and the ID of the custom targeting value from step 2.

Usage

dfp_getContentByStatement(request_data, as_df = TRUE, verbose = FALSE)

Arguments

Details

getContentByStatement

Gets a ContentPage of Content objects that satisfy the given {@link Statement query}. The following fields are supported for filtering:

• id

• status

• name

• lastModifiedDateTime

• lastDaiIngestDateTime

• daiIngestStatus

Value

a data.frame or list containing all the elements of a getContentByStatementResponse

See Also

Google Documentation for getContentByStatement

Examples

## Not run: 
 dat <- list(filterStatement=list('query'="WHERE status='ACTIVE'")) 
 res <- dfp_getContentByStatement(dat)

## End(Not run)

Description

Gets a ContentPage of Content objects that satisfy the given Statement query. Additionally, filters on the given value ID and key ID that the value belongs to. The following fields are supported for filtering:

• id

• status

• name

• lastModifiedDateTime

Usage

dfp_getContentByStatementAndCustomTargetingValue(as_df = TRUE,
  verbose = FALSE)

Arguments

Value

a data.frame or list containing all the elements of a getContentByStatementAndCustomTargetingValueResponse

See Also

Google Documentation for getContentByStatementAndCustomTargetingValue

Examples

## Not run: 
 res <- dfp_getContentByStatementAndCustomTargetingValue()

## End(Not run)

Description

Gets a CreativePage of Creative objects that satisfy the given Statement query. The following fields are supported for filtering:

• id

• name

• advertiserId

• width

• height

• lastModifiedDateTime

Usage

dfp_getCreativesByStatement(request_data, as_df = TRUE,
  verbose = FALSE)

Arguments

Value

a data.frame or list containing all the elements of a getCreativesByStatementResponse

See Also

Google Documentation for getCreativesByStatement

Examples

## Not run: 
 dat <- list(filterStatement=list('query'="WHERE status='ACTIVE'")) 
 res <- dfp_getCreativesByStatement(dat)

## End(Not run)

Description

Gets a CreativeSetPage of CreativeSet objects that satisfy the given Statement query. The following fields are supported for filtering:

• id

• name

• masterCreativeId

• lastModifiedDateTime

Usage

dfp_getCreativeSetsByStatement(request_data, as_df = TRUE,
  verbose = FALSE)

Arguments

Value

a data.frame or list containing all the elements of a getCreativeSetsByStatementResponse

See Also

Google Documentation for getCreativeSetsByStatement

Examples

## Not run: 
 dat <- list(filterStatement=list('query'="WHERE status='ACTIVE'")) 
 res <- dfp_getCreativeSetsByStatement(dat)

## End(Not run)

Description

Provides methods for retrieving CreativeTemplate objects.

Usage

dfp_getCreativeTemplatesByStatement(request_data, as_df = FALSE,
  verbose = FALSE)

Arguments

Details

getCreativeTemplatesByStatement

Gets a CreativeTemplatePage of CreativeTemplate objects that satisfy the given Statement query. The following fields are supported for filtering:

• id

• name

• type

• status

Value

a data.frame or list containing all the elements of a getCreativeTemplatesByStatementResponse

See Also

Google Documentation for getCreativeTemplatesByStatement

Examples

## Not run: 
 dat <- list(filterStatement=list('query'="WHERE status='ACTIVE'")) 
 res <- dfp_getCreativeTemplatesByStatement(dat)

## End(Not run)

Description

Gets a CreativeWrapperPage of CreativeWrapper objects that satisfy the given Statement query. The following fields are supported for filtering:

• id

• labelId

• status

• ordering

Usage

dfp_getCreativeWrappersByStatement(request_data, as_df = TRUE,
  verbose = FALSE)

Arguments

Value

a data.frame or list containing all the elements of a getCreativeWrappersByStatementResponse

See Also

Google Documentation for getCreativeWrappersByStatement

Examples

## Not run: 
 dat <- list(filterStatement=list('query'="WHERE status='ACTIVE'")) 
 res <- dfp_getCreativeWrappersByStatement(dat)

## End(Not run)

Description

Returns the current network for which requests are being made. Returns the current network for which requests are being made. @return the network for which the user is currently making the request Returns the current network for which requests are being made. @return the network for which the user is currently making the request

Usage

dfp_getCurrentNetwork(as_df = TRUE, verbose = FALSE)

Arguments

Value

a data.frame or list containing all the elements of a getCurrentNetworkResponse

See Also

Google Documentation for getCurrentNetwork

Examples

## Not run: 
 res <- dfp_getCurrentNetwork()

## End(Not run)

Description

Returns the current User. Returns the current User. @return the current user Returns the current User. @return the current user

Usage

dfp_getCurrentUser(as_df = TRUE, verbose = FALSE)

Arguments

Value

a data.frame or list containing all the elements of a getCurrentUserResponse

See Also

Google Documentation for getCurrentUser

Examples

## Not run: 
 res <- dfp_getCurrentUser()

## End(Not run)

Description

Returns the CustomFieldOption uniquely identified by the given ID.

Usage

dfp_getCustomFieldOption(request_data, as_df = TRUE, verbose = FALSE)

Arguments

Value

a data.frame or list containing all the elements of a getCustomFieldOptionResponse

See Also

Google Documentation for getCustomFieldOption

Examples

## Not run: 
 res <- dfp_getCustomFieldOption(request_data)

## End(Not run)

Description

Gets a CustomFieldPage of CustomField objects that satisfy the given Statement query. The following fields are supported for filtering:

• id

• entityType

• name

• isActive

• visibility

Usage

dfp_getCustomFieldsByStatement(request_data, as_df = TRUE,
  verbose = FALSE)

Arguments

Value

a data.frame or list containing all the elements of a getCustomFieldsByStatementResponse

See Also

Google Documentation for getCustomFieldsByStatement

Examples

## Not run: 
 dat <- list(filterStatement=list('query'="WHERE status='ACTIVE'")) 
 res <- dfp_getCustomFieldsByStatement(dat)

## End(Not run)

Description

Gets a CustomTargetingKeyPage of CustomTargetingKey objects that satisfy the given Statement query. The following fields are supported for filtering:

• NA

• id

• name

• displayName

• type

Usage

dfp_getCustomTargetingKeysByStatement(request_data, as_df = TRUE,
  verbose = FALSE)

Arguments

Value

a data.frame or list containing all the elements of a getCustomTargetingKeysByStatementResponse

See Also

Google Documentation for getCustomTargetingKeysByStatement

Examples

## Not run: 
 dat <- list(filterStatement=list('query'="WHERE status='ACTIVE'")) 
 res <- dfp_getCustomTargetingKeysByStatement(dat)

## End(Not run)

Description

Gets a CustomTargetingValuePage of CustomTargetingValue objects that satisfy the given Statement query. The WHERE clause in the Statement query must always contain CustomTargetingValue customTargetingKeyId as one of its columns in a way that it is AND'ed with the rest of the query. So, if you want to retrieve values for a known set of key ids, valid Statement query would look like: "WHERE customTargetingKeyId IN ('17','18','19')" retrieves all values that are associated with keys having ids 17, 18, 19. "WHERE customTargetingKeyId = '17' AND name = 'red'" retrieves values that are associated with keys having id 17 and value name is 'red'. The following fields are supported for filtering:

• id

• customTargetingKeyId

• name

• displayName

• matchType

Usage

dfp_getCustomTargetingValuesByStatement(request_data, as_df = TRUE,
  verbose = FALSE)

Arguments

Value

a data.frame or list containing all the elements of a getCustomTargetingValuesByStatementResponse

See Also

Google Documentation for getCustomTargetingValuesByStatement

Examples

## Not run: 
 dat <- list(filterStatement=list('query'="WHERE status='ACTIVE'")) 
 res <- dfp_getCustomTargetingValuesByStatement(dat)

## End(Not run)

Description

Gets a DaiAuthenticationKeyPage of DaiAuthenticationKey objects that satisfy the given Statement query. The following fields are supported for filtering:

• id

• status

• name

Usage

dfp_getDaiAuthenticationKeysByStatement(request_data, as_df = TRUE,
  verbose = FALSE)

Arguments

Value

a data.frame or list containing all the elements of a getDaiAuthenticationKeysByStatementResponse

See Also

Google Documentation for getDaiAuthenticationKeysByStatement

Examples

## Not run: 
 dat <- list(filterStatement=list('query'="WHERE status='ACTIVE'")) 
 res <- dfp_getDaiAuthenticationKeysByStatement(dat)

## End(Not run)

Description

Gets the delivery forecast for a list of ProspectiveLineItem objects in a single delivery simulation with line items potentially contending with each other. A delivery forecast reports the number of units that will be delivered to each line item given the line item goals and contentions from other line items. Gets the delivery forecast for a list of ProspectiveLineItem objects in a single delivery simulation with line items potentially contending with each other. A delivery forecast reports the number of units that will be delivered to each line item given the line item goals and contentions from other line items. @param lineItems line items to be forecasted for delivery @param forecastOptions options controlling the forecast Gets the delivery forecast for a list of ProspectiveLineItem objects in a single delivery simulation with line items potentially contending with each other. A delivery forecast reports the number of units that will be delivered to each line item given the line item goals and contentions from other line items. @param lineItems line items to be forecasted for delivery @param forecastOptions options controlling the forecast

Usage

dfp_getDeliveryForecast(request_data, as_df = TRUE, verbose = FALSE)

Arguments

Value

a data.frame or list containing all the elements of a getDeliveryForecastResponse

See Also

Google Documentation for getDeliveryForecast

Examples

## Not run: 
filter <- "WHERE Status='DELIVERING' LIMIT 1"
one_li <- dfp_getLineItemsByStatement(list(filterStatement=list(query=filter)))[[1]]
hypothetical_line_item <- list(lineItem=
                               list(id=one_li$id,
                                    startDateTime=one_li$startDateTime,
                                    endDateTime=dfp_date_to_list(Sys.Date()+100),
                                    lineItemType=one_li$lineItemType,
                                    costType=one_li$costType, 
                                    primaryGoal=one_li$primaryGoal, 
                                    targeting=one_li$targeting))
request_data <- list(lineItems=hypothetical_line_item,
                     forecastOptions=list(ignoredLineItemIds=NULL))
dfp_getDeliveryForecast_result <- dfp_getDeliveryForecast(request_data)

## End(Not run)

Description

Gets the delivery forecast for a list of existing LineItem objects in a single delivery simulation. A delivery forecast reports the number of units that will be delivered to each line item given the line item goals and contentions from other line items. Gets the delivery forecast for a list of existing LineItem objects in a single delivery simulation. A delivery forecast reports the number of units that will be delivered to each line item given the line item goals and contentions from other line items. @param lineItemIds the IDs of line items to be forecasted for delivery @param forecastOptions options controlling the forecast Gets the delivery forecast for a list of existing LineItem objects in a single delivery simulation. A delivery forecast reports the number of units that will be delivered to each line item given the line item goals and contentions from other line items. @param lineItemIds the IDs of line items to be forecasted for delivery @param forecastOptions options controlling the forecast

Usage

dfp_getDeliveryForecastByIds(request_data, as_df = TRUE,
  verbose = FALSE)

Arguments

Value

a data.frame or list containing all the elements of a getDeliveryForecastByIdsResponse

See Also

Google Documentation for getDeliveryForecastByIds

Examples

## Not run: 
filter <- "WHERE Status='DELIVERING' LIMIT 1"
one_li <- dfp_getLineItemsByStatement(list(filterStatement=list(query=filter)))[[1]]

# not specifying forecastOptions brings up NotNullError.ARG2_NULL, so send, but keep null
request_data <- list(lineItemIds=one_li$id,
                     forecastOptions=list(ignoredLineItemIds=NULL))
result <- dfp_getDeliveryForecastByIds(request_data)

## End(Not run)

Description

Gets a ExchangeRatePage of ExchangeRate objects that satisfy the given Statement query. The following fields are supported for filtering:

• id

• currencyCode

• refreshRate

• direction

• exchangeRate

Usage

dfp_getExchangeRatesByStatement(request_data, as_df = TRUE,
  verbose = FALSE)

Arguments

Value

a data.frame or list containing all the elements of a getExchangeRatesByStatementResponse

See Also

Google Documentation for getExchangeRatesByStatement

Examples

## Not run: 
 dat <- list(filterStatement=list('query'="WHERE status='ACTIVE'")) 
 res <- dfp_getExchangeRatesByStatement(dat)

## End(Not run)

Description

Gets a LabelPage of Label objects that satisfy the given Statement query. The following fields are supported for filtering:

• id

• type

• name

• description

• isActive

Usage

dfp_getLabelsByStatement(request_data, as_df = TRUE, verbose = FALSE)

Arguments

Value

a data.frame or list containing all the elements of a getLabelsByStatementResponse

See Also

Google Documentation for getLabelsByStatement

Examples

## Not run: 
 dat <- list(filterStatement=list('query'="WHERE status='ACTIVE'")) 
 res <- dfp_getLabelsByStatement(dat)

## End(Not run)

Description

Gets a LineItemCreativeAssociationPage of LineItemCreativeAssociation objects that satisfy the given Statement query. The following fields are supported for filtering:

• creativeId

• manualCreativeRotationWeight

• destinationUrl

• lineItemId

• status

• lastModifiedDateTime

Usage

dfp_getLineItemCreativeAssociationsByStatement(request_data,
  as_df = TRUE, verbose = FALSE)

Arguments

Value

a data.frame or list containing all the elements of a getLineItemCreativeAssociationsByStatementResponse

See Also

Google Documentation for getLineItemCreativeAssociationsByStatement

Examples

## Not run: 
 dat <- list(filterStatement=list('query'="WHERE status='ACTIVE'")) 
 res <- dfp_getLineItemCreativeAssociationsByStatement(dat)

## End(Not run)

Description

Gets a LineItemPage of LineItem objects that satisfy the given Statement query. The following fields are supported for filtering:

• CostType

• CreationDateTime

• DeliveryRateType

• EndDateTime

• ExternalId

• Id

• IsMissingCreatives

• IsSetTopBoxEnabled

• LastModifiedDateTime

• LineItemType

• Name

• OrderId

• StartDateTime

• Status

• Targeting

• UnitsBought

Usage

dfp_getLineItemsByStatement(request_data, as_df = FALSE,
  verbose = FALSE)

Arguments

Value

a data.frame or list containing all the elements of a getLineItemsByStatementResponse

See Also

Google Documentation for getLineItemsByStatement

Examples

## Not run: 
filter <- "WHERE LineItemType='STANDARD' and Status='DELIVERING' LIMIT 10"
result <- dfp_getLineItemsByStatement(list(filterStatement=list(query=filter)))

## End(Not run)

Description

Provides methods for creating, updating and retrieving LineItemTemplate objects.

Usage

dfp_getLineItemTemplatesByStatement(request_data, as_df = TRUE,
  verbose = FALSE)

Arguments

Details

getLineItemTemplatesByStatement

Gets a LineItemTemplatePage of LineItemTemplate objects that satisfy the given Statement query. The following fields are supported for filtering:

• id

Value

a data.frame or list containing all the elements of a getLineItemTemplatesByStatementResponse

See Also

Google Documentation for getLineItemTemplatesByStatement

Examples

## Not run: 
 dat <- list(filterStatement=list('query'="WHERE status='ACTIVE'")) 
 res <- dfp_getLineItemTemplatesByStatement(dat)

## End(Not run)

Description

Gets a LiveStreamEventPage of LiveStreamEvent objects that satisfy the given Statement query. The following fields are supported for filtering:

• id

Usage

dfp_getLiveStreamEventsByStatement(request_data, as_df = TRUE,
  verbose = FALSE)

Arguments

Value

a data.frame or list containing all the elements of a getLiveStreamEventsByStatementResponse

See Also

Google Documentation for getLiveStreamEventsByStatement

Examples

## Not run: 
 dat <- list(filterStatement=list('query'="WHERE status='ACTIVE'")) 
 res <- dfp_getLiveStreamEventsByStatement(dat)

## End(Not run)

Description

Gets a MarketplaceCommentPage of MarketplaceComment objects that satisfy the given Statement query. This method only returns comments already sent to Marketplace, local draft ProposalMarketplaceInfo marketplaceComment are not included. The following fields are supported for filtering:

• proposalId

Usage

dfp_getMarketplaceCommentsByStatement(request_data, as_df = TRUE,
  verbose = FALSE)

Arguments

Value

a data.frame or list containing all the elements of a getMarketplaceCommentsByStatementResponse

See Also

Google Documentation for getMarketplaceCommentsByStatement

Examples

## Not run: 
 dat <- list(filterStatement=list('query'="WHERE status='ACTIVE'")) 
 res <- dfp_getMarketplaceCommentsByStatement(dat)

## End(Not run)

Description

Gets a MobileApplicationPage mobileApplicationPage of MobileApplication mobile applications that satisfy the given Statement. The following fields are supported for filtering:

• id

• displayName

• appStore

• appStoreId

• NA

• isArchived

Usage

dfp_getMobileApplicationsByStatement(request_data, as_df = TRUE,
  verbose = FALSE)

Arguments

Value

a data.frame or list containing all the elements of a getMobileApplicationsByStatementResponse

See Also

Google Documentation for getMobileApplicationsByStatement

Examples

## Not run: 
 dat <- list(filterStatement=list('query'="WHERE status='ACTIVE'")) 
 res <- dfp_getMobileApplicationsByStatement(dat)

## End(Not run)

Description

Gets a NativeStylePage NativeStylePage of NativeStyle objects that satisfy the given Statement. The following fields are supported for filtering:

• id

• name

Usage

dfp_getNativeStylesByStatement(request_data, as_df = TRUE,
  verbose = FALSE)

Arguments

Value

a data.frame or list containing all the elements of a getNativeStylesByStatementResponse

See Also

Google Documentation for getNativeStylesByStatement

Examples

## Not run: 
 dat <- list(filterStatement=list('query'="WHERE status='ACTIVE'")) 
 res <- dfp_getNativeStylesByStatement(dat)

## End(Not run)

Description

Gets an OrderPage of Order objects that satisfy the given Statement query. The following fields are supported for filtering:

• advertiserId

• endDateTime

• id

• name

• salespersonId

• startDateTime

• status

• traffickerId

• lastModifiedDateTime

Usage

dfp_getOrdersByStatement(request_data, as_df = TRUE, verbose = FALSE)

Arguments

Value

a data.frame or list containing all the elements of a getOrdersByStatementResponse

See Also

Google Documentation for getOrdersByStatement

Examples

## Not run: 
 dat <- list(filterStatement=list('query'="WHERE status='ACTIVE'")) 
 res <- dfp_getOrdersByStatement(dat)

## End(Not run)

Description

Gets a PackagePage of Package objects that satisfy the given Statement query. The following fields are supported for filtering:

• id

• name

• proposalId

• productPackageId

• isArchived

• lastModifiedDateTime

Usage

dfp_getPackagesByStatement(request_data, as_df = TRUE, verbose = FALSE)

Arguments

Value

a data.frame or list containing all the elements of a getPackagesByStatementResponse

See Also

Google Documentation for getPackagesByStatement

Examples

## Not run: 
 dat <- list(filterStatement=list('query'="WHERE status='ACTIVE'")) 
 res <- dfp_getPackagesByStatement(dat)

## End(Not run)

Description

Gets a PlacementPage of Placement objects that satisfy the given Statement query. The following fields are supported for filtering:

• description

• id

• name

• placementCode

• status

• lastModifiedDateTime

Usage

dfp_getPlacementsByStatement(request_data, as_df = TRUE,
  verbose = FALSE)

Arguments

Value

a data.frame or list containing all the elements of a getPlacementsByStatementResponse

See Also

Google Documentation for getPlacementsByStatement

Examples

## Not run: 
 dat <- list(filterStatement=list('query'="WHERE status='ACTIVE'")) 
 res <- dfp_getPlacementsByStatement(dat)

## End(Not run)

Description

Gets a PremiumRatePage of PremiumRate objects that satisfy the given Statement query. The following fields are supported for filtering:

• id

• rateCardId

• pricingMethod

Usage

dfp_getPremiumRatesByStatement(request_data, as_df = TRUE,
  verbose = FALSE)

Arguments

Value

a data.frame or list containing all the elements of a getPremiumRatesByStatementResponse

See Also

Google Documentation for getPremiumRatesByStatement

Examples

## Not run: 
 dat <- list(filterStatement=list('query'="WHERE status='ACTIVE'")) 
 res <- dfp_getPremiumRatesByStatement(dat)

## End(Not run)

Description

Returns an insite preview URL that references the specified site URL with the specified creative from the association served to it. For Creative Set previewing you may specify the master creative Id.

Usage

dfp_getPreviewUrl(as_df = TRUE, verbose = FALSE)

Arguments

Value

a data.frame or list containing all the elements of a getPreviewUrlResponse

See Also

Google Documentation for getPreviewUrl

Examples

## Not run: 
 res <- dfp_getPreviewUrl()

## End(Not run)

Description

Returns a list of URLs that reference the specified site URL with the specified creative from the association served to it. For Creative Set previewing you may specify the master creative Id. Each URL corresponds to one available native style for previewing the specified creative. creative

Usage

dfp_getPreviewUrlsForNativeStyles(as_df = TRUE, verbose = FALSE)

Arguments

Value

a data.frame or list containing all the elements of a getPreviewUrlsForNativeStylesResponse

See Also

Google Documentation for getPreviewUrlsForNativeStyles

Examples

## Not run: 
 res <- dfp_getPreviewUrlsForNativeStyles()

## End(Not run)

Description

Gets a ProductPackageItemPage of ProductPackageItem objects that satisfy the filtering criteria specified by given Statement query. The following fields are supported for filtering:

• id

• productPackageId

• productId

• productTemplateId

• mandatory

• archived

Usage

dfp_getProductPackageItemsByStatement(request_data, as_df = TRUE,
  verbose = FALSE)

Arguments

Value

a data.frame or list containing all the elements of a getProductPackageItemsByStatementResponse

See Also

Google Documentation for getProductPackageItemsByStatement

Examples

## Not run: 
 dat <- list(filterStatement=list('query'="WHERE status='ACTIVE'")) 
 res <- dfp_getProductPackageItemsByStatement(dat)

## End(Not run)

Description

Gets a ProductPackagePage of ProductPackage objects that satisfy the filtering criteria specified by given Statement query. The following fields are supported for filtering:

• id

• name

• notes

• status

• isArchived

• lastModifiedDateTime

Usage

dfp_getProductPackagesByStatement(request_data, as_df = TRUE,
  verbose = FALSE)

Arguments

Value

a data.frame or list containing all the elements of a getProductPackagesByStatementResponse

See Also

Google Documentation for getProductPackagesByStatement

Examples

## Not run: 
 dat <- list(filterStatement=list('query'="WHERE status='ACTIVE'")) 
 res <- dfp_getProductPackagesByStatement(dat)

## End(Not run)

Description

Provides methods for updating and retrieving Product objects. A Product represents a line item proposal. Products are generated from ProductTemplate product templates on a periodic basis using the product template's attributes. Products are typically used by inventory managers to restrict what salespeople can sell. To use this service, you need to have the new sales management solution enabled on your network. If you do not see a "Sales" tab in <a href="https://www.google.com/dfp">DoubleClick for Publishers (DFP)</a>, you will not be able to use this service.

Usage

dfp_getProductsByStatement(request_data, as_df = TRUE, verbose = FALSE)

Arguments

Details

getProductsByStatement

Gets a ProductPage of Product objects that satisfy the criteria specified by given Statement query. When using sales management, the following fields are supported for filtering and/or sorting.

• rateCardId

• status

• lineItemType

• productType

• rateType

• productTemplateId

• name

• description

• id

• lastModifiedDateTime

Value

a data.frame or list containing all the elements of a getProductsByStatementResponse

See Also

Google Documentation for getProductsByStatement

Examples

## Not run: 
 dat <- list(filterStatement=list('query'="WHERE status='ACTIVE'")) 
 res <- dfp_getProductsByStatement(dat)

## End(Not run)

Description

Gets a ProductTemplatePage of ProductTemplate objects that satisfy the filtering criteria specified by given Statement query. The following fields are supported for filtering:

• id

• name

• nameMacro

• description

• status

• lastModifiedDateTime

• lineItemType

• productType

• rateType

Usage

dfp_getProductTemplatesByStatement(request_data, as_df = TRUE,
  verbose = FALSE)

Arguments

Value

a data.frame or list containing all the elements of a getProductTemplatesByStatementResponse

See Also

Google Documentation for getProductTemplatesByStatement

Examples

## Not run: 
 dat <- list(filterStatement=list('query'="WHERE status='ACTIVE'")) 
 res <- dfp_getProductTemplatesByStatement(dat)

## End(Not run)

Description

Gets a ProposalLineItemPage of ProposalLineItem objects that satisfy the given Statement query. The following fields are supported for filtering:

• id

• name

• proposalId

• startDateTime

• endDateTime

• isArchived

• lastModifiedDateTime

• useThirdPartyAdServerFromProposal Only applicable for non-programmatic proposal line items using sales management

• thirdPartyAdServerId Only applicable for non-programmatic proposal line items using sales management

• customThirdPartyAdServerName Only applicable for non-programmatic proposal line items using sales management

• isProgrammatic

Usage

dfp_getProposalLineItemsByStatement(request_data, as_df = TRUE,
  verbose = FALSE)

Arguments

Value

a data.frame or list containing all the elements of a getProposalLineItemsByStatementResponse

See Also

Google Documentation for getProposalLineItemsByStatement

Examples

## Not run: 
 dat <- list(filterStatement=list('query'="WHERE status='ACTIVE'")) 
 res <- dfp_getProposalLineItemsByStatement(dat)

## End(Not run)

Description

Gets a ProposalPage of Proposal objects that satisfy the given Statement query. The following fields are supported for filtering:

• id

• dfpOrderId

• name

• status

• isArchived

• approvalStatus Only applicable for proposals using sales management

• lastModifiedDateTime

• thirdPartyAdServerId Only applicable for non-programmatic proposals using sales management

• customThirdPartyAdServerName Only applicable for non-programmatic proposals using sales management

• hasOfflineErrors

• isProgrammatic

• negotiationStatus Only applicable for programmatic proposals

Usage

dfp_getProposalsByStatement(request_data, as_df = TRUE,
  verbose = FALSE)

Arguments

Value

a data.frame or list containing all the elements of a getProposalsByStatementResponse

See Also

Google Documentation for getProposalsByStatement

Examples

## Not run: 
 dat <- list(filterStatement=list('query'="WHERE status='ACTIVE'")) 
 res <- dfp_getProposalsByStatement(dat)

## End(Not run)

Description

Gets a RateCardPage of RateCard objects that satisfy the given Statement query. The following fields are supported for filtering:

• ForMarketplace

• Id

• LastModifiedDateTime

• Name

• Status

Usage

dfp_getRateCardsByStatement(request_data, as_df = TRUE,
  verbose = FALSE)

Arguments

Value

a data.frame or list containing all the elements of a getRateCardsByStatementResponse

See Also

Google Documentation for getRateCardsByStatement

Examples

## Not run: 
 dat <- list(filterStatement=list('query'="WHERE status='ACTIVE'")) 
 res <- dfp_getRateCardsByStatement(dat)

## End(Not run)

Description

Provides methods for retrieving and updating ReconciliationLineItemReport objects.

Usage

dfp_getReconciliationLineItemReportsByStatement(request_data,
  as_df = TRUE, verbose = FALSE)

Arguments

Details

getReconciliationLineItemReportsByStatement

Gets a ReconciliationLineItemReportPage of ReconciliationLineItemReport objects that satisfy the given Statement query. The following fields are supported for filtering:

• id

• reconciliationReportId

• orderId

• proposalId

• lineItemId

• proposalLineItemId

Value

a data.frame or list containing all the elements of a getReconciliationLineItemReportsByStatementResponse

See Also

Google Documentation for getReconciliationLineItemReportsByStatement

Examples

## Not run: 
 dat <- list(filterStatement=list('query'="WHERE status='ACTIVE'")) 
 res <- dfp_getReconciliationLineItemReportsByStatement(dat)

## End(Not run)

Description

Provides methods for retrieving, reconciling, and reverting ReconciliationOrderReport objects.

Usage

dfp_getReconciliationOrderReportsByStatement(request_data, as_df = TRUE,
  verbose = FALSE)

Arguments

Details

getReconciliationOrderReportsByStatement

Gets an ReconciliationOrderReportPage of ReconciliationOrderReport objects that satisfy the given Statement query. The following fields are supported for filtering:

• reconciliationReportId

• id

• orderId

• proposalId

• status

• submissionDateTime

• submitterId

Value

a data.frame or list containing all the elements of a getReconciliationOrderReportsByStatementResponse

See Also

Google Documentation for getReconciliationOrderReportsByStatement

Examples

## Not run: 
 dat <- list(filterStatement=list('query'="WHERE status='ACTIVE'")) 
 res <- dfp_getReconciliationOrderReportsByStatement(dat)

## End(Not run)

Description

Provides methods for retrieving and updating the ReconciliationReportRow objects.

Usage

dfp_getReconciliationReportRowsByStatement(request_data, as_df = TRUE,
  verbose = FALSE)

Arguments

Details

getReconciliationReportRowsByStatement

Gets a ReconciliationReportRowPage of ReconciliationReportRow objects that satisfy the given Statement query. The following fields are supported for filtering:

• reconciliationReportId

• advertiserId

• orderId

• lineItemId

• proposalLineItemId

• creativeId

• lineItemCostType

• dfpClicks

• dfpImpressions

• dfpLineItemDays

• thirdPartyClicks

• thirdPartyImpressions

• thirdPartyLineItemDays

• manualClicks

• manualImpressions

• manualLineItemDays

• reconciledClicks

• reconciledImpressions

• reconciledLineItemDays

Value

a data.frame or list containing all the elements of a getReconciliationReportRowsByStatementResponse

See Also

Google Documentation for getReconciliationReportRowsByStatement

Examples

## Not run: 
 dat <- list(filterStatement=list('query'="WHERE status='ACTIVE'")) 
 res <- dfp_getReconciliationReportRowsByStatement(dat)

## End(Not run)

Description

Provides methods for retrieving, submitting and reverting the ReconciliationReport objects. A ReconciliationReport is a group of ReconciliationReportRow objects.

Usage

dfp_getReconciliationReportsByStatement(request_data, as_df = TRUE,
  verbose = FALSE)

Arguments

Details

getReconciliationReportsByStatement

Gets an ReconciliationReportPage of ReconciliationReport objects that satisfy the given Statement query. The following fields are supported for filtering.

• id

• status

• startDate

Value

a data.frame or list containing all the elements of a getReconciliationReportsByStatementResponse

See Also

Google Documentation for getReconciliationReportsByStatement

Examples

## Not run: 
 dat <- list(filterStatement=list('query'="WHERE status='ACTIVE'")) 
 res <- dfp_getReconciliationReportsByStatement(dat)

## End(Not run)

Description

Provides methods for executing a ReportJob and retrieving performance and statistics about ad campaigns, networks, inventory and sales. Follow the steps outlined below:

• Create the ReportJob object by invoking ReportService#runReportJob.

• Poll the ReportJob object using ReportService#getReportJob.

• Continue to poll the ReportJob object until the ReportJob#reportJobStatus field is equal to ReportJobStatus#COMPLETED or ReportJobStatus#FAILED.

• If successful, fetch the URL for downloading the report by invoking ReportService#getReportDownloadURL.

<h4>Test network behavior</h4> The networks created using NetworkService#makeTestNetwork are unable to provide reports that would be comparable to the production environment because reports require traffic history. In the test networks, reports will consistently return no data for all reports.

Usage

dfp_getReportDownloadURL(request_data, as_df = FALSE, verbose = FALSE)

Arguments

Details

getReportDownloadURL

Returns the URL at which the report file can be downloaded. The report will be generated as a gzip archive, containing the report file itself.