ADO.NET Provider for Yahoo! Ads

Build 24.0.9062

DisplayAdsReports

Create, Read or Delete a Report.

Table Specific Information

SELECT

The 本製品 will use the Yahoo! Ads API to process WHERE clause conditions built with the following column and operator. The AccountId is required to make a request and the rest of the filter is executed client-side within the 本製品.

  • ReportJobId supports the '=,IN'.
  • ReportJobStatus supports the '=,IN'.
  • AccountId supports the '='.
For example:
SELECT * from DisplayAdsReports WHERE AccountId = '1234'

INSERT

Insert can be executed by specifying the AccountId,Fields,ReportName columns. The columns that are not read-only can be inserted optionally. Following is an example of how to insert into this table.

INSERT INTO DisplayAdsReportReportTypeConditionCrossCampaignReachesReportConditionCrossCampaignIds#TEMP (AccountId,AccountProductType,CampaignId) VALUES ('1002504155','YDA','1836679')
INSERT INTO DisplayAdsReports (AccountId,Fields,ReportDateRangeType,ReportName,CrossCampaignReachesReportConditionCrossCampaignType,CrossCampaignReachesReportConditionCrossCampaignIds) VALUES ('1002504155','ACCOUNT_ID,ACCOUNT_NAME,CAMPAIGN_ID,ADGROUP_ID,AD_ID','TODAY','MyAdReport','CAMPAIGN_ID','DisplayAdsReportReportTypeConditionCrossCampaignReachesReportConditionCrossCampaignIds#TEMP')

DELETE

Delete can be executed by specifying the ReportJobId and AccountId in the WHERE Clause. For example:

DELETE DisplayAdsReports WHERE AccountId = '1234' AND ReportJobId = '266841'

Columns

Name Type ReadOnly References Description
ReportJobId [KEY] Int64 True

Report Job ID.

AccountId Int64 True

DisplayAdsAccounts.AccountId

Account ID.

ReportJobStatus String False

The process status for the defined report.

使用できる値は次のとおりです。WAIT, COMPLETED, IN_PROGRESS, FAILED, UNKNOWN

CompleteTime Datetime False

The date and time of Job completion.

DateRangeStartDate Date False

The compilation start date. This field is required if DateRangeType is set to (CUSTOM DATE).

DateRangeEndDate Date False

The compilation End date. This field is required if DateRangeType is set to (CUSTOM DATE).

Fields String False

Select the fields. Available values can be referred to fieldName field of fields object obtained by getReportFields operation of ReportDefinitionService.

Filters String False

Object displays filtering report conditions.

ReportCompressType String False

Displays if defined download report is compressed.

使用できる値は次のとおりです。NONE, ZIP, UNKNOWN

ReportDateRangeType String False

Displays a date range of the report.

使用できる値は次のとおりです。TODAY, YESTERDAY, LAST_7_DAYS, LAST_WEEK, LAST_14_DAYS, LAST_30_DAYS, LAST_BUSINESS_WEEK, THIS_MONTH, LAST_MONTH, CUSTOM_DATE, UNKNOWN

ReportDownloadEncode String False

Displays a character code of the report.

使用できる値は次のとおりです。UTF8, SJIS, EUC, UTF16LE, UNKNOWN

ReportDownloadFormat String False

Displays a file format of the report.

使用できる値は次のとおりです。CSV, XML, TSV, UNKNOWN

ReportIncludeDeleted String False

Describes whether to output deleted items on the report or not.

使用できる値は次のとおりです。TRUE, FALSE, UNKNOWN

ReportJobErrorDetail String False

Error details of Report Job.

ReportLanguage String False

A language selection for report definition.

使用できる値は次のとおりです。JA, EN, UNKNOWN

ReportName String False

Name of the report.

ReportDecimalPartDisplayType String False

Describes the display type of the decimal item.

使用できる値は次のとおりです。FULL_DISPLAY, SIMPLE_DISPLAY, UNKNOWN

デフォルト値はSIMPLE_DISPLAYです。

ReportSkipColumnHeader String False

A flag that indicates whether to skip the display of the header line.

使用できる値は次のとおりです。TRUE, FALSE, UNKNOWN

デフォルト値はFALSEです。

ReportSkipReportSummary String False

