Data Source - Yahoo! Display Ads (operational)
- 07 Dec 2022
- Print
- DarkLight
- PDF
Data Source - Yahoo! Display Ads (operational)
- Updated on 07 Dec 2022
- Print
- DarkLight
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
This is a machine-translated version of the original Japanese article.
Please understand that some of the information contained on this page may be inaccurate.
summary
This is a help page for setting up data transfer from Yahoo! JAPAN Display Ads (operational type).
Use the Yahoo! JAPAN Ads API to acquire data.
Supported Protocols
- Data Transfer (Embulk)
Using embulk-input-yahoo_ads_api
constraint
Setting items
STEP1 Basic settings
| Item | namerequireddefault | valuecontent | |
|---|---|---|---|
| Yahoo! API connection information | Yes | - | Yahoo! Select the connection information for the API. |
| How to get it | Yes | Report Acquisition | If you want to get it as a report, specify Get Report, and if you want to get it as a statistic, specify Get Statistics. |
| Account ID | Yes | - | Please register the account ID to be obtained from the account management screen of Sponsor Search. |
| type | No | - | If you selected Get Statistics for the target, specify the type here. Currently ・CAMPAIGN ・ADGROUP ・AD type. |
| Data acquisition period | Yes | - | Specify the time period for which you want to retrieve data. Enter both a start date and an end date. Enter it in the format YYMMDD. You can also set custom variables to select the corresponding date for the actual transfer. |
| column | No | - | Enter the column information you want to transfer. The columns that can be set depend on the retrieval method. Please refer to the following for details. |
About columns
Due to API updates, the old indicator has been deprecated.
Along with the above, if a column containing "(old)" is specified in the column name, the new column will be automatically acquired.
- Example: If "CLICK_RATE_PREV (click-through rate (old))" is specified, "CLICK_RATE (click-through rate)" is automatically retrieved.
For report retrieval
Ads reports (Account, Campaign, Ad groups, Destination URLs reports)
* Depending on the items specified in STEP 1, errors may occur due to the inability to combine. See here for specific non-combinable columns.
You can set the following values for column fields:
Recommended operation classification
| of column name | contents | (*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 | Ad group ID | LONG | ATTRIBUTE |
| ADGROUP_NAME | Ad group name | STRING | ATTRIBUTE |
| AD_ID | Advertising ID | LONG | ATTRIBUTE |
| AD_NAME | Ad name | STRING | ATTRIBUTE |
| AD_TYPE | Ad type | STRING | ATTRIBUTE |
| URL_ID | Destination URL | LONG | SEGMENT |
| URL_NAME | Destination URL | STRING | SEGMENT |
| PREF_ID | State/Province ID | STRING | SEGMENT |
| PREF_NAME | prefecture | STRING | SEGMENT |
| CITY_ID | City ID | STRING | SEGMENT |
| CITY_NAME | City | STRING | SEGMENT |
| WARD_ID | Administrative District ID | STRING | SEGMENT |
| WARD_NAME | administrative district | STRING | SEGMENT |
| GENDER | gender | STRING | SEGMENT |
| AGE | age | STRING | SEGMENT |
| MONTH | moon | STRING | SEGMENT |
| DAY | sun | STRING | SEGMENT |
| HOUR | time | LONG | SEGMENT |
| DELIVER | Advertising 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 Keywords | STRING | SEGMENT |
| CONVERSION_CATEGORY | Conversion measurement objectives | STRING | SEGMENT |
| CARRIER | career | STRING | SEGMENT |
| AD_LAYOUT | layout | STRING | ATTRIBUTE |
| IMAGE_OPTION | Automatic image addition | STRING | SEGMENT |
| CONVERSION_NAME | Conversion name | STRING | ATTRIBUTE |
| OS | OS | STRING | SEGMENT |
| APPLI | Web/App | STRING | SEGMENT |
| CAMPAIGN_TYPE | Campaign Type | STRING | ATTRIBUTE |
| APP_ID | App ID/Package Name | STRING | ATTRIBUTE |
| APP_NAME | App name | STRING | ATTRIBUTE |
| APP_OS | App OS | STRING | ATTRIBUTE |
| CAMPAIGN_GOALS | Campaign Objectives | STRING | SEGMENT |
| CAMPAIGN_BUYING_TYPE | Campaign purchase types | STRING | ATTRIBUTE |
| DESTINATION_URL_CAMPAIGN_BANNER | Destination URL (campaign banner) | STRING | ATTRIBUTE |
| IMPS | Impressions | LONG | METRIC |
| CLICK_RATE | CTR | DOUBLE | METRIC |
| COST | cost | DOUBLE | METRIC |
| CLICK | Clicks | LONG | METRIC |
| AVG_CPC | Average CPC | DOUBLE | METRIC |
| AVG_DELIVER_RANK | Average position | DOUBLE | METRIC |
| TOTAL_VIEWABLE_IMPS | Major Impressions (old) | LONG | METRIC |
| VIEWABLE_IMPS | Viewable Impressions | LONG | METRIC |
| INVIEW_RATE | Viewable Impression Rate (old) | DOUBLE | METRIC |
| INVIEW_CLICK | Viewable clicks (old) | LONG | METRIC |
| INVIEW_CLICK_RATE | Viewable CTR (old) | DOUBLE | METRIC |
| AVG_CPV | Average CPV | DOUBLE | METRIC |
| VIDEO_VIEWS_TO_25 | 25% video views | LONG | METRIC |
| VIDEO_VIEWS_TO_50 | 50% video views | LONG | METRIC |
| VIDEO_VIEWS_TO_75 | 75% video views | LONG | METRIC |
| VIDEO_VIEWS_TO_95 | 95% video views | LONG | METRIC |
| VIDEO_VIEWS_TO_100 | 100% video views | LONG | METRIC |
| AVG_PERCENT_VIDEO_VIEWED | Average video start rate | DOUBLE | METRIC |
| AVG_DURATION_VIDEO_VIEWED | Average video duration (seconds) | DOUBLE | METRIC |
| VIDEO_VIEWS | Number of video starts | LONG | METRIC |
| PAID_VIDEO_VIEWS | Number of video views that incurred charges (CPV billing campaigns only) | LONG | METRIC |
| PAID_VIDEO_VIEW_RATE | Video view rate that incurred charges (CPV billing campaigns only) | DOUBLE | METRIC |
| VIDEO_VIEWS_TO_3_SEC | 3-second video views | LONG | METRIC |
| CONVERSIONS | Conversions | LONG | METRIC |
| CONV_RATE | Conversion rate | DOUBLE | METRIC |
| COST_PER_CONV | Cost/Conversions | DOUBLE | METRIC |
| CONV_VALUE | The value of conversions | LONG | METRIC |
| VALUE_PER_CONV | Conversion value/number of conversions | DOUBLE | METRIC |
| ALL_CONV | Conversions (all) | LONG | METRIC |
| ALL_CONV_RATE | Conversion rate (all) | DOUBLE | METRIC |
| COST_PER_ALL_CONV | Cost/Conversions (All) | DOUBLE | METRIC |
| ALL_CONV_VALUE | Conversion value (all) | LONG | METRIC |
| VALUE_PER_ALL_CONV | Value of conversions (all) / Conversions (all) | DOUBLE | METRIC |
| CONVERSIONS_VIA_AD_CLICK | 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 | Conversion value (via click) | LONG | METRIC |
| VALUE_PER_CONV_VIA_AD_CLICK | Value of conversions (via clicks) / Conversions (via clicks) | DOUBLE | METRIC |
| CROSS_DEVICE_CONVERSIONS | Cross-device conversions | LONG | METRIC |
| CONV_VALUE_PER_COST | Conversion value/cost | DOUBLE | METRIC |
| ALL_CONV_VALUE_PER_COST | Conversion value (all)/cost | DOUBLE | METRIC |
| CONV_VALUE_VIA_AD_CLICK_PER_COST | Conversion value (via click)/cost | DOUBLE | METRIC |
| IMPS_PREV | Impressions (old) | LONG | METRIC |
| CLICK_RATE_PREV | CTR (old) | DOUBLE | METRIC |
| AVG_CPM | Average CPM | DOUBLE | METRIC |
| AVG_VCPM | Average vCPM | DOUBLE | METRIC |
| MEASURED_IMPS | Major Impressions | LONG | METRIC |
| VIEWABLE_CLICK | Viewable Clicks | LONG | METRIC |
| MEASURED_IMPS_RATE | Major Impression Measurement Rate | DOUBLE | METRIC |
| VIEWABLE_IMPS_RATE | Viewable Impression Rate | DOUBLE | METRIC |
| VIEWABLE_CLICK_RATE | Viewable CTR | DOUBLE | METRIC |
| VIDEO_VIEWS_TO_10_SEC | 10-second video views | LONG | METRIC |
| IMPRESSION_SHARE | Impression Share | DOUBLE | METRIC |
| IMPRESSION_SHARE_BUDGET_LOSS | Lost impression share ratio (budget) | DOUBLE | METRIC |
| IMPRESSION_SHARE_RANK_LOSS | Lost impression share ratio (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 number obtained by filtering.
For obtaining statistical information
| Column name | content | 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 | Advertising ID (*2) | LONG |
| AD_NAME | Ad name (*2) | STRING |
| IMPS | Impressions | LONG |
| IMPS_PREV | Impressions (old) | LONG |
| CLICK | Clicks | LONG |
| CLICK_RATE | CTR | DOUBLE |
| CLICK_RATE_PREV | CTR (old) | DOUBLE |
| COST | cost | DOUBLE |
| AVG_CPC | Average CPC | DOUBLE |
| CONVERSIONS | Conversions | LONG |
| CONV_RATE | Conversion rate | DOUBLE |
| CONVERSIONS_VIA_AD_CLICK | Conversions (via clicks) | LONG |
| CONVERSION_RATE_VIA_AD_CLICK | Conversion rate (via clicks) | DOUBLE |
| ALL_CONV | Conversions (all) | LONG |
| ALL_CONV_RATE | Conversion rate (all) | DOUBLE |
| COST_PER_CONV | Cost/Conversions | DOUBLE |
| CONV_VALUE | The value of conversions | LONG |
| VALUE_PER_CONV | Conversion value/number of conversions | DOUBLE |
| CONV_VALUE_PER_COST | Conversion value/cost | DOUBLE |
| ALL_CONV_VALUE_PER_COST | Conversion value (all)/cost | DOUBLE |
| CONV_VALUE_VIA_AD_CLICK_PER_COST | Conversion value (via click)/cost | DOUBLE |
| ALL_CONV_VALUE | Conversion value (all) | LONG |
| VALUE_PER_ALL_CONV | Value of conversions (all) / Conversions (all) | DOUBLE |
| CONV_VALUE_VIA_AD_CLICK | Conversion value (via click) | LONG |
| VALUE_PER_CONV_VIA_AD_CLICK | Value of conversions (via clicks) / 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 position | DOUBLE |
| MEASURED_IMPS | Major Impressions | LONG |
| TOTAL_VIEWABLE_IMPS | Major Impressions (old) | LONG |
| MEASURED_IMPS_RATE | Major Impression Measurement Rate | DOUBLE |
| VIEWABLE_IMPS | 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 CTR | DOUBLE |
| INVIEW_CLICK_RATE | Viewable CTR (old) | DOUBLE |
| PAID_VIDEO_VIEWS | Number of video views that incurred charges (CPV billing campaigns only) | LONG |
| PAID_VIDEO_VIEW_RATE | Video view rate that incurred charges (CPV billing campaigns only) | DOUBLE |
| AVG_CPV | Average CPV | DOUBLE |
| VIDEO_VIEWS | Number of video starts | LONG |
| VIDEO_VIEWS_TO_25 | 25% video views | LONG |
| VIDEO_VIEWS_TO_50 | 50% video views | LONG |
| VIDEO_VIEWS_TO_75 | 75% video views | LONG |
| VIDEO_VIEWS_TO_95 | 95% video views | LONG |
| VIDEO_VIEWS_TO_100 | 100% video views | LONG |
| VIDEO_VIEWS_TO_3_SEC | 3-second video views | LONG |
| VIDEO_VIEWS_TO_10_SEC | 10-second video views | LONG |
| AVG_PERCENT_VIDEO_VIEWED | Average video start rate | DOUBLE |
| AVG_DURATION_VIDEO_VIEWED | Average video duration (seconds) | DOUBLE |
| IMPRESSION_SHARE | Impression Share | DOUBLE |
| IMPRESSION_SHARE_BUDGET_LOSS | Lost impression share ratio (budget) | DOUBLE |
| IMPRESSION_SHARE_RANK_LOSS | Lost impression share ratio (rank) | DOUBLE |
(*2)When the type is CAMPAIGN, CAMPAIGN_NAME, CAMPAIGN_ID,
When the type is ADGROUP, CAMPAIGN_NAME, CAMPAIGN_ID, ADGROUP_NAME, ADGROUP_ID
When type is AD, you can specify CAMPAIGN_NAME, CAMPAIGN_ID, ADGROUP_NAME, ADGROUP_ID, AD_NAME, and AD_ID.
Was this article helpful?