summary
Help Page for ETL Configuration of Data Settings for Data Transfer from Yahoo! Display Ads (Managed).
YahooAdsAPI is used to retrieve data.
Setting items
STEP1 Basic settings
| item name | indispensable | default value | Contents |
|---|---|---|---|
| Yahoo! API Connection Configuration | Yes | - | Yahoo! Select the API Connection Configuration. |
| Method of acquisition | Yes | Report Retrieval | Specify " Get Report" if you want to get it in a report, or "Get Statistics" if you want to get it in stats. |
| Base Account ID | Yes | - | Connection Configuration Yahoo! Select an account (MCC account or advertising account) for which the JAPAN Business ID has direct authority. The operation will be available for the selected account and all accounts under it. |
| account ID | Yes | - | Enter the account ID for which data is to be retrieved that can be operated with the selected base account ID. Account IDs can be found on the Manage Display Ads administration page. |
| type | No | - | If you chose to obtain statistics for the target, specify the type here. In addition, the current ・CAMPAIGN ・ADGROUP ・AD type. |
| Data acquisition period | Yes | - | Specify the period for which you want to retrieve data. Please enter both start and end dates. Please enter in the format YYMMDD. Custom Variables can also be set to select the corresponding date for the actual ETL Configuration. |
| column (esp. in chemistry, file, equipment, etc.) | No | - | Enter the column information you wish to transfer. The columns that can be set depend on the acquisition method. See below for details. |
About columns
Due to an API update, the old indicator has been discontinued.
In accordance with the above, from now on, if a column containing "(old)" is specified in the column name, the new column will be automatically obtained.
- Example. If "CLICK_RATE_PREV (click rate (old))" is specified, "CLICK_RATE (click rate)" is automatically obtained.
For report acquisition
Advertising reports (account reports, campaign reports, ad group reports, linked URL reports)
*Errors may occur due to non-combinability depending on the items specified in STEP1. See here for specific non-combinable columns .
The following values and others can be set for column items
| column name | Contents | recommended type | Operating classification (*1) |
|---|---|---|---|
| ACCOUNT_ID | account ID | LONG | ATTRIBUTE |
| ACCOUNT_NAME | account name | STRING | ATTRIBUTE |
| CAMPAIGN_ID | campaign ID | LONG | ATTRIBUTE |
| CAMPAIGN_NAME | Campaign Name | STRING | ATTRIBUTE |
| ADGROUP_ID | advertising group ID | LONG | ATTRIBUTE |
| ADGROUP_NAME | Ad group name | STRING | ATTRIBUTE |
| AD_ID | Ad ID | LONG | ATTRIBUTE |
| AD_NAME | Advertisement Name | STRING | ATTRIBUTE |
| AD_TYPE | Ad Type | STRING | ATTRIBUTE |
| PREF_ID | prefectural ID | STRING | SEGMENT |
| PREF_NAME | administrative divisions of Japan: Tokyo-to, Hokkai-do, Osaka-fu and Kyoto-fu | STRING | SEGMENT |
| CITY_ID | city, district and county ID | STRING | SEGMENT |
| CITY_NAME | cities, wards, counties | STRING | SEGMENT |
| WARD_ID | administrative district ID | STRING | SEGMENT |
| WARD_NAME | administrative district | STRING | SEGMENT |
| GENDER | gender | STRING | SEGMENT |
| AGE | age | STRING | SEGMENT |
| MONTH | month | STRING | SEGMENT |
| DAY | day (of the month) | STRING | SEGMENT |
| HOUR | Hours. | LONG | SEGMENT |
| DELIVER | Advertisement method | STRING | ATTRIBUTE |
| DEVICE | device | STRING | SEGMENT |
| AD_STYLE | Publication format (image type) | STRING | SEGMENT |
| MEDIA_ID | media ID | STRING | SEGMENT |
| MEDIA_NAME | Media Name | STRING | SEGMENT |
| MEDIA_FILE_NAME | file-name | STRING | SEGMENT |
| MEDIA_AD_FORMAT | Pixel size | STRING | SEGMENT |
| AD_TITLE | Title. | STRING | ATTRIBUTE |
| DESCRIPTION1 | Description 1 | STRING | ATTRIBUTE |
| DESCRIPTION2 | Description 2 | STRING | ATTRIBUTE |
| DISPLAY_URL | display URL | STRING | ATTRIBUTE |
| SEARCHKEYWORD_ID | search keyword ID | LONG | SEGMENT |
| SEARCHKEYWORD | search keyword | STRING | SEGMENT |
| CONVERSION_CATEGORY | Purpose of Conversion Measurement | STRING | SEGMENT |
| CARRIER | carrier | STRING | SEGMENT |
| AD_LAYOUT | layout | STRING | ATTRIBUTE |
| IMAGE_OPTION | Automatic Image Assignment | STRING | SEGMENT |
| CONVERSION_NAME | Conversion Name | STRING | ATTRIBUTE |
| OS | OS | STRING | SEGMENT |
| APPLI | Web/Applications | STRING | SEGMENT |
| CAMPAIGN_TYPE | Campaign Type | STRING | ATTRIBUTE |
| APP_ID | App ID/Package Name | STRING | ATTRIBUTE |
| APP_NAME | App Name | STRING | ATTRIBUTE |
| APP_OS | Application OS | STRING | ATTRIBUTE |
| CAMPAIGN_GOALS | Campaign Objective | STRING | SEGMENT |
| CAMPAIGN_BUYING_TYPE | Campaign Purchase Type | STRING | ATTRIBUTE |
| DESTINATION_URL_CAMPAIGN_BANNER | Linked URL (campaign banner) | STRING | ATTRIBUTE |
| IMPS | Impressions | LONG | METRIC |
| CLICK_RATE | click rate | DOUBLE | METRIC |
| COST | cost | DOUBLE | METRIC |
| CLICK | Number of clicks | LONG | METRIC |
| AVG_CPC | Average CPC | DOUBLE | METRIC |
| AVG_DELIVER_RANK | average order of magnitude | DOUBLE | METRIC |
| TOTAL_VIEWABLE_IMPS | Number of Major Impressions (old) | LONG | METRIC |
| VIEWABLE_IMPS | Number of viewable impressions | LONG | METRIC |
| INVIEW_RATE | Viewable impression rate (old) | DOUBLE | METRIC |
| INVIEW_CLICK | Viewable clicks (old) | LONG | METRIC |
| INVIEW_CLICK_RATE | Viewable Click Rate (old) | DOUBLE | METRIC |
| AVG_CPV | Average CPV | DOUBLE | METRIC |
| VIDEO_VIEWS_TO_25 | 25% of video views | LONG | METRIC |
| VIDEO_VIEWS_TO_50 | 50% of video views | LONG | METRIC |
| VIDEO_VIEWS_TO_75 | 75% of video views | LONG | METRIC |
| VIDEO_VIEWS_TO_95 | 95% of video views | LONG | METRIC |
| VIDEO_VIEWS_TO_100 | 100% of video views | LONG | METRIC |
| AVG_PERCENT_VIDEO_VIEWED | Average video playback start rate | DOUBLE | METRIC |
| AVG_DURATION_VIDEO_VIEWED | Average playback time of video (seconds) | DOUBLE | METRIC |
| VIDEO_VIEWS | Number of video playback starts | LONG | METRIC |
| PAID_VIDEO_VIEWS | Number of video views for which billing occurred (CPV billing campaigns only) | LONG | METRIC |
| PAID_VIDEO_VIEW_RATE | Percentage of video views for which billing occurred (CPV billing campaigns only) | DOUBLE | METRIC |
| VIDEO_VIEWS_TO_3_SEC | Number of 3-second views of video | LONG | METRIC |
| CONVERSIONS | Number of conversions | LONG | METRIC |
| CONV_RATE | Conversion Rate | DOUBLE | METRIC |
| COST_PER_CONV | Cost/conversions | DOUBLE | METRIC |
| CONV_VALUE | Value of Conversion | LONG | METRIC |
| VALUE_PER_CONV | Value of conversions/number of conversions | DOUBLE | METRIC |
| ALL_CONV | Number of conversions (all) | LONG | METRIC |
| ALL_CONV_RATE | Conversion rate (all) | DOUBLE | METRIC |
| COST_PER_ALL_CONV | Cost/conversions (all) | DOUBLE | METRIC |
| ALL_CONV_VALUE | Value of conversion (all) | LONG | METRIC |
| VALUE_PER_ALL_CONV | Value of conversions (all)/number of conversions (all) | DOUBLE | METRIC |
| CONVERSIONS_VIA_AD_CLICK | Number of conversions (via clicks) | LONG | METRIC |
| CONVERSION_RATE_VIA_AD_CLICK | Conversion rate (via clicks) | DOUBLE | METRIC |
| COST_PER_CONV_VIA_AD_CLICK | Cost/conversions (via clicks) | DOUBLE | METRIC |
| CONV_VALUE_VIA_AD_CLICK | Value of conversion (via clicks) | LONG | METRIC |
| VALUE_PER_CONV_VIA_AD_CLICK | Value of conversions (via clicks)/Number of conversions (via clicks) | DOUBLE | METRIC |
| CROSS_DEVICE_CONVERSIONS | Cross-device conversions | LONG | METRIC |
| CONV_VALUE_PER_COST | Value/cost of conversion | DOUBLE | METRIC |
| ALL_CONV_VALUE_PER_COST | Value of conversion (all)/cost | DOUBLE | METRIC |
| CONV_VALUE_VIA_AD_CLICK_PER_COST | Value of conversion (via clicks)/cost | DOUBLE | METRIC |
| IMPS_PREV | Number of impressions (old) | LONG | METRIC |
| CLICK_RATE_PREV | Click rate (old) | DOUBLE | METRIC |
| AVG_CPM | Average CPM | DOUBLE | METRIC |
| AVG_VCPM | Average vCPM | DOUBLE | METRIC |
| MEASURED_IMPS | Number of Major Impressions | LONG | METRIC |
| VIEWABLE_CLICK | Viewable Clicks | LONG | METRIC |
| MEASURED_IMPS_RATE | Measured Impression Measurement Rate | DOUBLE | METRIC |
| VIEWABLE_IMPS_RATE | Viewable impression rate | DOUBLE | METRIC |
| VIEWABLE_CLICK_RATE | Viewable Click Rate | DOUBLE | METRIC |
| VIDEO_VIEWS_TO_10_SEC | Number of 10-second views of video | LONG | METRIC |
| IMPRESSION_SHARE | impression share | DOUBLE | METRIC |
| IMPRESSION_SHARE_BUDGET_LOSS | Impression share loss rate (budget) | DOUBLE | METRIC |
| IMPRESSION_SHARE_RANK_LOSS | Impression share loss rate (rank) | DOUBLE | METRIC |
(*1) The operation category indicates the type of filtering operation in the Yahoo API.
ATTRIBUTE represents an attribute in the report.
SEGMENT represents the axis of the search.
METRICS represents the values obtained by the refinement.
For statistical information acquisition
| column name | Contents | recommended type |
|---|---|---|
| CAMPAIGN_ID | Campaign ID (*2) | LONG |
| CAMPAIGN_NAME | Campaign Name (*2) | STRING |
| ADGROUP_ID | Ad group ID (*2) | LONG |
| ADGROUP_NAME | Ad group name (*2) | STRING |
| AD_ID | Ad ID (*2) | LONG |
| AD_NAME | Advertisement name (*2) | STRING |
| IMPS | Impressions | LONG |
| IMPS_PREV | Number of impressions (old) | LONG |
| CLICK | Number of clicks | LONG |
| CLICK_RATE | click rate | DOUBLE |
| CLICK_RATE_PREV | Click rate (old) | DOUBLE |
| COST | cost | DOUBLE |
| AVG_CPC | Average CPC | DOUBLE |
| CONVERSIONS | Number of conversions | LONG |
| CONV_RATE | Conversion Rate | DOUBLE |
| CONVERSIONS_VIA_AD_CLICK | Number of conversions (via clicks) | LONG |
| CONVERSION_RATE_VIA_AD_CLICK | Conversion rate (via clicks) | DOUBLE |
| ALL_CONV | Number of conversions (all) | LONG |
| ALL_CONV_RATE | Conversion rate (all) | DOUBLE |
| COST_PER_CONV | Cost/conversions | DOUBLE |
| CONV_VALUE | Value of Conversion | LONG |
| VALUE_PER_CONV | Value of conversions/number of conversions | DOUBLE |
| CONV_VALUE_PER_COST | Value/cost of conversion | DOUBLE |
| ALL_CONV_VALUE_PER_COST | Value of conversion (all)/cost | DOUBLE |
| CONV_VALUE_VIA_AD_CLICK_PER_COST | Value of conversion (via clicks)/cost | DOUBLE |
| ALL_CONV_VALUE | Value of conversion (all) | LONG |
| VALUE_PER_ALL_CONV | Value of conversions (all)/number of conversions (all) | DOUBLE |
| CONV_VALUE_VIA_AD_CLICK | Value of conversion (via clicks) | LONG |
| VALUE_PER_CONV_VIA_AD_CLICK | Value of conversions (via clicks)/Number of conversions (via clicks) | DOUBLE |
| COST_PER_CONV_VIA_AD_CLICK | Cost/conversions (via clicks) | DOUBLE |
| COST_PER_ALL_CONV | Cost/conversions (all) | DOUBLE |
| CROSS_DEVICE_CONVERSIONS | Cross-device conversions | LONG |
| AVG_DELIVER_RANK | average order of magnitude | DOUBLE |
| MEASURED_IMPS | Number of Major Impressions | LONG |
| TOTAL_VIEWABLE_IMPS | Number of Major Impressions (old) | LONG |
| MEASURED_IMPS_RATE | Measured Impression Measurement Rate | DOUBLE |
| VIEWABLE_IMPS | Number of viewable impressions | LONG |
| VIEWABLE_IMPS_RATE | Viewable impression rate | DOUBLE |
| INVIEW_RATE | Viewable impression rate (old) | DOUBLE |
| VIEWABLE_CLICK | Viewable Clicks | LONG |
| INVIEW_CLICK | Viewable clicks (old) | LONG |
| VIEWABLE_CLICK_RATE | Viewable Click Rate | DOUBLE |
| INVIEW_CLICK_RATE | Viewable Click Rate (old) | DOUBLE |
| PAID_VIDEO_VIEWS | Number of video views for which billing occurred (CPV billing campaigns only) | LONG |
| PAID_VIDEO_VIEW_RATE | Percentage of video views for which billing occurred (CPV billing campaigns only) | DOUBLE |
| AVG_CPV | Average CPV | DOUBLE |
| VIDEO_VIEWS | Number of video playback starts | LONG |
| VIDEO_VIEWS_TO_25 | 25% of video views | LONG |
| VIDEO_VIEWS_TO_50 | 50% of video views | LONG |
| VIDEO_VIEWS_TO_75 | 75% of video views | LONG |
| VIDEO_VIEWS_TO_95 | 95% of video views | LONG |
| VIDEO_VIEWS_TO_100 | 100% of video views | LONG |
| VIDEO_VIEWS_TO_3_SEC | Number of 3-second views of video | LONG |
| VIDEO_VIEWS_TO_10_SEC | Number of 10-second views of video | LONG |
| AVG_PERCENT_VIDEO_VIEWED | Average video playback start rate | DOUBLE |
| AVG_DURATION_VIDEO_VIEWED | Average playback time of video (seconds) | DOUBLE |
| IMPRESSION_SHARE | impression share | DOUBLE |
| IMPRESSION_SHARE_BUDGET_LOSS | Impression share loss rate (budget) | DOUBLE |
| IMPRESSION_SHARE_RANK_LOSS | Impression share loss rate (rank) | DOUBLE |
(*2) When type is CAMPAIGN, CAMPAIGN_NAME and CAMPAIGN_ID,
When type is ADGROUP, CAMPAIGN_NAME, CAMPAIGN_ID, ADGROUP_NAME, ADGROUP_ID
When type is AD, CAMPAIGN_NAME, CAMPAIGN_ID, ADGROUP_NAME, ADGROUP_ID, AD_NAME, and AD_ID can be specified.