summary
Help Page for ETL Configuration of Data Settings from Yahoo! Search Ads.
YahooAdsAPI is used to retrieve data.
constraints
Setting items
STEP1 Basic settings
| item name | indispensable | default value | Contents |
|---|---|---|---|
| YahooAdsAPI Connection Configuration | Yes | - | Select the previously registered YahooAdsAPI Connection Configuration that has the necessary permissions for this ETL Configuration. |
| 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 Search Ads administration page. |
| Service | Yes | ReportDefinitionService |
Select the service for which you wish to acquire data from the followingReportDefinitionServiceCampaignExportService |
If ReportDefinitionService is selected
| item name | indispensable | default value | Contents |
|---|---|---|---|
| Report Type | Yes | - | Select the report type. Each report has different items that can be retrieved. |
| Data acquisition period | Yes | - | Enter the start and end dates of the filter range. Please enter in YYYYYYMMDD format. (Example. 20201119） |
| column (esp. in chemistry, file, equipment, etc.) | No | - | Enter the column (field) to be retrieved. For details, see the fields that can be obtained with the ReportDefinitionService described below. |
| Filter Setting | No | - | You can choose to transfer only records with impressions of 1 or more. |
Loading report template
When a report with a report template is selected in the report type, the main fields of the report type can be set at once by clicking on "Import Report Template".
Fields that can be retrieved
Fields that can be obtained with the ReportDefinitionService
Marketing Solutions As described in the official documentation of Yahoo!
Open the csv file of the report type you wish to retrieve and refer to the Field Name column.
Behavior Type
The Behavior Category/Behavior Type column in the csv file in the official documentation indicates the type of filtering behavior in the YahooAdsAPI.
ATTRIBUTE: Indicates an attribute in the report.SEGMENT: Represents the axis of the search.METRIC: Represents the number obtained by filtering.
Field
with no imprint and an action segment column of SEGMENT
Fields with an Operation Segment column of SEGMENT are not retrieved if the number of impressions is 0, even if Filter Setting is disabled.
Fields that cannot be retrieved at the same time
Due to API specifications, there are some field combinations that cannot be retrieved at the same time.
Please refer to the Not compatible fields column in the csv file in the official documentation.
Fields to be retrieved by CampaignExportService
When CampaignExportService is selected fora service, the following fields are automatically loaded
If you wish to change the column names during transfer, or if there are unnecessary fields, please edit them in Column Setting in ETL Configuration STEP 2.
| Field Name | Field Name Summary (Japanese) | Field Name Summary (English) |
|---|---|---|
CAMPAIGN_NAME |
Campaign Name | Campaign Name |
AD_GROUP_NAME |
Ad group name | Ad Group Name |
ENTITY_NAME |
Component Type | Component Type |
ENTITY_STATUS |
delivery setup | Display Settings |
DISPLAY_STATUS |
Delivery Status | Display Status |
BULK_MATCH_TYPE |
match type | Match Type |
TERM |
Keywords. | Keyword |
MANU_OPT_BID |
bidding price | Bid |
AD_NAME |
Advertisement Name | Ad Name |
BULK_AD_TYPE |
Ad Type | Ad Type |
HEADLINE_1 |
Title 1 | Title1 |
HEADLINE_2 |
Title 2 | Title2 |
HEADLINE_3 |
Title 3 | Title3 |
DESCRIPTION1 |
Description 1 | Description1 |
DESCRIPTION2 |
Description 2 | Description2 |
DISPLAY_URL |
display URL | Display URL |
PATH_1 |
Directory 1 | Directory1 |
PATH_2 |
Directory 2 | Directory2 |
ADVANCED_URL |
Last Linked URL | Final URL |
ADVANCED_MOBILE_URL |
URL for Smartphone | Smartphone final URL |
TRACKING_URL |
tracking URL | Tracking URL |
CUSTOM_PARAMETER |
Custom Parameters | Custom Parameters |
BUDGET_AMOUNT |
Campaign budget (daily) | Campaign Daily Budget |
START_YMD |
Campaign Start Date | Campaign Start Date |
END_YMD |
Campaign End Date | Campaign End Date |
PLATFORM_BID_MULTIPLIER |
Smartphone Bid Price Adjustment Percentage (%) | Smartphone Bid Adjustment (%) |
BULK_DEVICE_PREFERENCE |
preferred device | Focus Device |
CAMPAIGN_TYPE |
Campaign Type | Campaign Type |
AD_ROTATION_MODE |
Priority display of highly effective advertisements | Frequently run better-performing ads |
LABELS |
Label | Labels |
CAMPAIGN_ID |
campaign ID | Campaign ID |
AD_GROUP_ID |
advertising group ID | Ad Group ID |
CRITERION_ID |
Keyword ID | Keyword ID |
AD_ID |
Ad ID | Ad ID |
AD_TRACK_ID |
Ad ID for tracking | Ad Track ID |
RAS_HEADLINE_1 |
Title 1 (Asset) | Title 1 (asset) |
RAS_HEADLINE_POSITION1 |
Display position of Title 1 | Title 1 Position |
RAS_HEADLINE_2 |
Title 2 (Asset) | Title 2 (asset) |
RAS_HEADLINE_POSITION2 |
Title 2 display position | Title 2 Position |
RAS_HEADLINE_3 |
Title 3 (Assets) | Title 3 (asset) |
RAS_HEADLINE_POSITION3 |
Title 3 display position | Title 3 Position |
RAS_HEADLINE_4 |
Title 4 (Assets) | Title 4 (asset) |
RAS_HEADLINE_POSITION4 |
Title 4 display position | Title 4 Position |
RAS_HEADLINE_5 |
Title 5 (Assets) | Title 5 (asset) |
RAS_HEADLINE_POSITION5 |
Title 5 display position | Title 5 Position |
RAS_HEADLINE_6 |
Title 6 (Assets) | Title 6 (asset) |
RAS_HEADLINE_POSITION6 |
Title 6 display position | Title 6 Position |
RAS_HEADLINE_7 |
Title 7 (Asset) | Title 7 (asset) |
RAS_HEADLINE_POSITION7 |
Title 7 display position | Title 7 Position |
RAS_HEADLINE_8 |
Title 8 (Asset) | Title 8 (asset) |
RAS_HEADLINE_POSITION8 |
Title 8 display position | Title 8 Position |
RAS_HEADLINE_9 |
Title 9 (Asset) | Title 9 (asset) |
RAS_HEADLINE_POSITION9 |
Title 9 display position | Title 9 Position |
RAS_HEADLINE_10 |
Title 10 (Assets) | Title 10 (asset) |
RAS_HEADLINE_POSITION10 |
Title 10 display position | Title 10 Position |
RAS_HEADLINE_11 |
Title 11 (Assets) | Title 11 (asset) |
RAS_HEADLINE_POSITION11 |
Title 11 display position | Title 11 Position |
RAS_HEADLINE_12 |
Title 12 (Assets) | Title 12 (asset) |
RAS_HEADLINE_POSITION12 |
Title 12 display position | Title 12 Position |
RAS_HEADLINE_13 |
Title 13 (Assets) | Title 13 (asset) |
RAS_HEADLINE_POSITION13 |
Title 13 display position | Title 13 Position |
RAS_HEADLINE_14 |
Title 14 (Assets) | Title 14 (asset) |
RAS_HEADLINE_POSITION14 |
Title 14 display position | Title 14 Position |
RAS_HEADLINE_15 |
Title 15 (Assets) | Title 15 (asset) |
RAS_HEADLINE_POSITION15 |
Title 15 display position | Title 15 Position |
RAS_DESCRIPTION1 |
Description 1 (Asset) | Description 1 (asset) |
RAS_DESCRIPTION_POSITION1 |
Display position of description 1 | Description 1 Position |
RAS_DESCRIPTION2 |
Description 2 (Asset) | Description 2 (asset) |
RAS_DESCRIPTION_POSITION2 |
Display position of description 2 | Description 2 Position |
RAS_DESCRIPTION3 |
Description 3 (Asset) | Description 3 (asset) |
RAS_DESCRIPTION_POSITION3 |
Display position of description 3 | Description 3 Position |
RAS_DESCRIPTION4 |
Description 4 (Asset) | Description 4 (asset) |
RAS_DESCRIPTION_POSITION4 |
Display position of description 4 | Description 4 Position |
ASSET_ID |
Ad Display Option ID | Ad display option ID |
ASSET_TYPE |
Types of ad display options | Ad display option type |
ASSET_ADVANCED_URL |
Quick Link Final Link URL | QuickLink final URL |
ASSET_ADVANCED_MOBILE_URL |
URL for Quick Link Smartphone | QuickLink smartphone final URL |
ASSET_TRACKING_URL |
Quick Link Tracking URL | QuickLink tracking URL |
ASSET_CUSTOM_PARAMETER |
Quick Link Custom Parameters | QuickLink custom parameter |
ASSET_LINK_TEXT |
Quick Link Text | QuickLink text |
ASSET_DESCRIPTION1 |
Quick Link Description 1 | QuickLink description 1 |
ASSET_DESCRIPTION2 |
Quick Link Description 2 | QuickLink description 2 |
ASSET_CALLOUT_TEXT |
supplementary text | Callout text |
ASSET_HEADER |
Supplemental Category | Category |
ASSET_VALUE_1 |
Supplemental Contents 1 | Text 1 |
ASSET_VALUE_2 |
Supplemental Contents 2 | Text 2 |
ASSET_VALUE_3 |
Supplemental Contents 3 | Text 3 |
ASSET_VALUE_4 |
Supplemental Contents 4 | Text 4 |
ASSET_VALUE_5 |
Supplemental Contents5 | Text 5 |
ASSET_VALUE_6 |
Supplemental Contents 6 | Text 6 |
ASSET_VALUE_7 |
Supplemental Contents7 | Text 7 |
ASSET_VALUE_8 |
Supplemental Contents8 | Text 8 |
ASSET_VALUE_9 |
Supplemental Contents 9 | Text 9 |
ASSET_VALUE_10 |
Supplemental Contents 10 | Text 10 |
ASSET_PHONE_NUMBER |
Phone number | Phone Number |
CAMPAIGN_TRACK_ID |
Campaign ID for tracking | Campaign Track ID |
AD_GROUP_TRACK_ID |
Ad group ID for tracking | Ad Group Track ID |
CRITERION_TRACK_ID |
Keyword ID for tracking | Keyword Track ID |
ASSET_IMAGE_NAME |
||
ASSET_ASPECT_RATIO |