Establishing a Connection

Create a connection to Yahoo! Ads by navigating to the Connections page in the Sync App application and selecting the corresponding icon in the Add Connections panel. If the Yahoo! Ads icon is not available, click the Add More icon to download and install the Yahoo! Ads connector from the CData site.

Required properties are listed under the Settings tab. The Advanced tab lists connection properties that are not typically required.

Connecting to Yahoo! Ads

You can optionally set the following to refine the data returned from Yahoo! Ads.

DisplayAdsAccountId: Set this to the unique identifier associated with the DisplayAds account with your Yahoo! Ads. If not specified, the ID will be fetched by the driver by default.
SearchAdsAccountId: Set this to the unique identifier associated with SearchAds account with your Yahoo! Ads. If not specified, the ID will be fetched by the driver by default.

Authenticating to Yahoo! Ads

OAuth

You must use OAuth to authenticate with Yahoo! Ads. OAuth requires the authenticating user to interact with Yahoo! Ads using the browser. For more information, refer to Using OAuth Authentication.

Advanced Features

This section details a selection of advanced features of the Yahoo! Ads Sync App.

User Defined Views

The Sync App allows you to define virtual tables, called user defined views, whose contents are decided by a pre-configured query. These views are useful when you cannot directly control queries being issued to the drivers. See User Defined Views for an overview of creating and configuring custom views.

SSL Configuration

Use SSL Configuration to adjust how Sync App handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert property under "Connection String Options" for more information.

Firewall and Proxy

Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.

Query Processing

The Sync App offloads as much of the SELECT statement processing as possible to Yahoo! Ads and then processes the rest of the query in memory (client-side).

See Query Processing for more information.

Logging

See Logging for an overview of configuration settings that can be used to refine CData logging. For basic logging, you only need to set two connection properties, but there are numerous features that support more refined logging, where you can select subsets of information to be logged using the LogModules connection property.

SSL Configuration

Customizing the SSL Configuration

By default, the Sync App attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.

To specify another certificate, see the SSLServerCert property for the available formats to do so.

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

To connect through the Windows system proxy, you do not need to set any additional connection properties. To connect to other proxies, set ProxyAutoDetect to false.

In addition, to authenticate to an HTTP proxy, set ProxyAuthScheme, ProxyUser, and ProxyPassword, in addition to ProxyServer and ProxyPort.

Other Proxies

Set the following properties:

To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
To tunnel the connection, set FirewallType to TUNNEL.
To authenticate, specify FirewallUser and FirewallPassword.
To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

Data Model

Using DisplayAds API

See DisplayAds Data Model for the available entities in the DisplayAds Data Model.

Using SearchAds API

See SearchAds Data Model for the available entities in the SearchAds Data Model.

DisplayAds Data Model

Overview

This section shows the available API objects and provides more information on executing SQL to Yahoo! Ads APIs.

Key Features

The Sync App models Yahoo! Ads entities like documents, folders, and groups as relational views, allowing you to write SQL to query Yahoo! Ads data.
Stored procedures allow you to execute operations to Yahoo! Ads
Live connectivity to these objects means any changes to your Yahoo! Ads account are immediately reflected when using the Sync App.
Reports:
Reports are shown as views that cannot be modified once created. Unlike traditional database views, however, it is not very helpful to select all metrics and dimensions in a given table. The provider thus interprets the SELECT * query to mean a default set of metrics and dimensions are requested. This includes queries that explicitly select all columns.

Additionally, the Yahoo! Ads API limits the number and combinations of columns that can be projected over the data or used to restrict the results returned.

Tables

The Sync App models the data in Yahoo! Ads into a list of tables that can be queried using standard SQL statements.

Generally, querying Yahoo! Ads tables is the same as querying a table in a relational database. Sometimes there are special cases, for example, including a certain column in the WHERE clause might be required to get data for certain columns in the table. This is typically needed for situations where a separate request must be made for each row to get certain columns. These types of situations are clearly documented at the top of the table page linked below.

Yahoo! Ads Connector for CData Sync Tables


Name	Description
AdGroupTargets	Perform targeting settings operations (get, add, set, replace and remove) for ad group.
AudienceLists	Create, Read, Update or Delete the Audience list for site retargeting
ContentsKeywordLists	Get the contents keyeord list
ConversionGroups	Get ConversionGroup information of specified account
DisplayAdsAccountManagement	Create, Update or Read account information. Restricted to some users
DisplayAdsAccounts	Read Or Update account information.
DisplayAdsAccountTrackingUrl	Get Information related to account tracking.
DisplayAdsAdGroupAds	Create, Read, Update or Delete ad information
DisplayAdsAdGroups	Create, Read, Update or Delete Ad group
DisplayAdsAuditLogs	Create or Read the download result information of operation history data file.
DisplayAdsBudgets	Read or Update budget information for the account.
DisplayAdsCampaigns	Create, Read, Update or Delete information related campaigns.
DisplayAdsConversionTrackers	Create, Read or Update ConversionTracker information.
DisplayAdsFeeds	Create, Read, Update or delete Feed information
DisplayAdsLabels	Create, Read, Update or Delete information of label.
DisplayAdsReports	Create, Read or Delete a Report.
FeedFtp	Create, Read or Update FTP setting information.
FeedSets	Create, Read or delete Item Set information.
GuaranteedAdGroupAds	Create, Read, Update guaranteed ad and use AdGroupAd/remove to delete the guaranteed ad.
GuaranteedAdGroups	Create, Read, Update guaranteed ad group and use AdGroup/remove to delete the guaranteed ad group.
GuaranteedCampaigns	Read or Update guaranteed campaign.
GuaranteedInventory	Get details of guaranteed campaign and information about inventory status of product
GuaranteedSimulations	Create or Read information about the delivery simulation of the guaranteed campaign.
Media	Create, Read, Update or delete the media submission.
PlacementUrlLists	Create, Read, Update or Delete the placement URL list.
RetargetingTags	Create or Read site retargeting tag information.
SearchKeywordList	Read, add, update or delete the search keyword list.
Videos	Read, Update or Delete Video Ads.

AdGroupTargets

Perform targeting settings operations (get, add, set, replace and remove) for ad group.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
AdGroupId supports the '=,IN'.
CampaignId supports the '=,IN'.
TargetType supports the '=,IN'.

For example:

SELECT * from AdGroupTargets WHERE AccountId = '1002504155'

SELECT * FROM AdGroupTargets WHERE AccountId = '1002504155' AND AdGroupId IN ('437154455','437154455')

SELECT * FROM AdGroupTargets WHERE AccountId = '1002504155' AND CampaignId = '30799754'

INSERT

Insert can be executed by specifying the AccountId, AdGroupId, CampaignId, AdScheduleTargetDayOfWeek, AdScheduleTargetStartHour, AdScheduleTargetEndHour and TargetType 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 AdGroupTargets (AccountId,AdGroupId,CampaignId,TargetType,AdScheduleTargetStartHour,AdScheduleTargetEndHour,AdScheduleTargetDayOfWeek) VALUES ('1002504155','437154455','30799754','AD_SCHEDULE_TARGET','10','12','MONDAY')

UPDATE

Update can be executed by specifying the AccountId, AdGroupId, TargetId, CampaignId and TargetType in the WHERE Clause. The columns that are not read-only can be Updated. For example:

UPDATE AdGroupTargets SET BidMultiplier = '1.0', AgeTargetAge = 'GT_RANGE13_14'  WHERE AccountId = '1002504155' AND AdGroupId = '437154455' AND CampaignId = '30799754' AND TargetId = 'as010104'  AND TargetType = 'AD_SCHEDULE_TARGET'

DELETE

Delete can be executed by specifying the AccountId, AdGroupId, TargetId, CampaignId and TargetType in the WHERE Clause. For example:

DELETE FROM AdGroupTargets WHERE AccountId = '1002504155' AND AdGroupId = '437154455' AND CampaignId = '30799754' AND TargetId = 'as011012'  AND TargetType = 'AD_SCHEDULE_TARGET'

Columns


Name	Type	ReadOnly	References	Description
TargetId	String	False		Target ID.If targetType is any of the following, this field is required in ADD operation.SITE_RETARGETING,PLACEMENT_TARGET,SEARCH_TARGET,GEO_TARGET,INTEREST_CATEGORY,SITE_CATEGORY,PLACEMENT_CATEGORY_TARGET,PLACEMENT_CATEGORY_DETAIL_TARGET,CONTENTS_TARGETIf isRemove is true, this field does not need to be set in REPLACE operation.SITE_RETARGETING: targetListId,PLACEMENT_TARGET: placementUrlListId,,GEO_TARGET: IM area code(geo),SITE_CATEGORY: category code(category),OS_VERSION_TARGET: osVersion,AUDIENCE_CATEGORY_TARGET: audience category code(audience category),POSITION_TARGET: PositionType code.,PLACEMENT_CATEGORY_TARGET: placementCategoryListId,PLACEMENT_CATEGORY_DETAIL_TARGET: placementCategoryId,CONTENTS_TARGET: contentsKeywordListId
AccountId	Int64	True	DisplayAdsAccounts.AccountId	Account ID.
AdGroupId	Int64	True	DisplayAdsAdGroups.AdGroupId	Ad Group ID.
BidMultiplier	String	False		Bid adjustment.If bidMultiplier is not specified when SITE_RETARGETING, SEARCH_TARGET, or PLACEMENT_TARGET is specified for the targeting of the ad group and the ad group is linked to the YDN campaign, null will be assigned for this field.If bidMultiplier is not specified in other cases, 1.0 will be assigned for this field.
CampaignId	Int64	False	DisplayAdsCampaigns.CampaignId	Campaign ID.
AdScheduleTargetDayOfWeek	String	False		Serves the days of the week for delivery.If targetType is AD_SCHEDULE_TARGET, this field is required The allowed values are MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY, UNKNOWN.
AdScheduleTargetStartHour	Int64	False		Start time (hour only).If targetType is AD_SCHEDULE_TARGET, this field is required
AdScheduleTargetEndHour	Int64	False		End time (hour only).If targetType is AD_SCHEDULE_TARGET, this field is required
AgeTargetAge	String	False		Displays ages.If targetType is AGE_TARGET, this field is required. The allowed values are GT_RANGE13_14, GT_RANGE15_17, GT_RANGE18_19, GT_RANGE17_21, GT_RANGE22_29, GT_RANGE30_39, GT_RANGE40_49, GT_RANGE50_59, GT_RANGE60_69, GT_RANGE70_UL, GT_UNKNOWN, GT_RANGE15_19, GT_RANGE20_24, GT_RANGE25_29, GT_RANGE35_34, GT_RANGE35_39, GT_RANGE41_44, GT_RANGE45_49, GT_RANGE51_54, GT_RANGE55_59, GT_RANGE61_64, GT_RANGE65_69, GT_RANGE70_UL2, GT_UNKNOWN2, UNKNOWN.
AgeTargetEstimateFlg	String	False		Displays the advance delivery setting.If targetType is AGE_TARGET, this field is required. The allowed values are PAUSED, ACTIVE, UNKNOWN.
AppTargetDeviceAppType	String	False		Serves application types for devices. The allowed values are APP, WEB, UNKNOWN.
AudienceCategoryTargetAudienceCategoryType	String	False		Category type.
AudienceCategoryTargetCategoryNameEn	String	False		Category name (English).If targetType is AUDIENCE_CATEGORY_TARGET, this field is required.
AudienceCategoryTargetCategoryNameJa	String	False		Category name (Japanese).If targetType is AUDIENCE_CATEGORY_TARGET, this field is required.
DeviceTargetDeviceType	String	False		A container for storing gender targeting settings.Can set only bid adjustment in SET operation
GenderTargetGender	String	False		AdGroupTargetServiceGender serves genders.If targetType is GENDER_TARGET, this field is required. The allowed values are ST_MALE, ST_FEMALE, ST_UNKNOWN, UNKNOWN.
GeoTargetGeoareaSearchType	String	False		Types of regional search method.The default value in ADD operation will be GEO.
GeoTargetLatitudeInMicroDegrees	Int64	False		Micro degrees for the latitude.
GeoTargetLongitudeInMicroDegrees	Int64	False		Micro degrees for the longitude
GeoTargetRadius	Int64	False		Radius(km).
GeoTargetDescription	String	False		A description of the specified location
GeoTargetGeoNameEn	String	False		Region name (English).
GeoTargetGeoNameJa	String	False		Region name (Japanese).If targetType is GEO_TARGET, this field is required.
IsRemove	Boolean	False		If true, delete all targeting types.
OsTargetDeviceOsType	String	False		Serves OS types for devices to be posted on. The allowed values are IOS, ANDROID, UNKNOWN.
OsVersionTargetOsVersion	String	False		OS version.
PlacementCategoryTargetPlacementCategoryListName	String	False		Placement category list name.
PlacementTargetPlacementUrlListName	String	False		Placement List Name.
PlacementTargetPlacementUrlListType	String	False		Describes type of Placement URL list. The allowed values are WHITE_LIST, BLACKLIST, UNKNOWN.
PositionTargetPositionType	String	False		Serves position types of the instream video ads. The allowed values are INSTREAM_PREROLL, INSTREAM_MIDROLL, INSTREAM_POSTROLL, UNKNOWN.
SearchTargetSearchKeywordListName	String	False		Search Keyword List name.
SiteCategoryTargetCategoryFullNameEn	String	False		Site category name (English).
SiteCategoryTargetCategoryFullNameJa	String	False		Site category name (Japanese).
SiteRetargetingTargetTargetListDeliverType	String	False		Displays the type of target list type. The allowed values are INCLUDE, EXCLUDE, UNKNOWN.
SiteRetargetingTargetTargetListName	String	False		Target List name.
TargetType	String	False		Types of targets. PLACEMENT_CATEGORY_TARGET are target type exclusive for Guaranteed ads. The allowed values are AD_SCHEDULE_TARGET, GEO_TARGET, AGE_TARGET, GENDER_TARGET, INTEREST_CATEGORY, SITE_CATEGORY, SITE_RETARGETING, SEARCH_TARGET, PLACEMENT_TARGET, DEVICE_TARGET, CARRIER_TARGET, APP_TARGET, OS_TARGET, OS_VERSION_TARGET, AUDIENCE_CATEGORY_TARGET, POSITION_TARGET, PLACEMENT_CATEGORY_TARGET, UNKNOWN.

AudienceLists

Create, Read, Update or Delete the Audience list for site retargeting

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
AudienceListId supports the '=,IN'.
AudienceListType supports the '=,IN'.

For example:

SELECT * FROM AudienceLists WHERE AccountId = '1234339'
SELECT * FROM AudienceLists WHERE AccountId = '1234339' AND AudienceListId='1003039071'
SELECT * FROM AudienceLists WHERE AccountId = '1234339' AND AudienceListId='1003039071' AND AudienceListType='DEFAULT_LIST'

INSERT

Insert in AudienceLists can be done using temp tables.

INSERT INTO AudienceListContentCombinationAudienceListRulesRuleConditions#TEMP(AccountId, CompareOperator, RuleType, Value) Values(1002504155, 'EQUAL', 'URL', 'Cdata.com')
INSERT INTO AudienceListContentRuleAudienceListRules#TEMP(AccountId, RuleConditions) Values(1002504155,'AudienceListContentCombinationAudienceListRulesRuleConditions#TEMP')
INSERT INTO AudienceLists(AccountId, AudienceListType, AudienceListName, ContentRuleAudienceListRetargetingTagId, ContentRuleAudienceListIsOpen, ContentRuleAudienceListIsPreset, ContentRuleAudienceListReachPeriod,ContentRuleAudienceListRules) Values(1002504155,'RULE','UpdatingRetargetingListThrice','YWQ5T1KH11',TRUE,FALSE,7,'AudienceListContentRuleAudienceListRules#TEMP')

UPDATE

Update can be executed by specifying the AccountId, AudienceListId, AudienceListName AND AudienceListType in the WHERE Clause. For example:

UPDATE AudienceLists set AudienceListName='UpdatingRetargetingListFour' where AudienceListId=1003411978 AND AccountId=1002504155 AND AudienceListName='UpdatingRetargetingListThrice' AND AudienceListType='RULE'

DELETE

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

DELETE from AudienceLists where AudienceListId=1003411978 AND AccountId=1002504155

Columns


Name	Type	ReadOnly	References	Description
AudienceListId [KEY]	Int64	True		Audience List ID.
AccountId	Int64	True	DisplayAdsAccounts.AccountId	Account ID.
AudienceListType	String	False		Types of audience list. DEFAULT_LIST cannot be specified in ADD operation. The allowed values are DEFAULT_LIST, RULE, COMBINATION, SIMILARITY, CUSTOM_AUDIENCE, UNKNOWN.
ContentCombinationAudienceListCombinations	String	False		Combination of audience list information. If targetListType is COMBINATION, this field is required in ADD and SET operation.
ContentCustomAudienceListCustomAudienceId	String	False		ID to configure Yahoo! JAPAN DMP. If targetListType is CUSTOM_AUDIENCE, this field is required in ADD and SET operation.
ContentCustomAudienceListReachPeriod	Int64	False		Duration of user data configured from DMP (1-60days). If targetListType is CUSTOM_AUDIENCE, this field is required in ADD operation.
ContentCustomerDataAudienceListCustomAudienceId	String	False		Custom audience ID.
ContentCustomerDataAudienceListReachPeriod	Int64	False		Duration of user data configured from DMP (1-60days).This field is required in ADD operation.
ContentRuleAudienceListIsOpen	String	False		Display the setting of store to reaches Audience List. If audienceListType is RULE, this field is required in ADD operation, and is optional in SET operation. If audienceListType is DEFAULT_LIST, this field is optional in SET operation. The allowed values are TRUE, FALSE, UNKNOWN.
ContentRuleAudienceListIsPreset	String	False		Display the setting of history of past visit. This field is required in ADD operation. The allowed values are TRUE, FALSE, UNKNOWN.
ContentRuleAudienceListReachPeriod	Int64	False		Cookies validation period. (1 - 540 days). This field is required in ADD operation and is Optional in SET operation.
ContentRuleAudienceListRetargetingTagId	String	False		ID of Retargeting Tag. This field is required in ADD operation.
ContentRuleAudienceListRules	String	False		It displays the Possible conditions for audience list. This field is optional in ADD and SET operation.
ContentSimilarityAudienceListId	Int64	False		Audience list ID that is the basis for creating the audience list (similar users). This field is required in ADD operation, and will be ignored in SET and REMOVE operation.
ContentSimilarityAudienceListSize	String	False		It serves audience list size of similarity audience list. Under similarityaudienceList, this field is optional in ADD and SET operation, and will be ignored in REMOVE operation.
ContentSimilarityAudienceListSizeReaches	String	False		It contains each reaches of audience list size. Although this field will be returned in the response, it will be ignored on input.
ContentWebsiteVisitorsAudienceListIsOpen	String	False		Display the setting of store of reaches to Audience List. If audienceListType is RULE, this field is required in ADD operation, and is optional in SET operation. If audienceListType is DEFAULT_LIST, this field is optional in SET operation.
ContentWebsiteVisitorsAudienceListIsPreset	String	False		Display the setting of history of past visit.This field is required in ADD operation. The allowed values are TRUE, FALSE, UNKNOWN.
ContentWebsiteVisitorsAudienceListReachPeriod	Int64	False		Cookies validation period. (1 - 540 days). This field is required in ADD operation, and is optional in SET operation.
ContentWebsiteVisitorsAudienceListRetargetingTagId	String	False		ID of Retargeting Tag. This field is required in ADD operation.
ContentWebsiteVisitorsAudienceListRules	String	False		Displays the possible conditions for audience list. This field is optional in ADD and SET operation.
AudienceListName	String	False		Audience List name.
DeliveryStatus	String	False		Account delivery status The allowed values are ACTIVE, PAUSED, UNKNOWN.
Description	String	False		Description of Audience List.
IsRemoveDescription	String	False		flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
IsShared	Boolean	False		Describes the sharing status of the audience list The allowed values are TRUE, FALSE, UNKNOWN.
Reach	Int64	False		Number of reaches.
SourceAccountId	Int64	False		Account ID of the sharing source.
SourceAccountName	String	False		Account name of the sharing source.
SourceType	String	False		Describes the source type.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
SharingStatusFilterType	String	Sharing status of the Audiencet list. The allowed values are ALL, SHARED, NOT_SHARED, UNKNOWN. The default value is ALL.
ReferenceNumber	String	This column will be used in Bulk operations to get specific values from the Temp tables.

ContentsKeywordLists

Get the contents keyeord list

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
ContentsKeywordListId supports the '=,IN'.

For example:

SELECT * FROM ContentsKeywordLists WHERE AccountId = '1002504155'

SELECT * FROM ContentsKeywordLists WHERE ContentsKeywordListId='1000010795'

INSERT

Insert can be executed by specifying the AccountId, ContentsKeywordListName, ContentsKeyword and ContentsKeywordId 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 ContentsKeywordListsContentsKeyword#TEMP (ContentsKeywordId) VALUES (181202)
INSERT INTO ContentsKeywordLists (ContentsKeywordListName,ContentsKeyword,accountid) VALUES ('testvickyy',ContentsKeywordListsContentsKeyword#TEMP,1002504155)

UPADTE

Update can be executed by specifying the AccountId ,ContentsKeywordListId and ContentsKeywordId in the WHERE Clause. The columns that are not read-only can be Updated. For example:

INSERT INTO ContentsKeywordListsContentsKeyword#TEMP (ContentsKeywordId) VALUES (181202)
UPDATE ContentsKeywordLists SET ContentsKeywordListName ='NewTestLabeltest' WHERE AccountId ='1002504155' AND ContentsKeyword='ContentsKeywordListsContentsKeyword#TEMP' AND ContentsKeywordListId ='1000010795'

DELETE

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

DELETE From ContentsKeywordLists  WHERE AccountId ='1002504155' AND ContentsKeywordListId ='1000010795'

Columns


Name	Type	ReadOnly	References	Description
ContentsKeywordListId [KEY]	Int64	True		Contents keyword list ID.This field is required in SET and REMOVE operation.
AccountId	Int64	True	DisplayAdsAccounts.AccountId	Account ID.
BrandSafetyDenyListFlg	Boolean	False		A flag that indicates whether it is an exclusion list.This field is optional in ADD operation (default value will be FALSE), and cannot be specified in SET operation The allowed values are TRUE, FALSE.
ContentsKeyword	String	False		Contents keyword.This field is required in ADD and SET operation
ContentsKeywordListDescription	String	False		Description of Contents keyword list
ContentsKeywordListName	String	False		Name of Contents keyword list.This field is required in ADD operation
IsRemoveContentsKeywordListDescription	String	False		ContentsKeywordListServiceIsRemoveFlg is a flag for removing an information item

ConversionGroups

Get ConversionGroup information of specified account

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
ConversionGroupId supports the '='.
ConversionGroupName supports the '='.
ConversionTrackerId supports the '='.

For example:

SELECT * FROM ConversionGroups WHERE AccountId = '1002504155'

SELECT * FROM ContentsKeywordLists WHERE ConversionGroupId ='1000010795'

SELECT * FROM ContentsKeywordLists WHERE ConversionGroupName ='test'

SELECT * FROM ContentsKeywordLists WHERE ConversionTrackerId ='1000010795'

INSERT

Insert can be executed by specifying the AccountId, ContentsKeywordListName, ContentsKeyword and ContentsKeywordId 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 ConversionGroupConversions#TEMP(conversionTrackerId,ConversionTrackerType,status) VALUES (1309357,WEB_CONVERSION,ENABLED)
INSERT INTO ConversionGroupConversions#TEMP(conversionTrackerId,ConversionTrackerType,status) VALUES (1309357,WEB_CONVERSION,ENABLED)
INSERT INTO ConversionGroups (ConversionGroupName,accountid,Conversions) VALUES ('testvivek',1002504155,'ConversionGroupConversions#TEMP')

UPADTE

Update can be executed by specifying the AccountId ,ContentsKeywordListId and ContentsKeywordId in the WHERE Clause. The columns that are not read-only can be Updated. For example:

UPDATE ConversionGroups SET ConversionGroupName ='NewTestLabeltest' WHERE AccountId ='1002504155' AND ConversionGroupId ='123456'

DELETE

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

DELETE From ConversionGroups  WHERE AccountId ='1002504155' AND  ConversionGroupId ='123456'

Columns


Name	Type	ReadOnly	References	Description
ConversionGroupId [KEY]	Int64	True	DisplayAdsConversionTrackers.ConversionTrackerId	Conversion Group ID.This field will be ignored in ADD operation, and will be required in SET and REMOVE operation
AccountId	Int64	False	DisplayAdsAccounts.AccountId	Account ID.
ConversionGroupName	String	False		Conversion Group Name.This field is required in ADD operation, and will be optional in SET operation
Conversions	String	False		ConversionGroupServiceConversion object shows ConversionTracker information such as ConversionTag

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
ConversionTrackerId	Int64	Conversion Tracker ID

DisplayAdsAccountManagement

Create, Update or Read account information. Restricted to some users

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '=,IN'.
AuthType supports the '='.
AccountStatus supports the '=,IN'.
AccountType supports the '=,IN'.
IncludeTestAccount supports the '='.

For example:

SELECT * FROM DisplayAdsAccountManagement WHERE AccountId = '1002504155' AND AuthType = 'REFERABLE'

SELECT * FROM DisplayAdsAccountManagement WHERE AccountId = '1002504155' AND AccountStatus = 'INPROGRESS'

SELECT * FROM DisplayAdsAccountManagement WHERE AccountId = '1002504155' AND AccountType = 'PREPAY'

SELECT * FROM DisplayAdsAccountManagement WHERE AccountId = '1002504155' AND IncludeTestAccount = 'EXCLUDE_TEST'

INSERT

Insert can be executed by specifying the AccountName,AccountPaymentInvoiceBudgetAmount,AccountPaymentPaymentType,ClientBuilding,ClientCity,ClientCompanyName,ClientCompanyNameKana,ClientEnterpriseType,ClientPhoneNumber,ClientStreet1,ClientStreet2,ClientUrl,ClientUrlType,ClientZip,ClientType columns. The columns that are not read-only can be inserted optionally.

INSERT INTO DisplayAdsAccountManagement (AccountName,AccountPaymentInvoiceBudgetAmount,AccountPaymentPaymentType,ClientBuilding,ClientCity,ClientCompanyName,ClientCompanyNameKana,ClientEnterpriseType,ClientPhoneNumber,ClientStreet1,ClientStreet2,ClientUrl,ClientUrlType,ClientZip,ClientType ) values('test',1234,'PREPAY','cdata','blr','infosys','cd','GOMEI','98765-98765-98765','street1','street2','ClientUrl','PC','123-1234','AGENT');

UPDATE

Update can be executed by specifying the AccountId in the WHERE Clause. The columns that are not read-only can be Updated. For example:

UPDATE DisplayAdsAccountManagement SET AccountName='TestAccount' WHERE AccountId='1002504155'

Columns


Name	Type	ReadOnly	References	Description
AccountId [KEY]	Int64	True	DisplayAdsAccounts.AccountId	Account ID.
AccountName	String	False		Account Name.
AccountPaymentInvoiceBudgetAmount	Int64	False		Budget Amount.Amount must be more than 3,000 and less than 999,999,999,999,000. The unit is 1,000.
AccountPaymentPaymentType	String	False		Type of payment.Amount must be more than 3,000 and less than 999,999,999,999,000. The unit is 1,000. The allowed values are PREPAY, INVOICE, UNKNOWN.
AgencyPersonName	String	False		Agency Person Name.
AgencyPrefectureCode	String	False		Describes the code of prefectures. Under 'client', this field will be required in ADD operation. The allowed values are HOKKAIDO, AOMORI, IWATE, MIYAGI, AKITA, YAMAGATA, FUKUSHIMA, IBARAKI, TOCHIGI, GUNMA, SAITAMA, CHIBA, TOKYO, KANAGAWA, NIIGATA, TOYAMA, ISHIKAWA, FUKUI, YAMANASHI, NAGANO, GIFU, SHIZUOKA, AICHI, MIE, SIGA, KYOTO, OSAKA, HYOGO, NARA, WAKAYAMA, TOTTORI, SHIMANE, OKAYAMA, HIROSHIMA, YAMAGUCHI, TOKUSHIMA, KAGAWA, EHIME, KOCHI, FUKUOKA, SAGA, NAGASAKI, KUMAMOTO, OITA, MIYAZAKI, KAGOSHIMA, OKINAWA, NONE, UNKNOWN.
AuthType	String	False		Roles. The allowed values are REFERABLE, UPDATABLE, UNKNOWN.
AutoTaggingEnabled	String	False		Management flag for whether or not to set auto tag The allowed values are FALSE, TRUE, UNKNOWN. The default value is TRUE.
ClientBuilding	String	False		Building name.
ClientCity	String	False		City name.When clientType is SELF, this field will be ignored in ADD and SET operations.
ClientClientPersonName	String	False		Client person name.
ClientCompanyName	String	False		Company name.When clientType is SELF, this field will be ignored in ADD and SET operations.
ClientCompanyNameKana	String	False		Kana characters of company name . When clientType is SELF, this field will be ignored in ADD and SET operations.
ClientEnterpriseType	String	False		Type of enterprise.When clientType is SELF, this field will be ignored in ADD and SET operations. The allowed values are KABUSHIKI, YUGEN, GOSI, ZAIDAN, SYADAN, SYUKYO, GAKKO, KOJIN, OTHER, GOMEI, HIEIRI, GODO, KYODO, UNKNOWN.
ClientEnterpriseTypePosition	String	False		Position of enterprise type .Cannot be set when enterpriseType is KOJIN or OTHER in ADD operation.When clientType is SELF, this field will be ignored in ADD and SET operations. The allowed values are FRONT, Back, UNKNOWN.
ClientPhoneNumber	String	False		Phone number In xxxxx-xxxxx-xxxxx format. When clientType is SELF, this field will be ignored in ADD and SET operations.
ClientPrefectureCode	String	False		Code of prefectures
ClientStreet1	String	False		Street1. When clientType is SELF, this field will be ignored in ADD and SET operations.
ClientStreet2	String	False		Street2. When clientType is SELF, this field will be ignored in ADD and SET operations.
ClientUrl	String	False		Site URL for placing advertisement.
ClientUrlType	String	False		Type of application url. The allowed values are PC, DOCOMO, KDDI, SOFTBANK, OTHER, UNKNOWN.
ClientZip	String	False		Zip code.In xxx-xxxx format.When clientType is SELF, this field will be ignored in ADD and SET operations.
ClientType	String	False		Type of client. The allowed values are AGENT, SELF, UNKNOWN.
ContactBizId	String	False		Contact Business ID.
DeliveryStatus	String	False		Account delivery status. The allowed values are ACTIVE, PAUSED, UNKNOWN. The default value is ACTIVE.
StartDate	Date	False		Start Date.
EndDate	Date	False		End Date.
IsTestAccount	String	False		Account is a test account or not. The allowed values are ACTIVE, PAUSED, UNKNOWN.
Status	String	False		Contract status of account. The allowed values are INPROGRESS, WAIT_DECIDE, SUSPENDED, SERVING, ENDED, CANCELED, UNKNOWN.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
AccountStatus	String	Account Statuses.
AccountType	String	Account Payment Types.
IncludeTestAccount	String	Control which accounts are retrieved. The allowed values are ONLY_TEST, EXCLUDE_TEST, ALL, UNKNOWN.

DisplayAdsAccounts

Read Or Update account information.

Table Specific Information

Select

The Sync App will use the Yahoo! Ads API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Sync App.

AccountId supports the '=,IN'.
AccountName supports the '='.
AccountStatus supports the '=,IN'.
AccountType supports the '=,IN'.
AuthType supports the '=,IN'.
IncludeTestAccount supports the '='.
IncludeManagerAccount supports the '='.

For example:

SELECT * FROM DisplayAdsAccounts

SELECT * FROM DisplayAdsAccounts WHERE AccountName = 'TestAccount'

SELECT * FROM DisplayAdsAccounts WHERE AccountStatus = 'SERVING'

SELECT * FROM DisplayAdsAccounts WHERE AuthType = 'UPDATABLE'

SELECT * FROM DisplayAdsAccounts WHERE AccountType = 'PREPAY'

SELECT * FROM DisplayAdsAccounts WHERE IncludeTestAccount = 'ALL'

SELECT * FROM DisplayAdsAccounts WHERE IncludeManagerAccount = 'ALL'

UPDATE

Update can be executed by specifying the AccountId in the WHERE Clause. The columns that are not read-only can be Updated. For example:

UPDATE DisplayAdsAccounts SET AccountName = 'TestAccount' WHERE AccountId = '1002504155'

Columns


Name	Type	ReadOnly	References	Description
AccountId [KEY]	Int64	True		Account ID.
AccountName	String	False		Account Name.
AccountStatus	String	False		Account status. The allowed values are INPROGRESS, WAIT_DECIDE, SUSPENDED, SERVING, ENDED, UNKNOWN.
AccountType	String	False		Payment type of the account. The allowed values are PREPAY, INVOICE, UNKNOWN.
AuthType	String	False		Roles. The allowed values are REFERABLE, UPDATABLE, UNKNOWN.
AutoTaggingEnabled	String	False		The Management flag for whether or not to set auto tag.
ContactBizId	String	False		Contact Business ID.
DeliveryStatus	String	False		Delivery Status.
StartDate	Date	False		Start date of ad serving.
EndDate	Date	False		End date of ad serving.
IsManagerAccount	String	False		Describes whether it is an MCC account.
IsTestAccount	String	False		Describes whether it is a Test account.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
IncludeTestAccount	String	Accounts to retrieve The allowed values are ONLY_TEST, EXCLUDE_TEST, ALL, UNKNOWN. The default value is EXCLUDE_TEST.
IncludeManagerAccount	String	Represents whether the account to be retrieved includes an MCC account. The allowed values are ONLY_MANAGER, EXCLUDE_MANAGER, ALL, UNKNOWN. The default value is EXCLUDE_MANAGER.

DisplayAdsAccountTrackingUrl

Get Information related to account tracking.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.

For example:

SELECT * FROM DisplayAdsAccountTrackingUrl WHERE AccountId = '1002504155'

UPADTE

Update can be executed by specifying the AccountId in the WHERE Clause. The columns that are not read-only can be Updated. For example:

UPDATE DisplayAdsAccountTrackingUrl SET AccountName = 'Test' WHERE Accountid = '1002504155'

Columns


Name	Type	ReadOnly	References	Description
AccountId [KEY]	Int64	True	DisplayAdsAccounts.AccountId	Account ID.
AccountName	String	False		Account name.
IsRemoveTrackingUrl	String	False		flag for removing an information item. The allowed values are TRUE, FALSE, UNKNOWN.

DisplayAdsAdGroupAds

Create, Read, Update or Delete ad information

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
AdGroupId supports the '=,IN'.
AdId supports the '=,IN'.
ApprovalStatus supports the '=,IN'.
CampaignId supports the '=,IN'.
MediaId supports the '=,IN'.
UserStatus supports the '=,IN'.
CampaignGoalFilterType supports the '='.
ContainsLabelIdFlg supports the '='.
LabelId supports the '=,IN'.
StartDate supports the '='.
EndDate supports the '='.

For example:

SELECT * FROM DisplayAdsAdGroupAds WHERE AccountId = '125466'

SELECT * FROM DisplayAdsAdGroupAds WHERE AccountId = '123436' AND AdId IN ('4561','6996')
     
SELECT * FROM DisplayAdsAdGroupAds WHERE AccountId = '123436' AND ApprovalStatus IN ('APPROVED','APPROVED_WITH_REVIEW')

SELECT * FROM DisplayAdsAdGroupAds WHERE AccountId = '123436' AND MediaId IN ('12644','325687') AND UserStatus IN ('ACTIVE', 'PAUSED')

SELECT * FROM DisplayAdsAdGroupAds WHERE AccountId = '123436' AND CampaignGoalFilterType = 'ALL'

SELECT * FROM DisplayAdsAdGroupAds WHERE AccountId = '123436' AND ContainsLabelIdFlg = 'True' AND LabelId IN ('5697122')

SELECT * FROM DisplayAdsAdGroupAds WHERE AccountId = '123436' AND StartDate = '2021-06-03' AND EndDate = '2021-06-03'

INSERT

Insert can be executed by specifying the AccountId, AdGroupId, AdAdType, CampaignId and UserStatus 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 DisplayAdsAdGroupAds(AccountId, AdGroupId, AdType, TextAdDescription, TextAdDescription2, TextAdDisplayUrl, TextAdHeadline, TextAdUrl, Name, ApprovalStatus, CampaignId, UserStatus) values ('1002504155','437279778','TEXT_LONG_AD1','Test1','Test2','itunes.apple.com','TestHeadlines','https://www.test1.com','TestName','REVIEW','30820477','ACTIVE')

UPDATE

Update can be executed by specifying the AccountId,AdGroupId,AdId and CampaignId in the WHERE Clause. The columns that are not read-only can be Updated. For example:

UPDATE DisplayAdsAdGroupAds SET MediaId='10' WHERE AccountId = '1234' AND AdGroupId = '256' AND AdId = '562' AND CampaignId = '12533'

DELETE

Delete can be executed by specifying the AccountId, AdGroupId, AdId and CampaignId in the WHERE Clause. For example:

DELETE FROM DisplayAdsAdGroupAds WHERE AccountId = '1234' AND AdGroupId = '256' AND AdId = '562' AND CampaignId = '12533'

Columns


Name	Type	ReadOnly	References	Description
AdId [KEY]	Int64	True		Ad ID
AccountId	Int64	True	DisplayAdsAccounts.AccountId	Account ID
AdGroupId	Int64	True	DisplayAdsAdGroups.AdGroupId	Ad group ID
AdType	String	False		Types of ad. The allowed values are TEXT_SHORT_AD2, RESPONSIVE_IMAGE_AD, STATIC_FRAME_AD, BANNER_VIDEO_AD, RESPONSIVE_VIDEO_AD, DYNAMIC_AD, TEXT_LONG_AD1, TEXT_LONG_AD2, TEXT_SHORT_AD1, BANNER_IMAGE_AD, POS_AD, UNKNOWN.
BannerImageAdDisplayUrl	String	False		Display URL.
BannerImageAdUrl	String	False		Destination URL.
BannerImageAdCustomParametersIsRemove	String	False		Delete flag. The allowed values are TRUE, FALSE, UNKNOWN.
BannerImageAdCustomParameters	String	False		Displays the element of custom parameters.
BannerImageAdDisplayUrlLevel	String	False		Display URL.
BannerImageAdFinalUrl	String	False		Final URL.
BannerImageAdSmartphoneFinalUrl	String	False		Final URL (smartphone).
BannerImageAdisRemoveSmartphoneFinalUrl	String	False		Flag for removing an information item. The allowed values are TRUE, FALSE, UNKNOWN..
BannerImageAdisRemoveTrackingUrl	String	False		Flag for removing an information item. The allowed values are TRUE, FALSE, UNKNOWN..
BannerImageAdtrackingUrl	String	False		Destination URL.
BannerVideoAdDisplayUrl	String	False		Display URL.If adType is BANNER_IMAGE_AD, this field is required in ADD operation.
BannerVideoAdAddisplayUrlLevel	String	False		Display URL.
BannerVideoAdAdFinalUrl	String	False		Final URL.
BannerVideoAdAdSmartphoneFinalUrl	String	False		Final URL (smartphone).
BannerVideoAdAdisRemoveSmartphoneFinalUrl	String	False		Flag for removing an information item. The allowed values are TRUE, FALSE, UNKNOWN..
BannerVideoAdAdisRemoveTrackingUrl	String	False		Flag for removing an information item. The allowed values are TRUE, FALSE, UNKNOWN..
BannerVideoAdIsRemoveVideo10SecBeaconUrls	String	False		Flag for removing an information item. The allowed values are TRUE, FALSE, UNKNOWN.
BannerVideoAdIsRemoveVideo25PercentBeaconUrls	String	False		Flag for removing an information item. The allowed values are TRUE, FALSE, UNKNOWN.
BannerVideoAdIsRemoveVideo3SecBeaconUrls	String	False		Flag for removing an information item. The allowed values are TRUE, FALSE, UNKNOWN.
BannerVideoAdIsRemoveVideo50PercentBeaconUrls	String	False		Flag for removing an information item The allowed values are TRUE, FALSE, UNKNOWN.
BannerVideoAdIsRemoveVideo75PercentBeaconUrls	String	False		Flag for removing an information item. The allowed values are TRUE, FALSE, UNKNOWN.
BannerVideoAdCustomParametersIsRemove	String	False		Delete flag. The allowed values are TRUE, FALSE, UNKNOWN.
BannerVideoAdCustomParameters	String	False		Displays the element of custom parameters.
BannerVideoAdIsRemoveVideoCompleteBeaconUrls	String	False		Flag for removing an information item. The allowed values are TRUE, FALSE, UNKNOWN.
BannerVideoAdIsRemoveVideoStartBeaconUrls	String	False		Flag for removing an information item. The allowed values are TRUE, FALSE, UNKNOWN.
BannerVideoAdThumbnailMediaId	Int64	False		Thumbnail ID.If adType is BANNER_VIDEO_AD, this field is required in ADD operation.
BannerVideoAdUrl	String	False		Destination URL
BannerVideoAdVideo10SecBeaconUrls	String	False		Viewing beacon URL (10 seconds).
BannerVideoAdVideo25PercentBeaconUrls	String	False		Playback viewing beacon URL (25%).
BannerVideoAdVideo3SecBeaconUrls	String	False		Beacon URL (3 seconds).
BannerVideoAdVideo50PercentBeaconUrls	String	False		Playback viewing beacon URL (50%)
BannerVideoAdVideo75PercentBeaconUrls	String	False		Playback viewing beacon URL (75%)
BannerVideoAdVideoCompleteBeaconUrls	String	False		Beacon URL (complete)
BannerVideoAdVideoStartBeaconUrls	String	False		beacon URL (start)
DynamicAdBrandColor	String	False		Brand color. Format= RGB or HEX
DynamicAdButtonText	String	False		Displays the button text. The allowed values are INSTALL, MORE_DETAIL, CONFIRM_PROPERTY, DOWNLOAD, DOWNLOAD, PURCHASE_NOW, REQUEST_INFO, RESERVE_NOW, REGISTER_NOW, EXPERIENCE, RESERVE_HERE, APPLY_NOW, FOR_MORE_INFO, PURCHASE, CONTACT_US, CONFIRM_NOW, APPLY_HERE, UNKNOWN. The default value is MORE_DETAIL.
DynamicAdDisplayUrl	String	False		Display URL.If adType is BANNER_IMAGE_AD, this field is required in ADD operation.
DynamicAdAddisplayUrlLevel	String	False		Display URL.
DynamicAdAdFinalUrl	String	False		Final URL.
DynamicAdAdSmartphoneFinalUrl	String	False		Final URL (smartphone).
DynamicAdAdisRemoveSmartphoneFinalUrl	String	False		Flag for removing an information item. The allowed values are TRUE, FALSE, UNKNOWN..
DynamicAdAdisRemoveTrackingUrl	String	False		Flag for removing an information item. The allowed values are TRUE, FALSE, UNKNOWN..
DynamicAdCampaignBannerMediaId	Int64	False		Campaign banner media ID.
DynamicAdCampaignBannerMediaId2	Int64	False		Campaign banner media ID 2.
DynamicAdCampaignBannerMediaId3	Int64	False		Campaign banner media ID 3
DynamicAdCampaignBannerMediaId4	Int64	False		Campaign banner media ID 4.
DynamicAdCampaignBannerUrl	String	False		Campaign banner URL
DynamicAdDisplayUrl	String	False		Display URL
DynamicAdCustomParametersIsRemove	String	False		Delete flag. The allowed values are TRUE, FALSE, UNKNOWN.
DynamicAdCustomParameters	String	False		Displays the element of custom parameters.
DynamicAdIsRemoveBrandColor	String	False		Flag for removing an information item The allowed values are TRUE, FALSE, UNKNOWN.
DynamicAdIsRemoveCampaignBannerMediaId	String	False		Flag for removing an information item The allowed values are TRUE, FALSE, UNKNOWN.
DynamicAdIsRemoveCampaignBannerMediaId2	String	False		Flag for removing an information item The allowed values are TRUE, FALSE, UNKNOWN.
DynamicAdIsRemoveCampaignBannerMediaId3	String	False		Flag for removing an information item The allowed values are TRUE, FALSE, UNKNOWN.
DynamicAdIsRemoveCampaignBannerMediaId4	String	False		Flag for removing an information item The allowed values are TRUE, FALSE, UNKNOWN.
DynamicAdIsRemoveCampaignBannerUrl	String	False		Flag for removing an information item The allowed values are TRUE, FALSE, UNKNOWN.
DynamicAdIsRemovePrefix	String	False		Flag for removing an information item The allowed values are TRUE, FALSE, UNKNOWN.
DynamicAdIsRemoveSuffix	String	False		Flag for removing an information item The allowed values are TRUE, FALSE, UNKNOWN.
DynamicAdLogoMediaId	Int64	False		Media ID of logo image
DynamicAdLogoMediaId2	Int64	False		Media ID of logo image 2.
DynamicAdLogoMediaId3	Int64	False		Media ID of logo image 3.
DynamicAdPrefix	String	False		Prefix
DynamicAdPrincipal	String	False		Advertiser Indication
DynamicAdSuffix	String	False		Suffix
DynamicAdUrl	String	False		Destination URL
MobileAdDescription	String	False		Description text (line 1).
MobileAdDescription2	String	False		Description text (line 2).
MobileAdDisplayUrl	String	False		Display URL.
MobileAdHeadline	String	False		Title
MobileAdMobileCarriers	String	False		Carrier types. The allowed values are DOCOMO,KDDI,SOFTBANK,NONE,UNKNOWN
MobileAdUrl	String	False		Destination URL
PosAdDescription	String	False		Description
PosAdUrl	String	False		Destination URL.
ResponsiveImageAdButtonText	String	False		Displays the button text. The allowed values are INSTALL, MORE_DETAIL, CONFIRM_PROPERTY, DOWNLOAD, DOWNLOAD, PURCHASE_NOW, REQUEST_INFO, RESERVE_NOW, REGISTER_NOW, EXPERIENCE, RESERVE_HERE, APPLY_NOW, FOR_MORE_INFO, PURCHASE, CONTACT_US, CONFIRM_NOW, APPLY_HERE, UNKNOWN. The default value is MORE_DETAIL.
ResponsiveImageAdDescription	String	False		Description.
ResponsiveImageAdDisplayUrl	String	False		Display URL
ResponsiveImageAddisplayUrlLevel	String	False		Display URL.
ResponsiveImageAdFinalUrl	String	False		Final URL.
ResponsiveImageAdSmartphoneFinalUrl	String	False		Final URL (smartphone).
ResponsiveImageAdisRemoveSmartphoneFinalUrl	String	False		Flag for removing an information item. The allowed values are TRUE, FALSE, UNKNOWN..
ResponsiveImageAdisRemoveTrackingUrl	String	False		Flag for removing an information item. The allowed values are TRUE, FALSE, UNKNOWN..
ResponsiveImageAdCustomParametersIsRemove	String	False		Delete flag. The allowed values are TRUE, FALSE, UNKNOWN.
ResponsiveImageAdCustomParameters	String	False		Displays the element of custom parameters.
ResponsiveImageAdHeadline	String	False		Title
ResponsiveImageAdIsRemoveLogoMediaId	String	False		Flag for removing an information item The allowed values are TRUE, FALSE, UNKNOWN.
ResponsiveImageAdLogoMediaId	Int64	False		Media ID of logo image.
ResponsiveImageAdPrincipal	String	False		Advertiser Indication of the ad
ResponsiveImageAdUrl	String	False		Destination URL.
ResponsiveVideoAdButtonText	String	False		Types of ad. The allowed values are TEXT_SHORT_AD2, RESPONSIVE_IMAGE_AD, STATIC_FRAME_AD, BANNER_VIDEO_AD, RESPONSIVE_VIDEO_AD, DYNAMIC_AD, TEXT_LONG_AD1, TEXT_LONG_AD2, TEXT_SHORT_AD1, BANNER_IMAGE_AD, POS_AD, UNKNOWN.
ResponsiveVideoAdDescription	String	False		Ad description.If adType is RESPONSIVE_VIDEO_AD, this field is required in ADD operation.
ResponsiveVideoAdCustomParametersIsRemove	String	False		Delete flag. The allowed values are TRUE, FALSE, UNKNOWN.
ResponsiveVideoAdCustomParameters	String	False		Displays the element of custom parameters.
ResponsiveVideoAdDisplayUrl	String	False		Display URL.
ResponsiveVideoAdHeadline	String	False		Ad title.If adType is RESPONSIVE_VIDEO_AD, this field is required in ADD operation.
ResponsiveVideoAdIsRemoveLogoMediaId	String	False		Flag for removing an information item The allowed values are TRUE, FALSE, UNKNOWN.
ResponsiveVideoAdIsRemoveVideo10SecBeaconUrls	String	False		Flag for removing an information item The allowed values are TRUE, FALSE, UNKNOWN.
ResponsiveVideoAdIsRemoveVideo25PercentBeaconUrls	String	False		Flag for removing an information item The allowed values are TRUE, FALSE, UNKNOWN.
ResponsiveVideoAdIsRemoveVideo3SecBeaconUrls	String	False		Flag for removing an information item The allowed values are TRUE, FALSE, UNKNOWN.
ResponsiveVideoAdIsRemoveVideo50PercentBeaconUrls	String	False		Flag for removing an information item The allowed values are TRUE, FALSE, UNKNOWN.
ResponsiveVideoAdIsRemoveVideo75PercentBeaconUrls	String	False		Flag for removing an information item The allowed values are TRUE, FALSE, UNKNOWN.
ResponsiveVideoAdIsRemoveVideoCompleteBeaconUrls	String	False		Flag for removing an information item The allowed values are TRUE, FALSE, UNKNOWN.
ResponsiveVideoAdIsRemoveVideoStartBeaconUrls	String	False		Flag for removing an information item The allowed values are TRUE, FALSE, UNKNOWN.
ResponsiveVideoAdLogoMediaId	Int64	False		Logo image ID.
ResponsiveVideoAdPrincipal	String	False		Advertiser Indication of the ad.If adType is RESPONSIVE_VIDEO_AD, this field is required in ADD operation.
ResponsiveVideoAdThumbnailMediaId	Int64	False		Thumbnail ID.If adType is RESPONSIVE_VIDEO_AD, this field is required in ADD operation.
ResponsiveVideoAdUrl	String	False		Destination URL.If adType is RESPONSIVE_VIDEO_AD, this field is required in ADD operation.
ResponsiveVideoAdVideo10SecBeaconUrls	String	False		Beacon URL (10 seconds)
ResponsiveVideoAdVideo25PercentBeaconUrls	String	False		Playback viewing beacon URL (25%).
ResponsiveVideoAdVideo3SecBeaconUrls	String	False		Beacon URL (3 seconds).
ResponsiveVideoAdVideo50PercentBeaconUrls	String	False		Playback viewing beacon URL (50%)
ResponsiveVideoAdVideo75PercentBeaconUrls	String	False		Playback viewing beacon URL (75%)
ResponsiveVideoAdVideoCompleteBeaconUrls	String	False		Beacon URL (complete)
ResponsiveVideoAdVideoStartBeaconUrls	String	False		Beacon URL (start)
StaticFrameAdButtonText	String	False		Displays the button text. The allowed values are INSTALL, MORE_DETAIL, CONFIRM_PROPERTY, DOWNLOAD, DOWNLOAD, PURCHASE_NOW, REQUEST_INFO, RESERVE_NOW, REGISTER_NOW, EXPERIENCE, RESERVE_HERE, APPLY_NOW, FOR_MORE_INFO, PURCHASE, CONTACT_US, CONFIRM_NOW, APPLY_HERE, UNKNOWN. The default value is MORE_DETAIL.
StaticFrameAdColorSetId	Int64	False		Color set ID.
StaticFrameAdDescription	String	False		Description.
StaticFrameAdDisplayUrl	String	False		Display URL.
StaticFrameAdHeadline	String	False		Title.
StaticFrameAdIsRemoveLogoMediaId	String	False		Flag for removing an information item The allowed values are TRUE, FALSE, UNKNOWN.
StaticFrameAdLayout	String	False		Ad Layout.
StaticFrameAdLogoMediaId	Int64	False		Media ID of logo image
StaticFrameAdPrincipal	String	False		Advertiser Indication
StaticFrameAdSize	String	False		Ad Size.
StaticFrameAdUrl	String	False		Destination URL
TextAdDescription	String	False		Description text (line 1).If adType is TEXT_LONG_AD1 or TEXT_SHORT_AD2, this field is required in ADD operation.
TextAdDescription2	String	False		Description text (line 2).If adType is TEXT_LONG_AD1 or TEXT_SHORT_AD2, this field is required in ADD operation.
TextAddisplayUrlLevel	String	False		Display URL.
TextAdFinalUrl	String	False		Final URL.
TextAdSmartphoneFinalUrl	String	False		Final URL (smartphone).
TextAdisRemoveSmartphoneFinalUrl	String	False		Flag for removing an information item. The allowed values are TRUE, FALSE, UNKNOWN..
TextAdisRemoveTrackingUrl	String	False		Flag for removing an information item. The allowed values are TRUE, FALSE, UNKNOWN..
TextAdCustomParametersIsRemove	String	False		Delete flag. The allowed values are TRUE, FALSE, UNKNOWN.
TextAdCustomParameters	String	False		Displays the element of custom parameters.
TextAdDisplayUrl	String	False		Display URL.However, not allowed for ADD and SET when a campaign goal is app promotion. Based on DeviceOsType specified on the campaign, any of the following URLs will be automatically For iOS : itunes.apple.com,For Android : play.google.com
TextAdHeadline	String	False		Title.If adType is TEXT_LONG_AD1 or TEXT_SHORT_AD2, this field is required in ADD operation.
TextAdUrl	String	False		Destination URL.If adType is TEXT_LONG_AD1 or TEXT_SHORT_AD2, this field is required in ADD operation.
CarouselAdCustomParametersIsRemove	String	False		Delete flag. The allowed values are TRUE, FALSE, UNKNOWN.
CarouselCustomParameters	String	False		Displays the element of custom parameters.
CarouselAdButtonText	String	False		Displays the button text. The allowed values are INSTALL, MORE_DETAIL, CONFIRM_PROPERTY, DOWNLOAD, DOWNLOAD, PURCHASE_NOW, REQUEST_INFO, RESERVE_NOW, REGISTER_NOW, EXPERIENCE, RESERVE_HERE, APPLY_NOW, FOR_MORE_INFO, PURCHASE, CONTACT_US, CONFIRM_NOW, APPLY_HERE, UNKNOWN. The default value is MORE_DETAIL.
CarouselAdCarousels	String	False		Describes the detailed information of carousel ad.In SET operation, all Carousel included in the current Carousels will be replaced with the specified Carousels.Cannot specify a specific Carousel alone.
CarouselAdDisplayUrl	String	False		Display URLHowever, not allowed for ADD and SET when a campaign goal is app promotion. Based on DeviceOsType specified on the campaign, any of the following URLs will be automatically set.For iOS : itunes.apple.com,For Android : play.google.com
CarouselAdLogoMediaId	Int64	False		Logo image ID.
CarouselAdPrincipal	String	False		Advertiser Indication of the ad.However,If adType is CAROUSEL_AD, this field is required in ADD operation. if campaignGoal is APP_PROMOTION, it will automatically be set to the same value as appName of campaign, and it cannot be changed to any other value.
CarouselAdUrl	String	False		Destination URL.For information about the destination URL that can be set with campaigns for app promotion, refer to this page.This field is required in ADD operation, and will be optional in SET operation.If adType is CAROUSEL_AD, this field is required in ADD operation
TextAddisplayUrlLevel	String	False		Display URL.
CarouselAdFinalUrl	String	False		Final URL.
CarouselAdSmartphoneFinalUrl	String	False		Final URL (smartphone).
CarouselAdisRemoveSmartphoneFinalUrl	String	False		Flag for removing an information item. The allowed values are TRUE, FALSE, UNKNOWN..
CarouselAdisRemoveTrackingUrl	String	False		Flag for removing an information item. The allowed values are TRUE, FALSE, UNKNOWN..
GroupName	String	False		Ad group name
Name	String	False		Ad name.
Style	String	False		Displays the ad style type. The allowed values are TEXT, IMAGE, ANIMATION_IMAGE, VIDEO, UNKNOWN.
ApprovalStatus	String	False		Editorial status The allowed values are APPROVED, APPROVED_WITH_REVIEW, REVIEW, PRE_DISAPPROVED, POST_DISAPPROVED, UNKNOWN.
CampaignId	Int64	False	DisplayAdsCampaigns.CampaignId	Campaign ID
CampaignName	String	False		Campaign name
CreatedDate	Date	True		Date of Ad made
DisapprovalReasonCodes	String	False		Reject reason on editorial review
ImpressionBeaconUrls	String	False		Impression beacon URL
IsRemoveBeaconUrls	String	False		Flag for removing an information item The allowed values are TRUE, FALSE, UNKNOWN.
IsRemoveThirdPartyTrackingScriptUrl	String	False		Flag for removing an information item The allowed values are TRUE, FALSE, UNKNOWN.
Labels	String	False		Describes label information to be associated
MediaId	Int64	False	Media.MediaId	Media ID
ThirdPartyTrackingScriptUrl	String	False		Third party tracking script URL
ThirdPartyTrackingVendor	String	False		Third party tracking vendor (Read only).
UserStatus	String	False		Delivery status that can be set by an user The allowed values are ACTIVE, PAUSED, UNKNOWN.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
CampaignGoalFilterType	String	Setting for filtering campaigns (with campaignGoal) or (with no campaignGoal). The allowed values are ALL, NON_GOAL, UNKNOWN. The default value is ALL.
ContainsLabelIdFlg	String	Flag of contains label ID.
LabelId	String	Label ID.
StartDate	Date	start date of the search target period.
EndDate	Date	This is the end date of the search target period.
ReferenceNumber	String	This column will be used in Bulk operations to get specific values from the Temp tables.

DisplayAdsAdGroups

Create, Read, Update or Delete Ad group

Table Specific Information

Select

The Sync App 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 The rest of the filter is executed client side within the Sync App.

AdGroupId supports the '=,IN'.
AccountId supports the '='.
CampaignId supports the '=,IN'.
UserStatus supports the '=,IN'.
CampaignGoalFilterType supports the '='.
ContainsLabelIdFlg supports the '='.
LabelId supports the '=,IN'.
StartDate supports the '='.
EndDate supports the '='.

For example:

SELECT * FROM DisplayAdsAdGroups WHERE AccountId = '1002504155'

SELECT * FROM DisplayAdsAdGroups WHERE AccountId = '1002504155' AND AdGroupId = '437264177'

INSERT

Insert can be executed by specifying the AccountId, AdGroupId, AdType, Name, CampaignId, UserStatus 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 DisplayAdsAdGroups (AdGroupName, AccountId, CampaignId,device,UserStatus,DeviceApp,DeviceOs) values('Testgroup','1002504155','30799754','SMARTPHONE','ACTIVE','APP','ANDROID');

UPDATE

Update can be executed by specifying the AccountId, AdGroupId AND CampaignId,AdId,UserStatus in the WHERE Clause. The columns that are not read-only can be Updated. For example:

UPDATE DisplayAdsAdGroups SET AdGroupName = 'NewTest' WHERE AccountId = '1002504155' AND CampaignId = '30799754' AND AdGroupId = '437264190' AND UserStatus = 'ACTIVE'

DELETE

Delete can be executed by specifying the AccountId, AdGroupId, CampaignId, AdId and UserStatus in the WHERE Clause. For example:

DELETE FROM DisplayAdsAdGroups WHERE AccountId = '1002504155' AND CampaignId = '30799754' AND AdGroupId = '437264190' AND UserStatus = 'ACTIVE'

Columns


Name	Type	ReadOnly	References	Description
AdGroupId [KEY]	Int64	True		Ad group ID.
AdGroupName	String	False		Ad group name.
AccountId	Int64	True	DisplayAdsAccounts.AccountId	Account ID.
CampaignBiddingStrategyType	String	False		Campaign bid strategy type. The allowed values are AUTO, MAX_VCPM, MAX_CPC, MAX_CPV, TARGET_CPA, NONE, UNKNOWN.
CpcBidValue	Int64	False		Ad group MAX_CPC bid value.
CpvBidValue	Int64	False		Ad group MAX_CPV bid value.
VcpmBidValue	Int64	False		Ad group MAX_VCPM bid value.
TargetCpaBidValue	Int64	False		Ad group TARGET_CPA bid value.This can only be specified when campaignBiddingStrategyType is TARGET_CPA.
CampaignId	Int64	False	DisplayAdsCampaigns.CampaignId	Campaign ID.
CampaignName	String	False		Campaign name.
CreatedDate	Date	True		Date of Ad Group made.
Device	String	False		Types of devices to be posted on .Setting NONE is only available for AdGroupService. The allowed values are DESKTOP,WAP_MOBILE,SMARTPHONE,TABLET,NONE,UNKNOWN
DeviceApp	String	False		Application types for devices.Setting NONE is only available for AdGroupService. The allowed values are APP,WEB,NONE,UNKNOWN
DeviceOs	String	False		OS types for devices to be posted on.Setting NONE is only available for AdGroupService. The allowed values are IOS,ANDROID,NONE,UNKNOWN
DeviceOsVersion	String	False		OS version.To cancel the setting, specify NONE.
FeedSetId	Int64	False	FeedSets.FeedSetId	Feed set ID.If feedSetId is not specified in ADD operation, the default set is associated automatically
Labels	String	False		Label information to be associated.
UserStatus	String	False		Ad delivery status that can be set by an user.This field is required in ADD operation The allowed values are ACTIVE, PAUSED, UNKNOWN.
CustomParametersIsRemove	String	False		Delete flag. The allowed values are TRUE, FALSE, UNKNOWN.
CustomParameters	String	False		Displays the element of custom parameters.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
CampaignGoalFilterType	String	Setting for filtering campaigns (with campaignGoal) or (with no campaignGoal). The allowed values are ALL, NON_GOAL, UNKNOWN. The default value is ALL.
ContainsLabelIdFlg	String	Flag of contains label ID.
LabelId	String	Label ID.
StartDate	Date	This is the start date of the search target period.
EndDate	Date	This is the end date of the search target period.
ReferenceNumber	String	This column will be used in Bulk operations to get specific values from the Temp tables.

DisplayAdsAuditLogs

Create or Read the download result information of operation history data file.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
JobId supports the '=,IN'.
JobStatus supports the '=,IN'.

For example:

SELECT * FROM DisplayAdsAuditLogs WHERE AccountId = '1002504155'


SELECT * FROM DisplayAdsAuditLogs WHERE AccountId = '1002504155' AND JobId = '4508692'

INSERT

Insert can be executed by specifying the AccountId 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 DisplayAdsAuditLogs (AccountId) VALUES ('1002504155')

Columns


Name	Type	ReadOnly	References	Description
JobId [KEY]	Int64	True		The operation history job ID.
AccountId	Int64	True	DisplayAdsAccounts.AccountId	Account ID.
JobStartDate	Date	False		The job start date .
JobEndDate	Date	False		The job end date .
JobName	String	False		The operation history job name.
JobUserName	String	False		The user name who executes the operation history job.
CampaignIds	String	False		Campaign ID of the download object.
DateRangeStartDate	Datetime	False		Start date. Entry format : Ymd format Default value : Current date Available range : Current date Enter the date after Start date.e.g.: The oldest date selectable as of April 30 is March 1.
DateRangeEndDate	Datetime	False		End date. Entry format : Ymd format Default value : Current date Available range : Current date Enter the date after Start date.Maximum length of date range between Start and End is 1 month
JobStatus	String	False		Serves process status of download job. The allowed values are IN_PROGRESS, COMPLETED, SYSTEM_ERROR, UNKNOWN.
Lang	String	False		Serves the language of download data. The allowed values are JA, EN, UNKNOWN.
Progress	Int64	False		Displays progress in integers from 1 to 100.
UpdateSource	String	False		Serves update tool type of the download data. The allowed values are CAMPAIGN_MANAGEMENT_TOOL, API, ALL, UNKNOWN.

DisplayAdsBudgets

Read or Update budget information for the account.

Table Specific Information

SELECT

The Sync App 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 Sync App.

AccountId supports the '=,IN'.

For example:

SELECT * FROM DisplayAdsBudgets WHERE AccountId = '1234'

UPDATE

Update can be executed by specifying the AccountId in the WHERE Clause. The columns that are not read-only can be Updated. For example:

UPDATE DisplayAdsBudgets SET AccountType = 'PREPAY' WHERE AccountId = '1234'

Columns


Name	Type	ReadOnly	References	Description
AccountId [KEY]	Int64	True	DisplayAdsAccounts.AccountId	Account ID.
AccountType	String	False		Displays the account charge type The allowed values are PREPAY, INVOICE, UNKNOWN.
Amount	Int64	False		Amount of budget.The monthly budget can be changed only when accountType is INVOICE. In addition, the budget amount must be specified in units of 1000 yen.
LimitChargeType	String	False		The account's budget allotment .Specify MONTHLY to change the monthly budget. The allowed values are SUM, MONTHLY, UNKNOWN.

DisplayAdsCampaigns

Create, Read, Update or Delete information related campaigns.

Table Specific Information

SELECT

The Sync App 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 Sync App.

AccountId supports the '='.
CampaignId supports the '=,IN'.
EndDate supports the '='.
FeedId supports the '=,IN'.
StartDate supports the '='.
UserStatus supports the '=,IN'.
CampaignGoalFilterType supports the '='.
CampaignType supports the '='.
ContainsLabelIdFlg supports the '='.
LabelId supports the '=,IN'.

For example:

SELECT * FROM DisplayAdsCampaigns WHERE AccountId = '1002504155'

SELECT * FROM DisplayAdsCampaigns WHERE AccountId = '1002504155' AND CampaignId = '30799754'

SELECT * FROM DisplayAdsCampaigns WHERE AccountId = '1002504155' AND LabelId = '1000158197'

INSERT

Insert can be executed by specifying the AccountId, BudgetAmount, CampaignGoal, CampaignName, UserStatus, CampaignBiddingStrategyType, AppId, AppName and DeviceOsType 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 DisplayAdsCampaigns (AccountId, AppId, AppName, BudgetAmount, BudgetBudgetDeliveryMethod, CampaignBiddingStrategyType, TargetCpaBidValue, CampaignGoal, CampaignName, ConversionOptimizerType, ManualCampaignConversionOptimizerConversionOptimizerEligibilityFlg, ManualCampaignConversionOptimizerConversionOptimizerTrainingStatus, DeviceOsType, ServingStatus, Type, UserStatus) values ('1002504155','741','TestApp',1500,'STANDARD','TARGET_CPA',250,'APP_PROMOTION','TestCampaign','MANUAL','ENABLE','PROCESSING','IOS','SERVING','STANDARD','ACTIVE')

UPDATE

Update can be executed by specifying the AccountId, CampaignId in the WHERE Clause. The columns that are not read-only can be Updated. For example:

UPDATE DisplayAdsCampaigns SET CampaignName = 'Test', BiddingStrategyType = 'MANUAL_CPC', BudgetAmount = '100' WHERE AccountId = '1002504155'AND CampaignId = '30799754'

DELETE

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

DELETE FROM DisplayAdsCampaigns WHERE AccountId = '1002504155' AND CampaignId = '30799754' AND LabelId = '1000158197'

Columns


Name	Type	ReadOnly	References	Description
CampaignId [KEY]	Int64	True		Campaign ID.
AccountId	Int64	True	DisplayAdsAccounts.AccountId	Account ID
AppId	String	False		APP ID.If campaignGoal is APP_PROMOTION, this field is required in ADD operation.
AppName	String	False		App Name.If campaignGoal is APP_PROMOTION, this field is required in ADD operation.
BudgetAmount	Int64	False		The daily bu.For campaigns with campaign goal, this field is required in ADD operation.
BudgetBudgetDeliveryMethod	String	False		Delivery method of budget.For campaigns with campaign goal, this field is required in ADD operation. The allowed values are STANDARD, ACCELERATED, UNKNOWN.
CampaignBiddingStrategyType	String	False		Setting of campaign bid strategy type The allowed values are AUTO, MAX_VCPM, MAX_CPC, MAX_CPV, TARGET_CPA, NONE, UNKNOWN.
CpcBidValue	Int64	False		Max bid of campaign (CPC).
CpvBidValue	Int64	False		Max bid of campaign (CPV).
VcpmBidValue	Int64	False		Max bid of campaign (vCPM).
TargetCpaBidValue	Int64	False		Target bid of campaign (tCPA).
CampaignDeliveryType	String	False		Campaign delivery type.
CampaignGoal	String	False		Campaign goal.Available values can be referred to authorities field of AccountAuthority object obtained by GET operation of AccountAuthorityService.
CampaignName	String	False		Campaign Name.
ConversionGroupId	Int64	False		CampaignServiceConversionGroup ID.
ConversionTrackerId	Int64	False		CampaignServiceConversionTracker ID.
IsRemoveConversionGroupId	String	False		Delete flag. The allowed values are TRUE, FALSE, UNKNOWN.
IsRemoveConversionTrackerId	String	False		Delete flag. The allowed values are TRUE, FALSE, UNKNOWN.
ManualCampaignConversionOptimizerConversionOptimizerTrainingStatus	String	False		Conversion optimizer training status. The allowed values are PROCESSING, COMPLETED, PAUSED, UNKNOWN.
CreatedDate	Date	True		Date of Campaign made.
DeviceOsType	String	False		OS types for devices to be posted on.If campaignGoal is APP_PROMOTION, this field is required in ADD operation. The allowed values are ANDROID, IOS, UNKNOWN.
StartDate	Date	False		Start date.
EndDate	Date	False		End date.
FeedId	Int64	False		Feed ID.If adType is Dynamic Ads for Display, this field is required in ADD operation
Labels	String	False		Label information to be associated.
ServingStatus	String	False		Delivery status in campaign level. The allowed values are SERVING, ENDED, PENDING, UNKNOWN.
Type	String	False		Type of campaign The allowed values are STANDARD, APP, UNKNOWN.
CustomParametersIsRemove	String	False		Delete flag. The allowed values are TRUE, FALSE, UNKNOWN.
CustomParameters	String	False		Displays the element of custom parameters.
UserStatus	String	False		ad delivery status that can be set by an user The allowed values are ACTIVE, PAUSED, UNKNOWN.
ViewableFrequencyCapFrequencyLevel	String	False		Frequency setting level The allowed values are CAMPAIGN, AD_GROUP, AD, UNKNOWN.
ViewableFrequencyCapFrequencyTimeUnit	String	False		Frequency setting period. The allowed values are DAY, WEEK, MONTH, UNKNOWN.
ViewableFrequencyCapVImps	Int64	False		Maximum number of ad viewable impressions to same user.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
CampaignGoalFilterType	String	Campaigns with campaignGoal or with no campaignGoal The allowed values are ALL, NON_GOAL, GOAL, UNKNOWN. The default value is ALL.
CampaignType	String	Type of campaign The allowed values are STANDARD, APP, UNKNOWN.
ContainsLabelIdFlg	Boolean	Flag of contains label ID
LabelId	Int64	Label ID
ReferenceNumber	String	This column will be used in Bulk operations to get specific values from the Temp tables.

DisplayAdsConversionTrackers

Create, Read or Update ConversionTracker information.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
AppConversionAppConversionPlatform supports the '='.
AppConversionAppId supports the '=,IN'.
Category supports the '=,IN'.
ConversionTrackerId supports the '=,IN'.
ConversionTrackerType supports the '=,IN'.
CountingType supports the '='.
ExcludeFromBidding supports the '='.
Status supports the '=,IN'.
StatsEndDate supports the '='.
StatsStartDate supports the '='.
StatsPeriod supports the '='.

For example:

SELECT * FROM DisplayAdsConversionTrackers WHERE AccountId = '1002504155'

SELECT * FROM DisplayAdsConversionTrackers WHERE AccountId = '1002504155' AND ConversionTrackerId = '1307071'

INSERT

Insert can be executed by specifying the AccountId, ConversionTrackerName, Status, Category, ConversionTrackerType, AppConversionPlatform 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 DisplayAdsConversionTrackers (AccountId, ConversionTrackerName, Status, Category, ConversionTrackerType, AppConversionPlatform) VALUES ('1002504155', 'vtest', 'ENABLED', 'DEFAULT', 'WEB_CONVERSION', 'ANDROID_MARKET')

UPDATE

Update can be executed by specifying the AccountId and ConversionTrackerId in the WHERE Clause. The columns that are not read-only can be Updated. For example:

UPDATE DisplayAdsConversionTrackers SET ConversionTrackerName = 'test' WHERE AccountId = '1002504155' AND ConversionTrackerId = '1307071'

Columns


Name	Type	ReadOnly	References	Description
ConversionTrackerId [KEY]	Int64	True		Conversion Tracker ID.
AccountId	Int64	True	DisplayAdsAccounts.AccountId	Account ID.
AllConversions	Int64	False		Conversions (all).
AllConversionValue	String	False		Conversion value (all).
AppConversionPlatform	String	False		Target platform of the app conversion. The allowed values are ITUNES, ANDROID_MARKET, UNKNOWN.
AppConversionType	String	False		Type of counting conversions for app.FIRST_OPEN' will be counted as one conversion of app install for mobile app campaign, when the app first opened. The allowed values are FIRST_OPEN, UNKNOWN. The default value is FIRST_OPEN.
AppId	String	False		App ID of the object to be tracked.
Category	String	False		Category for ConversionTracker The allowed values are NONE, DEFAULT, PAGE_VIEW, PURCHASE, SIGNUP, LEAD, DOWNLOAD, UNKNOWN.
Conversions	Int64	False		Conversions.
ConversionsViaAdClick	Int64	False		Conversions (via click).
ConversionTrackerName	String	False		Conversion Tracker Name.
ConversionTrackerType	String	False		Conversion type. The allowed values are WEB_CONVERSION, APP_CONVERSION, UNKNOWN.
ConversionValue	String	False		Conv. value/conv.
ConversionValueViaAdClick	String	False		Conv. value (via click).
CountingType	String	False		conversion measurement method The allowed values are ONE_PER_CLICK, MANY_PER_CLICK, UNKNOWN.
CrossDeviceConversions	Int64	False		Cross-device conv.
ExcludeFromBidding	String	False		use or not for auto bidding. The allowed values are FALSE, TRUE, UNKNOWN. The default value is FALSE.
MeasurementPeriod	Int64	False		Counting period (Unit: Day). Can be specified within the range of 7 to 90 days. The default value in ADD operation will be 30. The default value is 30.
MeasurementPeriodView	Int64	False		Counting period (Video view) .Can be specified within the range of 1 to 30. The default value in ADD operation will be 1 The default value is 1.
MostRecentConversionDate	Date	False		The date of the most recent conversion.
Status	String	False		ConversionTracker status The allowed values are ENABLED, DISABLED, UNKNOWN.
UserRevenueValue	Int64	False		Revenue value for Conversions.The default value in ADD operation will be 0. The default value is 0.
ViewThroughConversions	Int64	False		View through conversions
WebConversionSnippet	String	False		Type of tracking script

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
StatsEndDate	Date	Acquisition end date of stats information.
StatsStartDate	Date	Acquisition start date of stats information.
StatsPeriod	String	summarized period of statistics The allowed values are DEFINITE_VALUE_YESTERDAY, DEFINITE_VALUE_LASTBSDAY, DEFINITE_VALUE_LASTWEEK, DEFINITE_VALUE_WEEK, DEFINITE_VALUE_TWOWEEK, DEFINITE_VALUE_THIRTYDAY, DEFINITE_VALUE_LASTMONTH, REALTIME_TODAY, REALTIME_MONTH, DEFINITE_VALUE_LAST13MONTH, CUSTOM_DATE, UNKNOWN.
ReferenceNumber	String	This column will be used in Bulk operations to get specific values from the Temp tables.

DisplayAdsFeeds

Create, Read, Update or delete Feed information

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
FeedId supports the '=,IN'.

For example, the following queries are processed server side:

SELECT * FROM DisplayAdsFeeds WHERE AccountId = '1002504155'

SELECT * FROM DisplayAdsFeeds WHERE AccountId = '1002504155' AND FeedId = '1002504'

Insert

Insert can be executed by specifying the AccountId and FeedName 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 DisplayAdsFeeds (AccountId,FeedName) VALUES ('1002504155','Testfeed')

Update

Update can be executed by specifying the AccountId and FeedId in the WHERE Clause. The columns that are not read-only can be Updated. For example:

UPDATE DisplayAdsFeeds SET FeedName = 'Testfeed' WHERE AccountId = '1002504155' AND FeedId = '1002504155'

Delete

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

DELETE FROM DisplayAdsFeeds WHERE AccountId = '1002504155' AND FeedId = '1002504155'

Columns


Name	Type	ReadOnly	References	Description
FeedId [KEY]	Int64	True		ID for identifying Feed.
AccountId	Int64	True	DisplayAdsAccounts.AccountId	Account ID.
ApprovedItemCount	Int64	False		Number of approved items
DisApprovedItemCount	Int64	False		Number of disapproved items.
FeedName	String	False		Name for identifying Feed
ItemCount	Int64	False		Number of items.
UploadLimitSourceTypes	String	True		Source Type. The allowed values are FTP_SCHEDULE, FTP_DIRECT, API, FTP_AND_API, CAMPAIGN_MANAGEMENT_TOOL, UNKNOWN.
UploadLimitControlType	String	True		Control type The allowed values are UPLOAD_COUNT_LIMIT, FILE_ROWS_LIMIT, FILE_SIZE_LIMIT_COMPRESS, FILE_SIZE_LIMIT_UNCOMPRESS, UNKNOWN.
UploadLimitValue	Int64	True		Number of limit.

DisplayAdsLabels

Create, Read, Update or Delete information of label.

Table Specific Information

SELECT

The Sync App 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 Sync App.Note: AccountId is required for select on this table.

AccountId supports the '='.
LabelId supports the '=,IN'.

For example:

SELECT * from DisplayAdsLabels WHERE AccountId = '1234'

SELECT * from DisplayAdsLabels WHERE AccountId = '1234' AND LabelId = '266841'

INSERT

Insert can be executed by specifying the AccountId and LabelName 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 DisplayAdsLabels(AccountId,LabelName) VALUES ('1234','New label')

UPDATE

Update can be executed by specifying the AccountId and LabelId in the WHERE Clause. The columns that are not read-only can be Updated. For example:

UPDATE DisplayAdsLabels SET Color='#FFFFFF' WHERE AccountId = '1002504155' AND LabelId = '266841'

DELETE

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

DELETE DisplayAdsLabels WHERE AccountId = '1234' AND LabelId = '266841'

Columns


Name	Type	ReadOnly	References	Description
LabelId [KEY]	Int64	True		Label ID.
AccountId	Int64	True	DisplayAdsAccounts.AccountId	Account ID.
Color	String	False		Color.
Description	String	False		Description.
LabelName	String	False		Label Name.

DisplayAdsReports

Create, Read or Delete a Report.

Table Specific Information

SELECT

The Sync App 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 Sync App.

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. The allowed values are 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. The allowed values are NONE, ZIP, UNKNOWN.
ReportDateRangeType	String	False		Displays a date range of the report. The allowed values are 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. The allowed values are UTF8, SJIS, EUC, UTF16LE, UNKNOWN.
ReportDownloadFormat	String	False		Displays a file format of the report. The allowed values are CSV, XML, TSV, UNKNOWN.
ReportIncludeDeleted	String	False		Describes whether to output deleted items on the report or not. The allowed values are TRUE, FALSE, UNKNOWN.
ReportJobErrorDetail	String	False		Error details of Report Job.
ReportLanguage	String	False		A language selection for report definition. The allowed values are JA, EN, UNKNOWN.
ReportName	String	False		Name of the report.
ReportDecimalPartDisplayType	String	False		Describes the display type of the decimal item. The allowed values are FULL_DISPLAY, SIMPLE_DISPLAY, UNKNOWN. The default value is SIMPLE_DISPLAY.
ReportSkipColumnHeader	String	False		A flag that indicates whether to skip the display of the header line. The allowed values are TRUE, FALSE, UNKNOWN. The default value is FALSE.
ReportSkipReportSummary	String	False		A flag that indicates whether to skip the display of the total line. The allowed values are TRUE, FALSE, UNKNOWN. The default value is 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. The allowed values are 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. The allowed values are TRUE, FALSE, UNKNOWN.
ConversionPathReportConditionConversionPathAccountSettingsBaseAccountAaccountId	Int64	False		Account ID.
ConversionPathReportConditionConversionPathAccountSettingsBaseAccountAproductType	String	False		Describes product type of the account. The allowed values are 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. The allowed values are 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. The allowed values are 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. The allowed values are 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.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
ReferenceNumber	String	This column will be used in Bulk operations to get specific values from the Temp tables.

FeedFtp

Create, Read or Update FTP setting information.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
FeedId supports the '=,IN'.

For example, the following queries are processed server side:

SELECT * from FeedFtp WHERE AccountId = '123436'

Insert

Insert can be executed by specifying the AccountId, FeedId, FeedUrl, ScheduleScheduleDailyTime, ScheduleScheduleHourlyInterval, ScheduleScheduleType, ScheduleScheduleWeeklyScheduleWeek, ScheduleScheduleWeeklyTime, UserName and UserPassword columns. The columns that are not read-only can be inserted optionally.

INSERT INTO FeedFtp (AccountId,UserName,UserPassword,FeedId,FeedUrl,ItemListUploadType,ScheduleDailyTime,ScheduleHourlyInterval,ScheduleType,ScheduleWeeklyScheduleWeek,ScheduleWeeklyTime) VALUES ('123436','1002504155','Admin','Admin',1132453,'www.feedftp.com','UPDATE_ALL',500,10,'DAILY','SUN','10')

Update

Update can be executed by specifying the AccountId and FeedId in the WHERE Clause. The columns that are not read-only can be Updated. For example:

UPDATE FeedFtp SET UserName = 'Admin@123', UserPassword = 'password' WHERE AccountId = '1002504155' AND FeedId = '1132453'

Columns


Name	Type	ReadOnly	References	Description
FeedId [KEY]	Int64	True	DisplayAdsFeeds.FeedId	Feed ID.
AccountId	Int64	True	DisplayAdsAccounts.AccountId	Account ID.
ActiveStatus	String	False		Displays status of FTP schedule.The default value in ADD operation will be ACTIVE. The allowed values are INACTIVE, ACTIVE, UNKNOWN. The default value is ACTIVE.
FeedUrl	String	False		URL of item list file.
ItemListUploadType	String	False		Displays the upload type of Item List file. The allowed values are UPDATE_PART, UPDATE_ALL, UNKNOWN.
ScheduleDailyTime	Int64	False		Execution time.
ScheduleHourlyInterval	Int64	False		Interval of the execution time.
ScheduleType	String	False		Displays the schedule type of Periodic Upload. The allowed values are HOURLY, DAILY, WEEKLY, UNKNOWN.
ScheduleWeeklyScheduleWeek	String	False		Serves the days of the week. The allowed values are SUN, MON, TUE, WED, THU, FRI, SAT, UNKNOWN.
ScheduleWeeklyTime	Int64	False		Execution time.
UserName	String	False		User name.
UserPassword	String	False		Password.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
ReferenceNumber	String	This column will be used in Bulk operations to get specific values from the Temp tables.

FeedSets

Create, Read or delete Item Set information.

Table Specific Information

Select

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

AccountId supports the '='.
FeedId supports the '='.
FeedSetId supports the '=,IN'.
IncludeItemCount supports the '='.

For example:

SELECT * FROM FeedSets WHERE AccountId = '1002504155' AND FeedId = '1132453'

INSERT

Insert can be executed by specifying the AccountId, FeedId, ConditionSets and FeedSetName 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 FeedSetConditionSetsOrCondition#TEMP (CompareOperator,Value) VALUES ('EQUAL','10000')
INSERT INTO FeedSetConditionSets#TEMP (ConditionType,OrConditions) VALUES ('PRICE','FeedSetConditionSetsOrCondition#TEMP')
INSERT INTO FeedSets (AccountId,FeedId,ConditionSets,FeedSetName) VALUES ('1002504155','1132453','FeedSetConditionSets#TEMP','TestFeedSet')

DELETE

Delete can be executed by specifying the AccountId, FeedId and FeedSetId in the WHERE Clause. The columns that are not read-only can be Updated. For example:

DELETE FROM FeedSets WHERE AccountId = '1234' AND FeedSetId = '3573618' AND FeedId = '25644'

Columns


Name	Type	ReadOnly	References	Description
FeedSetId [KEY]	Int64	True		Item Set ID.
AccountId	Int64	True	DisplayAdsAccounts.AccountId	Account ID.
FeedId	Int64	False	DisplayAdsFeeds.FeedId	Feed ID.
ConditionSets	String	False		Conditions of Item Set information.
FeedSetName	String	False		Item Set name.
IsDefaultSet	Boolean	False		Default setting of Item Set or not.
ItemCount	Int64	False		Number of items included in Item Set conditions.
IncludeItemCount	Boolean	False		number of items of Item Set.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
ReferenceNumber	String	This column will be used in Bulk operations to get specific values from the Temp tables.

GuaranteedAdGroupAds

Create, Read, Update guaranteed ad and use AdGroupAd/remove to delete the guaranteed ad.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
AdGroupId supports the '=,IN'.
AdId supports the '=,IN'.
CampaignId supports the '=,IN'.
ContainsLabelIdFlg supports the '='.
LabelId supports the '=,IN'.
MediaId supports the '=,IN'.

For example:

SELECT * FROM GuaranteedAdGroupAds WHERE AccountId = '123436'

Insert

Insert can be executed by specifying the AccountId, AdType, AdGroupId, AdName, CampaignId and UserStatus 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 GuaranteedAdGroupLabels#TEMP (Color, Description, LabelId, LabelName) VALUES ('#0000FF', 'Testing GuaranteedAdGroupAdLabels', '1000158197', 'TestGuaranteedAdGroupAdLabel')

INSERT INTO GuaranteedAdGroupAds (AccountId, AdType, BannerImageAdUrl, Labels, AdGroupId, AdName, CampaignId, UserStatus) VALUES ('1002504155', 'BANNER_IMAGE_AD', 'https://www.cdata.com', 'GuaranteedAdGroupLabels#TEMP', '303302921', 'TestAdGroupAd', '437154455', 'ACTIVE')

Update

Update can be executed by specifying the AccountId and AdId in the WHERE Clause. The columns that are not read-only can be Updated. For example:

INSERT INTO GuaranteedAdGroupAdLabels#TEMP (Color, Description, LabelName) VALUES ('#0000FF', 'Updating GuaranteedAdGroupAdLabels', 'TestGuaranteedAdGroupLabel')
UPDATE GuaranteedAdGroupAds SET AdType='BANNER_IMAGE_AD', BannerImageAdDisplayUrl='www.bannerimageaddisplayurl.com', BannerImageAdUrl='www.bannerimageadurl.com', Labels='GuaranteedAdGroupAdLabels#TEMP', AdGroupId=12353463, AdName=UpdateGuaranteedAdGroupAd, CampaignId='8232533', UserStatus='ACTIVE' WHERE AccountId='123436' AND AdId='2737353'

Columns


Name	Type	ReadOnly	References	Description
AccountId	Int64	True	DisplayAdsAccounts.AccountId	Account ID.
AdGroupId	Int64	True	GuaranteedAdGroups.AdGroupId	Ad group ID
AdGroupName	String	False		Ad group name
AdType	String	False		Type of ad. The allowed values are BANNER_VIDEO_AD, BANNER_IMAGE_AD, BRANDPANEL_QUINTIE, BRANDPANEL_QUINTIE_VIDEO, BRANDPANEL_PANORAMA, BRANDPANEL_PANORAMA_VIDEO, TOP_IMPACT_SQUARE, TOP_IMPACT_SQUARE_VIDEO, TOP_IMPACT_QUINTIE, TOP_IMPACT_QUINTIE_VIDEO, TOP_IMPACT_PANORAMA, TOP_IMPACT_PANORAMA_VIDEO, TOP_IMPACT_PANORAMA_SIDE_VISION_VIDEO, TOP_IMPACT_PANORAMA_SIDE_SWITCH_VIDEO, TOP_IMPACT_THEATER_VIDEO, TOP_IMPACT_SQUARE_SPECIAL, TOP_IMPACT_SQUARE_SPECIAL_VIDEO, TOP_IMPACT_PRIME_DISPLAY_DOUBLE, TOP_IMPACT_PRIME_DISPLAY_DOUBLE_VIDEO, INSTREAM_VIDEO_AD, CAROUSEL_AD, UNKNOWN.
BannerImageAdDisplayUrl	String	False		Display URL. If AdType is BANNER_IMAGE_AD, this field is required in ADD operation.
BannerImageAdUrl	String	False		Destination URL. If AdType is BANNER_IMAGE_AD, this field is required in ADD operation.
BannerImageAdCustomParametersIsRemove	String	False		Delete flag. The allowed values are TRUE, FALSE, UNKNOWN.
BannerImageAdCustomParameters	String	False		Displays the element of custom parameters.
BannerImageAdDisplayUrlLevel	String	False		Display URL.
BannerImageAdFinalUrl	String	False		Final URL.
BannerImageAdSmartphoneFinalUrl	String	False		Final URL (smartphone).
BannerImageAdisRemoveSmartphoneFinalUrl	String	False		Flag for removing an information item. The allowed values are TRUE, FALSE, UNKNOWN..
BannerImageAdisRemoveTrackingUrl	String	False		Flag for removing an information item. The allowed values are TRUE, FALSE, UNKNOWN..
BannerImageAdtrackingUrl	String	False		Destination URL.
BannerVideoAdDisplayUrl	String	False		Display URL.
BannerVideoAdAddisplayUrlLevel	String	False		Display URL.
BannerVideoAdAdFinalUrl	String	False		Final URL.
BannerVideoAdAdSmartphoneFinalUrl	String	False		Final URL (smartphone).
BannerVideoAdAdisRemoveSmartphoneFinalUrl	String	False		Flag for removing an information item. The allowed values are TRUE, FALSE, UNKNOWN..
BannerVideoAdAdisRemoveTrackingUrl	String	False		Flag for removing an information item. The allowed values are TRUE, FALSE, UNKNOWN..
BannerVideoAdCustomParametersIsRemove	String	False		Delete flag. The allowed values are TRUE, FALSE, UNKNOWN.
BannerVideoAdCustomParameters	String	False		Displays the element of custom parameters.
BannerVideoAdIsRemoveVideo10SecBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
BannerVideoAdIsRemoveVideo25PercentBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
BannerVideoAdIsRemoveVideo3SecBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
BannerVideoAdIsRemoveVideo50PercentBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
BannerVideoAdIsRemoveVideo75PercentBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
BannerVideoAdIsRemoveVideoCompleteBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
BannerVideoAdIsRemoveVideoStartBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
BannerVideoAdThumbnailMediaId	Int64	False		Thumbnail ID. If AdType is BANNER_VIDEO_AD, this field is required in ADD operation.
BannerVideoAdUrl	String	False		Destination URL. If AdType is BANNER_VIDEO_AD, this field is required in ADD operation.
BannerVideoAdVideo10SecBeaconUrls	String	False		Viewing beacon URL (10 seconds).Available URL is only (https).
BannerVideoAdVideo25PercentBeaconUrls	String	False		Playback viewing beacon URL (25%).Available URL is only (https).
BannerVideoAdVideo3SecBeaconUrls	String	False		Beacon URL (3 seconds).Available URL is only (https).
BannerVideoAdVideo50PercentBeaconUrls	String	False		Playback viewing beacon URL (50%).Available URL is only (https).
BannerVideoAdVideo75PercentBeaconUrls	String	False		Playback viewing beacon URL (75%).Available URL is only (https).
BannerVideoAdVideoCompleteBeaconUrls	String	False		Viewing Beacon URL (complete).Available URL is only (https).
BannerVideoAdVideoStartBeaconUrls	String	False		Viewing Beacon URL (start).Available URL is only (https).
BrandPanelPanoramaAdShrinkMainMediaId	Int64	False		Reduced main image. If AdType is BRANDPANEL_PANORAMA, this field is required in ADD operation.
BrandPanelAddisplayUrlLevel	String	False		Display URL.
BrandPanelFinalUrl	String	False		Final URL.
BrandPanelSmartphoneFinalUrl	String	False		Final URL (smartphone).
BrandPanelisRemoveSmartphoneFinalUrl	String	False		Flag for removing an information item. The allowed values are TRUE, FALSE, UNKNOWN..
BrandPanelisRemoveTrackingUrl	String	False		Flag for removing an information item. The allowed values are TRUE, FALSE, UNKNOWN..
BrandPanelCustomParametersIsRemove	String	False		Delete flag. The allowed values are TRUE, FALSE, UNKNOWN.
BrandPanelCustomParameters	String	False		Displays the element of custom parameters.
BrandPanelPanoramaUrl	String	False		Destination URL. If AdType is BRANDPANEL_PANORAMA, this field is required in ADD operation.
BrandPanelPanoramaVideoAdShrinkMainMediaId	Int64	False		Reduced main image. If AdType is BRANDPANEL_PANORAMA, this field is required in ADD operation.
BrandPanelPanoramaVideoDisplayUrl	String	False		Display URL. If AdType is BRANDPANEL_PANORAMA, this field is required in ADD operation.
BrandPanelPanoramaVideoIsRemoveVideo10SecBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
BrandPanelPanoramaVideoIsRemoveVideo25PercentBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
BrandPanelPanoramaVideoIsRemoveVideo3SecBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
BrandPanelPanoramaVideoIsRemoveVideo50PercentBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
BrandPanelPanoramaVideoIsRemoveVideo75PercentBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
BrandPanelPanoramaVideoIsRemoveVideoCompleteBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
BrandPanelPanoramaVideoIsRemoveVideoStartBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
BrandPanelPanoramaVideoThumbnailMediaId	Int64	False		Thumbnail ID. If AdType is BRANDPANEL_PANORAMA_VIDEO, this field is required in ADD operation.
BrandPanelPanoramaVideoUrl	String	False		Destination URL. If AdType is BRANDPANEL_PANORAMA_VIDEO, this field is required in ADD operation.
BrandPanelPanoramaVideoVideo10SecBeaconUrls	String	False		Viewing beacon URL (10 seconds).Available URL is only https.
BrandPanelPanoramaVideoVideo25PercentBeaconUrls	String	False		Playback viewing beacon URL (25%).Available URL is only https.
BrandPanelPanoramaVideoVideo3SecBeaconUrls	String	False		Beacon URL (3 seconds).Available URL is only https.
BrandPanelPanoramaVideoVideo50PercentBeaconUrls	String	False		Playback viewing beacon URL (50%).Available URL is only https.
BrandPanelPanoramaVideoVideo75PercentBeaconUrls	String	False		Playback viewing beacon URL (75%).Available URL is only https.
BrandPanelPanoramaVideoVideoCompleteBeaconUrls	String	False		Viewing Beacon URL (complete).Available URL is only https.
BrandPanelPanoramaVideoVideoStartBeaconUrls	String	False		Viewing Beacon URL (start).Available URL is only https.
BrandPanelQuintieDisplayUrl	String	False		Display URL. If AdType is BRANDPANEL_QUINTIE, this field is required in ADD operation.
BrandPanelQuintieUrl	String	False		Destination URL. If AdType is BRANDPANEL_QUINTIE, this field is required in ADD operation.
BrandPanelQuintieDisplayUrlLevel	String	False		Display URL.
BrandPanelQuintieAdFinalUrl	String	False		Final URL.
BrandPanelQuintieAdSmartphoneFinalUrl	String	False		Final URL (smartphone).
BrandPanelQuintieisRemoveSmartphoneFinalUrl	String	False		Flag for removing an information item. The allowed values are TRUE, FALSE, UNKNOWN..
BrandPanelQuintieisRemoveTrackingUrl	String	False		Flag for removing an information item. The allowed values are TRUE, FALSE, UNKNOWN..
BrandPanelQuintieCustomParametersIsRemove	String	False		Delete flag. The allowed values are TRUE, FALSE, UNKNOWN.
BrandPanelQuintieCustomParameters	String	False		Displays the element of custom parameters.
BrandPanelQuintiePanoramaUrl	String	False		Destination URL. If AdType is BRANDPANEL_PANORAMA, this field is required in ADD operation.
BrandPanelQuintieVideoDisplayUrl	String	False		Display URL. If AdType is BRANDPANEL_QUINTIE, this field is required in ADD operation.
BrandPanelQuintieVideoIsRemoveVideo10SecBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
BrandPanelQuintieVideoIsRemoveVideo25PercentBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
BrandPanelQuintieVideoIsRemoveVideo3SecBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
BrandPanelQuintieVideoIsRemoveVideo50PercentBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
BrandPanelQuintieVideoIsRemoveVideo75PercentBeaconUrls	String	False		Flag for removing an information itemIf the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
BrandPanelQuintieVideoIsRemoveVideoCompleteBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
BrandPanelQuintieVideoIsRemoveVideoStartBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
BrandPanelQuintieVideoThumbnailMediaId	Int64	False		Thumbnail ID. If AdType is BRANDPANEL_QUINTIE_VIDEO, this field is required in ADD operation.
BrandPanelQuintieVideoUrl	String	False		Destination URL If AdType is BRANDPANEL_QUINTIE_VIDEO, this field is required in ADD operation.
BrandPanelQuintieVideoVideo10SecBeaconUrls	String	False		Viewing beacon URL (10 seconds).Available URL is only https.
BrandPanelQuintieVideoVideo25PercentBeaconUrls	String	False		Playback viewing beacon URL (25%).Available URL is only https.
BrandPanelQuintieVideoVideo3SecBeaconUrls	String	False		Beacon URL (3 seconds).
BrandPanelQuintieVideoVideo50PercentBeaconUrls	String	False		Playback viewing beacon URL (50%).Available URL is only https.
BrandPanelQuintieVideoVideo75PercentBeaconUrls	String	False		Playback viewing beacon URL (75%).Available URL is only https.
BrandPanelQuintieVideoVideoCompleteBeaconUrls	String	False		Viewing Beacon URL (complete).Available URL is only https.
BrandPanelQuintieVideoVideoStartBeaconUrls	String	False		Viewing Beacon URL (start).Available URL is only https.
InstreamVideoDisplayUrl	String	False		Display URL. If AdType is INSTREAM_VIDEO_AD, this field is required in ADD operation.
InstreamVideoDisplayUrlLevel	String	False		Display URL.
InstreamVideoAdFinalUrl	String	False		Final URL.
InstreamVideoAdSmartphoneFinalUrl	String	False		Final URL (smartphone).
InstreamVideoisRemoveSmartphoneFinalUrl	String	False		Flag for removing an information item. The allowed values are TRUE, FALSE, UNKNOWN..
InstreamVideoisRemoveTrackingUrl	String	False		Flag for removing an information item. The allowed values are TRUE, FALSE, UNKNOWN..
InstreamVideoCustomParametersIsRemove	String	False		Delete flag. The allowed values are TRUE, FALSE, UNKNOWN.
InstreamVideoCustomParameters	String	False		Displays the element of custom parameters.
InstreamVideoHeadline	String	False		Headline.
InstreamVideoIsRemoveVideo25PercentBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
InstreamVideoIsRemoveVideo50PercentBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
InstreamVideoIsRemoveVideo75PercentBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
InstreamVideoIsRemoveVideoCompleteBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
InstreamVideoIsRemoveVideoStartBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
InstreamVideoUrl	String	False		Destination URL. If AdType is INSTREAM_VIDEO_AD, this field is required in ADD operation.
InstreamVideoVideo25PercentBeaconUrls	String	False		Playback viewing beacon URL (25%)
InstreamVideoVideo50PercentBeaconUrls	String	False		Playback viewing beacon URL (50%)
InstreamVideoVideo75PercentBeaconUrls	String	False		Playback viewing beacon URL (75%)
InstreamVideoVideoCompleteBeaconUrls	String	False		Viewing Beacon URL (complete)
InstreamVideoVideoStartBeaconUrls	String	False		Viewing Beacon URL (start)
TopImpactPanoramaAdLeftSideMediaId	Int64	False		Left side image. If AdType is TOP_IMPACT_PANORAMA, this field is required in ADD operation.
TopImpactPanoramaAdRightSideMediaId	Int64	False		Right side image. If AdType is TOP_IMPACT_PANORAMA, this field is required in ADD operation.
TopImpactPanoramaAdShrinkMainMediaId	Int64	False		Reduced main image. If AdType is TOP_IMPACT_PANORAMA, this field is required in ADD operation.
TopImpactPanoramaDisplayUrl	String	False		Display URL. If AdType is TOP_IMPACT_PANORAMA, this field is required in ADD operation.
TopImpactPanoramaAddisplayUrlLevel	String	False		Display URL.
TopImpactPanoramaFinalUrl	String	False		Final URL.
TopImpactPanoramaSmartphoneFinalUrl	String	False		Final URL (smartphone).
TopImpactPanoramaisRemoveSmartphoneFinalUrl	String	False		Flag for removing an information item. The allowed values are TRUE, FALSE, UNKNOWN..
TopImpactPanoramaisRemoveTrackingUrl	String	False		Flag for removing an information item. The allowed values are TRUE, FALSE, UNKNOWN..
TopImpactPanoramaCustomParametersIsRemove	String	False		Delete flag. The allowed values are TRUE, FALSE, UNKNOWN.
TopImpactPanoramaCustomParameters	String	False		Displays the element of custom parameters.
TopImpactPanoramaUrl	String	False		Destination URL. If AdType is TOP_IMPACT_PANORAMA, this field is required in ADD operation.
TopImpactPanoramaSideSwitchVideoAdLeftSideMediaId	Int64	False		Left side image. If AdType is TOP_IMPACT_PANORAMA_SIDE_SWITCH_VIDEO, this field is required in ADD operation.
TopImpactPanoramaSideSwitchVideoAdLeftSideMediaId2	Int64	False		Left side image. If AdType is TOP_IMPACT_PANORAMA_SIDE_SWITCH_VIDEO, this field is required in ADD operation.
TopImpactPanoramaSideSwitchVideoAdRightSideMediaId	Int64	False		Right side image. If AdType is TOP_IMPACT_PANORAMA_SIDE_SWITCH_VIDEO, this field is required in ADD operation.
TopImpactPanoramaSideSwitchVideoAdRightSideMediaId2	Int64	False		Right side image. If AdType is TOP_IMPACT_PANORAMA_SIDE_SWITCH_VIDEO, this field is required in ADD operation.
TopImpactPanoramaSideSwitchVideoAdShrinkMainMediaId	Int64	False		Reduced main image. If AdType is TOP_IMPACT_PANORAMA_SIDE_SWITCH_VIDEO, this field is required in ADD operation.
TopImpactPanoramaSideSwitchVideoDisplayUrl	String	False		Display URL. If AdType is TOP_IMPACT_PANORAMA_SIDE_SWITCH_VIDEO, this field is required in ADD operation.
TopImpactPanoramaSideSwitchVideoIsRemoveVideo10SecBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
TopImpactPanoramaSideSwitchVideoIsRemoveVideo25PercentBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
TopImpactPanoramaSideSwitchVideoIsRemoveVideo3SecBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
TopImpactPanoramaSideSwitchVideoIsRemoveVideo50PercentBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
TopImpactPanoramaSideSwitchVideoIsRemoveVideo75PercentBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
TopImpactPanoramaSideSwitchVideoIsRemoveVideoCompleteBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
TopImpactPanoramaSideSwitchVideoIsRemoveVideoStartBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
TopImpactPanoramaSideSwitchVideoThumbnailMediaId	Int64	False		Thumbnail ID. If AdType is TOP_IMPACT_PANORAMA_SIDE_SWITCH_VIDEO, this field is required in ADD operation.
TopImpactPanoramaSideSwitchVideoUrl	String	False		Destination URL. If AdType is TOP_IMPACT_PANORAMA_SIDE_SWITCH_VIDEO, this field is required in ADD operation.
TopImpactPanoramaSideSwitchVideoAddisplayUrlLevel	String	False		Display URL.
TopImpactPanoramaSideSwitchVideoFinalUrl	String	False		Final URL.
TopImpactPanoramaSideSwitchVideoSmartphoneFinalUrl	String	False		Final URL (smartphone).
TopImpactPanoramaSideSwitchVideoisRemoveSmartphoneFinalUrl	String	False		Flag for removing an information item. The allowed values are TRUE, FALSE, UNKNOWN..
TopImpactPanoramaSideSwitchVideoisRemoveTrackingUrl	String	False		Flag for removing an information item. The allowed values are TRUE, FALSE, UNKNOWN..
TopImpactPanoramaSideSwitchVideoCustomParametersIsRemove	String	False		Delete flag. The allowed values are TRUE, FALSE, UNKNOWN.
TopImpactPanoramaSideSwitchVideoCustomParameters	String	False		Displays the element of custom parameters.
TopImpactPanoramaSideSwitchVideoVideo10SecBeaconUrls	String	False		Viewing beacon URL (10 seconds).
TopImpactPanoramaSideSwitchVideoVideo25PercentBeaconUrls	String	False		Playback viewing beacon URL (25%).
TopImpactPanoramaSideSwitchVideoVideo3SecBeaconUrls	String	False		Beacon URL (3 seconds).
TopImpactPanoramaSideSwitchVideoVideo50PercentBeaconUrls	String	False		Playback viewing beacon URL (50%)
TopImpactPanoramaSideSwitchVideoVideo75PercentBeaconUrls	String	False		Playback viewing beacon URL (75%)
TopImpactPanoramaSideSwitchVideoVideoCompleteBeaconUrls	String	False		Viewing Beacon URL (complete)
TopImpactPanoramaSideSwitchVideoVideoStartBeaconUrls	String	False		Viewing Beacon URL (start)
TopImpactPanoramaSideVisionVideoAdShrinkMainMediaId	Int64	False		Reduced main image. If AdType is TOP_IMPACT_PANORAMA_SIDE_VISION_VIDEO, this field is required in ADD operation.
TopImpactPanoramaSideVisionVideoDisplayUrl	String	False		Display URL. If AdType is TOP_IMPACT_PANORAMA_SIDE_VISION_VIDEO, this field is required in ADD operation.
TopImpactPanoramaSideVisionVideoAddisplayUrlLevel	String	False		Display URL.
TopImpactPanoramaSideVisionVideoFinalUrl	String	False		Final URL.
TopImpactPanoramaSideVisionVideoSmartphoneFinalUrl	String	False		Final URL (smartphone).
TopImpactPanoramaSideVisionVideoisRemoveSmartphoneFinalUrl	String	False		Flag for removing an information item. The allowed values are TRUE, FALSE, UNKNOWN..
TopImpactPanoramaSideVisionVideoisRemoveTrackingUrl	String	False		Flag for removing an information item. The allowed values are TRUE, FALSE, UNKNOWN..
TopImpactPanoramaSideVisionVideoCustomParametersIsRemove	String	False		Delete flag. The allowed values are TRUE, FALSE, UNKNOWN.
TopImpactPanoramaSideVisionVideoCustomParameters	String	False		Displays the element of custom parameters.
TopImpactPanoramaSideVisionVideoIsRemoveVideo10SecBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
TopImpactPanoramaSideVisionVideoIsRemoveVideo25PercentBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
TopImpactPanoramaSideVisionVideoIsRemoveVideo3SecBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
TopImpactPanoramaSideVisionVideoIsRemoveVideo50PercentBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
TopImpactPanoramaSideVisionVideoIsRemoveVideo75PercentBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
TopImpactPanoramaSideVisionVideoIsRemoveVideoCompleteBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
TopImpactPanoramaSideVisionVideoIsRemoveVideoStartBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
TopImpactPanoramaSideVisionVideoThumbnailMediaId	Int64	False		Thumbnail ID. If AdType is TOP_IMPACT_PANORAMA_SIDE_VISION_VIDEO, this field is required in ADD operation.
TopImpactPanoramaSideVisionVideoUrl	String	False		Destination URL. If AdType is TOP_IMPACT_PANORAMA_SIDE_VISION_VIDEO, this field is required in ADD operation.
TopImpactPanoramaSideVisionVideoVideo10SecBeaconUrls	String	False		Viewing beacon URL (10 seconds).
TopImpactPanoramaSideVisionVideoVideo25PercentBeaconUrls	String	False		Playback viewing beacon URL (25%).
TopImpactPanoramaSideVisionVideoVideo3SecBeaconUrls	String	False		Beacon URL (3 seconds).
TopImpactPanoramaSideVisionVideoVideo50PercentBeaconUrls	String	False		Playback viewing beacon URL (50%)
TopImpactPanoramaSideVisionVideoVideo75PercentBeaconUrls	String	False		Playback viewing beacon URL (75%)
TopImpactPanoramaSideVisionVideoVideoCompleteBeaconUrls	String	False		Viewing Beacon URL (complete)
TopImpactPanoramaSideVisionVideoVideoStartBeaconUrls	String	False		Viewing Beacon URL (start)
TopImpactPanoramaVideoAdLeftSideMediaId	Int64	False		Left side image. If AdType is TOP_IMPACT_PANORAMA_VIDEO, this field is required in ADD operation.
TopImpactPanoramaVideoAdRightSideMediaId	Int64	False		Right side image. If AdType is TOP_IMPACT_PANORAMA_VIDEO, this field is required in ADD operation.
TopImpactPanoramaVideoAdShrinkMainMediaId	Int64	False		Reduced main image. If AdType is TOP_IMPACT_PANORAMA_VIDEO, this field is required in ADD operation.
TopImpactPanoramaVideoDisplayUrl	String	False		Display URL. If AdType is TOP_IMPACT_PANORAMA_VIDEO, this field is required in ADD operation.
TopImpactPanoramaVideoAddisplayUrlLevel	String	False		Display URL.
TopImpactPanoramaVideoFinalUrl	String	False		Final URL.
TopImpactPanoramaVideoSmartphoneFinalUrl	String	False		Final URL (smartphone).
TopImpactPanoramaVideoisRemoveSmartphoneFinalUrl	String	False		Flag for removing an information item. The allowed values are TRUE, FALSE, UNKNOWN..
TopImpactPanoramaVideoisRemoveTrackingUrl	String	False		Flag for removing an information item. The allowed values are TRUE, FALSE, UNKNOWN..
TopImpactPanoramaVideoCustomParametersIsRemove	String	False		Delete flag. The allowed values are TRUE, FALSE, UNKNOWN.
TopImpactPanoramaVideoCustomParameters	String	False		Displays the element of custom parameters.
TopImpactPanoramaVideoIsRemoveVideo10SecBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
TopImpactPanoramaVideoIsRemoveVideo25PercentBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
TopImpactPanoramaVideoIsRemoveVideo3SecBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
TopImpactPanoramaVideoIsRemoveVideo50PercentBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
TopImpactPanoramaVideoIsRemoveVideo75PercentBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
TopImpactPanoramaVideoIsRemoveVideoCompleteBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
TopImpactPanoramaVideoIsRemoveVideoStartBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
TopImpactPanoramaVideoThumbnailMediaId	Int64	False		Thumbnail ID. If AdType is TOP_IMPACT_PANORAMA_VIDEO, this field is required in ADD operation.
TopImpactPanoramaVideoUrl	String	False		Destination URL. If AdType is TOP_IMPACT_PANORAMA_VIDEO, this field is required in ADD operation.
TopImpactPanoramaVideoVideo10SecBeaconUrls	String	False		Viewing beacon URL (10 seconds).
TopImpactPanoramaVideoVideo25PercentBeaconUrls	String	False		Playback viewing beacon URL (25%).
TopImpactPanoramaVideoVideo3SecBeaconUrls	String	False		Beacon URL (3 seconds).
TopImpactPanoramaVideoVideo50PercentBeaconUrls	String	False		Playback viewing beacon URL (50%)
TopImpactPanoramaVideoVideo75PercentBeaconUrls	String	False		Playback viewing beacon URL (75%)
TopImpactPanoramaVideoVideoCompleteBeaconUrls	String	False		Viewing Beacon URL (complete)
TopImpactPanoramaVideoVideoStartBeaconUrls	String	False		Viewing Beacon URL (start)
TopImpactPrimeDisplayDoubleAdLeftSideMediaId	Int64	False		Left side image. If AdType is TOP_IMPACT_PRIME_DISPLAY_DOUBLE, this field is required in ADD operation.
TopImpactPrimeDisplayDoubleAdRightSideMediaId	Int64	False		Right side image. If AdType is TOP_IMPACT_PRIME_DISPLAY_DOUBLE, this field is required in ADD operation.
TopImpactPrimeDisplayDoubleDisplayUrl	String	False		Display URL. If AdType is TOP_IMPACT_PRIME_DISPLAY_DOUBLE, this field is required in ADD operation.
TopImpactPrimeDisplayDoubleUrl	String	False		Destination URL. If AdType is TOP_IMPACT_PRIME_DISPLAY_DOUBLE, this field is required in ADD operation.
TopImpactPrimeDisplayDoubleVideoAdLeftSideMediaId	Int64	False		Left side image. If AdType is TOP_IMPACT_PRIME_DISPLAY_DOUBLE, this field is required in ADD operation.
TopImpactPrimeDisplayDoubleVideoAdRightSideMediaId	Int64	False		Right side image. If AdType is TOP_IMPACT_PRIME_DISPLAY_DOUBLE, this field is required in ADD operation.
TopImpactPrimeDisplayDoubleVideoDisplayUrl	String	False		Display URL. If AdType is TOP_IMPACT_PRIME_DISPLAY_DOUBLE, this field is required in ADD operation.
TopImpactPrimeDisplayDoubleVideoAddisplayUrlLevel	String	False		Display URL.
TopImpactPrimeDisplayDoubleVideoFinalUrl	String	False		Final URL.
TopImpactPrimeDisplayDoubleVideoSmartphoneFinalUrl	String	False		Final URL (smartphone).
TopImpactPrimeDisplayDoubleVideoisRemoveSmartphoneFinalUrl	String	False		Flag for removing an information item. The allowed values are TRUE, FALSE, UNKNOWN..
TopImpactPrimeDisplayDoubleVideoisRemoveTrackingUrl	String	False		Flag for removing an information item. The allowed values are TRUE, FALSE, UNKNOWN..
TopImpactPrimeDisplayDoubleVideoCustomParametersIsRemove	String	False		Delete flag. The allowed values are TRUE, FALSE, UNKNOWN.
TopImpactPrimeDisplayDoubleVideoCustomParameters	String	False		Displays the element of custom parameters.
TopImpactPrimeDisplayDoubleVideoIsRemoveVideo10SecBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
TopImpactPrimeDisplayDoubleVideoIsRemoveVideo25PercentBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
TopImpactPrimeDisplayDoubleVideoIsRemoveVideo3SecBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
TopImpactPrimeDisplayDoubleVideoIsRemoveVideo50PercentBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
TopImpactPrimeDisplayDoubleVideoIsRemoveVideo75PercentBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
TopImpactPrimeDisplayDoubleVideoIsRemoveVideoCompleteBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
TopImpactPrimeDisplayDoubleVideoIsRemoveVideoStartBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
TopImpactPrimeDisplayDoubleVideoThumbnailMediaId	Int64	False		Thumbnail ID. If AdType is TOP_IMPACT_PRIME_DISPLAY_DOUBLE, this field is required in ADD operation.
TopImpactPrimeDisplayDoubleVideoUrl	String	False		Destination URL. If AdType is TOP_IMPACT_PRIME_DISPLAY_DOUBLE, this field is required in ADD operation.
TopImpactPrimeDisplayDoubleVideoVideo10SecBeaconUrls	String	False		Viewing beacon URL (10 seconds).
TopImpactPrimeDisplayDoubleVideoVideo25PercentBeaconUrls	String	False		Playback viewing beacon URL (25%).
TopImpactPrimeDisplayDoubleVideoVideo3SecBeaconUrls	String	False		Beacon URL (3 seconds).
TopImpactPrimeDisplayDoubleVideoVideo50PercentBeaconUrls	String	False		Playback viewing beacon URL (50%)
TopImpactPrimeDisplayDoubleVideoVideo75PercentBeaconUrls	String	False		Playback viewing beacon URL (75%)
TopImpactPrimeDisplayDoubleVideoVideoCompleteBeaconUrls	String	False		Viewing Beacon URL (complete)
TopImpactPrimeDisplayDoubleVideoVideoStartBeaconUrls	String	False		Viewing Beacon URL (start)
TopImpactQuintieAdCenterMediaId	Int64	False		Center image. If AdType is TOP_IMPACT_QUINTIE, this field is required in ADD operation.
TopImpactQuintieAdLeftSideMediaId	Int64	False		Left side image. If AdType is TOP_IMPACT_QUINTIE, this field is required in ADD operation.
TopImpactQuintieAdRightSideMediaId	Int64	False		Right side image. If AdType is TOP_IMPACT_QUINTIE, this field is required in ADD operation.
TopImpactQuintieDisplayUrl	String	False		Display URL. If AdType is TOP_IMPACT_QUINTIE, this field is required in ADD operation.
TopImpactQuintieFinalUrl	String	False		Final URL.
TopImpactQuintieSmartphoneFinalUrl	String	False		Final URL (smartphone).
TopImpactQuintieisRemoveSmartphoneFinalUrl	String	False		Flag for removing an information item. The allowed values are TRUE, FALSE, UNKNOWN..
TopImpactQuintieisRemoveTrackingUrl	String	False		Flag for removing an information item. The allowed values are TRUE, FALSE, UNKNOWN..
TopImpactQuintieCustomParametersIsRemove	String	False		Delete flag. The allowed values are TRUE, FALSE, UNKNOWN.
TopImpactQuintieCustomParameters	String	False		Displays the element of custom parameters.
TopImpactQuintieUrl	String	False		Destination URL. If AdType is TOP_IMPACT_QUINTIE, this field is required in ADD operation.
TopImpactQuintieVideoAdCenterMediaId	Int64	False		Center image. If AdType is TOP_IMPACT_QUINTIE, this field is required in ADD operation.
TopImpactQuintieVideoAdLeftSideMediaId	Int64	False		Left side image. If AdType is TOP_IMPACT_QUINTIE, this field is required in ADD operation.
TopImpactQuintieVideoAdRightSideMediaId	Int64	False		Right side image. If AdType is TOP_IMPACT_QUINTIE, this field is required in ADD operation.
TopImpactQuintieVideoDisplayUrl	String	False		Display URL. If AdType is TOP_IMPACT_QUINTIE, this field is required in ADD operation.
TopImpactQuintieVideoIsRemoveVideo10SecBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
TopImpactQuintieVideoIsRemoveVideo25PercentBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
TopImpactQuintieVideoIsRemoveVideo3SecBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
TopImpactQuintieVideoIsRemoveVideo50PercentBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
TopImpactQuintieVideoIsRemoveVideo75PercentBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
TopImpactQuintieVideoIsRemoveVideoCompleteBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
TopImpactQuintieVideoIsRemoveVideoStartBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
TopImpactQuintieVideoThumbnailMediaId	Int64	False		Thumbnail ID. If AdType is TOP_IMPACT_QUINTIE_VIDEO, this field is required in ADD operation.
TopImpactQuintieVideoUrl	String	False		Destination URL. If AdType is TOP_IMPACT_QUINTIE_VIDEO, this field is required in ADD operation.
TopImpactQuintieVideoVideo10SecBeaconUrls	String	False		Viewing beacon URL (10 seconds).
TopImpactQuintieVideoVideo25PercentBeaconUrls	String	False		Playback viewing beacon URL (25%).
TopImpactQuintieVideoVideo3SecBeaconUrls	String	False		Beacon URL (3 seconds).
TopImpactQuintieVideoVideo50PercentBeaconUrls	String	False		Playback viewing beacon URL (50%)
TopImpactQuintieVideoVideo75PercentBeaconUrls	String	False		Playback viewing beacon URL (75%)
TopImpactQuintieVideoVideoCompleteBeaconUrls	String	False		Viewing Beacon URL (complete)
TopImpactQuintieVideoVideoStartBeaconUrls	String	False		Viewing Beacon URL (start)
TopImpactSquareAdCenterMediaId	Int64	False		Center image. If AdType is TOP_IMPACT_SQUARE, this field is required in ADD operation.
TopImpactSquareAdLeftSideMediaId	Int64	False		Left side image. If AdType is TOP_IMPACT_SQUARE, this field is required in ADD operation.
TopImpactSquareAdRightSideMediaId	Int64	False		Right side image. If AdType is TOP_IMPACT_SQUARE, this field is required in ADD operation.
TopImpactSquareDisplayUrl	String	False		Display URL. If AdType is TOP_IMPACT_SQUARE, this field is required in ADD operation.
topImpactSquareFinalUrl	String	False		Final URL.
topImpactSquareSmartphoneFinalUrl	String	False		Final URL (smartphone).
topImpactSquareisRemoveSmartphoneFinalUrl	String	False		Flag for removing an information item. The allowed values are TRUE, FALSE, UNKNOWN..
topImpactSquareisRemoveTrackingUrl	String	False		Flag for removing an information item. The allowed values are TRUE, FALSE, UNKNOWN..
topImpactSquareCustomParametersIsRemove	String	False		Delete flag. The allowed values are TRUE, FALSE, UNKNOWN.
topImpactSquareCustomParameters	String	False		Displays the element of custom parameters.
TopImpactSquareUrl	String	False		Destination URL. If AdType is TOP_IMPACT_SQUARE, this field is required in ADD operation.
TopImpactSquareSpecialAdCenterMediaId	Int64	False		Center image. If AdType is TOP_IMPACT_SQUARE_SPECIAL, this field is required in ADD operation.
TopImpactSquareSpecialAdLeftSideMediaId	Int64	False		Left side image. If AdType is TOP_IMPACT_SQUARE_SPECIAL, this field is required in ADD operation.
TopImpactSquareSpecialAdRightSideMediaId	Int64	False		Right side image. If AdType is TOP_IMPACT_SQUARE_SPECIAL, this field is required in ADD operation.
TopImpactSquareSpecialDisplayUrl	String	False		Display URL. If AdType is TOP_IMPACT_SQUARE_SPECIAL, this field is required in ADD operation.
TopImpactSquareSpecialVideoFinalUrl	String	False		Final URL.
TopImpactSquareSpecialVideoSmartphoneFinalUrl	String	False		Final URL (smartphone).
TopImpactSquareSpecialVideoisRemoveSmartphoneFinalUrl	String	False		Flag for removing an information item. The allowed values are TRUE, FALSE, UNKNOWN..
TopImpactSquareSpecialVideoisRemoveTrackingUrl	String	False		Flag for removing an information item. The allowed values are TRUE, FALSE, UNKNOWN..
TopImpactSquareSpecialVideoCustomParametersIsRemove	String	False		Delete flag. The allowed values are TRUE, FALSE, UNKNOWN.
TopImpactSquareSpecialVideoCustomParameters	String	False		Displays the element of custom parameters.
TopImpactSquareSpecialUrl	String	False		Destination URL. If AdType is TOP_IMPACT_SQUARE_SPECIAL, this field is required in ADD operation.
TopImpactSquareSpecialVideoAdCenterMediaId	Int64	False		Center image. If AdType is TOP_IMPACT_SQUARE_SPECIAL_VIDEO, this field is required in ADD operation.
TopImpactSquareSpecialVideoAdLeftSideMediaId	Int64	False		Left side image. If AdType is TOP_IMPACT_SQUARE_SPECIAL_VIDEO, this field is required in ADD operation.
TopImpactSquareSpecialVideoAdRightSideMediaId	Int64	False		Right side image. If AdType is TOP_IMPACT_SQUARE_SPECIAL_VIDEO, this field is required in ADD operation.
TopImpactSquareSpecialVideoDisplayUrl	String	False		Display URL. If AdType is TOP_IMPACT_SQUARE_SPECIAL_VIDEO, this field is required in ADD operation.
TopImpactSquareSpecialVideoIsRemoveVideo10SecBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
TopImpactSquareSpecialVideoIsRemoveVideo25PercentBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
TopImpactSquareSpecialVideoIsRemoveVideo3SecBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
TopImpactSquareSpecialVideoIsRemoveVideo50PercentBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
TopImpactSquareSpecialVideoIsRemoveVideo75PercentBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
TopImpactSquareSpecialVideoIsRemoveVideoCompleteBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
TopImpactSquareSpecialVideoIsRemoveVideoStartBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
TopImpactSquareSpecialVideoThumbnailMediaId	Int64	False		Thumbnail ID. If AdType is TOP_IMPACT_SQUARE_SPECIAL_VIDEO, this field is required in ADD operation.
TopImpactSquareSpecialVideoUrl	String	False		Destination URL. If AdType is TOP_IMPACT_SQUARE_SPECIAL_VIDEO, this field is required in ADD operation.
TopImpactSquareSpecialVideoVideo10SecBeaconUrls	String	False		Viewing beacon URL (10 seconds).
TopImpactSquareSpecialVideoVideo25PercentBeaconUrls	String	False		Playback viewing beacon URL (25%).
TopImpactSquareSpecialVideoVideo3SecBeaconUrls	String	False		Beacon URL (3 seconds).
TopImpactSquareSpecialVideoVideo50PercentBeaconUrls	String	False		Playback viewing beacon URL (50%)
TopImpactSquareSpecialVideoVideo75PercentBeaconUrls	String	False		Playback viewing beacon URL (75%)
TopImpactSquareSpecialVideoVideoCompleteBeaconUrls	String	False		Viewing Beacon URL (complete)
TopImpactSquareSpecialVideoVideoStartBeaconUrls	String	False		Viewing Beacon URL (start)
TopImpactSquareVideoAdCenterMediaId	Int64	False		Center image. If AdType is TOP_IMPACT_SQUARE_VIDEO, this field is required in ADD operation.
TopImpactSquareVideoAdLeftSideMediaId	Int64	False		Left side image. If AdType is TOP_IMPACT_SQUARE_VIDEO, this field is required in ADD operation.
TopImpactSquareVideoAdRightSideMediaId	Int64	False		Right side image. If AdType is TOP_IMPACT_SQUARE_VIDEO, this field is required in ADD operation.
TopImpactSquareVideoDisplayUrl	String	False		Display URL. If AdType is TOP_IMPACT_SQUARE_VIDEO, this field is required in ADD operation.
TopImpactSquareVideoIsRemoveVideo10SecBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
TopImpactSquareVideoIsRemoveVideo25PercentBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
TopImpactSquareVideoIsRemoveVideo3SecBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
TopImpactSquareVideoIsRemoveVideo50PercentBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
TopImpactSquareVideoIsRemoveVideo75PercentBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
TopImpactSquareVideoIsRemoveVideoCompleteBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
TopImpactSquareVideoIsRemoveVideoStartBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
TopImpactSquareVideoThumbnailMediaId	Int64	False		Thumbnail ID. If AdType is TOP_IMPACT_SQUARE_VIDEO, this field is required in ADD operation.
TopImpactSquareVideoUrl	String	False		Destination URL. If AdType is TOP_IMPACT_SQUARE_VIDEO, this field is required in ADD operation.
TopImpactSquareVideoVideo10SecBeaconUrls	String	False		Viewing beacon URL (10 seconds).
TopImpactSquareVideoVideo25PercentBeaconUrls	String	False		Playback viewing beacon URL (25%).
TopImpactSquareVideoVideo3SecBeaconUrls	String	False		Beacon URL (3 seconds).
TopImpactSquareVideoVideo50PercentBeaconUrls	String	False		Playback viewing beacon URL (50%)
TopImpactSquareVideoVideo75PercentBeaconUrls	String	False		Playback viewing beacon URL (75%)
TopImpactSquareVideoVideoCompleteBeaconUrls	String	False		Viewing Beacon URL (complete)
TopImpactSquareVideoVideoStartBeaconUrls	String	False		Viewing Beacon URL (start)
TopImpactTheaterVideoAdCenterMediaId	Int64	False		Center image. If AdType is TOP_IMPACT_THEATER_VIDEO, this field is required in ADD operation.
TopImpactTheaterVideoAdLeftSideMediaId	Int64	False		Left side image. If AdType is TOP_IMPACT_THEATER_VIDEO, this field is required in ADD operation.
TopImpactTheaterVideoAdRightSideMediaId	Int64	False		Right side image. If AdType is TOP_IMPACT_THEATER_VIDEO, this field is required in ADD operation.
TopImpactTheaterVideoDisplayUrl	String	False		Display URL. If AdType is TOP_IMPACT_THEATER_VIDEO, this field is required in ADD operation.
TopImpactTheaterVideoFinalUrl	String	False		Final URL.
TopImpactTheaterVideoSmartphoneFinalUrl	String	False		Final URL (smartphone).
TopImpactTheaterVideoisRemoveSmartphoneFinalUrl	String	False		Flag for removing an information item. The allowed values are TRUE, FALSE, UNKNOWN..
TopImpactTheaterVideoisRemoveTrackingUrl	String	False		Flag for removing an information item. The allowed values are TRUE, FALSE, UNKNOWN..
TopImpactTheaterVideoCustomParametersIsRemove	String	False		Delete flag. The allowed values are TRUE, FALSE, UNKNOWN.
TopImpactTheaterVideoCustomParameters	String	False		Displays the element of custom parameters.
TopImpactSquareSpecialUrl	String	False		Destination URL. If AdType is TOP_IMPACT_SQUARE_SPECIAL, this field is required in ADD operation.
TopImpactTheaterVideoIsRemoveVideo10SecBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
TopImpactTheaterVideoIsRemoveVideo25PercentBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
TopImpactTheaterVideoIsRemoveVideo3SecBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
TopImpactTheaterVideoIsRemoveVideo50PercentBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
TopImpactTheaterVideoIsRemoveVideo75PercentBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
TopImpactTheaterVideoIsRemoveVideoCompleteBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
TopImpactTheaterVideoIsRemoveVideoStartBeaconUrls	String	False		Flag for removing an information item.If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
TopImpactTheaterVideoThumbnailMediaId	Int64	False		Thumbnail ID. If AdType is TOP_IMPACT_THEATER_VIDEO, this field is required in ADD operation.
TopImpactTheaterVideoUrl	String	False		Destination URL. If AdType is TOP_IMPACT_THEATER_VIDEO, this field is required in ADD operation.
TopImpactTheaterVideoVideo10SecBeaconUrls	String	False		Viewing beacon URL (10 seconds).Available URL is only https.
TopImpactTheaterVideoVideo25PercentBeaconUrls	String	False		Playback viewing beacon URL (25%).Available URL is only https.
TopImpactTheaterVideoVideo3SecBeaconUrls	String	False		Beacon URL (3 seconds).Available URL is only https.
TopImpactTheaterVideoVideo50PercentBeaconUrls	String	False		Playback viewing beacon URL (50%).Available URL is only https.
TopImpactTheaterVideoVideo75PercentBeaconUrls	String	False		Playback viewing beacon URL (75%).Available URL is only https.
TopImpactTheaterVideoVideoCompleteBeaconUrls	String	False		Viewing Beacon URL (complete).Available URL is only https.
TopImpactTheaterVideoVideoStartBeaconUrls	String	False		Viewing Beacon URL (start).Available URL is only https.
AdId	Int64	False		Ad ID
AdName	String	False		Ad name.
AdStyle	String	False		Displays the ad style type. The allowed values are IMAGE, VIDEO, UNKNOWN.
ApprovalStatus	String	False		Displays editorial status. The allowed values are APPROVED, APPROVED_WITH_REVIEW, REVIEW, PRE_DISAPPROVED, POST_DISAPPROVED, UNKNOWN.
CampaignId	Int64	False	GuaranteedCampaigns.AccountId	Campaign ID
CampaignName	String	False		Campaign name
DisapprovalReasonCodes	String	False		Reject reason on editorial review.
DisapprovalReasonDescription	String	False		Reject reason details on editorial review.
ImpressionBeaconUrls	String	False		Impression beacon URL.
ViewableImpressionBeaconUrls	String	False		Impression beacon URL.
IsRemoveBeaconUrls	String	False		A flag for removing an information item. If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
IsRemoveImpressionBeaconUrls	String	False		A flag for removing an information item. If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
IsRemoveViewableImpressionBeaconUrls	String	False		A flag for removing an information item. If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
IsRemoveThirdPartyTrackingScriptUrl	String	False		A flag for removing an information item. If the set value is 'TRUE', the set value will be invalid. The allowed values are TRUE, FALSE, UNKNOWN.
Labels	String	False		Describes label information to be associated.
LandingPageStatus	String	False		Describes the status of the landing page. The allowed values are COMPLETED, SPECIFIED_UPDATE_SCHEDULED_TIME, UNKNOWN.
LandingPageUpdateScheduledTime	Datetime	False		The scheduled update date and time for the landing page.If landingPageStatus is SPECIFIED_UPDATE_SCHEDULED_TIME, this field is required.
MediaId	Int64	False	Media.MediaId	Media ID.
PreApprovalId	String	False		Pre-approval ID (Only number).
ThirdPartyTrackingScriptUrl	String	False		Third party tracking script URL. The allowed values are TRUE, FALSE, UNKNOWN.
ThirdPartyTrackingVendor	String	False		Third party tracking vendor (Read only).
UserStatus	String	False		Delivery status that can be set by an user. The allowed values are ACTIVE, PAUSED, UNKNOWN.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
ContainsLabelIdFlg	Boolean	Flag of contains label ID.
LabelId	String	Label ID.
ReferenceNumber	String	This column will be used in Bulk operations to get specific values from the Temp tables.

GuaranteedAdGroups

Create, Read, Update guaranteed ad group and use AdGroup/remove to delete the guaranteed ad group.

Table Specific Information

SELECT

The Sync App 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 Sync App.

AccountId supports the '='.
AdGroupId supports the '=,IN'.
CampaignId supports the '=,IN'.
ContainsLabelIdFlg supports the '='.
LabelId supports the '=,IN'.

For example, the following queries are processed server side:

SELECT * from GuaranteedAdGroups WHERE AccountId = '123436'

INSERT

Insert can be executed by specifying the AccountId, AdGroupName, CampaignId, Device and UserStatus 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 GuaranteedAdGroupLabels#TEMP (Color,Description,LabelId,LabelName) VALUES ('#0000FF','Testing GuaranteedAdGroupLabels','1000158197','TestGuaranteedAdGroupLabel')
INSERT INTO GuaranteedAdGroups (AccountId,AdGroupName,CampaignId,Device,Labels,UserStatus) VALUES ('1002504155','TestGuaranteedAdGroup','8667452','DESKTOP','GuaranteedAdGroupLabels#TEMP','ACTIVE')

UPDATE

Update can be executed by specifying the AccountId in the WHERE Clause. The columns that are not read-only can be Updated. For example:

INSERT INTO GuaranteedAdGroupAdLabels#TEMP (Color,Description,LabelName) VALUES ('#0000FF','Updating GuaranteedAdGroupLabels','TestGuaranteedAdGroupLabel')
UPDATE GuaranteedAdGroups SET AdGroupName = 'UpdateGuaranteedAdGroup', CampaignId = '8667452',Device = 'DESKTOP',Labels = 'GuaranteedAdGroupLabels#TEMP', UserStatus = 'ACTIVE' WHERE AccountId = '123436' AND AdGroupId = '2737353'

Columns


Name	Type	ReadOnly	References	Description
AdGroupId [KEY]	Int64	True		Ad Group ID.
AccountId	Int64	True	DisplayAdsAccounts.AccountId	Account ID.
AdGroupName	String	False		Ad group name.
AdGroupTargets	String	False		Contains targeting information specified in ad group.
CampaignId	Int64	False	GuaranteedCampaigns.CampaignId	Campaign ID.
CampaignName	String	False		Campaign name.
Device	String	False		Displays types of devices to be posted on. The allowed values are DESKTOP,SMARTPHONE,TABLET,NONE,UNKNOWN
DeviceApp	String	False		Serves application types for devices. The allowed values are APP,WEB,NONE,UNKNOWN
DeviceOs	String	False		Serves OS types for devices to be posted on. The allowed values are IOS,ANDROID,NONE,UNKNOWN
IsCreativeProfile	Boolean	False		If the value of this field is true, it indicates that the ad group was added using a creative profile.
Labels	String	False		Object describes label information to be associated.
UserStatus	String	False		Serves ad delivery status that can be set by an user. The allowed values are ACTIVE, PAUSED, UNKNOWN.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
ContainsLabelIdFlg	Boolean	Flag of contains label ID.
LabelId	Int64	Label ID.
ReferenceNumber	String	This column will be used in Bulk operations to get specific values from the Temp tables.

GuaranteedCampaigns

Read or Update guaranteed campaign.

Table Specific Information

SELECT

The Sync App 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 Sync App.

AccountId supports the '='.
CampaignId supports the '=,IN'.
ContainsLabelIdFlg supports the '='.
LabelId supports the '=,IN'.

For example:

SELECT * FROM GuaranteedCampaigns WHERE AccountId = '1002504155'

SELECT * FROM GuaranteedCampaigns WHERE AccountId = '1002504155' AND CampaignId = '1833923'

SELECT * FROM GuaranteedCampaigns WHERE AccountId = '1002504155' AND LabelId = '97108'

UPDATE

Update can be executed by specifying the AccountId,CampaignId in the WHERE Clause. The columns that are not read-only can be Updated. For example:

UPDATE GuaranteedCampaigns SET CampaignName = 'Test' WHERE AccountId = '1002504155' AND CampaignId = '1833923'

Columns


Name	Type	ReadOnly	References	Description
CampaignId [KEY]	Int64	True		Campaign ID.
AccountId	Int64	True	DisplayAdsAccounts.AccountId	Account ID.
AdCategoryStatus	String	False		Describes the ad category status of a guaranteed campaign. The allowed values are ADDED, NONE, UNKNOWN.
BrandTrackingAudienceCategoryIds1	String	False		Audience Category ID group 1.
BrandTrackingAudienceCategoryIds2	String	False		Audience Category ID group 2.
BrandTrackingBusinessCategoryIds	String	False		Business Category ID group.
CampaignBiddingStrategyCampaignBiddingStrategyType	String	False		Describes setting of campaign bid strategy type. The allowed values are MAX_VCPM, SOV, UNKNOWN.
CampaignBiddingStrategyVcpmBidValue	Int64	False		Max bid of campaign (vCPM).
CampaignBiddingStrategySovRate	Int64	False		SOV rate.
CampaignCanceledDate	Datetime	False		A date and time which the guaranteed campaign is cancelled.
ConversionGroupId	String	False		GuaranteedCampaignServiceConversionGroupID.conversionGroupId and conversionTrackerIds cannot be set at the same time
ConversionTrackerId	Int64	False		GuaranteedCampaignServiceConversionTrackerID.conversionGroupId and conversionTrackerIds cannot be set at the same time
IsRemoveConversionGroupId	Int64	False		GuaranteedCampaignServiceIsRemoveFlg is a flag for removing an information item. The allowed values are TRUE, FALSE, UNKNOWN.
IsRemoveConversionTrackerId	Datetime	False		GuaranteedCampaignServiceIsRemoveFlg is a flag for removing an information item The allowed values are TRUE, FALSE, UNKNOWN.
CampaignGoal	String	False		Campaign goal.
CampaignName	String	False		Campaign Name.
StartDate	Date	False		Start date.
EndDate	Date	False		End date.
StartTime	Date	False		Start Time.
EndTime	Date	False		End Time.
GuaranteedSimulationId	Int64	False		Maximum number of ad viewable impressions to same user.
Labels	String	False		Describes label information to be associated.
LifetimeBudgetAmount	Int64	False		Describes the information of campaign's lifetime budget.
LifetimeBudgetPrice	Int64	False		Price.
NotificationEmailAddress	String	False		Email address to send notifications.
PackagePackageHistoryId	Int64	False		Package ID.
PackagePackageId	Int64	False		Package history ID.
PackagePackageName	String	False		Package Name.
ConversionTrackerConversionGroupId	Int64	False		Conversion Group ID.
ConversionTrackerConversionTrackerId	Int64	False		Conversion Tracker ID.
ConversionTrackerIsRemoveConversionGroupId	String	False		It is a flag for removing an information item.
ConversionTrackerIsRemoveConversionTrackerId	String	False		It is a flag for removing an information item.
ServingStatus	String	False		Display the campaign status, regardless of userStatus setting. The allowed values are SERVING, ENDED, PENDING, UNKNOWN.
UserStatus	String	False		Serves ad delivery status that can be set by an user. The allowed values are ACTIVE, PAUSED, UNKNOWN.
ViewableFrequencyCapFrequencyLevel	String	False		Frequency setting level. The allowed values are CAMPAIGN, UNKNOWN.
ViewableFrequencyCapFrequencyTimeUnit	String	False		Frequency setting period. The allowed values are DAY, WEEK, MONTH, LIFETIME, UNKNOWN.
ViewableFrequencyCapVImps	Int64	False		Maximum number of ad viewable impressions to same user.
ContainsLabelIdFlg	Boolean	False		Flag of contains label ID.
LabelId	Int64	False		Label ID.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
ReferenceNumber	String	This column will be used in Bulk operations to get specific values from the Temp tables.

GuaranteedInventory

Get details of guaranteed campaign and information about inventory status of product

Table Specific Information

Select

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

AccountId supports the '=,IN'.
InventoryJobId supports the '='.

For example:

SELECT * FROM GuaranteedInventory WHERE AccountId = '1002504155' 

SELECT * FROM GuaranteedInventory WHERE InventoryJobId = '1002504155'

INSERT

Insert can be executed by specifying the AccountId and InventoryJobName 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 GuaranteedInventory (AccountId,InventoryJobName) VALUES (1002504155,'test')

Columns


Name	Type	ReadOnly	References	Description
InventoryJobId [KEY]	Int64	True		Inventory check job ID.
AccountId	Int64	True	DisplayAdsAccounts.AccountId	Account ID
CreatedBusinessId	String	False		Yahoo! JAPAN Business ID of inventory check job creator
Inventories	String	False		GuaranteedInventory object holds information about the delivery simulation of the guaranteed campaign
InventoryJobEndDate	String	False		End date of inventory check job
InventoryJobName	String	False		Inventory check job name
InventoryJobStartDate	String	False		Start date of inventory check job
InventoryJobStatus	String	False		GuaranteedInventoryServiceInventoryJobStatus describes the execution status of inventory check job The allowed values are PROCESSING, SUCCEEDED, FAILED, UNKNOWN.
IsExpiredPackage	Boolean	False		A flag which indicates if the expired package is specified
NotificationBusinessIds	String	False		Yahoo! JAPAN Business ID to send notification

GuaranteedSimulations

Create or Read information about the delivery simulation of the guaranteed campaign.

Table Specific Information

SELECT

The Sync App 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 Sync App.

AccountId supports the '='.
GuaranteedSimulationId supports the '=,IN'.

For example:

SELECT * FROM GuaranteedSimulations WHERE AccountId = '1002504155'

SELECT * FROM GuaranteedSimulations WHERE AccountId = '1231002504' AND GuaranteedSimulationId = '45698'

INSERT

Insert can be executed by specifying the AccountId, CampaignGoal, StartDate, EndDate, AdRequirements 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 GuaranteedSimulationAdRequirements#TEMP(AccountId, AdType, MediaAdFormat) values(1002504155, 'BANNER_VIDEO_AD','YJ_1350_760')
INSERT INTO GuaranteedSimulations(AccountId, CampaignGoal, StartDate, EndDate, AdRequirements) values(1002504155, 'abcd','20220830','20220831','GuaranteedSimulationAdRequirements#TEMP')

Columns


Name	Type	ReadOnly	References	Description
GuaranteedSimulationId [KEY]	Int64	True		Simulation ID.
AccountId	Int64	True	DisplayAdsAccounts.AccountId	Account ID.
ActionAfterVideoAdTap	String	False		Describes what happens after a video ad is tapped. The allowed values are NONE, FOR_VIEW, FOR_CLICK, UNKNOWN.
AdCategoryIds	String	False	GuaranteedSimulationAdCategories.AdCategoryId	Ad category ID.
AdRequirements	String	False		Describes the conditions for composing the guaranteed ad.
AdPlaceType	String	False		Describes the ad placements. The allowed values are YAHOO_JAPAN_TOP, YAHOO_JAPAN_ALL, YAHOO_JAPAN_EXCLUSION_OF_TOP, UNKNOWN.
CampaignGoal	String	False		Campaign goal.
StartDate	Date	False		Start date.
EndDate	Date	False		End date.
EndTime	Date	False		End Time.
LifetimeBudget	Int64	False		An amount of campaign's lifetime budget.
LowerBudgetLimit	Int64	False		Minimum reservable lifetime budget.
UpperBudgetLimit	Int64	False		Maximum reservable lifetime budget.
MaxReach	Int64	False		Maximum number of reaches.
MaxVImps	Int64	False		Maximum number of ad viewable impressions to same user.
PackageHistoryId	Int64	False		Package history ID.
PackageId	Int64	False		Package ID.
RequestedConditionResultLifetimeBudget	Int64	False		Lifetime budget.
RequestedConditionResultReach	Int64	False		Number of reaches.
RequestedConditionResultPrice	Int64	False		Price.
RequestedConditionResultSovRate	String	False		SOV (0.0% to 100.0%).
RequestedConditionResultVcpm	Int64	False		Number of reaches.
RequestedConditionResultViewableFrequency	String	False		Viewable frequency.
RequestedConditionResultVImps	Int64	False		Viewable impressions
ReservedConditionResultLifetimeBudget	Int64	False		Lifetime budget.
ReservedConditionResultLifetimePrice	Int64	False		Price.
ReservedConditionResultReach	Int64	False		Number of reaches.
ReservedConditionResultSovRate	String	False		SOV (0.0% to 100.0%).
ReservedConditionResultVcpm	Int64	False		Number of reaches.
ReservedConditionResultViewableFrequency	String	False		Viewable frequency.
ReservedConditionResultVImps	Int64	False		Viewable impressions
Results	String	False		Describes the prediction result of the guaranteed campaign.
InventoryResult	String	False		Describes the result of inventory check.
Reach	Int64	False		Number of reaches.
ReservationStatus	String	False		Describes the reservation availability status of guaranteed campaign. The allowed values are RESERVABLE, UNRESERVABLE, RESERVED, UNKNOWN.
Slots	Int64	False		Number of buying slots.lifetimeBudget, reach, vImps and slots cannot be set at the same time.
SovRate	Int64	False		SOV (1% to 100%).
Targets	String	False		Object holds the targeting information about the delivery simulation of the guaranteed campaign.
UnreservableReason	String	False		Describes the reason why reservation is not possible. The allowed values are NOT_ENOUGH_DELIVERY_TARGET, OUT_OF_STOCK, UNKNOWN.
ViewableFrequencyCapFrequencyLevel	String	False		Frequency setting level. The allowed values are CAMPIGN, UNKNOWN.
ViewableFrequencyCapFrequencyTimeUnit	String	False		Frequency setting period. The allowed values are DAY, WEEK, MONTH, LIFETIME, UNKNOWN.
ViewableFrequencyCapVImps	Int64	False		Maximum number of ad viewable impressions to same user.
VImps	Int64	False		Viewable impressions.

Media

Create, Read, Update or delete the media submission.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
MediaId supports the '=,IN'.
ApprovalStatus supports the '=,IN'.
UserStatus supports the '=,IN'.
StartDate supports the '='.
EndDate supports the '='.

For example:

SELECT * FROM Media WHERE AccountId = '1002504155'

SELECT * FROM Media WHERE AccountId = '1002504155' AND MediaId = '12345'

SELECT * FROM Media WHERE AccountId = '1002504155' AND StartDate = '20210703'

SELECT * FROM Media WHERE AccountId = '1002504155' AND EndDate = '20210703'

INSERT

Insert can be executed by specifying the AccountId, MediaName, MediaTitle, UserStatus and ImageMediaData 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 Media (AccountId, MediaName, MediaTitle, UserStatus, ImageMediaData) VALUES ('1002504155', 'test.JPEG', 'vtest', 'ACTIVE', 'iVBORw0KGgoAAAANSUhEUgAAAcsAAABuCAMAAAB')

UPADTE

Update can be executed by specifying the AccountId and MediaId in the WHERE Clause. The columns that are not read-only can be Updated. For example:

UPDATE Media SET MediaName = 'Test', ImageMediaAspectRatio = '10', ImageMediaData = 'iVBORw0KGgoAAAANSUhEUg', ImageMediaFileSize = '10', ImageMediaHeight = '100', ImageMediaMediaAdFormat = 'png', ImageMediaMediaFileType = 'GIF', ImageMediaMediaType = 'ANIMATION_IMAGE', ImageMediaWidth = '100' WHERE Accountid = '1002504155' AND MediaId = '123456'

DELETE

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

DELETE FROM Media WHERE  Accountid = '1002504155' AND MediaId = '123456'

Columns


Name	Type	ReadOnly	References	Description
MediaId [KEY]	Int64	True		Media ID.
AccountId	Int64	True	DisplayAdsAccounts.AccountId	Account ID.
ApprovalStatus	String	False		Serves the approval status of media. The allowed values are POST_DISAPPROVED, APPROVED, REVIEW, PRE_DISAPPROVED, UNKNOWN.
CampaignBannerFlg	String	False		Displays the flag settings of Campaign banner image. The allowed values are TRUE, FALSE, UNKNOWN.
CreatedDate	Date	True		Date of Media made.
CreationTime	String	False		Date and time of creation.
DisapprovalReasonCodes	String	False		Reason code why it's disapproved on the review.
ImageMediaAspectRatio	String	False		The type of aspect ratio.
ImageMediaData	String	False		The image file in base64 encode.
ImageMediaFileSize	Int64	False		The file size of image.
ImageMediaHeight	Int64	False		The height of image.
ImageMediaMediaAdFormat	String	False		The type of image format.Available values can be referred to adFormat field of DictionaryServiceMediaAdFormat object obtained by getMediaAdFormat operation of DictionaryService.
ImageMediaMediaFileType	String	False		Serves the file type of media. The allowed values are GIF, PNG, JPEG, UNKNOWN.
ImageMediaMediaType	String	False		Serves the type of media. The allowed values are IMAGE, ANIMATION_IMAGE, UNKNOWN.
ImageMediaWidth	Int64	False		The width of image.
LogoFlg	String	False		Displays the flag settings of Logo image. The allowed values are FALSE, TRUE, UNKNOWN.
MediaName	String	False		File name.
MediaRichFormatFlg	String	False		Displays the flag settings of rich format image of guaranteed campaign. The allowed values are TRUE, FALSE, UNKNOWN.
MediaTitle	String	False		Image name.
ThumbnailFlg	String	False		Displays the setting flag for the thumbnail image. The allowed values are FALSE, TRUE, UNKNOWN.
UserStatus	String	False		Serves ad delivery status that can be set by an user. The allowed values are ACTIVE, PAUSED, UNKNOWN.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
StartDate	Date	This is the start date of the search target period.
EndDate	Date	This is the end date of the search target period.
ReferenceNumber	String	This column will be used in Bulk operations to get specific values from the Temp tables.

PlacementUrlLists

Create, Read, Update or Delete the placement URL list.

Table Specific Information

SELECT

The Sync App 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 Sync App.

AccountId supports the '='.
UrlListId supports the '=,IN'.

For example:

SELECT * FROM PlacementUrlLists WHERE AccountId = '1002504155'

SELECT * FROM PlacementUrlLists WHERE AccountId = '1002504155' AND UrlListId = '1000908843'

INSERT

Insert can be executed by specifying the AccountId, UrlListName and Urls 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 PlacementUrlListUrls#temp(PlacementUrl) VALUES ('cdata.com')
INSERT INTO PlacementUrlLists(AccountId,UrlListName, Urls) VALUES ('1002504155','Testurl','PlacementUrlListUrls#temp')

UPDATE

Update can be executed by specifying the AccountId and UrlListId in the WHERE Clause. The columns that are not read-only can be Updated. For example:

INSERT INTO PlacementUrlListUrls#temp(PlacementUrl) VALUES ('cdata.com');
UPDATE PlacementUrlLists SET UrlListName = 'Cdata' WHERE AccountId = '1002504155' AND UrlListId = '1000908844'

DELETE

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

DELETE FROM PlacementUrlLists  WHERE AccountId = '1002504155' AND UrlListId = '1000908844'

Columns


Name	Type	ReadOnly	References	Description
UrlListId [KEY]	Int64	True		Url List ID.
AccountId	Int64	True	DisplayAdsAccounts.AccountId	Account ID.
BrandSafetyDenyListFlg	Boolean	False		A flag that indicates whether it is an exclusion list.Only one list can be created per account.Can be linked only to exclusion.Cannot be linked with YDN campaign. The default value is FALSE.
Description	String	False		Url List Description.
IsRemoveDescription	String	False		Flag for removing an information item. The allowed values are TRUE, FALSE, UNKNOWN.
UnknownDomainFlg	String	False		Unknown Domain Flag The allowed values are TRUE, FALSE, UNKNOWN.
UrlListName	String	False		Url List Name.
Urls	String	False		The objects to keep url

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
ReferenceNumber	String	This column will be used in Bulk operations to get specific values from the Temp tables.

RetargetingTags

Create or Read site retargeting tag information.

Table Specific Information

SELECT

The Sync App 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 Sync App.

AccountId supports the '='.

For example:

SELECT * FROM RetargetingTags WHERE AccountId = '1002504155'

INSERT

Insert can be executed by specifying the AccountId 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 RetargetingTags(AccountId) VALUES ('1002504155')

Columns


Name	Type	ReadOnly	References	Description
RetargetingTagId [KEY]	String	True		Tag ID for site retargeting.
AccountId	Int64	True	DisplayAdsAccounts.AccountId	Account ID.
AdvancedTag	String	False		The new format of site retargeting tag avoids the impacts such as changes made to the browser.
ApprovalStatus	String	False		Status of tag approval for site retargeting The allowed values are AVAILABLE, DISAPPROVED, DISAPPROVED_WITH_REVIEW, UNKNOWN.
Tag	String	False		Tag of site retargeting.

SearchKeywordList

Read, add, update or delete the search keyword list.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
SearchKeywordListId supports the 'IN,='.

For example:

SELECT * FROM SearchKeywordList WHERE AccountId = '1002504155'

SELECT * FROM SearchKeywordList WHERE AccountId = '1002504155' AND SearchKeywordListId = '1002346070'

INSERT

Insert can be executed by specifying the AccountId, SearchKeyword and SearchKeywordListName 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 SearchKeywordListSearchKeywords#TEMP (SearchKeywordId) VALUES ('1000023142')
INSERT INTO SearchKeywordList(AccountId,SearchKeyword, SearchKeywordListName) VALUES ('1002504155','SearchKeywordListSearchKeywords#TEMP','test')

UPDATE

Update can be executed by specifying the AccountId and SearchKeywordListId in the WHERE Clause. The columns that are not read-only can be Updated. For example:

INSERT INTO SearchKeywordListSearchKeywords#TEMP (SearchKeywordId) VALUES ('1000023142')
UPDATE SearchKeywordList SET SearchKeywordListName ='TestSearch' , SearchKeyword ='SearchKeywordListSearchKeywords#TEMP'  WHERE AccountId = '1002504155' AND SearchKeywordListId = '1002346070'

DELETE

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

DELETE SearchKeywordList  WHERE AccountId = '1002504155' AND SearchKeywordListId = '1002346070'

Columns


Name	Type	ReadOnly	References	Description
SearchKeywordListId [KEY]	Int64	True		Search keyword list ID.
AccountId	Int64	True	DisplayAdsAccounts.AccountId	Account ID.
DeliveryStatus	String	False		Displays the status of search keyword list. The allowed values are PAUSED, ACTIVE, UNKNOWN.
IsRemoveSearchKeywordListDescription	String	False		Flag for removing an information item The allowed values are TRUE, FALSE, UNKNOWN.
KeywordFrequency	String	False		Search frequency information on Search Keyword.The default value in ADD operation will be ONCE_OR_MORE. The allowed values are ONCE_OR_MORE, TWICE_OR_MORE, THREE_TIMES_OR_MORE, UNKNOWN. The default value is ONCE_OR_MORE.
KeywordRecency	String	False		Storing the effective period information of Search Keyword.The default value in ADD operation will be WITHIN_30DAYS. The allowed values are WITHIN_1DAY, WITHIN_3DAYS, WITHIN_7DAYS, WITHIN_14DAYS, WITHIN_30DAYS, UNKNOWN. The default value is WITHIN_30DAYS.
SearchKeyword	String	False		Display the search keyword.
SearchKeywordListDescription	String	False		Description of Search keyword list.
SearchKeywordListName	String	False		Name of Search keyword list.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
ReferenceNumber	String	This column will be used in Bulk operations to get specific values from the Temp tables.

Videos

Read, Update or Delete Video Ads.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
MediaId supports the '=,IN'.
ApprovalStatus supports the '=,IN'.
ProcessStatus supports the '=,IN'.
UserStatus supports the '='.
StartDate supports the '='.
EndDate supports the '='.

For example:

SELECT * FROM Videos WHERE AccountId = '1002504155';

SELECT * FROM Videos WHERE AccountId = '1002504155' AND MediaId = '123456'

SELECT * FROM Videos WHERE AccountId = '1002504155' AND StartDate = '20210703'

SELECT * FROM Videos WHERE AccountId = '1002504155' AND EndDate = '20210703'

UPDATE

Update can be executed by specifying the AccountId and MediaId in the WHERE Clause. The columns that are not read-only can be Updated. For example:

UPDATE Videos SET VideoName='Testvideo' WHERE AccountId = '1002504155' AND MediaId = '123456'

DELETE

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

DELETE FROM Videos WHERE AccountId = '1002504155' AND MediaId = '123456'

Columns


Name	Type	ReadOnly	References	Description
MediaId [KEY]	Int64	True	Media.MediaId	Media ID.
AccountId	Int64	True	DisplayAdsAccounts.AccountId	Account ID.
ApprovalStatus	String	False		Editorial status. The allowed values are APPROVED, REVIEW, PRE_DISAPPROVED, POST_DISAPPROVED, UNKNOWN.
CreatedDate	Date	True		Date when the video was made.
CreationTime	String	False		Time and date when the video was submitted.
DisapprovalReasonCodes	String	False		Disapproval reason of the video.
ProcessStatus	String	False		process status of videos The allowed values are PROCESSING, FINISHED, FAILED, UNKNOWN.
UserStatus	String	False		Ad delivery status that can be set by an user. The allowed values are ACTIVE, PAUSED, UNKNOWN.
VideoName	String	False		Video file name.
VideoSettingExtraSpecs	String	False		It is an additional video quality that can be used other than the regular video qualities.
VideoSettingFileSize	Int64	False		File size of the video.
VideoSettingFileType	String	False		File type of videos. The allowed values are MP4, UNKNOWN.
VideoSettingHeight	Int64	False		Height (vertical length) of the video.
VideoSettingPlaybackTime	Int64	False		Play time (sec) of the video.
VideoSettingVideoAdFormat	String	False		Ad format type of the video ad.
VideoSettingVideoAspectRatio	String	False		Type of aspect ratio.
VideoSettingWidth	Int64	False		Width of the video.
VideoTitle	String	False		Video name.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
StartDate	Date	start date of the search target period.
EndDate	Date	end date of the search target period.
ReferenceNumber	String	This column will be used in Bulk operations to get specific values from the Temp tables.

Views

Views are composed of columns and pseudo columns. Views are similar to tables in the way that data is represented; however, views do not support updates. Entities that are represented as views are typically read-only entities. Often, a stored procedure is available to update the data if such functionality is applicable to the data source.

Queries can be executed against a view as if it were a normal table, and the data that comes back is similar in that regard.

Dynamic views, such as queries exposed as views, and views for looking up specific combinations of project_team work items are supported.

Yahoo! Ads Connector for CData Sync Views


Name	Description
AccountAuthorities	Get account authority information.
AudienceCategories	Get the list of audience category
AudienceListContentCombinationAudienceListCombinations	Retrieve the details of Combination of Audience list information. The columns values set read-only false can be inserted in the parent table using Temp tables.
AudienceListContentCombinationAudienceListCombinationsAudienceLists	Retrieve the details of Audience list. The columns values set read-only false can be inserted in the parent table using Temp tables.
AudienceListContentCombinationAudienceListRulesRuleConditions	Retrieve the details of AudienceList Rules RuleConditions. The columns values set read-only false can be inserted in the parent table using Temp tables.
AudienceListContentRuleAudienceListRules	Retrieve the details of ContentRuleAudience List Rules. The columns values set read-only false can be inserted in the parent table using Temp tables.
AudienceListContentSimilarityAudienceListAudienceListSizeReaches	Retrieve the details of each reaches of Audience list size. The columns values set read-only false can be inserted in the parent table using Temp tables.
AudienceListContentWebsiteVisitorsAudienceListRules	Retrieve the details of ContentWebsiteVisitorsAudience List Rules. The columns values set read-only false can be inserted in the parent table using Temp tables.
AudienceListContentWebsiteVisitorsAudienceListRulesRuleConditions	Retrieve the details of ContentWebsiteVisistorsAudienceList Rules RuleConditions. The columns values set read-only false can be inserted in the parent table using Temp tables.
BrandLifts	Get the BrandLift information.
BrandLiftsQuestions	Brand lift survey contents. The columns values set read-only false can be inserted in the parent table using Temp tables.
BusinessCategories	Get the list of business category
CampaignMigrations	Get the migration status.
ContentsKeywordIdea	Retrieves the keyword for contents targeting.
ContentsKeywordListsContentsKeyword	Get the contents keyeord list
ConversionGroupConversions	Get ConversionGroup information of specified account
DisplayAdsAccountLinks	Get the account link information.
DisplayAdsAdGroupAdCarouselAdCarousels	Retrieve the information of carousel ad.
DisplayAdsAdGroupAdServiceLabels	Retrieve the details of AdGroupAdService Labels. The columns values set read-only false can be inserted in the parent table using Temp tables
DisplayAdsAdGroupServiceLabels	Retrieve the details of AdGroup Labels. The columns values set read-only false can be inserted in the parent table using Temp tables.
DisplayAdsBalance	Get the account balance.
DisplayAdsCampaignServiceLabels	Retrieve the details of DisplayAdsCampaign Labels. The columns values set read-only false can be inserted in the parent table using Temp tables.
DisplayAdsConversionTrackerWebConversionSnippets	Retrieve the details of tracking script information of Web Conversion Tracker. The columns values set read-only false can be inserted in the parent table using Temp tables.
DisplayAdsDisapprovalReasons	Get the list of response from recommendation with EditorialReason.
DisplayAdsGeographicLocations	Get the information list of geo targeting.
DisplayAdsReportFields	Retrieve the available report fields for a given report type.
DisplayAdsReportFilters	Retrieve the details of filtering report conditions. The columns values set read-only false can be inserted in the parent table using Temp tables.
DisplayAdsReportReportTypeConditionConversionPathAccountSettingSubAccounts	Retrieve the details of account and its product type. The columns values set read-only false can be inserted in the parent table using Temp tables.
DisplayAdsReportReportTypeConditionConversionPathFilters	Retrieve the details of flag which indicates whether to include view interaction in Conversion Path Report.
DisplayAdsReportReportTypeConditionCrossCampaignReachesReportConditionCrossCampaignGoals	Retrieve the details of account and campaign goal that is subject to Cross-campaign Reach Report combination.
DisplayAdsReportReportTypeConditionCrossCampaignReachesReportConditionCrossCampaignIds	Retrieve the details of condition to create each report type
DisplayAdsReportSortFields	Retrieve the sort details of report definition. The columns values set read-only false can be inserted in the parent table using Temp tables.
DisplayAdsReportTypeConditionCrossCampaignBuyingTypes	Retrieve the details of Condition to create Cross-campaign Reach Report. The columns values set read-only false can be inserted in the parent table using Temp tables.
FeedData	Get the status of uploaded item list.
FeedItemGoogleProductCategories	Get Google product category that can be specified for Feed item information.
FeedSetConditionSets	Retrieve the details of Conditions of Item Set information. The columns values set read-only false can be inserted in the parent table using Temp tables.
FeedSetConditionSetsOrCondition	Retrieve the details of Conditions of Item Set information. The columns values set read-only false can be inserted in the parent table using Temp tables.
GetUploadUserListStatus	Get the upload status of the user list.
GuaranteedAdGroupAdGroupTargets	Retrieve the targeting information specified in ad group.This object is required if you are adding ad group via GuaranteedAdGroupService. The columns values set read-only false can be inserted in the parent table using Temp tables.
GuaranteedAdGroupAdLabels	Retrieve the details of GuaranteedAdGroupAds Labels. The columns values set read-only false can be inserted in the parent table using Temp tables.
GuaranteedAdGroupLabels	Retrieve the details of GuaranteedAdGroup Labels. The columns values set read-only false can be inserted in the parent table using Temp tables.
GuaranteedCampaignLabels	Retrieve the details of GuaranteedCampaigns Labels. The columns values set read-only false can be inserted in the parent table using Temp tables.
GuaranteedInventoryInventories	Get details of guaranteed campaign and information about inventory status of product
GuaranteedInventoryInventoriesAdRequirements	Get details of guaranteed campaign and information about inventory status of product
GuaranteedInventoryInventoriesInventoryResults	Get details of guaranteed campaign and information about inventory status of product
GuaranteedInventoryInventoriesInventoryResultUnavailableReasons	Get details of guaranteed campaign and information about inventory status of product
GuaranteedInventoryInventoriesPredictionResults	Get details of guaranteed campaign and information about inventory status of product
GuaranteedInventoryInventoriesTargets	Get details of guaranteed campaign and information about inventory status of product
GuaranteedPreview	Read the preview of guaranteed campaign.
GuaranteedPreviewPanels	It holds information about the preview material.
GuaranteedSimulationAdCategories	Get the list of ad categories in the delivery simulation of the guaranteed campaign.
GuaranteedSimulationAdRequirements	Retrieve details of conditions for composing the guaranteed ad.
GuaranteedSimulationInventoryResult	Retrieve details of conditions for composing the guaranteed ad.
GuaranteedSimulationInventoryResultUnavailableReasons	Retrieve details of conditions for composing the guaranteed ad.
GuaranteedSimulationPackageAdRequirements	Retrieve the details of conditions for composing the guaranteed ad. The columns values set read-only false can be inserted in the parent table using Temp tables.
GuaranteedSimulationPackages	Get the package list for the delivery simulation of the guaranteed campaign.
GuaranteedSimulationPackagesPackagePermittedAdScheduleTargetPermittedTargets	Retrieve the details of Configuration information of Ad Schedule targeting. The columns values set read-only false can be inserted in the parent table using Temp tables.
GuaranteedSimulationPackagesPackagePermittedAgeTargetPermittedTargets	Retrieve the details of Configuration information of age targeting. The columns values set read-only false can be inserted in the parent table using Temp tables.
GuaranteedSimulationPackagesPackagePermittedAppTargetPermittedTargets	Retrieve the details of Configuration information of App targeting. The columns values set read-only false can be inserted in the parent table using Temp tables.
GuaranteedSimulationPackagesPackagePermittedAudienceCategoryTargetPermittedTargets	Retrieve the details of Configuration information of audience category targeting. The columns values set read-only false can be inserted in the parent table using Temp tables.
GuaranteedSimulationPackagesPackagePermittedDeviceTargetPermittedTargets	Retrieve the details of Configuration information of Device targeting. The columns values set read-only false can be inserted in the parent table using Temp tables.
GuaranteedSimulationPackagesPackagePermittedGenderTargetPermittedTargets	Retrieve the details of Configuration information of Gender targeting. The columns values set read-only false can be inserted in the parent table using Temp tables.
GuaranteedSimulationPackagesPackagePermittedGeoTargetPermittedTargets	Retrieve the details of Configuration information of Geo targeting. The columns values set read-only false can be inserted in the parent table using Temp tables.
GuaranteedSimulationPackagesPackagePermittedOsTargetPermittedTargets	Retrieve the details of Configuration information of OS targeting. The columns values set read-only false can be inserted in the parent table using Temp tables.
GuaranteedSimulationPackagesPackagePermittedPlacementCategoryTargetPermittedTargets	Retrieve the details of Configuration information of placement category targeting. The columns values set read-only false can be inserted in the parent table using Temp tables.
GuaranteedSimulationPackagesPackagePermittedPositionTargetPermittedTargets	Retrieve the details of Configuration information of position targeting. The columns values set read-only false can be inserted in the parent table using Temp tables.
GuaranteedSimulationPackagesPackagePermittedSiteRetargetingTargetPermittedTargets	Retrieve the details of site retargeting settings. The columns values set read-only false can be inserted in the parent table using Temp tables.
GuaranteedSimulationPredictionResults	Retrieve details of prediction result of the guaranteed campaign. The columns values set read-only false can be inserted in the parent table using Temp tables.
GuaranteedSimulationsAdCategories	Get the list of ad categories in the delivery simulation of the guaranteed campaign.
GuaranteedSimulationTargets	Retrieve details of targeting information about the delivery simulation of the guaranteed campaign. The columns values set read-only false can be inserted in the parent table using Temp tables.
MediaAdFormats	Get an acceptable format (MediaAdFormat) of ad creatives.
OsVersions	Get the version of OS.
PlacementUrlIdeas	Get the candidate URL
PlacementUrlListUrls	Retrieve the details of PlacementUrlLists Urls. The columns values set read-only false can be inserted in the parent table using Temp tables.
RecommendationCampaignBiddingStrategyToTargetCpaCampaignBiddingStrategyToTargetCpaCampaignList	Retrieve the details of campaign that is suitable for using autobidding. The columns values set read-only false can be inserted in the parent table using Temp tables.
RecommendationDailyBudgetOverDailyBudgetOverCampaignLists	Retrieve the information about campaigns that reached the daily budget. The columns values set read-only false can be inserted in the parent table using Temp tables.
RecommendationImpsShareBudgetLossOverImpsShareBudgetLossOverCampaignLists	Retrieve the information of campaigns that have a large lost impression share (budget). The columns values set read-only false can be inserted in the parent table using Temp tables.
Recommendations	Get Recommendations information.
RecommendationSearchKeywordIdeaSearchKeywordIdeaSearchKeywordLists	Retrieve the details of recommended search keyword to add. The columns values set read-only false can be inserted in the parent table using Temp tables.
SearchKeywordIdeas	Get the keyword for search targeting.
SearchKeywordListSearchKeywords	Retrieve the details of search keyword. The columns values set read-only false can be inserted in the parent table using Temp tables.
SearchLifts	Get SearchLift information.
SearchLiftskeywords	Retrieve the details of keyword of the search lift. The columns values set read-only false can be inserted in the parent table using Temp tables.
SiteCategories	Get the list of site category.
StationPlacementCategories	Get list of station information included in placement category list.
StationPlacementCategoryPlacementCategories	Get list of station information included in placement category list.
Stats	Get the stats information of each campaign, ad group, ad, image and video.
ThirdPartyTrackingDomains	Get the domain and vendor name that can be specified for the third-party scripting URL.
VideosVideoSettingExtraSpecs	It is an additional video quality that can be used other than the regular video qualities. The columns values set read-only false can be inserted in the parent table using Temp tables.

AccountAuthorities

Get account authority information.

Table Specific Information

SELECT

The Sync App 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 Sync App.

AccountId supports the 'IN,='.

For example:

SELECT * FROM AccountAuthorities WHERE AccountId = '1002504155'

Columns


Name	Type	References	Description
AccountId [KEY]	Int64	DisplayAdsAccounts.AccountId	Account ID.
Authorities	String		Account authority.

AudienceCategories

Get the list of audience category

Table Specific Information

SELECT

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

lang supports the '='.

For example:

SELECT * FROM AudienceCategories WHERE Lang = 'EN'

Columns


Name	Type	References	Description
AudienceCategoryType	String		Audience category information The allowed values are AFFINITY, IN_MARKET, ATTRIBUTE_LIFE_EVENTS, UNKNOWN.
Child	String		DictionaryServiceAudienceCategory object is used
Code	String		Category code
FullName	String		Category name (A formal name including category name and sub category name.)
IsGuaranteedPermitted	String		Indicates that it is subject to guaranteed sale.
Name	String		Sub-category name
Reach	Int64		Reach record number
Lang	String		DictionaryServiceLang is a language selection of the list The allowed values are EN, JA, UNKNOWN.

AudienceListContentCombinationAudienceListCombinations

Retrieve the details of Combination of Audience list information. The columns values set read-only false can be inserted in the parent table using Temp tables.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
AudienceListId supports the '=,IN'.
AudienceListType supports the '=,IN'.

For example:

SELECT * FROM AudienceListContentCombinationAudienceListCombinations
SELECT * FROM AudienceListContentCombinationAudienceListCombinations WHERE AccountId = '1234339'
SELECT * FROM AudienceListContentCombinationAudienceListCombinations WHERE AccountId = '1234339' AND AudienceListId='1003039071'
SELECT * FROM AudienceListContentCombinationAudienceListCombinations WHERE AccountId = '1234339' AND AudienceListId='1003039071' AND AudienceListType='DEFAULT_LIST'

Columns


Name	Type	References	Description
AudienceListId	Int64		Audience List ID.
AccountId	Int64	DisplayAdsAccounts.AccountId	Account ID.
AudienceLists	String		Audience lists. If audienceListType is COMBINATION, this field is required in ADD and SET operation.
LogicalOperator	String		Displays the type of conditions. This field is required in ADD and SET operation, and will be ignored in REMOVE operation. The allowed values are OR, AND, NOTIN, UNKNOWN.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name

Type

Description

SharingStatusFilterType

String

Sharing status of the Audience list.

The allowed values are ALL, SHARED, NOT_SHARED, UNKNOWN.

The default value is ALL.

AudienceListContentCombinationAudienceListCombinationsAudienceLists

Retrieve the details of Audience list. The columns values set read-only false can be inserted in the parent table using Temp tables.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
AudienceListId supports the '=,IN'.
AudienceListType supports the '=,IN'.

For example:

SELECT * FROM AudienceListContentCombinationAudienceListCombinationsAudienceLists
SELECT * FROM AudienceListContentCombinationAudienceListCombinationsAudienceLists WHERE AccountId = '1234339'
SELECT * FROM AudienceListContentCombinationAudienceListCombinationsAudienceLists WHERE AccountId = '1234339' AND AudienceListId='1003039071'
SELECT * FROM AudienceListContentCombinationAudienceListCombinationsAudienceLists WHERE AccountId = '1234339' AND AudienceListId='1003039071' AND AudienceListType='DEFAULT_LIST'

Columns


Name	Type	References	Description
AudienceListId	Int64		Audience List ID.
AccountId	Int64	DisplayAdsAccounts.AccountId	Account ID.
AudienceListName	String		Audience List Names.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name

Type

Description

SharingStatusFilterType

String

sharing status of the target list.

The allowed values are ALL, SHARED, NOT_SHARED, UNKNOWN.

The default value is ALL.

AudienceListContentCombinationAudienceListRulesRuleConditions

Retrieve the details of AudienceList Rules RuleConditions. The columns values set read-only false can be inserted in the parent table using Temp tables.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
AudienceListId supports the '=,IN'.
AudienceListType supports the '=,IN'.

For example:

SELECT * FROM AudienceListContentCombinationAudienceListRulesRuleConditions
SELECT * FROM AudienceListContentCombinationAudienceListRulesRuleConditions WHERE AccountId = '1234339'
SELECT * FROM AudienceListContentCombinationAudienceListRulesRuleConditions WHERE AccountId = '1234339' AND AudienceListId='1003039071'
SELECT * FROM AudienceListContentCombinationAudienceListRulesRuleConditions WHERE AccountId = '1234339' AND AudienceListId='1003039071' AND AudienceListType='DEFAULT_LIST'

Columns


Name	Type	References	Description
AudienceListId	Int64		Audience List ID.
AccountId	Int64	DisplayAdsAccounts.AccountId	Account ID.
CompareOperator	String		Types of rule conditions. The allowed values are EQUAL, INCLUDED, START_WITH, END_WITH, NOT_EQUAL, NOT_INCLUDED, NOT_START_WITH, NOT_END_WITH, UNKNOWN.
RuleType	String		Type of the rule. The allowed values are URL, LABEL, REFERER_URL, PAGE_TYPE, ITEM_ID, ITEM_CATEGORY_ID, EVENT_TYPE, UNKNOWN.
Value	String		Matching Rules Value.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name

Type

Description

SharingStatusFilterType

String

sharing status of the target list.

The allowed values are ALL, SHARED, NOT_SHARED, UNKNOWN.

The default value is ALL.

AudienceListContentRuleAudienceListRules

Retrieve the details of ContentRuleAudience List Rules. The columns values set read-only false can be inserted in the parent table using Temp tables.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
AudienceListId supports the '=,IN'.
AudienceListType supports the '=,IN'.

For example:

SELECT * FROM AudienceListContentRuleAudienceListRules
SELECT * FROM AudienceListContentRuleAudienceListRules WHERE AccountId = '1234339'
SELECT * FROM AudienceListContentRuleAudienceListRules WHERE AccountId = '1234339' AND AudienceListId='1003039071'
SELECT * FROM AudienceListContentRuleAudienceListRules WHERE AccountId = '1234339' AND AudienceListId='1003039071' AND AudienceListType='DEFAULT_LIST'

Columns


Name	Type	References	Description
AudienceListId	Int64		Audience List ID.
AccountId	Int64	DisplayAdsAccounts.AccountId	Account ID.
RuleConditions	String		Displays the possible conditions to set for audience list. The field is required in ADD and SET operation.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name

Type

Description

SharingStatusFilterType

String

sharing status of the target list.

The allowed values are ALL, SHARED, NOT_SHARED, UNKNOWN.

The default value is ALL.

AudienceListContentSimilarityAudienceListAudienceListSizeReaches

Retrieve the details of each reaches of Audience list size. The columns values set read-only false can be inserted in the parent table using Temp tables.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
AudienceListId supports the '=,IN'.
AudienceListType supports the '=,IN'.

For example:

SELECT * FROM AudienceListContentSimilarityAudienceListAudienceListSizeReaches
SELECT * FROM AudienceListContentSimilarityAudienceListAudienceListSizeReaches WHERE AccountId = '1234339'
SELECT * FROM AudienceListContentSimilarityAudienceListAudienceListSizeReaches WHERE AccountId = '1234339' AND AudienceListId='1003039071'
SELECT * FROM AudienceListContentSimilarityAudienceListAudienceListSizeReaches WHERE AccountId = '1234339' AND AudienceListId='1003039071' AND AudienceListType='DEFAULT_LIST'

Columns


Name	Type	References	Description
AudienceListId	Int64		Audience List ID.
AccountId	Int64	DisplayAdsAccounts.AccountId	Account ID.
AudienceListSize	String		Size of similarity audience list. The allowed values are RATE_1, RATE_2, RATE_3, RATE_4, RATE_5, RATE_6, RATE_7, RATE_8, RATE_9, RATE_10, UNKNOWN.
Reach	Int64		Reaches of target list size.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name

Type

Description

SharingStatusFilterType

String

sharing status of the target list.

The allowed values are ALL, SHARED, NOT_SHARED, UNKNOWN.

The default value is ALL.

AudienceListContentWebsiteVisitorsAudienceListRules

Retrieve the details of ContentWebsiteVisitorsAudience List Rules. The columns values set read-only false can be inserted in the parent table using Temp tables.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
AudienceListId supports the '=,IN'.
AudienceListType supports the '=,IN'.

For example:

SELECT * FROM AudienceListContentWebsiteVisitorsAudienceListRules
SELECT * FROM AudienceListContentWebsiteVisitorsAudienceListRules WHERE AccountId = '1234339'
SELECT * FROM AudienceListContentWebsiteVisitorsAudienceListRules WHERE AccountId = '1234339' AND AudienceListId='1003039071'
SELECT * FROM AudienceListContentWebsiteVisitorsAudienceListRules WHERE AccountId = '1234339' AND AudienceListId='1003039071' AND AudienceListType='DEFAULT_LIST'

Columns


Name	Type	References	Description
AudienceListId	Int64		Audience List ID.
AccountId	Int64	DisplayAdsAccounts.AccountId	Account ID.
RuleConditions	String		Displays the possible conditions to set for audience list. The field is required in ADD and SET Operation.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name

Type

Description

SharingStatusFilterType

String

sharing status of the target list.

The allowed values are ALL, SHARED, NOT_SHARED, UNKNOWN.

The default value is ALL.

AudienceListContentWebsiteVisitorsAudienceListRulesRuleConditions

Retrieve the details of ContentWebsiteVisistorsAudienceList Rules RuleConditions. The columns values set read-only false can be inserted in the parent table using Temp tables.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
AudienceListId supports the '=,IN'.
AudienceListType supports the '=,IN'.

For example:

SELECT * FROM AudienceListContentWebsiteVisitorsAudienceListRulesRuleConditions
SELECT * FROM AudienceListContentWebsiteVisitorsAudienceListRulesRuleConditions WHERE AccountId = '1234339'
SELECT * FROM AudienceListContentWebsiteVisitorsAudienceListRulesRuleConditions WHERE AccountId = '1234339' AND AudienceListId='1003039071'
SELECT * FROM AudienceListContentWebsiteVisitorsAudienceListRulesRuleConditions WHERE AccountId = '1234339' AND AudienceListId='1003039071' AND AudienceListType='DEFAULT_LIST'

Columns


Name	Type	References	Description
AudienceListId	Int64		Audience List ID.
AccountId	Int64	DisplayAdsAccounts.AccountId	Account ID.
CompareOperator	String		Types of rule conditions. The allowed values are EQUAL, INCLUDED, START_WITH, END_WITH, NOT_EQUAL, NOT_INCLUDED, NOT_START_WITH, NOT_END_WITH, UNKNOWN.
RuleType	String		Type of the rule. The allowed values are URL, LABEL, REFERER_URL, PAGE_TYPE, ITEM_ID, ITEM_CATEGORY_ID, EVENT_TYPE, UNKNOWN.
Value	String		Matching Rules Value. The field is required in ADD and SET operation.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name

Type

Description

SharingStatusFilterType

String

sharing status of the target list.

The allowed values are ALL, SHARED, NOT_SHARED, UNKNOWN.

The default value is ALL.

BrandLifts

Get the BrandLift information.

Table Specific Information

SELECT

The Sync App 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 Sync App.

AccountId supports the '='.
BrandLiftId supports the '=,IN'.
ApprovalStatus supports the '=,IN'.
CampaignId supports the '=,IN'.

For example:

SELECT * FROM BrandLifts WHERE AccountId = '45896'

SELECT * FROM BrandLifts WHERE AccountId = '45896' AND BrandLiftId IN ('23534','45986')

SELECT * FROM BrandLifts WHERE AccountId = '45896'

SELECT * FROM BrandLifts WHERE AccountId = '45896' AND CampaignId IN ('48855')

Columns


Name	Type	References	Description
BrandLiftId [KEY]	Int64		Brand Lift ID.
AccountId	Int64	DisplayAdsAccounts.AccountId	Account ID.
ApprovalStatus	String		Approval status of survey information The allowed values are APPROVED, APPROVED_WITH_REVIEW, REVIEW, PRE_DISAPPROVED, POST_DISAPPROVED, UNKNOWN.
CampaignId	Int64	DisplayAdsCampaigns.CampaignId	Campaign ID.
CampaignName	String		Campaign Name.
CampaignStartDate	Date		Campaign Start Date.
DisapprovalReason	String		Disapproval Reason.
DisapprovalReasonCodes	String		Disapproval Reason Codes.
NotificationBusinessIds	String		Yahoo! JAPAN Business ID to send notifications.
Questions	String		Describes the brand lift survey contents.
ReviewCompleteDate	Datetime		Review Complete Date.
SubmitDate	Datetime		Submit Date.

BrandLiftsQuestions

Brand lift survey contents. The columns values set read-only false can be inserted in the parent table using Temp tables.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
BrandLiftId supports the '=,IN'.
ApprovalStatus supports the '=,IN'.
CampaignId supports the '=,IN'.

For example, the following queries are processed server side:

SELECT * FROM BrandLiftsQuestions WHERE AccountId = '1002504155'

SELECT * FROM BrandLiftsQuestions WHERE AccountId = '45896' AND BrandLiftId IN ('23534','45986')

SELECT * FROM BrandLiftsQuestions WHERE AccountId = '45896'

SELECT * FROM BrandLiftsQuestions WHERE AccountId = '45896' AND CampaignId IN ('48855')

Columns


Name	Type	References	Description
BrandLiftId	Int64		Brand Lift ID.
AccountId	Int64	DisplayAdsAccounts.AccountId	Account ID.
ApprovalStatus	String		Approval status of survey information The allowed values are APPROVED, APPROVED_WITH_REVIEW, REVIEW, PRE_DISAPPROVED, POST_DISAPPROVED, UNKNOWN.
CampaignId	Int64	DisplayAdsCampaigns.CampaignId	Campaign ID.
AnswerOption1	String		Answer Option1
AnswerOption2	String		Answer Option2
AnswerOption3	String		Answer Option3
AnswerOption4	String		Answer Option4
AnswerOption5	String		Answer Option5
Goal	String		Survey Goal.
PreApproveId	String		Preapprove ID.
Question	String		Question
QuestionId	Int64		Question ID.

BusinessCategories

Get the list of business category

Table Specific Information

SELECT

For example:

SELECT * FROM BusinessCategories;

Columns


Name	Type	References	Description
BusinessCategoryId [KEY]	String		Business category ID.
BusinessCategoryName	String		Business category name.

CampaignMigrations

Get the migration status.

Table Specific Information

SELECT

The Sync App 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 Sync App.

AccountId supports the '='.
MigrationJobId supports the '=,IN'.

For example:

SELECT * FROM CampaignMigrations WHERE AccountId = '1002504155'

SELECT * FROM CampaignMigrations WHERE AccountId = '1002504155' AND MigrationJobId = '12345'

Columns


Name	Type	References	Description
MigrationJobId [KEY]	Int64		Migration job ID.
AccountId	Int64	DisplayAdsAccounts.AccountId	Account ID.
FailedCount	Int64		Number of failed campaigns.
InProgressCount	Int64		Number of progressing campaigns.
JobStatus	String		Object indicates migration job status. The allowed values are NOT_STARTED, IN_PROGRESS, COMPLETED, FILE_FORMAT_ERROR, INVALID_CSV_VALUE_ERROR, UNKNOWN_CSV_FIELD_ERROR, SYSTEM_ERROR, UNKNOWN.
MigrationJobEndDate	Date		Migration job end date.
MigrationJobSubmitDate	Date		Migration job submit date.
Scope	String		Campaign scope to be migrated. The allowed values are SINGLE_ACCOUNT, ALL_ACCOUNT, UNKNOWN.
SucceededCount	Int64		Number of completed campaigns.
TotalCount	Int64		Number of total campaigns.

ContentsKeywordIdea

Retrieves the keyword for contents targeting.

Table Specific Information

SELECT

SELECT * FROM ContentsKeywordIdea

Columns


Name	Type	References	Description
ContentsKeyword	String		Contents keyword.
ContentsKeywordId	Integer		Contents keyword ID.
CreatedDate	String		Created date of keyword.
Volume	Integer		Number of impressions.

ContentsKeywordListsContentsKeyword

Get the contents keyeord list

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
ContentsKeywordListId supports the '=,IN'.

For example:

SELECT * FROM ContentsKeywordListsContentsKeyword WHERE AccountId = '1002504155'

SELECT * FROM ContentsKeywordListsContentsKeyword WHERE ContentsKeywordListId ='1000010795'

Columns


Name	Type	References	Description
AccountId	Int64	DisplayAdsAccounts.AccountId	Account ID.
ContentsKeywordId [KEY]	Integer		Contents keyword ID.This field is required in ADD and SET operation.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
ContentsKeywordListId	Integer		Contents keyword list ID.

ConversionGroupConversions

Get ConversionGroup information of specified account

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
ConversionGroupId supports the '='.
ConversionGroupName supports the '='.
ConversionTrackerId supports the '='.

For example:

SELECT * FROM ConversionGroupConversions WHERE AccountId = '1002504155'

SELECT * FROM ConversionGroupConversions WHERE ConversionGroupId ='1000010795'

SELECT * FROM ConversionGroupConversions WHERE ConversionGroupName ='test'

SELECT * FROM ConversionGroupConversions WHERE ConversionTrackerId ='1000010795'

Columns


Name	Type	References	Description
ConversionTrackerId [KEY]	Int64	DisplayAdsConversionTrackers.ConversionTrackerId	Conversion Tracker ID
AccountId	Int64	DisplayAdsAccounts.AccountId	Account ID.
ConversionTagId	Int64		Conversion Tag ID
ConversionTagName	String		Conversion Tag Name
ConversionTrackerType	String		Conversion type.This field is required in requests The allowed values are WEB_CONVERSION, APP_CONVERSION, UNKNOWN.
Status	String		ConversionTracker status.This field is required in ADD operation, and will be optional in SET operation. The allowed values are ENABLED, DISABLED, UNKNOWN.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
ConversionGroupId	Int64		Conversion Group ID.
ConversionGroupName	String		Conversion Group Name.

DisplayAdsAccountLinks

Get the account link information.

Table Specific Information

SELECT

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

ManagerAccountId supports the '='.

For example:

SELECT * FROM DisplayAdsAccountLinks WHERE ManagerAccountId = '1002513173'

Columns


Name	Type	References	Description
ManagerAccountId [KEY]	Int64		MCC Account ID.
AccountId	Int64	DisplayAdsAccounts.AccountId	Account ID.
LinkAccessPermission	String		Account link access permission.
OwnerShipType	String		Describes whether the linked account is an account within the same company.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
AccountStatus	String		Account registration status
RetargetingListSharingEnabled	String		Describes whether the link is valid for the sharing of retargeting list. The allowed values are TRUE, FALSE, UNKNOWN.

DisplayAdsAdGroupAdCarouselAdCarousels

Retrieve the information of carousel ad.

Table Specific Information

Select

The Sync App 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 The rest of the filter is executed client side within the Sync App.

AdGroupId supports the '=,IN'.
AccountId supports the '='.
CampaignId supports the '=,IN'.
UserStatus supports the '=,IN'.
CampaignGoalFilterType supports the '='.
ContainsLabelIdFlg supports the '='.
LabelId supports the '=,IN'.
StartDate supports the '='.
EndDate supports the '='.

For example:

SELECT * FROM DisplayAdsAdGroupAdCarouselAdCarousels WHERE AccountId = '1002504155'

SELECT * FROM DisplayAdsAdGroupAdCarouselAdCarousels WHERE AccountId = '1002504155' AND AdGroupId = '437264177'

Columns


Name	Type	References	Description
AdId	Int64		Ad ID
AccountId	Int64	DisplayAdsAccounts.AccountId	Account ID
AdGroupId	Int64	DisplayAdsAdGroups.AdGroupId	Ad group ID
ApprovalStatus	String		Editorial status The allowed values are APPROVED, APPROVED_WITH_REVIEW, REVIEW, PRE_DISAPPROVED, POST_DISAPPROVED, UNKNOWN.
CampaignId	Int64	DisplayAdsCampaigns.CampaignId	Campaign ID
UserStatus	String		Delivery status that can be set by an user The allowed values are ACTIVE, PAUSED, UNKNOWN.
Description	String		Ad description.This field is required in SET operation,
DisapprovalReasonCodes	String		Reject reason on editorial review.
DisplayOrder	Int64		Carousel display order.If not specified, it will be set automatically.
Headline	String		Ad title.This field is requred in ADD and SET operation.
MediaId	Int64	Media.MediaId	Media ID
Url	String		Destination URL.This field is requred in ADD and SET operation.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
CampaignGoalFilterType	String		Setting for filtering campaigns (with campaignGoal) or (with no campaignGoal). The allowed values are ALL, NON_GOAL, UNKNOWN. The default value is ALL.
ContainsLabelIdFlg	String		Flag of contains label ID.
LabelId	String		Label ID.
StartDate	Date		start date of the search target period.Format: yyyy-MM-dd.
EndDate	Date		This is the end date of the search target period.Format: yyyy-MM-dd.

DisplayAdsAdGroupAdServiceLabels

Retrieve the details of AdGroupAdService Labels. The columns values set read-only false can be inserted in the parent table using Temp tables

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
AdGroupId supports the '=,IN'.
AdId supports the '=,IN'.
ApprovalStatus supports the '=,IN'.
CampaignId supports the '=,IN'.
MediaId supports the '=,IN'.
UserStatus supports the '=,IN'.
CampaignGoalFilterType supports the '='.
ContainsLabelIdFlg supports the '='.
LabelId supports the '=,IN'.
StartDate supports the '='.
EndDate supports the '='.

For example:

SELECT * FROM DisplayAdsAdGroupAdServiceLabels WHERE AccountId = '125466'

SELECT * FROM DisplayAdsAdGroupAdServiceLabels WHERE AccountId = '123436' AND AdId IN ('4561','6996')
     
SELECT * FROM DisplayAdsAdGroupAdServiceLabels WHERE AccountId = '123436' AND ApprovalStatus IN ('APPROVED','APPROVED_WITH_REVIEW')

SELECT * FROM DisplayAdsAdGroupAdServiceLabels WHERE AccountId = '123436' AND MediaId IN ('12644','325687') AND UserStatus IN ('ACTIVE')

SELECT * FROM DisplayAdsAdGroupAdServiceLabels WHERE AccountId = '123436' AND CampaignGoalFilterType = 'ALL'

SELECT * FROM DisplayAdsAdGroupAdServiceLabels WHERE AccountId = '123436' AND ContainsLabelIdFlg = 'True' AND LabelId IN ('5697122')

SELECT * FROM DisplayAdsAdGroupAdServiceLabels WHERE AccountId = '123436' AND StartDate = '2021-06-03' AND EndDate = '2021-06-28'

Columns


Name	Type	References	Description
LabelId [KEY]	Int64		Label ID.
AdId	Int64		Ad ID
AccountId	Int64	DisplayAdsAccounts.AccountId	Account ID
AdGroupId	Int64	DisplayAdsAdGroups.AdGroupId	Ad group ID
ApprovalStatus	String		Editorial status The allowed values are APPROVED, APPROVED_WITH_REVIEW, REVIEW, PRE_DISAPPROVED, POST_DISAPPROVED, UNKNOWN.
CampaignId	Int64	DisplayAdsCampaigns.CampaignId	Campaign ID
MediaId	Int64	Media.MediaId	Media ID
UserStatus	String		Delivery status that can be set by an user The allowed values are ACTIVE, PAUSED, UNKNOWN.
Color	String		Color.
Description	String		Description
LabelName	String		Label Name

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
CampaignGoalFilterType	String		Setting for filtering campaigns (with campaignGoal) or (with no campaignGoal). The allowed values are ALL, NON_GOAL, UNKNOWN. The default value is ALL.
ContainsLabelIdFlg	String		Flag of contains label ID.
StartDate	Date		start date of the search target period.
EndDate	Date		This is the end date of the search target period.

DisplayAdsAdGroupServiceLabels

Retrieve the details of AdGroup Labels. The columns values set read-only false can be inserted in the parent table using Temp tables.

Table Specific Information

Select

The Sync App 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 The rest of the filter is executed client side within the Sync App.

AdGroupId supports the '=,IN'.
AccountId supports the '='.
CampaignId supports the '=,IN'.
UserStatus supports the '=,IN'.
CampaignGoalFilterType supports the '='.
ContainsLabelIdFlg supports the '='.
LabelId supports the '=,IN'.
StartDate supports the '='.
EndDate supports the '='.

For example:

SELECT * FROM DisplayAdsAdGroupServiceLabels WHERE AccountId = '1002504155'

SELECT * FROM DisplayAdsAdGroupServiceLabels WHERE AccountId = '1002504155' AND AdGroupId = '437264177'

Columns


Name	Type	References	Description
LabelId [KEY]	Int64	DisplayAdsLabels.LabelId	Label ID.
AdGroupId	Int64	DisplayAdsLabels.AdGroupId	Ad group ID.
AccountId	Int64	DisplayAdsAccounts.AccountId	Account ID.
CampaignId	Int64	DisplayAdsCampaigns.CampaignId	Campaign ID.
FeedSetId	Int64	FeedSets.FeedSetId	Feed set ID.If feedSetId is not specified in ADD operation, the default set is associated automatically
UserStatus	String		Ad delivery status that can be set by an user.This field is required in ADD operation The allowed values are ACTIVE, PAUSED, UNKNOWN.
Color	String		Color.
Description	String		Description
LabelName	String		Label Name

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
CampaignGoalFilterType	String		Setting for filtering campaigns (with campaignGoal) or (with no campaignGoal). The allowed values are ALL, NON_GOAL, UNKNOWN. The default value is ALL.
ContainsLabelIdFlg	String		Flag of contains label ID.
StartDate	Date		This is the start date of the search target period.
EndDate	Date		This is the end date of the search target period.

DisplayAdsBalance

Get the account balance.

Table Specific Information

SELECT

The Sync App 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 Sync App.

AccountId supports the '='.

For example:

SELECT * FROM DisplayAdsBalance WHERE AccountId = '1002504155'

Columns


Name	Type	References	Description
AccountId	Int64	DisplayAdsAccounts.AccountId	The account ID.
Balance	Int64		The balance.

DisplayAdsCampaignServiceLabels

Retrieve the details of DisplayAdsCampaign Labels. The columns values set read-only false can be inserted in the parent table using Temp tables.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
CampaignId supports the '=,IN'.
EndDate supports the '='.
FeedId supports the '=,IN'.
StartDate supports the '='.
UserStatus supports the '=,IN'.
CampaignGoalFilterType supports the '='.
CampaignType supports the '='.
ContainsLabelIdFlg supports the '='.
LabelId supports the '=,IN'.

For example:

SELECT * FROM DisplayAdsCampaignServiceLabels WHERE AccountId = '1002504155'

SELECT * FROM DisplayAdsCampaignServiceLabels WHERE AccountId = '1002504155' AND CampaignId = '30799754'

SELECT * FROM DisplayAdsCampaignServiceLabels WHERE AccountId = '1002504155' AND LabelId = '1000158197'

Columns


Name	Type	References	Description
LabelId [KEY]	Int64		Label ID
CampaignId	Int64		Campaign ID.
AccountId	Int64	DisplayAdsAccounts.AccountId	Account ID
StartDate	Date		Start date. Format: yyyy-MM-dd.
EndDate	Date		End date. Format: yyyy-MM-dd.
UserStatus	String		ad delivery status that can be set by an user The allowed values are ACTIVE, PAUSED, UNKNOWN.
FeedId	Int64		Feed ID.If adType is Dynamic Ads for Display, this field is required in ADD operation
Color	String		Color.
Description	String		Description
LabelName	String		Label Name

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
CampaignGoalFilterType	String		Campaigns with campaignGoal or with no campaignGoal The allowed values are ALL, NON_GOAL, GOAL, UNKNOWN. The default value is ALL.
CampaignType	String		Type of campaign The allowed values are STANDARD, APP, UNKNOWN.
ContainsLabelIdFlg	Boolean		Flag of contains label ID

DisplayAdsConversionTrackerWebConversionSnippets

Retrieve the details of tracking script information of Web Conversion Tracker. The columns values set read-only false can be inserted in the parent table using Temp tables.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
AppConversionAppConversionPlatform supports the '='.
AppConversionAppId supports the '=,IN'.
Category supports the '=,IN'.
ConversionTrackerId supports the '=,IN'.
ConversionTrackerType supports the '=,IN'.
CountingType supports the '='.
ExcludeFromBidding supports the '='.
Status supports the '=,IN'.
StatsEndDate supports the '='.
StatsStartDate supports the '='.
StatsPeriod supports the '='.

For example:

SELECT * FROM DisplayAdsConversionTrackerWebConversionSnippets WHERE AccountId = '1002504155'

SELECT * FROM DisplayAdsConversionTrackerWebConversionSnippets WHERE AccountId = '1002504155' AND ConversionTrackerId = '1307071'

Columns


Name	Type	References	Description
AccountId	Int64	DisplayAdsAccounts.AccountId	Account ID.
ConversionTrackerId	Int64		Conversion Tracker ID.
AppConversionPlatform	String		Target platform of the app conversion. The allowed values are ITUNES, ANDROID_MARKET, UNKNOWN.
AppId	String		App ID of the object to be tracked.
Category	String		Category for ConversionTracker The allowed values are NONE, DEFAULT, PAGE_VIEW, PURCHASE, SIGNUP, LEAD, DOWNLOAD, UNKNOWN.
ConversionTrackerType	String		Conversion type. The allowed values are WEB_CONVERSION, APP_CONVERSION, UNKNOWN.
CountingType	String		conversion measurement method The allowed values are ONE_PER_CLICK, MANY_PER_CLICK, UNKNOWN.
ExcludeFromBidding	String		use or not for auto bidding. The allowed values are FALSE, TRUE, UNKNOWN. The default value is FALSE.
Status	String		ConversionTracker status The allowed values are ENABLED, DISABLED, UNKNOWN.
AdvancedTag	String		The new format of conversion tag avoids the impacts such as changes made to the browser.
Tag	String		Previous tag of Conversion.
WebConversionSnippetType	String		Type of tracking script. The allowed values are IMG, JS, UNKNOWN.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
StatsEndDate	Date		Acquisition end date of stats information.
StatsStartDate	Date		Acquisition start date of stats information.
StatsPeriod	String		summarized period of statistics The allowed values are DEFINITE_VALUE_YESTERDAY, DEFINITE_VALUE_LASTBSDAY, DEFINITE_VALUE_LASTWEEK, DEFINITE_VALUE_WEEK, DEFINITE_VALUE_TWOWEEK, DEFINITE_VALUE_THIRTYDAY, DEFINITE_VALUE_LASTMONTH, REALTIME_TODAY, REALTIME_MONTH, DEFINITE_VALUE_LAST13MONTH, CUSTOM_DATE, UNKNOWN.

DisplayAdsDisapprovalReasons

Get the list of response from recommendation with EditorialReason.

Table Specific Information

SELECT

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

Lang supports the '='.

For example:

SELECT * From DisplayAdsDisapprovalReasons WHERE Lang = 'EN'

Columns


Name	Type	References	Description
Description	String		Description of disapproval reason.
DisapprovalReasonCode	String		Disapproval reason code.
Lang	String		Language selection of the list. The allowed values are EN, JA, UNKNOWN.
Recommendation	String		Description of recommendation
Title	String		Title of disapproval reason.

DisplayAdsGeographicLocations

Get the information list of geo targeting.

Table Specific Information

Select

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

GeographicLocationType supports the '='.
Lang supports the '='.

For example:

SELECT * From DisplayAdsGeographicLocations WHERE Lang = 'EN'

SELECT * FROM DisplayAdsGeographicLocations WHERE Lang = 'EN' AND GeographicLocationType = 'TARGETING'

Columns


Name	Type	References	Description
Child	String		undefined.
Code	String		Geographic code.The 'Other' geo code (TC-CI-00000073) is not available for geo targeting.
FullName	String		Name of places (Prefecture and all).
Name	String		Name of places (City Only).
Order	String		Order of list.
Parent	String		Parent geographic code.
Lang	String		A language selection of the list. The allowed values are JA, EN, UNKNOWN.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
GeographicLocationType	String		Describes the type of location information. The allowed values are TARGETING, FEED, UNKNOWN.

DisplayAdsReportFields

Retrieve the available report fields for a given report type.

Table Specific Information

Select

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

ReportType supports the '='.

For example:

SELECT * FROM DisplayAdsReportFields WHERE ReportType = 'ACCOUNT'

Columns


Name	Type	References	Description
DisplayFieldNameEN	String		Field Name for the Downloaded Report (EN).
DisplayFieldNameJA	String		Field Name for the Downloaded Report (JA).
FieldName	String		Field Name.
FieldType	String		Field type (number, string, ENUM, etc.)
Filterable	Boolean		Whether the field filter can be specified or not (true: Filter can be specified).
XmlAttributeName	String		XML attribute for the Downloaded Report
ImpossibleCombinationFields	String		Invalid field combinations.
ReportType	String		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. The allowed values are AD, AUDIENCE_CATEGORY, CONVERSION_PATH, CROSS_CAMPAIGN_REACHES, SITE_RETARGETING, SEARCH_TARGET, PLACEMENT_TARGET, LABEL, SITE_CATEGORY, REACH, URL, UNKNOWN.

DisplayAdsReportFilters

Retrieve the details of filtering report conditions. The columns values set read-only false can be inserted in the parent table using Temp tables.

Table Specific Information

Select

The Sync App 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 Sync App.

ReportJobId supports the '=,IN'.
ReportJobStatus supports the '=,IN'.
AccountId supports the '='.

For example:

SELECT * FROM DisplayAdsReportFilters WHERE AccountId = '123436'

Columns


Name	Type	References	Description
ReportJobId	Int64		Report Job ID.
ReportJobStatus	String		The process status for the defined report. The allowed values are WAIT, COMPLETED, IN_PROGRESS, FAILED, UNKNOWN.
AccountId	Int64	DisplayAdsAccounts.AccountId	Account ID.
Field	String		Field to be filtered.
FilterOperator	String		Operator to be specified by filter. The allowed values are NOT_EQUALS, CONTAINS_ANY, EQUALS, GREATER_THAN_EQUALS, LESS_THAN_EQUALS, GREATER_THAN, LESS_THAN, CONTAINS, IN, CONTAINS_ALL, UNKNOWN.
Values	String		Value for condition.

DisplayAdsReportReportTypeConditionConversionPathAccountSettingSubAccounts

Retrieve the details of account and its product type. The columns values set read-only false can be inserted in the parent table using Temp tables.

Table Specific Information

Select

The Sync App 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 Sync App.

ReportJobId supports the '=,IN'.
ReportJobStatus supports the '=,IN'.
AccountId supports the '='.

For example:

SELECT * FROM DisplayAdsReportReportTypeConditionConversionPathAccountSettingSubAccounts WHERE AccountId = '123436'

Columns


Name	Type	References	Description
ReportJobId	Int64		Report Job ID.
ReportJobStatus	String		The process status for the defined report. The allowed values are WAIT, COMPLETED, IN_PROGRESS, FAILED, UNKNOWN.
AccountId	Int64	DisplayAdsAccounts.AccountId	Account ID.
ProductType	String		Product type of the account. The allowed values are YDA, YSA, UNKNOWN.

DisplayAdsReportReportTypeConditionConversionPathFilters

Retrieve the details of flag which indicates whether to include view interaction in Conversion Path Report.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.

For example, the following queries are processed server side:

SELECT * FROM DisplayAdsReportReportTypeConditionConversionPathFilters WHERE  AccountId='25687';

Columns


Name	Type	References	Description
AccountId	Int64	DisplayAdsAccounts.AccountId	Account ID.
ConversionPathFilterOperator	String		Indicates the filter condition item of Conversion Path Report. The allowed values are EQUALS, NOT_EQUALS, CONTAINS, NOT_CONTAINS, START_WITH, END_WITH, UNKNOWN.
ConversionPathFilterType	String		Indicates the filter condition item of Conversion Path Report. The allowed values are CAMPAIGN_ID, CAMPAIGN_NAME, CAMPAIGN_ID, UNKNOWN.
Values	String		Condition value. If multiple values are specified, the condition will be 'OR'.

DisplayAdsReportReportTypeConditionCrossCampaignReachesReportConditionCrossCampaignGoals

Retrieve the details of account and campaign goal that is subject to Cross-campaign Reach Report combination.

Table Specific Information

Select

The Sync App 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 Sync App.

ReportJobId supports the '=,IN'.
ReportJobStatus supports the '=,IN'.
AccountId supports the '='.

For example:

SELECT * FROM DisplayAdsReportReportTypeConditionCrossCampaignReachesReportConditionCrossCampaignGoals WHERE AccountId = '123436'

Columns


Name	Type	References	Description
ReportJobId	Int64		Report Job ID.
ReportJobStatus	String		The process status for the defined report. The allowed values are WAIT, COMPLETED, IN_PROGRESS, FAILED, UNKNOWN.
AccountId	Int64	DisplayAdsAccounts.AccountId	Account ID.
AccountproductType	String		Product type of the account. The allowed values are YDA, YSA, UNKNOWN.
CampaignGoal	String		Combination of Cross-campaign Reach Report. If crossCampaignReachType is CAMPAIGN_GOAL, this field is required in ADD operation. If you specify BRAND_AWARENESS, (Auction: Brand awareness) and (Guaranteed: Brand awareness) will be targeted. BRAND_AWARENESS_GUARANTEED cannot be specified.

DisplayAdsReportReportTypeConditionCrossCampaignReachesReportConditionCrossCampaignIds

Retrieve the details of condition to create each report type

Table Specific Information

Select

The Sync App 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 Sync App.

ReportJobId supports the '=,IN'.
ReportJobStatus supports the '=,IN'.
AccountId supports the '='.

For example:

SELECT * FROM DisplayAdsReportReportTypeConditionCrossCampaignReachesReportConditionCrossCampaignIds WHERE AccountId = '123436'

Columns


Name	Type	References	Description
ReportJobId	Int64		Report Job ID.
ReportJobStatus	String		The process status for the defined report. The allowed values are WAIT, COMPLETED, IN_PROGRESS, FAILED, UNKNOWN.
AccountId	Int64	DisplayAdsAccounts.AccountId	Account ID.
AccountproductType	String		Product type of the account. The allowed values are YDA, YSA, UNKNOWN.
CampaignId	Int64		Campaign ID that is subject to combination of Cross-campaign Reach Report. If crossCampaignReachType is CAMPAIGN_ID, this field is required in ADD operation.

DisplayAdsReportSortFields

Retrieve the sort details of report definition. The columns values set read-only false can be inserted in the parent table using Temp tables.

Table Specific Information

Select

The Sync App 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 Sync App.

ReportJobId supports the '=,IN'.
ReportJobStatus supports the '=,IN'.
AccountId supports the '='.

For example:

SELECT * FROM DisplayAdsReportSortFields WHERE AccountId = '123436'

Columns


Name	Type	References	Description
ReportJobId	Int64		Report Job ID.
ReportJobStatus	String		The process status for the defined report. The allowed values are WAIT, COMPLETED, IN_PROGRESS, FAILED, UNKNOWN.
AccountId	Int64	DisplayAdsAccounts.AccountId	Account ID.
Field	String		Field of report definition.
ReportSortType	String		Sort condition type. The allowed values are ASC, DESC, UNKNOWN.

DisplayAdsReportTypeConditionCrossCampaignBuyingTypes

Retrieve the details of Condition to create Cross-campaign Reach Report. The columns values set read-only false can be inserted in the parent table using Temp tables.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.

For example, the following queries are processed server side:

SELECT * FROM DisplayAdsReportTypeConditionCrossCampaignBuyingTypes  WHERE  AccountId='25687';

Columns


Name	Type	References	Description
ReportJobId	Int64		Report Job ID.
ReportJobStatus	String		The process status for the defined report. The allowed values are WAIT, COMPLETED, IN_PROGRESS, FAILED, UNKNOWN.
AccountId	Int64	DisplayAdsAccounts.AccountId	Account ID.
ProductType	String		Product type of the account The allowed values are YDA, YSA, UNKNOWN.
CampaignBuyingType	String		Indicates the campaign purchase type that is subject to combination of Cross-campaign Reach Report. If crossCampaignType is CAMPAIGN_BUYING_TYPE, this field is required in ADD operation. The allowed values are AUCTION, GUARANTEED, UNKNOWN.

FeedData

Get the status of uploaded item list.

Table Specific Information

SELECT

The Sync App 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 Sync App.

AccountId supports the '='.
FeedId supports the '=,IN'.
FileUploadStatus supports the '=,IN'.
ItemListUploadId supports the '=,IN'.
StartDate supports the '='.
EndDate supports the '='.

For example, the following queries are processed server side:

SELECT * FROM FeedData WHERE AccountId='96473'

Columns


Name	Type	References	Description
FeedId [KEY]	Int64		Feed ID.
AccountId	Int64	DisplayAdsAccounts.AccountId	Account ID.
CompleteDate	Date		Complete Date.
ErrorCount	Int64		Number od item list with error.
ErrorRate	String		Error rate.
FileUploadSrc	String		Displays source of item list upload. The allowed values are CAMPAIGN_MANAGEMENT_TOOL, API, FTP_SCHEDULE, FTP_DIRECT, UNKNOWN.
FileUploadStatus	String		Displays status of file upload. The allowed values are UPLOADED, COMPLETED, FILE_FORMAT_ERROR, SYSTEM_ERROR, NETWORK_ERROR, FILE_NOT_FOUND_ERROR, FILE_SIZE_OVER_ERROR, AUTH_ERROR, UPLOAD_COUNT_OVER_ERROR, NOT_MODIFIED, UNKNOWN.
IsDebug	Boolean		true means to run in debug mode.
ItemListUploadId	Int64		Uploaded item list ID.
ItemListUploadType	String		Displays upload type of item list. The allowed values are UPDATE_PART, UPDATE_ALL, UNKNOWN.
UploadDate	Date		Upload date.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
StartDate	Date		Start date.
EndDate	Date		End date.

FeedItemGoogleProductCategories

Get Google product category that can be specified for Feed item information.

Table Specific Information

SELECT

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

Lang supports the '='.

For example:

SELECT * FROM FeedItemGoogleProductCategories WHERE Lang='JA';

Columns


Name	Type	References	Description
Id [KEY]	String		Google Product Category ID.
Child	String		Object is used.
FullName	String		Name of Google Product Category including parent.
Name	String		Name of Google Product Category.
Order	String		Number that indicates the sequence.
Parent	String		Parent Google Product Category ID.
Lang	String		A language selection of the list. The allowed values are EN, JA, UNKNOWN.

FeedSetConditionSets

Retrieve the details of Conditions of Item Set information. The columns values set read-only false can be inserted in the parent table using Temp tables.

Table Specific Information

Select

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

AccountId supports the '='.
FeedId supports the '='.
FeedSetId supports the '=,IN'.
IncludeItemCount supports the '='.

For example:

SELECT * FROM FeedSetConditionSets WHERE AccountId = '1002504155' AND FeedId = '1132453'

Columns


Name	Type	References	Description
AccountId	Int64	DisplayAdsAccounts.AccountId	Account ID.
FeedSetId	Int64		Item Set ID.
FeedId	Int64	DisplayAdsFeeds.FeedId	Feed ID.
ConditionType	String		Type of items available for condition of Item Set. The allowed values are CATEGORY_ID, STOCK_QUANTITY, PRICE, SALE_PRICE, RATING, REVIEWS, BADGE, AGE_GROUP, AVAILABILITY_DATE, GENDER_GROUP, GOOGLE_PRODUCT_CATEGORY, LOCATION, SALES_RANK, UNKNOWN.
OrConditions	String		Conditional retrieval of feedset information.
IncludeItemCount	Boolean		number of items of Item Set.

FeedSetConditionSetsOrCondition

Retrieve the details of Conditions of Item Set information. The columns values set read-only false can be inserted in the parent table using Temp tables.

Columns


Name	Type	References	Description
AccountId	Int64	DisplayAdsAccounts.AccountId	Account ID.
FeedSetId	Int64		Item Set ID.
FeedId	Int64	DisplayAdsFeeds.FeedId	Feed ID.
CompareOperator	String		Setting conditions of Item Set The allowed values are EQUAL, NOT_EQUAL, GREATER_THAN_EQUALS, LESS_THAN_EQUALS, UNKNOWN.
Value	String		Value.
IncludeItemCount	Boolean		number of items of Item Set.

GetUploadUserListStatus

Get the upload status of the user list.

Table Specific Information

SELECT

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

UploadJobId supports the '=,IN'.
JobStatus supports the '=,IN'.
AudienceListId supports the '='.
AccountId supports the '='.

For example:

SELECT * FROM GetUploadUserListStatus WHERE AccountId = '25647' AND AudienceListId = '25647'

Columns


Name	Type	References	Description
UploadJobId [KEY]	String		Upload job ID.
JobStatus	String		Status of the upload job .The user list will usually be reflected within a few hours after the status becomes RECEIVED.If the status is INVALID_FILE, there is a problem with the file contents, the file format is incorrect, or the file size exceeds the upper limit (1,073,741,824 bytes).If the status is FAILED, it means that the job did not complete successfully due to a problem other than the file contents. The allowed values are RECEIVING, RECEIVED, INVALID_FILE, FAILED, UNKNOWN.
ReceivedDate	Datetime		Job completion date and time.
AudienceListId	Int64	AudienceLists.AudienceListId	Audience list ID.
UploadSubmitDate	Datetime		Upload date and time.
UploadType	String		Kind of upload method. The allowed values are IDFA, AAID, MAIL_ADDRESS, UNKNOWN.
AccountId	Int64		Account ID.

GuaranteedAdGroupAdGroupTargets

Retrieve the targeting information specified in ad group.This object is required if you are adding ad group via GuaranteedAdGroupService. The columns values set read-only false can be inserted in the parent table using Temp tables.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
AdGroupId supports the '=,IN'.
CampaignId supports the '=,IN'.
ContainsLabelIdFlg supports the '='.
LabelId supports the '=,IN'.

For example, the following queries are processed server side:

SELECT * FROM GuaranteedAdGroupAdGroupTargets WHERE AccountId = '123436'

Columns


Name	Type	References	Description
AccountId	Int64	DisplayAdsAccounts.AccountId	Account ID.
AdGroupId	Int64	GuaranteedAdGroups.AdGroupId	Ad group ID
BidMultiplier	String		Bid adjustment
CampaignId	Int64	DisplayAdsCampaigns.CampaignId	Campaign ID.
AdScheduleTargetDayOfWeek	String		days of the week for delivery. The allowed values are MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY, UNKNOWN.
AdScheduleTargetEndHour	Int64		End time (hour only).
AdScheduleTargetStartHour	Int64		Start time (hour only).
AgeTargetAge	String		Ages The allowed values are GT_RANGE13_14, GT_RANGE15_17, GT_RANGE20_21, GT_RANGE30_39, GT_RANGE50_59, GT_RANGE70_UL, GT_RANGE15_19, GT_RANGE20_24, GT_RANGE25_29, GT_RANGE30_34, GT_RANGE40_44, GT_RANGE50_54, GT_RANGE60_64, GT_RANGE65_69, GT_RANGE70_UL2, GT_UNKNOWN2, UNKNOWN.
AgeTargetEstimateFlg	String		Advance delivery setting. The allowed values are PAUSED, ACTIVE, UNKNOWN.
AppTargetDeviceAppType	String		Application types for devices. The allowed values are APP, WEB, UNKNOWN.
AudienceCategoryTargetAudienceCategoryType	String		Category type
AudienceCategoryTargetCategoryNameEn	String		Category name (English).
AudienceCategoryTargetCategoryNameJa	String		Category name (Japanese).
DeviceTargetDeviceType	String		Types of devices to be posted on. The allowed values are DESKTOP, WAP_MOBILE, SMARTPHONE, TABLET, UNKNOWN.
GenderTargetEstimateFlg	String		Advance delivery setting The allowed values are PAUSED, ACTIVE, UNKNOWN.
GenderTargetGender	String		Types of Genders The allowed values are ST_MALE, ST_FEMALE, ST_UNKNOWN, UNKNOWN.
GeoTargetGeoNameEn	String		Region name (English).
GeoTargetGeoNameJa	String		Region name (Japanese).
GeoTargetGeoAreaSearchType	String		Displays types of regional search
GeoTargetGeoLatitudeInMicroDegrees	String		Micro degrees for the latitude
GeoTargetGeoLongitudeInMicroDegrees	String		Micro degrees for the longitude
GeoTargetGeoRadius	String		Radius(km)
InterestCategoryTargetCategoryFullNameEn	String		Interest category name (English).
InterestCategoryTargetCategoryFullNameJa	String		Interest category name (Japanese).
IsRemove	Boolean		If true, delete all targeting types.
OsTargetDeviceOsType	String		OS types for devices to be posted on. The allowed values are IOS, ANDROID, UNKNOWN.
OsVersionTargetOsVersion	String		OS version.
PlacementCategoryTargetPlacementCategoryListName	String		Placement category list name.
PlacementTargetPlacementUrlListName	String		Placement List Name.
PlacementTargetPlacementUrlListType	String		Type of Placement URL list. The allowed values are WHITE_LIST, BLACK_LIST, UNKNOWN.
PositionTargetPositionType	String		Types of the instream video ads. The allowed values are INSTREAM_PREROLL, INSTREAM_MIDROLL, INSTREAM_POSTROLL.
SearchTargetSearchKeywordListName	String		Search Keyword List name.
SiteCategoryTargetCategoryFullNameEn	String		Site category name (English).
SiteCategoryTargetCategoryFullNameJa	String		Site category name (Japanese).
AudienceListTargetDeliverType	String		AdGroupTargetServiceDeliverType describes whether the subjected targeting setting is delivery target or excluded from delivery target. The allowed values are INCLUDE, EXCLUDE, UNKNOWN.
AudienceListTargetAudienceListName	String		Audience List name.
AudienceListTargetAudienceListType	String		Type of audience list. The allowed values are DEFAULT_LIST, RULE, COMBINATION, SIMILARITY, CUSTOM_AUDIENCE, WEBSITE_VISITORS, CUSTOMER_DATA, OFFERED_BY_YAHOO_JAPAN, UNKNOWN.
SiteRetargetingTargetTargetListDeliverType	String		Type of target list type. The allowed values are INCLUDE, EXCLUDE, UNKNOWN.
SiteRetargetingTargetTargetListName	String		Target List name.
PlacementCategoryType	String		Region name (English).
PlacementCategoryNameEn	String		Region name (Japanese).
PlacementCategoryNameJa	String		Displays types of regional search
ContentsTargetDeliverType	String		Region name (Japanese).
ContentsTargetContentsKeywordListName	String		Displays types of regional search
TargetSetting	String		AdGroupTargetServiceTargetSetting displays the setting information of target. The allowed values are NONE, ACTIVE, PAUSED, UNKNOWN.
TargetId	String		Target ID.
TargetType	String		Types of targets. The allowed values are AD_SCHEDULE_TARGET, GEO_TARGET, AGE_TARGET, GENDER_TARGET, INTEREST_CATEGORY, SITE_CATEGORY, SITE_RETARGETING, SEARCH_TARGET, PLACEMENT_TARGET, DEVICE_TARGET, CARRIER_TARGET, APP_TARGET, OS_TARGET, OS_VERSION_TARGET, AUDIENCE_CATEGORY_TARGET, POSITION_TARGET, PLACEMENT_CATEGORY_TARGET, PLACEMENT_CATEGORY_DETAIL_TARGET, CONTENTS_TARGET, UNKNOWN.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
ContainsLabelIdFlg	Boolean		Flag of contains label ID.
LabelId	String		Label ID.

GuaranteedAdGroupAdLabels

Retrieve the details of GuaranteedAdGroupAds Labels. The columns values set read-only false can be inserted in the parent table using Temp tables.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
AdGroupId supports the '=,IN'.
AdId supports the '=,IN'.
CampaignId supports the '=,IN'.
ContainsLabelIdFlg supports the '='.
LabelId supports the '=,IN'.
MediaId supports the '=,IN'.

For example:

SELECT * FROM GuaranteedAdGroupAdLabels WHERE AccountId = '123436'

Columns


Name	Type	References	Description
AccountId	Int64	DisplayAdsAccounts.AccountId	Account ID.
AdGroupId	Int64	GuaranteedAdGroups.AdGroupId	Ad group ID
AdId	Int64		Ad ID
CampaignId	Int64	GuaranteedCampaigns.AccountId	Campaign ID
MediaId	Int64	Media.MediaId	Media ID.
Color	String		Color.
Description	String		Description
LabelId	Int64	DisplayAdsLabels.LabelId	Label ID.
LabelName	String		Label Name

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
ContainsLabelIdFlg	Boolean		Flag of contains label ID.

GuaranteedAdGroupLabels

Retrieve the details of GuaranteedAdGroup Labels. The columns values set read-only false can be inserted in the parent table using Temp tables.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
AdGroupId supports the '=,IN'.
CampaignId supports the '=,IN'.
ContainsLabelIdFlg supports the '='.
LabelId supports the '=,IN'.

For example:

SELECT * FROM GuaranteedAdGroupLabels WHERE AccountId = '123436'

Columns


Name	Type	References	Description
AccountId	Int64	DisplayAdsAccounts.AccountId	Account ID.
AdGroupId	Int64	GuaranteedAdGroups.AdGroupId	Ad group ID
CampaignId	Int64	GuaranteedCampaigns.AccountId	Campaign ID
Color	String		Color.
Description	String		Description
LabelId	Int64	DisplayAdsLabels.LabelId	Label ID
LabelName	String		Label Name

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
ContainsLabelIdFlg	Boolean		Flag of contains label ID.

GuaranteedCampaignLabels

Retrieve the details of GuaranteedCampaigns Labels. The columns values set read-only false can be inserted in the parent table using Temp tables.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
CampaignId supports the '=,IN'.
ContainsLabelIdFlg supports the '='.
LabelId supports the '=,IN'.

For example:

SELECT * FROM GuaranteedCampaignLabels WHERE AccountId = '1002504155'

SELECT * FROM GuaranteedCampaignLabels WHERE AccountId = '1002504155' AND CampaignId = '1833923'

SELECT * FROM GuaranteedCampaignLabels WHERE AccountId = '1002504155' AND LabelId = '97108'

Columns


Name	Type	References	Description
CampaignId	Int64		Campaign ID.
AccountId	Int64	DisplayAdsAccounts.AccountId	Account ID.
Color	String		Color.
Description	String		Description
LabelId	Int64		Label ID.
LabelName	String		Label Name
ContainsLabelIdFlg	Boolean		Flag of contains label ID.

GuaranteedInventoryInventories

Get details of guaranteed campaign and information about inventory status of product

Table Specific Information

Select

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

AccountId supports the '=,IN'.
InventoryJobId supports the '='.

For example:

SELECT * FROM GuaranteedInventoryInventories WHERE AccountId = '1002504155' 

SELECT * FROM GuaranteedInventoryInventories WHERE InventoryJobId = '1002504155'

Columns


Name	Type	References	Description
AccountId	Int64	DisplayAdsAccounts.AccountId	Account ID
ActionAfterVideoAdTap	String		GuaranteedInventoryServiceActionAfterVideoAdTap describes what happens after a video ad is tapped The allowed values are NONE, FOR_VIEW, FOR_CLICK, UNKNOWN.
AdCategoryIds	String		Ad category ID
AdRequirements	String		GuaranteedInventoryServiceAdRequirement object describes the conditions for composing the guaranteed ad.This field is required in ADD operation
CampaignBiddingStrategyType	String		Campaign bid strategy type The allowed values are VCPM, SOV, UNKNOWN.
CampaignGoal	String		Campaign goal
EndDate	Date		End date of campaign.This field is required in ADD operation.Format yyyyMMdd
EndTime	String		End time of campaign.Format: HHmm
InventoryDetailStatus	String		Execution status details of inventory check. The allowed values are WAIT, SUCCEEDED, FAILED, UNKNOWN.
InventoryResult	String		Result of inventory check
InventoryUnit	String		GuaranteedInventoryServiceInventoryUnit describes the unit of inventoy check.This field is required in ADD operation. The allowed values are DAILY, WEEKLY, MONTHLY, LIFETIME, UNKNOWN.
LifetimeBudget	Int64		An amount of campaign's lifetime budget
LowerBudgetLimit	Int64		Minimum reservable lifetime budget
MaximumPurchaseVImps	Int64		Maximum purchase viewable impression
MaxReservableSlots	Int64		Maximum number of reservable slots under the specified period
MaxReservableVImps	Int64		Maximum ad delivery amount that can be reserved under the specified conditions
MaxSellableReach	Int64		Maximum number of reach available for sale
MaxSellableVImps	Int64		Inventory of sellable viewable impression under the specified period
MinimumPurchaseVImps	Int64		Minimum purchase viewable impression
PackageHistoryId	Int64		Package history ID.In ADD operation, this field will be required
PackageId	Int64		Package ID.In ADD operation, this field will be required
PackageName	String		Package name
PlacementMonopolyFlg	String		Describes whether it can be delivered to a monopoly place The allowed values are TRUE, FALSE, UNKNOWN.
PredictionResults	String		GuaranteedInventoryServicePredictionResult object describes the prediction result of the guaranteed campaign
PriceType	String		Purchase type of the package The allowed values are VIMPS_CUSTOM, VIMPS_SOV, VIMPS_REACH, SLOTS, UNKNOWN.
PromotionUrl	String		Promotion url
Reach	Int64		Number of reaches
PredictionResultLifetimeBudget	Int64		Lifetime budget
PredictionResultReach	Int64		Number of reaches
PredictionResultSovRate	String		SOV (0.0% to 100.0%)
PredictionResultVcpm	Int64		VCPM
PredictionResultViewableFrequency	String		Viewable frequency
PredictionResultVImps	Int64		Viewable impressions
ReservationStatus	String		Describes the reservation availability status of guaranteed campaign The allowed values are RESERVABLE, UNRESERVABLE, RESERVED, UNKNOWN.
Slots	Int64		Number of buying slots
SovRate	Int64		Number of buying slots
StartDate	Date		Start date of campaign.This field is required in ADD operation Format yyyyMMdd
StartTime	String		Start time of campaign Format: HHmm
Targets	String		GuaranteedInventoryServiceAdGroupTarget object holds the targeting Information about the delivery simulation of the guaranteed campaign
UnreservableReason	String		GuaranteedInventoryServiceUnreservableReason describes the reason why reservation is not possible
UpperBudgetLimit	Int64		Maximum reservable lifetime budget
FrequencyCapFrequencyLevel	String		Frequency setting level The allowed values are CAMPAIGN, UNKNOWN.
FrequencyCapFrequencyTimeUnit	String		Frequency setting period The allowed values are DAY, WEEK, MONTH, LIFETIME, UNKNOWN.
FrequencyCapvImps	Int64		Maximum number of ad viewable impressions to same user
VImps	Int64		Maximum number of ad viewable impressions to same user

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
InventoryJobId	Integer		Inventory check job ID.

GuaranteedInventoryInventoriesAdRequirements

Get details of guaranteed campaign and information about inventory status of product

Table Specific Information

Select

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

AccountId supports the '=,IN'.
InventoryJobId supports the '='.

For example:

SELECT * FROM GuaranteedInventoryInventoriesAdRequirements WHERE AccountId = '1002504155' 

SELECT * FROM GuaranteedInventoryInventoriesAdRequirements WHERE InventoryJobId = '1002504155'

Columns


Name	Type	References	Description
AccountId	Int64	DisplayAdsAccounts.AccountId	Account ID
AdType	String		GuaranteedInventoryServiceAdType describes the type of ad.This field is required in ADD operation The allowed values are BANNER_VIDEO_AD, BANNER_IMAGE_AD, BRANDPANEL_QUINTIE, BRANDPANEL_QUINTIE_VIDEO, BRANDPANEL_PANORAMA, BRANDPANEL_PANORAMA_VIDEO, TOP_IMPACT_SQUARE, TOP_IMPACT_SQUARE_VIDEO, TOP_IMPACT_QUINTIE, TOP_IMPACT_QUINTIE_VIDEO, TOP_IMPACT_PANORAMA, TOP_IMPACT_PANORAMA_VIDEO, TOP_IMPACT_PANORAMA_SIDE_VISION_VIDEO, TOP_IMPACT_PANORAMA_SIDE_SWITCH_VIDEO, TOP_IMPACT_THEATER_VIDEO, TOP_IMPACT_SQUARE_SPECIAL, TOP_IMPACT_SQUARE_SPECIAL_VIDEO, TOP_IMPACT_PRIME_DISPLAY_DOUBLE, TOP_IMPACT_PRIME_DISPLAY_DOUBLE_VIDEO, INSTREAM_VIDEO_AD, CAROUSEL_AD, BRANDPANEL_PANORAMA_PANEL_SWITCH, TOP_IMPACT_PANORAMA_PANEL_SWITCH, UNKNOWN.
AspectRatio	String		Aspect ratio type
MediaAdFormat	String		Media format.In ADD operation, this field will be required.Refer to the adFormat field of DictionaryServiceMediaAdFormat which can be obtained via getMediaAdFormat in DictionaryService, to check the values that can be specified in this field

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
InventoryJobId	Int64		Inventory check job ID.

GuaranteedInventoryInventoriesInventoryResults

Get details of guaranteed campaign and information about inventory status of product

Table Specific Information

Select

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

AccountId supports the '=,IN'.
InventoryJobId supports the '='.

For example:

SELECT * FROM GuaranteedInventoryInventoriesInventoryResults WHERE AccountId = '1002504155' 

SELECT * FROM GuaranteedInventoryInventoriesInventoryResults WHERE InventoryJobId = '1002504155'

Columns


Name	Type	References	Description
AccountId	Int64	DisplayAdsAccounts.AccountId	Account ID
EndDate	Date		End date of campaign.Format: yyyyMMdd
MaxReservableSlots	Int64		Maximum number of reservable slots under the specified period
MaxReservableVImps	Int64		Inventory of sellable viewable impression under the specified period
MaxSellableVImps	Int64		Inventory of sellable viewable impression under the specified period
SellingSlots	Int64		Inventory of sellable slots under the specified period
StartDate	Date		Start date of campaign.Format: yyyyMMdd
UnavailableReasons	String		GuaranteedInventoryServiceUnavailableReason describes a reason for lack of inventory
UnreservableReason	String		GuaranteedInventoryServiceUnreservableReason describes the reason why reservation is not possible The allowed values are NOT_ENOUGH_DELIVERY_TARGET, OUT_OF_STOCK, OUT_OF_STOCK, OUT_OF_STOCK, UNKNOWN.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
InventoryJobId	Int64		Inventory check job ID.

GuaranteedInventoryInventoriesInventoryResultUnavailableReasons

Get details of guaranteed campaign and information about inventory status of product

Table Specific Information

Select

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

AccountId supports the '=,IN'.
InventoryJobId supports the '='.

For example:

SELECT * FROM GuaranteedInventoryInventoriesInventoryResultUnavailableReasons WHERE AccountId = '1002504155' 

SELECT * FROM GuaranteedInventoryInventoriesInventoryResultUnavailableReasons WHERE InventoryJobId = '1002504155'

Columns


Name	Type	References	Description
AccountId	Int64	DisplayAdsAccounts.AccountId	Account ID
Ages	String		GuaranteedSimulationServiceAge displays ages
AudienceCategories	String		A list of Audience category target ID (category code) with no inventory
Date	String		Indicates a day when it is out of inventory Format: yyyyMMdd
Devices	String		GuaranteedInventoryServiceDeviceType displays types of devices to be posted on
Genders	String		GuaranteedInventoryServiceGender serves genders
Hours	String		List of time zones that cannot be reserved

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
InventoryJobId	Int64		Inventory check job ID.

GuaranteedInventoryInventoriesPredictionResults

Get details of guaranteed campaign and information about inventory status of product

Table Specific Information

Select

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

AccountId supports the '=,IN'.
InventoryJobId supports the '='.

For example:

SELECT * FROM GuaranteedInventoryInventoriesPredictionResults WHERE AccountId = '1002504155' 

SELECT * FROM GuaranteedInventoryInventoriesPredictionResults WHERE InventoryJobId = '1002504155'

Columns


Name	Type	References	Description
AccountId	Int64	DisplayAdsAccounts.AccountId	Account ID
LifetimeBudget	Integer		Lifetime budget
Reach	Integer		Number of reaches.
SovRate	String		SOV (0.0% to 100.0%)
Vcpm	Integer		VCPM
ViewableFrequency	String		Viewable frequency
VImps	Integer		Viewable impressions

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
InventoryJobId	Int64		Inventory check job ID.

GuaranteedInventoryInventoriesTargets

Get details of guaranteed campaign and information about inventory status of product

Table Specific Information

Select

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

AccountId supports the '=,IN'.
InventoryJobId supports the '='.

For example:

SELECT * FROM GuaranteedInventoryInventoriesTargets WHERE AccountId = '1002504155' 

SELECT * FROM GuaranteedInventoryInventoriesTargets WHERE InventoryJobId = '1002504155'

Columns


Name	Type	References	Description
AccountId	Int64	DisplayAdsAccounts.AccountId	Account ID
AdScheduleTargetDayOfWeek	String		GuaranteedInventoryServiceDayOfWeek serves the days of the week for delivery The allowed values are MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY, UNKNOWN.
AdScheduleTargetEndHour	Int64		End time (hour only).This field is required in ADD operation
AdScheduleTargetStartHour	Int64		Start time (hour only).This field is required in ADD operation
AgeTargetAge	String		GuaranteedSimulationServiceAge displays ages
AppTargetDeviceAppType	String		GuaranteedInventoryServiceDeviceAppType serves application types for devices The allowed values are APP, WEB, UNKNOWN.
AudienceCategoryType	String		Category type
CategoryNameEn	String		Category name (English)
CategoryNameJa	String		Category name (Japanese)
AccountName	String		Account name
AudienceListName	String		Audience list name
AudienceListType	String		Type of audience list The allowed values are DEFAULT_LIST, RULE, COMBINATION, SIMILARITY, CUSTOM_AUDIENCE, WEBSITE_VISITORS, CUSTOMER_DATA, OFFERED_BY_YAHOO_JAPAN, UNKNOWN.
DeliverType	String		GuaranteedInventoryServiceAudienceListDeliverType describes whether the audience list is delivery target or excluded from delivery target The allowed values are INCLUDE, EXCLUDE, UNKNOWN.
DeviceType	String		GuaranteedInventoryServiceDeviceType displays types of devices to be posted on The allowed values are DESKTOP, SMARTPHONE, TABLET, UNKNOWN.
GenderTargetGender	String		GuaranteedInventoryServiceGender serves genders
GeoTargetGeoNameEn	String		Region name (English)
GeoTargetGeoNameJa	String		Region name (Japanese)
DeviceOsType	String		OS types for devices
PlacementCategoryNameEn	String		PCategory name (English)
PlacementCategoryNameJa	String		Category name (Japanese)
PlacementCategoryType	String		Describes the type of placement category The allowed values are PAGE, STATION, UNKNOWN.
PlacementCategoryListName	String		Placement category list name
PositionType	String		Serves position types of the instream video ads
TargetId	String		Target ID
TargetType	String		GuaranteedInventoryServiceTargetType serves types of targets The allowed values are AD_SCHEDULE_TARGET, GEO_TARGET, AGE_TARGET, GENDER_TARGET, DEVICE_TARGET, APP_TARGET, OS_TARGET, AUDIENCE_CATEGORY_TARGET, PLACEMENT_CATEGORY_TARGET, PLACEMENT_CATEGORY_DETAIL_TARGET, POSITION_TARGET, AUDIENCE_LIST_TARGET, UNKNOWN.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
InventoryJobId	Int64		Inventory check job ID.

GuaranteedPreview

Read the preview of guaranteed campaign.

Table Specific Information

SELECT

The Sync App will use the Yahoo! Ads API to process WHERE clause conditions built with the following column and operator. The AccountId, MaterialType, AdId and AdType is required to make a request and rest of the filter is executed client side within the Sync App.

AccountId supports the '='.
AdId supports the '='.
AdLeftSideMediaId supports the '='.
AdRightSideMediaId supports the '='.
AdType supports the '='.
MediaId supports the '='.
ThumbnailMediaId supports the '='.
MaterialType supports the '='.

For example:

Select * from GuaranteedPreview WHERE AccountId = '1002504155' AND MaterialType = 'AD' AND AdId = '437760638' AND MediaId = '9307679' AND AdType = 'BRANDPANEL_QUINTIE'

Columns


Name	Type	References	Description
AccountId [KEY]	Int64	DisplayAdsAccounts.AccountId	Account ID.
AdId	Int64		Ad ID.
AdCenterMediaId	Int64		Center image.
AdLeftSideMediaId	Int64		Left side image.
AdRightSideMediaId	Int64		Right side image.
AdShrinkMainMediaId	Int64		Reduced main image.
AdType	String		Describes the type of ad. The allowed values are BRANDPANEL_QUINTIE, BRANDPANEL_QUINTIE_VIDEO, BRANDPANEL_PANORAMA, BRANDPANEL_PANORAMA_VIDEO, TOP_IMPACT_SQUARE, TOP_IMPACT_SQUARE_VIDEO, TOP_IMPACT_QUINTIE, TOP_IMPACT_QUINTIE_VIDEO, TOP_IMPACT_PANORAMA, TOP_IMPACT_PANORAMA_VIDEO, TOP_IMPACT_PANORAMA_SIDE_VISION_VIDEO, TOP_IMPACT_PANORAMA_SIDE_SWITCH_VIDEO, TOP_IMPACT_THEATER_VIDEO, TOP_IMPACT_THEATER_SPECIAL, TOP_IMPACT_THEATER_SPECIAL_VIDEO, TOP_IMPACT_PRIME_DISPLAY_DOUBLE, TOP_IMPACT_PRIME_DISPLAY_DOUBLE_VIDEO, INSTREAM_VIDEO_AD, UNKNOWN.
MediaId	Int64		Media ID.
ThumbnailMediaId	Int64		Thumbnail ID.
MaterialType	String		Describes the type of the preview material. The allowed values are AD, MEDIA, UNKNOWN.
PreviewUrl	String		Preview URL.
VideoScreenshot	String		Video start position for video screenshot that appears on both sides of homepage.
Panels	String		It holds information about the preview material (switch image).

GuaranteedPreviewPanels

It holds information about the preview material.

Table Specific Information

SELECT

The Sync App will use the Yahoo! Ads API to process WHERE clause conditions built with the following column and operator.The AccountId, MaterialType, AdId and AdType is required to make a request rest of the filter is executed client side within the Sync App.

AccountId supports the '='.
AdId supports the '='.
AdLeftSideMediaId supports the '='.
AdRightSideMediaId supports the '='.
AdType supports the '='.
MediaId supports the '='.
ThumbnailMediaId supports the '='.
MaterialType supports the '='.

For example:

SELECT * FROM GuaranteedPreviewPanels WHERE AccountId = '1002504155' AND MaterialType = 'AD' AND AdId = '437760638' AND MediaId='9307679' AND AdType='BRANDPANEL_QUINTIE'

Columns


Name	Type	References	Description
AccountId [KEY]	Int64	DisplayAdsAccounts.AccountId	Account ID.
PanelsMediaId	Int64		Media ID.
SwitchMediaId	Int64		Media ID of switch image.
MaterialType	String		Describes the type of the preview material. The allowed values are AD, MEDIA, UNKNOWN.
AdLeftSideMediaId	String		Left side image.
AdRightSideMediaId	String		Right side image.
MediaId	Int64		Media ID.
AdId	Int64		Ad ID.
AdType	String		Describes the type of ad. The allowed values are BRANDPANEL_QUINTIE, BRANDPANEL_QUINTIE_VIDEO, BRANDPANEL_PANORAMA, BRANDPANEL_PANORAMA_VIDEO, TOP_IMPACT_SQUARE, TOP_IMPACT_SQUARE_VIDEO, TOP_IMPACT_QUINTIE, TOP_IMPACT_QUINTIE_VIDEO, TOP_IMPACT_PANORAMA, TOP_IMPACT_PANORAMA_VIDEO, TOP_IMPACT_PANORAMA_SIDE_VISION_VIDEO, TOP_IMPACT_PANORAMA_SIDE_SWITCH_VIDEO, TOP_IMPACT_THEATER_VIDEO, TOP_IMPACT_THEATER_SPECIAL, TOP_IMPACT_THEATER_SPECIAL_VIDEO, TOP_IMPACT_PRIME_DISPLAY_DOUBLE, TOP_IMPACT_PRIME_DISPLAY_DOUBLE_VIDEO, INSTREAM_VIDEO_AD, UNKNOWN.

GuaranteedSimulationAdCategories

Get the list of ad categories in the delivery simulation of the guaranteed campaign.

Table Specific Information

SELECT

The driver does not support any filters on the server side. The rest of the filters will be processed on the client side.

For example, the following queries are processed server side:

SELECT * FROM GuaranteedSimulationAdCategories

Columns


Name	Type	References	Description
AdCategoryId [KEY]	String		Ad category ID.
AdCategoryName	String		Ad category name.
ParentCategoryId	String		Parent category ID.
ParentCategoryName	String		Parent category name.

GuaranteedSimulationAdRequirements

Retrieve details of conditions for composing the guaranteed ad.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
GuaranteedSimulationId supports the '=,IN'.

For example:

SELECT * FROM GuaranteedSimulationAdRequirements WHERE AccountId = '1002504155'

SELECT * FROM GuaranteedSimulationAdRequirements WHERE AccountId = '1231002504' AND GuaranteedSimulationId = '45698'

Columns


Name	Type	References	Description
AccountId	Int64	DisplayAdsAccounts.AccountId	Account ID.
GuaranteedSimulationId	Int64		Simulation ID.
AdType	String		Type of ad. The allowed values are BANNER_VIDEO_AD, BANNER_IMAGE_AD, BRANDPANEL_QUINTIE, BRANDPANEL_QUINTIE_VIDEO, BRANDPANEL_PANORAMA, BRANDPANEL_PANORAMA_VIDEO, TOP_IMPACT_SQUARE, TOP_IMPACT_SQUARE_VIDEO, TOP_IMPACT_QUINTIE_VIDEO, TOP_IMPACT_PANORAMA, TOP_IMPACT_PANORAMA_VIDEO, TOP_IMPACT_PANORAMA_SIDE_VISION_VIDEO, TOP_IMPACT_PANORAMA_SIDE_SWITCH_VIDEO, TOP_IMPACT_THEATER_VIDEO, TOP_IMPACT_SQUARE_SPECIAL, TOP_IMPACT_SQUARE_SPECIAL_VIDEO, TOP_IMPACT_PRIME_DISPLAY_DOUBLE, TOP_IMPACT_PRIME_DISPLAY_DOUBLE_VIDEO, INSTREAM_VIDEO_AD, CAROUSEL_AD, UNKNOWN.
AspectRatio	String		Aspect ratio type.
MediaAdFormat	String		Media format.

GuaranteedSimulationInventoryResult

Retrieve details of conditions for composing the guaranteed ad.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
GuaranteedSimulationId supports the '=,IN'.

For example:

SELECT * FROM GuaranteedSimulationInventoryResult WHERE AccountId = '1002504155'

SELECT * FROM GuaranteedSimulationInventoryResult WHERE AccountId = '1231002504' AND GuaranteedSimulationId = '45698'

Columns


Name	Type	References	Description
AccountId	Int64	DisplayAdsAccounts.AccountId	Account ID.
GuaranteedSimulationId	Int64		Simulation ID.
StartDate	String		Start date of campaign.
EndDate	String		End date of campaign.
MaxSellableVImps	String		Inventory of sellable viewable impression under the specified period.
MaxReservableVImps	String		Residual inventory of viewable impression under the specified period.
SellingSlots	String		Inventory of sellable slots under the specified period.
MaxReservableSlots	String		Maximum number of reservable slots under the specified period.
UnavailableReasons	String		Describes a reason for lack of inventory.
UnreservableReason	String		Describes the reason why reservation is not possible.

GuaranteedSimulationInventoryResultUnavailableReasons

Retrieve details of conditions for composing the guaranteed ad.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
GuaranteedSimulationId supports the '=,IN'.

For example:

SELECT * FROM GuaranteedSimulationInventoryResultUnavailableReasons WHERE AccountId = '1002504155'

SELECT * FROM GuaranteedSimulationInventoryResultUnavailableReasons WHERE AccountId = '1231002504' AND GuaranteedSimulationId = '45698'

Columns


Name	Type	References	Description
AccountId	Int64	DisplayAdsAccounts.AccountId	Account ID.
GuaranteedSimulationId	Int64		Simulation ID.
Date	String		Indicates a day when it is out of inventory.
Hours	Int64		List of time zones that cannot be reserved.
Genders	String		Serves Genders.
Ages	String		It displays ages.
Devices	String		Displays types of devices to be posted on.
AudienceCategories	String		A list of Audience category target ID (category code) with no inventory.

GuaranteedSimulationPackageAdRequirements

Retrieve the details of conditions for composing the guaranteed ad. The columns values set read-only false can be inserted in the parent table using Temp tables.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
PackageId supports the '=,IN'.
PackageName supports the '='.
PackagePermittedAdPlaceTypesAdPlaceTypes supports the '=,IN'.
DeviceTypes supports the '=,IN'.
AdTypes supports the '=,IN'.

For example:

SELECT * FROM GuaranteedSimulationPackageAdRequirements WHERE AccountId = '1002504155'

SELECT * FROM GuaranteedSimulationPackageAdRequirements WHERE AccountId = '1002504155' AND PackageId = '12346'

SELECT * FROM GuaranteedSimulationPackageAdRequirements WHERE AccountId = '1002504155' AND PackageName = 'cdata'

Columns


Name	Type	References	Description
AccountId	Int64	DisplayAdsAccounts.AccountId	Account ID.
PackageId	Int64		Package ID.
AdType	String		Type of ad. The allowed values are BANNER_VIDEO_AD, BANNER_IMAGE_AD, BRANDPANEL_QUINTIE, BRANDPANEL_QUINTIE_VIDEO, BRANDPANEL_PANORAMA, BRANDPANEL_PANORAMA_VIDEO, TOP_IMPACT_SQUARE, TOP_IMPACT_SQUARE_VIDEO, TOP_IMPACT_QUINTIE_VIDEO, TOP_IMPACT_PANORAMA, TOP_IMPACT_PANORAMA_VIDEO, TOP_IMPACT_PANORAMA_SIDE_VISION_VIDEO, TOP_IMPACT_PANORAMA_SIDE_SWITCH_VIDEO, TOP_IMPACT_THEATER_VIDEO, TOP_IMPACT_SQUARE_SPECIAL, TOP_IMPACT_SQUARE_SPECIAL_VIDEO, TOP_IMPACT_PRIME_DISPLAY_DOUBLE, TOP_IMPACT_PRIME_DISPLAY_DOUBLE_VIDEO, INSTREAM_VIDEO_AD, CAROUSEL_AD, UNKNOWN.
AspectRatio	String		Aspect ratio type.
MediaAdFormat	String		Media format.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
DeviceTypes	String		Device Types
AdTypes	String		Ad Types

GuaranteedSimulationPackages

Get the package list for the delivery simulation of the guaranteed campaign.

Table Specific Information

SELECT

The Sync App 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 Sync App.

AccountId supports the '='.
PackageId supports the '=,IN'.
PackageName supports the '='.
PackagePermittedAdPlaceTypesAdPlaceTypes supports the '=,IN'.
DeviceTypes supports the '=,IN'.
AdTypes supports the '=,IN'.

For example:

SELECT * FROM GuaranteedSimulationPackages WHERE AccountId = '1002504155'

SELECT * FROM GuaranteedSimulationPackages WHERE AccountId = '1002504155' AND PackageId = '12346'

SELECT * FROM GuaranteedSimulationPackages WHERE AccountId = '1002504155' AND PackageName = 'cdata'

Columns


Name	Type	References	Description
PackageId [KEY]	Int64		Package ID.
AccountId	Int64	DisplayAdsAccounts.AccountId	Account ID.
ActionAfterVideoAdTap	String		Describes what happens after a video ad is tapped. The allowed values are NONE, FOR_VIEW, FOR_CLICK, UNKNOWN.
AdDeliveryDurationStartDate	Date		Start date of the ad delivery validity period.
AdDeliveryDurationEndDate	Date		End date of the ad delivery validity period.
AdRequirements	String		Describes the conditions for composing the guaranteed ad.
AdTypePermission	String		Describes the restriction of the package setting. The allowed values are FORBIDDEN, PERMITTED_NON_TARGET_ENABLE, PERMITTED_NON_TARGET_DISABLE, FIXED, UNKNOWN.
BuyingTermBuyingTermType	String		Type of package purchase term. The allowed values are SINGLE_DAY, SINGLE_DAY, CUSTOM_RANGE, UNKNOWN.
BuyingTermCustomRangeBuyingTermBuyingTermDateMinRange	Int64		The number of days in the package purchase term (minimum range).
BuyingTermCustomRangeBuyingTermBuyingTermDateMaxRange	Int64		The number of days in the package purchase term (maximum range).
BuyingTermSingleDayBuyingTermBuyingSingleDayTerm	Int64		Package purchase term (single day).
BuyingTermSingleTermBuyingTermBuyingSingleTermStartDate	Date		Start date of the package purchase term (single term).
BuyingTermSingleTermBuyingTermBuyingSingleTermEndDate	Date		End date of the package purchase term (single term).
InstreamDurationType	String		Describes the duration type of in-stream ads. The allowed values are MAX_6_SECONDS, MAX_15_SECONDS, MAX_30_SECONDS, UNLIMITED, UNKNOWN.
PackageHistoryId	Int64		Package history ID.
PackageName	String		Package name.
PackagePermittedAdPlaceTypesAdPlaceTypes	String		Describes the ad placements. The allowed values are YAHOO_JAPAN_TOP, YAHOO_JAPAN_ALL, YAHOO_JAPAN_EXCLUSION_OF_TOP, UNKNOWN.
PackagePermittedAdPlaceTypesPermission	String		Describes the restriction of the package setting. The allowed values are FORBIDDEN, PERMITTED_NON_TARGET_ENABLE, PERMITTED_NON_TARGET_DISABLE, FIXED, UNKNOWN.
PackagePermittedAdScheduleTargetPermittedTargets	String		Configuration information of Ad Schedule targeting.
PackagePermittedAdScheduleTargetTargetPermission	String		Describes the restriction of the package setting. The allowed values are FORBIDDEN, PERMITTED_NON_TARGET_ENABLE, PERMITTED_NON_TARGET_DISABLE, FIXED, UNKNOWN.
PackagePermittedAgeTargetPermittedTargets	String		Configuration information of age targeting.
PackagePermittedAgeTargetTargetPermission	String		Describes the restriction of the package setting. The allowed values are FORBIDDEN, PERMITTED_NON_TARGET_ENABLE, PERMITTED_NON_TARGET_DISABLE, FIXED, UNKNOWN.
PackagePermittedAppTargetPermittedTargets	String		Configuration information of App targeting.
PackagePermittedAppTargetTargetPermission	String		Describes the restriction of the package setting. The allowed values are FORBIDDEN, PERMITTED_NON_TARGET_ENABLE, PERMITTED_NON_TARGET_DISABLE, FIXED, UNKNOWN.
PackagePermittedAudienceCategoryTargetPermittedTargets	String		Configuration information of audience category targeting.
PackagePermittedAudienceCategoryTargetTargetPermission	String		Describes the restriction of the package setting. The allowed values are FORBIDDEN, PERMITTED_NON_TARGET_ENABLE, PERMITTED_NON_TARGET_DISABLE, FIXED, UNKNOWN.
PackagePermittedAudienceListTargetTargetPermission	String		Describes the restriction of the package setting. The allowed values are FORBIDDEN, PERMITTED_NON_TARGET_ENABLE, PERMITTED_NON_TARGET_DISABLE, FIXED, UNKNOWN.
PackagePermittedAudienceListTargetPermittedTargets	String		Describes the restriction of the package setting. The allowed values are FORBIDDEN, PERMITTED_NON_TARGET_ENABLE, PERMITTED_NON_TARGET_DISABLE, FIXED, UNKNOWN.
PackagePermittedDeviceTargetPermittedTargets	String		Configuration information of Device targeting.
PackagePermittedDeviceTargetTargetPermission	String		Describes the restriction of the package setting. The allowed values are FORBIDDEN, PERMITTED_NON_TARGET_ENABLE, PERMITTED_NON_TARGET_DISABLE, FIXED, UNKNOWN.
PackagePermittedGenderTargetPermittedTargets	String		Configuration information of Gender targeting.
PackagePermittedGenderTargetTargetPermission	String		Describes the restriction of the package setting. The allowed values are FORBIDDEN, PERMITTED_NON_TARGET_ENABLE, PERMITTED_NON_TARGET_DISABLE, FIXED, UNKNOWN.
PackagePermittedGeoTargetPermittedTargets	String		Configuration information of Geo targeting.
PackagePermittedGeoTargetTargetPermission	String		Describes the restriction of the package setting. The allowed values are FORBIDDEN, PERMITTED_NON_TARGET_ENABLE, PERMITTED_NON_TARGET_DISABLE, FIXED, UNKNOWN.
PackagePermittedOsTargetPermittedTargets	String		Configuration information of OS targeting.
PackagePermittedOsTargetTargetPermission	String		Describes the restriction of the package setting. The allowed values are FORBIDDEN, PERMITTED_NON_TARGET_ENABLE, PERMITTED_NON_TARGET_DISABLE, FIXED, UNKNOWN.
PackagePermittedPlacementCategoryTargetPermittedTargets	String		Configuration information of placement category targeting.
PackagePermittedPlacementCategoryTargetPlacementMonopolyFlg	String		Describes whether it can be delivered to a monopoly place. The allowed values are TRUE, FALSE, UNKNOWN.
PackagePermittedPlacementCategoryTargetPlacementDetailMax	String		The maximum number of placement category details.
PackagePermittedPlacementCategoryTargetTargetPermission	String		Describes the restriction of the package setting. The allowed values are FORBIDDEN, PERMITTED_NON_TARGET_ENABLE, PERMITTED_NON_TARGET_DISABLE, FIXED, UNKNOWN.
PackagePermittedPositionTargetPermittedTargets	String		Configuration information of position targeting.
PackagePermittedPositionTargetTargetPermission	String		Describes the restriction of the package setting. The allowed values are FORBIDDEN, PERMITTED_NON_TARGET_ENABLE, PERMITTED_NON_TARGET_DISABLE, FIXED, UNKNOWN.
PackagePermittedSiteRetargetingTargetPermittedTargets	String		A container for site retargeting settings.
PackagePermittedSiteRetargetingTargetTargetPermission	String		Describes the restriction of the package setting. The allowed values are FORBIDDEN, PERMITTED_NON_TARGET_ENABLE, PERMITTED_NON_TARGET_DISABLE, FIXED, UNKNOWN.
PackagePermittedViewableFrequencyCapPermittedViewableFrequencyCapImpressionMin	Int64		Display count of viewable frequency cap (minimum).
PackagePermittedViewableFrequencyCapPermittedViewableFrequencyCapImpressionMax	Int64		Display count of viewable frequency cap (maximum).
PackagePermittedViewableFrequencyCapPermittedViewableFrequencyCapTimeUnits	String		Frequency setting period. The allowed values are DAY, WEEK, MONTH, LIFETIME, UNKNOWN.
PackagePermittedViewableFrequencyCapViewableFrequencyCapLevels	String		Frequency setting level. The allowed values are CAMPAIGN, UNKNOWN.
PackagePermittedViewableFrequencyCapViewableFrequencyCapPermission	String		Dscribes the restriction of the package setting. The allowed values are FORBIDDEN, PERMITTED_NON_TARGET_ENABLE, PERMITTED_NON_TARGET_DISABLE, FIXED, UNKNOWN.
PackagePublicLevel	String		Describes the public level of package setting. The allowed values are PUBLIC, LIMITED, UNKNOWN.
PricingPackagePriceType	String		Describes the purchase type of the package. The allowed values are VIMS_CUSTOM, VIMPS_SOV, VIMPS_REACH, SLOTS, UNKNOWN.
PricingPackageSlotsPricingPackageFixedBudgetApplyTermType	String		Describes the application period of fixed product price. The allowed values are SINGLE_DAY, LIFETIME, UNKNOWN.
PricingPackageSlotsPricingPackageFixedLifetimeBudget	Int64		Package price.
PricingPackageSlotsPricingPackageMinimumBuyingSlots	Int64		Minimum number of purchase slots.
PricingPackageSlotsPricingPackageSellingSlots	Int64		Number of selling slots.
PricingPackageVimpsCustomPricingPackageFixedLifetimeBudget	Int64		Package price.
PricingPackageVimpsCustomPricingPackageMaximumPurchaseVImps	Int64		Maximum purchase viewable impression.
PricingPackageVimpsCustomPricingPackageMinimumPurchaseVImps	Int64		Minimum purchase viewable impression.
PricingPackageVimpsReachPricingPackageFixedLifetimeBudget	Int64		Package price.
PricingPackageVimpsReachPricingPackageViewableReach	Int64		SOV (1% to 100%).
PricingPackageVimpsSOVPricingPackageFixedLifetimeBudget	Int64		Package price.
PricingPackageVimpsSOVPricingPackageSovRate	Int64		Viewable reach.
PromotionalDocumentFiles	String		Holds information about the promotional document.
RelatedDocumentFiles	String		Holds information about the package document.
Remarks	String		Remarks.
ReservationStartDate	Date		Start date of reservation period.
ReservationEndDate	Date		End date of reservation period.
SalesDocumentFileFileName	String		File name of the package document.
SalesDocumentFileUrl	String		Download URL of the package document.
SellingStartDate	Date		Start date of the package.
SellingEndDate	Date		End date of the package.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
DeviceTypes	String		Device Types
AdTypes	String		Ad Types

GuaranteedSimulationPackagesPackagePermittedAdScheduleTargetPermittedTargets

Retrieve the details of Configuration information of Ad Schedule targeting. The columns values set read-only false can be inserted in the parent table using Temp tables.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
PackageId supports the '=,IN'.
PackageName supports the '='.
PackagePermittedAdPlaceTypesAdPlaceTypes supports the '=,IN'.
DeviceTypes supports the '=,IN'.
AdTypes supports the '=,IN'.

For example:

SELECT * FROM GuaranteedSimulationPackagesPackagePermittedAdScheduleTargetPermittedTargets WHERE AccountId = '1002504155'

SELECT * FROM GuaranteedSimulationPackagesPackagePermittedAdScheduleTargetPermittedTargets WHERE AccountId = '1002504155' AND PackageId = '12346'

SELECT * FROM GuaranteedSimulationPackagesPackagePermittedAdScheduleTargetPermittedTargets WHERE AccountId = '1002504155' AND PackageName = 'cdata'

Columns


Name	Type	References	Description
TargetId [KEY]	String		Target ID.
AccountId	Int64	DisplayAdsAccounts.AccountId	Account ID.
PackageId	Int64		Package ID.
DayOfWeek	String		Days of the week for delivery. The allowed values are MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY, UNKNOWN.
EndHour	Int64		End time (hour only)
Price	Int64		Fixed price.
StartHour	Int64		Start time (hour only)

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
DeviceTypes	String		Device Types
AdTypes	String		Ad Types

GuaranteedSimulationPackagesPackagePermittedAgeTargetPermittedTargets

Retrieve the details of Configuration information of age targeting. The columns values set read-only false can be inserted in the parent table using Temp tables.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
PackageId supports the '=,IN'.
PackageName supports the '='.
PackagePermittedAdPlaceTypesAdPlaceTypes supports the '=,IN'.
DeviceTypes supports the '=,IN'.
AdTypes supports the '=,IN'.

For example:

SELECT * FROM GuaranteedSimulationPackagesPackagePermittedAgeTargetPermittedTargets WHERE AccountId = '1002504155'

SELECT * FROM GuaranteedSimulationPackagesPackagePermittedAgeTargetPermittedTargets WHERE AccountId = '1002504155' AND PackageId = '12346'

SELECT * FROM GuaranteedSimulationPackagesPackagePermittedAgeTargetPermittedTargets WHERE AccountId = '1002504155' AND PackageName = 'cdata'

Columns


Name	Type	References	Description
TargetId [KEY]	String		Target ID.
AccountId	Int64	DisplayAdsAccounts.AccountId	Account ID.
Age	String		Ages The allowed values are GT_RANGE13_14, GT_RANGE15_17, GT_RANGE20_21, GT_RANGE30_39, GT_RANGE50_59, GT_RANGE70_UL, GT_RANGE15_19, GT_RANGE20_24, GT_RANGE25_29, GT_RANGE30_34, GT_RANGE40_44, GT_RANGE50_54, GT_RANGE60_64, GT_RANGE65_69, GT_RANGE70_UL2, GT_UNKNOWN2, UNKNOWN.
PackageId	Int64		Package ID.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
DeviceTypes	String		Device Types
AdTypes	String		Ad Types

GuaranteedSimulationPackagesPackagePermittedAppTargetPermittedTargets

Retrieve the details of Configuration information of App targeting. The columns values set read-only false can be inserted in the parent table using Temp tables.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
PackageId supports the '=,IN'.
PackageName supports the '='.
PackagePermittedAdPlaceTypesAdPlaceTypes supports the '=,IN'.
DeviceTypes supports the '=,IN'.
AdTypes supports the '=,IN'.

For example:

SELECT * FROM GuaranteedSimulationPackagesPackagePermittedAppTargetPermittedTargets WHERE AccountId = '1002504155'

SELECT * FROM GuaranteedSimulationPackagesPackagePermittedAppTargetPermittedTargets WHERE AccountId = '1002504155' AND PackageId = '12346'

SELECT * FROM GuaranteedSimulationPackagesPackagePermittedAppTargetPermittedTargets WHERE AccountId = '1002504155' AND PackageName = 'cdata'

Columns


Name	Type	References	Description
TargetId [KEY]	String		Target ID.
AccountId	Int64	DisplayAdsAccounts.AccountId	Account ID.
PackageId	Int64		Package ID.
AppType	String		Types for devices. The allowed values are APP, WEB, UNKNOWN.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
DeviceTypes	String		Device Types
AdTypes	String		Ad Types

GuaranteedSimulationPackagesPackagePermittedAudienceCategoryTargetPermittedTargets

Retrieve the details of Configuration information of audience category targeting. The columns values set read-only false can be inserted in the parent table using Temp tables.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
PackageId supports the '=,IN'.
PackageName supports the '='.
PackagePermittedAdPlaceTypesAdPlaceTypes supports the '=,IN'.
DeviceTypes supports the '=,IN'.
AdTypes supports the '=,IN'.

For example:

SELECT * FROM GuaranteedSimulationPackagesPackagePermittedAudienceCategoryTargetPermittedTargets WHERE AccountId = '1002504155'

SELECT * FROM GuaranteedSimulationPackagesPackagePermittedAudienceCategoryTargetPermittedTargets WHERE AccountId = '1002504155' AND PackageId = '12346'

SELECT * FROM GuaranteedSimulationPackagesPackagePermittedAudienceCategoryTargetPermittedTargets WHERE AccountId = '1002504155' AND PackageName = 'cdata'

Columns


Name	Type	References	Description
TargetId [KEY]	String		Target ID.
AccountId	Int64	DisplayAdsAccounts.AccountId	Account ID.
PackageId	Int64		Package ID.
CategoryFullNameEn	String		Site category name (English)
CategoryFullNameJa	String		Interest category name (Japanese)

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
DeviceTypes	String		Device Types
AdTypes	String		Ad Types

GuaranteedSimulationPackagesPackagePermittedDeviceTargetPermittedTargets

Retrieve the details of Configuration information of Device targeting. The columns values set read-only false can be inserted in the parent table using Temp tables.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
PackageId supports the '=,IN'.
PackageName supports the '='.
PackagePermittedAdPlaceTypesAdPlaceTypes supports the '=,IN'.
DeviceTypes supports the '=,IN'.
AdTypes supports the '=,IN'.

For example:

SELECT * FROM GuaranteedSimulationPackagesPackagePermittedDeviceTargetPermittedTargets WHERE AccountId = '1002504155'

SELECT * FROM GuaranteedSimulationPackagesPackagePermittedDeviceTargetPermittedTargets WHERE AccountId = '1002504155' AND PackageId = '12346'

SELECT * FROM GuaranteedSimulationPackagesPackagePermittedDeviceTargetPermittedTargets WHERE AccountId = '1002504155' AND PackageName = 'cdata'

Columns


Name	Type	References	Description
TargetId [KEY]	String		Target ID
AccountId	Int64	DisplayAdsAccounts.AccountId	Account ID.
PackageId	Int64		Package ID.
DeviceType	String		Types of devices to be posted on. The allowed values are DESKTOP, SMARTPHONE, TABLET, UNKNOWN.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
DeviceTypes	String		Device Types
AdTypes	String		Ad Types

GuaranteedSimulationPackagesPackagePermittedGenderTargetPermittedTargets

Retrieve the details of Configuration information of Gender targeting. The columns values set read-only false can be inserted in the parent table using Temp tables.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
PackageId supports the '=,IN'.
PackageName supports the '='.
PackagePermittedAdPlaceTypesAdPlaceTypes supports the '=,IN'.
DeviceTypes supports the '=,IN'.
AdTypes supports the '=,IN'.

For example:

SELECT * FROM GuaranteedSimulationPackagesPackagePermittedGenderTargetPermittedTargets WHERE AccountId = '1002504155'

SELECT * FROM GuaranteedSimulationPackagesPackagePermittedGenderTargetPermittedTargets WHERE AccountId = '1002504155' AND PackageId = '12346'

SELECT * FROM GuaranteedSimulationPackagesPackagePermittedGenderTargetPermittedTargets WHERE AccountId = '1002504155' AND PackageName = 'cdata'

Columns


Name	Type	References	Description
TargetId [KEY]	String		Target ID
AccountId	Int64	DisplayAdsAccounts.AccountId	Account ID.
PackageId	Int64		Package ID.
Gender	String		ST_MALE,ST_FEMALE,ST_UNKNOWN,UNKNOWN

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
DeviceTypes	String		Device Types
AdTypes	String		Ad Types

GuaranteedSimulationPackagesPackagePermittedGeoTargetPermittedTargets

Retrieve the details of Configuration information of Geo targeting. The columns values set read-only false can be inserted in the parent table using Temp tables.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
PackageId supports the '=,IN'.
PackageName supports the '='.
PackagePermittedAdPlaceTypesAdPlaceTypes supports the '=,IN'.
DeviceTypes supports the '=,IN'.
AdTypes supports the '=,IN'.

For example:

SELECT * FROM GuaranteedSimulationPackagesPackagePermittedGeoTargetPermittedTargets WHERE AccountId = '1002504155'

SELECT * FROM GuaranteedSimulationPackagesPackagePermittedGeoTargetPermittedTargets WHERE AccountId = '1002504155' AND PackageId = '12346'

SELECT * FROM GuaranteedSimulationPackagesPackagePermittedGeoTargetPermittedTargets WHERE AccountId = '1002504155' AND PackageName = 'cdata'

Columns


Name	Type	References	Description
TargetId [KEY]	String		Target ID
AccountId	Int64	DisplayAdsAccounts.AccountId	Account ID.
PackageId	Int64		Package ID.
GeoNameEn	String		Region name (English).
GeoNameJa	String		Region name (Japanese).

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
DeviceTypes	String		Device Types
AdTypes	String		Ad Types

GuaranteedSimulationPackagesPackagePermittedOsTargetPermittedTargets

Retrieve the details of Configuration information of OS targeting. The columns values set read-only false can be inserted in the parent table using Temp tables.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
PackageId supports the '=,IN'.
PackageName supports the '='.
PackagePermittedAdPlaceTypesAdPlaceTypes supports the '=,IN'.
DeviceTypes supports the '=,IN'.
AdTypes supports the '=,IN'.

For example:

SELECT * FROM GuaranteedSimulationPackagesPackagePermittedOsTargetPermittedTargets WHERE AccountId = '1002504155'

SELECT * FROM GuaranteedSimulationPackagesPackagePermittedOsTargetPermittedTargets WHERE AccountId = '1002504155' AND PackageId = '12346'

SELECT * FROM GuaranteedSimulationPackagesPackagePermittedOsTargetPermittedTargets WHERE AccountId = '1002504155' AND PackageName = 'cdata'

Columns


Name	Type	References	Description
TargetId [KEY]	String		Target ID
AccountId	Int64	DisplayAdsAccounts.AccountId	Account ID.
PackageId	Int64		Package ID.
OsType	String		OS types for devices to be posted on. The allowed values are IOS, ANDROID, UNKNOWN.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
DeviceTypes	String		Device Types
AdTypes	String		Ad Types

GuaranteedSimulationPackagesPackagePermittedPlacementCategoryTargetPermittedTargets

Retrieve the details of Configuration information of placement category targeting. The columns values set read-only false can be inserted in the parent table using Temp tables.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
PackageId supports the '=,IN'.
PackageName supports the '='.
PackagePermittedAdPlaceTypesAdPlaceTypes supports the '=,IN'.
DeviceTypes supports the '=,IN'.
AdTypes supports the '=,IN'.

For example:

SELECT * FROM GuaranteedSimulationPackagesPackagePermittedPlacementCategoryTargetPermittedTargets WHERE AccountId = '1002504155'

SELECT * FROM GuaranteedSimulationPackagesPackagePermittedPlacementCategoryTargetPermittedTargets WHERE AccountId = '1002504155' AND PackageId = '12346'

SELECT * FROM GuaranteedSimulationPackagesPackagePermittedPlacementCategoryTargetPermittedTargets WHERE AccountId = '1002504155' AND PackageName = 'cdata'

Columns


Name	Type	References	Description
AccountId	Int64	DisplayAdsAccounts.AccountId	Account ID.
PackageId	Int64		Package ID.
PlacementCategoryListId	Int64		Placement category ID.
PlacementCategoryListName	String		Placement category name.
PlacementCategoryType	String		Placement category type.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
DeviceTypes	String		Device Types
AdTypes	String		Ad Types

GuaranteedSimulationPackagesPackagePermittedPositionTargetPermittedTargets

Retrieve the details of Configuration information of position targeting. The columns values set read-only false can be inserted in the parent table using Temp tables.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
PackageId supports the '=,IN'.
PackageName supports the '='.
PackagePermittedAdPlaceTypesAdPlaceTypes supports the '=,IN'.
DeviceTypes supports the '=,IN'.
AdTypes supports the '=,IN'.

For example:

SELECT * FROM GuaranteedSimulationPackagesPackagePermittedPositionTargetPermittedTargets WHERE AccountId = '1002504155'

SELECT * FROM GuaranteedSimulationPackagesPackagePermittedPositionTargetPermittedTargets WHERE AccountId = '1002504155' AND PackageId = '12346'

SELECT * FROM GuaranteedSimulationPackagesPackagePermittedPositionTargetPermittedTargets WHERE AccountId = '1002504155' AND PackageName = 'cdata'

Columns


Name	Type	References	Description
TargetId [KEY]	String		Target ID
AccountId	Int64	DisplayAdsAccounts.AccountId	Account ID.
PackageId	Int64		Package ID.
PositionType	String		Position types of the instream video ads. The allowed values are INSTREAM_PREROLL, INSTREAM_MIDROLL, INSTREAM_POSTROLL, UNKNOWN.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
DeviceTypes	String		Device Types
AdTypes	String		Ad Types

GuaranteedSimulationPackagesPackagePermittedSiteRetargetingTargetPermittedTargets

Retrieve the details of site retargeting settings. The columns values set read-only false can be inserted in the parent table using Temp tables.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
PackageId supports the '=,IN'.
PackageName supports the '='.
PackagePermittedAdPlaceTypesAdPlaceTypes supports the '=,IN'.
DeviceTypes supports the '=,IN'.
AdTypes supports the '=,IN'.

For example:

SELECT * FROM GuaranteedSimulationPackagesPackagePermittedSiteRetargetingTargetPermittedTargets WHERE AccountId = '1002504155'

SELECT * FROM GuaranteedSimulationPackagesPackagePermittedSiteRetargetingTargetPermittedTargets WHERE AccountId = '1002504155' AND PackageId = '12346'

SELECT * FROM GuaranteedSimulationPackagesPackagePermittedSiteRetargetingTargetPermittedTargets WHERE AccountId = '1002504155' AND PackageName = 'cdata'

Columns


Name	Type	References	Description
TargetId [KEY]	String		Target ID.
AccountId	Int64	DisplayAdsAccounts.AccountId	Account ID.
PackageId	Int64		Package ID.
PackageName	String		Package name.
PackagePermittedAdPlaceTypesAdPlaceTypes	String		Describes the ad placements. The allowed values are YAHOO_JAPAN_TOP, YAHOO_JAPAN_ALL, YAHOO_JAPAN_EXCLUSION_OF_TOP, UNKNOWN.
TargetListDeliverType	String		Type of target list type. The allowed values are INCLUDE, EXCLUDE, UNKNOWN.
TargetListName	String		Target list name.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
DeviceTypes	String		Device Types
AdTypes	String		Ad Types

GuaranteedSimulationPredictionResults

Retrieve details of prediction result of the guaranteed campaign. The columns values set read-only false can be inserted in the parent table using Temp tables.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
GuaranteedSimulationId supports the '=,IN'.

For example:

SELECT * FROM GuaranteedSimulationPredictionResults WHERE AccountId = '1002504155'

SELECT * FROM GuaranteedSimulationPredictionResults WHERE AccountId = '1231002504' AND GuaranteedSimulationId = '45698'

Columns


Name	Type	References	Description
AccountId	Int64	DisplayAdsAccounts.AccountId	Account ID.
GuaranteedSimulationId	Int64		Simulation ID.
LifetimeBudget	Int64		Lifetime budget.
Price	Int64		Price.
Reach	Int64		Number of reaches.
SovRate	String		SOV (0.0% to 100.0%).
Vcpm	Int64		VCPM.
ViewableFrequency	String		Viewable frequency.
VImps	Int64		Viewable impressions.

GuaranteedSimulationsAdCategories

Get the list of ad categories in the delivery simulation of the guaranteed campaign.

Columns


Name	Type	References	Description
AdCategoryId [KEY]	String		Ad category ID.
AdCategoryName	String		Ad category name.
ParentCategoryId	String		Parent category ID.
ParentCategoryName	String		Parent category name.

GuaranteedSimulationTargets

Retrieve details of targeting information about the delivery simulation of the guaranteed campaign. The columns values set read-only false can be inserted in the parent table using Temp tables.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
GuaranteedSimulationId supports the '=,IN'.

For example:

SELECT * FROM GuaranteedSimulationTargets WHERE AccountId = '1002504155'

SELECT * FROM GuaranteedSimulationTargets WHERE AccountId = '1231002504' AND GuaranteedSimulationId = '45698'

Columns


Name	Type	References	Description
TargetId [KEY]	String		Target ID.
AccountId	Int64	DisplayAdsAccounts.AccountId	Account ID.
GuaranteedSimulationId	Int64		Simulation ID.
LifetimeBudget	Int64		Lifetime budget.
AdScheduleTargetDayOfWeek	String		days of the week for delivery. The allowed values are MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY, UNKNOWN.
AdScheduleTargetEndHour	Int64		End time (hour only).
AdScheduleTargetStartHour	Int64		Start time (hour only).
AgeTargetAge	String		Ages The allowed values are GT_RANGE13_14, GT_RANGE15_17, GT_RANGE20_21, GT_RANGE30_39, GT_RANGE50_59, GT_RANGE70_UL, GT_RANGE15_19, GT_RANGE20_24, GT_RANGE25_29, GT_RANGE30_34, GT_RANGE40_44, GT_RANGE50_54, GT_RANGE60_64, GT_RANGE65_69, GT_RANGE70_UL2, GT_UNKNOWN2, UNKNOWN.
AppTargetDeviceAppType	String		Application types for devices. The allowed values are APP, WEB, UNKNOWN.
AudienceCategoryTargetAudienceCategoryType	String		Category type
AudienceCategoryTargetCategoryNameEn	String		Category name (English).
AudienceCategoryTargetCategoryNameJa	String		Category name (Japanese).
DeviceTargetDeviceType	String		Types of devices to be posted on. The allowed values are DESKTOP, WAP_MOBILE, SMARTPHONE, TABLET, UNKNOWN.
GenderTargetGender	String		Types of Genders The allowed values are ST_MALE, ST_FEMALE, ST_UNKNOWN, UNKNOWN.
GeoTargetGeoNameEn	String		Region name (English).
GeoTargetGeoNameJa	String		Region name (Japanese).
OsTargetDeviceOsType	String		OS types for devices to be posted on. The allowed values are IOS, ANDROID, UNKNOWN.
PlacementCategoryTargetPlacementCategoryListName	String		Placement category list name.
PlacementCategoryDetailTargetPlacementCategoryNameJa	String		Placement category name (Japanese).
PlacementCategoryDetailTargetPlacementCategoryNameEn	String		Placement category name(English).
PlacementCategoryDetailTargetPlacementCategoryType	String		Describes Placement category types.
PositionTargetPositionType	String		Types of the instream video ads. The allowed values are INSTREAM_PREROLL, INSTREAM_MIDROLL, INSTREAM_POSTROLL.
AudienceListTargetDeliverType	String		Type of target list type. The allowed values are INCLUDE, EXCLUDE, UNKNOWN.
AudienceListTargetAudienceListName	String		Target List name.
TargetType	String		Types of targets. The allowed values are AD_SCHEDULE_TARGET, GEO_TARGET, AGE_TARGET, GENDER_TARGET, INTEREST_CATEGORY, SITE_CATEGORY, SITE_RETARGETING, SEARCH_TARGET, PLACEMENT_TARGET, DEVICE_TARGET, CARRIER_TARGET, APP_TARGET, OS_TARGET, OS_VERSION_TARGET, AUDIENCE_CATEGORY_TARGET, POSITION_TARGET, PLACEMENT_CATEGORY_TARGET, PLACEMENT_CATEGORY_DETAIL_TARGET, CONTENTS_TARGET, UNKNOWN.

MediaAdFormats

Get an acceptable format (MediaAdFormat) of ad creatives.

Table Specific Information

Select

The driver does not support server side filters. The rest of the filters are processed on the client side. For example:

SELECT * FROM MediaAdFormats

Columns


Name	Type	References	Description
AdFormat	String		Format of display (image) ads.
Aspect	Boolean		This field indicates whether the aspect ratio is supported.
AspectHeight	Int64		Image aspect ratio: height [ratio]
AspectRatio	String		Aspect ratio.
AspectWidth	Int64		Image aspect ratio: width [ratio]
CampaignBanner	Boolean		This field indicates whether it is a campaign banner image or not.
Height	Int64		Minimum image size: height [pixel]
Logo	Boolean		This field indicates whether it is a logo image or not.
MaxHeight	Int64		Size limit: height [pixel]
MaxWidth	Int64		Size limit: weight [pixel]
RichFormat	Boolean		Indicates whether the image is for rich format.
Size	Int64		Maximum image capacity: [byte]
SizeTo	Int64		Image compression capacity: [byte]
StaticImage	Boolean		This field indicates whether it is a static image.
Thumbnail	Boolean		This field indicates whether it is a thumbnail image image or not.
Transparent	Boolean		This field indicates whether transparent image is permitted.
Width	Int64		Minimum image size: width [pixel]

OsVersions

Get the version of OS.

Table Specific Information

SELECT

The Sync App will use the Yahoo! Ads API to process WHERE clause conditions built with the following column and operator.

DeviceOsType supports the '='.

For example:

SELECT * FROM OsVersions WHERE DeviceOsType = 'ANDROID'

Columns


Name	Type	References	Description
DeviceOsType	String		Serves OS types for devices to be posted on. The allowed values are ANDROID, IOS, UNKNOWN.
Version	String		OS Version.

PlacementUrlIdeas

Get the candidate URL

Table Specific Information

SELECT

The Sync App will use the Yahoo! Ads API to process WHERE clause conditions built with the following column and operator.

Keyword supports the '='.
SiteCategory supports the '=,IN'.

For example:

SELECT * FROM PlacementUrlIdeas

Columns


Name	Type	References	Description
AdFormat	String		Ad Format
DesktopAdRequests	Int64		AD Number of PC(1000 In the case of 0)
DesktopReaches	Int64		Reach Number of PC(1000 In the case of 0)
Keyword	String		Search Keyword Search all keywords (AND), separated by spaces. Maximum of 250 characters. Maximum of 10 spaces to separate the words
SearchUrl	String		Search Category
SiteCategory	String		URL. Category of URL. Exact match. Search multiple specific keywords (OR) From value: TC-SC-xxxxxx Choose the TC-SC-xxxxxx value from DictionaryService Maximum of 50 cases
SmartPhoneAdRequests	Int64		AD Number of SmartPhone(1000 In the case of 0)
SmartPhoneReaches	Int64		Reach Number of SmartPhone (1000 In the case of 0)
TabletAdRequests	Int64		AD Number of Tablet (1000 In the case of 0)
TabletReaches	Int64		Tablet(1000 In the case of 0)

PlacementUrlListUrls

Retrieve the details of PlacementUrlLists Urls. The columns values set read-only false can be inserted in the parent table using Temp tables.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
UrlListId supports the '=,IN'.

For example:

SELECT * FROM PlacementUrlListUrls WHERE AccountId = '1002504155'

SELECT * FROM PlacementUrlListUrls WHERE AccountId = '1002504155' AND UrlListId = '1000908843'

Columns


Name	Type	References	Description
UrlListId	Int64		Url List ID.
AccountId	Int64	DisplayAdsAccounts.AccountId	Account ID.
PlacementUrl	String		Url.
UrlActiveFlg	String		Placement Url Active Flag. The allowed values are ACTIVE, PAUSED, UNKNOWN.

RecommendationCampaignBiddingStrategyToTargetCpaCampaignBiddingStrategyToTargetCpaCampaignList

Retrieve the details of campaign that is suitable for using autobidding. The columns values set read-only false can be inserted in the parent table using Temp tables.

Table Specific Information

Select

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

AccountId supports the '='.
Type supports the '=,IN'.

For example:

SELECT * FROM RecommendationCampaignBiddingStrategyToTargetCpaCampaignBiddingStrategyToTargetCpaCampaignList WHERE AccountId = '1002504155' AND Type = 'DAILY_BUDGET_OVER'

Columns


Name	Type	References	Description
AccountId	Int64	DisplayAdsAccounts.AccountId	Account ID.
CampaignId	Int64		Campaign ID.
CampaignName	String		Campaign Name.
CurrentBudget	Int64		Current campaign budget.
CurrentCampaignBiddingStrategyType	String		Current campaign bidding strategy type.
CurrentCpcBidValue	Int64		Current max bid of campaign (CPC).
RecommendationId	Int64		Recommendation ID.
RecommendedCampaignBiddingStrategyType	String		Recommended campaign bidding strategy type
RecommendedTargetCpaBidValue	Int64		Recommended target bid of campaign (tCPA).
Type	String		Type of Recommendations The allowed values are DAILY_BUDGET_OVER, IMPRESSION_SHARE_BUDGET_LOSS_OVER, BID_STRATEGY_TO_TARGET_CPA, SEARCH_KEYWORD_LIST_IDEA, CAMPAIGNS_FOR_ADDING_ADS, UNKNOWN.

RecommendationDailyBudgetOverDailyBudgetOverCampaignLists

Retrieve the information about campaigns that reached the daily budget. The columns values set read-only false can be inserted in the parent table using Temp tables.

Table Specific Information

Select

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

AccountId supports the '='.
Type supports the '=,IN'.

For example:

SELECT * FROM RecommendationDailyBudgetOverDailyBudgetOverCampaignLists WHERE AccountId = '1002504155' AND Type = 'DAILY_BUDGET_OVER'

Columns


Name	Type	References	Description
AccountId	Int64	DisplayAdsAccounts.AccountId	Account ID.
CampaignId	Int64		Campaign ID.
CampaignName	String		Campaign Name
CurrentBudget	Int64		Current campaign budget.
RecommendationId	Int64		Recommendation ID.
Type	String		Type of Recommendations The allowed values are DAILY_BUDGET_OVER, IMPRESSION_SHARE_BUDGET_LOSS_OVER, BID_STRATEGY_TO_TARGET_CPA, SEARCH_KEYWORD_LIST_IDEA, CAMPAIGNS_FOR_ADDING_ADS, UNKNOWN.

RecommendationImpsShareBudgetLossOverImpsShareBudgetLossOverCampaignLists

Retrieve the information of campaigns that have a large lost impression share (budget). The columns values set read-only false can be inserted in the parent table using Temp tables.

Table Specific Information

Select

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

AccountId supports the '='.
Type supports the '=,IN'.

For example:

SELECT * FROM RecommendationImpsShareBudgetLossOverImpsShareBudgetLossOverCampaignLists WHERE AccountId = '1002504155' AND Type = 'DAILY_BUDGET_OVER'

Columns


Name	Type	References	Description
AccountId	Int64	DisplayAdsAccounts.AccountId	Account ID.
CampaignId	Int64		Campaign ID.
CampaignName	String		Campaign Name.
CurrentBudget	Int64		Current campaign budget
RecommendationId	Int64		Recommendation ID
RecommendedBudget	Int64		Recommended campaign budget setting.
Type	String		Type of Recommendations The allowed values are DAILY_BUDGET_OVER, IMPRESSION_SHARE_BUDGET_LOSS_OVER, BID_STRATEGY_TO_TARGET_CPA, SEARCH_KEYWORD_LIST_IDEA, CAMPAIGNS_FOR_ADDING_ADS, UNKNOWN.

Recommendations

Get Recommendations information.

Table Specific Information

SELECT

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

AccountId supports the '='.
Type supports the '=,IN'.

For example:

SELECT * FROM Recommendations WHERE AccountId = '1002504155' AND Type = 'DAILY_BUDGET_OVER'

Columns


Name	Type	References	Description
AccountId	Int64		Account ID
CampaignBiddingStrategyToTargetCpaCampaignBiddingStrategyToTargetCpaCampaignList	String		Recommendation information about the campaign that is suitable for using autobidding
DailyBudgetOverDailyBudgetOverCampaignList	String		Recommendation information about campaigns that reached the daily budget.
ImpsShareBudgetLossOverImpsShareBudgetLossOverCampaignList	String		Recommendations information of campaigns that have a large lost impression share (budget).
SearchKeywordIdeaSearchKeywordIdeaSearchKeywordList	String		This describes the detailed information of recommended search keyword to add.
Type	String		Type of Recommendations The allowed values are DAILY_BUDGET_OVER, IMPRESSION_SHARE_BUDGET_LOSS_OVER, BID_STRATEGY_TO_TARGET_CPA, SEARCH_KEYWORD_LIST_IDEA, CAMPAIGNS_FOR_ADDING_ADS, UNKNOWN.

RecommendationSearchKeywordIdeaSearchKeywordIdeaSearchKeywordLists

Retrieve the details of recommended search keyword to add. The columns values set read-only false can be inserted in the parent table using Temp tables.

Table Specific Information

Select

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

AccountId supports the '='.
Type supports the '=,IN'.

For example:

SELECT * FROM RecommendationSearchKeywordIdeaSearchKeywordIdeaSearchKeywordLists WHERE AccountId = '1002504155' AND Type = 'DAILY_BUDGET_OVER'

Columns


Name	Type	References	Description
AccountId	Int64	DisplayAdsAccounts.AccountId	Account ID.
CurrentSearchKeywordFrequency	String		Frequency of search keyword list.
CurrentSearchKeywordListId	Int64		Search keyword list ID.
CurrentSearchKeywordListName	String		Search keyword list name.
CurrentSearchKeywordRecency	String		Recency of search keyword list.
DesktopSearchVolume	Int64		Number of reach in PC with recommended search keyword
RecommendationId	Int64		Recommendation ID.
RecommendedSearchKeyword	String		Recommended search keyword.
RecommendedSearchKeywordId	Int64		Recommended search keyword ID.
SmartPhoneSearchVolume	Int64		Number of Reach in SmartPhone with recommended search keyword.
TabletSearchVolume	Int64		Number of Reach in Tablet with recommended search keyword.
Type	String		Type of Recommendations The allowed values are DAILY_BUDGET_OVER, IMPRESSION_SHARE_BUDGET_LOSS_OVER, BID_STRATEGY_TO_TARGET_CPA, SEARCH_KEYWORD_LIST_IDEA, CAMPAIGNS_FOR_ADDING_ADS, UNKNOWN.

SearchKeywordIdeas

Get the keyword for search targeting.

Table Specific Information

SELECT

The Sync App will use the Yahoo! Ads API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App. Note: AccountId is required for Select on this table

SearchKeywordId supports the '=,IN'.
AvailabilityStatus supports the '='.
SearchKeyword supports the '=,IN'.
KeywordFrequency supports the '='.
KeywordRecency supports the '='.
MatchType supports the '='.
SortField supports the '='.
SortType supports the '='.

For example:

SELECT * FROM SearchKeywordIdeas WHERE AvailabilityStatus = 'AVAILABLE' LIMIT 10

Columns


Name	Type	References	Description
SearchKeywordId [KEY]	Int64		Search Keyword ID
AvailabilityStatus	String		Availability of keywords for search targeting The allowed values are AVAILABLE, UNAVAILABLE, UNKNOWN.
CloseDate	Date		Stop date of keyword.
DesktopSearchVolume	Int64		Reach numbers on PC.
ReleaseDate	Date		Additional date of keyword.
SearchKeyword	String		Search Keyword.
SmartPhoneSearchVolume	Int64		Reach numbers on Smartphone.
TabletSearchVolume	Int64		Reach numbers on Tablet.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
KeywordFrequency	String		search frequency information on Search Keyword. The allowed values are ONCE_OR_MORE, TWICE_OR_MORE, THREE_TIMES_OR_MORE, UNKNOWN.
KeywordRecency	String		Storing the effective period information of Search Keyword. The allowed values are WITHIN_1DAY, WITHIN_3DAYS, WITHIN_7DAYS, WITHIN_14DAYS, WITHIN_30DAYS, UNKNOWN.
MatchType	String		Search method The allowed values are EXACT, BROAD, UNKNOWN.

SearchKeywordListSearchKeywords

Retrieve the details of search keyword. The columns values set read-only false can be inserted in the parent table using Temp tables.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
SearchKeywordListId supports the 'IN,='.

For example:

SELECT * FROM SearchKeywordListSearchKeywords WHERE AccountId = '1002504155'

SELECT * FROM SearchKeywordListSearchKeywords WHERE AccountId = '1002504155' AND SearchKeywordListId = '1002346070'

Columns


Name	Type	References	Description
AccountId	Int64	DisplayAdsAccounts.AccountId	Account ID.
SearchKeywordListId	Int64	SearchKeywordList.SearchKeywordListId	Search keyword list ID.
SearchKeywordId	Int64		Search keyword ID.

SearchLifts

Get SearchLift information.

Table Specific Information

SELECT

The Sync App 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 Sync App.

AccountId supports the '='.
SearchLiftId supports the '=,IN'.
CampaignId supports the '=,IN'.

For example:

SELECT * FROM SearchLifts WHERE AccountId = '1002504155'

SELECT * FROM SearchLifts WHERE AccountId = '1002504155' AND SearchLiftId = '1234567'

SELECT * FROM SearchLifts WHERE AccountId = '1002504155' AND CampaignId IN ('1234567','25678')

Columns


Name	Type	References	Description
SearchLiftId [KEY]	Int64		SearchLift ID.
AccountId	Int64	DisplayAdsAccounts.AccountId	Account ID.
CampaignId	Int64	DisplayAdsCampaigns.CampaignId	Campaign ID
Keywords	String		Describes information about the keyword of the search lift.

SearchLiftskeywords

Retrieve the details of keyword of the search lift. The columns values set read-only false can be inserted in the parent table using Temp tables.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
SearchLiftId supports the '=,IN'.
CampaignId supports the '=,IN'.

For example:

SELECT * FROM SearchLiftskeywords WHERE AccountId = '1002504155'

SELECT * FROM SearchLiftskeywords WHERE AccountId = '1002504155' AND SearchLiftId = '1234567'

SELECT * FROM SearchLiftskeywords WHERE AccountId = '1002504155' AND CampaignId IN ('1234567','25678')

Columns


Name	Type	References	Description
SearchLiftId	Int64		SearchLift ID.
AccountId	Int64	DisplayAdsAccounts.AccountId	Account ID.
CampaignId	Int64	DisplayAdsCampaigns.CampaignId	Campaign ID
Keyword	String		Keyword.
KeywordCategory	String		keyword category The allowed values are BRAND, SERVICE, CAMPAIGN, UNKNOWN.

SiteCategories

Get the list of site category.

Table Specific Information

SELECT

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

Lang supports the '='.

For example:

SELECT * FROM SiteCategories WHERE Lang = 'EN'
        
SELECT * FROM SiteCategories WHERE Lang = 'EN' AND CODE = 'TC-SC-10110100100100'

Columns


Name	Type	References	Description
Code	String		Category code.
FullName	String		Category name in high level.
Name	String		Category name.
ReachDesktop	Int64		Reach record number of PC
ReachSmartphone	Int64		Reach record number of smartphone
ReachTablet	Int64		Reach record number of tablet
Lang	String		language selection of the list. The allowed values are EN, JA, UNKNOWN.

StationPlacementCategories

Get list of station information included in placement category list.

Table Specific Information

Select

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

PlacementCategoryListId supports the '=,IN'.

For example:

SELECT * FROM StationPlacementCategories WHERE PlacementCategoryListId = '1002504155'

Columns


Name	Type	References	Description
PlacementCategoryListId	String		Placement category list ID
PlacementCategoryListName	String		Placement category list name
PlacementCategories	String		DictionaryServicePlacementCategory object contains information about station

StationPlacementCategoryPlacementCategories

Get list of station information included in placement category list.

Table Specific Information

Select

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

PlacementCategoryListId supports the '=,IN'.

For example:

SELECT * FROM StationPlacementCategoryPlacementCategories WHERE PlacementCategoryListId = '1002504155'

Columns


Name	Type	References	Description
PlacementCategoryListId	String		Placement category list ID
PlacementCategoryNameJa	String		Station name(Ja)
placementCategoryNameEn	String		Station name(Eng)

Stats

Get the stats information of each campaign, ad group, ad, image and video.

Table Specific Information

SELECT

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

AccountId supports the '='.
StatsPeriod supports the '='.
Type supports the '='.
campaignId supports the '=,IN'.
adGroupId supports the '=,IN'.
adId supports the '=,IN'.
mediaId supports the '=,IN'.
StatsEndDate supports the '='.
StatsStartDate supports the '='.
targetType supports the '=,IN'.

For example:

SELECT * FROM Stats WHERE AccountId = '1002504155'

SELECT  * FROM Stats WHERE AccountId = '1002504155' AND CampaignId = '1833923'

SELECT  * FROM Stats WHERE AccountId = '1002504155' AND Type = 'CAMPAIGN'

SELECT  * FROM Stats WHERE AccountId = '1002504155' AND AdGroupId = '303133212'

SELECT  * FROM Stats WHERE AccountId = '1002504155' AND StatsPeriod = 'REALTIME_MONTH'

SELECT  * FROM Stats WHERE AccountId = '1002504155' AND StatsStartDate = '20210703'

SELECT  * FROM Stats WHERE AccountId = '1002504155' AND StatsEndDate = '20210703'

Columns


Name	Type	References	Description
AccountId [KEY]	Int64	DisplayAdsAccounts.AccountId	Account ID.
AdGroupStatsValueAdGroupId	Int64		Ad group ID.
AdGroupStatsValueAdGroupName	String		Ad group name.
AdGroupStatsValueCampaignId	Int64		Campaign ID.
AdGroupStatsValueCampaignName	String		Campaign name.
AdGroupStatsValueStatsAllConversionRate	String		Conv. rate (all)
AdGroupStatsValueStatsAllConversions	Int64		Conversions (all)
AdGroupStatsValueStatsAllConversionValue	String		Conv. value (all)
AdGroupStatsValueStatsAllConvValuePerCost	String		Conv. value (all)/cost All Conv.
AdGroupStatsValueStatsAllCpa	String		Cost/conv. (all)
AdGroupStatsValueStatsAverageCpv	String		Avg. CPV
AdGroupStatsValueStatsAverageDurationVideoViewed	String		Avg. duration of video viewed
AdGroupStatsValueStatsAverageRateVideoViewed	String		Avg. video view rate
AdGroupStatsValueStatsAvgCpc	String		Avg. CPC
AdGroupStatsValueStatsAvgDeliverRank	String		Avg. position (the average of eCPM rank on ads delivery)
AdGroupStatsValueStatsBudgetImpressionShareLostRate	String		Impression share lost rate(budget)
AdGroupStatsValueStatsClickCnt	Int64		Number of clicks
AdGroupStatsValueStatsClickRate	String		Click through rate
AdGroupStatsValueStatsClickRatePrev	String		CTR (previous)
AdGroupStatsValueStatsConversionRate	String		Conv. rate
AdGroupStatsValueStatsConversionRateViaAdClick	String		Conv. rate (via click)
AdGroupStatsValueStatsConversions	Int64		Conversions
AdGroupStatsValueStatsConversionsViaAdClick	Int64		Conversions (via click)
AdGroupStatsValueStatsConversionValue	String		Conv. value
AdGroupStatsValueStatsConversionValueViaAdClick	String		Conv. value (via click)
AdGroupStatsValueStatsConvValuePerCost	String		Conversions value/cost
AdGroupStatsValueStatsConvValueViaAdClickPerCost	String		Conversions value(via ad clicks)/cost
AdGroupStatsValueStatsCost	String		Cost
AdGroupStatsValueStatsCpa	String		Conversion cost per acquisition
AdGroupStatsValueStatsCpaViaAdClick	String		Cost/conv. (via click)
AdGroupStatsValueStatsCrossDeviceConversions	Int64		Cross-device conv.
AdGroupStatsValueStatsImpressionShare	String		Impression share
AdGroupStatsValueStatsImps	Int64		Number of impressions
AdGroupStatsValueStatsImpsPrev	String		Impressions (previous)
AdGroupStatsValueStatsInViewClickCnt	Int64		Viewable clicks (previous)
AdGroupStatsValueStatsInViewClickRate	String		Viewable CTR (previous)
AdGroupStatsValueStatsInViewRate	String		Viewable impression rate (previous)
AdGroupStatsValueStatsMeasuredImps	String		Measured impressions
AdGroupStatsValueStatsMeasuredImpsRate	String		Measured impression rate
AdGroupStatsValueStatsPaidVideoViewRate	String		Paid video view rate (CPV)
AdGroupStatsValueStatsPaidVideoViews	Int64		Paid video views (CPV)
AdGroupStatsValueStatsRankImpressionShareLostRate	String		Impression share lost rate(rank)
AdGroupStatsValueStatsTotalVimps	Int64		Measured impressions (previous)
AdGroupStatsValueStatsValuePerAllConversions	String		Conv. value (all)/conv. (all)
AdGroupStatsValueStatsValuePerConversions	String		Conv. value/conv.
AdGroupStatsValueStatsValuePerConversionsViaAdClick	String		Conv. value (via click)/conv. (via click)
AdGroupStatsValueStatsVideoViews	Int64		Video views
AdGroupStatsValueStatsVideoViewsTo100	Int64		100% video views
AdGroupStatsValueStatsVideoViewsTo10Sec	Int64		10 sec video views
AdGroupStatsValueStatsVideoViewsTo25	Int64		25% video views
AdGroupStatsValueStatsVideoViewsTo3Sec	Int64		3 sec video views
AdGroupStatsValueStatsVideoViewsTo50	Int64		50% video views
AdGroupStatsValueStatsVideoViewsTo75	Int64		75% video views
AdGroupStatsValueStatsVideoViewsTo95	Int64		95% video views
AdGroupStatsValueStatsVideoViewThroughRate	String		Video view through rate
AdGroupStatsValueStatsViewableClickRate	String		Viewable CTR
AdGroupStatsValueStatsViewableClicks	String		Viewable clicks
AdGroupStatsValueStatsViewableImpsRate	String		Viewable impression rate
AdGroupStatsValueStatsViewThroughConversions	Int64		View through conversions
AdGroupStatsValueStatsVimps	Int64		Viewable impressions
AdStatsValueAdGroupId	Int64		Ad group ID
AdStatsValueAdGroupName	String		Ad group name
AdStatsValueAdId	Int64		Ad ID
AdStatsValueAdName	String		Ad name
AdStatsValueCampaignId	Int64		Campaign ID.
AdStatsValueCampaignName	String		Campaign name.
AdStatsValueStatsAllConversionRate	String		Conv. rate (all)
AdStatsValueStatsAllConversions	Int64		Conversions (all)
AdStatsValueStatsAllConversionValue	String		Conv. value (all)
AdStatsValueStatsAllConvValuePerCost	String		Conv. value (all)/cost All Conv.
AdStatsValueStatsAllCpa	String		Cost/conv. (all)
AdStatsValueStatsAverageCpv	String		Avg. CPV
AdStatsValueStatsAverageDurationVideoViewed	String		Avg. duration of video viewed
AdStatsValueStatsAverageRateVideoViewed	String		Avg. video view rate
AdStatsValueStatsAvgCpc	String		Avg. CPC
AdStatsValueStatsAvgDeliverRank	String		Avg. position (the average of eCPM rank on ads delivery)
AdStatsValueStatsBudgetImpressionShareLostRate	String		Impression share lost rate(budget)
AdStatsValueStatsClickCnt	Int64		Number of clicks
AdStatsValueStatsClickRate	String		Click through rate
AdStatsValueStatsClickRatePrev	String		CTR (previous)
AdStatsValueStatsConversionRate	String		Conv. rate
AdStatsValueStatsConversionRateViaAdClick	String		Conv. rate (via click)
AdStatsValueStatsConversions	Int64		Conversions
AdStatsValueStatsConversionsViaAdClick	Int64		Conversions (via click)
AdStatsValueStatsConversionValue	String		Conv. value
AdStatsValueStatsConversionValueViaAdClick	String		Conv. value (via click)
AdStatsValueStatsConvValuePerCost	String		Conversions value/cost
AdStatsValueStatsConvValueViaAdClickPerCost	String		Conversions value(via ad clicks)/cost
AdStatsValueStatsCost	String		Cost
AdStatsValueStatsCpa	String		Conversion cost per acquisition
AdStatsValueStatsCpaViaAdClick	String		Cost/conv. (via click)
AdStatsValueStatsCrossDeviceConversions	Int64		Cross-device conv.
AdStatsValueStatsImpressionShare	String		Impression share
AdStatsValueStatsImps	Int64		Number of impressions
AdStatsValueStatsImpsPrev	String		Impressions (previous)
AdStatsValueStatsInViewClickCnt	Int64		Viewable clicks (previous)
AdStatsValueStatsInViewClickRate	String		Viewable CTR (previous)
AdStatsValueStatsInViewRate	String		Viewable impression rate (previous)
AdStatsValueStatsMeasuredImps	String		Measured impressions
AdStatsValueStatsMeasuredImpsRate	String		Measured impression rate
AdStatsValueStatsPaidVideoViewRate	String		Paid video view rate (CPV)
AdStatsValueStatsPaidVideoViews	Int64		Paid video views (CPV)
AdStatsValueStatsRankImpressionShareLostRate	String		Impression share lost rate(rank)
AdStatsValueStatsTotalVimps	Int64		Measured impressions (previous)
AdStatsValueStatsValuePerAllConversions	String		Conv. value (all)/conv. (all)
AdStatsValueStatsValuePerConversions	String		Conv. value/conv.
AdStatsValueStatsValuePerConversionsViaAdClick	String		Conv. value (via click)/conv. (via click)
AdStatsValueStatsVideoViews	Int64		Video views
AdStatsValueStatsVideoViewsTo100	Int64		100% video views
AdStatsValueStatsVideoViewsTo10Sec	Int64		10 sec video views
AdStatsValueStatsVideoViewsTo25	Int64		25% video views
AdStatsValueStatsVideoViewsTo3Sec	Int64		3 sec video views
AdStatsValueStatsVideoViewsTo50	Int64		50% video views
AdStatsValueStatsVideoViewsTo75	Int64		75% video views
AdStatsValueStatsVideoViewsTo95	Int64		95% video views
AdStatsValueStatsVideoViewThroughRate	String		Video view through rate
AdStatsValueStatsViewableClickRate	String		Viewable CTR
AdStatsValueStatsViewableClicks	String		Viewable clicks
AdStatsValueStatsViewableImpsRate	String		Viewable impression rate
AdStatsValueStatsViewThroughConversions	Int64		View through conversions
AdStatsValueStatsVimps	Int64		Viewable impressions
CampaignStatsValueCampaignId	Int64		Campaign ID.
CampaignStatsValueCampaignName	String		Campaign name.
CampaignStatsValueStatsAllConversionRate	String		Conv. rate (all)
CampaignStatsValueStatsAllConversions	Int64		Conversions (all)
CampaignStatsValueStatsAllConversionValue	String		Conv. value (all)
CampaignStatsValueStatsAllConvValuePerCost	String		Conv. value (all)/cost All Conv.
CampaignStatsValueStatsAllCpa	String		Cost/conv. (all)
CampaignStatsValueStatsAverageCpv	String		Avg. CPV
CampaignStatsValueStatsAverageDurationVideoViewed	String		Avg. duration of video viewed
CampaignStatsValueStatsAverageRateVideoViewed	String		Avg. video view rate
CampaignStatsValueStatsAvgCpc	String		Avg. CPC
CampaignStatsValueStatsAvgDeliverRank	String		Avg. position (the average of eCPM rank on ads delivery)
CampaignStatsValueStatsBudgetImpressionShareLostRate	String		Impression share lost rate(budget)
CampaignStatsValueStatsClickCnt	Int64		Number of clicks
CampaignStatsValueStatsClickRate	String		Click through rate
CampaignStatsValueStatsClickRatePrev	String		CTR (previous)
CampaignStatsValueStatsConversionRate	String		Conv. rate
CampaignStatsValueStatsConversionRateViaAdClick	String		Conv. rate (via click)
CampaignStatsValueStatsConversions	Int64		Conversions
CampaignStatsValueStatsConversionsViaAdClick	Int64		Conversions (via click)
CampaignStatsValueStatsConversionValue	String		Conv. value
CampaignStatsValueStatsConversionValueViaAdClick	String		Conv. value (via click)
CampaignStatsValueStatsConvValuePerCost	String		Conversions value/cost
CampaignStatsValueStatsConvValueViaAdClickPerCost	String		Conversions value(via ad clicks)/cost
CampaignStatsValueStatsCost	String		Cost
CampaignStatsValueStatsCpa	String		Conversion cost per acquisition
CampaignStatsValueStatsCpaViaAdClick	String		Cost/conv. (via click)
CampaignStatsValueStatsCrossDeviceConversions	Int64		Cross-device conv.
CampaignStatsValueStatsImpressionShare	String		Impression share
CampaignStatsValueStatsImps	Int64		Number of impressions
CampaignStatsValueStatsImpsPrev	String		Impressions (previous)
CampaignStatsValueStatsInViewClickCnt	Int64		Viewable clicks (previous)
CampaignStatsValueStatsInViewClickRate	String		Viewable CTR (previous)
CampaignStatsValueStatsInViewRate	String		Viewable impression rate (previous)
CampaignStatsValueStatsMeasuredImps	String		Measured impressions
CampaignStatsValueStatsMeasuredImpsRate	String		Measured impression rate
CampaignStatsValueStatsPaidVideoViewRate	String		Paid video view rate (CPV)
CampaignStatsValueStatsPaidVideoViews	Int64		Paid video views (CPV)
CampaignStatsValueStatsRankImpressionShareLostRate	String		Impression share lost rate(rank)
CampaignStatsValueStatsTotalVimps	Int64		Measured impressions (previous)
CampaignStatsValueStatsValuePerAllConversions	String		Conv. value (all)/conv. (all)
CampaignStatsValueStatsValuePerConversions	String		Conv. value/conv.
CampaignStatsValueStatsValuePerConversionsViaAdClick	String		Conv. value (via click)/conv. (via click)
CampaignStatsValueStatsVideoViews	Int64		Video views
CampaignStatsValueStatsVideoViewsTo100	Int64		100% video views
CampaignStatsValueStatsVideoViewsTo10Sec	Int64		10 sec video views
CampaignStatsValueStatsVideoViewsTo25	Int64		25% video views
CampaignStatsValueStatsVideoViewsTo3Sec	Int64		3 sec video views
CampaignStatsValueStatsVideoViewsTo50	Int64		50% video views
CampaignStatsValueStatsVideoViewsTo75	Int64		75% video views
CampaignStatsValueStatsVideoViewsTo95	Int64		95% video views
CampaignStatsValueStatsVideoViewThroughRate	String		Video view through rate
CampaignStatsValueStatsViewableClickRate	String		Viewable CTR
CampaignStatsValueStatsViewableClicks	String		Viewable clicks
CampaignStatsValueStatsViewableImpsRate	String		Viewable impression rate
CampaignStatsValueStatsViewThroughConversions	Int64		View through conversions
CampaignStatsValueStatsVimps	Int64		Viewable impressions
Errors	String		Error information.
ImageStatsValueMediaId	Int64		Media ID
ImageStatsValueMediaName	String		File name
ImageStatsValueMediaTitle	String		Media title
ImageStatsValueStatsAllConversionRate	String		Conv. rate (all)
ImageStatsValueStatsAllConversions	Int64		Conversions (all)
ImageStatsValueStatsAllConversionValue	String		Conv. value (all)
ImageStatsValueStatsAllConvValuePerCost	String		Conv. value (all)/cost All Conv.
ImageStatsValueStatsAllCpa	String		Cost/conv. (all)
ImageStatsValueStatsAverageCpv	String		Avg. CPV
ImageStatsValueStatsAverageDurationVideoViewed	String		Avg. duration of video viewed
ImageStatsValueStatsAverageRateVideoViewed	String		Avg. video view rate
ImageStatsValueStatsAvgCpc	String		Avg. CPC
ImageStatsValueStatsAvgDeliverRank	String		Avg. position (the average of eCPM rank on ads delivery)
ImageStatsValueStatsBudgetImpressionShareLostRate	String		Impression share lost rate(budget)
ImageStatsValueStatsClickCnt	Int64		Number of clicks
ImageStatsValueStatsClickRate	String		Click through rate
ImageStatsValueStatsClickRatePrev	String		CTR (previous)
ImageStatsValueStatsConversionRate	String		Conv. rate
ImageStatsValueStatsConversionRateViaAdClick	String		Conv. rate (via click)
ImageStatsValueStatsConversions	Int64		Conversions
ImageStatsValueStatsConversionsViaAdClick	Int64		Conversions (via click)
ImageStatsValueStatsConversionValue	String		Conv. value
ImageStatsValueStatsConversionValueViaAdClick	String		Conv. value (via click)
ImageStatsValueStatsConvValuePerCost	String		Conversions value/cost
ImageStatsValueStatsConvValueViaAdClickPerCost	String		Conversions value(via ad clicks)/cost
ImageStatsValueStatsCost	String		Cost
ImageStatsValueStatsCpa	String		Conversion cost per acquisition
ImageStatsValueStatsCpaViaAdClick	String		Cost/conv. (via click)
ImageStatsValueStatsCrossDeviceConversions	Int64		Cross-device conv.
ImageStatsValueStatsImpressionShare	String		Impression share
ImageStatsValueStatsImps	Int64		Number of impressions
ImageStatsValueStatsImpsPrev	String		Impressions (previous)
ImageStatsValueStatsInViewClickCnt	Int64		Viewable clicks (previous)
ImageStatsValueStatsInViewClickRate	String		Viewable CTR (previous)
ImageStatsValueStatsInViewRate	String		Viewable impression rate (previous)
ImageStatsValueStatsMeasuredImps	String		Measured impressions
ImageStatsValueStatsMeasuredImpsRate	String		Measured impression rate
ImageStatsValueStatsPaidVideoViewRate	String		Paid video view rate (CPV)
ImageStatsValueStatsPaidVideoViews	Int64		Paid video views (CPV)
ImageStatsValueStatsRankImpressionShareLostRate	String		Impression share lost rate(rank)
ImageStatsValueStatsTotalVimps	Int64		Measured impressions (previous)
ImageStatsValueStatsValuePerAllConversions	String		Conv. value (all)/conv. (all)
ImageStatsValueStatsValuePerConversions	String		Conv. value/conv.
ImageStatsValueStatsValuePerConversionsViaAdClick	String		Conv. value (via click)/conv. (via click)
ImageStatsValueStatsVideoViews	Int64		Video views
ImageStatsValueStatsVideoViewsTo100	Int64		100% video views
ImageStatsValueStatsVideoViewsTo10Sec	Int64		10 sec video views
ImageStatsValueStatsVideoViewsTo25	Int64		25% video views
ImageStatsValueStatsVideoViewsTo3Sec	Int64		3 sec video views
ImageStatsValueStatsVideoViewsTo50	Int64		50% video views
ImageStatsValueStatsVideoViewsTo75	Int64		75% video views
ImageStatsValueStatsVideoViewsTo95	Int64		95% video views
ImageStatsValueStatsVideoViewThroughRate	String		Video view through rate
ImageStatsValueStatsViewableClickRate	String		Viewable CTR
ImageStatsValueStatsViewableClicks	String		Viewable clicks
ImageStatsValueStatsViewableImpsRate	String		Viewable impression rate
ImageStatsValueStatsViewThroughConversions	Int64		View through conversions
ImageStatsValueStatsVimps	Int64		Viewable impressions
OperationSucceeded	Boolean		The process results. If true, the process succeeded. If false, the process failed.
PeriodCustomDateStatsEndDate	Date		Acquisition end date of stats information.
PeriodCustomDateStatsStartDate	Date		Acquisition start date of stats information.
StatsPeriod	String		Summarized period of statistics The allowed values are REALTIME_TODAY, DEFINITE_VALUE_YESTERDAY, DEFINITE_VALUE_LASTWEEK, DEFINITE_VALUE_LASTBSDAY, DEFINITE_VALUE_WEEK, DEFINITE_VALUE_TWOWEEK, DEFINITE_VALUE_THIRTYDAY, REALTIME_MONTH, DEFINITE_VALUE_LASTMONTH, DEFINITE_VALUE_LAST13MONTH, CUSTOM_DATE, UNKNOWN.
TargetStatsValueAdGroupId	Int64		Ad group ID.
TargetStatsValueAdGroupName	String		Ad group name.
TargetStatsValueCampaignId	Int64		Campaign ID.
TargetStatsValueCampaignName	String		Campaign name.
TargetStatsValueStatsAllConversionRate	String		Conv. rate (all)
TargetStatsValueStatsAllConversions	Int64		Conversions (all)
TargetStatsValueStatsAllConversionValue	String		Conv. value (all)
TargetStatsValueStatsAllConvValuePerCost	String		Conv. value (all)/cost All Conv.
TargetStatsValueStatsAllCpa	String		Cost/conv. (all)
TargetStatsValueStatsAverageCpv	String		Avg. CPV
TargetStatsValueStatsAverageDurationVideoViewed	String		Avg. duration of video viewed
TargetStatsValueStatsAverageRateVideoViewed	String		Avg. video view rate
TargetStatsValueStatsAvgCpc	String		Avg. CPC
TargetStatsValueStatsAvgDeliverRank	String		Avg. position (the average of eCPM rank on ads delivery)
TargetStatsValueStatsBudgetImpressionShareLostRate	String		Impression share lost rate(budget)
TargetStatsValueStatsClickCnt	Int64		Number of clicks
TargetStatsValueStatsClickRate	String		Click through rate
TargetStatsValueStatsClickRatePrev	String		CTR (previous)
TargetStatsValueStatsConversionRate	String		Conv. rate
TargetStatsValueStatsConversionRateViaAdClick	String		Conv. rate (via click)
TargetStatsValueStatsConversions	Int64		Conversions
TargetStatsValueStatsConversionsViaAdClick	Int64		Conversions (via click)
TargetStatsValueStatsConversionValue	String		Conv. value
TargetStatsValueStatsConversionValueViaAdClick	String		Conv. value (via click)
TargetStatsValueStatsConvValuePerCost	String		Conversions value/cost
TargetStatsValueStatsConvValueViaAdClickPerCost	String		Conversions value(via ad clicks)/cost
TargetStatsValueStatsCost	String		Cost
TargetStatsValueStatsCpa	String		Conversion cost per acquisition
TargetStatsValueStatsCpaViaAdClick	String		Cost/conv. (via click)
TargetStatsValueStatsCrossDeviceConversions	Int64		Cross-device conv.
TargetStatsValueStatsImpressionShare	String		Impression share
TargetStatsValueStatsImps	Int64		Number of impressions
TargetStatsValueStatsImpsPrev	String		Impressions (previous)
TargetStatsValueStatsInViewClickCnt	Int64		Viewable clicks (previous)
TargetStatsValueStatsInViewClickRate	String		Viewable CTR (previous)
TargetStatsValueStatsInViewRate	String		Viewable impression rate (previous)
TargetStatsValueStatsMeasuredImps	String		Measured impressions
TargetStatsValueStatsMeasuredImpsRate	String		Measured impression rate
TargetStatsValueStatsPaidVideoViewRate	String		Paid video view rate (CPV)
TargetStatsValueStatsPaidVideoViews	Int64		Paid video views (CPV)
TargetStatsValueStatsRankImpressionShareLostRate	String		Impression share lost rate(rank)
TargetStatsValueStatsTotalVimps	Int64		Measured impressions (previous)
TargetStatsValueStatsValuePerAllConversions	String		Conv. value (all)/conv. (all)
TargetStatsValueStatsValuePerConversions	String		Conv. value/conv.
TargetStatsValueStatsValuePerConversionsViaAdClick	String		Conv. value (via click)/conv. (via click)
TargetStatsValueStatsVideoViews	Int64		Video views
TargetStatsValueStatsVideoViewsTo100	Int64		100% video views
TargetStatsValueStatsVideoViewsTo10Sec	Int64		10 sec video views
TargetStatsValueStatsVideoViewsTo25	Int64		25% video views
TargetStatsValueStatsVideoViewsTo3Sec	Int64		3 sec video views
TargetStatsValueStatsVideoViewsTo50	Int64		50% video views
TargetStatsValueStatsVideoViewsTo75	Int64		75% video views
TargetStatsValueStatsVideoViewsTo95	Int64		95% video views
TargetStatsValueStatsVideoViewThroughRate	String		Video view through rate
TargetStatsValueStatsViewableClickRate	String		Viewable CTR
TargetStatsValueStatsViewableClicks	String		Viewable clicks
TargetStatsValueStatsViewableImpsRate	String		Viewable impression rate
TargetStatsValueStatsViewThroughConversions	Int64		View through conversions
TargetStatsValueStatsVimps	Int64		Viewable impressions
TargetStatsValueTargetAdScheduleTargetDayOfWeek	String		Days of the week to deliver. The allowed values are MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY, UNKNOWN.
TargetStatsValueTargetAdScheduleTargetEndHour	Int64		End time (hour only)
TargetStatsValueTargetAdScheduleTargetStartHour	Int64		Start time (hour only)
TargetStatsValueTargetAgeTargetAge	String		Format of age classification. The allowed values are GT_RANGE13_14, GT_RANGE15_17, GT_RANGE18_19, GT_RANGE20_21, GT_RANGE22_29, GT_RANGE30_39, GT_RANGE40_49, GT_RANGE50_59, GT_RANGE60_69, GT_RANGE70_UL, GT_UNKNOWN, GT_RANGE15_19, GT_RANGE20_24, GT_RANGE25_29, GT_RANGE30_34, GT_RANGE35_39, GT_RANGE40_44, GT_RANGE45_49, GT_RANGE50_54, GT_RANGE55_59, GT_RANGE60_64, GT_RANGE65_69, GT_RANGE70_UL2, GT_UNKNOWN2, UNKNOWN.
TargetStatsValueTargetAgeTargetEstimateFlg	String		delivery settings The allowed values are PAUSED, ACTIVE, UNKNOWN.
TargetStatsValueTargetAppTargetDeviceAppType	String		Type of delivery application. The allowed values are APP, WEB, UNKNOWN.
TargetStatsValueTargetAudienceCategoryTargetAudienceCategoryType	String		Audience category information.
TargetStatsValueTargetAudienceCategoryTargetCategoryNameEn	String		Category name (English)
TargetStatsValueTargetAudienceCategoryTargetCategoryNameJa	String		Category name (Japanese)
TargetStatsValueTargetCarrierTargetCarrierType	String		Stats Service Carrier Type The allowed values are DOCOMO, KDDI, SOFTBANK, YMOBILE, OTHERS, UNKNOWN.
TargetStatsValueTargetDeviceTargetDeviceType	String		Types of target devices. The allowed values are DESKTOP, WAP_MOBILE, SMARTPHONE, TABLET, UNKNOWN.
TargetStatsValueTargetGenderTargetEstimateFlg	String		Extended delivery settings The allowed values are PAUSED, ACTIVE, UNKNOWN.
TargetStatsValueTargetGenderTargetGender	String		Types of gender The allowed values are ST_MALE, ST_FEMALE, ST_UNKNOWN, UNKNOWN.
TargetStatsValueTargetGeoTargetGeoNameEn	String		Geo name(English)
TargetStatsValueTargetGeoTargetGeoNameJa	String		Geo name(Japanese)
TargetStatsValueTargetInterestCategoryTargetCategoryFullNameEn	String		Interest category name (English)
TargetStatsValueTargetInterestCategoryTargetCategoryFullNameJa	String		Interest category name (Japanese
TargetStatsValueTargetOsTargetDeviceOsType	String		OS types of the delivery target device. The allowed values are IOS, ANDROID, UNKNOWN.
TargetStatsValueTargetOsVersionTargetOsVersion	String		OS Version
TargetStatsValueTargetPlacementTargetPlacementUrlListName	String		Placement Url List Name
TargetStatsValueTargetPlacementTargetPlacementUrlListType	String		Type of Placement URL list. The allowed values are WHITE_LIST, BLACK_LIST, UNKNOWN.
TargetStatsValueTargetSearchTargetSearchKeywordListName	String		Search Keyword List name
TargetStatsValueTargetSiteCategoryTargetCategoryFullNameEn	String		Site category name (English)
TargetStatsValueTargetSiteCategoryTargetCategoryFullNameJa	String		Site category name (Japanese)
TargetStatsValueTargetSiteRetargetingTargetTargetListDeliverType	String		Type of target list The allowed values are INCLUDE, EXCLUDE, UNKNOWN.
TargetStatsValueTargetSiteRetargetingTargetTargetListName	String		Target list name
TargetStatsValueTargetTargetId	String		Stats Service Target ID
TargetStatsValueTargetTargetSetting	String		Setting information of target. The allowed values are NONE, ACTIVE, PAUSED, UNKNOWN.
TargetStatsValueTargetTargetType	String		Types of target The allowed values are AD_SCHEDULE_TARGET, GEO_TARGET, AGE_TARGET, GENDER_TARGET, INTEREST_CATEGORY, SITE_CATEGORY, SITE_RETARGETING, SEARCH_TARGET, PLACEMENT_TARGET, DEVICE_TARGET, CARRIER_TARGET, AUDIENCE_CATEGORY, PLACEMENT_CATEGORY_DETAIL_TARGET, UNKNOWN.
Type	String		Information type The allowed values are CAMPAIGN, ADGROUP, AD, IMAGE, VIDEO, TARGET, UNKNOWN.
VideoStatsValueMediaId	Int64		Media ID
VideoStatsValueStatsAllConversionRate	String		Conv. rate (all)
VideoStatsValueStatsAllConversions	Int64		Conversions (all)
VideoStatsValueStatsAllConversionValue	String		Conv. value (all)
VideoStatsValueStatsAllConvValuePerCost	String		Conv. value (all)/cost All Conv.
VideoStatsValueStatsAllCpa	String		Cost/conv. (all)
VideoStatsValueStatsAverageCpv	String		Avg. CPV
VideoStatsValueStatsAverageDurationVideoViewed	String		Avg. duration of video viewed
VideoStatsValueStatsAverageRateVideoViewed	String		Avg. video view rate
VideoStatsValueStatsAvgCpc	String		Avg. CPC
VideoStatsValueStatsAvgDeliverRank	String		Avg. position (the average of eCPM rank on ads delivery)
VideoStatsValueStatsBudgetImpressionShareLostRate	String		Impression share lost rate(budget)
VideoStatsValueStatsClickCnt	Int64		Number of clicks
VideoStatsValueStatsClickRate	String		Click through rate
VideoStatsValueStatsClickRatePrev	String		CTR (previous)
VideoStatsValueStatsConversionRate	String		Conv. rate
VideoStatsValueStatsConversionRateViaAdClick	String		Conv. rate (via click)
VideoStatsValueStatsConversions	Int64		Conversions
VideoStatsValueStatsConversionsViaAdClick	Int64		Conversions (via click)
VideoStatsValueStatsConversionValue	String		Conv. value
VideoStatsValueStatsConversionValueViaAdClick	String		Conv. value (via click)
VideoStatsValueStatsConvValuePerCost	String		Conversions value/cost
VideoStatsValueStatsConvValueViaAdClickPerCost	String		Conversions value(via ad clicks)/cost
VideoStatsValueStatsCost	String		Cost
VideoStatsValueStatsCpa	String		Conversion cost per acquisition
VideoStatsValueStatsCpaViaAdClick	String		Cost/conv. (via click)
VideoStatsValueStatsCrossDeviceConversions	Int64		Cross-device conv.
VideoStatsValueStatsImpressionShare	String		Impression share
VideoStatsValueStatsImps	Int64		Number of impressions
VideoStatsValueStatsImpsPrev	String		Impressions (previous)
VideoStatsValueStatsInViewClickCnt	Int64		Viewable clicks (previous)
VideoStatsValueStatsInViewClickRate	String		Viewable CTR (previous)
VideoStatsValueStatsInViewRate	String		Viewable impression rate (previous)
VideoStatsValueStatsMeasuredImps	String		Measured impressions
VideoStatsValueStatsMeasuredImpsRate	String		Measured impression rate
VideoStatsValueStatsPaidVideoViewRate	String		Paid video view rate (CPV)
VideoStatsValueStatsPaidVideoViews	Int64		Paid video views (CPV)
VideoStatsValueStatsRankImpressionShareLostRate	String		Impression share lost rate(rank)
VideoStatsValueStatsTotalVimps	Int64		Measured impressions (previous)
VideoStatsValueStatsValuePerAllConversions	String		Conv. value (all)/conv. (all)
VideoStatsValueStatsValuePerConversions	String		Conv. value/conv.
VideoStatsValueStatsValuePerConversionsViaAdClick	String		Conv. value (via click)/conv. (via click)
VideoStatsValueStatsVideoViews	Int64		Video views
VideoStatsValueStatsVideoViewsTo100	Int64		100% video views
VideoStatsValueStatsVideoViewsTo10Sec	Int64		10 sec video views
VideoStatsValueStatsVideoViewsTo25	Int64		25% video views
VideoStatsValueStatsVideoViewsTo3Sec	Int64		3 sec video views
VideoStatsValueStatsVideoViewsTo50	Int64		50% video views
VideoStatsValueStatsVideoViewsTo75	Int64		75% video views
VideoStatsValueStatsVideoViewsTo95	Int64		95% video views
VideoStatsValueStatsVideoViewThroughRate	String		Video view through rate
VideoStatsValueStatsViewableClickRate	String		Viewable CTR
VideoStatsValueVideoTitle	String		Video title
VideoStatsValueStatsViewableClicks	String		Viewable clicks
VideoStatsValueStatsViewableImpsRate	String		Viewable impression rate
VideoStatsValueStatsViewThroughConversions	Int64		View through conversions
VideoStatsValueStatsVimps	Int64		Viewable impressions
VideoStatsValueVideoName	String		File name

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
CampaignId	Int64		Campaign ID.
AdGroupId	Int64		Ad group ID.
AdId	Int64		Ad ID.
MediaId	Int64		Media ID.
StatsEndDate	Date		Acquisition end date of stats information.
StatsStartDate	Date		Acquisition start date of stats information.
TargetType	String		Types of target The allowed values are AD_SCHEDULE_TARGET, GEO_TARGET, AGE_TARGET, GENDER_TARGET, INTEREST_CATEGORY, SITE_CATEGORY, SITE_RETARGETING, SEARCH_TARGET, PLACEMENT_TARGET, DEVICE_TARGET, CARRIER_TARGET, AUDIENCE_CATEGORY, PLACEMENT_CATEGORY_DETAIL_TARGET, UNKNOWN.

ThirdPartyTrackingDomains

Get the domain and vendor name that can be specified for the third-party scripting URL.

Table Specific Information

SELECT

The driver does not support the filters on the server side. The rest of the filters are processed on the client side. For example, the following queries are processed server side:

SELECT * FROM ThirdPartyTrackingDomains

Columns


Name	Type	References	Description
Domain	String		Domain
Vendor	String		Third Party Tracking vendor
VendorName	String		Logical name of Third Party Tracking vendor

VideosVideoSettingExtraSpecs

It is an additional video quality that can be used other than the regular video qualities. The columns values set read-only false can be inserted in the parent table using Temp tables.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
MediaId supports the '='.

SELECT * FROM  VideosVideoSettingExtraSpecs WHERE AccountId = '1002504155';

SELECT * FROM VideosVideoSettingExtraSpecs WHERE AccountId = '1002504155' AND MediaId = '123456'

Columns


Name	Type	References	Description
MediaId	Int64		Audience List ID.
AccountId	Int64	DisplayAdsAccounts.AccountId	Account ID.
QualityType	String		Describes the type of video quality that can be used other than the regular video qualities.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
StartDate	Date		start date of the search target period.
EndDate	Date		end date of the search target period.
ReferenceNumber	String		This column will be used in Bulk operations to get specific values from the Temp tables.

SearchAds Data Model

Overview

This section shows the available API objects and provides more information on executing SQL to Yahoo! Ads APIs.

Key Features

The Sync App models Yahoo! Ads entities like documents, folders, and groups as relational views, allowing you to write SQL to query Yahoo! Ads data.
Stored procedures allow you to execute operations to Yahoo! Ads
Live connectivity to these objects means any changes to your Yahoo! Ads account are immediately reflected when using the Sync App.
Reports:
Reports are shown as views that cannot be modified once created. Unlike traditional database views, however, it is not very helpful to select all metrics and dimensions in a given table. The provider thus interprets the SELECT * query to mean a default set of metrics and dimensions are requested. This includes queries that explicitly select all columns.

Additionally, the Yahoo! Ads API limits the number and combinations of columns that can be projected over the data or used to restrict the results returned.

Tables

The Sync App models the data in Yahoo! Ads into a list of tables that can be queried using standard SQL statements.

Generally, querying Yahoo! Ads tables is the same as querying a table in a relational database. Sometimes there are special cases, for example, including a certain column in the WHERE clause might be required to get data for certain columns in the table. This is typically needed for situations where a separate request must be made for each row to get certain columns. These types of situations are clearly documented at the top of the table page linked below.

Yahoo! Ads Connector for CData Sync Tables


Name	Description
AccountCustomizer	To get, add, or delete, Asset information.
AccountSharedLists	Create, Read, Update or Delete ad information of negative keyword list which can be shared within the account.
AccountTrackingUrl	Read or Update related to account tracking.
AdGroupAsset	Provides operation of assets associated with ad groups.
AdGroupBidMultipliers	Read, Update or Delete bid multiplier of adgroup.
AdGroupCriteria	Read, add, update or delete targeting conditions (criteria) of Ad group.
AdGroupCriterionCustomizer	Get,Add or Delete Asset information.
AdGroupCustomizer	Get,Add or Delete Asset information.
AdGroupFeeds	Read or update FeedItem information of ad groups.
AdGroupLabels	Add or Delete related ad group and label.
AdGroupRetargetingLists	Create, Read, Update or Delete information of target list setting in ad group level.
AdGroupWebpages	Create, Read, Update or Delete allowed or excluded settings of PageFeedItem setting in ad group.
AppLinks	Create, Read or Update app link information.
Asset	Get, Add or Update Asset Information.
BiddingStrategies	Create, Read, Update or Delete auto bidding information.
CampaignAsset	Provides operation of assets associated with campaign.
CampaignCriteria	Create, Read or Delete negative criteria in campaign-level.
CampaignCustomizer	Get, Add, or Delete Asset information.
CampaignExportJobStatus	Get the status or creates job to register for export.
CampaignFeeds	Read or update FeedItem information of campaign.
CampaignRetargetingLists	Create, Read, Update or Delete target list setting in campaign level.
CampaignSharedSets	Create, Read or Delete setup negative keyword list to campaign.
CampaignTargets	Create, Read, Update or Delete target setting information.
CampaignWebpages	Create, Read or Delete excluded settings of PageFeedItem for campaign.
CustomizerAttribute	Get, Add or Delete Customizer Attribute Information.
FeedItems	Create, Read, Update or Delete Feed Item information.
PageFeedAssetSet	Get, Add or Remove the Page feed asset set.
SearchAdsAccountManagement	Create, update or Read account information.
SearchAdsAccounts	Read Or Update account information.
SearchAdsAdGroupAds	Create, Read, Update and Delete Ad group information.
SearchAdsAdGroups	Create, Read, Update or Delete Ad group.
SearchAdsAuditLogs	Get procession status about download operation history data or creates job to register for export.
SearchAdsBudgets	Read or Update budget information for the account.
SearchAdsCampaigns	Create, Read, Update or Delete Campaigns.
SearchAdsConversionTracker	Create, Read or Update ConversionTracker information.
SearchAdsFeeds	Create, Read, Update or Delete the Feed (Data auto insertion) information.
SearchAdsLabels	Create, Read, Update or Delete information of label.
SearchAdsReports	Create, Read or Delete a report.
SearchAdsRetargetingLists	Create, Read or Update the target list information.
SharedCriteria	Create, Read or delete negative keyword to negative keyword list.

AccountCustomizer

To get, add, or delete, Asset information.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
CustomizerAttributeId supports the '=,IN'.

For example:

SELECT * FROM AccountCustomizer
SELECT * FROM AccountCustomizer WHERE AccountId='1234339'
SELECT * FROM AccountCustomizer WHERE AccountId='1234339' AND CustomizerAttributeId='510004'

INSERT

Insert can be executed by specifying the AccountId, CustomizerAttributeId, Value 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 AccountCustomizer (AccountId, CustomizerAttributeId, Value) values(1234339,510004,'ABCD')

DELETE

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

DELETE FROM AccountCustomizer where AccountId=1234339 AND CustomizerAttributeId=510004

Columns


Name	Type	ReadOnly	References	Description
AccountId	Int64	True	SearchAdsAccounts.AccountId	Account ID.
ApprovalStatus	String	False		Displays Editorial Status.
CustomizerAttributeId	Int64	False		Customizer Attribute ID.
DisapprovalReasonCodes	String	False		Reject reason on editorial review.
Value	String	False		The attribute value. It will be inserted into the ad for insertion.

AccountSharedLists

Create, Read, Update or Delete ad information of negative keyword list which can be shared within the account.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
SharedListId supports the '=,IN'.

For example:

SELECT * from AccountSharedLists WHERE AccountId = '123436'

SELECT * FROM AccountSharedLists WHERE AccountId = '123436' AND SharedListId = '25648'

INSERT

Insert can be executed by specifying the AccountId and Name 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  AccountSharedLists (AccountId,Name) VALUES ('1234339','AccountSharedLists')

UPDATE

Update can be executed by specifying the AccountId and SharedListId in the WHERE Clause. The columns that are not read-only can be Updated. For example:

update AccountSharedLists SET Name = 'Testtestnew' WHERE AccountId = '1234339' AND SharedListId = '25683'

DELETE

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

DELETE FROM AccountSharedLists WHERE AccountId = '1234339' AND SharedListId = '25683'

Columns


Name	Type	ReadOnly	References	Description
SharedListId [KEY]	Int64	True		Negative keyword list ID.
AccountId	Int64	True	SearchAdsAccounts.AccountId	Account ID.
MemberCount	Int64	False		Number of items on Negative keyword list (keyword excluded on search).
Name	String	False		Negative keyword list name.
ReferenceCount	Int64	False		Number of campaigns which use negative keyword list.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
ReferenceNumber	String	This column will be used in Bulk operations to get specific values from the Temp tables.

AccountTrackingUrl

Read or Update related to account tracking.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.

For example:

SELECT * FROM AccountTrackingUrl WHERE  AccountId = '25687'

UPDATE

Update can be executed by specifying the AccountId in the WHERE Clause. The columns that are not read-only can be Updated. For example:

UPDATE AccountTrackingUrl SET DisapprovalReasonCodes = 'test' WHERE AccountId = '1569342'

Columns


Name	Type	ReadOnly	References	Description
AccountId [KEY]	Int64	True	SearchAdsAccounts.AccountId	Account ID.
AccountName	String	False		Account name.
DisapprovalReasonCodes	String	False		Code of disapproval reason.
DisapprovalReviewUrl	String	False		Tracking URL the has been disapproval.
InReviewUrl	String	False		Tracking URL that is in review.
TrackingUrl	String	False		Tracking URL.When tag is set blank, existing Tracking URL will be deleted.
UrlApprovalStatus	String	False		A review status of URL. The allowed values are DISAPPROVED, NONE, APPROVED, APPROVED_WITH_REVIEW, REVIEW, UNKNOWN.

AdGroupAsset

Provides operation of assets associated with ad groups.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
AdGroupId supports the '=,IN'.
AssetId supports the '=,IN'.
CampaignId supports the '=,IN'.

For example:

SELECT * FROM AdGroupAsset
SELECT * FROM AdGroupAsset WHERE AccountId='1234339'
SELECT * FROM AdGroupAsset WHERE AccountId='1234339' AND AdGroupId='510004'
SELECT * FROM AdGroupAsset WHERE AccountId='1234339' AND AdGroupId='510004' AND CampaignId='412324'

Columns


Name	Type	ReadOnly	References	Description
AccountId	Int64	True	SearchAdsAccounts.AccountId	Account ID.
AdGroupId	Int64	False		Ad group ID.
AssetId	Int64	False		Asset ID.
CampaignId	Int64	False		Campaign ID.
Type	String	False		Selects the type of Asset information.
UserStatus	String	True		Displays the status of the assets set in the ad group.

AdGroupBidMultipliers

Read, Update or Delete bid multiplier of adgroup.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
AdGroupId supports the 'IN'.
CampaignId supports the 'IN'.
PlatformType supports the 'IN'.

For example, the following queries are processed server side:

SELECT * FROM AdGroupBidMultipliers WHERE AccountId = '25687'

SELECT * FROM AdGroupBidMultipliers WHERE AccountId = '25687' AND AdGroupId IN ('456971')	

SELECT * FROM AdGroupBidMultipliers WHERE AccountId = '25687' AND CampaignId IN ('25687')

SELECT * FROM AdGroupBidMultipliers WHERE AccountId = '25687' AND PlatformType IN ('SMART_PHONE')

UPDATE

Update can be executed by specifying the AccountId, AdGroupId, BidMultiplier, CampaignId and PlatformType in the WHERE Clause. The columns that are not read-only can be Updated. For example:

UPDATE AdGroupBidMultipliers SET PlatformType = 'SMART_PHONE' WHERE AccountId = '1569' AND AdGroupId = '7894' AND BidMultiplier = 'Test' AND CampaignId = '4569'

DELETE

Delete can be executed by specifying the AccountId, AdGroupId, CampaignId and PlatformType in the WHERE Clause. For example:

DELETE FROM AdGroupBidMultipliers WHERE AccountId = '1569' AND AdGroupId = '7894' AND CampaignId = '4569' AND  PlatformType = 'SMART_PHONE'

Columns


Name	Type	ReadOnly	References	Description
AdGroupId [KEY]	Int64	True	SearchAdsAdGroups.AdGroupId	Ad group ID.
AccountId	Int64	True	SearchAdsAccounts.AccountId	Account ID.
BidMultiplier	String	False		Bid adjustment rate. Can be specified between 0 to 10.00. When specified 0, the ad will not be delivered. Bid adjustment rate can be specified up to two decimal places.
CampaignId	Int64	False	SearchAdsCampaigns.CampaignId	Campaign ID.
PlatformType	String	False		A platform of the selected device. The allowed values are SMART_PHONE, TABLET, DESKTOP, UNKNOWN.

AdGroupCriteria

Read, add, update or delete targeting conditions (criteria) of Ad group.

Table Specific Information

Select

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

AccountId supports the '='.
AdGroupId supports the '=,IN'.
CriterionCriterionId supports the '=,IN'.
ApprovalStatus supports the '=,IN'.
CampaignId supports the '=,IN'.
KeywordMatchType supports the '='.
CriterionKeywordText supports the '='.
BiddingStrategyId supports the '=,IN'.
ContainsLabelId supports the '='.
LabelIds supports the '=,IN'.
UserStatus supports the '=,IN'.
Use supports the '='.
Min supports the '='.
Max supports the '='.

For example, the following queries are processed server side:

SELECT * FROM AdGroupCriteria WHERE AccountId = '1234339' AND Use = 'BIDDABLE'

SELECT * FROM AdGroupCriteria WHERE AccountId = '1234339' AND Use = 'BIDDABLE' AND AdGroupId = '303252478'

INSERT

Insert can be executed by specifying the AccountId , AdGroupId, CampaignId, CriterionType, KeywordMatchType, KeywordText, Use and userStatus columns. The columns that are not read-only can be inserted optionally. For example:

INSERT INTO AdGroupCriteria (AccountId ,AdGroupId, CampaignId, CriterionType, KeywordMatchType, KeywordText, Use, userStatus) VALUES ('1234339', '303252478', '1836566', 'KEYWORD', 'PHRASE', 'tests cdata', 'BIDDABLE', 'ACTIVE')

UPDATE

Update can be executed by specifying the AccountId , AdGroupId, CampaignId, CriterionType, KeywordMatchType, KeywordText, Use and userStatus in the WHERE Clause. The columns that are not read-only can be Updated. For example:

UPDATE  AdGroupCriteria SET AdGroupName = 'cdata test', Use = 'BIDDABLE', CriterionType = 'KEYWORD' WHERE AccountId = '1234339' AND AdGroupId = '303244006' AND CampaignId = '1767536' AND CriterionId = '1872965100'

DELETE

Delete can be executed by specifying the AccountId, AdGroupId, CriterionId, CampaignId, CriterionType and USe in the WHERE Clause. For example:

DELETE FROM  AdGroupCriteria  WHERE AccountId = '1234339' AND AdGroupId = '303244006' AND CampaignId = '1767536' AND CriterionId = '1872965100' AND CriterionType = 'KEYWORD' AND Use = 'BIDDABLE'

Columns


Name	Type	ReadOnly	References	Description
CriterionId [KEY]	Long	True		Criterion ID.
AccountId	Int64	True	SearchAdsAccounts.AccountId	Account ID.
AdGroupId	Int64	True	SearchAdsAdGroups.AdGroupId	Ad group ID.
AdGroupName	String	False		Ad group name.
AdGroupTrackId	Int64	False		Ad group ID for tracking.
SmartphoneFinalUrl	String	False		Upgraded Custom URL (Smartphone).
Finalurl	String	False		Upgraded Custom URL. If upgraded and tracking Url is specified, it is required in ADD operation.
ApprovalStatus	String	False		Displays Editorial Status. The allowed values are APPROVED, APPROVED_WITH_REVIEW, REVIEW, PRE_DISAPPROVED, POST_DISAPPROVED, UNKNOWN.
BidAdGroupCpc	Int64	False		CPC of Ad group.
BidSource	String	False		displays which level bid belongs to criterion or ad group. The allowed values are ADGROUP, CRITERION, UNKNOWN.
BidKeywordCpc	Int64	False		CPC of Keyword.
BidCpc	Int64	False		CPC of Keyword. The default value in ADD operation will be 1. Confirmed as no setting, if value is set 0.
CustomParametersIsRemove	String	False		Delete flag. The allowed values are TRUE, FALSE, UNKNOWN.
CustomParameters	String	False		Displays the element of custom parameters.
DestinationUrl	String	False		Custom URL of before upgrading.
DisapprovalReasonCodes	String	False		Code of Disapproval reason.
ReviewSmartphoneFinalUrl	String	False		Upgraded Custom URL (Smartphone), in review.
ReviewFinalUrl	String	False		Upgraded Custom URL, in review.
ReviewCustomParametersIsRemove	String	False		Delete flag. The allowed values are TRUE, FALSE, UNKNOWN.
ReviewCustomParametersParameters	String	False		Displays the element of custom parameters.
ReviewDestinationUrl	String	False		Custom URL of before upgrading, in review.
ReviewTrackingUrl	String	False		Tracking URL, in review.
TrackingUrl	String	False		Tracking URL.
UserStatus	String	False		Displays ad delivery status that can be set by an user. The allowed values are ACTIVE, PAUSED, UNKNOWN.
CampaignId	Int64	False	SearchAdsCampaigns.CampaignId	Campaign ID.
CampaignName	String	False		Campaign name.
CampaignTrackId	Int64	False		Campaign ID for tracking.
CriterionTrackId	Int64	False		AdGroupCriterionServiceCriterion ID for tracking.
CriterionType	String	False		AdGroupCriterionServiceCriterionType displays the type of criteria. The allowed values are KEYWORD, UNKNOWN.
KeywordMatchType	String	False		Describes keyword match type. The allowed values are EXACT, PHRASE, BROAD, UNKNOWN.
KeywordText	String	False		AdGroupCriterionServiceKeyword element.Maximum of 80 letters, 10 words.
InvalidedTrademarks	String	False		Invalided trademarks.
Labels	String	False		Describes label information.
TrademarkStatus	String	False		describes the status of trademark. The allowed values are NO_RESTRICTION, CONFLICT_WITH_TRADEMARK, CLAIM_IN_PROGRESS, DISAPPROVED_CLAIM, DISAPPROVED_REVIEWER, UNKNOWN.
Use	String	False		Describes criterion to be selected. The allowed values are BIDDABLE, NEGATIVE, UNKNOWN.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
BiddingStrategyId	Int64	Auto bidding ID.
ContainsLabelId	String	Describes acquisition flag of label data. The allowed values are TRUE, FALSE, UNKNOWN.
LabelIds	Int64	Label ID.
Min	Int64	Minimum value of the search range.
Max	Int64	Maximum value of the search range.

AdGroupCriterionCustomizer

Get,Add or Delete Asset information.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
CriterionId supports the '=,IN'.
CustomizerAttributeId supports the '=,IN'.

For example:

SELECT * FROM AdGroupCriterionCustomizer
SELECT * FROM AdGroupCriterionCustomizer WHERE AccountId='1234339'
SELECT * FROM AdGroupCriterionCustomizer WHERE AccountId='1234339' AND CriterionId='823145'
SELECT * FROM AdGroupCriterionCustomizer WHERE AccountId='1234339' AND CriterionId='823145' AND CustomizerAttributeId='231458'

INSERT

Insert can be executed by specifying the AccountId, CriterionId, CustomizerAttributeId, Value 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 AdGroupCriterionCustomizer (AccountId, CriterionId, CustomizerAttributeId, Value) values(1234339,2443788943,510004,'ABCD')

DELETE

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

DELETE FROM AdGroupCriterionCustomizer where AccountId=1234339 AND CriterionId=2443788943  AND CustomizerAttributeId=510004

Columns


Name	Type	ReadOnly	References	Description
AccountId	Int64	True	SearchAdsAccounts.AccountId	Account ID.
ApprovalStatus	String	True		Displays Editorial Status.
CriterionId	Int64	False		Criterion ID.
CustomizerAttributeId	Int64	False		Customizer Attribute ID.
DisapprovalReasonCodes	String	True		Reject reason on editorial review.
Value	String	False		The attribute value. It will be inserted into the ad for insertion.

AdGroupCustomizer

Get,Add or Delete Asset information.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
AdGroupId supports the '=,IN'.
CustomizerAttributeId supports the '=,IN'.
CampaignId supports the '=,IN'.

For example:

SELECT * FROM AdGroupCustomizer
SELECT * FROM AdGroupCustomizer WHERE AccountId='1234339'
SELECT * FROM AdGroupCustomizer WHERE AccountId='1234339' AND AdGroupId='823145'
SELECT * FROM AdGroupCustomizer WHERE AccountId='1234339' AND AdGroupId='823145' AND CustomizerAttributeId='546821'
SELECT * FROM AdGroupCustomizer WHERE AccountId='1234339' AND AdGroupId='823145' AND CustomizerAttributeId='546821' AND CampaignId='549456'

INSERT

Insert can be executed by specifying the AccountId, AdGroupId, CustomizerAttributeId, Value 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 AccountCustomizer (AccountId, AdGroupId, CustomizerAttributeId, Value) values(1234339,304682598,510004,'ABCD')

DELETE

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

DELETE FROM AccountCustomizer where AccountId=1234339 AND AdGroupId=304682598 AND CustomizerAttributeId=510004

Columns


Name	Type	ReadOnly	References	Description
AccountId	Int64	True	SearchAdsAccounts.AccountId	Account ID.
AdGroupId	Int64	False		AdGroup ID.
ApprovalStatus	String	False		Displays Editorial Status.
CustomizerAttributeId	Int64	True		Customizer Attribute ID.
CampaignId	Int64	True	SearchAdsCampaigns.CampaignId	Campaign ID.
DisapprovalReasonCodes	String	False		Reject reason on editorial review.
Value	String	False		The attribute value. It will be inserted into the ad for insertion.

AdGroupFeeds

Read or update FeedItem information of ad groups.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
AdGroupId supports the '=,IN'.
CampaignId supports the '=,IN'.
PlaceholderType supports the '=,IN'.
FeedItemId supports the '=,IN'.

For example:

SELECT * from AdGroupFeeds WHERE AccountId = '1234339'

SELECT * from AdGroupFeeds WHERE AccountId = '1234339' AND AdGroupId = '303282282'

SELECT * FROM AdGroupFeeds WHERE AccountId = '1234339' AND CampaignId = '1767536'

UPDATE

Update can be executed by specifying the AccountId, AdGroupId, AdGroupFeed and CampaignId in the WHERE Clause. The columns that are not read-only can be Updated. For example:

INSERT INTO AdGroupFeedServiceAdGroupFeeds#temp (FeedItemId) VALUES ('123456')

UPDATE AdGroupFeeds SET AdGroupFeed = 'AdGroupFeedServiceAdGroupFeeds#temp', CampaignId = '1833923', PlaceholderType = 'QUICKLINK' WHERE AccountId = '1234339' AND AdGroupId = '303133212'

Columns


Name	Type	ReadOnly	References	Description
AdGroupId [KEY]	Int64	True	SearchAdsAdGroups.AdGroupId	AdGroup ID.
AccountId	Int64	True	SearchAdsAccounts.AccountId	Account ID.
AdGroupFeed	String	False		the FeedItem information connected to ad group.
CampaignId	Int64	False	SearchAdsCampaigns.CampaignId	Campaign ID.
PlaceholderType	String	False		The type of FeedItem information. The allowed values are QUICKLINK, CALLEXTENSION, CALLOUT, STRUCTURED_SNIPPET, UNKNOWN.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
FeedItemId	Int64	FeedItem ID.

AdGroupLabels

Add or Delete related ad group and label.

Table Specific Information

INSERT

Insert can be executed by specifying the AccountId,AdGroupId,LabelId and CampaignId columns. The columns that are not read-only can be inserted optionally.

INSERT INTO AdGroupLabels (AccountId,AdGroupId,LabelId,CampaignId) VALUES ('1234339','303133212','97108 ','1833923')

DELETE

Delete can be executed by specifying the AccountId, AdGroupId, LabelId and CampaignId in the WHERE Clause. For example:

DELETE FROM AdGroupLabels WHERE AccountId = '1234339' AND AdGroupId = '303133212' AND LabelId = '97108' AND CampaignId = '1833923'

Columns


Name	Type	ReadOnly	References	Description
LabelId [KEY]	Integer	True	SearchAdsLabels.LabelId	Label ID.
AccountId	Integer	False	SearchAdsAccounts.AccountId	Account ID.
AdGroupId	Integer	False	SearchAdsAdGroups.AdGroupId	AdGroup ID.
CampaignId	Integer	False	SearchAdsCampaigns.CampaignId	Campaign ID.

AdGroupRetargetingLists

Create, Read, Update or Delete information of target list setting in ad group level.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
AdGroupId supports the '=,IN'.
TargetListId supports the '=,IN'.
BidMultiplier supports the '=,IN'.
ExcludedType supports the '='.

For example:

SELECT * FROM AdGroupRetargetingLists WHERE AccountId = '1234339'

SELECT * FROM AdGroupRetargetingLists WHERE AccountId = '1234339' AND AdGroupId IN ('303133212')	

SELECT * FROM AdGroupRetargetingLists WHERE AccountId = '1234339' AND TargetListId IN ('634035')

SELECT * FROM AdGroupRetargetingLists WHERE AccountId = '1234339' AND BidMultiplier IN ('test')

SELECT * FROM AdGroupRetargetingLists WHERE AccountId = '1234339' AND ExcludedType = 'INCLUDED'

INSERT

Insert can be executed by specifying the AccountId, AdGroupId, TargetListId and CampaignId 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 AdGroupRetargetingLists (AccountId,AdGroupId,TargetListId,AdGroupName,CampaignId)  VALUES ('1234339','303133212','634035','TestGroup','1833923')

UPDATE

Update can be executed by specifying the AccountId, AdGroupId, TargetListId and CampaignId in the WHERE Clause. The columns that are not read-only can be Updated. For example:

UPDATE AdGroupRetargetingLists SET AdGroupName = 'TestAdGroupRetargetingLists' WHERE AccountId = '1234339' AND AdGroupId = '303133212' AND CampaignId = '1833923' AND TargetListId = '634035'

DELETE

Delete can be executed by specifying the AccountId,AdGroupId,TargetListId and CampaignId in the WHERE Clause. For example:

DELETE FROM AdGroupRetargetingLists WHERE AccountId = '1234339' AND TargetListId = '634035' AND AdGroupId = '303133212' AND CampaignId = '1833923'

Columns


Name	Type	ReadOnly	References	Description
TargetListId [KEY]	Int64	True	SearchAdsRetargetingLists.TargetListId	Target list ID.
AccountId	Int64	True	SearchAdsAccounts.AccountId	Account ID.
AdGroupId	Int64	True	SearchAdsAdGroups.AdGroupId	Ad group ID.
AdGroupName	String	False		Ad group name.
BidMultiplier	String	False		Maximum CPC increase value. Can be specified between 0.10 to 10.00. When specified '0', the ad will not be delivered. Maximum CPC increase value can be specified up to two decimal places. The default value will be 1.0.
CampaignId	Int64	False	SearchAdsCampaigns.CampaignId	Campaign ID.
CampaignName	String	False		Campaign name.
RetargetingTrackId	Int64	False		Retargeting Track ID.
TargetListName	String	False		Target list name.
ExcludedType	String	False		the setting type which delivers ads or do not deliver ads. The allowed values are INCLUDED, EXCLUDED, UNKNOWN.

AdGroupWebpages

Create, Read, Update or Delete allowed or excluded settings of PageFeedItem setting in ad group.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
AdGroupId supports the '=,IN'.
TargetId supports the '=,IN'.
CampaignId supports the '=,IN'.

For example:

SELECT * FROM AdGroupWebpages WHERE AccountId = '25687'

SELECT * FROM AdGroupWebpages WHERE AccountId = '25687' AND AdGroupId IN ('89756')	

SELECT * FROM AdGroupWebpages WHERE AccountId = '25687' AND TargetId IN ('89756')

SELECT * FROM AdGroupWebpages WHERE AccountId = '25687' AND CampaignId IN ('78962')

INSERT

Insert can be executed by specifying the AccountId, AdGroupId, TargetId and WebpageParameterConditions 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 AdGroupWebpages(AccountId,AdGroupId,TargetId,WebpageParameterConditions) VALUES ('15625','12365','4789','test list')

UPDATE

Update can be executed by specifying the AccountId and AdGroupId in the WHERE Clause. The columns that are not read-only can be Updated. For example:

UPDATE AdGroupWebpages SET WebpageTargetTrackId = '897466' WHERE AccountId = '525862' AND AdGroupId = '89348'

DELETE

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

DELETE FROM AdGroupWebpages WHERE AccountId = '8975' AND AdGroupId = '2369'

Columns


Name	Type	ReadOnly	References	Description
TargetId [KEY]	Int64	True		Unique ID for each identify webpage.
AccountId	Int64	True	SearchAdsAccounts.AccountId	Account ID.
AdGroupId	Int64	True	SearchAdsAdGroups.AdGroupId	Ad Group ID.
AdGroupTrackId	Int64	False		Ad group tracking ID.
AdGroupCpc	Int64	False		Max bid of ad group.
BidSource	String	False		Describes the level at which bid is set. The allowed values are ADGROUP, CRITERION, UNKNOWN.
KeywordCpc	Int64	False		Max bid of keyword.
Cpc	Int64	False		Max bid.The default value in ADD operation will be 1. The default value is 1.
CampaignId	Int64	False		Campaign ID.
CampaignTrackId	Int64	False		Campaign Tracking ID.
ExcludedType	String	False		Describes the setting type which delivers ads or do not delivers ads. The allowed values are INCLUDED, EXCLUDED, UNKNOWN. The default value is INCLUDED.
UserStatus	String	False		Displays ad delivery status that can be set by an user.This field can be updated when ExcludedType is 'INCLUDED'. The allowed values are PAUSED, ACTIVE, UNKNOWN.
WebpageParameterConditions	String	False		The rule list of webpage to be allowed or excluded.
WebpageTargetTrackId	Int64	False		Tracking ID for each identify webpage.

AppLinks

Create, Read or Update app link information.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
AppLinkId supports the '=,IN'.

For example:

SELECT * FROM AppLinks WHERE AccountId = '1234339'

SELECT * FROM AppLinks WHERE AccountId = '1234339' AND AppLinkId ='73'

INSERT

Insert can be executed by specifying the AccountId,AppId,AppLinkPlatform,AppVendorId columns. The columns that are not read-only can be inserted optionally. Following is an example of how to inserting into AppLinks table

INSERT INTO AppLinks (AccountId,AppId,AppLinkPlatform,AppVendorId) VALUES('1234339','testtest','ANDROID','Adjust')

UPDATE

Update can be executed by specifying the AppLinkId and LinkStatus in the WHERE Clause. The columns that are not read-only can be Updated. For example:

UPDATE AppLinks SET LinkStatus = 'ENABLED' WHERE AccountId = '1234339' AND AppLinkId = '73'

Columns


Name	Type	ReadOnly	References	Description
AppLinkId [KEY]	Int64	True		App Link ID.
AccountId	Int64	True	SearchAdsAccounts.AccountId	Account ID.
AppId	String	True		App ID.
AppLinkPlatform	String	False		App Link Platform. The allowed values are ANDROID, UNKNOWN.
AppVendorId	String	False	ApplinkVendors.AppVendorId	App Vendor ID.
AppVendorNameEn	String	False		App Vendor Name in English.
AppVendorNameJa	String	False		App Vendor Name in Japanese.
LinkId	String	False		Link ID.
LinkStatus	String	False		Link Status. The allowed values are ENABLED, DISABLED, UNKNOWN.
SyncStatus	String	False		Sync Status. The allowed values are IN_PROGRESS, COMPLETED, UNKNOWN.

Asset

Get, Add or Update Asset Information.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
ApprovalStatus supports the '=,IN'.
AssetId supports the '=,IN'.

For example:

SELECT * FROM Asset
SELECT * FROM Asset WHERE AccountId='1234339'
SELECT * FROM Asset WHERE AccountId='1234339' AND ApprovalStatus='APPROVED'
SELECT * FROM Asset WHERE AccountId='1234339' AND ApprovalStatus='APPROVED' AND AssetId='3460269'

INSERT

Insert can be executed by specifying the AccountId,AssetDataType,AssetDataCalloutAssetCalloutText 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 Asset (AccountId,AssetDataType,AssetDataCalloutAssetCalloutText) values(1234339,'CALLOUT','Yogesh')

UPDATE

Update can be executed by specifying the AccountId, AssetId AND AssetDataType in the WHERE Clause. For example:

UPDATE Asset set AssetDataCalloutAssetCalloutText='Mangal' where AccountId=1234339 AND AssetId=3460151 AND AssetDataType='CALLOUT'

Columns


Name	Type	ReadOnly	References	Description
AccountId	Int64	True	SearchAdsAccounts.AccountId	Account ID.
ApprovalStatus	String	False		Displays Editorial Status.
AssetDataCallAssetPhoneNumber	String	False		Phone Number.
AssetDataCallAssetReviewPhoneNumber	String	False		Phone Number on editorial review.
AssetDataCallAssetSchedules	String	False		Describes display schedule from Ad Display Option.
AssetDataCalloutAssetCalloutText	String	False		Callout text.
AssetDataCalloutAssetEndDate	String	False		End date of ad display.
AssetDataCalloutAssetReviewCalloutText	String	False		Callout text on editorial review.
AssetDataCalloutAssetSchedules	String	False		Display schedule from Ad Display Option.
AssetDataCalloutAssetStartDate	String	False		Start date of ad display
AssetDataQuickLinkAssetDescription1	String	False		Description 1.
AssetDataQuickLinkAssetDescription2	String	False		Description 2.
AssetDataQuickLinkAssetEndDate	String	False		End date of ad display.
AssetDataQuickLinkAssetLinkText	String	False		Link text.
AssetDataQuickLinkAssetReviewDescription1	String	False		Description 1 on editorial review.
AssetDataQuickLinkAssetReviewDescription2	String	False		Description 2 on editorial review.
AssetDataQuickLinkAssetReviewLinkText	String	False		Link text on editorial review.
AssetDataQuickLinkAssetSchedules	String	False		Describes display schedule from Ad Display Option.
AssetDataQuickLinkAssetStartDate	String	False		Start date of ad display
AssetDataStructuredSnippetAssetHeader	String	False		Header.
AssetDataStructuredSnippetAssetReviewHeader	String	False		Header on editorial review.
AssetDataStructuredSnippetAssetReviewValues	String	False		Value on editorial review.
AssetDataStructuredSnippetAssetValues	String	False		Value.
AssetDataType	String	False		Asset information type.
AssetId	Int64	True		Asset ID.
AssetTrackId	Int64	True		Asset ID for tracking.
CustomParametersIsRemove	String	False		AssetServiceIsRemove
CustomParametersParameters	String	False		Displays the element of custom parameters.
DisapprovalReasonCodes	String	False		Reject reason on editorial review.
FinalUrl	String	False		Landing Page URL.
InvalidedTrademarks	String	False		Invalided trademarks.
ReviewCustomParametersIsRemove	String	False		AssetServiceIsRemove
ReviewCustomParametersParameters	String	False		Displays the element of custom parameters.
ReviewFinalUrl	String	False		Landing Page URL on editorial review.
ReviewSmartphoneFinalUrl	String	False		Landing Page URL (Smartphone) on editorial review.
ReviewTrackingUrl	String	False		Tracking URL on editorial review.
SmartphoneFinalUrl	String	False		Landing Page URL (Smartphone).
TrackingUrl	String	False		Tracking URL.
TrademarkStatus	String	False		Describes the status of trademark.

BiddingStrategies

Create, Read, Update or Delete auto bidding information.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
BiddingStrategyId supports the '=,IN'.
Type supports the '=,IN'.

For example:

SELECT * FROM BiddingStrategies WHERE AccountId ='1234339'

SELECT * FROM BiddingStrategies WHERE AccountId ='1234339' AND BiddingStrategyId ='88272'

SELECT * FROM BiddingStrategies WHERE AccountId ='1234339' AND Type='TARGET_SPEND'

INSERT

Insert can be executed by specifying the AccountId, Type, BiddingStrategyName and TargetRoasBiddingSchemeBidCeiling 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  BiddingStrategies (AccountId, Type, BiddingStrategyName,TargetRoasBiddingSchemeBidCeiling) VALUES('1234339','TARGET_SPEND','Test Bidding','50')

UPDATE

Update can be executed by specifying the AccountId and BiddingStrategyId in the WHERE Clause. The columns that are not read-only can be Updated. For example:

UPDATE BiddingStrategies SET BiddingStrategyName = 'Test', Type = 'TARGET_SPEND', TargetRoasBiddingSchemeBidCeiling = '30' WHERE AccountId = '1234339' AND BiddingStrategyId = '88272'

DELETE

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

DELETE FROM BiddingStrategies WHERE AccountId = '1234339' AND BiddingStrategyId = '88272'

Columns


Name	Type	ReadOnly	References	Description
BiddingStrategyId [KEY]	Int64	True		Auto bidding ID.
AccountId	Int64	True	SearchAdsAccounts.AccountId	Account ID.
TargetCpaBiddingSchemeBidCeiling	Int64	False		CPC limit. No limits if 0 is set. If type is 'TARGET_CPA', this field is required in ADD operation.
TargetCpaBiddingSchemeBidFloor	Int64	False		Minimum CPC. Set 0 to deactivate. If type is 'TARGET_CPA', this field is required in ADD operation.
TargetCpaBiddingSchemeTargetCpa	Int64	False		Target CPA (JPY). If type is 'TARGET_CPA', this field is required in ADD operation.
TargetImpressionShareSchemeBidCeiling	Int64	False		CPC limit (0-50000). No limits if 0 is set. If type is TARGET_IMPRESSION_SHARE, this field is required in ADD operation.
TargetImpressionShareSchemeLocation	String	False		Specifies search result posting position to achieve the target ratio of impression share. If type is TARGET_IMPRESSION_SHARE, this field is required in ADD operation. The allowed values are ANYWHERE_ON_PAGE, TOP_ON_PAGE, ABSOLUTE_TOP_OF_PAGE, UNKNOWN. The default value is ANYWHERE_ON_PAGE.
TargetImpressionShareSchemeTargetImpressionShare	Int64	False		Target impression share. If type is TARGET_IMPRESSION_SHARE, this field is required in ADD operation.
TargetRoasBiddingSchemeBidCeiling	Int64	False		CPC limit (0-50000). No limits if 0 is set. If type is 'TARGET_ROAS', this field is required in ADD operation.
TargetRoasBiddingSchemeBidFloor	Int64	False		Minimum CPC. Set 0 to deactivate. If type is 'TARGET_ROAS', this field is required in ADD operation.
TargetRoasBiddingSchemeTargetRoas	String	False		Target ROAS. ROAS: Return On Average Spend. Setting limit: 0.01%20-%201000.00%EF%BC%881%25-100000%25%29. If type is 'TARGET_ROAS', this field is required in ADD operation.
TargetSpendBiddingSchemeBidCeiling	Int64	False		Bid amount limit (0-50000). No limits if 0 is set. If type is 'TARGET_SPEND', this field is required in ADD operation.
Type	String	False		Displays the Auto Bidding type. The allowed values are TARGET_ROAS, TARGET_SPEND, TARGET_CPA, TARGET_IMPRESSION_SHARE, UNKNOWN.
TargetMaximizeClicksBiddingSchemeBidCeiling	Int64	False		Describes Auto Bidding setting for Maximize Clicks.If type is 'MAXIMIZE_CLICKS', this field is required in ADD operation
BiddingStrategyName	String	False		Auto bidding name(Can set up to 50 characters).

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
ReferenceNumber	String	This column will be used in Bulk operations to get specific values from the Temp tables.

CampaignAsset

Provides operation of assets associated with campaign.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
CampaignId supports the '=,IN'.
AssetId supports the '=,IN'.

For example:

SELECT * FROM CampaignAsset WHERE AccountId = '1234339'
SELECT * FROM CampaignAsset WHERE AccountId = '1234339' AND CampaignId='89542'
SELECT * FROM CampaignAsset WHERE AccountId = '1234339' AND CampaignId='89542' AND AssetId='654852'

Columns


Name	Type	ReadOnly	References	Description
AccountId	Int64	True	SearchAdsAccounts.AccountId	Account ID.
AssetId	Int64	True		Asset ID.
CampaignId	Int64	True		Campaign ID.
Type	String	False		Selects the type of Asset information.
UserStatus	String	False		Displays the status of the assets set in the campaign.

CampaignCriteria

Create, Read or Delete negative criteria in campaign-level.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
CampaignId supports the '=,IN'.
CriterionId supports the '=,IN'.
Use supports the '=,IN'.

For example:

SELECT * FROM CampaignCriteria WHERE AccountId = '1234339'

SELECT * FROM CampaignCriteria WHERE AccountId = '1234339' AND CriterionId IN ('89745')

SELECT * FROM CampaignCriteria WHERE AccountId = '1234339' AND Use IN ('NEGATIVE')

INSERT

Insert can be executed by specifying the AccountId,CampaignId, CriterionCriterionType, CriterionKeywordKeywordMatchType, CriterionKeywordText and Use 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 CampaignCriteria (AccountId,CampaignId, CriterionType, KeywordKeywordMatchType, KeywordText, Use) VALUES ('1234339',1833923,'KEYWORD','PHRASE','NEGATIVE','NEGATIVE')

DELETE

Delete can be executed by specifying the AccountId, CampaignId, CriterionCriterionId, CriterionCriterionType and Use in the WHERE Clause. For example:

DELETE FROM CampaignCriteria WHERE AccountId = '1234339' AND CampaignId = '1833923' AND CriterionId = '128702426' AND CriterionType = 'KEYWORD' AND Use = 'NEGATIVE'

Columns


Name	Type	ReadOnly	References	Description
CriterionId [KEY]	Int64	True		CampaignCriterionServiceCriterion ID.
AccountId	Int64	False	SearchAdsAccounts.AccountId	Account ID.
CampaignId	Int64	False	SearchAdsCampaigns.CampaignId	Campaign ID.
CampaignName	String	False		Campaign name.
CriterionTrackId	Int64	False		Track ID.
CriterionType	String	False		Displays the type of criteria. The allowed values are KEYWORD, UNKNOWN.
KeywordKeywordMatchType	String	False		Describes keyword match type. This field is required when criterionType is 'KEYWORD'. The allowed values are EXACT, PHRASE, BROAD, UNKNOWN.
KeywordText	String	False		CampaignCriterionServiceKeyword element. Maximum of 80 letters, 10 word. This field is required when criterionType is 'KEYWORD'.
Use	String	False		Describes the criteria to be selected. The allowed values are NEGATIVE, UNKNOWN.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
ReferenceNumber	String	This column will be used in Bulk operations to get specific values from the Temp tables.

CampaignCustomizer

Get, Add, or Delete Asset information.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
CampaignId supports the '=,IN'.
CustomizerAttributeId supports the '=,IN'.

For example:

SELECT * FROM CampaignCustomizer
SELECT * FROM CampaignCustomizer WHERE AccountId = '1234339'
SELECT * FROM CampaignCustomizer WHERE AccountId = '1234339' AND CampaignId='89542'
SELECT * FROM CampaignCustomizer WHERE AccountId = '1234339' AND CampaignId='89542' AND CustomizerAttributeId='654852'

INSERT

Insert can be executed by specifying the AccountId, CampaignId, CustomizerAttributeId, Value 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 CampaignCustomizer (AccountId,CampaignId,CustomizerAttributeId,Value) values(1234339,1840750,510004,'FDSA')

DELETE

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

DELETE FROM CampaignCustomizer where AccountId=1234339 AND CampaignId=1840750 AND CustomizerAttributeId=510004

Columns


Name	Type	ReadOnly	References	Description
AccountId	Int64	True	SearchAdsAccounts.AccountId	Account ID.
ApprovalStatus	String	False		Displays Editorial Status.
CampaignId	Int64	True		Campaign ID.
CustomizerAttributeId	Int64	True		Customizer Attribute ID.
DisapprovalReasonCodes	String	False		Reject reason on editorial review.
Value	String	False		The attribute value. It will be inserted into the ad for insertion.

CampaignExportJobStatus

Get the status or creates job to register for export.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
JobId supports the 'IN'.
JobStatus supports the 'IN'.

For example:

SELECT * FROM CampaignExportJobStatus WHERE AccountId='25687'

SELECT * FROM CampaignExportJobStatus WHERE AccountId='123434' AND JobId IN('8520')

SELECT * FROM CampaignExportJobStatus WHERE AccountId='123436' AND JobStatus IN('TIMEOUT')

INSERT

Insert can be executed by specifying the AccountId, Encoding, Lang and Output 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 CampaignExportJobStatus (AccountId, Encoding, Lang, Output) VALUES (1234339, 'UTF8', 'EN', 'CSV')

Columns


Name	Type	ReadOnly	References	Description
JobId [KEY]	Int64	True		Job ID.
AccountId	Int64	True	SearchAdsAccounts.AccountId	Account ID.
StartDate	Date	True		Start date and time of job setting.
EndDate	Date	True		End date and time of job setting
ExportFields	String	True		Fields to be exported
JobName	String	True		Job name.
JobStatus	String	True		a status of job in export setting. The allowed values are IN_PROGRESS, COMPLETED, TIMEOUT, SYSTEM_ERROR, UNKNOWN.
Progress	Int64	True		Progress of job setting
UserName	String	True		Name of user who run the job.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
AdGroupApprovalStatuses	String	Displays Editorial Status. The allowed values are APPROVED,APPROVED_WITH_REVIEW,REVIEW,PRE_DISAPPROVED,POST_DISAPPROVED,UNKNOWN
AdGroupAdUserStatuses	String	Displays ad delivery status that can be set by an user. The allowed values are ACTIVE,PAUSED,UNNKOWN
AdGroupCriterionApprovalStatuses	String	Displays Editorial Status. The allowed values are APPROVED,APPROVED_WITH_REVIEW,REVIEW,PRE_DISAPPROVED,POST_DISAPPROVED,UNKNOWN
AdGroupCriterionIds	Int64	Ad group criteria ID.
AdGroupCriterionUserStatuses	String	Displays ad delivery status that can be set by an user.
AdGroupIds	Int64	Ad group ID of export objective.
AdGroupUserStatuses	String	Displays ad delivery status that can be set by an user. The allowed values are ACTIVE,PAUSED,UNKNOWN
AdIds	Int64	Ad ID of export objective.
CampaignCriterionIds	Int64	Campaign criteria ID.
CampaignIds	Int64	Campaign ID of export objective.
CampaignUserStatuses	String	Displays ad delivery status that can be set by an user. The allowed values are ACTIVE,PAUSED,UNKNOWN
Encoding	String	An encoding setting for exporting data. The allowed values are UTF8, SJIS, UNKNOWN.
EntityTypes	String	Describes target entities. The allowed values are CAMPAIGN,NEGATIVE_CAMPAIGN_CRITERION,AD_GROUP,BIDDABLE_AD_GROUP_CRITERION,NEGATIVE_AD_GROUP_CRITERION,AD,ALL,UNKNOWN
Lang	String	A language setting for exporting data. The allowed values are JA, EN, UNKNOWN.
Output	String	An output format for exporting data. The allowed values are CSV, ZIPPED_CSV, UNKNOWN.

CampaignFeeds

Read or update FeedItem information of campaign.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
FeedItemId supports the '=,IN'.
CampaignId supports the '=,IN'.
PlaceholderType supports the '=,IN'.

For example:

SELECT * FROM CampaignFeeds WHERE AccountId = '1234339'

SELECT * FROM CampaignFeeds WHERE AccountId = '1234339' AND FeedItemId = '123456'

SELECT * FROM CampaignFeeds WHERE AccountId = '1234339' AND CampaignId = '53478'

UPDATE

Update can be executed by specifying the AccountId, FeedItemId, CampaignId and CampaignFeed in the WHERE Clause. The columns that are not read-only can be Updated. For example:

INSERT INTO CampaignFeedServiceCampaignFeeds#temp (FeedItemId) VALUES('12345');
UPDATE CampaignFeeds SET PlaceholderType = 'QUICKLINK', CampaignFeed = 'CampaignFeedServiceCampaignFeeds#temp' WHERE AccountId = '1234339' AND FeedItemId = '12345' AND CampaignId = '3457899'

Columns


Name	Type	ReadOnly	References	Description
FeedItemId [KEY]	Int64	True	FeedItems.FeedItemId	FeedItem information ID.
AccountId	Int64	False	SearchAdsAccounts.AccountId	Account ID.
CampaignId	Int64	True	SearchAdsCampaigns.CampaignId	Campaign ID.
CampaignFeed	String	False		Describes FeedItem information connected to campaign.
PlaceholderType	String	False		The type of FeedItem information. The allowed values are QUICKLINK, CALLEXTENSION, CALLOUT, STRUCTURED_SNIPPET, UNKNOWN.

CampaignRetargetingLists

Create, Read, Update or Delete target list setting in campaign level.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
CampaignId supports the '=,IN'.
TargetListId supports the '=,IN'.
ExcludedType supports the '='.

For example:

SELECT * FROM CampaignRetargetingLists WHERE AccountId = '1234339'

SELECT * FROM CampaignRetargetingLists WHERE AccountId = '123436' AND CampaignId = '1833923' AND TargetListId = '634035'

SELECT * FROM CampaignRetargetingLists WHERE AccountId = '123436' AND TargetListId IN ('634035')

INSERT

Insert can be executed by specifying the AccountId,CampaignId and CriterionTargetListTargetListId 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 CampaignRetargetingLists (AccountId,CampaignId, TargetListId) values('1234339','1833923','634035')

UPDATE

Update can be executed by specifying the AccountId,CampaignId and CriterionTargetListTargetListId in the WHERE Clause. The columns that are not read-only can be Updated. For example:

UPDATE CampaignRetargetingLists SET TargetListName='Test' WHERE AccountId ='1234339' AND CampaignId='1833923' AND TargetListId='634035'

DELETE

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

DELETE FROM CampaignRetargetingLists  WHERE AccountId ='1234339' AND CampaignId='1833923' AND TargetListId='634035'

Columns


Name	Type	ReadOnly	References	Description
TargetListId [KEY]	Int64	True	SearchAdsRetargetingLists.TargetListId	Target list ID.
AccountId	Int64	True	SearchAdsAccounts.AccountId	Account ID.
CampaignId	Int64	True	SearchAdsCampaigns.CampaignId	Campaign ID.
BidMultiplier	String	False		Bid adjustment rate. Can be specified between 0.10 to 10.00. When specified '0', the ad will not be delivered. Bid adjustment rate can be specified up to two decimal places. The default value will be 1.0.
CampaignName	String	False		Name of campaign.
RetargetingTrackId	Int64	False		Retargeting Track ID.
TargetListName	String	False		Target list name.
ExcludedType	String	False		the setting type which delivers ads or do not deliver ads. The allowed values are INCLUDED, EXCLUDED, UNKNOWN. The default value is INCLUDED.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
ReferenceNumber	String	This column will be used in Bulk operations to get specific values from the Temp tables.

CampaignSharedSets

Create, Read or Delete setup negative keyword list to campaign.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
CampaignId supports the '=,IN'.
SharedListId supports the '=,IN'.

For example:

SELECT * FROM CampaignSharedSets WHERE AccountId = '1234339'

SELECT * FROM CampaignSharedSets WHERE AccountId = '1234339' AND CampaignId IN ('1833923')

SELECT * FROM CampaignSharedSets WHERE AccountId = '1234339' AND SharedListId IN ('25648')

INSERT

Insert can be executed by specifying the AccountId,CampaignId and SharedListId 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 CampaignSharedSets (AccountId,CampaignId, SharedListId) VALUES ('1234339','1833923','25648')

DELETE

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

DELETE FROM CampaignSharedSets WHERE AccountId ='1234339' AND CampaignId = '1833923' AND SharedListId = '25648'

Columns


Name	Type	ReadOnly	References	Description
SharedListId [KEY]	Int64	True	AccountSharedLists.SharedListId	Negative keyword list ID of the account.
AccountId	Int64	True	SearchAdsAccounts.AccountId	Account ID.
CampaignId	Int64	True	SearchAdsCampaigns.CampaignId	Campaign ID.
CampaignName	String	False		Campaign name.
SharedListName	String	False		Negative keyword list name of the account.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
ReferenceNumber	String	This column will be used in Bulk operations to get specific values from the Temp tables.

CampaignTargets

Create, Read, Update or Delete target setting information.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
TargetId supports the '=,IN'.
CampaignId supports the '=,IN'.
LocationTargetExcludedType supports the '='.
PlatformTargetPlatformType supports the '=,IN'.
TargetType supports the '=,IN'.

For example, the following queries are processed server side:

SELECT * FROM CampaignTargets WHERE AccountId = '25687'

SELECT * FROM CampaignTargets WHERE AccountId = '25687' AND TargetId IN ('456971')

SELECT * FROM CampaignTargets WHERE AccountId = '25687' AND LocationTargetExcludedType='INCLUDED'	

SELECT * FROM CampaignTargets WHERE AccountId = '25687' AND CampaignId IN ('0147')

SELECT * FROM CampaignTargets WHERE AccountId = '25687' AND PlatformTargetPlatformType IN ('SMART_PHONE')

SELECT * FROM CampaignTargets WHERE AccountId = '25687' AND TargetType IN (LOCATION')

INSERT

Insert can be executed by specifying the AccountId,CampaignId,TargetId,LocationTargetExcludedType,PlatformTargetPlatformType,ScheduleTargetDayOfWeek,ScheduleTargetStartMinute,ScheduleTargetEndMinute,ScheduleTargetStartHour,ScheduleTargetEndHour and TargetType 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 CampaignTargets(AccountId,CampaignId,TargetId,LocationTargetExcludedType,PlatformTargetPlatformType,ScheduleTargetDayOfWeek,ScheduleTargetStartMinute,ScheduleTargetEndMinute,ScheduleTargetStartHour,ScheduleTargetEndHour,TargetType) VALUES('4698','12365','3543535','INCLUDED','SMART_PHONE','TUESDAY','FIFTEEN','FORTY_FIVE',0,12,'LOCATION');

UPDATE

Update can be executed by specifying the AccountId, TargetId, CampaignId, PlatformTargetPlatformType and TargetType in the WHERE Clause. The columns that are not read-only can be Updated. For example:

UPDATE CampaignTargets SET ScheduleTargetDayOfWeek='WEDNESDAY' WHERE AccountId='78955' AND TargetId='78945' AND CampaignId='3245' AND PlatformTargetPlatformType='SMART_PHONE' AND TargetType='PLATFORM';

DELETE

Delete can be executed by specifying the AccountId,TargetId,CampaignId and TargetType in the WHERE Clause. For example:

DELETE FROM CampaignTargets WHERE AccountId='78955' AND TargetId='78945' AND CampaignId='3245'  AND TargetType='PLATFORM'

Columns


Name	Type	ReadOnly	References	Description
TargetId	String	True		Target ID.
AccountId	Int64	True	SearchAdsAccounts.AccountId	Account ID.
CampaignId	Int64	True	SearchAdsCampaigns.CampaignId	Campaign ID.
BidMultiplier	String	False		Bid adjustment rate. Can be specified between 0.10 to 10.00. When specified '0', the ad will not be delivered. Bid adjustment rate can be specified up to two decimal places. The default value will be 1.0.
CampaignName	String	False		Campaign Name.
LocationTargetCityNameEN	String	False		City(English). If targetType is LOCATION, this field is required in ADD operation.
LocationTargetCityNameJA	String	False		City(Japanese). If targetType is LOCATION, this field is required in ADD operation.
LocationTargetExcludedType	String	False		The setting type which delivers ads or do not deliver ads. If targetType is LOCATION, this field is required in ADD operation. The allowed values are INCLUDED, EXCLUDED, UNKNOWN.
LocationTargetProvinceNameEN	String	False		Prefecture(English). If targetType is LOCATION, this field is required in ADD operation.
LocationTargetProvinceNameJA	String	False		Prefecture(Japanese). If targetType is LOCATION, this field is required in ADD operation.
LocationTargetTargetingStatus	String	False		Status of targeting setting. If targetType is LOCATION, this field is required in ADD operation. The allowed values are ACTIVE, OBSOLETE, PHASING_OUT, UNKNOWN.
NetworkTargetNetworkCoverageType	String	False		Network coverage type. If targetType is NETWORK, this field is required in ADD operation. If you do not set the NetworkTarget, ads are delivered to the advertising system including all (YAHOO_SEARCH).
PlatformTargetPlatformType	String	False		A platform of the selected device. If targetType is PLATFORM, this field is required in ADD operation. The allowed values are SMART_PHONE, TABLET, DESKTOP, UNKNOWN.
ScheduleTargetDayOfWeek	String	False		A day of the week. If targetType is SCHEDULE, this field is required in ADD operation. The allowed values are MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY, UNKNOWN.
ScheduleTargetStartMinute	String	False		Minutes of an hour. Only supported for: 0, 15, 30, and 45 minutes past the hour. If targetType is SCHEDULE, this field is required in ADD operation. The allowed values are ZERO, FIFTEEN, THIRTY, FORTY_FIVE, UNKNOWN.
ScheduleTargetEndMinute	String	False		Minutes of an hour. Only supported for: 0, 15, 30, and 45 minutes past the hour. If targetType is SCHEDULE, this field is required in ADD operation. The allowed values are ZERO, FIFTEEN, THIRTY, FORTY_FIVE, UNKNOWN.
ScheduleTargetStartHour	Int64	False		Starting hour in 24 hour time. If targetType is SCHEDULE, this field is required in ADD operation.
ScheduleTargetEndHour	Int64	False		Ending hour in 24 hour time. If targetType is SCHEDULE, this field is required in ADD operation.
TargetType	String	False		Type of target setting. The allowed values are LOCATION, SCHEDULE, NETWORK, PLATFORM, UNKNOWN.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
ReferenceNumber	String	This column will be used in Bulk operations to get specific values from the Temp tables.

CampaignWebpages

Create, Read or Delete excluded settings of PageFeedItem for campaign.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
CampaignId supports the '=,IN'.
WebpageTargetId supports the '=,IN'.

For example:

SELECT * FROM CampaignWebpages WHERE AccountId = '25687'

SELECT * FROM CampaignWebpages WHERE AccountId = '25687' AND CampaignId IN ('456971')

SELECT * FROM CampaignWebpages WHERE AccountId = '25687' AND WebpageTargetId IN('8520')

INSERT

Insert can be executed by specifying the AccountId,CampaignId and WebpageTargetId 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 CampaignWebpageParameterConditions#TEMP (Argument, Operator, Type) VALUES ('url', 'CONTAINS', 'URL')

INSERT INTO CampaignWebpages (AccountId, CampaignId, WebpageTargetId, WebpageParameterConditions) VALUES ('4698', '12365', '4312', 'CampaignWebpageParameterConditions#TEMP')

DELETE

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

DELETE FROM CampaignWebpages WHERE AccountId='78955' AND CampaignId = '3245' AND WebpageTargetId = '1001'

Columns


Name	Type	ReadOnly	References	Description
WebpageTargetId [KEY]	Int64	True		Unique ID for each webpage.
AccountId	Int64	True	SearchAdsAccounts.AccountId	Account ID.
CampaignId	Int64	True	SearchAdsCampaigns.CampaignId	Campaign ID.
CampaignTrackId	Int64	False		Campaign Tracking ID.
WebpageParameterConditions	String	False		Object contains the rules of webpage.
WebpageTargetTrackId	Int64	False		Unique tracking ID for each CampaignWebpageServiceWebpage.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
ReferenceNumber	String	This column will be used in Bulk operations to get specific values from the Temp tables.

CustomizerAttribute

Get, Add or Delete Customizer Attribute Information.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
Type supports the '=,IN'.

For example:

SELECT * FROM CustomizerAttribute
SELECT * FROM CustomizerAttribute WHERE AccountId = '1234339'
SELECT * FROM CustomizerAttribute WHERE AccountId = '1234339' AND Type='TEXT'

INSERT

Insert can be executed by specifying the AccountId, Name, Type 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 CustomizerAttribute (AccountId,Name,Type) values(1234339,'Yogesh Mangal','TEXT')

DELETE

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

DELETE FROM CustomizerAttribute where AccountId=1234339 AND CustomizerAttributeId=510001

Columns


Name	Type	ReadOnly	References	Description
AccountId	Integer	True	SearchAdsAccounts.AccountId	Account ID.
CustomizerAttributeId	Integer	False		Customize Attribute ID.
Name	String	False		Attribute name.
Type	String	False		Represents the type of customizer attribute.

FeedItems

Create, Read, Update or Delete Feed Item information.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
FeedItemId supports the '=,IN'.
ApprovalStatus supports the '=,IN'.
FeedId supports the '=,IN'.
PlaceholderType supports the '=,IN'.

For example:

SELECT * FROM FeedItems WHERE AccountId='25687'

SELECT * FROM FeedItems WHERE AccountId='234535' AND FeedItemId='456971'

SELECT * FROM FeedItems WHERE AccountId='234535' AND ApprovalStatus IN('APPROVED_WITH_REVIEW')

SELECT * FROM FeedItems WHERE AccountId='234535' AND FeedId IN ('1470')	

SELECT * FROM FeedItems WHERE AccountId='234535' AND PlaceholderType IN ('CALLEXTENSION','AD_CUSTOMIZER')

INSERT

Insert can be executed by specifying the AccountId,CustomParameters,FeedItemAttribute,LocationTargetId,ReviewCustomParameters,TargetingKeywordKeywordMatchType and TargetingKeywordText 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 FeedItems(AccountId,CustomParameters,FeedItemAttribute,LocationTargetId,ReviewCustomParameters,TargetingKeywordKeywordMatchType,TargetingKeywordText) VALUES('4698','Testparameter','Feedobject','RA11','parameter1','PHRASE','DISAPPROVAL_REVIEWER');

UPDATE

Update can be executed by specifying the AccountId, FeedItemId, CustomParameters, ReviewCustomParameters, TargetingKeywordKeywordMatchType and TargetingKeywordText in the WHERE Clause. The columns that are not read-only can be Updated. For example:

UPDATE FeedItems SET TargetScheduleTargetDayOfWeek='WEDNESDAY' WHERE AccountId = '78955' AND FeedItemId = '56279' AND CustomParameters = 'Testparameter' AND ReviewCustomParameters = 'parameter1' AND TargetingKeywordKeywordMatchType = 'EXACT' AND TargetingKeywordText = 'KEY'

DELETE

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

DELETE FROM FeedItems WHERE AccountId = '78955' AND FeedItemId = '475219' AND PlaceholderType = 'QUICKLINK'

Columns


Name	Type	ReadOnly	References	Description
FeedItemId [KEY]	Int64	True		Feed Item ID.
AccountId	Int64	True	SearchAdsAccounts.AccountId	Account ID.
ApprovalStatus	String	False		FeedItemServiceApprovalStatus displays Editorial Status. The allowed values are APPROVED, APPROVED_WITH_REVIEW, REVIEW, PRE_DISAPPROVED, POST_DISAPPROVED, UNKNOWN.
CustomParametersIsRemove	String	False		Delete flag. The allowed values are TRUE, FALSE, UNKNOWN.
CustomParameters	String	False		Displays the element of custom parameters.
DevicePreference	String	False		A selection of device to deliver ads in high priority. The allowed values are SMART_PHONE, NONE, UNKNOWN. The default value is SMART_PHONE.
DisapprovalReasonCodes	String	False		Reject reason on editorial review.
StartDate	Date	False		Start date of ad display.
EndDate	Date	False		End date of ad display.
FeedId	Int64	False	SearchAdsFeeds.FeedId	Feed ID.
FeedItemAttribute	String	False		Object holds the value of Feed Item information.
FeedItemTrackId	Int64	False		Feed Item ID for tracking.
InvalidedTrademarks	String	False		Invalided trademarks.
LocationCriterionTypeFeedItem	String	False		Describes criteria information of location restriction. The allowed values are LOCATION, UNKNOWN. The default value is LOCATION.
LocationGeoRestriction	String	False		Controls ad delivery of location restriction. The allowed values are NONE, LOCATION_OF_PRESENCE, UNKNOWN. The default value is NONE.
LocationIsRemove	String	False		Delete flag. The allowed values are TRUE, FALSE, UNKNOWN.
LocationTargetId	String	False		FeedItemServiceLocation Type Code.
PlaceholderType	String	False		selects FeeItem information type. The allowed values are QUICKLINK, CALLEXTENSION, AD_CUSTOMIZER, CALLOUT, STRUCTURED_SNIPPET, UNKNOWN.
ReviewCustomParametersIsRemove	String	False		Delete flag. The allowed values are TRUE, FALSE, UNKNOWN.
ReviewCustomParameters	String	False		Displays the element of custom parameters.
SchedulingSchedules	String	False		Describes display schedule from Ad Display Option.
TargetingAdGroupTargetingAdGroupId	Int64	False		Targeting Ad group ID.
TargetingCampaignTargetingCampaignId	Int64	False		Campaign ID used for ad display.
TargetingKeywordKeywordMatchType	String	False		Describes keyword match type. The allowed values are EXACT, PHRASE, BROAD, UNKNOWN.
TargetingKeywordTargetingKeywordId	Int64	False		ID to identify the Targeting keyword (text).
TargetingKeywordText	String	False		Keyword text.
TrademarkStatus	String	False		Describes the status of trademark. The allowed values are DISAPPROVAL_CLAIM, DISAPPROVAL_REVIEWER, NO_RESTRICTION, CONFLICT_WITH_TRADEMARK, CLAIM_IN_PROGRESS, UNKNOWN.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
ReferenceNumber	String	This column will be used in Bulk operations to get specific values from the Temp tables.

PageFeedAssetSet

Get, Add or Remove the Page feed asset set.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
PageFeedAssetSetId supports the '=,IN'.
FeedId supports the '=,IN'.

For example:

SELECT * FROM PageFeedAssetSet
SELECT * FROM PageFeedAssetSet WHERE AccountId = '1234339'
SELECT * FROM PageFeedAssetSet WHERE AccountId = '1234339' AND PageFeedAssetSetId='1732'
SELECT * FROM PageFeedAssetSet WHERE AccountId = '1234339' AND PageFeedAssetSetId='1732' AND FeedId='12342'

INSERT

Insert can be executed by specifying the AccountId, PageFeedAssetSetName and Domain 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 PageFeedAssetSet(AccountId, PageFeedAssetSetName, Domain) Values(1234339,'TestPageAssetName','https://www.cdata.com/')

UPDATE

Update can be executed by specifying the AccountId, PageFeedAssetSetName AND PageFeedAssetSetId in the WHERE Clause. For example:

Update PageFeedAssetSet set PageFeedAssetSetName='Yogesh' where PageFeedAssetSetId=1728 AND AccountId=1234339

DELETE

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

Delete from PageFeedAssetSet where AccountId=1234339 AND PageFeedAssetSetId=1728

Columns


Name	Type	ReadOnly	References	Description
PageFeedAssetSetId [KEY]	Int64	True		Page Feed Asset Set ID.
AccountId	Int64	False	SearchAdsAccounts.AccountId	Account ID.
Domain	String	False		Domain.
FeedId	Int64	False	SearchAdsFeeds.FeedId	Feed ID.
PageFeedAssetSetName	String	False		Page Feed Asset Set Name.

SearchAdsAccountManagement

Create, update or Read account information.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '=,IN'.
AccountType supports the '=,IN'.
AuthType supports the '='.
Status supports the '=,IN'.
IncludeTestAccount supports the '=,IN'.

For example:

SELECT * FROM SearchAdsAccountManagement WHERE AccountId = '25687'

SELECT * FROM SearchAdsAccountManagement WHERE AccountId = '25687' AND AccountType IN ('INVOICE')

SELECT * FROM SearchAdsAccountManagement WHERE AccountId = '25687' AND AuthType = 'ssl'

SELECT * FROM SearchAdsAccountManagement WHERE AccountId = '25687' AND Status IN ('SUSPENDED')	

SELECT * FROM SearchAdsAccountManagement WHERE AccountId = '25687' AND IncludeTestAccount IN ('ONLY_TEST')

INSERT

Insert can be executed by specifying the AccountName, AccountPaymentInvoiceBudgetAmount, ClientCity, ClientCompanyName, ClientCompanyNameKana, ClientEnterpriseType ,ClientPhoneNumber, ClientStreet1, ClientStreet2, ClientUrl, ClientUrlType, ClientZip and ClientType columns. The columns that are not read-only can be inserted optionally.

INSERT INTO SearchAdsAccountManagement (AccountName,AccountPaymentInvoiceBudgetAmount,AccountPaymentPaymentType,ClientBuilding,ClientCity,ClientCompanyName,ClientCompanyNameKana,ClientEnterpriseType,ClientPhoneNumber,ClientStreet1,ClientStreet2,ClientUrl,ClientUrlType,ClientZip,ClientType ) values('test',1234,'PREPAY','cdata','blr','infosys','cd','GOMEI','98765-98765-98765','street1','street2','ClientUrl','PC','123-1234','AGENT')

UPDATE

The columns that are not read-only can be Updated. For example:

UPDATE SearchAdsAccountManagement SET AccountName = 'TestAccount' WHERE AccountId = '1002504155';

Columns


Name	Type	ReadOnly	References	Description
AccountId [KEY]	Int64	True	SearchAdsAccounts.AccountId	Account ID.
AccountName	String	False		Account Name.
AccountPaymentInvoiceBudgetAmount	Int64	False		Budget Amount. Amount must be more than 3,000 and less than 999,999,999,999,000. The unit is 1,000
AccountPaymentInvoiceStartDate	Date	False		Start Date.This field will be automatically registered in ADD operation.
AccountPaymentInvoiceEndDate	Date	False		End Date. Specify the date in .The default value in ADD operation will be 20371231. 20371231 will be considered as No setting.
AccountPaymentPaymentType	String	False		Describes the type of payment. The allowed values are PREPAY, INVOICE, UNKNOWN.
AgencyPersonName	String	False		Agency Person Name.
AgencyPrefectureCode	String	False		Describes the code of prefectures.Under 'client' this field will be required in ADD operation. The allowed values are HOKKAIDO, AOMORI, IWATE, MIYAGI, AKITA, YAMAGATA, FUKUSHIMA, IBARAKI, TOCHIGI, GUNMA, SAITAMA, CHIBA, TOKYO, KANAGAWA, NIIGATA, TOYAMA, ISHIKAWA, FUKUI, YAMANASHI, GIFU, AICHI, MIE, SIGA, KYOTO, OSAKA, HYOGO, NARA, WAKAYAMA, TOTTORI, SHIMANE, OKAYAMA, YAMAGUCHI, TOKUSHIMA, KAGAWA, EHIME, KOCHI, FUKUOKA, SAGA, NAGASAKI, KUMAMOTO, OITA, MIYAZAKI, KAGOSHIMA, OKINAWA, NONE, UNKNOWN.
AuthType	String	False		Access roles.
AutoTaggingEnabled	String	False		The Management flag for whether or not to set auto tag. The allowed values are TRUE, FALSE, UNKNOWN. The default value is TRUE.
ClientBuilding	String	False		Client Building name.
ClientCity	String	False		Client City name.
ClientClientPersonName	String	False		Client person name.
ClientCompanyName	String	False		Client Company name.
ClientCompanyNameKana	String	False		Kana characters of company name.
ClientEnterpriseType	String	False		Describes type of enterprise. The allowed values are KABUSHIKI, YUGEN, GOSI, ZAIDAN, SYADAN, SYUKYO, GAKKO, KOJIN, OTHER, GOMEI, HIEIRI, GODO, KYODO, Unknown.
ClientEnterpriseTypePosition	String	False		Describes the position of enterprise type. Cannot be set when enterpriseType is KOJIN or OTHER in ADD operation. The allowed values are FRONT, BACK, UNKNOWN.
ClientPhoneNumber	String	False		Phone number. In xxxxx-xxxxx-xxxxx format.
ClientPrefectureCode	String	False		Describes the code of prefectures. The allowed values are HOKKAIDO, AOMORI, IWATE, MIYAGI, AKITA, YAMAGATA, FUKUSHIMA, IBARAKI, TOCHIGI, GUNMA, SAITAMA, CHIBA, TOKYO, KANAGAWA, NIIGATA, TOYAMA, ISHIKAWA, FUKUI, YAMANASHI, GIFU, AICHI, MIE, SIGA, KYOTO, OSAKA, HYOGO, NARA, WAKAYAMA, TOTTORI, SHIMANE, OKAYAMA, YAMAGUCHI, TOKUSHIMA, KAGAWA, EHIME, KOCHI, FUKUOKA, SAGA, NAGASAKI, KUMAMOTO, OITA, MIYAZAKI, KAGOSHIMA, OKINAWA, NONE, UNKNOWN.
ClientStreet1	String	False		Street1.
ClientStreet2	String	False		Street2.
ClientUrl	String	False		Site URL for placing advertisement.
ClientUrlType	String	False		Describes the type of application url. The allowed values are PC, DOCOMO, KDDI, SOFTBANK, OTHER, UNKNOWN.
ClientZip	String	False		Zip code in xxx-xxxxx format.
ClientType	String	False		Describes the type of client. The allowed values are AGENT, SELF, UNKNOWN.
ContactBizId	String	False		Contact Business ID.
DeliveryStatus	String	False		Describes account delivery status. The allowed values are ACTIVE, PAUSED, UNKNOWN. The default value is ACTIVE.
IsAdultAccount	String	False		The Adult Account flag. The allowed values are TRUE, FALSE, UNKNOWN.
IsTestAccount	String	False		Describes whether the account is a test account or not. The allowed values are TRUE, FALSE, UNKNOWN.
Status	String	False		Describes contract status of account. The allowed values are INPROGRESS, WAIT_DECIDE, SUSPENDED, SERVING, ENDED, CANCELLED, UNKNOWN.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
IncludeTestAccount	String	Accounts to retrieve. The allowed values are ONLY_TEST, EXCLUDE_TEST, ALL, UNKNOWN.
AccountType	String	Account Payment Types.

SearchAdsAccounts

Read Or Update account information.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '=,IN'.
AccountName supports the '='.
AccountStatus supports the '=,IN'.
AccountType supports the '=,IN'.
AuthType supports the '=,IN'.
IncludeTestAccount supports the '='.
IncludeManagerAccount supports the '='.

For example:

SELECT * FROM SearchAdsAccounts

SELECT * FROM SearchAdsAccounts WHERE  AccountId = '1234339'

UPDATE

Update can be executed by specifying the AccountId in the WHERE Clause.The columns that are not read-only can be Updated. For example: For example:

UPDATE  SearchAdsAccounts SET AccountName = 'CData Software' WHERE  AccountId = '1234339'

Columns


Name	Type	ReadOnly	References	Description
AccountId [KEY]	Int64	True		Account ID.
AccountName	String	False		Account Name.
AccountStatus	String	False		Account status. The allowed values are INPROGRESS, WAIT_DECIDE, SUSPENDED, SERVING, ENDED, UNKNOWN.
AccountType	String	False		Payment type of the account. The allowed values are PREPAY, INVOICE, UNKNOWN.
AuthType	String	False		Roles. The allowed values are REFERABLE, UPDATABLE, UNKNOWN.
AutoTaggingEnabled	String	False		The Management flag for whether or not to set auto tag.
ContactBizId	String	False		Contact Business ID.
DeliveryStatus	String	False		Delivery status.
StartDate	Date	False		Start date of ad serving.
EndDate	Date	False		End date of ad serving.
IsManagerAccount	String	False		Describes whether it is an MCC account.
IsTestAccount	String	False		Describes whether it is a Test account.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
IncludeTestAccount	String	Accounts to retrieve. The allowed values are ONLY_TEST, EXCLUDE_TEST, ALL, UNKNOWN. The default value is EXCLUDE_TEST.
IncludeManagerAccount	String	Represents whether the account to be retrieved includes an MCC account. The allowed values are ONLY_MANAGER, EXCLUDE_MANAGER, ALL, UNKNOWN. The default value is EXCLUDE_MANAGER.

SearchAdsAdGroupAds

Create, Read, Update and Delete Ad group information.

Table Specific Information

Select

The Sync App 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 Sync App.

AdId supports the '=,IN'.
AccountId supports the '='.
AdGroupId supports the '=,IN'.
AdType supports the '=,IN'.
ApprovalStatus supports the '=,IN'.
CampaignId supports the '=,IN'.
UserStatus supports the '=,IN'.
ContainsLabelId supports the '='.
LabelId supports the '='.
StartDate supports the '='.
EndDate supports the '='.

For example, the following queries are processed server side:

SELECT * FROM SearchAdsAdGroupAds WHERE AccountId = '25687';

SELECT * FROM SearchAdsAdGroupAds WHERE AccountId = '25687' AND AdId IN ('456971');	

SELECT * FROM SearchAdsAdGroupAds WHERE AccountId = '25687' AND AdGroupId IN ('8520');

INSERT

Insert can be executed by specifying the AccountId, CampaignId, AdGroupId, AdType, AdvancedUrl, Description1, AdName and userStatus 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 SearchAdsAdGroupAds (AccountId,CampaignId,AdGroupId,AdType,AdvancedUrl,Description1,AdName,userStatus) values('1234339','1836854','303272616','DYNAMIC_SEARCH_LINKED_AD','https://cdata.com','test','test','ACTIVE')

UPDATE

Update can be executed by specifying the AccountId, CampaignId, AdId and AdGroupId columns. The columns that are not read-only can be inserted optionally. Following is an example of how to insert into this table

UPDATE  SearchAdsAdGroupAds SET AdName = 'Jtest'  WHERE AccountId='1234339' AND CampaignId = '1767536' AND AdGroupId = '303244007' AND AdId = '661448246'

DELETE

Delete can be executed by specifying theAccountId, CampaignId, AdId and AdGroupId in the WHERE Clause. For example:

DELETE FROM SearchAdsAdGroupAds WHERE  AccountId = '1234339' AND CampaignId = '1833923' AND AdGroupId = '303133212' AND AdId = '661222773'

Columns


Name	Type	ReadOnly	References	Description
AdId [KEY]	Int64	True		Ad ID.
AccountId	Int64	True	SearchAdsAccounts.AccountId	Account ID.
AdGroupId	Int64	True	SearchAdsAdGroups.AdGroupId	Ad group ID.
AdGroupName	String	False		Ad group name.
AdGroupTrackId	Int64	False		Ad group ID for tracking.
AdName	String	False		Ad name.
AdTrackId	Int64	False		Ad ID for tracking.
AdType	String	False		Device type and number of title and description character. The allowed values are EXTENDED_TEXT_AD, DYNAMIC_SEARCH_LINKED_AD, TEXT_AD2, APP_AD, RESPONSIVE_SEARCH_AD, UNKNOWN.
SmartphoneFinalUrl	String	False		Landing Page URL (Smartphone).
FinalUrl	String	False		Landing Page URL.
AppAdAppId	String	False		App ID. If adType is APP_AD, this field is required.
AppAdAppStore	String	False		App Store. If adType is APP_AD, this field is required. The allowed values are IOS, ANDROID, UNKNOWN.
AppAdDescription2	String	False		Description2 (line2) of the ad.If adType is APP_AD, this field is required.
CustomParametersIsRemove	String	False		Delete flag. The allowed values are TRUE, FALSE, UNKNOWN.
CustomParametersParameters	String	False		displays the element of custom parameters.
Description1	String	False		Description of ad. If adType is RESPONSIVE_SEARCH_AD, this field will be ignored.
DevicePreference	String	False		A device delivering an advertisement with precedence. If adType is EXTENDED_TEXT_AD, this field will be ignored.
DisplayUrl	String	False		Display URL.
ExtendedTextAdDescription2	String	False		Description on the second line. If adType is EXTENDED_TEXT_AD, this field is required.
ExtendedTextAdHeadline2	String	False		Title on the second line. If adType is EXTENDED_TEXT_AD, this field is required.
ExtendedTextAdHeadline3	String	False		Title on the second line. If adType is EXTENDED_TEXT_AD, this field is required.
ExtendedTextAdPath1	String	False		The path information which complements display URL generated automatically. To specify path2, path1 is required. f adType is EXTENDED_TEXT_AD, this field is required.
ExtendedTextAdPath2	String	False		The path information which complements display URL generated automatically. If path1 is not specified, path2 will be ignored. f adType is EXTENDED_TEXT_AD, this field is required.
Headline1	String	False		Title of ad.
ResponsiveSearchAdDescriptions	String	False		Displays the text asset for the description that specify in responsive ad. If adType is RESPONSIVE_SEARCH_AD, this field is required.
ResponsiveSearchAdHeadlines	String	False		Displays the text asset for the headline that specify in responsive ad. If adType is RESPONSIVE_SEARCH_AD, this field is required.
ResponsiveSearchAdPath1	String	False		The path information which complements display URL generated automatically. To specify path2, path1 is required. If adType is RESPONSIVE_SEARCH_AD, this field is required.
ResponsiveSearchAdPath2	String	False		The path information which complements display URL generated automatically. If path1 is not specified, path2 will be ignored. If adType is RESPONSIVE_SEARCH_AD, this field is required.
TextAd2Description2	String	False		Description2 (line2) of the ad.
TrackingUrl	String	False		Tracking URL.
Url	String	False		Destination URL before upgrading.
ApprovalStatus	String	False		Displays Editorial Status. The allowed values are APPROVED, APPROVED_WITH_REVIEW, REVIEW, PRE_DISAPPROVAL, POST_DISAPPROVAL, UNKNOWN.
CampaignId	Int64	False	SearchAdsCampaigns.CampaignId	Campaign ID.
CampaignName	String	False		Campaign name.
CampaignTrackId	Int64	False		Campaign ID for tracking.
CreatedDate	Date	True		Date of Ad made
DisapprovalReasonCodes	String	False		Code of Disapproval reason.
FeedId	Int64	False	SearchAdsFeeds.FeedId	Feed ID.
InvalidedTrademarks	String	False		Invalided trademarks.
Labels	String	False		Describes label information to be associated.
TrademarkStatus	String	False		Describes the status of trademark. The allowed values are NO_RESTRICTION, CONFLICT_WITH_TRADEMARK, CLAIM_IN_PROGRESS, DISAPPROVAL_CLAIM, DISAPPROVAL_REVIEWER, UNKNOWN.
UserStatus	String	False		Displays ad delivery status that can be set by an user. The allowed values are ACTIVE, PAUSED, UNKNOWN.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
ContainsLabelId	String	Describes acquisition flag of label data. The allowed values are TRUE, FALSE, UNKNOWN.
LabelIds	Int64	Label Ids.
StartDate	Date	This is the start date of the search target period.
EndDate	Date	This is the end date of the search target period.
ReferenceNumber	String	This column will be used in Bulk operations to get specific values from the Temp tables.

SearchAdsAdGroups

Create, Read, Update or Delete Ad group.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
AdGroupId supports the '=,IN'.
CampaignId supports the '=,IN'.
UserStatus supports the '=,IN'.
ContainsLabelId supports the '=,IN'.
BiddingStateryIds supports the '=,IN'.
LabelId supports the '=,IN'.
StartDate supports the '='.
EndDate supports the '='.

For example, the following queries are processed server side:

SELECT * FROM SearchAdsAdGroupAds WHERE AccountId = '1234339'

SELECT * FROM SearchAdsAdGroupAds WHERE AccountId = '1234339' AND AdGroupId = '303253202'

SELECT * FROM SearchAdsAdGroupAds WHERE AccountId = '1234339' AND CampaignId = '303253202'

INSERT

Insert can be executed by specifying the AccountId, AdGroupId, AdGroupName, CampaignId, CustomParameters, UrlReviewDataInReviewUrlParameters and UserStatus columns. The columns that are not read-only can be inserted optionally. For example:

 INSERT INTO customparameters#TEMP (Key, value) VALUES ('TestKey', 'TestValue')
 INSERT INTO urlparameters#TEMP (Key, value) VALUES ('TestKey2', 'TestValue2')
 INSERT INTO SearchAdsAdGroups (AccountId, AdGroupName,CampaignId, CustomParameters, UserStatus, UrlReviewDataInReviewUrlParameters ) VALUES ('1234339', 'TestGroupName', '1833923','customparameters#TEMP', 'ACTIVE', 'urlparameters#TEMP')

UPDATE

Update can be executed by specifying the AccountId,AdGroupId,CampaignId in the WHERE Clause. The columns that are not read-only can be Updated. For example:

INSERT INTO urlparameters#TEMP (Key, value) VALUES ('TestKey2', 'TestValue2')
UPDATE SearchAdsAdGroups SET AdGroupName = 'TestName', SettingsTargetingSettingTargetAll = 'ACTIVE', UrlReviewDataInReviewUrlParameters = 'urlparameters#TEMP', SettingsCriterionType = 'TARGET_LIST'  WHERE AccountId = '1234339' AND AdGroupId = '303253202' AND CampaignId = '1833923'

DELETE

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

Delete from SearchAdsAdGroups  WHERE AccountId = '1234339' AND CampaignId = '1833923' AND AdGroupId = '303253202'

Columns


Name	Type	ReadOnly	References	Description
AdGroupId [KEY]	Int64	True		Ad group ID.
AccountId	Int64	True	SearchAdsAccounts.AccountId	Account ID.
AdGroupAdRotationModeAdRotationMode	String	False		Describes Ad Rotation settings for optimizing and displaying ads. The allowed values are OPTIMIZE, ROTATE_FOREVER, UNKNOWN.
AdGroupName	String	False		Ad Group name.
AdGroupTrackId	Int64	False		Ad Group ID for tracking.
BidBidSource	String	False		Displays which level bid belongs to ad group. The allowed values are ADGROUP, UNKNOWN.
BidCpc	Int64	False		Keyword bid (CPC).The default value in ADD operation will be 1.
CampaignId	Int64	False	SearchAdsCampaigns.CampaignId	Campaign ID.
CampaignName	String	False		Campaign name.
CampaignTrackId	Int64	False		Campaign ID for tracking.
CreatedDate	Date	False		Date of Ad Group made.
CustomParametersIsRemove	String	False		The Delete flag. The allowed values are TRUE, FALSE, UNKNOWN.
CustomParameters	String	False		Displays the element of custom parameters.
Labels	String	False		Describes label information to be associated.
SettingsCriterionType	String	False		Display the type of criteria.The default value in ADD operation for the case of no setting 'TargetingSetting' is TARGET_LIST. The allowed values are TARGET_LIST, UNKNOWN. The default value is TARGET_LIST.
SettingsTargetingSettingTargetAll	String	False		Describes the setting of target(include) users on Site Retargeting. The allowed values are ACTIVE, DEACTIVATE, UNKNOWN. The default value is ACTIVE.
TargetCpaOverride	Int64	False		Target CPA.
TargetRoasOverride	String	False		Target ROAS.
TrackingUrl	String	False		Tracking URL
UrlReviewDataDisapprovalReasonCodes	String	False		Code of Disapproval reason.
UrlReviewDataDisapprovalReviewUrlParameters	String	False		Displays the element of custom parameters.
UrlReviewDataDisapprovalReviewUrlTrackingUrl	String	False		Tracking URL.
UrlReviewDataInReviewUrlParameters	String	False		Displays the element of custom parameters.
UrlReviewDataInReviewUrlTrackingUrl	String	False		Tracking URL.
UrlReviewDataUrlApprovalStatus	String	False		A review status of URL. The allowed values are REVIEW, DISAPPROVAL, NONE, APPROVED, APPROVED_WITH_REVIEW, UNKNOWN.
UserStatus	String	False		Displays ad delivery status that can be set by an user. The allowed values are ACTIVE, PAUSED, UNKNOWN.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
BiddingStateryIds	Int64	Bidding Statery Ids.
ContainsLabelId	String	Describes acquisition flag of label data.
LabelId	Int64	Label Ids.
StartDate	Date	This is the start date of the search target period.
EndDate	Date	This is the end date of the search target period.
Min	String	Maximum value of the search range.
Max	String	Minimum value of the search range.
ReferenceNumber	String	This column will be used in Bulk operations to get specific values from the Temp tables.

SearchAdsAuditLogs

Get procession status about download operation history data or creates job to register for export.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
JobId supports the '=,IN'.
JobStatus supports the '=,IN'.

For example:

SELECT * FROM SearchAdsAuditLogs WHERE AccountId = '25687';

SELECT * FROM SearchAdsAuditLogs WHERE AccountId = '23542' AND JobId = '456971';

Columns


Name	Type	ReadOnly	References	Description
JobId [KEY]	Int64	True		Job ID.
AccountId	Int64	True	SearchAdsAccounts.AccountId	Account ID.
StartDate	Datetime	False		Start date of target date.
EndDate	Datetime	False		End date of target date.
Encoding	String	False		Describes the encoding type (character encoding) for Operation History file. The allowed values are SJIS, UTF8, UTF16LE, UNKNOWN.
EventSelector	String	False		Object enables the target setting of acquiring operation history.
JobName	String	False		Name of job.
JobStatus	String	False		Describes the job status of acquiring operation history data. The allowed values are SYSTEM_ERROR, IN_PROGRESS, COMPLETED, TIMEOUT, UNKNOWN.
Lang	String	False		Describes the language setting of operation history data file. The allowed values are EN, JA, UNKNOWN. The default value is JA.
Output	String	False		Specifies the file format of acruiqred operation history data. The allowed values are ZIPPED_CSV, ZIPPED_TSV, CSV, TSV, UNKNOWN. The default value is CSV.
SourceType	String	False		Desribes the operator information of operation history data. The allowed values are API, YAHOO_JAPAN, CAMPAIGN_MANAGEMENT_TOOL, ALL, UNKNOWN. The default value is API.
OperationSucceeded	String	False		Processing result. If true, the operation was successful. If false, the process has failed

SearchAdsBudgets

Read or Update budget information for the account.

Table Specific Information

SELECT

The Sync App 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 Sync App.

AccountId supports the '=,IN'.

For example:

SELECT * FROM SearchAdsBudgets WHERE AccountId = '12346'

UPDATE

Update can be executed by specifying the AccountId in the WHERE clause. The columns that are not read-only can be Updated. For example:

UPDATE SearchAdsBudgets SET Amount = '1000', LimitChargeType = 'MONTHLY' WHERE AccountId = '12346'

Columns


Name	Type	ReadOnly	References	Description
AccountId [KEY]	Int64	True	SearchAdsAccounts.AccountId	Account ID.
AccountType	String	False		Displays the account charge type. The allowed values are PREPAY, INVOICE, UNKNOWN.
Amount	Int64	False		Amount of budget. The monthly budget can be changed only when accountType is INVOICE. In addition, the budget amount must be specified in units of 1000 yen.
LimitChargeType	String	False		Serves the account's budget allotment. Specify MONTHLY to change the monthly budget. The allowed values are SUM, MONTHLY, UNKNOWN.

SearchAdsCampaigns

Create, Read, Update or Delete Campaigns.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
CampaignId supports the '=,IN'.
BiddingStrategyConfigurationBiddingStrategyId supports the '=,IN'.
StartDate supports the '='.
EndDate supports the '='.
UserStatus supports the '=,IN'.
ContainsLabelId supports the '='.
LabelId supports the '=,IN'.
MinBudgetAmount supports the '='.
MaxBudgetAmount supports the '='.

For example:

SELECT * FROM  SearchAdsCampaigns WHERE AccountId = '12346'

SELECT * FROM  SearchAdsCampaigns WHERE AccountId = '12346' AND CampaignId = '9756'

SELECT * FROM  SearchAdsCampaigns WHERE AccountId = '12346' AND StartDate = '2021-01-21' AND EndDate = '2021-02-03'

SELECT * FROM  SearchAdsCampaigns WHERE AccountId = '12346' AND UserStatus = 'UNKNOWN'

SELECT * FROM  SearchAdsCampaigns WHERE AccountId = '12346' AND ContainsLabelId = 'TRUE'

SELECT * FROM  SearchAdsCampaigns WHERE AccountId = '12346' AND MinBudgetAmount = '1' AND MaxBudgetAmount = '1000'

INSERT

Insert can be executed by specifying the AccountId, BiddingStrategyConfigurationBiddingSchemeBiddingStrategyType, BiddingStrategyConfigurationBiddingSchemeTargetImpressionShareSchemeLocation, BiddingStrategyConfigurationBiddingSchemeTargetImpressionShareSchemeTargetImpressionShare, BiddingStrategyConfigurationBiddingSchemeTargetImpressionShareSchemeBidCeiling, BudgetAmount, CampaignName, CustomParametersParameters, EndDate, FailedBiddingStrategyConfigurationBiddingSchemeTargetImpressionShareSchemeTargetImpressionShare, UrlReviewDataDisapprovalReviewUrlParameters, UrlReviewDataDisapprovalReviewUrlTrackingUrl, UrlReviewDataInReviewUrlParameters, UrlReviewDataInReviewUrlTrackingUrl, UserStatus 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 CustomParameters#TEMP (Key,Value) VALUES ('TestKey','TestValue')

INSERT INTO UrlReviewDataDisapprovalReviewUrlParameters#TEMP (Key,Value) VALUES ('TestKey2','TestValue2')

INSERT INTO UrlReviewDataInReviewUrlParameters#TEMP (Key,Value) VALUES ('TestKey3','TestValue3')

INSERT INTO SearchAdsCampaigns (AccountId, BiddingStrategyConfigurationBiddingSchemeBiddingStrategyType, BiddingStrategyConfigurationBiddingSchemeTargetImpressionShareSchemeLocation, BiddingStrategyConfigurationBiddingSchemeTargetImpressionShareSchemeTargetImpressionShare, BiddingStrategyConfigurationBiddingSchemeTargetImpressionShareSchemeBidCeiling, BudgetAmount, BudgetPeriod, CampaignName, CustomParameters, FailedBiddingStrategyConfigurationBiddingSchemeTargetImpressionShareSchemeTargetImpressionShare, UrlReviewDataDisapprovalReviewUrlParameters, UrlReviewDataDisapprovalReviewUrlTrackingUrl, UrlReviewDataInReviewUrlParameters, UrlReviewDataInReviewUrlTrackingUrl, UserStatus) VALUES (1234339,'TARGET_IMPRESSION_SHARE','ANYWHERE_ON_PAGE', '1', 20, 100, 'DAILY', 'CampaignProduct1', 'CustomParameters#TEMP', 50, 'UrlReviewDataDisapprovalReviewUrlParameters#TEMP', 'tracking.com/1sjfn23iu4hnw234s', 'UrlReviewDataInReviewUrlParameters#TEMP', 'tracking.com/1sjfn23iu4hnw234f', 'PAUSED')

UPDATE

Update can be executed by specifying the AccountId, CampaignId, BiddingStrategyConfigurationBiddingSchemeTargetImpressionShareSchemeTargetImpressionShare, CustomParametersParameters, EndDate, FailedBiddingStrategyConfigurationBiddingSchemeTargetImpressionShareSchemeTargetImpressionShare, UrlReviewDataDisapprovalReviewUrlParameters, UrlReviewDataDisapprovalReviewUrlTrackingUrl, UrlReviewDataInReviewUrlParameters, UrlReviewDataInReviewUrlTrackingUrl in the WHERE Clause. The columns that are not read-only can be Updated. For example:

INSERT INTO CustomParameters#TEMP (Key,Value) VALUES ('TestKey','TestValue')
INSERT INTO UrlReviewDataDisapprovalReviewUrlParameters#TEMP (Key,Value) VALUES ('TestKey2','TestValue2')
INSERT INTO UrlReviewDataInReviewUrlParameters#TEMP (Key,Value) VALUES ('TestKey3','TestValue3')
UPDATE SearchAdsCampaigns SET BiddingStrategyConfigurationBiddingSchemeTargetImpressionShareSchemeTargetImpressionShare = '20', CustomParameters = 'CustomParameters#TEMP', FailedBiddingStrategyConfigurationBiddingSchemeTargetImpressionShareSchemeTargetImpressionShare  = '50', UrlReviewDataDisapprovalReviewUrlParameters = 'UrlReviewDataDisapprovalReviewUrlParameters#TEMP', UrlReviewDataDisapprovalReviewUrlTrackingUrl = 'tracking.com/1sjfn23iu4hnw234t', UrlReviewDataInReviewUrlParameters = 'UrlReviewDataInReviewUrlParameters#TEMP', UrlReviewDataInReviewUrlTrackingUrl = 'tracking.com/1sjfn23iu4hnw234g' WHERE AccountId = '1234339' AND CampaignId = '25649'

DELETE

Delete can be executed by specifying the AccountId,CampaignId in the WHERE Clause. For example:

DELETE FROM SearchAdsCampaigns WHERE AccountId = '12346' AND CampaignId = '23569'

Columns


Name	Type	ReadOnly	References	Description
CampaignId [KEY]	Int64	True		Campaign ID.
AccountId	Int64	False	SearchAdsAccounts.AccountId	Account ID.
AppId	String	False		App ID (for iOS) or Package name (for Android). pp ID (for iOS) or Package name (for Android). Input only the numbers for iOS in Mobile App Campaign. In ADD operation, this field will be ignored when campaignType is (STANDARD) or (DYNAMIC_ADS_FOR_SEARCH_SETTING), and is required when campaignType is MOBILE_APP.
AppStore	String	False		The type of app store. In ADD operation, this field will be ignored when campaignType is (STANDARD) or (DYNAMIC_ADS_FOR_SEARCH_SETTING), and is required when campaignType is MOBILE_APP. The allowed values are IOS, ANDROID, UNKNOWN.
BiddingStrategyConfigurationBiddingSchemeBiddingStrategyType	String	False		Displays the Auto Bidding type. This field is required when Standard bidding is setting, and is optional when Portfolio bidding is setting in ADD operation. The allowed values are MANUAL_CPC, TARGET_ROAS, TARGET_SPEND, TARGET_CPA, MAXIMIZE_CONVERSIONS, TARGET_IMPRESSION_SHARE, UNKNOWN.
BiddingStrategyConfigurationBiddingCpcBiddingSchemeEnhancedCpcEnabled	String	False		Specifies flag of Maximize Conversions. This field is required when BiddingStrategyType is MANUAL_CPC in ADD operation. For other BiddingStrategyType, this field is optional in ADD operation. The allowed values are TRUE, FALSE, UNKNOWN. The default value is FALSE.
BiddingStrategyConfigurationBiddingSchemeTargetCpaBiddingSchemeBidCeiling	Int64	False		Limit of bid (CPC). The default value will be 0. No limits if 0 is set. This field is required when BiddingStrategyType is TARGET_CPA in ADD operation. For other BiddingStrategyType, this field is optional in ADD operation.
BiddingStrategyConfigurationBiddingSchemeTargetCpaBiddingSchemeBidFloor	Int64	False		Minimum CPC. The default value will be 0. Set 0 to deactivate. This field is required when BiddingStrategyType is TARGET_CPA in ADD operation. For other BiddingStrategyType, this field is optional in ADD operation.
BiddingStrategyConfigurationBiddingSchemeTargetCpaBiddingSchemeTargetCpa	Int64	False		Target CPA (JPY). Range limit: 0 - 99999999. This field is required when BiddingStrategyType is TARGET_CPA in ADD operation. For other BiddingStrategyType, this field is optional in ADD operation.
BiddingStrategyConfigurationBiddingSchemeTargetImpressionShareSchemeBidCeiling	Int64	False		Limit of bid (CPC). The default value will be 0. No limits if 0 is set. If BiddingStrategyType is TARGET_IMPRESSION_SHARE, this field is required in ADD operation, and it is optional when BiddingStrategyType is the others.
BiddingStrategyConfigurationBiddingSchemeTargetImpressionShareSchemeLocation	String	False		Specifies search result posting position to achieve the target ratio of impression share. If BiddingStrategyType is TARGET_IMPRESSION_SHARE, this field is required in ADD operation, and it is optional when BiddingStrategyType is the others. The allowed values are ANYWHERE_ON_PAGE, TOP_OF_PAGE, ABSOLUTE_TOP_OF_PAGE, UNKNOWN. The default value is ANYWHERE_ON_PAGE.
BiddingStrategyConfigurationBiddingSchemeTargetImpressionShareSchemeTargetImpressionShare	Int64	False		Target impression share. If BiddingStrategyType is TARGET_IMPRESSION_SHARE, this field is required in ADD operation, and it is optional when BiddingStrategyType is the others.
BiddingStrategyConfigurationBiddingSchemeTargetRoasBiddingSchemeBidCeiling	Int64	False		Limit of bid (CPC). This field is required when BiddingStrategyType is TARGET_ROAS in ADD operation. For other BiddingStrategyType, this field is optional in ADD operation.
BiddingStrategyConfigurationBiddingSchemeTargetRoasBiddingSchemeBidFloor	Int64	False		Minimum CPC. This field is required when BiddingStrategyType is TARGET_ROAS in ADD operation. For other BiddingStrategyType, this field is optional in ADD operation.
BiddingStrategyConfigurationBiddingSchemeTargetRoasBiddingSchemeTargetRoas	String	False		Target ROAS (Return On Advertising Spend). This field is required when BiddingStrategyType is TARGET_ROAS in ADD operation. For other BiddingStrategyType, this field is optional in ADD operation.
BiddingStrategyConfigurationBiddingStrategyId	Int64	False		Auto Bidding ID. This field cannot be specified when Standard bidding is setting, and is required when Portfolio bidding is setting in ADD operation. It cannot be specified at the same times as biddingScheme.
BiddingStrategyConfigurationBiddingStrategyName	String	False		Auto Bidding name. Up to 50 characters.
BiddingStrategyConfigurationBiddingStrategySource	String	False		A source of Auto Bidding. The allowed values are CAMPAIGN, UNKNOWN.
BiddingStrategyConfigurationBiddingStrategyType	String	False		Displays the Auto Bidding type. This field is required when Standard bidding is setting, and is optional when Portfolio bidding is setting in ADD operation. The allowed values are MANUAL_CPC, TARGET_ROAS, TARGET_SPEND, TARGET_CPA, MAXIMIZE_CONVERSIONS, TARGET_IMPRESSION_SHARE, UNKNOWN.
BiddingStrategyFailedReason	String	False		Displays the failure reason of Auto Bidding setting. The allowed values are FAILURE, CONVERSION_TRACKING_NOT_ENABLED, NOT_ENOUGH_CONVERSIONS, CANNOT_CREATE_CAMPAIGN_WITH_CONVERSION_OPTIMIZER, BIDDING_STRATEGY_CANNOT_BE_OVERRIDDEN, NOT_CPC_CAMPAIGN, UNKNOWN.
BudgetAmount	Int64	False		Amount of budget of Campaign.
BudgetPeriod	String	False		Displays the period for budget. The allowed values are DAILY, UNKNOWN.
CampaignName	String	False		Campaign name. Insert limit: Up to 50 characters.
CampaignTrackId	Int64	False		Campaign ID for tracking.
ConversionOptimizerEligibility	String	False		Object is to determine if it is possible to use conversion optimizer. The allowed values are ENABLE, DISABLE, CAMPAIGN_IS_NOT_ACTIVE, NOT_CPC_CAMPAIGN, CONVERSION_TRACKING_NOT_ENABLED, NOT_ENOUGH_CONVERSIONS, UNKNOWN.
CreatedDate	Date	False		Date of Campaign made.
CustomParametersIsRemove	String	False		Delete flag. The allowed values are TRUE, FALSE, UNKNOWN.
CustomParameters	String	False		Displays the element of custom parameters.
StartDate	Date	False		Start date of Campaign. The default value in ADD operation will be Today's date. The default value in ADD operation will be Today's date. Cannot set the past date. Cannot change the date to the campaign that is already active. In YYYYMMDD format.
EndDate	Date	False		End date of Campaign. The default value in ADD operation will be 20371231. Cannot set the past date and date before the start date. In YYYYMMDD format.
FailedBiddingStrategyConfigurationBiddingSchemeBiddingStrategyType	String	False		Displays the Auto Bidding type. This field is required when Standard bidding is setting, and cannot be specified when Portfolio bidding is setting in ADD operation. It cannot be specified at the same times as biddingStrategyId. The allowed values are MANUAL_CPC, TARGET_ROAS, TARGET_SPEND, TARGET_CPA, MAXIMIZE_CONVERSIONS, TARGET_IMPRESSION_SHARE, UNKNOWN.
FailedBiddingStrategyConfigurationBiddingSchemeCpcBiddingSchemeEnhancedCpcEnabled	String	False		Specifies flag of Maximize Conversions. This field is required when Standard bidding is setting, and cannot be specified when Portfolio bidding is setting in ADD operation. It cannot be specified at the same times as biddingStrategyId. The allowed values are TRUE, FALSE, UNKNOWN. The default value is FALSE.
FailedBiddingStrategyConfigurationBiddingSchemeTargetCpaBiddingSchemeBidCeiling	Int64	False		Limit of bid (CPC). The default value will be 0. No limits if 0 is set. This field is required when BiddingStrategyType is TARGET_CPA in ADD operation. For other BiddingStrategyType, this field is optional in ADD operation.
FailedBiddingStrategyConfigurationBiddingSchemeTargetCpaBiddingSchemeBidFloor	Int64	False		Minimum CPC. The default value will be 0. No limits if 0 is set. This field is required when BiddingStrategyType is TARGET_CPA in ADD operation. For other BiddingStrategyType, this field is optional in ADD operation.
FailedBiddingStrategyConfigurationBiddingSchemeTargetCpaBiddingSchemeTargetCpa	Int64	False		Target CPA (JPY). Range limit: 0 - 99999999. This field is required when BiddingStrategyType is TARGET_CPA in ADD operation. For other BiddingStrategyType, this field is optional in ADD operation.
FailedBiddingStrategyConfigurationBiddingSchemeTargetImpressionShareSchemeBidCeiling	Int64	False		Limit of bid (CPC). The default value will be 0. No limits if 0 is set. If BiddingStrategyType is TARGET_IMPRESSION_SHARE, this field is required in ADD operation, and it is optional when BiddingStrategyType is the others.
FailedBiddingStrategyConfigurationBiddingSchemeTargetImpressionShareSchemeLocation	String	False		Specifies search result posting position to achieve the target ratio of impression share. If BiddingStrategyType is TARGET_IMPRESSION_SHARE, this field is required in ADD operation, and it is optional when BiddingStrategyType is the others. The allowed values are ANYWHERE_ON_PAGE, TOP_ON_PAGE, ABSOLUTE_TOP_OF_PAGE, UNKNOWN. The default value is ANYWHERE_ON_PAGE.
FailedBiddingStrategyConfigurationBiddingSchemeTargetImpressionShareSchemeTargetImpressionShare	Int64	False		Target impression share. If BiddingStrategyType is TARGET_IMPRESSION_SHARE, this field is required in ADD operation, and it is optional when BiddingStrategyType is the others.
FailedBiddingStrategyConfigurationBiddingSchemeTargetRoasBiddingSchemeBidCeiling	Int64	False		Limit of bid (CPC). he default value will be 0. No limits if 0 is set. This field is required when BiddingStrategyType is TARGET_ROAS in ADD operation. For other BiddingStrategyType, this field is optional in ADD operation.
FailedBiddingStrategyConfigurationBiddingSchemeTargetRoasBiddingSchemeBidFloor	Int64	False		Minimum CPC. The default value will be 0. Set 0 to deactivate. This field is required when BiddingStrategyType is TARGET_ROAS in ADD operation. For other BiddingStrategyType, this field is optional in ADD operation.
FailedBiddingStrategyConfigurationBiddingSchemeTargetRoasBiddingSchemeTargetRoas	String	False		Target ROAS (Return On Advertising Spend). Limit range: 0.01 - 1000.00 (1% - 100000%). This field is required when BiddingStrategyType is TARGET_ROAS in ADD operation. For other BiddingStrategyType, this field is optional in ADD operation.
FailedBiddingStrategyConfigurationBiddingStrategyId	Int64	False		Auto Bidding ID. This field cannot be specified when Standard bidding is setting, and is required when Portfolio bidding is setting in ADD operation. It cannot be specified at the same times as biddingScheme.
FailedBiddingStrategyConfigurationBiddingStrategyName	String	False		Auto Bidding name. Up to 50 characters.
FailedBiddingStrategyConfigurationBiddingStrategySource	String	False		A source of Auto Bidding. The allowed values are CAMPAIGN, UNKNOWN.
FailedBiddingStrategyConfigurationBiddingStrategyType	String	False		Displays the Auto Bidding type. The allowed values are MANUAL_CPC, TARGET_ROAS, TARGET_SPEND, TARGET_CPA, MAXIMIZE_CONVERSIONS, TARGET_IMPRESSION_SHARE, UNKNOWN.
FailedBiddingStrategyConfigurationMaximizeConversionsBiddingSchemeTargetCpa	Int64	False		Target CPA (JPY). Range limit: 0 - 99999999. This field is required when BiddingStrategyType is TARGET_CPA in ADD operation. For other BiddingStrategyType, this field is optional in ADD operation.
FailedBiddingStrategyConfigurationMaximizeConversionValueBiddingSchemeSchemeTargetRoas	String	False		Target ROAS (Return On Advertising Spend). Limit range: 0.01 - 1000.00 (1% - 100000%). This field is required when BiddingStrategyType is TARGET_ROAS in ADD operation. For other BiddingStrategyType, this field is optional in ADD operation.
Labels	String	False		Describes label information to be associated.
ServingStatus	String	False		displays delivery status in campaign level. The allowed values are SERVING, ENDED, PENDING, STOP, UNKNOWN.
Settings	String	False		Container for geographic targeting of campaign.
TrackingUrl	String	False		Tracking URL. Cannot set if Mobile App Campaign is in Android.
Type	String	False		the type of campaign. The allowed values are STANDARD, MOBILE_APP, DYNAMIC_ADS_FOR_SEARCH, UNKNOWN.
UrlReviewDataDisapprovalReasonCodes	String	False		Code of Disapproval reason.
UrlReviewDataDisapprovalReviewUrlParameters	String	False		Displays the element of custom parameters.
UrlReviewDataDisapprovalReviewUrlTrackingUrl	String	False		Tracking URL
UrlReviewDataInReviewUrlParameters	String	False		Displays the element of custom parameters.
UrlReviewDataInReviewUrlTrackingUrl	String	False		Tracking URL
UrlReviewDataUrlApprovalStatus	String	False		A review status of URL. The allowed values are APPROVED_WITH_REVIEW, REVIEW, DISAPPROVED, NONE, APPROVED, UNKNOWN.
UserStatus	String	False		Displays ad delivery status that can be set by an user. The allowed values are ACTIVE, PAUSED, UNKNOWN.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
ContainsLabelId	String	acquisition flag of label data The allowed values are TRUE, FALSE, UNKNOWN.
LabelId	Int64	Label ID.
MinBudgetAmount	Int64	Minimum value of the search range.
MaxBudgetAmount	Int64	Maximum value of the search range.
ReferenceNumber	String	This column will be used in Bulk operations to get specific values from the Temp tables.

SearchAdsConversionTracker

Create, Read or Update ConversionTracker information.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
ConversionTrackerId supports the '=,IN'.
AppConversionAppId supports the '=,IN'.
Category supports the '=,IN'.
ConversionCountingType supports the '=,IN'.
ConversionTrackerType supports the '=,IN'.
ExcludeFromBidding supports the '=,IN'.
Status supports the '=,IN'.
WebConversionTrackingCodeType supports the '=,IN'.
StartDate supports the '='.
EndDate supports the '='.

For example:

SELECT * FROM SearchAdsConversionTracker WHERE AccountId = '12346';

SELECT * FROM SearchAdsConversionTracker WHERE AccountId = '12346' AND ConversionTrackerId = '12323';

INSERT

Insert can be executed by specifying the AccountId, AppConversionAppConversionType, AppConversionAppPlatform, Category, ConversionTrackerName, ConversionTrackerType, Status, WebConversionMarkupLanguage and WebConversionTrackingCodeType 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 SearchAdsConversionTracker (AccountId,ConversionTrackerName,ConversionTrackerType,Category,Status,WebConversionMarkUpLanguage,WebConversionTrackingCodeType) values (1234339,'TestConversionTracker','WEB_CONVERSION','DEFAULT','ENABLED','HTML','WEBPAGE')

UPDATE

Update can be executed by specifying the AccountId, ConversionTrackerId and ConversionTrackerType in the WHERE Clause. The columns that are not read-only can be Updated. For example:

UPDATE SearchAdsConversionTracker SET ConversionTrackerName = 'UpdatingConversionTracker', ConversionTrackerType = 'WEB_CONVERSION', AllConversions = '10', AllConversionValue = '10000' WHERE AccountId = '1234339' AND ConversionTrackerId = '2375518'

Columns


Name	Type	ReadOnly	References	Description
ConversionTrackerId [KEY]	Int64	True		ConversionTracker ID. If conversionTrackerType is APP_LINK_CONVERSION, this field is required.
AccountId	Int64	False	SearchAdsAccounts.AccountId	Account ID.
AllConversions	Int64	False		Total number of conversions to be included to auto bidding and to be excluded from auto bidding.
AllConversionValue	String	False		Total value of conversions to be included to auto bidding and to be exluded from auto bidding.
AppConversionAppConversionType	String	False		Describes App conversion type. If the conversionTrackerType is APP_CONVERSION, this field will be required in ADD operation. The allowed values are DOWNLOAD, IN_APP_PURCHASE, FIRST_OPEN, UNKNOWN.
AppConversionAppId	String	False		Application ID. If the conversionTrackerType is APP_CONVERSION, this field will be required in ADD operation.
AppConversionAppPlatform	String	False		App platform. If the conversionTrackerType is APP_CONVERSION, this field will be required in ADD operation. The allowed values are ANDROID_MARKET, UNKNOWN.
AppConversionAppPostbackUrlAppPostbackUrlClearFlag	String	False		The clear flag of postback URL. The allowed values are TRUE, UNKNOWN.
AppConversionAppPostbackUrlUrl	String	False		URL
AppConversionSnippetId	Int64	False		Conversion ID.
AppConversionSnippetLabel	String	False		Conversion tracker label.
AppLinkConversionAdvancedSnippet	String	False		The new format of conversion tag avoids the impacts such as changes made to the browser.
AppLinkConversionAppEventType	String	False		Application Event Type.
AppLinkConversionAppId	String	False		Application ID.
AppLinkConversionAppLinkPlatform	String	False		Describes Application Platform. The allowed values are ANDROID, UNKNOWN.
AppLinkConversionAppVendorId	String	False		Application Vendor ID.
AppLinkConversionSnippet	String	False		Tracking script.
Category	String	False		A category for ConversionTracker. LEAD cannot be specified in SET operation. In ADD and SET operation, if the conversionTrackerType is APP_LINK_CONVERSION, there is a limit to the values that can be specified by appEventType.appEventType can be confirmed by appEvent.appEventType obtained by ConversionTrackerService/getAppEventType. In case of first_open, only DOWNLOAD can be selected. In case of in_app_purchase, only PURCHASE can be selected. In other cases, any value can be selected. The allowed values are DEFAULT, PAGE_VIEW, PURCHASE, SIGNUP, LEAD, DOWNLOAD, UNKNOWN.
ConversionCountingType	String	False		Desribes how to count conversions. The default value in ADD operation will be ONE_PER_CLICK. In ADD and SET operation, if conversionTrackerType is APP_LINK_CONVERSION and appEventType is first_open, Only ONE_PER_CLICK can be specified. AppEventType can be confirmed by appEvent.appEventType obtained by ConversionTrackerService/getAppEventType. The allowed values are ONE_PER_CLICK, MANY_PER_CLICK, UNKNOWN.
Conversions	Int64	False		Conversions which counts as included to Auto Bidding setting. CountingType specifies whether one-per-click or many-per-click.
ConversionTrackerName	String	False		ConversionTracker Name.
ConversionTrackerTrackId	Int64	False		ConversionTracker ID for tracking.
ConversionTrackerType	String	False		Describes conversion type. The allowed values are WEB_CONVERSION, APP_CONVERSION, APP_LINK_CONVERSION, UNKNOWN.
ConversionValue	String	False		Conversion value to be included to auto bidding.
ExcludeFromBidding	String	False		Describes whether exclude the data for Auto Bidding setting or not. The allowed values are TRUE, FALSE, UNKNOWN. The default value is FALSE.
MeasurementPeriod	Int64	False		Counting period of conversoins (days). It is available between 7 to 90 days. For Mobile App Download, this period is fixed as 30 days. This field is optional in ADD and SET operation. The default value in ADD operation will be 30. In ADD and SET operation, if conversionTrackerType is APP_LINK_CONVERSION and appEventType is first_open, Only 30 can be specified. AppEventType can be confirmed by appEvent.appEventType obtained by ConversionTrackerService/getAppEventType.
MostRecentConversionDate	Date	False		The most latest date when conversion occured.
Status	String	False		It shows ConversionTracker status. The allowed values are ENABLED, DISABLED, UNKNOWN.
UserRevenueValue	String	False		The value of revenue of the conversion tracker specified by user. When the sales revenue of 1 conversion is fixed value, you are able to review the total sales on reports by specifying the amount on this item. If it is not specified on ADD request, the value 0 is set. This field is optional in ADD and SET operation. In ADD and SET operation, if conversionTrackerType is APP_LINK_CONVERSION and appEventType is in_app_purchase, it will be ignored even if specified. AppEventType can be confirmed by appEvent. AppEventType obtained by ConversionTrackerService/getAppEventType.
WebConversionAdvancedSnippet	String	False		The new format of conversion tag avoids the impacts such as changes made to the browser. If the conversionTrackerType is WEB_CONVERSION, this field will be required in ADD operation.
WebConversionMarkupLanguage	String	False		ConversionTrackerServiceMarkupLanguage shows ConversionTrackerServiceMarkupLanguage for Snipet. If the conversionTrackerType is WEB_CONVERSION, this field will be required in ADD operation. The allowed values are HTML, CHTML, XHTML, WML, UNKNOWN.
WebConversionSnippet	String	False		Tracking script. If the conversionTrackerType is WEB_CONVERSION, this field will be required in ADD operation.
WebConversionTrackingCodeType	String	False		ConversionTrackerServiceTrackingCodeType describes tracking type of web page. If the conversionTrackerType is WEB_CONVERSION, this field will be required in ADD operation. The allowed values are WEBPAGE, CLICK_TO_CALL, IMPORT, UNKNOWN.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
StartDate	Date	Conversion performance aggregation period start
EndDate	Date	Conversion performance aggregation period end.
ReferenceNumber	String	This column will be used in Bulk operations to get specific values from the Temp tables.

SearchAdsFeeds

Create, Read, Update or Delete the Feed (Data auto insertion) information.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
FeedId supports the '=,IN'.
PlaceholderType supports the '=,IN'.

For example, the following queries are processed server side:

SELECT * FROM SearchAdsFeeds WHERE AccountId = '1234339' AND FeedId = '174849'

INSERT

Insert can be executed by specifying the AccountName, FeedName and PlaceholderType 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 SearchAdsFeedServiceFeedAttributes#TEMP (FeedAttributeName,PlaceholderField) VALUES ('InsertingFeedAttribute',AD_CUSTOMIZER_INTEGER)
INSERT INTO SearchAdsFeeds (AccountId,FeedName,FeedAttribute,PlaceholderType) values (1234339,'InsertingFeed','SearchAdsFeedServiceFeedAttributes#TEMP','AD_CUSTOMIZER')

UPDATE

Update can be executed by specifying the AccountId and FeedId in the WHERE Clause. The columns that are not read-only can be Updated. For example:

INSERT INTO SearchAdsFeedServiceFeedAttributes#TEMP (FeedAttributeName,PlaceholderField) VALUES ('UpdateFeedAttribute','AD_CUSTOMIZER_PRICE')
UPDATE SearchAdsFeeds SET FeedName = 'NewFeed', FeedAttribute = 'SearchAdsFeedServiceFeedAttributes#TEMP', PlaceholderType = 'DYNAMIC_AD_FOR_SEARCH_PAGE_FEEDS' WHERE AccountId = '1234339' AND FeedId = '174849'

DELETE

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

DELETE FROM SearchAdsFeeds WHERE AccountId = '1234339' AND FeedId = '174849'

Columns


Name	Type	ReadOnly	References	Description
FeedId [KEY]	Int64	True		Feed ID.
AccountId	Int64	True	SearchAdsAccounts.AccountId	Account ID. Not required by design change on editorials.
Domain	String	False		Domain.
FeedAttribute	String	False		FeedServiceAttribute object contains the attribute of auto data insertion list.
FeedName	String	False		List name of Feed.
FeedTrackId	Int64	False		Tracking ID of Feed.
PlaceholderType	String	False		FeedServicePlaceholderType (enum) object select the type of Feed Item information. The allowed values are AD_CUSTOMIZER, DYNAMIC_AD_FOR_SEARCH_PAGE_FEEDS, UNKNOWN.

SearchAdsLabels

Create, Read, Update or Delete information of label.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
LabelId supports the '=,IN'.
CountLabeledEntity supports the '='.

For example:

SELECT * FROM SearchAdsLabels WHERE AccountId = '12346'

SELECT * FROM SearchAdsLabels WHERE AccountId = '12346' AND LabelId = '26894'

INSERT

Insert can be executed by specifying the AccountId and LabelName 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 SearchAdsLabels (AccountId,LabelName) VALUES ('12346','Lable1')

UPDATE

Update can be executed by specifying the AccountId and LabelId in the WHERE Clause. The columns that are not read-only can be Updated. For example:

UPDATE SearchAdsLabels SET Color = '#0000FF', LabeledAdGroupCriterion = '1' WHERE AccountId = '1234' AND LabelId = '4598723';

DELETE

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

DELETE FROM SearchAdsLabels WHERE AccountId = '1234' AND LabelId = '15684'

Columns


Name	Type	ReadOnly	References	Description
LabelId [KEY]	Int64	True		Label ID.
AccountId	Int64	True	SearchAdsAccounts.AccountId	Account ID.
Color	String	False		Color code.e.g #FFFFFF
Description	String	False		Description.
LabeledAdGroup	Int64	False		Number of labeled AdGroup.
LabeledAdGroupAd	Int64	False		Number of labeled AdGroupAd.
LabeledAdGroupCriterion	Int64	False		Number of labeled Ad Group Criterion.
LabeledCampaign	Int64	False		Number of labeled Campaign.
LabelName	String	False		Label Name.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
CountLabeledEntity	String	Setting of Label number count flag.

SearchAdsReports

Create, Read or Delete a report.

Table Specific Information

Select

The Sync App will use the Yahoo! Ads API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App. Note: AccountId is required for Select on this table

AccountId supports the '='.
ReportJobId supports the '=,IN'.
ReportJobStatus supports the '=,IN'.
ReportType supports the '=,IN'.

For example:

SELECT * FROM SearchAdsReports WHERE AccountId = '125466'

INSERT

Insert can be executed by specifying the AccountId, Fields, ReportDateRangeType, ReportName and ReportType 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 SearchAdsReports (AccountId,Fields,ReportDateRangeType,ReportName,ReportType) VALUES ('1234339','ACCOUNT_ID,ACCOUNT_NAME,COST,CLICKS,CLICK_RATE','TODAY','MyAccountReport','ACCOUNT')

DELETE

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

DELETE FROM SearchAdsReports WHERE AccountId = '1234' AND ReportJobId = '89756'

Columns


Name	Type	ReadOnly	References	Description
ReportJobId [KEY]	String	True		Report Job ID.
AccountId	Int64	True	SearchAdsAccounts.AccountId	Account ID.
CompleteTime	Datetime	False		Completion time of Report Job request
DateRangeStartDate	Date	False		Start date.
DateRangeEndDate	Date	False		End date.
Fields	String	False		Item name of the report.
Filters	String	False		Object displays filtering report conditions.
ReportCompressType	String	False		Displays if defined download report is compressed. The allowed values are NONE, ZIP, UNKNOWN.
ReportDateRangeType	String	False		Displays a date range of the report. The allowed values are TODAY, YESTERDAY, LAST_7_DAYS, LAST_WEEK, LAST_14_DAYS, LAST_30_DAYS, LAST_BUSINESS_WEEK, THIS_MONTH, LAST_MONTH, ALL_TIME, CUSTOM_DATE, UNKNOWN.
ReportDownloadEncode	String	False		Displays a character code of the report. The allowed values are UTF8, SJIS, EUC, UTF16LE, UNKNOWN.
ReportDownloadFormat	String	False		Displays a file format of the report. The allowed values are CSV, XML, TSV, UNKNOWN.
ReportIncludeDeleted	String	False		Describes whether to output deleted items on the report or not. The allowed values are TRUE, FALSE, UNKNOWN.
ReportIncludeZeroImpressions	String	False		Describes whether including 0 impression line in the report or not. The allowed values are TRUE, FALSE, UNKNOWN.
ReportJobErrorDetail	String	False		Error details of Report Job.
ReportJobStatus	String	False		A status of the requested report. The allowed values are WAIT, COMPLETED, IN_PROGRESS, FAILED, UNKNOWN.
ReportLanguage	String	False		A language selection for report definition. The allowed values are JA, EN, UNKNOWN.
ReportName	String	False		Name of the report.
ReportType	String	False		Displays a type of available report. The allowed values are ACCOUNT, CAMPAIGN, ADGROUP, AD, KEYWORDS, SEARCH_QUERY, GEO, FEED_ITEM, GEO_TARGET, SCHEDULE_TARGET, BID_STRATEGY, AD_CUSTOMIZERS, TARGET_LIST, LANDING_PAGE_URL, KEYWORDLESSS_QUERY, WEBPAGE_CRITERION, UNKNOWN.
RequestTime	Datetime	False		Start time of Report Job request.
SortFields	String	False		Describes sort details of report definition.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
ReferenceNumber	String	This column will be used in Bulk operations to get specific values from the Temp tables.

SearchAdsRetargetingLists

Create, Read or Update the target list information.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
TargetListId supports the '=,IN'.
TargetListOwner supports the '='.
TargetListType supports the '=,IN'.

For example:

SELECT * FROM SearchAdsRetargetingLists WHERE AccountId = '125466'

SELECT * FROM SearchAdsRetargetingLists WHERE AccountId = '125466' AND TargetListId = '234234'

INSERT

Insert can be executed by specifying the AccountId, LogicalTargetListLogicalGroup, RuleBaseTargetListIsAllVisitorRule, TargetListName and TargetListType 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 SearchAdsRetargetingListRuleBaseTargetListRuleRuleItems#TEMP (RuleOperator,RuleType,UrlRuleItemUrlRuleKey,Value) VALUES ('EQUALS','URL_RULE','URL','bestcampaign.com')
INSERT INTO SearchAdsRetargetingListRuleBaseTargetListRules#TEMP (RuleItems) VALUES ('SearchAdsRetargetingListRuleBaseTargetListRuleRuleItems#TEMP')
INSERT INTO SearchAdsRetargetingLists (AccountId,TargetListName,TargetListType,RuleBaseTargetListIsAllVisitorRule,RuleBaseTargetListIsDateSpecificRule,RuleBaseTargetListRules) values (1234339,'RuleBaseRetargetingList','RULE','TRUE','FALSE','SearchAdsRetargetingListRuleBaseTargetListRules#TEMP')

UPDATE

Update can be executed by specifying the AccountId, TargetListId, LogicalTargetListLogicalGroup, RuleBaseTargetListIsAllVisitorRule and TargetListType in the WHERE Clause. The columns that are not read-only can be Updated. For example:

INSERT INTO SearchAdsRetargetingListRuleBaseTargetListRuleRuleItems#TEMP (RuleOperator,RuleType,UrlRuleItemUrlRuleKey,Value) VALUES ('NOT_EQUAL','URL_RULE','REFFER_URL','badcampaign.com')
INSERT INTO SearchAdsRetargetingListRuleBaseTargetListRules#TEMP (RuleItems) VALUES ('SearchAdsRetargetingListRuleBaseTargetListRuleRuleItems#TEMP')
UPDATE SearchAdsRetargetingLists SET TargetListName = 'UpdateRetargetingList', TargetListType = 'RULE', RuleBaseTargetListIsAllVisitorRule = 'TRUE', RuleBaseTargetListIsDateSpecificRule = 'FALSE', RuleBaseTargetListRules = 'SearchAdsRetargetingListRuleBaseTargetListRules#TEMP' WHERE AccountId = '1234339' AND TargetListId = '634293'

Columns


Name	Type	ReadOnly	References	Description
TargetListId [KEY]	Int64	True		Target List ID.
AccountId	Int64	True	SearchAdsAccounts.AccountId	Account ID.
ClosingReason	String	False		The reason for closing. The allowed values are UNUSED_LIST, UNKNOWN.
DefaultTargetListTagAdvancedSnippet	String	False		The new format of site retargeting tag avoids the impacts such as changes made to the browser.
DefaultTargetListTagSnippet	String	False		Site Retargeting.
LogicalTargetListLogicalGroup	String	False		An object that holds combination group information.
Reach	Int64	False		Number of users stored to the list.
ReachStorageSpan	Int64	False		Days to hold Cookie. Default:180
ReachStorageStatus	String	False		The flag status to store Cookie reach. The allowed values are OPEN, CLOSED, UNKNOWN.
RetargetingAccountStatusAgreeDate	Date	False		Agreement date.
RetargetingAccountStatusReviewRequestDate	Date	False		Re-examination review request date.
RetargetingAccountStatusReviewStatus	String	False		The review status of target list. The allowed values are APPROVED, DISAPPROVED, DISAPPROVED_WITH_REVIEW, UNKNOWN.
RuleBaseTargetListStartDate	Date	False		Start date of rule setting in
RuleBaseTargetListEndDate	Date	False		End date of rule setting in
RuleBaseTargetListIsAllVisitorRule	String	False		The rule of visitors. The allowed values are TRUE, FALSE, UNKNOWN.
RuleBaseTargetListIsDateSpecificRule	String	False		The rule with deadline. The allowed values are TRUE, FALSE, UNKNOWN.
RuleBaseTargetListRules	String	False		An object that holds grouped URL/LABEL rules.
TargetListDescription	String	False		Description of Target List.
TargetListName	String	False		Target List name.
TargetListOwner	String	False		Describes the owner information of the target list. The allowed values are ONWER, SHARED, UNKNOWN.
TargetListTrackId	Int64	False		Tracking ID of Target list.
TargetListType	String	False		The type of target list. The allowed values are DEFAULT, RULE, LOGICAL, UNKNOWN.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
ReferenceNumber	String	This column will be used in Bulk operations to get specific values from the Temp tables.

SharedCriteria

Create, Read or delete negative keyword to negative keyword list.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
CriterionId supports the '=,IN'.
SharedListId supports the '=,IN'.

For example, the following queries are processed server side:

SELECT * FROM SharedCriteria WHERE AccountId = '1234339' AND CriterionId = '14761881'

INSERT

Insert can be executed by specifying the AccountId,SharedListId,KeywordMatchType,Text 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 SharedCriteria (AccountId,SharedListId,KeywordMatchType,Text) VALUES (1234339,'25648','EXACT','Test Keyword')

DELETE

Delete can be executed by specifying the AccountId,SharedListId in the WHERE Clause. For example:

DELETE FROM SharedCriteria WHERE AccountId = '1234339' AND CriterionId = '14761881' AND SharedListId = '25648'

Columns


Name	Type	ReadOnly	References	Description
CriterionId [KEY]	Int64	True		Criterion ID.
AccountId	Int64	True	SearchAdsAccounts.AccountId	Account ID.
SharedListId	Int64	True		Account shared list ID.
KeywordMatchType	String	False		Describes keyword match type. The allowed values are EXACT, PHRASE, BROAD, UNKNOWN.
Text	String	False		Keyword.
Use	String	False		Describes keyword type. The allowed values are NEGATIVE, UNKNOWN.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
ReferenceNumber	String	This column will be used in Bulk operations to get specific values from the Temp tables.

Views

Views are composed of columns and pseudo columns. Views are similar to tables in the way that data is represented; however, views do not support updates. Entities that are represented as views are typically read-only entities. Often, a stored procedure is available to update the data if such functionality is applicable to the data source.

Queries can be executed against a view as if it were a normal table, and the data that comes back is similar in that regard.

Dynamic views, such as queries exposed as views, and views for looking up specific combinations of project_team work items are supported.

Yahoo! Ads Connector for CData Sync Views


Name	Description
AdGroupCriteriaLabels	Retrieve the details of AdGroupCriteria Labels.The columns values set read-only false can be inserted in the parent table using Temp tables
AdGroupFeedServiceAdGroupFeeds	Retrieve the details of AdGroupFeedService AdGroupFeeds.The columns values set read-only false can be inserted in the parent table using Temp tables
AdGroupWebpageParameterConditions	Retrieve the details of AdGroupWebpage WebpageParameterConditions.The columns values set read-only false can be inserted in the parent table using Temp tables
AppEventTracker	Get AppEventType informations.
ApplinkVendors	Get App measurement vendor information list.
AssetDataCallAssetSchedules	Asset value information for phone number options.
AssetDataCallOutAssetSchedules	Asset value information for callout options.
AssetDataQuickLinkAssetSchedules	Asset value information for quicklink options.
CampaignFeedServiceCampaignFeeds	Retrieves the details of CampaignFeed Service Campaigns Feeds.The columns values set read-only false can be inserted in the parent table using Temp tables
CampaignWebpageParameterConditions	Retrieves the details of CampaignWebpage WebpageParameterConditions.The columns values set read-only false can be inserted in the parent table using Temp tables
CustomKeys	Get custom key information
KeywordForecastMetrics	Get performance information of keywords.
KeywordPlanIdeas	Suggests new related keywords based on the specified value.
OfflineConversions	Get registered offline conversion data information.
PageFeedAsset	Getpage feed asset, upload or bulk download.
PageFeedAssetReviewSummary	Gets registered approval records of page feed asset and summary of each status.
PageFeedAssetServiceAddDownloadJob	displays content of page feed asset for download collectively.
PageFeedAssetServiceDownloadJob	Gets processing status about upload or download.
PageFeedAssetServiceUploadJob	Gets processing status about upload or download.
PageFeedItemJobStatus	Gets processing status about upload or download.
PageFeedItemReviewSummary	Gets registered approval records of page feed item and summary of each status.
PageFeedItems	Get information related to page feed item.
SearchAdsAccountLinks	Get account link information.
SearchAdsAdGroupAdAdditionalAdvancedMobileUrls	Retrieve the details of AdGroupAd AdditionalAdvancedMobileUrls.The columns values set read-only false can be inserted in the parent table using Temp tables
SearchAdsAdGroupAdAdditionalAdvancedUrls	Retrieve details of AdGroupAd AdditionalAdvancedUrls.The columns values set read-only false can be inserted in the parent table using Temp tables
SearchAdsAdGroupAdAdResponsiveSearchAdDescriptions	Retrieve the details for AdGroupAd ResponsiveSearchAd Descriptions.The columns values set read-only false can be inserted in the parent table using Temp tables
SearchAdsAdGroupAdAdResponsiveSearchAdHeadlines	Retrieve the details of AdGroupAd ReponsiveSearchAd Headlines.The columns values set read-only false can be inserted in the parent table using Temp tables
SearchAdsAdGroupAdServiceLabels	Retrieve the details of AdGroupAd Labels. The columns values set read-only false can be inserted in the parent table using Temp tables.
SearchAdsAdGroupServiceLabels	Retrieve the details of AdGroup Labels
SearchAdsAuditLogEventSelector	Retrieve the details of AuditLog EventSelector.The columns values set read-only false can be inserted in the parent table using Temp tables
SearchAdsBalance	Get the account balance.
SearchAdsCampaignServiceLabels	Retrieve the details of Campaign Labels.The columns values set read-only false can be inserted in the parent table using Temp tables
SearchAdsCampaignSettings	Retrive the details of campaign settings.The columns values set read-only false can be inserted in the parent table using Temp tables
SearchAdsDisapprovalReasons	Get EditorialReason and recommended resolution list.
SearchAdsFeedItemSchedulingSchedules	Retrieves the details of FeedItem Scheduling Schedules.The columns values set read-only false can be inserted in the parent table using Temp tables
SearchAdsFeedItemServiceFeedItemAttributes	Retrieves the details of FeedItem FeedItemAttribute.The columns values set read-only false can be inserted in the parent table using Temp tables
SearchAdsFeedItemServiceFeedItemAttributeValues	Retrieves the details of FeedItem FeedItemAttribute feedAttributeValues.The columns values set read-only false can be inserted in the parent table using Temp tables
SearchAdsFeedServiceFeedAttributes	Retrieves the details of Feed FeedAttributes.The columns values set read-only false can be inserted in the parent table using Temp tables
SearchAdsGeographicLocations	Get the information list of geo targeting.
SearchAdsReportFields	Returns the available report fields for a given report type.The columns values set read-only false can be inserted in the parent table using Temp tables
SearchAdsReportFilters	Retrieves the details of Report Filters.The columns values set read-only false can be inserted in the parent table using Temp tables
SearchAdsReportSortFields	Retrieve the sort details of report definition.The columns values set read-only false can be inserted in the parent table using Temp tables
SearchAdsRetargetingListLogicalGroupLogicalOperand	Retrieve the details of RetargetingList LogicalTargetList LogicalGroup LogicalOperand.The columns values set read-only false can be inserted in the parent table using Temp tables
SearchAdsRetargetingListLogicalGroups	Retrieve the details of RetargetingList LogicalTargetList LogicalGroup.The columns values set read-only false can be inserted in the parent table using Temp tables
SearchAdsRetargetingListRuleBaseTargetListRuleRuleItems	Retrieves the details of RetargetingList RuleBaseTargetList Rule RuleItems.The columns values set read-only false can be inserted in the parent table using Temp tables
SearchAdsRetargetingListRuleBaseTargetListRules	Retrieves the details of RetargetingList RuleBaseTargetList Rules.The columns values set read-only false can be inserted in the parent table using Temp tables

AdGroupCriteriaLabels

Retrieve the details of AdGroupCriteria Labels.The columns values set read-only false can be inserted in the parent table using Temp tables

Table Specific Information

Select

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

AccountId supports the '='.
AdGroupId supports the '=,IN'.
CriterionCriterionId supports the '=,IN'.
ApprovalStatus supports the '=,IN'.
CampaignId supports the '=,IN'.
KeywordMatchType supports the '='.
CriterionKeywordText supports the '='.
BiddingStrategyId supports the '=,IN'.
ContainsLabelId supports the '='.
LabelIds supports the '=,IN'.
UserStatus supports the '=,IN'.
Usesupports the '='.
Min supports the '='.
Max supports the '='.

For example:

SELECT * FROM AdGroupCriteriaLabels WHERE AccountId = '1234339' AND USE = 'BIDDABLE'

SELECT * FROM AdGroupCriteriaLabels WHERE AccountId = '1234339' AND USE = 'BIDDABLE' AND AdGroupId = '303252478'

Columns


Name	Type	References	Description
LabelId [KEY]	Int64		Label ID.
CriterionId	Long		Criterion ID.
AccountId	Int64	SearchAdsAccounts.AccountId	Account ID.
AdGroupId	Int64	SearchAdsAdGroups.AdGroupId	Ad group ID.
ApprovalStatus	String		Displays Editorial Status. The allowed values are APPROVED, APPROVED_WITH_REVIEW, REVIEW, PRE_DISAPPROVED, POST_DISAPPROVED, UNKNOWN.
UserStatus	String		Displays ad delivery status that can be set by an user. The allowed values are ACTIVE, PAUSED, UNKNOWN.
CampaignId	Int64	SearchAdsCampaigns.CampaignId	Campaign ID.
KeywordMatchType	String		Describes keyword match type. The allowed values are EXACT, PHRASE, BROAD, UNKNOWN.
KeywordText	String		AdGroupCriterionServiceKeyword element.Maximum of 80 letters, 10 words.
Color	String		Color.
Description	String		Description.
LabelName	String		Label name.
Use	String		Describes criterion to be selected. The allowed values are BIDDABLE, NEGATIVE, UNKNOWN.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
BiddingStrategyId	Int64		Auto bidding ID.
ContainsLabelId	String		Describes acquisition flag of label data. The allowed values are TRUE, FALSE, UNKNOWN.
LabelIds	Int64		Label ID.
Min	Int64		Minimum value of the search range.
Max	Int64		Maximum value of the search range..

AdGroupFeedServiceAdGroupFeeds

Retrieve the details of AdGroupFeedService AdGroupFeeds.The columns values set read-only false can be inserted in the parent table using Temp tables

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
AdGroupId supports the '=,IN'.
CampaignId supports the '=,IN'.
PlaceholderType supports the '=,IN'.
FeedItemId supports the '=,IN'.

For example:

SELECT * FROM AdGroupFeedServiceAdGroupFeeds WHERE AccountId = '1234339'

SELECT * FROM AdGroupFeedServiceAdGroupFeeds WHERE AccountId = '1234339' AND AdGroupId = '303282282'

SELECT * FROM AdGroupFeedServiceAdGroupFeeds WHERE AccountId = '1234339' AND CampaignId = '1767536'

Columns


Name	Type	References	Description
FeedItemId	Int64	FeedItems.FeedItemId	FeedItem information ID.
AccountId	Int64	SearchAdsAccounts.AccountId	Account ID.
AdGroupId	Int64		Ad group ID.
CampaignId	Int64	SearchAdsCampaigns.CampaignId	Campaign ID.
PlaceholderType	String		The type of FeedItem information. The allowed values are QUICKLINK, CALLEXTENSION, CALLOUT, STRUCTURED_SNIPPET, UNKNOWN.

AdGroupWebpageParameterConditions

Retrieve the details of AdGroupWebpage WebpageParameterConditions.The columns values set read-only false can be inserted in the parent table using Temp tables

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
AdGroupId supports the '=,IN'.
WebpageTargetId supports the '=,IN'.
CampaignId supports the '=,IN'.

For example:

SELECT * FROM AdGroupWebpageParameterConditions WHERE AccountId = '25687'

SELECT * FROM AdGroupWebpageParameterConditions WHERE AccountId = '25687' AND AdGroupId IN ('89756')	

SELECT * FROM AdGroupWebpageParameterConditions WHERE AccountId = '25687' AND TargetId IN ('89756')

SELECT * FROM AdGroupWebpageParameterConditions WHERE AccountId = '25687' AND CampaignId IN ('78962')

Columns


Name	Type	References	Description
TargetId	Int64		Unique ID for each identify webpage.
AccountId	Int64	SearchAdsAccounts.AccountId	Account ID.
AdGroupId	Int64	SearchAdsAdGroups.AdGroupId	Ad Group ID.
Argument	String		Value of rule setting. If type is 'ALL_PAGES', this field is optional in ADD operation.
Operator	String		A condition type of URL. This field can be specified only if the webpageConditionType is URL. If you specified EQUALS in operator, you can specify only one value in condition. The allowed values are CONTAINS, EQUALS, UNKNOWN.
WebpageConditionType	String		Rule type of web page. The allowed values are PAGE_CONTENT, CUSTOM_LABEL, ALL_PAGES, URL, PAGE_TITLE, UNKNOWN.
CampaignId	Int64		Campaign ID.

AppEventTracker

Get AppEventType informations.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.

For example:

SELECT * FROM AppEventTracker WHERE  AccountId='1234339';

Columns


Name	Type	References	Description
AppId [KEY]	String		Application ID.
AppVendorId	String	ApplinkVendors.AppVendorId	Application Vendor ID.
AppEventType	String		Application Event Type.
AppLinkPlatform	String		Describes Application Platform. The allowed values are ANDROID, UNKNOWN.
ConversionTrackerTrackId	Int64		ConversionTracker ID for tracking.
AccountId	Int64		Account ID.

ApplinkVendors

Get App measurement vendor information list.

Table Specific Information

Select

The driver does not support filters on the server side. The rest of the filters are processed on the client side. For example:

SELECT * FROM ApplinkVendors

Columns


Name	Type	References	Description
AppVendorId [KEY]	String		App Vendor ID.
AppVendorNameEn	String		App Vendor Name in English.
AppVendorNameJa	String		App Vendor Name in Japanese.

AssetDataCallAssetSchedules

Asset value information for phone number options.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
ApprovalStatus supports the '=,IN'.
AssetId supports the '=,IN'.

For example:

SELECT * FROM AssetDataCallAssetSchedules
SELECT * FROM AssetDataCallAssetSchedules WHERE AccountId='1234339'
SELECT * FROM AssetDataCallAssetSchedules WHERE AccountId='1234339' AND ApprovalStatus='APPROVED'
SELECT * FROM AssetDataCallAssetSchedules WHERE AccountId='1234339' AND ApprovalStatus='APPROVED' AND AssetId='3460269'

Columns


Name	Type	References	Description
AccountId	Int64	SearchAdsAccounts.AccountId	Account ID.
AssetId	Int64		Asset ID.
DayOfWeek	String		A day of the week.
EndHour	Int64		End time in hour.
EndMinute	String		Minutes of an hour. Only supported for: 0, 15, 30, and 45 minutes past the hour.
StartHour	Int64		Start time in hour.
StartMinute	String		Minutes of an hour. Only supported for: 0, 15, 30, and 45 minutes past the hour.

AssetDataCallOutAssetSchedules

Asset value information for callout options.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
ApprovalStatus supports the '=,IN'.
AssetId supports the '=,IN'.

For example:

SELECT * FROM AssetDataCallOutAssetSchedules
SELECT * FROM AssetDataCallOutAssetSchedules WHERE AccountId='1234339'
SELECT * FROM AssetDataCallOutAssetSchedules WHERE AccountId='1234339' AND ApprovalStatus='APPROVED'
SELECT * FROM AssetDataCallOutAssetSchedules WHERE AccountId='1234339' AND ApprovalStatus='APPROVED' AND AssetId='3460269'

Columns


Name	Type	References	Description
AccountId	Int64	SearchAdsAccounts.AccountId	Account ID.
AssetId	Int64		Asset ID.
DayOfWeek	String		A day of the week.
EndHour	Int64		End time in hour.
EndMinute	String		Minutes of an hour. Only supported for: 0, 15, 30, and 45 minutes past the hour.
StartHour	Int64		Start time in hour.
StartMinute	String		Minutes of an hour. Only supported for: 0, 15, 30, and 45 minutes past the hour.

AssetDataQuickLinkAssetSchedules

Asset value information for quicklink options.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
ApprovalStatus supports the '=,IN'.
AssetId supports the '=,IN'.

For example:

SELECT * FROM AssetDataQuickLinkAssetSchedules
SELECT * FROM AssetDataQuickLinkAssetSchedules WHERE AccountId='1234339'
SELECT * FROM AssetDataQuickLinkAssetSchedules WHERE AccountId='1234339' AND ApprovalStatus='APPROVED'
SELECT * FROM AssetDataQuickLinkAssetSchedules WHERE AccountId='1234339' AND ApprovalStatus='APPROVED' AND AssetId='3460269'

Columns


Name	Type	References	Description
AccountId	Int64	SearchAdsAccounts.AccountId	Account ID.
AssetId	Int64		Asset ID.
DayOfWeek	String		A day of the week.
EndHour	Int64		End time in hour.
EndMinute	String		Minutes of an hour. Only supported for: 0, 15, 30, and 45 minutes past the hour.
StartHour	Int64		Start time in hour.
StartMinute	String		Minutes of an hour. Only supported for: 0, 15, 30, and 45 minutes past the hour.

CampaignFeedServiceCampaignFeeds

Retrieves the details of CampaignFeed Service Campaigns Feeds.The columns values set read-only false can be inserted in the parent table using Temp tables

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
FeedItemId supports the '=,IN'.
CampaignId supports the '=,IN'.
PlaceholderType supports the '=,IN'.

For example, the following queries are processed server side:

SELECT * FROM CampaignFeedServiceCampaignFeeds WHERE AccountId = '1234339'

SELECT * FROM CampaignFeedServiceCampaignFeeds WHERE AccountId = '1234339' AND FeedItemId = '123456'

SELECT * FROM CampaignFeedServiceCampaignFeeds WHERE AccountId = '1234339' AND CampaignId = '53478'

Columns


Name	Type	References	Description
AccountId	Int64	SearchAdsAccounts.AccountId	Account ID.
CampaignId	Int64		Campaign ID.
FeedItemId	Int64		FeedItem information ID.
PlaceholderType	String		The type of FeedItem information. In SET operation, this field will be ignored under (campaignFeed), and this field is required under (campaignFeedList). The allowed values are QUICKLINK, CALLEXTENSION, CALLOUT, STRUCTURED_SNIPPET, UNKNOWN.

CampaignWebpageParameterConditions

Retrieves the details of CampaignWebpage WebpageParameterConditions.The columns values set read-only false can be inserted in the parent table using Temp tables

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
CampaignId supports the '=,IN'.
TargetId supports the '=,IN'.

For example:

SELECT * FROM CampaignWebpageParameterConditions WHERE AccountId = '25687'

SELECT * FROM CampaignWebpageParameterConditions WHERE AccountId = '25687' AND CampaignId IN ('456971')

SELECT * FROM CampaignWebpageParameterConditions WHERE AccountId = '25687' AND TargetId IN('8520')

Columns


Name	Type	References	Description
WebpageTargetId	Int64		Unique ID for each webpage.
AccountId	Int64	SearchAdsAccounts.AccountId	Account ID.
CampaignId	Int64	SearchAdsCampaigns.CampaignId	Campaign ID.
Argument	String		Value of rule setting.
Operator	String		A condition type of URL. This field can be specified only if the type is URL. If you specified EQUALS in operator, you can specify only one value in condition. The allowed values are CONTAINS, EQUALS, UNKNOWN.
Type	String		Rule type of web page. The allowed values are URL, PAGE_TITLE, PAGE_CONTENT, CUSTOM_LABEL, ALL_PAGES, UNKNOWN.

CustomKeys

Get custom key information

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
TargetListOwner supports the '='.

For example:

SELECT * FROM CustomKeys WHERE AccountId='1234339'

SELECT * FROM CustomKeys WHERE AccountId='1234339' AND TargetListOwner='OWNER'

Columns


Name	Type	References	Description
AccountId	Int64	SearchAdsAccounts.AccountId	Account ID.
TextKey	String		Evaluation items.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
TargetListOwner	String		Describes the owner information of the target list. The allowed values are OWNER, SHARED, UNKNOWN.

KeywordForecastMetrics

Get performance information of keywords.

Table Specific Information

Select

The Sync App will use the Yahoo! Ads API to process WHERE clause conditions built with the following column and operator. The AccountId,DateInterval,MaxCpc,KeywordPlanAdGroupKeywordText and KeywordPlanAdGroupKeywordMatchType is required to make a request and the rest of the filter is executed client-side within the Sync App.

AccountId supports the '='.
DateInterval supports the '='.
StartDate supports the '='.
EndDate supports the '='.
KeywordPlanNetwork supports the '='.
MaxCpc supports the '='.
GeoTargets supports the '=,IN'.
KeywordPlanAdGroupMaxCpc supports the '='.
KeywordPlanAdGroupKeywords supports the '=,IN'.

For example:

SELECT * FROM KeywordForecastMetrics WHERE AccountId = '1234339' AND DateInterval = 'NEXT_QUARTER' AND MaxCpc = '1' AND KeywordPlanAdGroupKeywordText = 'test' AND KeywordPlanAdGroupKeywordMatchType = 'EXACT'

Columns


Name	Type	References	Description
AverageCpc	String		Average CPC.
Clicks	String		Number of click.
Cost	String		Cost.
Ctr	String		Click rate.
Impressions	String		Number of impression.
Keyword	String		Keywords.
AccountId	Int64		Account ID.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
DateInterval	String		Describes the forecast period. startDate and endDate is required if CUSTOM_DATE is specified. The allowed values are NEXT_WEEK, NEXT_MONTH, NEXT_QUARTER, CUSTOM_DATE, UNKNOWN.
StartDate	Date		Start date specified when dateInterval is CUSTOM_DATE. Must be earlier than the current date and less than a year old.
EndDate	Date		End date specified when dateInterval is CUSTOM_DATE. Must be earlier than the current date and less than a year old.
KeywordPlanNetwork	String		Describes the forecast target. The allowed values are YAHOO_SEARCH, SEARCH_NETWORK, UNKNOWN. The default value is YAHOO_SEARCH.
Cpc	String		Maximum CPC.
GeoTargets	String		Area information.
KeywordPlanAdGroupMCpc	String		Maximum CPC.
KeywordPlanAdGroupKeywords	String		A container for the keywords to estimate. Use this attribute to send the keywordPlanAdGroupKeywords columns using a TEMP table or JSON
KeywordPlanAdGroupKeywordText	String		Keyword.
KeywordPlanAdGroupKeywordMatchType	String		Describes keyword match type. The allowed values are EXACT, PHRASE, BROAD, UNKNOWN.
KeywordPlanAdGroupKeywordCpc	String		Maximum CPC. When isNegative is TRUE, maxCPC cannot be specified.
KeywordPlanAdGroupKeywordIsNegative	String		Refine keyword. The default value will be FALSE. Cannot request with only refine keyword.

KeywordPlanIdeas

Suggests new related keywords based on the specified value.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
KeywordAndUrlSeedKeywords supports the '=,IN'.
KeywordAndUrlSeedUrl supports the '='.
KeywordSeedKeywords supports the '=,IN'.
UrlSeedUrl supports the '='.
SiteSeedSite supports the '='.
SeedType supports the '='.

For example:

SELECT * FROM KeywordPlanIdeas WHERE AccountId = '1234339' AND SeedType = 'SITE' AND SiteSeedSite = 'https://cdata.com/'

Columns


Name	Type	References	Description
Text	String		Keyword.
AccountId	Int64		Account ID.
SeedType	String		Describes a type of related keywords creation conditions. The allowed values are KEYWORD_AND_URL, KEYBOARD, URL, SITE, UNKNOWN.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Url	String		URL. If seedType is URL, this field is required.
KeywordAndUrlSeedKeywords	String		Keyword. If seedType is KEYWORD_AND_URL, this field is required.
KeywordAndUrlSeedUrl	String		URL. If seedType is KEYWORD_AND_URL, this field is required.
KeywordSeedKeywords	String		Keyword. If seedType is KEYWORD, this field is required.
UrlSeedUrl	String		URL. If seedType is URL, this field is required.
SiteSeedSite	String		Site (domain URL). If seedType is SITE, this field is required.

OfflineConversions

Get registered offline conversion data information.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
UploadId supports the '=,IN'.

For example, the following queries are processed server side:

SELECT * FROM OfflineConversions WHERE AccountId = '1234339'

SELECT * FROM OfflineConversions WHERE AccountId = '1234339' AND UploadId = '2345'

Columns


Name	Type	References	Description
AccountId [KEY]	Int64	SearchAdsAccounts.AccountId	Account ID.
ProcessStatus	String		Processing status The allowed values are PROCESSING, DONE, DONE_WITH_ERROR, ERROR, UNKNOWN.
UploadedDate	Date		Upload date and time.
UploadFileName	String		Upload file name.
UploadId	Int64		Upload ID.
UploadSourceType	String		Desribes the operator information of operation history data. The allowed values are API, YAHOO_JAPAN, CAMPAIGN_MANAGEMENT_TOOL, UNKNOWN.
UploadType	String		Upload type. The allowed values are NEW, ADJUSTMENT, UNKNOWN.

PageFeedAsset

Getpage feed asset, upload or bulk download.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
ApprovalStatus supports the '=,IN'.
PageFeedAssetSetId supports the '=,IN'.

For example:

SELECT * FROM PageFeedAsset
SELECT * FROM PageFeedAsset WHERE AccountId = '1234339'
SELECT * FROM PageFeedAsset WHERE AccountId = '1234339' AND ApprovalStatus='Approved'
SELECT * FROM PageFeedAsset WHERE AccountId = '1234339' AND ApprovalStatus='Approved' AND PageFeedAssetSetId='245678'
SELECT * FROM PageFeedAsset
SELECT * FROM PageFeedAsset

Columns


Name	Type	References	Description
AccountId	Int64	SearchAdsAccounts.AccountId	Account ID.
ApprovalStatus	String		Displays Editorial Status.
DisapprovalReasonCodes	String		Codes of disapproval reason.
DisapprovalReasonComment	String		Comment of disapproval reason.
PageFeedAssetCustomLabel	String		Custom label of page feed asset.
PageFeedAssetId	Int64		PageFeedAsset ID.
PageFeedAssetSetId	Int64		PageFeedAssetSet ID.
PageFeedAssetUrl	String		Url of page feed asset.

PageFeedAssetReviewSummary

Gets registered approval records of page feed asset and summary of each status.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
PageFeedAssetSetId supports the '=,IN'.
FeedId supports the '=,IN'.

For example:

SELECT * FROM PageFeedAssetReviewSummary
SELECT * FROM PageFeedAssetReviewSummary WHERE AccountId = '1234339'
SELECT * FROM PageFeedAssetReviewSummary WHERE AccountId = '1234339' AND PageFeedAssetSetId='1732'
SELECT * FROM PageFeedAssetReviewSummary WHERE AccountId = '1234339' AND PageFeedAssetSetId='1732' AND FeedId='12342'

Columns


Name	Type	References	Description
AccountId	Int64	SearchAdsAccounts.AccountId	Account ID.
ApprovedCount	Int64		Count of approved.
ApprovedWithReviewCount	Int64		Count of approved with review.
EntityCount	Int64		Total count of page feed asset in page feed asset set.
PageFeedAssetSetId	Int64		PageFeedAssetSet ID.
PostDisapprovedCount	Int64		Count of distribution cancelled.
PreDisapprovedCount	Int64		Count of disapproved.
ReviewCount	Int64		Count of review.

PageFeedAssetServiceAddDownloadJob

displays content of page feed asset for download collectively.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
PageFeedAssetSetId supports the '=,IN'.
FeedId supports the '=,IN'.

For example:

SELECT * FROM PageFeedAssetServiceAddDownloadJob
SELECT * FROM PageFeedAssetServiceAddDownloadJob WHERE AccountId = '1234339'
SELECT * FROM PageFeedAssetServiceAddDownloadJob WHERE AccountId = '1234339' AND PageFeedAssetSetId='1732'
SELECT * FROM PageFeedAssetServiceAddDownloadJob WHERE AccountId = '1234339' AND PageFeedAssetSetId='1732' AND FeedId='12342'

Columns


Name	Type	References	Description
AccountId	Int64	SearchAdsAccounts.AccountId	Account ID.
BulkEncoding	String		Displays encoding(character code) of Page feed asset file.
BulkLang	String		Displays language setting of Page feed asset file.
BulkOutput	String		Specifies format of Page feed asset file.
DownloadJobStatus	String		Displays status of page feed asset download jobs.
EndDate	String		End date of job.
JobId	Int64		Job ID.
PageFeedAssetSetId	Int64		PageFeedAssetSet ID.
Progress	Int64		Progress of page feed asset job.
StartDate	String		Start date of job.

PageFeedAssetServiceDownloadJob

Gets processing status about upload or download.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
PageFeedAssetSetId supports the '=,IN'.
FeedId supports the '=,IN'.

For example:

SELECT * FROM PageFeedAssetServiceDownloadJob
SELECT * FROM PageFeedAssetServiceDownloadJob WHERE AccountId = '1234339'
SELECT * FROM PageFeedAssetServiceDownloadJob WHERE AccountId = '1234339' AND PageFeedAssetSetId='1732'
SELECT * FROM PageFeedAssetServiceDownloadJob WHERE AccountId = '1234339' AND PageFeedAssetSetId='1732' AND FeedId='12342'

Columns


Name	Type	References	Description
AccountId	Int64	SearchAdsAccounts.AccountId	Account ID.
BulkEncoding	String		Displays encoding(character code) of Page feed asset file.
BulkLang	String		Displays language setting of Page feed asset file.
BulkOutput	String		Specifies format of Page feed asset file.
DownloadJobStatus	String		Displays status of page feed asset download jobs.
EndDate	String		End date of job.
JobId	Int64		Job ID.
PageFeedAssetSetId	Int64		PageFeedAssetSet ID.
Progress	Int64		Progress of page feed asset job.
StartDate	String		Start date of job.

PageFeedAssetServiceUploadJob

Gets processing status about upload or download.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
PageFeedAssetSetId supports the '=,IN'.
FeedId supports the '=,IN'.

For example:

SELECT * FROM PageFeedAssetServiceUploadJob
SELECT * FROM PageFeedAssetServiceUploadJob WHERE AccountId = '1234339'
SELECT * FROM PageFeedAssetServiceUploadJob WHERE AccountId = '1234339' AND PageFeedAssetSetId='1732'
SELECT * FROM PageFeedAssetServiceUploadJob WHERE AccountId = '1234339' AND PageFeedAssetSetId='1732' AND FeedId='12342'

Columns


Name	Type	References	Description
AccountId	Int64	SearchAdsAccounts.AccountId	Account ID.
UploadJobStatus	String		Displays status of page feed asset upload jobs.
EndDate	String		End date of job.
JobId	Int64		Job ID.
PageFeedAssetSetId	Int64		PageFeedAssetSet ID.
Progress	Int64		Progress of page feed asset job.
ErrorCount	Int64		Count of error occured.
StartDate	String		Start date of job.

PageFeedItemJobStatus

Gets processing status about upload or download.

Table Specific Information

Select

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

AccountId supports the '='.
JobId supports the '=,IN'.
JobType supports the '=,IN'.

For example:

SELECT * FROM PageFeedItemJobStatus WHERE AccountId = '1234339' AND JobType = 'UPLOAD'

Columns


Name	Type	References	Description
FeedId [KEY]	Int64	SearchAdsFeeds.FeedId	Feed ID.
AccountId	Int64	SearchAdsAccounts.AccountId	Account ID.
BulkEncoding	String		Displays encoding(character code) of Page feed item file. The allowed values are SJIS, UTF8, UTF16LE, UNKNOWN. The default value is SJIS.
BulkLang	String		Displays language setting of Page feed item file. The allowed values are JA, EN, UNKNOWN. The default value is JA.
BulkOutput	String		Specifies format of Page feed item file. The allowed values are CSV, TSV, ZIPPED_CSV, ZIPPED_TSV, UNKNOWN. The default value is CSV.
DownloadJobStatus	String		Displays status of page feed item download jobs. The allowed values are IN_PROGRESS, COMPLETED, FIELDS_ERROR, TIMEDOUT, SYSTEM_ERROR, UNKNOWN.
StartDate	Datetime		Start date of job.
EndDate	Datetime		End date of job.
JobId	Int64		Registered job ID.
Progress	Int64		Progress of page feed item job.
JobType	String		Displays kind of registered job. The allowed values are UPLOAD, DOWNLOAD, UNKNOWN.

PageFeedItemReviewSummary

Gets registered approval records of page feed item and summary of each status.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
FeedId supports the '=,IN'.

For example, the following queries are processed server side:

SELECT * FROM PageFeedItemReviewSummary WHERE AccountId = '1234339'

SELECT * FROM PageFeedItemReviewSummary WHERE AccountId = '1234339' AND FeedId = '12345'

Columns


Name	Type	References	Description
FeedId [KEY]	Int64	SearchAdsFeeds.FeedId	Feed ID.
AccountId	Int64	SearchAdsAccounts.AccountId	Account ID.
ApprovedCount	Int64		Count of approved.
ApprovedWithReviewCount	Int64		Count of approved with review.
EntityCount	Int64		Total count of page feed item in feed folder
PostDisapprovedCount	Int64		Count of distribution cancelled.
PreDisapprovedCount	Int64		Count of disapproved.
ReviewCount	Int64		Count of review.

PageFeedItems

Get information related to page feed item.

Table Specific Information

Select

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

AccountId supports the '='.
FeedId supports the '=,IN'.
ApprovalStatussupports the '=,IN'.
PageFeedCustomLabelsupports the '=,IN'.
MatchTypesupports the '='.
Textsupports the '='.

For example:

SELECT * FROM PageFeedItems WHERE AccountId = '12353' AND FeedId = '8962'

SELECT * FROM PageFeedItems WHERE AccountId = '12353' AND FeedId = '8962' AND ApprovalStatus IN ('APPROVED')

SELECT * FROM PageFeedItems WHERE AccountId = '12353' AND FeedId = '8962' AND PageFeedCustomLabel IN ('LABEL')

SELECT * FROM PageFeedItems WHERE AccountId = '12353' AND MatchType = 'EXACT' AND FeedId='8962' AND Text = 'www.computerhope.com/jargon/u/url.htm'

SELECT * FROM PageFeedItems WHERE AccountId = '13525' AND FeedId IN ('8962')

Columns


Name	Type	References	Description
PageFeedItemId [KEY]	Int64		Page feed Item ID.
AccountId	Int64	SearchAdsAccounts.AccountId	Account ID.
FeedId	Int64	SearchAdsFeeds.FeedId	Label ID.
ApprovalStatus	String		Displays Editorial Status. The allowed values are APPROVED, APPROVED_WITH_REVIEW, REVIEW, PRE_DISAPPROVED, POST_DISAPPROVED, UNKNOWN.
DisapprovalReasonCodes	String		Codes of disapproval reason.
DisapprovalReasonComment	String		Comment of disapproval reason.
PageFeedCustomLabel	String		Custom label.
PageFeedUrl	String		object stores search condition of page feed URL.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
MatchType	String		Search method of page feed URL. The allowed values are EXACT, BROAD, UNKNOWN.
Text	String		Page feed URL

SearchAdsAccountLinks

Get account link information.

Table Specific Information

Select

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

ManagerAccountId supports the '='.
AccountStatus supports the '=,IN'.

For example:

SELECT * FROM SearchAdsAccountLinks WHERE ManagerAccountId = '1002513173'

SELECT * FROM SearchAdsAccountLinks WHERE ManagerAccountId = '1002513173' AND AccountStatus IN ('INPROGRESS','WAIT_DECIDE')

Columns


Name	Type	References	Description
ManagerAccountId [KEY]	Int64		MCC Account ID.
AccountId	Int64	SearchAdsAccounts.AccountId	Account ID.
LinkAccessPermission	String		Display the account link access permission.
OwnerShipType	String		Describes whether the linked account is an account within the same company.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
AccountStatus	String		Displays the account registration status. The allowed values are INPROGRESS, WAIT_DECIDE, SUSPENDED, SERVING, ENDED, UNKNOWN.

SearchAdsAdGroupAdAdditionalAdvancedMobileUrls

Retrieve the details of AdGroupAd AdditionalAdvancedMobileUrls.The columns values set read-only false can be inserted in the parent table using Temp tables

Columns


Name	Type	References	Description
AdId	Int64		Ad ID.
AccountId	Int64	SearchAdsAccounts.AccountId	Account ID.
AdGroupId	Int64	SearchAdsAdGroups.AdGroupId	Ad group ID.
AdType	String		Device type and number of title and description character. The allowed values are EXTENDED_TEXT_AD, DYNAMIC_SEARCH_LINKED_AD, TEXT_AD2, APP_AD, RESPONSIVE_SEARCH_AD, UNKNOWN.
ApprovalStatus	String		Displays Editorial Status. The allowed values are APPROVED, APPROVED_WITH_REVIEW, REVIEW, PRE_DISAPPROVAL, POST_DISAPPROVAL, UNKNOWN.
CampaignId	Int64	SearchAdsCampaigns.CampaignId	Campaign ID.
UserStatus	String		Displays ad delivery status that can be set by an user. The allowed values are ACTIVE, PAUSED, UNKNOWN.
AdvancedMobileUrl	String		Landing Page URL.
DisapprovalReasonCodes	String		Reject reason code.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
ContainsLabelId	String		Describes acquisition flag of label data. The allowed values are TRUE, FALSE, UNKNOWN.
LabelIds	Int64		Label Ids.
StartDate	Date		This is the start date of the search target period.
EndDate	Date		This is the end date of the search target period.

SearchAdsAdGroupAdAdditionalAdvancedUrls

Retrieve details of AdGroupAd AdditionalAdvancedUrls.The columns values set read-only false can be inserted in the parent table using Temp tables

Table Specific Information

Select

The Sync App 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 Sync App.

AdId supports the '=,IN'.
AccountId supports the '='.
AdGroupId supports the '=,IN'.
AdType supports the '=,IN'.
ApprovalStatus supports the '=,IN'.
CampaignId supports the '=,IN'.
UserStatus supports the '=,IN'.
ContainsLabelId supports the '='.
LabelId supports the '='.
StartDate supports the '='.
EndDate supports the '='.

For example:

SELECT * FROM SearchAdsAdGroupAdAdditionalAdvancedUrls WHERE AccountId = '25687';

SELECT * FROM SearchAdsAdGroupAdAdditionalAdvancedUrls WHERE AccountId = '25687' AND AdId IN ('456971');	

SELECT * FROM SearchAdsAdGroupAdAdditionalAdvancedUrls WHERE AccountId = '25687' AND AdGroupId IN ('8520');

Columns


Name	Type	References	Description
AdId	Int64		Ad ID.
AccountId	Int64	SearchAdsAccounts.AccountId	Account ID.
AdGroupId	Int64	SearchAdsAdGroups.AdGroupId	Ad group ID.
AdType	String		Device type and number of title and description character. The allowed values are EXTENDED_TEXT_AD, DYNAMIC_SEARCH_LINKED_AD, TEXT_AD2, APP_AD, RESPONSIVE_SEARCH_AD, UNKNOWN.
ApprovalStatus	String		Displays Editorial Status. The allowed values are APPROVED, APPROVED_WITH_REVIEW, REVIEW, PRE_DISAPPROVAL, POST_DISAPPROVAL, UNKNOWN.
CampaignId	Int64	SearchAdsCampaigns.CampaignId	Campaign ID.
UserStatus	String		Displays ad delivery status that can be set by an user. The allowed values are ACTIVE, PAUSED, UNKNOWN.
AdvancedUrl	String		Landing Page URL.
DisapprovalReasonCodes	String		Reject reason code.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
ContainsLabelId	String		Describes acquisition flag of label data. The allowed values are TRUE, FALSE, UNKNOWN.
LabelIds	Int64		Label Ids.
StartDate	Date		This is the start date of the search target period.
EndDate	Date		This is the end date of the search target period.

SearchAdsAdGroupAdAdResponsiveSearchAdDescriptions

Retrieve the details for AdGroupAd ResponsiveSearchAd Descriptions.The columns values set read-only false can be inserted in the parent table using Temp tables

Table Specific Information

Select

The Sync App 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 Sync App.

AdId supports the '=,IN'.
AccountId supports the '='.
AdGroupId supports the '=,IN'.
AdType supports the '=,IN'.
ApprovalStatus supports the '=,IN'.
CampaignId supports the '=,IN'.
UserStatus supports the '=,IN'.
ContainsLabelId supports the '='.
LabelId supports the '='.
StartDate supports the '='.
EndDate supports the '='.

For example:

SELECT * FROM SearchAdsAdGroupAdAdResponsiveSearchAdDescriptions WHERE AccountId = '25687';

SELECT * FROM SearchAdsAdGroupAdAdResponsiveSearchAdDescriptions WHERE AccountId = '25687' AND AdId IN ('456971')	

SELECT * FROM SearchAdsAdGroupAdAdResponsiveSearchAdDescriptions WHERE AccountId = '25687' AND AdGroupId IN ('8520')

Columns


Name	Type	References	Description
AdId	Int64		Ad ID.
AccountId	Int64	SearchAdsAccounts.AccountId	Account ID.
AdGroupId	Int64	SearchAdsAdGroups.AdGroupId	Ad group ID.
AdType	String		Device type and number of title and description character. The allowed values are EXTENDED_TEXT_AD, DYNAMIC_SEARCH_LINKED_AD, TEXT_AD2, APP_AD, RESPONSIVE_SEARCH_AD, UNKNOWN.
ApprovalStatus	String		Displays Editorial Status. The allowed values are APPROVED, APPROVED_WITH_REVIEW, REVIEW, PRE_DISAPPROVAL, POST_DISAPPROVAL, UNKNOWN.
DisapprovalReasonCodes	String		Reject reason code.
PinnedField	String		A field that specifies where to fix the display position of the description. The allowed values are SPECIFIED, DESCRIPTION1, DESCRIPTION2, UNKNOWN.
Text	String		Text of parameter.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
ContainsLabelId	String		Describes acquisition flag of label data. The allowed values are TRUE, FALSE, UNKNOWN.
LabelIds	Int64		Label Ids.
StartDate	Date		This is the start date of the search target period.
EndDate	Date		This is the end date of the search target period.

SearchAdsAdGroupAdAdResponsiveSearchAdHeadlines

Retrieve the details of AdGroupAd ReponsiveSearchAd Headlines.The columns values set read-only false can be inserted in the parent table using Temp tables

Table Specific Information

Select

The Sync App 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 Sync App.

AdId supports the '=,IN'.
AccountId supports the '='.
AdGroupId supports the '=,IN'.
AdType supports the '=,IN'.
ApprovalStatus supports the '=,IN'.
CampaignId supports the '=,IN'.
UserStatus supports the '=,IN'.
ContainsLabelId supports the '='.
LabelId supports the '='.
StartDate supports the '='.
EndDate supports the '='.

For example, the following queries are processed server side:

SELECT * FROM SearchAdsAdGroupAdAdResponsiveSearchAdHeadlines WHERE AccountId = '25687';

SELECT * FROM SearchAdsAdGroupAdAdResponsiveSearchAdHeadlines WHERE AccountId = '25687' AND AdId IN ('456971');	

SELECT * FROM SearchAdsAdGroupAdAdResponsiveSearchAdHeadlines WHERE AccountId = '25687' AND AdGroupId IN ('8520');

Columns


Name	Type	References	Description
AdId	Int64		Ad ID.
AccountId	Int64	SearchAdsAccounts.AccountId	Account ID.
AdGroupId	Int64	SearchAdsAdGroups.AdGroupId	Ad group ID.
AdType	String		Device type and number of title and description character. The allowed values are EXTENDED_TEXT_AD, DYNAMIC_SEARCH_LINKED_AD, TEXT_AD2, APP_AD, RESPONSIVE_SEARCH_AD, UNKNOWN.
ApprovalStatus	String		Displays Editorial Status. The allowed values are APPROVED, APPROVED_WITH_REVIEW, REVIEW, PRE_DISAPPROVAL, POST_DISAPPROVAL, UNKNOWN.
DisapprovalReasonCodes	String		Reject reason code.
PinnedField	String		A field that specifies where to fix the display position of the description. The allowed values are SPECIFIED, DESCRIPTION1, DESCRIPTION2, UNKNOWN.
Text	String		Text of parameter.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
ContainsLabelId	String		Describes acquisition flag of label data. The allowed values are TRUE, FALSE, UNKNOWN.
LabelIds	Int64		Label Ids.
StartDate	Date		This is the start date of the search target period.
EndDate	Date		This is the end date of the search target period.

SearchAdsAdGroupAdServiceLabels

Retrieve the details of AdGroupAd Labels. The columns values set read-only false can be inserted in the parent table using Temp tables.

Table Specific Information

Select

The Sync App 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 Sync App.

AdId supports the '=,IN'.
AccountId supports the '='.
AdGroupId supports the '=,IN'.
AdType supports the '=,IN'.
ApprovalStatus supports the '=,IN'.
CampaignId supports the '=,IN'.
UserStatus supports the '=,IN'.
ContainsLabelId supports the '='.
LabelId supports the '='.
StartDate supports the '='.
EndDate supports the '='.

For example, the following queries are processed server side:

SELECT * FROM SearchAdsAdGroupAdServiceLabels WHERE AccountId = '25687';

SELECT * FROM SearchAdsAdGroupAdServiceLabels WHERE AccountId = '25687' AND AdId IN ('456971');	

SELECT * FROM SearchAdsAdGroupAdServiceLabels WHERE AccountId = '25687' AND AdGroupId IN ('8520');

Columns


Name	Type	References	Description
LabelId [KEY]	Int64		Label Id.
AdId	Int64		Ad ID.
AccountId	Int64	SearchAdsAccounts.AccountId	Account ID.
AdGroupId	Int64	SearchAdsAdGroups.AdGroupId	Ad group ID.
AdType	String		Device type and number of title and description character. The allowed values are EXTENDED_TEXT_AD, DYNAMIC_SEARCH_LINKED_AD, TEXT_AD2, APP_AD, RESPONSIVE_SEARCH_AD, UNKNOWN.
ApprovalStatus	String		Displays Editorial Status. The allowed values are APPROVED, APPROVED_WITH_REVIEW, REVIEW, PRE_DISAPPROVAL, POST_DISAPPROVAL, UNKNOWN.
CampaignId	Int64	SearchAdsCampaigns.CampaignId	Campaign ID.
UserStatus	String		Displays ad delivery status that can be set by an user. The allowed values are ACTIVE, PAUSED, UNKNOWN.
Color	String		Color.
Description	String		Description.
LabelName	String		Label name.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
ContainsLabelId	String		Describes acquisition flag of label data. The allowed values are TRUE, FALSE, UNKNOWN.
StartDate	Date		This is the start date of the search target period.
EndDate	Date		This is the end date of the search target period.

SearchAdsAdGroupServiceLabels

Retrieve the details of AdGroup Labels

Table Specific Information

Select

The Sync App 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 The rest of the filter is executed client side within the Sync App.

AccountId supports the '='.
AdGroupId supports the '=,IN'.
CampaignId supports the '=,IN'.
UserStatus supports the '=,IN'.
ContainsLabelId supports the '=,IN'.
BiddingStateryIds supports the '=,IN'.
LabelId supports the '=,IN'.
StartDate supports the '='.
EndDate supports the '='.

For example, the following queries are processed server side:

SELECT * FROM SearchAdsAdGroupServiceLabels WHERE AccountId = '1234339'

SELECT * FROM SearchAdsAdGroupServiceLabels WHERE AccountId = '1234339' AND AdGroupId = '303253202'

SELECT * FROM SearchAdsAdGroupServiceLabels WHERE AccountId = '1234339' AND CampaignId = '303253202'

Columns


Name	Type	References	Description
AdGroupId [KEY]	Int64		Ad group ID.
AccountId	Int64	SearchAdsAccounts.AccountId	Account ID.
CampaignId	Int64	SearchAdsCampaigns.CampaignId	Campaign ID.
UserStatus	String		Displays ad delivery status that can be set by an user. The allowed values are ACTIVE, PAUSED, UNKNOWN.
Color	String		Color.
Description	String		Description
LabelName	String		Label Name

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
BiddingStateryIds	Int64		Bidding Statery Ids.
ContainsLabelId	String		Describes acquisition flag of label data.
LabelId	Int64		Label Ids.
StartDate	Date		This is the start date of the search target period.
EndDate	Date		This is the end date of the search target period.
Min	String		Maximum value of the search range.
Max	String		Minimum value of the search range.

SearchAdsAuditLogEventSelector

Retrieve the details of AuditLog EventSelector.The columns values set read-only false can be inserted in the parent table using Temp tables

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
JobId supports the '=,IN'.
JobStatus supports the '=,IN'.

For example:

SELECT * FROM SearchAdsAuditLogEventSelector WHERE AccountId = '25687'

SELECT * FROM SearchAdsAuditLogEventSelector WHERE AccountId = '23542' AND JobId = '456971'

Columns


Name	Type	References	Description
JobId	Int64		Job ID.
AccountId	Int64	SearchAdsAccounts.AccountId	Account ID.
EntityType	String		Describes the type of entities to be output on the data of operation history. The allowed values are CAMPAIGN, NEGATIVE_CAMPAIGN_CRITERION, CAMPAIGN_CRITERION, AD_GROUP, AD_GROUP_BID_MULTIPLIER, BIDDABLE_AD_GROUP_CRITERION, NEGATIVE_AD_GROUP_CRITERION, AD, FEED, FEED_ITEM, CAMPAIGN_FEED, AD_GROUP_FEED, SS_IO, SS_CONVERSION, BIDDING_STRATEGY_NEGATIVE_CAMPAIGN_USER_LIST, NEGATIVE_AD_GROUP_USER_LIST, AD_GROUP_USER_LIST, TARGET_LIST, SHARED_SET, SHARED_CRITERION, CAMPAIGN_SHARED_SET, AD_CUSTOMIZER, EXCLUDE_AD_CUSTOMIZER, ALL, UNKNOWN.
EventTypes	String		Describes the operation type to be acquired the operation history data. The allowed values are ADD,SET,REMOVE,ALL,UNKNOWN
JobStatus	String		Describes the job status of acquiring operation history data. The allowed values are SYSTEM_ERROR, IN_PROGRESS, COMPLETED, TIMEOUT, UNKNOWN.

SearchAdsBalance

Get the account balance.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '=,IN'.

For example:

SELECT * FROM SearchAdsBalance WHERE AccountId = '25687'

Columns


Name	Type	References	Description
AccountId [KEY]	Int64	SearchAdsAccounts.AccountId	Account ID.
Balance	Int64		Balance.

SearchAdsCampaignServiceLabels

Retrieve the details of Campaign Labels.The columns values set read-only false can be inserted in the parent table using Temp tables

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
CampaignId supports the '=,IN'.
BiddingStrategyConfigurationBiddingStrategyId supports the '=,IN'.
StartDate supports the '='.
EndDate supports the '='.
UserStatus supports the '=,IN'.
ContainsLabelId supports the '='.
LabelId supports the '=,IN'.
MinBudgetAmount supports the '='.
MaxBudgetAmount supports the '='.

For example:

SELECT * FROM  SearchAdsCampaignServiceLabels WHERE AccountId = '12346'

SELECT * FROM  SearchAdsCampaignServiceLabels WHERE AccountId = '12346' AND CampaignId = '9756'

SELECT * FROM  SearchAdsCampaignServiceLabels WHERE AccountId = '12346' AND StartDate = '2021-01-21' AND EndDate = '2021-02-03'

SELECT * FROM  SearchAdsCampaignServiceLabels WHERE AccountId = '12346' AND UserStatus = 'UNKNOWN'

SELECT * FROM  SearchAdsCampaignServiceLabels WHERE AccountId = '12346' AND ContainsLabelId = 'TRUE'

SELECT * FROM  SearchAdsCampaignServiceLabels WHERE AccountId = '12346' AND MinBudgetAmount = '1' AND MaxBudgetAmount = '1000'

Columns


Name	Type	References	Description
LabelId [KEY]	Int64		Label ID.
Color	String		Color.
Description	String		Description.
LabelName	String		Label name.
CampaignId	Int64		Campaign ID.
AccountId	Int64	SearchAdsAccounts.AccountId	Account ID.
BiddingStrategyConfigurationBiddingStrategyId	Int64		Auto Bidding ID. This field cannot be specified when Standard bidding is setting, and is required when Portfolio bidding is setting in ADD operation. It cannot be specified at the same times as biddingScheme.
StartDate	Date		Start date of Campaign. The default value in ADD operation will be Today's date. The default value in ADD operation will be Today's date. Cannot set the past date. Cannot change the date to the campaign that is already active.
EndDate	Date		End date of Campaign. The default value in ADD operation will be 20371231. Cannot set the past date and date before the start date.
UserStatus	String		Displays ad delivery status that can be set by an user. The allowed values are ACTIVE, PAUSED, UNKNOWN.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
ContainsLabelId	String		acquisition flag of label data The allowed values are TRUE, FALSE, UNKNOWN.
MinBudgetAmount	Int64		Minimum value of the search range.
MaxBudgetAmount	Int64		Maximum value of the search range.

SearchAdsCampaignSettings

Retrive the details of campaign settings.The columns values set read-only false can be inserted in the parent table using Temp tables

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
CampaignId supports the '=,IN'.
BiddingStrategyConfigurationBiddingStrategyId supports the '=,IN'.
StartDate supports the '='.
EndDate supports the '='.
UserStatus supports the '=,IN'.
ContainsLabelId supports the '='.
LabelId supports the '=,IN'.
MinBudgetAmount supports the '='.
MaxBudgetAmount supports the '='.

For example:

SELECT * FROM  SearchAdsCampaignSettings WHERE AccountId = '12346'

SELECT * FROM  SearchAdsCampaignSettings WHERE AccountId = '12346' AND CampaignId = '9756'

SELECT * FROM  SearchAdsCampaignSettings WHERE AccountId = '12346' AND StartDate = '2021-01-21' AND EndDate = '2021-02-03'

SELECT * FROM  SearchAdsCampaignSettings WHERE AccountId = '12346' AND UserStatus = 'UNKNOWN'

SELECT * FROM  SearchAdsCampaignSettings WHERE AccountId = '12346' AND ContainsLabelId = 'TRUE'

Columns


Name	Type	References	Description
AccountId	Int64	SearchAdsAccounts.AccountId	Account ID.
CampaignId	Int64		Campaign ID.
BiddingStrategyConfigurationBiddingStrategyId	Int64		Auto Bidding ID. This field cannot be specified when Standard bidding is setting, and is required when Portfolio bidding is setting in ADD operation. It cannot be specified at the same times as biddingScheme.
StartDate	Date		Start date of Campaign. The default value in ADD operation will be Today's date. The default value in ADD operation will be Today's date. Cannot set the past date. Cannot change the date to the campaign that is already active.
EndDate	Date		End date of Campaign. The default value in ADD operation will be 20371231. Cannot set the past date and date before the start date.
UserStatus	String		Displays ad delivery status that can be set by an user. The allowed values are ACTIVE, PAUSED, UNKNOWN.
DynamicAdsForSearchSettingDasUseUrlsType	String		DSA URL usage type. The allowed values are USE_SUPPLIED_URLS_ONLY, TOP_DOMAIN_ONLY, DOMAIN_AND_SUPPLIED_URLS, UNKNOWN.
DynamicAdsForSearchSettingDomain	String		Domain. If DasUseUrlsType is TOP_DOMAIN_ONLY or DOMAIN_AND_SUPPLIED_URLS, this field is required in ADD and SET operation.
DynamicAdsForSearchSettingFeedIds	String		Page Feed ID for campaign. If DasUseUrlsType is USE_SUPPLIED_URLS_ONLY or DOMAIN_AND_SUPPLIED_URLS, this field is required in ADD and SET operation.
GeoTargetTypeSettingNegativeGeoTargetType	String		Specifies Advanced Location options of Geo Targeting. The allowed values are DONT_CARE, AREA_OF_INTENT, LOCATION_OF_PRESENCE, UNKNOWN. The default value is DONT_CARE.
GeoTargetTypeSettingPositiveGeoTargetType	String		Specifies Advanced Location options of Geo Targeting. The allowed values are DONT_CARE, AREA_OF_INTENT, LOCATION_OF_PRESENCE, UNKNOWN. The default value is DONT_CARE.
SettingType	String		Describes the setting information of Target on the campaign. The allowed values are GEO_TARGET_TYPE_SETTING, TARGET_LIST_SETTING, DYNAMIC_ADS_FOR_SEARCH_SETTING, UNKNOWN. The default value is GEO_TARGET_TYPE_SETTING.
TargetingSettingTargetAll	String		Describes the setting of target(include) users on Site Retargeting. The allowed values are ACTIVE, DEACTIVE, UNKNOWN.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
ContainsLabelId	String		acquisition flag of label data The allowed values are TRUE, FALSE, UNKNOWN.
LabelId	Int64		Label ID.
MinBudgetAmount	Int64		Minimum value of the search range.
MaxBudgetAmount	Int64		Maximum value of the search range.

SearchAdsDisapprovalReasons

Get EditorialReason and recommended resolution list.

Table Specific Information

SELECT

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

Lang supports the '='.

For example:

SELECT * FROM  SearchAdsDisapprovalReasons WHERE Lang = 'JA';

Columns


Name	Type	References	Description
Description	String		Description of disapproval reason.
DisapprovalReasonCode	String		Editorial code.
Lang	String		DictionaryServiceLang is a language selection of the list. The allowed values are JA, EN, UNKNOWN.
Recommendation	String		Recommended solution.
Title	String		Title of disapproval reason.

SearchAdsFeedItemSchedulingSchedules

Retrieves the details of FeedItem Scheduling Schedules.The columns values set read-only false can be inserted in the parent table using Temp tables

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
FeedItemId supports the '=,IN'.
ApprovalStatus supports the '=,IN'.
FeedId supports the '=,IN'.
PlaceholderType supports the '=,IN'.

For example:

SELECT * FROM SearchAdsFeedItemSchedulingSchedules WHERE AccountId = '25687';

SELECT * FROM SearchAdsFeedItemSchedulingSchedules WHERE AccountId='25687'

SELECT * FROM SearchAdsFeedItemSchedulingSchedules WHERE AccountId='234535' AND FeedItemId='456971'

SELECT * FROM SearchAdsFeedItemSchedulingSchedules WHERE AccountId='234535' AND ApprovalStatus IN ('APPROVED_WITH_REVIEW')

SELECT * FROM SearchAdsFeedItemSchedulingSchedules WHERE AccountId='234535' AND FeedId IN ('0147')	

SELECT * FROM SearchAdsFeedItemSchedulingSchedules WHERE AccountId='234535' AND PlaceholderType IN ('CALLEXTENSION','AD_CUSTOMIZER')

Columns


Name	Type	References	Description
FeedItemId	Int64		Feed Item ID.
AccountId	Int64	SearchAdsAccounts.AccountId	Account ID.
ApprovalStatus	String		FeedItemServiceApprovalStatus displays Editorial Status. The allowed values are APPROVED, APPROVED_WITH_REVIEW, REVIEW, PRE_DISAPPROVED, POST_DISAPPROVED, UNKNOWN.
FeedId	Int64	SearchAdsFeeds.FeedId	Feed ID.
PlaceholderType	String		selects FeeItem information type. The allowed values are QUICKLINK, CALLEXTENSION, AD_CUSTOMIZER, CALLOUT, STRUCTURED_SNIPPET, UNKNOWN.
DayOfWeek	String		A day of the week. The allowed values are MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY, UNKNOWN.
StartMinute	String		Minutes of an hour. The allowed values are ZERO, FIFTEEN, THIRTY, FORTY_FIVE, UNKNOWN.
EndMinute	String		Minutes of an hour. The allowed values are ZERO, FIFTEEN, THIRTY, FORTY_FIVE, UNKNOWN.
StartHour	Int64		Start time in hour. Specify in 0-23.
EndHour	Int64		End time in hour. Specify in 0-24.

SearchAdsFeedItemServiceFeedItemAttributes

Retrieves the details of FeedItem FeedItemAttribute.The columns values set read-only false can be inserted in the parent table using Temp tables

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
FeedItemId supports the '=,IN'.
ApprovalStatus supports the '=,IN'.
FeedId supports the '=,IN'.
PlaceholderType supports the '=,IN'.

For example:

SELECT * FROM SearchAdsFeedItemServiceFeedItemAttributes WHERE AccountId='25687'

SELECT * FROM SearchAdsFeedItemServiceFeedItemAttributes WHERE AccountId='234535' AND FeedItemId='456971'

SELECT * FROM SearchAdsFeedItemServiceFeedItemAttributes WHERE AccountId='234535' AND ApprovalStatus IN ('APPROVED_WITH_REVIEW')

SELECT * FROM SearchAdsFeedItemServiceFeedItemAttributes WHERE AccountId='234535' AND FeedId IN ('0147')	

SELECT * FROM SearchAdsFeedItemServiceFeedItemAttributes WHERE AccountId='234535' AND PlaceholderType IN ('CALLEXTENSION','AD_CUSTOMIZER')

Columns


Name	Type	References	Description
FeedItemId	Int64		Feed Item ID.
AccountId	Int64	SearchAdsAccounts.AccountId	Account ID.
ApprovalStatus	String		FeedItemServiceApprovalStatus displays Editorial Status. The allowed values are APPROVED, APPROVED_WITH_REVIEW, REVIEW, PRE_DISAPPROVED, POST_DISAPPROVED, UNKNOWN.
FeedId	Int64	SearchAdsFeeds.FeedId	Feed ID.
PlaceholderType	String		selects FeeItem information type. The allowed values are QUICKLINK, CALLEXTENSION, AD_CUSTOMIZER, CALLOUT, STRUCTURED_SNIPPET, UNKNOWN.
FeedAttributeId	Int64		Feed attribute ID. For AD_CUSTOMIZER, this field is required in ADD and SET operation.
MultipleFeedItemAttributeFeedAttributeValues	String		Describes FeedItem attribute value.
MultipleFeedItemAttributeIsRemove	String		Delete flag. To deactivate the location restriction, set isRemove of location object to TRUE. After the deactivation, geoTargetingRestriction will be set to NONE. The allowed values are TRUE, FALSE, UNKNOWN.
PlaceholderField	String		Selects FeedItem information details. The allowed values are LINK_TEXT, LINK_DESCRIPTION_1, LINK_DESCRIPTION_2, ADVANCED_URL, ADVANCED_MOBILE_URL, TRACKING_URL, CALL_PHONE_NUMBER, AD_CUSTOMIZER_INTEGER, AD_CUSTOMIZER_PRICE, AD_CUSTOMIZER_DATE, AD_CUSTOMIZER_STRING, CALLOUT_TEXT, ADDITIONAL_ADVANCED_URLS, ADDITIONAL_ADVANCED_MOBILE_URLS, STRUCTURED_SNIPPET_HEADER, STRUCTURED_SNIPPET_VALUES, UNKNOWN.
SimpleFeedItemAttributeFeedAttributeValue	String		Value of feed iteim information. When using data insertion, you need to enter attribution as follows: For AD_CUSTOMIZER_INTEGER: 99999999, For AD_CUSTOMIZER_PRICE: 19800 or 19,800 , For AD_CUSTOMIZER_DATE: 20151231 235959, For AD_CUSTOMIZER_STRING: home, For STRUCTURED_SNIPPET_HEADER: brand
SimpleFeedItemAttributeReviewFeedAttributeValue	String		The feed item information on editorial review.

SearchAdsFeedItemServiceFeedItemAttributeValues

Retrieves the details of FeedItem FeedItemAttribute feedAttributeValues.The columns values set read-only false can be inserted in the parent table using Temp tables

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
FeedItemId supports the '=,IN'.
ApprovalStatus supports the '=,IN'.
FeedId supports the '=,IN'.
PlaceholderType supports the '=,IN'.

For example:

SELECT * FROM SearchAdsFeedItemServiceFeedItemAttributeValues WHERE AccountId = '25687'

SELECT * FROM SearchAdsFeedItemServiceFeedItemAttributeValues WHERE AccountId='25687'

SELECT * FROM SearchAdsFeedItemServiceFeedItemAttributeValues WHERE AccountId='234535' AND FeedItemId='456971'

SELECT * FROM SearchAdsFeedItemServiceFeedItemAttributeValues WHERE AccountId='234535' AND ApprovalStatus IN ('APPROVED_WITH_REVIEW')

SELECT * FROM SearchAdsFeedItemServiceFeedItemAttributeValues WHERE AccountId='234535' AND FeedId IN ('0147')	

SELECT * FROM SearchAdsFeedItemServiceFeedItemAttributeValues WHERE AccountId='234535' AND PlaceholderType IN ('CALLEXTENSION','AD_CUSTOMIZER')

Columns


Name	Type	References	Description
FeedItemId	Int64		Feed Item ID.
AccountId	Int64	SearchAdsAccounts.AccountId	Account ID.
ApprovalStatus	String		FeedItemServiceApprovalStatus displays Editorial Status. The allowed values are APPROVED, APPROVED_WITH_REVIEW, REVIEW, PRE_DISAPPROVED, POST_DISAPPROVED, UNKNOWN.
FeedId	Int64	SearchAdsFeeds.FeedId	Feed ID.
PlaceholderType	String		selects FeeItem information type. The allowed values are QUICKLINK, CALLEXTENSION, AD_CUSTOMIZER, CALLOUT, STRUCTURED_SNIPPET, UNKNOWN.
DisapprovalReasonCodes	String		Reject reason code of editorial review.
FeedAttributeValue	String		FeedItem attribute value.
ReviewFeedAttributeValue	String		FeedItem attribute value in review.

SearchAdsFeedServiceFeedAttributes

Retrieves the details of Feed FeedAttributes.The columns values set read-only false can be inserted in the parent table using Temp tables

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
FeedId supports the '=,IN'.
PlaceholderType supports the '=,IN'.

For example:

SELECT * FROM SearchAdsFeedServiceFeedAttributes WHERE AccountId = '25687'

SELECT * FROM SearchAdsFeedServiceFeedAttributes WHERE AccountId = '1234339' AND FeedId = '174849'

Columns


Name	Type	References	Description
FeedAttributeId [KEY]	Int64		Attribute ID (column ID) of auto data insertion list.
AccountId	Int64	SearchAdsAccounts.AccountId	Account ID. Not required by design change on editorials.
PlaceholderType	String		FeedServicePlaceholderType (enum) object select the type of Feed Item information. The allowed values are AD_CUSTOMIZER, DYNAMIC_AD_FOR_SEARCH_PAGE_FEEDS, UNKNOWN.
FeedId	Int64		Feed ID.
FeedAttributeName	String		Attribute name (column name) of auto data insertion list.
PlaceholderField	String		Select the details of Feed Item information. The allowed values are AD_CUSTOMIZER_INTEGER, AD_CUSTOMIZER_PRICE, AD_CUSTOMIZER_DATE, AD_CUSTOMIZER_STRING, DYNAMIC_AD_FOR_SEARCH_PAGE_FEEDS_PAGE_URL, DYNAMIC_AD_FOR_SEARCH_PAGE_FEEDS_LABEL, UNKNOWN.

SearchAdsGeographicLocations

Get the information list of geo targeting.

Table Specific Information

SELECT

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

Lang supports the 'IN'.

For example:

SELECT * FROM SearchAdsGeographicLocations WHERE Lang = 'JA'

Columns


Name	Type	References	Description
Child	String		undefined.
Code	String		Geographic code.
FullName	String		Name of places (Prefecture and all).
GeographicLocationStatus	String		Status of geographic location. The allowed values are ACTIVE, OBSOLETE, PHASING_OUT, UNKNOWN.
Name	String		Name of places (City Only).
Order	String		Order of list.
Parent	String		Parent geographic code.
Lang	String		A language selection of the list. The allowed values are JA, EN, UNKNOWN.

SearchAdsReportFields

Returns the available report fields for a given report type.The columns values set read-only false can be inserted in the parent table using Temp tables

Table Specific Information

Select

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

ReportType supports the '='.

For example:

SELECT * FROM SearchAdsReportFields WHERE ReportType = 'ACCOUNT'

Columns


Name	Type	References	Description
ReportType	String		Displays a type of available report. The allowed values are ACCOUNT, CAMPAIGN, ADGROUP, AD, KEYWORDS, SEARCH_QUERY, GEO, FEED_ITEM, GEO_TARGET, SCHEDULE_TARGET, BID_STRATEGY, AD_CUSTOMIZERS, TARGET_LIST, LANDING_PAGE_URL, KEYWORDLESSS_QUERY, WEBPAGE_CRITERION, UNKNOWN.
DisplayFieldNameEN	String		Field name displayed in downloaded report (in English).
DisplayFieldNameJA	String		Field name displayed in downloaded report (in Japanese).
FieldName	String		Field name.
FieldType	String		Type of field.
CanFilter	Boolean		Indicate if use can filter the fields.
CanSelect	Boolean		Indicate if user can select the fields.
ImpossibleCombinationFields	String		Report fields which cannot be combined.

SearchAdsReportFilters

Retrieves the details of Report Filters.The columns values set read-only false can be inserted in the parent table using Temp tables

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
ReportJobId supports the '=,IN'.
ReportJobStatus supports the '=,IN'.
ReportType supports the '=,IN'.

For example:

SELECT * FROM SearchAdsReportFilters WHERE AccountId = '25687'

SELECT * FROM SearchAdsReportFilters WHERE AccountId = '25687' AND ReportJobId = '5678'

Columns


Name	Type	References	Description
AccountId	Int64	SearchAdsAccounts.AccountId	Account ID.
ReportJobId	String		Report Job ID.
ReportJobStatus	String		A status of the requested report. The allowed values are WAIT, COMPLETED, IN_PROGRESS, FAILED, UNKNOWN.
ReportType	String		Displays a type of available report. The allowed values are ACCOUNT, CAMPAIGN, ADGROUP, AD, KEYWORDS, SEARCH_QUERY, GEO, FEED_ITEM, GEO_TARGET, SCHEDULE_TARGET, BID_STRATEGY, AD_CUSTOMIZERS, TARGET_LIST, LANDING_PAGE_URL, KEYWORDLESSS_QUERY, WEBPAGE_CRITERION, UNKNOWN.
Field	String		Field which you set filtering.
FilterOperator	String		Displays filtering conditions for the report. The allowed values are EQUALS, NOT_EQUALS, GREATER_THAN, GREATER_THAN_EQUALS, LESS_THAN, LESS_THAN_EQUALS, CONTAINS, IN, UNKNOWN.
Values	String		Condition values to filter the field.

SearchAdsReportSortFields

Retrieve the sort details of report definition.The columns values set read-only false can be inserted in the parent table using Temp tables

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
ReportJobId supports the '=,IN'.
ReportJobStatus supports the '=,IN'.
ReportType supports the '=,IN'.

For example:

SELECT * FROM SearchAdsReportSortFields WHERE AccountId = '25687'

SELECT * FROM SearchAdsReportSortFields WHERE AccountId = '25687' AND ReportJobId = '5678'

Columns


Name	Type	References	Description
AccountId	Int64	SearchAdsAccounts.AccountId	Account ID.
ReportJobId	String		Report Job ID.
ReportJobStatus	String		A status of the requested report. The allowed values are WAIT, COMPLETED, IN_PROGRESS, FAILED, UNKNOWN.
ReportType	String		Displays a type of available report. The allowed values are ACCOUNT, CAMPAIGN, ADGROUP, AD, KEYWORDS, SEARCH_QUERY, GEO, FEED_ITEM, GEO_TARGET, SCHEDULE_TARGET, BID_STRATEGY, AD_CUSTOMIZERS, TARGET_LIST, LANDING_PAGE_URL, KEYWORDLESSS_QUERY, WEBPAGE_CRITERION, UNKNOWN.
Field	String		Field of report definition.
ReportSortType	String		Sort condition type. The allowed values are ASC, DESC, UNKNOWN.

SearchAdsRetargetingListLogicalGroupLogicalOperand

Retrieve the details of RetargetingList LogicalTargetList LogicalGroup LogicalOperand.The columns values set read-only false can be inserted in the parent table using Temp tables

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
TargetListId supports the '=,IN'.
TargetListOwner supports the '='.
TargetListType supports the '=,IN'.

For example:

SELECT * FROM SearchAdsRetargetingListLogicalGroupLogicalOperand WHERE AccountId = '125466'

SELECT * FROM SearchAdsRetargetingListLogicalGroupLogicalOperand WHERE AccountId = '125466' AND TargetListId = '234234'

Columns


Name	Type	References	Description
TargetListId	Int64		Target List ID.
AccountId	Int64	SearchAdsAccounts.AccountId	Account ID.
TargetListOwner	String		Describes the owner information of the target list. The allowed values are ONWER, SHARED, UNKNOWN.
TargetListType	String		The type of target list. The allowed values are DEFAULT, RULE, LOGICAL, UNKNOWN.

SearchAdsRetargetingListLogicalGroups

Retrieve the details of RetargetingList LogicalTargetList LogicalGroup.The columns values set read-only false can be inserted in the parent table using Temp tables

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
TargetListId supports the '=,IN'.
TargetListOwner supports the '='.
TargetListType supports the '=,IN'.

For example:

SELECT * FROM SearchAdsRetargetingListLogicalGroups WHERE AccountId = '125466'

SELECT * FROM SearchAdsRetargetingListLogicalGroups WHERE AccountId = '125466' AND TargetListId = '234234'

Columns


Name	Type	References	Description
TargetListId	Int64		Target List ID.
AccountId	Int64	SearchAdsAccounts.AccountId	Account ID.
TargetListOwner	String		Describes the owner information of the target list. The allowed values are ONWER, SHARED, UNKNOWN.
TargetListType	String		The type of target list. The allowed values are DEFAULT, RULE, LOGICAL, UNKNOWN.
LogicalCondition	String		Describes the conditions of combined target list. The allowed values are NOT, AND, OR, UNKNOWN.
LogicalOperand	String		Object that holds target list of combination.

SearchAdsRetargetingListRuleBaseTargetListRuleRuleItems

Retrieves the details of RetargetingList RuleBaseTargetList Rule RuleItems.The columns values set read-only false can be inserted in the parent table using Temp tables

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
TargetListId supports the '=,IN'.
TargetListOwner supports the '='.
TargetListType supports the '=,IN'.

For example:

SELECT * FROM SearchAdsRetargetingListRuleBaseTargetListRuleRuleItems WHERE AccountId = '125466'

SELECT * FROM SearchAdsRetargetingListRuleBaseTargetListRuleRuleItems WHERE AccountId = '125466' AND TargetListId = '234234'

Columns


Name	Type	References	Description
TargetListId	Int64		Target List ID.
AccountId	Int64	SearchAdsAccounts.AccountId	Account ID.
TargetListOwner	String		Describes the owner information of the target list. The allowed values are ONWER, SHARED, UNKNOWN.
TargetListType	String		The type of target list. The allowed values are DEFAULT, RULE, LOGICAL, UNKNOWN.
CustomKeyRuleItemTextKey	String		Evaluation item. If ruleType is CUSTOM_KEY_RULE, this field is required in ADD and SET operation.
RuleOperator	String		The evaluation type to set evaluation condition of rules. The allowed values are UNKNOWN, EQUALS, NOT_EQUAL, CONTAINS, NOT_CONTAIN, STARTS_WITH, NOT_START_WITH, ENDS_WITH, NOT_END_WITH.
RuleType	String		The rule type of target list. The allowed values are URL_RULE, CUSTOM_KEY_RULE, UNKNOWN.
UrlRuleItemUrlRuleKey	String		The evaluation to set URL rules. If ruleType is URL_RULE, this field is required in ADD and SET operation. The allowed values are URL, REFFER_URL, UNKNOWN.
Value	String		Evaluation value. Cannot use: bracket, single quote, double quote, and tab. Can select up to 250 characters.

SearchAdsRetargetingListRuleBaseTargetListRules

Retrieves the details of RetargetingList RuleBaseTargetList Rules.The columns values set read-only false can be inserted in the parent table using Temp tables

Table Specific Information

Select

The Sync App 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 Sync App.

AccountId supports the '='.
TargetListId supports the '=,IN'.
TargetListOwner supports the '='.
TargetListType supports the '=,IN'.

For example:

SELECT * FROM SearchAdsRetargetingListRuleBaseTargetListRules WHERE AccountId = '125466'

SELECT * FROM SearchAdsRetargetingListRuleBaseTargetListRules WHERE AccountId = '125466' AND TargetListId = '234234'

Columns


Name	Type	References	Description
RuleItems	String		Object that holds grouped URL/LABEL rules. If isAllVisitor is TRUE, this field is required in ADD and SET operation.
TargetListId	Int64		Target List ID.
AccountId	Int64	SearchAdsAccounts.AccountId	Account ID.
TargetListOwner	String		Describes the owner information of the target list. The allowed values are ONWER, SHARED, UNKNOWN.
TargetListType	String		The type of target list. The allowed values are DEFAULT, RULE, LOGICAL, UNKNOWN.

Connection String Options

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.

For more information on establishing a connection, see Establishing a Connection.

Connection

Property	Description
DisplayAdsAccountId	The unique identifier associated with the DisplayAds Account.
SearchAdsAccountId	The unique identifier associated with the SearchAds Account.
Language	Report definition service ReportLanguage serves the language for the defined column name.

OAuth

Property	Description
OAuthClientId	The client Id assigned when you register your application with an OAuth authorization server.
OAuthClientSecret	The client secret assigned when you register your application with an OAuth authorization server.

SSL

Property	Description
SSLServerCert	The certificate to be accepted from the server when connecting using TLS/SSL.

Firewall

Property	Description
FirewallType	The protocol used by a proxy-based firewall.
FirewallServer	The name or IP address of a proxy-based firewall.
FirewallPort	The TCP port for a proxy-based firewall.
FirewallUser	The user name to use to authenticate with a proxy-based firewall.
FirewallPassword	A password used to authenticate to a proxy-based firewall.

Proxy

Property	Description
ProxyAutoDetect	This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
ProxyServer	The hostname or IP address of a proxy to route HTTP traffic through.
ProxyPort	The TCP port the ProxyServer proxy is running on.
ProxyAuthScheme	The authentication type to use to authenticate to the ProxyServer proxy.
ProxyUser	A user name to be used to authenticate to the ProxyServer proxy.
ProxyPassword	A password to be used to authenticate to the ProxyServer proxy.
ProxySSLType	The SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Logging

Property	Description
LogModules	Core modules to be included in the log file.

Schema

Property	Description
Location	A path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Tables	This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Views	Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Miscellaneous

Property	Description
MaxRows	Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
Other	These hidden properties are used only in specific use cases.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.
UserDefinedViews	A filepath pointing to the JSON configuration file containing your custom views.

Connection

This section provides a complete list of the Connection properties you can configure in the connection string for this provider.

Property	Description
DisplayAdsAccountId	The unique identifier associated with the DisplayAds Account.
SearchAdsAccountId	The unique identifier associated with the SearchAds Account.
Language	Report definition service ReportLanguage serves the language for the defined column name.

DisplayAdsAccountId

The unique identifier associated with the DisplayAds Account.

Remarks

Requests will return the data for this account.

You can find this by querying the DisplayAdsAccounts

SELECT AccountId FROM DisplayAdsAccounts

SearchAdsAccountId

The unique identifier associated with the SearchAds Account.

Remarks

Requests will return the data for this account.

You can find this by querying the SearchAdsAccounts

SELECT AccountId FROM SearchAdsAccounts

Language

Report definition service ReportLanguage serves the language for the defined column name.

Remarks

This property can take one of the following values:


EN (default)	English
JA	Japanese

OAuth

This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.

Property	Description
OAuthClientId	The client Id assigned when you register your application with an OAuth authorization server.
OAuthClientSecret	The client secret assigned when you register your application with an OAuth authorization server.

OAuthClientId

The client Id assigned when you register your application with an OAuth authorization server.

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.

OAuthClientSecret

The client secret assigned when you register your application with an OAuth authorization server.

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret property.

SSL

This section provides a complete list of the SSL properties you can configure in the connection string for this provider.

Property	Description
SSLServerCert	The certificate to be accepted from the server when connecting using TLS/SSL.

SSLServerCert

The certificate to be accepted from the server when connecting using TLS/SSL.

Remarks

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.

This property can take the following forms:


Description	Example
A full PEM Certificate (example shortened for brevity)	-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
A path to a local file containing the certificate	C:\cert.cer
The public key (example shortened for brevity)	-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
The MD5 Thumbprint (hex values can also be either space or colon separated)	ecadbdda5a1529c58a1e9e09828d70e4
The SHA1 Thumbprint (hex values can also be either space or colon separated)	34a929226ae0819f2ec14b4a3d904f801cbb150d

If not specified, any certificate trusted by the machine is accepted.

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

Firewall

This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.

Property	Description
FirewallType	The protocol used by a proxy-based firewall.
FirewallServer	The name or IP address of a proxy-based firewall.
FirewallPort	The TCP port for a proxy-based firewall.
FirewallUser	The user name to use to authenticate with a proxy-based firewall.
FirewallPassword	A password used to authenticate to a proxy-based firewall.

FirewallType

The protocol used by a proxy-based firewall.

Remarks

This property specifies the protocol that the Sync App will use to tunnel traffic through the FirewallServer proxy. Note that by default, the Sync App connects to the system proxy; to disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.


Type	Default Port	Description
TUNNEL	80	When this is set, the Sync App opens a connection to Yahoo! Ads and traffic flows back and forth through the proxy.
SOCKS4	1080	When this is set, the Sync App sends data through the SOCKS 4 proxy specified by FirewallServer and FirewallPort and passes the FirewallUser value to the proxy, which determines if the connection request should be granted.
SOCKS5	1080	When this is set, the Sync App sends data through the SOCKS 5 proxy specified by FirewallServer and FirewallPort. If your proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes.

To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.

FirewallServer

The name or IP address of a proxy-based firewall.

Remarks

This property specifies the IP address, DNS name, or host name of a proxy allowing traversal of a firewall. The protocol is specified by FirewallType: Use FirewallServer with this property to connect through SOCKS or do tunneling. Use ProxyServer to connect to an HTTP proxy.

Note that the Sync App uses the system proxy by default. To use a different proxy, set ProxyAutoDetect to false.

FirewallPort

The TCP port for a proxy-based firewall.

Remarks

This specifies the TCP port for a proxy allowing traversal of a firewall. Use FirewallServer to specify the name or IP address. Specify the protocol with FirewallType.

FirewallUser

The user name to use to authenticate with a proxy-based firewall.

Remarks

The FirewallUser and FirewallPassword properties are used to authenticate against the proxy specified in FirewallServer and FirewallPort, following the authentication method specified in FirewallType.

FirewallPassword

A password used to authenticate to a proxy-based firewall.

Remarks

This property is passed to the proxy specified by FirewallServer and FirewallPort, following the authentication method specified by FirewallType.

Proxy

This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.

Property	Description
ProxyAutoDetect	This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
ProxyServer	The hostname or IP address of a proxy to route HTTP traffic through.
ProxyPort	The TCP port the ProxyServer proxy is running on.
ProxyAuthScheme	The authentication type to use to authenticate to the ProxyServer proxy.
ProxyUser	A user name to be used to authenticate to the ProxyServer proxy.
ProxyPassword	A password to be used to authenticate to the ProxyServer proxy.
ProxySSLType	The SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

ProxyAutoDetect

This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.

Remarks

This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.

To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.

ProxyServer

The hostname or IP address of a proxy to route HTTP traffic through.

Remarks

The hostname or IP address of a proxy to route HTTP traffic through. The Sync App can use the HTTP, Windows (NTLM), or Kerberos authentication types to authenticate to an HTTP proxy.

If you need to connect through a SOCKS proxy or tunnel the connection, see FirewallType.

By default, the Sync App uses the system proxy. If you need to use another proxy, set ProxyAutoDetect to false.

ProxyPort

The TCP port the ProxyServer proxy is running on.

Remarks

The port the HTTP proxy is running on that you want to redirect HTTP traffic through. Specify the HTTP proxy in ProxyServer. For other proxy types, see FirewallType.

ProxyAuthScheme

The authentication type to use to authenticate to the ProxyServer proxy.

Remarks

This value specifies the authentication type to use to authenticate to the HTTP proxy specified by ProxyServer and ProxyPort.

Note that the Sync App will use the system proxy settings by default, without further configuration needed; if you want to connect to another proxy, you will need to set ProxyAutoDetect to false, in addition to ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

The authentication type can be one of the following:

BASIC: The Sync App performs HTTP BASIC authentication.
DIGEST: The Sync App performs HTTP DIGEST authentication.
NEGOTIATE: The Sync App retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
PROPRIETARY: The Sync App does not generate an NTLM or Kerberos token. You must supply this token in the Authorization header of the HTTP request.

If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.

ProxyUser

A user name to be used to authenticate to the ProxyServer proxy.

Remarks

The ProxyUser and ProxyPassword options are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

You can select one of the available authentication types in ProxyAuthScheme. If you are using HTTP authentication, set this to the user name of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a user name in one of the following formats:

user@domain
domain\user

ProxyPassword

A password to be used to authenticate to the ProxyServer proxy.

Remarks

This property is used to authenticate to an HTTP proxy server that supports NTLM (Windows), Kerberos, or HTTP authentication. To specify the HTTP proxy, you can set ProxyServer and ProxyPort. To specify the authentication type, set ProxyAuthScheme.

If you are using HTTP authentication, additionally set ProxyUser and ProxyPassword to HTTP proxy.

If you are using NTLM authentication, set ProxyUser and ProxyPassword to your Windows password. You may also need these to complete Kerberos authentication.

For SOCKS 5 authentication or tunneling, see FirewallType.

By default, the Sync App uses the system proxy. If you want to connect to another proxy, set ProxyAutoDetect to false.

ProxySSLType

The SSL type to use when connecting to the ProxyServer proxy.

Remarks

This property determines when to use SSL for the connection to an HTTP proxy specified by ProxyServer. This value can be AUTO, ALWAYS, NEVER, or TUNNEL. The applicable values are the following:


AUTO	Default setting. If the URL is an HTTPS URL, the Sync App will use the TUNNEL option. If the URL is an HTTP URL, the component will use the NEVER option.
ALWAYS	The connection is always SSL enabled.
NEVER	The connection is not SSL enabled.
TUNNEL	The connection is through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy.

ProxyExceptions

A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Remarks

The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.

Note that the Sync App uses the system proxy settings by default, without further configuration needed; if you want to explicitly configure proxy exceptions for this connection, you need to set ProxyAutoDetect = false, and configure ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

Logging

This section provides a complete list of the Logging properties you can configure in the connection string for this provider.

Property	Description
LogModules	Core modules to be included in the log file.

LogModules

Core modules to be included in the log file.

Remarks

Only the modules specified (separated by ';') will be included in the log file. By default all modules are included.

See the Logging page for an overview.

Schema

This section provides a complete list of the Schema properties you can configure in the connection string for this provider.

Property	Description
Location	A path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Tables	This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Views	Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Location

A path to the directory that contains the schema files defining tables, views, and stored procedures.

Remarks

The path to a directory which contains the schema files for the Sync App (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.

Note: Given that this Sync App supports multiple schemas, the structure for Yahoo! Ads custom schema files is as follows:

Each schema is given a folder corresponding to that schema name.
These schema folders are contained in a parent folder.
The parent folder should be set as the Location, not an individual schema's folder.

If left unspecified, the default location is "%APPDATA%\\CData\\YahooAds Data Provider\\Schema" with %APPDATA% being set to the user's configuration directory:

BrowsableSchemas

This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Remarks

Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.

Tables

This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.

Remarks

Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the Sync App.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Views

Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Remarks

Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the Sync App.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Miscellaneous

This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.

Property	Description
MaxRows	Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
Other	These hidden properties are used only in specific use cases.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.
UserDefinedViews	A filepath pointing to the JSON configuration file containing your custom views.

MaxRows

Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.

Remarks

Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.

Other

These hidden properties are used only in specific use cases.

Remarks

The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting


DefaultColumnSize	Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000.
ConvertDateTimeToGMT	Determines whether to convert date-time values to GMT, instead of the local time of the machine.
RecordToFile=filename	Records the underlying socket data transfer to the specified file.

PseudoColumns

This property indicates whether or not to include pseudo columns as columns to the table.

Remarks

This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".

Timeout

The value in seconds until the timeout error is thrown, canceling the operation.

Remarks

If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.

If Timeout expires and the operation is not yet complete, the Sync App throws an exception.

UserDefinedViews

A filepath pointing to the JSON configuration file containing your custom views.

Remarks

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The Sync App automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the Sync App.

This User Defined View configuration file is formatted as follows:

Each root element defines the name of a view.
Each root element contains a child element, called query, which contains the custom SQL query for the view.

For example:

{
	"MyView": {
		"query": "SELECT * FROM [YahooAds].[SearchAds].SearchAdsAdGroups WHERE MyColumn = 'value'"
	},
	"MyView2": {
		"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
	}
}

Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:

"UserDefinedViews", "C:\\Users\\yourusername\\Desktop\\tmp\\UserDefinedViews.json"