A flag that indicates whether to skip the display of the total line.

使用できる値は次のとおりです。TRUE, FALSE, UNKNOWN

デフォルト値はFALSEです。

ConversionPathReportConditionLookbackWindow Int64 False

Look back period (number of days). The lower limit of the value that can be specified is 0, and the upper limit is 90.

ConversionPathReportConditionIncludeViewInteraction String False

A flag which indicates whether to include view interaction in Conversion Path Report. If reportType is CONVERSION_PATH, this field is required in ADD operation.

使用できる値は次のとおりです。TRUE, FALSE, UNKNOWN

ConversionPathReportConditionConversionPathFilters String False

Describes the filter condition of Conversion Path Report. If multiple values are specified, the condition will be (AND). If reportType is CONVERSION_PATH, this field is required in ADD operation.

使用できる値は次のとおりです。TRUE, FALSE, UNKNOWN

ConversionPathReportConditionConversionPathAccountSettingsBaseAccountAaccountId Int64 False

Account ID.

ConversionPathReportConditionConversionPathAccountSettingsBaseAccountAproductType String False

Describes product type of the account.

使用できる値は次のとおりです。YDA, YSA, UNKNOWN

ConversionPathReportConditionConversionPathAccountSettingsSubAccounts String False

Object describes account and its product type.

CrossCampaignReachesReportConditionCrossCampaignType String False

Indicates the combination type of Cross-campaign Reach Report. If reportType is CROSS_CAMPAIGN_REACHES, this field is required in ADD operation. * At least two elements are required for crossCampaignIds, crossCampaignGoals, and crossCampaignBuyingTypes. * Up to 3 elements can be specified for crossCampaignIds, crossCampaignGoals, and crossCampaignBuyingTypes.

使用できる値は次のとおりです。CAMPAIGN_ID, CAMPAIGN_GOAL, CAMPAIGN_BUYING_TYPE, UNKNOWN

CrossCampaignReachesReportConditionCrossCampaignIds String False

Indicates account and campaign ID that is subject to Cross-campaign Reach Report combination. If crossCampaignType is CAMPAIGN_ID, this field is required in ADD operation.

CrossCampaignReachesReportConditionCrossCampaignGoals String False

Indicates account and campaign goal that is subject to Cross-campaign Reach Report combination. If crossCampaignType is CAMPAIGN_GOAL, this field is required in ADD operation.

CrossCampaignReachesReportConditioncrossCampaignBuyingTypes String False

Indicates account and campaign purchase type that is subject to Cross-campaign Reach Report combination. If crossCampaignType is CAMPAIGN_BUYING_TYPE, this field is required in ADD operation.

ReachReportConditionFrequencyRange String False

Serves measurement range of reach frequency. If specified GUARANTEED_CAMPAIGN_PERIOD, GUARANTEED_CAMPAIGN_PERIOD must be specified for reportDateRangeType as well. Lifetime means the entire period from the start to the end of the guaranteed campaign. If reportType is REACH, this field is required in ADD operation.

使用できる値は次のとおりです。DAILY, WEEKLY, MONTHLY, GUARANTEED_CAMPAIGN_PERION, UNKNOWN

ReportTypeConditionReportType String False

Serves category type of report. Conversion Path Report: CONVERSION_PATH, Cross-campaign Reach Report: CROSS_CAMPAIGN_REACHES, Reach Frequency Report: FREQUENCY, Reach Report: REACH. Only CONVERSION_PATH,CROSS_CAMPAIGN_REACHES,FREQUENCY and REACH can be specified in ADD operation.

使用できる値は次のとおりです。AD, AUDIENCE_CATEGORY, CONVERSION_PATH, CROSS_CAMPAIGN_REACHES, FREQUENCY, INTEREST_CATEGORY, SITE_RETARGETING, SEARCH_TARGET, PLACEMENT_TARGET, LABEL, SITE_CATEGORY, REACH, URL, UNKNOWN

RequestTime Datetime False

Start time of Report Job request.

SortFields String False

Describes sort details of report definition.

ReportIncludeDeleted String False

Describes whether to output deleted items on the report or not.

使用できる値は次のとおりです。TRUE, FALSE, UNKNOWN

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
ReferenceNumber String

This column will be used in Bulk operations to get specific values from the Temp tables.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9062