Daily Performance Report

Daily Performance Report pipeline is used to request and retrieve details about the daily performance of various objects such as campaigns, adgroups, keywords, creative sets, and search terms. Read more about this here

Configuring the Credentials

Select the account credentials which has access to relevant Apple Search Ads data from the dropdown menu & Click Next

Credentials not listed in dropdown ?: Click on + Add New for adding new credentials

Data Pipelines Details

Data Pipeline: Select Daily Performance Report from the dropdown
Account: Select one or more accounts from the drop-down

All accounts which your credentials have access to should be available here. If they are not, please check the credentials selected / configured by you. While you can add multiple accounts, the table size may become too large and so it is advisable to add one report per pipeline and use Union queries in the data warehouse to join the data for consumption.

Field & Metrics: Select relevant fields and metrics from the drop-down. You can click on View Schema anytime to see the schema of the table which will get created.

Setting Parameters

Parameter	Description	Values
Insert Mode	*Required* Specifies the manner in which data will get updated in the data warehouse : Upsert will insert only new records or records with changes, Append will insert all fetched data at the end, Replace will drop the existing table and recreate a fresh one on each run.	{Upsert,Append,Replace} *Default Value:* Upsert
Object	*Required* Select to specify the object for which you wish to retrieve data in each run.	{campaign, adgroup, keyword, search_term, creative_set} *Default Value:* campaign
TimeZone	*Required* Select to specify the timezone for which you wish to retrieve data in each run.	{UTC, ORTZ} *Default Value:* UTC
No of Days	*Required* Number of days for which you wish to get the data in each run.	Integer value (Max value 30)
Group By	*Required* Specify the manner in which incoming data has to be grouped together in the report. The deviceClass dimension is a group of device classes that the promoted app supports, ageRange is a group of the user demographic age ranges, gender is a group of user-demographic genders, countryCode is a group of country codes that indicate the country or region to serve ads in, adminArea is a group of states or the equivalent according to its associated country, locality is the city or group of cities equivalent according to its associated adminArea, and countryOrRegion is a group of countries and regions.	{deviceClass, ageRange, gender, countryCode, adminArea, locality, countryOrRegion}

Parameter

Description

Values

Insert Mode

Required

Specifies the manner in which data will get updated in the data warehouse : Upsert will insert only new records or records with changes, Append will insert all fetched data at the end, Replace will drop the existing table and recreate a fresh one on each run.

{Upsert,Append,Replace}

Default Value: Upsert

Object

Required

Select to specify the object for which you wish to retrieve data in each run.

{campaign, adgroup, keyword, search_term, creative_set}

Default Value: campaign

TimeZone

Required

Select to specify the timezone for which you wish to retrieve data in each run.

{UTC, ORTZ}

Default Value: UTC

No of Days

Required

Number of days for which you wish to get the data in each run.

Integer value (Max value 30)

Group By

Required

Specify the manner in which incoming data has to be grouped together in the report. The deviceClass dimension is a group of device classes that the promoted app supports, ageRange is a group of the user demographic age ranges, gender is a group of user-demographic genders, countryCode is a group of country codes that indicate the country or region to serve ads in, adminArea is a group of states or the equivalent according to its associated country, locality is the city or group of cities equivalent according to its associated adminArea, and countryOrRegion is a group of countries and regions.

{deviceClass, ageRange, gender, countryCode, adminArea, locality, countryOrRegion}

Datapipeline Scheduling

Scheduling specifies the frequency with which data will get updated in the data warehouse. You can choose between Manual Run, Normal Scheduling or Advance Scheduling.

Manual Run: If scheduling is not required, you can use the toggle to run the pipeline manually.
Normal Scheduling: Use the dropdown to select an interval-based hourly, monthly, weekly, or daily frequency.
Advance Scheduling: Set schedules fine-grained at the level of Months, Days, Hours, and Minutes.

Detailed explanation on scheduling of pipelines can be found here

Dataset & Name

Dataset Name: Key in the Dataset Name(also serves as the table name in your data warehouse).Keep in mind, that the name should be unique across the account and the data source. Special characters (except underscore _) and blank spaces are not allowed. It is best to follow a consistent naming scheme for future search to locate the tables.
Dataset Description: Enter a short description (optional) describing the dataset being fetched by this particular pipeline.
Notifications: Choose the events for which you’d like to be notified: whether "ERROR ONLY" or "ERROR AND SUCCESS".

Once you have finished click on Finish to save it. Read more about naming and saving your pipelines including the option to save them as templates here

Still have Questions?

We’ll be happy to help you with any questions you might have! Send us an email at info@datachannel.co.

Subscribe to our Newsletter for latest updates at DataChannel.