- 4 Minutes to read
Display & Video 360 Walkthrough
- 4 Minutes to read
Display & Video 360 API version 2 is currently supported.
This guide will show you how to get the data from Display & Video 360 into Rivery.
- Display & Video 360 Connection
Display & Video 360 source in Rivery can be executed in one of the following options:
Create a new query
Type : Select a report type.
- TYPE_ORDER_IDsupports date ranges at most 60 days in the past.
support date ranges at most 30 days in the past.
Partners : When 'Auto Complete Partners' is selected, clicking the 'Partners' input will show up a list of all the account's partners. You may select one or more partners, or leave empty to pull data for all partners. When the following message pops up, select the 'Type manually partners IDs ' option and insert partners IDs manually. You must insert at least one partner ID when this option is selected.
You can find a list of your partner IDs here.
Please make sure to select the partner's ID and not his name, an example of a partner ID could look like this: 123456789.
When the following message pops up, select the 'Type manually partners IDs ' option and insert partners IDs manually. You must insert at least one partner ID when this option is selected.
Metrics: Select metrics to include as columns in your report.
Group-bys: Data is grouped by the filters listed in this field.
Filters : Data is filtered by the selected filters. To add filters, click on the 'add filters' button, and select a filter name and value for each filter. You may add the same filter more than once, with different values, in order to get results for multiple filtered values.
Enabling ' Add filter to result columns (group by) ' will add the selected filter to the results as a column by adding it to 'group-bys'. Disable it will return aggregated results for this filter.
Locale : Locale of the generated reports. The default is English.
Timezone : The time zone used for the report.
Important : There are type/metrics/filters combinations which are not allowed to select. In the case of having this error, it is necessary to change the input parameters.
Query's Time Period
Select the time period of the report:
All the reports support two kinds of the time period:
Date Range -
- Pulls data in the date range between the start and end date provided, including the end date.
- You must select a Start date.
- The Start Date won't be advanced if a River run is unsuccessful.
If you don't want this default setting, click More Options and check the box to advance the start date even if the River run is unsuccessful (Not recommended).
- Leaving the End date empty will pull data according to the current time of the river's run.
- Select a timezone offset to send dates considering the offset.
- Use the "Last Days Back For Each Run" to expend the start date and pull data x days back before the chosen start date.
Predefined date - A date range defined by Rivery:
- Day - Yesterday.
- Week (From Monday to Sunday) - Week to date, Previous week, Previous week to date.
- Month - Month to date, Previous month, Previous month to date.
- Year - Year to date.
Rivery can run over the increment using chunks, in order to make the loading more efficient and more precise. Your options are:
Don't Split - Rivery will pull the data from the chosen start date to the end date in one bulk.
Daily - The run will be chunked daily from the start to the end date.
Monthly - The run will be chunked monthly from the start to the end date.
Yearly (Less Recommended) - The run will be chunked yearly from the start to the end date.
Decides either to keep that query in the Display & Video 360 query system or not. If 'keep report' is enabled, a query title must be submitted.
After running the river, when ‘keep report’ is enabled, the query will be available in the Display & Video 360 query system as any other query in the system , with the exact same configurations.
Important notice about scheduling Display & Video 360 rivers
When scheduling the river, the query will be created and executed in the given scheduled time periods.
If the ‘keep report’ input is enabled, a new query will be created in the Display & Video 360 query system in every river execution. For example, if the river is scheduled to be run every hour, it will create 24 new reports in Display & Video 360, one per hour.
Therefore, it is important to turn off the input of ‘keep report’ when scheduling a report which runs a “new query” in Display & Video 360. That way, after executing the query and getting its results, the query will be deleted from the system.
Run an existing query
An existing query is a predefined saved query in your Display & Video 360 console.
Click on the box or the refresh button to load all the saved queries from your console and select the one you wish to execute.
Run an entity reports
Entities provide additional information on your Display & Video 360 activities.
Rivery currently supports the Line items entity and Sdf entity, which retrieves entities in SDF format.
Select the desired entity.
- Line Items Report:
Select the filter type and insert the IDs of the specified filter type to filter line items to fetch. If omitted, all the line items will be returned.
- SDF Report:
File Type: Select the file type that will be returned.
Filters: Select the filter type and insert the IDs of the specified filter type to filter line items to fetch.
- At least one ID must be specified.
- Only one ID is allowed for the ' ADVERTISER_ID' filter type.
- For INSERTION_ORDER_ID or LINE_ITEM_ID
filter types all IDs must be from the same Advertiser.