CData Sync App は、Yahoo! Ads データをデータベース、データレイク、またはデータウェアハウスに継続的にパイプライン化する簡単な方法を提供し、分析、レポート、AI、および機械学習で簡単に利用できるようにします。
Yahoo! Ads コネクタはCData Sync アプリケーションから使用可能で、Yahoo! Ads からデータを取得して、サポートされている任意の同期先に移動できます。
Sync App はYahoo!広告 API v10 を使用してYahoo!広告データへの双方向アクセスを実現します。
必須プロパティについては、設定タブを参照してください。
通常必須ではない接続プロパティについては、高度な設定タブを参照してください。
以下をオプションで設定して、Yahoo! Ads から返されたデータを絞り込むことができます。
アクセストークンの期限が切れたときは、Sync App は自動でアクセストークンをリフレッシュします。
カスタムアプリケーションを作成した場合は、接続する前に以下の変数を設定してください。
Yahoo! Ads への接続 をクリックして、デフォルトブラウザでOAuth エンドポイントを開きます。ログインして、アプリケーションにアクセス許可を与えます。
ドライバーは、以下のようにOAuth プロセスを完了します。
CData はOAuth アプリケーション認証情報を製品に組み込んでおり、デスクトップアプリケーションまたはヘッドレスマシン経由でYahoo! Ads に接続する際に使用できます。埋め込みOAuth アプリケーションを使用する場合、接続するために必要なことは以下のみです。
(OAuthAccessToken およびその他の設定パラメータを取得および設定する方法についての情報は、 「Yahoo! Ads への接続」のデスクトップ認証セクションを参照してください。)
ただし、Web 経由で接続するには、カスタムOAuth アプリケーションの作成が必要です。また、カスタムOAuth アプリケーションは、一般的に使用される3つの認証フローをすべてシームレスにサポートするため、これらの認証フロー用にカスタムOAuth アプリケーションを作成(独自のOAuth アプリケーションクレデンシャルを使用)することもできます。
カスタムOAuth アプリケーションは、次のような場合に有用です。
カスタムOAuth アプリケーションを登録してOAuth クライアントクレデンシャル、クライアントID、およびクライアントシークレットを取得するには:
新しいカスタムOAuth アプリケーションのクライアントID とクライアントシークレットが、登録プロセスで入力された情報とともに表示されます。あとで使用するためにOAutheClientId およびClientSecret を記録します。
このセクションでは、Yahoo! Ads Sync App の高度な機能を厳選して説明します。
Sync App を使用すると、事前設定されたクエリによって内容が決定されるユーザー定義ビューと呼ばれる仮想テーブルを定義できます。 このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。 カスタムビューの作成と設定の概要については、ユーザー定義ビュー を参照してください。
SSL の設定 を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。 詳しくは、接続文字列オプションにあるSSLServerCert プロパティを参照してください。
Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシ に合致するようSync App を設定します。トンネル接続を設定することもできます。
Sync App は、Yahoo! Ads にできるだけ多くのSELECT ステートメント処理をオフロードし、残りのクエリをクライアント側のインメモリで処理します。
詳しくはクエリ処理 を参照してください。
CData ログを調整するために使用可能な設定の概要については、ログ を参照してください。基本的なロギングでは、 次の2つの接続プロパティを設定するだけです。LogModules 接続プロパティを使用してログに記録する情報のサブセットを選択できる、 より洗練されたロギングをサポートする多数の機能があります。
デフォルトでは、Sync App はサーバーの証明書をシステムの信頼できる証明書ストアと照合してSSL / TLS のネゴシエーションを試みます。
別の証明書を指定するには、利用可能なフォーマットについてSSLServerCert プロパティを参照してください。
Windows のシステムプロキシ経由の接続では、接続プロパティを追加で設定する必要はありません。他のプロキシに接続するには、ProxyAutoDetect をfalse に設定します。
さらにHTTP プロキシへの認証には、ProxyServer とProxyPort に加えてProxyAuthScheme、ProxyUser、およびProxyPassword を設定します。
次のプロパティを設定します。
DisplayAds データモデルで利用可能なエンティティについては、DisplayAds データモデル を参照してください。
SearchAds データモデルで利用可能なエンティティについては、SearchAds データモデル を参照してください。
このセクションでは、利用可能なAPI オブジェクトを示し、Yahoo! Ads API へのSQL の実行について詳しく説明します。
レポートは、一度作成すると変更ができないビューとして表示されます。ただし、従来のデータベースビューとは異なり、特定のテーブルですべてのメトリクスとディメンションを選択することはあまり役に立ちません。このためプロバイダーは、SELECT * クエリはデフォルトのメトリクスとディメンションのセットが要求されていると解釈します。これは、明示的にすべてのカラムを選択しているクエリにも適用されます。
さらにYahoo! Ads API は、データに投影できるまたは返される結果を制限するために使用する、カラムの数や組み合わせを制限します。
Sync App はYahoo! Ads のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。
Name | Description |
AbTest | Create, Read, Update and Remove A/B test information. |
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. |
GuaranteedCampaigns | Read or Update 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. |
Create, Read, Update and Remove A/B test information.
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.
SELECT * FROM AbTest WHERE AccountId = '1002504155' SELECT * FROM AbTest WHERE AccountId = '1002504155' AND AbTestId = '1000000651'
Insert can be executed by specifying the AccountId, AbTestName, ACampaignId, BCampaignId, StartDate and EndDate 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 AbTest(AbTestName, ACampaignId, AccountId, BCampaignId, StartDate, EndDate) VALUES ('TestingName', 30825919, 1002504155, 30825917, '2023-04-19', '2023-04-21')
Update can be executed by specifying the AccountId and AbTestId in the WHERE Clause. The columns that are not read-only can be Updated.
For example:
UPDATE AbTest SET AbTestName = 'TestingName2' WHERE AbTestId = '1000000643' AND AccountId = '1002504155'
Delete can be executed by specifying the AccountId and AbTestId in the WHERE Clause.
For example:
DELETE FROM AbTest WHERE AbTestId = '1000000643' AND AccountId = '1002504155'
Name | Type | ReadOnly | References | Description |
AbTestId | Int64 | False |
A/B test ID. | |
AbTestName | String | False |
A/B test name. | |
ACampaignId | Int64 | False |
Campaign ID of Campaign A. | |
ACampaignName | String | False |
Campaign Name of Campaign A. | |
ACampaignUserStatus | String | False |
It describes ad delivery settings of campaign. | |
AccountId | Int64 | False |
DisplayAdsAccounts.AccountId |
Account Id. |
BCampaignId | Int64 | False |
Campaign ID of Campaign B. | |
BCampaignName | String | False |
Campaign Name of Campaign B. | |
BCampaignUserStatus | String | False |
It describes ad delivery settings of campaign. | |
Description | String | False |
Description text. | |
EndDate | String | False |
End date. | |
IsRemoveDescription | String | False |
It is a flag for removing an information item. | |
StartDate | String | False |
Start date. | |
Status | String | False |
It shows AbTestServiceStatus status. |
Perform targeting settings operations (get, add, set, replace and remove) for ad group.
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.
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 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 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 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'
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 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。PAUSED, ACTIVE, UNKNOWN | |
AppTargetDeviceAppType | String | False |
Serves application types for devices. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。WHITE_LIST, BLACKLIST, UNKNOWN | |
PositionTargetPositionType | String | False |
Serves position types of the instream video ads. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。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 | |
TargetSetting | String | False |
Displays the setting information of target. 使用できる値は次のとおりです。ACTIVE, PAUSED, NONE, UNKNOWN | |
AudienceListTargetDeliveryType | String | False |
Describes whether the subjected targeting setting is delivery target or excluded from delivery target. 使用できる値は次のとおりです。INCLUDE, EXCLUDE, UNKNOWN | |
AudienceListTargetAudienceListName | String | False |
Audience List name. | |
AudienceListTargetAudienceListNameEn | String | False |
Audience list name (Eng). | |
AudienceListTargetAudienceListType | String | False |
Type of audience list. | |
PlacementCategoryDetailTargetPlacementCategoryNameJa | String | False |
Category name (Japanese). | |
PlacementCategoryDetailTargetPlacementCategoryNameEn | String | False |
Category name (English). | |
PlacementCategoryDetailTargetPlacementCategoryType | String | False |
Describes the type of placement category. | |
ContentsTargetDeliverType | String | False |
Describes whether the subjected targeting setting is delivery target or excluded from delivery target. | |
ContentsTargetContentsKeywordListName | String | False |
Contents Keyword List name. |
Create, Read, Update or Delete the Audience list for site retargeting
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.
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 in AudienceLists can be done using temp tables.
INSERT INTO DisplayAdsAudienceListContentCombinationAudienceListRulesRuleConditions#TEMP(AccountId, CompareOperator, RuleType, Value) VALUES (1002504155, 'EQUAL', 'URL', 'Cdata.com') INSERT INTO DisplayAdsAudienceListContentRuleAudienceListRules#TEMP(AccountId, RuleConditions) VALUES (1002504155, 'DisplayAdsAudienceListContentCombinationAudienceListRulesRuleConditions#TEMP') INSERT INTO AudienceLists(AccountId, AudienceListType, AudienceListName, ContentRuleAudienceListRetargetingTagId, ContentRuleAudienceListIsOpen, ContentRuleAudienceListIsPreset, ContentRuleAudienceListReachPeriod, ContentRuleAudienceListRules) VALUES (1002504155, 'RULE', 'UpdatingRetargetingListThrice', 'YWQ5T1KH11', TRUE, FALSE, 7, 'DisplayAdsAudienceListContentRuleAudienceListRules#TEMP')
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 can be executed by specifying the AccountId and AudienceListId in the WHERE Clause.
For example.
DELETE FROM AudienceLists WHERE AudienceListId = 1003411978 AND AccountId = 1002504155
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. 使用できる値は次のとおりです。DEFAULT_LIST, COMBINATION, SIMILARITY, WEBSITE_VISITORS, CUSTOMER_DATA, APP_USER, YAHOO_JAPAN_AUDIENCE_DISCOVERY, UNKNOWN | |
ContentCombinationAudienceListCombinations | String | False |
Combination of audience list information. If targetListType is COMBINATION, this field is required in ADD and SET 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. 使用できる値は次のとおりです。TRUE, FALSE, UNKNOWN | |
ContentRuleAudienceListIsPreset | String | False |
Display the setting of history of past visit. This field is required in ADD operation. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。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 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。TRUE, FALSE, UNKNOWN | |
IsShared | Boolean | False |
Describes the sharing status of the audience list 使用できる値は次のとおりです。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. | |
DataConnectionStopped | String | False |
It shows whether or not the custom list stopped the data connection. | |
YahooJapanAudienceDiscoveryAudienceListReachPeriod | String | False |
It displays audience list (Yahoo! JAPAN Audience Discovery). | |
ContentAppUserAudienceListIsOpen | String | False |
It displays the setting of store of reaches to Audience List. | |
ContentAppUserAudienceListIsPresent | String | False |
It displays the setting of history of past visit. | |
ContentAppUserAudienceListReachPeriod | Int64 | False |
It represents Cookies validation period. (1 - 540 days). | |
ContentAppUserAudienceListRules | String | False |
It displays the possible conditions for audience list. | |
ContentAppUserAudienceListAppLinkAppId | String | False |
App Id. | |
ContentAppUserAudienceListAppLinkAppVendor | String | False |
It serves app measurement partner. | |
ContentAppUserAudienceListAppLinkLinkId | String | False |
Link ID. | |
ContentAppUserAudienceListAppLinkAppPlatform | String | False |
It displays the platform of app link. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
SharingStatusFilterType | String |
Sharing status of the Audiencet list. 使用できる値は次のとおりです。ALL, SHARED, NOT_SHARED, UNKNOWN デフォルト値はALLです。 |
ReferenceNumber | String |
This column will be used in Bulk operations to get specific values from the Temp tables. |
Get the contents keyeord list
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.
For example:
SELECT * FROM ContentsKeywordLists WHERE AccountId = '1002504155' SELECT * FROM ContentsKeywordLists WHERE ContentsKeywordListId = '1000010795'
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)
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 can be executed by specifying the AccountId and ContentsKeywordListId in the WHERE Clause.
For example:
DELETE FROM ContentsKeywordLists WHERE AccountId = '1002504155' AND ContentsKeywordListId = '1000010795'
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 使用できる値は次のとおりです。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 |
Get ConversionGroup information of specified account
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.
For example:
SELECT * FROM ConversionGroups WHERE AccountId = '1002504155' SELECT * FROM ConversionGroups WHERE ConversionGroupId = '1000010795' SELECT * FROM ConversionGroups WHERE ConversionGroupName = 'test' SELECT * FROM ConversionGroups WHERE ConversionTrackerId = '1000010795'
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 DisplayAdsConversionGroupConversions#TEMP(conversionTrackerId, ConversionTrackerType, status) VALUES (1309357, WEB_CONVERSION, ENABLED) INSERT INTO DisplayAdsConversionGroupConversions#TEMP(conversionTrackerId, ConversionTrackerType, status) VALUES (1309357, WEB_CONVERSION, ENABLED) INSERT INTO ConversionGroups (ConversionGroupName, accountid, Conversions) VALUES ('testvivek', 1002504155, 'DisplayAdsConversionGroupConversions#TEMP')
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 can be executed by specifying the AccountId and ContentsKeywordListId in the WHERE Clause.
For example:
DELETE FROM ConversionGroups WHERE AccountId = '1002504155' AND ConversionGroupId = '123456'
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 |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
ConversionTrackerId | Int64 |
Conversion Tracker ID |
Create, Update or Read account information. Restricted to some users
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.
SELECT * FROM DisplayAdsAccountManagement WHERE AccountId = '1002504155' 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 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 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'
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. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。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 | |
AutoTaggingEnabled | String | False |
Management flag for whether or not to set auto tag 使用できる値は次のとおりです。FALSE, TRUE, UNKNOWN デフォルト値は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. | |
ClientCorporateNumber | Int64 | False |
Corporate number. | |
ClientEnterpriseType | String | False |
Type of enterprise.When clientType is SELF, this field will be ignored in ADD and SET operations. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。AGENT, SELF, UNKNOWN | |
ContactBizId | String | False |
Contact Business ID. | |
DeliveryStatus | String | False |
Account delivery status. 使用できる値は次のとおりです。ACTIVE, PAUSED, UNKNOWN デフォルト値はACTIVEです。 | |
StartDate | Date | False |
Start Date. | |
EndDate | Date | False |
End Date. | |
IsTestAccount | String | False |
Account is a test account or not. 使用できる値は次のとおりです。ACTIVE, PAUSED, UNKNOWN | |
Status | String | False |
Contract status of account. 使用できる値は次のとおりです。INPROGRESS, WAIT_DECIDE, SUSPENDED, SERVING, ENDED, UNKNOWN |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
AccountStatus | String |
Account Statuses. |
AccountType | String |
Account Payment Types. |
IncludeTestAccount | String |
Control which accounts are retrieved. 使用できる値は次のとおりです。ONLY_TEST, EXCLUDE_TEST, ALL, UNKNOWN |
Read Or Update account information.
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.
SELECT * FROM DisplayAdsAccounts WHERE AccountName = 'TestAccount' SELECT * FROM DisplayAdsAccounts WHERE AccountStatus = 'SERVING' SELECT * FROM DisplayAdsAccounts WHERE AccountType = 'PREPAY' SELECT * FROM DisplayAdsAccounts WHERE IncludeTestAccount = 'ALL' SELECT * FROM DisplayAdsAccounts WHERE IncludeManagerAccount = 'ALL'
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'
Name | Type | ReadOnly | References | Description |
AccountId [KEY] | Int64 | True |
Account ID. | |
AccountName | String | False |
Account Name. | |
AccountStatus | String | False |
Account status. 使用できる値は次のとおりです。INPROGRESS, WAIT_DECIDE, SUSPENDED, SERVING, ENDED, UNKNOWN | |
AccountType | String | False |
Payment type of the account. 使用できる値は次のとおりです。PREPAY, INVOICE, 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. | |
IsMccAccount | String | False |
Describes whether it is an MCC account. | |
IsTestAccount | String | False |
Describes whether it is a Test account. | |
OptimizationScore | Double | False |
Optimization Score. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
IncludeTestAccount | String |
Accounts to retrieve 使用できる値は次のとおりです。ONLY_TEST, EXCLUDE_TEST, ALL, UNKNOWN デフォルト値はEXCLUDE_TESTです。 |
IncludeManagerAccount | String |
Represents whether the account to be retrieved includes an MCC account. 使用できる値は次のとおりです。ONLY_MANAGER, EXCLUDE_MANAGER, ALL, UNKNOWN デフォルト値はEXCLUDE_MANAGERです。 |
Get Information related to account tracking.
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.
For example:
SELECT * FROM DisplayAdsAccountTrackingUrl WHERE AccountId = '1002504155'
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'
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. 使用できる値は次のとおりです。TRUE, FALSE, UNKNOWN |
Create, Read, Update or Delete ad information
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.
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 ContainsLabel = 'True' AND LabelId IN ('5697122') SELECT * FROM DisplayAdsAdGroupAds WHERE AccountId = '123436' AND StartDate = '2021-06-03' AND EndDate = '2021-06-03'
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, Name, ApprovalStatus, CampaignId, UserStatus) values ('1002504155','437279778','TEXT_LONG_AD1','Test1','Test2','itunes.apple.com','TestHeadlines','TestName','REVIEW','30820477','ACTIVE')
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 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'
Name | Type | ReadOnly | References | Description |
AdId [KEY] | Int64 | False |
Ad ID. | |
AccountId | Int64 | False |
DisplayAdsAccounts.AccountId |
Account ID. |
AdGroupId | Int64 | False |
DisplayAdsAdGroups.AdGroupId |
Ad group ID. |
AdType | String | False |
Types of ad. 使用できる値は次のとおりです。BANNER_AD, CAROUSEL_AD, DYNAMIC_DISPLAY_AD, RESPONSIVE_AD, TEXT_AD, UNKNOWN | |
BannerAdIsRemoveVideo10SecBeaconUrls | String | False |
Flag for removing an information item. 使用できる値は次のとおりです。TRUE, FALSE, UNKNOWN | |
BannerAdIsRemoveVideo25PercentBeaconUrls | String | False |
Flag for removing an information item. 使用できる値は次のとおりです。TRUE, FALSE, UNKNOWN | |
BannerAdIsRemoveVideo3SecBeaconUrls | String | False |
Flag for removing an information item. 使用できる値は次のとおりです。TRUE, FALSE, UNKNOWN | |
BannerAdIsRemoveVideo50PercentBeaconUrls | String | False |
Flag for removing an information item. 使用できる値は次のとおりです。TRUE, FALSE, UNKNOWN | |
BannerAdIsRemoveVideo75PercentBeaconUrls | String | False |
Flag for removing an information item. 使用できる値は次のとおりです。TRUE, FALSE, UNKNOWN | |
BannerAdIsRemoveVideoCompleteBeaconUrls | String | False |
Flag for removing an information item. 使用できる値は次のとおりです。TRUE, FALSE, UNKNOWN | |
BannerAdIsRemoveVideoStartBeaconUrls | String | False |
Flag for removing an information item. 使用できる値は次のとおりです。TRUE, FALSE, UNKNOWN | |
BannerAdThumbnailMediaId | Int64 | False |
Thumbnail ID. | |
BannerAdVideo10SecBeaconUrls | String | False |
Viewing beacon URL (10 seconds). | |
BannerAdVideo25PercentBeaconUrls | String | False |
Playback viewing beacon URL (25%). | |
BannerAdVideo3SecBeaconUrls | String | False |
Viewing beacon URL (3 seconds). | |
BannerAdVideo50PercentBeaconUrls | String | False |
Playback viewing beacon URL (50%). | |
BannerAdVideo75PercentBeaconUrls | String | False |
Playback viewing beacon URL (75%). | |
BannerAdVideoCompleteBeaconUrls | String | False |
Viewing beacon URL (complete). | |
BannerAdVideoStartBeaconUrls | String | False |
Viewing beacon URL (start). | |
CarouselAdButtonText | String | False |
Displays the button text. | |
CarouselAdCarousels | String | False |
Describes the detailed information of carousel ad. | |
CarouselAdLogoMediaId | Int64 | False |
Logo image ID. | |
CarouselAdPrincipal | String | False |
Advertiser Indication of the ad. | |
CustomParametersIsRemove | String | False |
Flag for removing an information item. | |
CustomParametersParameters | String | False |
Displays the element of custom parameters. | |
DisplayUrl | String | False |
Display URL. | |
DisplayUrlLevel | String | False |
Describes a level of URL to display. 使用できる値は次のとおりです。DOMAIN, FIRST_LEVEL, UNKNOWN | |
DynamicDisplayAdBrandColor | String | False |
Brand color. | |
DynamicDisplayAdButtonText | String | False |
Displays the button text. | |
DynamicDisplayAdCampaignBannerMediaId | Int64 | False |
Campaign banner media ID. | |
DynamicDisplayAdCampaignBannerMediaId2 | Int64 | False |
Campaign banner media ID2. | |
DynamicDisplayAdCampaignBannerMediaId3 | Int64 | False |
Campaign banner media ID3. | |
DynamicDisplayAdCampaignBannerMediaId4 | Int64 | False |
Campaign banner media ID4. | |
DynamicDisplayAdCampaignBannerUrl | String | False |
Campaign banner URL. | |
DynamicDisplayAdIsRemoveBrandColor | String | False |
Flag for removing an information item. | |
DynamicDisplayAdIsRemoveCampaignBannerMediaId | String | False |
Flag for removing an information item. | |
DynamicDisplayAdIsRemoveCampaignBannerMediaId2 | String | False |
Flag for removing an information item. | |
DynamicDisplayAdIsRemoveCampaignBannerMediaId3 | String | False |
Flag for removing an information item. | |
DynamicDisplayAdIsRemoveCampaignBannerMediaId4 | String | False |
Flag for removing an information item. | |
DynamicDisplayAdIsRemoveCampaignBannerUrl | String | False |
Flag for removing an information item. | |
DynamicDisplayAdIsRemovePrefix | String | False |
Flag for removing an information item. | |
DynamicDisplayAdIsRemoveSuffix | String | False |
Flag for removing an information item. | |
DynamicDisplayAdLogoMediaId | Int64 | False |
Media ID of logo image. | |
DynamicDisplayAdLogoMediaId2 | Int64 | False |
Media ID of logo image 2. | |
DynamicDisplayAdLogoMediaId3 | Int64 | False |
Media ID of logo image 3. | |
DynamicDisplayAdPrefix | String | False |
Prefix. | |
DynamicDisplayAdPrincipal | String | False |
Advertiser Indication. | |
DynamicDisplayAdSuffix | String | False |
Suffix. | |
FinalUrl | String | False |
Final URL. | |
IsRemoveSmartphoneFinalUrl | String | False |
Flag for removing an information item. | |
IsRemoveTrackingUrl | String | False |
Flag for removing an information item. | |
MainMediaFormat | String | False |
It describes the main media format. 使用できる値は次のとおりです。IMAGE, VIDEO, NONE, UNKNOWN | |
ResponsiveAdAssetDescriptionAssets | String | False |
Represents a description asset to specify in responsive display ads. | |
ResponsiveAdAssetHeadlineAssets | String | False |
Represents a headline asset to specify in responsive display ads. | |
ResponsiveAdAssetMediaAssets | String | False |
Represents a media asset to specify in responsive display ads. | |
ResponsiveAdButtonText | String | False |
Displays the button text. | |
ResponsiveAdDescription | String | False |
Ad description. | |
ResponsiveAdHeadline | String | False |
Ad title. | |
ResponsiveAdIsRemoveLogoMediaId | String | False |
Flag for removing an information item. | |
ResponsiveAdIsRemoveVideo10SecBeaconUrls | String | False |
Flag for removing an information item. | |
ResponsiveAdIsRemoveVideo25PercentBeaconUrls | String | False |
Flag for removing an information item. | |
ResponsiveAdIsRemoveVideo3SecBeaconUrls | String | False |
Flag for removing an information item. | |
ResponsiveAdIsRemoveVideo50PercentBeaconUrls | String | False |
Flag for removing an information item. | |
ResponsiveAdIsRemoveVideo75PercentBeaconUrls | String | False |
Flag for removing an information item. | |
ResponsiveAdIsRemoveVideoCompleteBeaconUrls | String | False |
Flag for removing an information item. | |
ResponsiveAdIsRemoveVideoStartBeaconUrls | String | False |
Flag for removing an information item. | |
ResponsiveAdLogoMediaId | Int64 | False |
Logo image ID. | |
ResponsiveAdPrincipal | String | False |
Advertiser Indication of the ad. | |
ResponsiveAdThumbnailMediaId | Int64 | False |
Thumbnail ID. | |
ResponsiveAdVideo10SecBeaconUrls | String | False |
Viewing beacon URL (10 seconds). | |
ResponsiveAdVideo25PercentBeaconUrls | String | False |
Playback viewing beacon URL (25%). | |
ResponsiveAdVideo3SecBeaconUrls | String | False |
Viewing beacon URL (3 seconds). | |
ResponsiveAdVideo50PercentBeaconUrls | String | False |
Playback viewing beacon URL (50%). | |
ResponsiveAdVideo75PercentBeaconUrls | String | False |
Playback viewing beacon URL (75%). | |
ResponsiveAdVideoCompleteBeaconUrls | String | False |
Viewing beacon URL (complete). | |
ResponsiveAdVideoStartBeaconUrls | String | False |
Viewing beacon URL (start). | |
SmartphoneFinalUrl | String | False |
Final URL (smartphone). | |
TextAdDescription | String | False |
Description text (line 1). | |
TextAdDescription2 | String | False |
Description text (line 2). | |
TextAdHeadline | String | False |
Title. | |
TrackingUrl | String | False |
Tracking URL. | |
AdGroupName | String | False |
Ad group name. | |
AdName | String | False |
Ad name. | |
ApprovalStatus | String | False |
Editorial status. 使用できる値は次のとおりです。APPROVED, APPROVED_WITH_REVIEW, REVIEW, PRE_DISAPPROVED, POST_DISAPPROVED, UNKNOWN | |
CampaignId | Int64 | False |
DisplayAdsCampaigns.CampaignId |
Campaign ID. |
CampaignName | String | False |
Campaign name. | |
CreatedDate | String | False |
Date of Ad made. | |
DisapprovalReasonCodes | String | False |
Reject reason on editorial review. | |
DisapprovalReasonDescription | String | False |
Reject reason details on editorial review. | |
ImpressionBeaconUrls | String | False |
Impression beacon URL. | |
IsRemoveImpressionBeaconUrls | String | False |
Flag for removing an information item. | |
IsRemoveThirdPartyTrackingScriptUrl | String | False |
Flag for removing an information item. | |
IsRemoveViewableImpressionBeaconUrls | String | False |
Flag for removing an information item. | |
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 | True |
Third party tracking vendor. | |
UserStatus | String | False |
Delivery status that can be set by an user 使用できる値は次のとおりです。ACTIVE, PAUSED, UNKNOWN | |
ViewableImpressionBeaconUrls | String | False |
Viewable impression beacon URL. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
ContainsLabel | Boolean |
Flag of contains label ID. |
LabelId | Int64 |
Label ID. |
StartDate | Date |
start date of the search target period. |
EndDate | Date |
This is the end date of the search target period. |
Create, Read, Update or Delete Ad group
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.
SELECT * FROM DisplayAdsAdGroups WHERE AccountId = '1002504155' SELECT * FROM DisplayAdsAdGroups WHERE AccountId = '1002504155' AND AdGroupId = '437264177'
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 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 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'
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. 使用できる値は次のとおりです。MAXIMIZE_CONVERSIONS, MAXIMIZE_CLICKS, MAXIMIZE_VIDEO_VIEWS, MAXIMIZE_VIEWABLE_IMPRESSIONS, VCPM, CPC, CPV, UNKNOWN | |
CpcBiddingSchemeCpc | Int64 | False |
Max bid of ad group(CPC). | |
CpcBiddingSchemeEnhancedCpcEnabled | String | False |
Specifies flag of Maximize Conversions. If this field is TRUE, the bidding strategy on audit log is eCPC. If cpc or isRemoveCpc is specified, this field is required. | |
CpcBiddingSchemeIsRemoveCpc | Int64 | False |
It is a flag for removing an information item. | |
CpvBiddingSchemeCpv | Int64 | False |
Max bid of ad group (CPV). | |
CpvBiddingSchemeIsRemoveCpv | Int64 | False |
It is a flag for removing an information item. | |
VcpmBiddingSchemeVcpm | Int64 | False |
Max bid of ad group (vCPM). | |
VcpmBiddingSchemeIsRemoveVcpm | Int64 | False |
It is a flag for removing an information item. | |
MaximizeConversionsBiddingSchemeTargetCpa | Int64 | False |
Target CPA (tCPA) of ad group. | |
MaximizeConversionsBiddingSchemeIsRemoveTargetCpa | Int64 | False |
It is a flag for removing an information item. | |
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 使用できる値は次のとおりです。ACTIVE, PAUSED, UNKNOWN | |
CustomParametersIsRemove | String | False |
Delete flag. 使用できる値は次のとおりです。TRUE, FALSE, UNKNOWN | |
CustomParameters | String | False |
Displays the element of custom parameters. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
CampaignGoalFilterType | String |
Setting for filtering campaigns (with campaignGoal) or (with no campaignGoal). 使用できる値は次のとおりです。ALL, NON_GOAL, UNKNOWN デフォルト値はALLです。 |
ContainsLabel | Boolean |
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. |
Create or Read the download result information of operation history data file.
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.
SELECT * FROM DisplayAdsAuditLogs WHERE AccountId = '1002504155' SELECT * FROM DisplayAdsAuditLogs WHERE AccountId = '1002504155' AND JobId = '4508692'
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')
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. 使用できる値は次のとおりです。IN_PROGRESS, COMPLETED, SYSTEM_ERROR, UNKNOWN | |
Lang | String | False |
Serves the language of download data. 使用できる値は次のとおりです。JA, EN, UNKNOWN | |
Progress | Int64 | False |
Displays progress in integers from 1 to 100. | |
SourceType | String | False |
Serves update tool type of the download data. 使用できる値は次のとおりです。CAMPAIGN_MANAGEMENT_TOOL, API, YAHOO_JAPAN, ALL, UNKNOWN | |
Encoding | String | False |
It describes the encoding type (character encoding) for Operation History file. The default value will be SJIS. 使用できる値は次のとおりです。SJIS, UTF8, UNKNOWN | |
Output | String | False |
It specifies the file format of acruiqred operation history data. The default value will be CSV. 使用できる値は次のとおりです。ZIPPED_CSV, ZIPPED_TSV, CSV, TSV, UNKNOWN |
Read or Update budget information for the account.
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.
SELECT * FROM DisplayAdsBudgets WHERE AccountId = '1234'
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'
Name | Type | ReadOnly | References | Description |
AccountId [KEY] | Int64 | True |
DisplayAdsAccounts.AccountId |
Account ID. |
AccountType | String | False |
Displays the account charge type 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。SUM, MONTHLY, UNKNOWN |
Create, Read, Update or Delete information related campaigns.
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.
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 can be executed by specifying the AccountId, BudgetAmount, BiddingStrategyType, CampaignGoal, CampaignName, UserStatus, CpcBiddingSchemeCpc and CpcBiddingSchemeEnhancedCpcEnabled 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, AppOsType, BudgetAmount, BiddingStrategyType, CampaignGoal, CampaignName, UserStatus, CpcBiddingSchemeCpc, CpcBiddingSchemeEnhancedCpcEnabled) VALUES ('1002504155', 'Test_214', 'TestApp', 'ANDROID', 1500000, 'CPC', 'APP_PROMOTION', 'TestCampaign2', 'ACTIVE', 800, 'TRUE')
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 can be executed by specifying the AccountId and CampaignId in the WHERE Clause.
For example:
DELETE FROM DisplayAdsCampaigns WHERE AccountId = '1002504155' AND CampaignId = '30799754'
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. | |
BiddingStrategyType | String | False |
Setting of campaign bid strategy type 使用できる値は次のとおりです。MAXIMIZE_CONVERSIONS, MAXIMIZE_CLICKS, MAXIMIZE_VIDEO_VIEWS, MAXIMIZE_VIEWABLE_IMPRESSIONS, VCPM, CPC, CPV, UNKNOWN | |
CpcBiddingSchemeCpc | Int64 | False |
Max bid of campaign (CPC). | |
CpcBiddingSchemeEnhancedCpcEnabled | String | False |
It specifies flag of Maximize Conversions. 使用できる値は次のとおりです。TRUE, FALSE, UNKNOWN | |
CpvBiddingSchemeCpv | Int64 | False |
Max bid of campaign (CPV). | |
VcpmBiddingSchemeVcpm | Int64 | False |
Max bid of campaign (vCPM). | |
MaximizeConversionsBiddingSchemeTargetCpa | 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. 使用できる値は次のとおりです。TRUE, FALSE, UNKNOWN | |
IsRemoveConversionTrackerId | String | False |
Delete flag. 使用できる値は次のとおりです。TRUE, FALSE, UNKNOWN | |
ManualCampaignConversionOptimizerConversionOptimizerTrainingStatus | String | False |
Conversion optimizer training status. 使用できる値は次のとおりです。PROCESSING, COMPLETED, PAUSED, UNKNOWN | |
CreatedDate | Date | True |
Date of Campaign made. | |
AppOsType | String | False |
OS types for devices to be posted on.If campaignGoal is APP_PROMOTION, this field is required in ADD operation. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。SERVING, ENDED, PENDING, UNKNOWN | |
Type | String | False |
Type of campaign 使用できる値は次のとおりです。STANDARD, APP, UNKNOWN | |
CustomParametersIsRemove | String | False |
Delete flag. 使用できる値は次のとおりです。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 使用できる値は次のとおりです。ACTIVE, PAUSED, UNKNOWN | |
ViewableFrequencyCapFrequencyLevel | String | False |
Frequency setting level 使用できる値は次のとおりです。CAMPAIGN, AD_GROUP, AD, UNKNOWN | |
ViewableFrequencyCapFrequencyTimeUnit | String | False |
Frequency setting period. 使用できる値は次のとおりです。DAY, WEEK, MONTH, UNKNOWN | |
ViewableFrequencyCapVImps | Int64 | False |
Maximum number of ad viewable impressions to same user. | |
OptimizationScore | Double | False |
Optimization score. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
CampaignGoalFilterType | String |
Campaigns with campaignGoal or with no campaignGoal 使用できる値は次のとおりです。ALL, NON_GOAL, GOAL, UNKNOWN デフォルト値はALLです。 |
CampaignType | String |
Type of campaign 使用できる値は次のとおりです。STANDARD, APP, UNKNOWN |
ContainsLabel | 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. |
Create, Read or Update ConversionTracker information.
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.
SELECT * FROM DisplayAdsConversionTrackers WHERE AccountId = '1002504155' SELECT * FROM DisplayAdsConversionTrackers WHERE AccountId = '1002504155' AND ConversionTrackerId = '1307071'
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 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'
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. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。FIRST_OPEN, UNKNOWN デフォルト値はFIRST_OPENです。 | |
AppId | String | False |
App ID of the object to be tracked. | |
Category | String | False |
Category for ConversionTracker 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。WEB_CONVERSION, APP_CONVERSION, IMPORT_CONVERSION, UNKNOWN | |
ConversionValue | String | False |
Conv. value/conv. | |
ConversionValueViaAdClick | String | False |
Conv. value (via click). | |
CountingType | String | False |
conversion measurement method 使用できる値は次のとおりです。ONE_PER_CLICK, MANY_PER_CLICK, UNKNOWN | |
CrossDeviceConversions | Int64 | False |
Cross-device conv. | |
ExcludeFromBidding | String | False |
use or not for auto bidding. 使用できる値は次のとおりです。FALSE, TRUE, UNKNOWN デフォルト値は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. デフォルト値は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 デフォルト値は1です。 | |
MostRecentConversionDate | Date | False |
The date of the most recent conversion. | |
Status | String | False |
ConversionTracker status 使用できる値は次のとおりです。ENABLED, DISABLED, UNKNOWN | |
UserRevenueValue | Int64 | False |
Revenue value for Conversions.The default value in ADD operation will be 0. デフォルト値は0です。 | |
ViewThroughConversions | Int64 | False |
View through conversions | |
WebConversionSnippet | String | False |
Type of tracking script | |
IsPreviousConversion | String | False |
It is a flag that indicates whether to include conversion tracker information that includes conversion tag which conversion label is not set. | |
AdvancedMatchingEnabled | String | False |
It is management flag for whether or not to use advanced matching. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
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 使用できる値は次のとおりです。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, REALTIME_LAST25MONTH, REALTIME_LAST37MONTH, CUSTOM_DATE, UNKNOWN |
ReferenceNumber | String |
This column will be used in Bulk operations to get specific values from the Temp tables. |
Create, Read, Update or delete Feed information
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.
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 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 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 can be executed by specifying the AccountId and FeedId in the WHERE Clause.
For example:
DELETE FROM DisplayAdsFeeds WHERE AccountId = '1002504155' AND FeedId = '1002504155'
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. 使用できる値は次のとおりです。FTP_SCHEDULE, FTP_DIRECT, API, FTP_AND_API, CAMPAIGN_MANAGEMENT_TOOL, UNKNOWN | |
UploadLimitControlType | String | True |
Control type 使用できる値は次のとおりです。UPLOAD_COUNT_LIMIT, FILE_ROWS_LIMIT, FILE_SIZE_LIMIT_COMPRESS, FILE_SIZE_LIMIT_UNCOMPRESS, UNKNOWN | |
UploadLimitValue | Int64 | True |
Number of limit. |
Create, Read, Update or Delete information of label.
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.
For example:
SELECT * from DisplayAdsLabels WHERE AccountId = '1234' SELECT * from DisplayAdsLabels WHERE AccountId = '1234' AND LabelId = '266841'
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 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 can be executed by specifying the AccountId and LabelId in the WHERE Clause.
For example:
DELETE DisplayAdsLabels WHERE AccountId = '1234' AND LabelId = '266841'
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. |
Create, Read or Delete a Report.
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.
SELECT * from DisplayAdsReports WHERE AccountId = '1234'
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 can be executed by specifying the ReportJobId and AccountId in the WHERE Clause.
For example:
DELETE DisplayAdsReports WHERE AccountId = '1234' AND ReportJobId = '266841'
Name | Type | ReadOnly | References | Description |
ReportJobId [KEY] | Int64 | True |
Report Job ID. | |
AccountId | Int64 | True |
DisplayAdsAccounts.AccountId |
Account ID. |
ReportJobStatus | String | False |
The process status for the defined report. 使用できる値は次のとおりです。WAIT, COMPLETED, IN_PROGRESS, FAILED, UNKNOWN | |
CompleteTime | Datetime | False |
The date and time of Job completion. | |
DateRangeStartDate | Date | False |
The compilation start date. This field is required if DateRangeType is set to (CUSTOM DATE). | |
DateRangeEndDate | Date | False |
The compilation End date. This field is required if DateRangeType is set to (CUSTOM DATE). | |
Fields | String | False |
Select the fields. Available values can be referred to fieldName field of fields object obtained by getReportFields operation of ReportDefinitionService. | |
Filters | String | False |
Object displays filtering report conditions. | |
ReportCompressType | String | False |
Displays if defined download report is compressed. 使用できる値は次のとおりです。NONE, ZIP, UNKNOWN | |
ReportDateRangeType | String | False |
Displays a date range of the report. 使用できる値は次のとおりです。TODAY, YESTERDAY, LAST_7_DAYS, LAST_WEEK, LAST_14_DAYS, LAST_30_DAYS, LAST_BUSINESS_WEEK, THIS_MONTH, LAST_MONTH, CUSTOM_DATE, UNKNOWN | |
ReportDownloadEncode | String | False |
Displays a character code of the report. 使用できる値は次のとおりです。UTF8, SJIS, EUC, UTF16LE, UNKNOWN | |
ReportDownloadFormat | String | False |
Displays a file format of the report. 使用できる値は次のとおりです。CSV, XML, TSV, UNKNOWN | |
ReportIncludeDeleted | String | False |
Describes whether to output deleted items on the report or not. 使用できる値は次のとおりです。TRUE, FALSE, UNKNOWN | |
ReportJobErrorDetail | String | False |
Error details of Report Job. | |
ReportLanguage | String | False |
A language selection for report definition. 使用できる値は次のとおりです。JA, EN, UNKNOWN | |
ReportName | String | False |
Name of the report. | |
ReportDecimalPartDisplayType | String | False |
Describes the display type of the decimal item. 使用できる値は次のとおりです。FULL_DISPLAY, SIMPLE_DISPLAY, UNKNOWN デフォルト値はSIMPLE_DISPLAYです。 | |
ReportSkipColumnHeader | String | False |
A flag that indicates whether to skip the display of the header line. 使用できる値は次のとおりです。TRUE, FALSE, UNKNOWN デフォルト値はFALSEです。 | |
ReportSkipReportSummary | String | False |
A flag that indicates whether to skip the display of the total line. 使用できる値は次のとおりです。TRUE, FALSE, UNKNOWN デフォルト値はFALSEです。 | |
ConversionPathReportConditionLookbackWindow | Int64 | False |
Look back period (number of days). The lower limit of the value that can be specified is 0, and the upper limit is 90. | |
ConversionPathReportConditionIncludeViewInteraction | String | False |
A flag which indicates whether to include view interaction in Conversion Path Report. If reportType is CONVERSION_PATH, this field is required in ADD operation. 使用できる値は次のとおりです。TRUE, FALSE, UNKNOWN | |
ConversionPathReportConditionConversionPathFilters | String | False |
Describes the filter condition of Conversion Path Report. If multiple values are specified, the condition will be (AND). If reportType is CONVERSION_PATH, this field is required in ADD operation. 使用できる値は次のとおりです。TRUE, FALSE, UNKNOWN | |
ConversionPathReportConditionConversionPathAccountSettingsBaseAccountAaccountId | Int64 | False |
Account ID. | |
ConversionPathReportConditionConversionPathAccountSettingsBaseAccountAproductType | String | False |
Describes product type of the account. 使用できる値は次のとおりです。YDA, YSA, UNKNOWN | |
ConversionPathReportConditionConversionPathAccountSettingsSubAccounts | String | False |
Object describes account and its product type. | |
CrossCampaignReachesReportConditionCrossCampaignType | String | False |
Indicates the combination type of Cross-campaign Reach Report. If reportType is CROSS_CAMPAIGN_REACHES, this field is required in ADD operation. * At least two elements are required for crossCampaignIds, crossCampaignGoals, and crossCampaignBuyingTypes. * Up to 3 elements can be specified for crossCampaignIds, crossCampaignGoals, and crossCampaignBuyingTypes. 使用できる値は次のとおりです。CAMPAIGN_ID, CAMPAIGN_GOAL, CAMPAIGN_BUYING_TYPE, UNKNOWN | |
CrossCampaignReachesReportConditionCrossCampaignIds | String | False |
Indicates account and campaign ID that is subject to Cross-campaign Reach Report combination. If crossCampaignType is CAMPAIGN_ID, this field is required in ADD operation. | |
CrossCampaignReachesReportConditionCrossCampaignGoals | String | False |
Indicates account and campaign goal that is subject to Cross-campaign Reach Report combination. If crossCampaignType is CAMPAIGN_GOAL, this field is required in ADD operation. | |
CrossCampaignReachesReportConditioncrossCampaignBuyingTypes | String | False |
Indicates account and campaign purchase type that is subject to Cross-campaign Reach Report combination. If crossCampaignType is CAMPAIGN_BUYING_TYPE, this field is required in ADD operation. | |
ReachReportConditionFrequencyRange | String | False |
Serves measurement range of reach frequency. If specified GUARANTEED_CAMPAIGN_PERIOD, GUARANTEED_CAMPAIGN_PERIOD must be specified for reportDateRangeType as well. Lifetime means the entire period from the start to the end of the guaranteed campaign. If reportType is REACH, this field is required in ADD operation. 使用できる値は次のとおりです。DAILY, WEEKLY, MONTHLY, GUARANTEED_CAMPAIGN_PERION, UNKNOWN | |
ReportTypeConditionReportType | String | False |
Serves category type of report. Conversion Path Report: CONVERSION_PATH, Cross-campaign Reach Report: CROSS_CAMPAIGN_REACHES, Reach Frequency Report: FREQUENCY, Reach Report: REACH. Only CONVERSION_PATH,CROSS_CAMPAIGN_REACHES,FREQUENCY and REACH can be specified in ADD operation. 使用できる値は次のとおりです。AD, AUDIENCE_CATEGORY, CONVERSION_PATH, CROSS_CAMPAIGN_REACHES, FREQUENCY, INTEREST_CATEGORY, SITE_RETARGETING, SEARCH_TARGET, PLACEMENT_TARGET, LABEL, SITE_CATEGORY, REACH, URL, UNKNOWN | |
RequestTime | Datetime | False |
Start time of Report Job request. | |
SortFields | String | False |
Describes sort details of report definition. | |
ReportIncludeDeleted | String | False |
Describes whether to output deleted items on the report or not. 使用できる値は次のとおりです。TRUE, FALSE, UNKNOWN |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
ReferenceNumber | String |
This column will be used in Bulk operations to get specific values from the Temp tables. |
Create, Read or Update FTP setting information.
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.
For example, the following queries are processed server side:
SELECT * FROM FeedFtp WHERE AccountId = '123436'
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 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'
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. 使用できる値は次のとおりです。INACTIVE, ACTIVE, UNKNOWN デフォルト値はACTIVEです。 | |
FeedUrl | String | False |
URL of item list file. | |
ItemListUploadType | String | False |
Displays the upload type of Item List file. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。HOURLY, DAILY, WEEKLY, UNKNOWN | |
ScheduleWeeklyScheduleWeek | String | False |
Serves the days of the week. 使用できる値は次のとおりです。SUN, MON, TUE, WED, THU, FRI, SAT, UNKNOWN | |
ScheduleWeeklyTime | Int64 | False |
Execution time. | |
UserName | String | False |
User name. | |
UserPassword | String | False |
Password. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
ReferenceNumber | String |
This column will be used in Bulk operations to get specific values from the Temp tables. |
Create, Read or delete Item Set information.
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.
SELECT * FROM FeedSets WHERE AccountId = '1002504155' AND FeedId = '1132453'
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 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'
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. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
ReferenceNumber | String |
This column will be used in Bulk operations to get specific values from the Temp tables. |
Read or Update guaranteed campaign.
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.
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 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'
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. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。TRUE, FALSE, UNKNOWN | |
IsRemoveConversionTrackerId | Datetime | False |
GuaranteedCampaignServiceIsRemoveFlg is a flag for removing an information item 使用できる値は次のとおりです。TRUE, FALSE, UNKNOWN | |
CampaignGoal | String | False |
Campaign goal. | |
CampaignName | String | False |
Campaign Name. | |
StartDate | Date | False |
Start date. | |
EndDate | Date | False |
End date. | |
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. | |
NotificationEmailAddress | String | False |
Email address to send notifications. | |
PackagePackageHistoryId | Int64 | False |
Package ID. | |
PackagePackageId | Int64 | False |
Package history ID. | |
PackagePackageName | String | False |
Package Name. | |
ServingStatus | String | False |
Display the campaign status, regardless of userStatus setting. 使用できる値は次のとおりです。SERVING, ENDED, PENDING, UNKNOWN | |
UserStatus | String | False |
Serves ad delivery status that can be set by an user. 使用できる値は次のとおりです。ACTIVE, PAUSED, UNKNOWN | |
ViewableFrequencyCapFrequencyLevel | String | False |
Frequency setting level. 使用できる値は次のとおりです。CAMPAIGN, UNKNOWN | |
ViewableFrequencyCapFrequencyTimeUnit | String | False |
Frequency setting period. 使用できる値は次のとおりです。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. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
ReferenceNumber | String |
This column will be used in Bulk operations to get specific values from the Temp tables. |
Create, Read, Update or delete the media submission.
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.
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 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')
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 can be executed by specifying the AccountId and MediaId in the WHERE Clause.
For example:
DELETE FROM Media WHERE Accountid = '1002504155' AND MediaId = '123456'
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. 使用できる値は次のとおりです。POST_DISAPPROVED, APPROVED, REVIEW, PRE_DISAPPROVED, UNKNOWN | |
CampaignBannerFlg | String | False |
Displays the flag settings of Campaign banner image. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。GIF, PNG, JPEG, UNKNOWN | |
ImageMediaMediaType | String | False |
Serves the type of media. 使用できる値は次のとおりです。IMAGE, ANIMATION_IMAGE, UNKNOWN | |
ImageMediaWidth | Int64 | False |
The width of image. | |
LogoFlg | String | False |
Displays the flag settings of Logo image. 使用できる値は次のとおりです。FALSE, TRUE, UNKNOWN | |
MediaName | String | False |
File name. | |
MediaRichFormatFlg | String | False |
Displays the flag settings of rich format image of guaranteed campaign. 使用できる値は次のとおりです。TRUE, FALSE, UNKNOWN | |
MediaTitle | String | False |
Image name. | |
ThumbnailFlg | String | False |
Displays the setting flag for the thumbnail image. 使用できる値は次のとおりです。FALSE, TRUE, UNKNOWN | |
UserStatus | String | False |
Serves ad delivery status that can be set by an user. 使用できる値は次のとおりです。ACTIVE, PAUSED, UNKNOWN | |
ImageMediaUpscaleImageEnabled | Boolean | False |
It displays the flag settings of automatic image up-conversion. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
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. |
Create, Read, Update or Delete the placement URL list.
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.
For example:
SELECT * FROM PlacementUrlLists WHERE AccountId = '1002504155' SELECT * FROM PlacementUrlLists WHERE AccountId = '1002504155' AND UrlListId = '1000908843'
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 DisplayAdsPlacementUrlListUrls#TEMP(PlacementUrl) VALUES ('cdata.com') INSERT INTO PlacementUrlLists(AccountId, UrlListName, Urls) VALUES ('1002504155', 'Testurl', 'DisplayAdsPlacementUrlListUrls#TEMP')
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 DisplayAdsPlacementUrlListUrls#TEMP(PlacementUrl) VALUES ('cdata.com'); UPDATE PlacementUrlLists SET UrlListName = 'Cdata' WHERE AccountId = '1002504155' AND UrlListId = '1000908844'
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'
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. デフォルト値はFALSEです。 | |
Description | String | False |
Url List Description. | |
IsRemoveDescription | String | False |
Flag for removing an information item. 使用できる値は次のとおりです。TRUE, FALSE, UNKNOWN | |
UnknownDomainFlg | String | False |
Unknown Domain Flag 使用できる値は次のとおりです。TRUE, FALSE, UNKNOWN | |
UrlListName | String | False |
Url List Name. | |
Urls | String | False |
The objects to keep url |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
ReferenceNumber | String |
This column will be used in Bulk operations to get specific values from the Temp tables. |
Create or Read site retargeting tag information.
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.
For example:
SELECT * FROM RetargetingTags WHERE AccountId = '1002504155'
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')
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 使用できる値は次のとおりです。AVAILABLE, DISAPPROVED, DISAPPROVED_WITH_REVIEW, UNKNOWN |
Read, add, update or delete the search keyword list.
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.
For example:
SELECT * FROM SearchKeywordList WHERE AccountId = '1002504155' SELECT * FROM SearchKeywordList WHERE AccountId = '1002504155' AND SearchKeywordListId = '1002346070'
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 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 can be executed by specifying the AccountId and SearchKeywordListId in the WHERE Clause.
For example:
DELETE SearchKeywordList WHERE AccountId = '1002504155' AND SearchKeywordListId = '1002346070'
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. 使用できる値は次のとおりです。PAUSED, ACTIVE, UNKNOWN | |
IsRemoveSearchKeywordListDescription | String | False |
Flag for removing an information item 使用できる値は次のとおりです。TRUE, FALSE, UNKNOWN | |
KeywordFrequency | String | False |
Search frequency information on Search Keyword.The default value in ADD operation will be ONCE_OR_MORE. 使用できる値は次のとおりです。ONCE_OR_MORE, TWICE_OR_MORE, THREE_TIMES_OR_MORE, UNKNOWN デフォルト値はONCE_OR_MOREです。 | |
KeywordRecency | String | False |
Storing the effective period information of Search Keyword.The default value in ADD operation will be WITHIN_30DAYS. 使用できる値は次のとおりです。WITHIN_1DAY, WITHIN_3DAYS, WITHIN_7DAYS, WITHIN_14DAYS, WITHIN_30DAYS, UNKNOWN デフォルト値は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. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
ReferenceNumber | String |
This column will be used in Bulk operations to get specific values from the Temp tables. |
Read, Update or Delete Video Ads.
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.
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 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 can be executed by specifying the AccountId and MediaId in the WHERE Clause. For example:
DELETE FROM Videos WHERE AccountId = '1002504155' AND MediaId = '123456'
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. 使用できる値は次のとおりです。APPROVED, REVIEW, PRE_DISAPPROVED, POST_DISAPPROVED, UNKNOWN | |
CreatedDate | Date | True |
Date when the video was made. | |
CreatedDateTime | 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 使用できる値は次のとおりです。PROCESSING, FINISHED, FAILED, UNKNOWN | |
UserStatus | String | False |
Ad delivery status that can be set by an user. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。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. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
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. |
ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。
クエリは、ビューに対して通常のテーブルと同様に実行することができます。
Name | Description |
AccountAuthorities | Get account authority information. |
AdGroupAdResponsiveAdAssetDescriptionAssets | Represents a description asset to specify in responsive display ads. |
AdGroupAdResponsiveAdAssetHeadlineAssets | Represents a headline asset to specify in responsive display ads. |
AdGroupAdResponsiveAdAssetMediaAssets | Represents a media asset to specify in responsive display ads. |
AppLinkService | Get the app link information. |
AudienceCategories | Get the list of audience category |
AudienceListContentAppUserAudienceListRules | Retrieve the details of ContentAppUserAudience List Rules. The columns values set read-only false can be inserted in the parent table using Temp tables. |
AudienceListContentAppUserAudienceListRulesRuleConditions | Retrieve the details of AudienceListContentAppUserAudienceListRules Rules RuleConditions. The columns values set read-only false can be inserted in the parent table using Temp tables. |
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 |
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. |
DisplayAdsBaseAccount | Get lists of all accounts (MCC and ad accounts). |
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. |
DisplayAdsOfflineConversion | Get registered offline conversion data information. |
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. |
GuaranteedAdGroupAdBrandPanelPanoramaPanelSwitchPanels | Retreived detailed information of Brand Panel Panorama Panel-switch ad. |
GuaranteedAdGroupAdCarouselAdCarousels | Retreived detailed information of carousel ad. |
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. |
GuaranteedAdGroupAds | Create, Read, Update guaranteed ad and use AdGroupAd/remove to delete the guaranteed ad. |
GuaranteedAdGroupAdTopImpactPanoramaPanelSwitchPanels | Retreived detailed information of top impact Panorama Panel-switch ad. |
GuaranteedAdGroupLabels | Retrieve the details of GuaranteedAdGroup Labels. The columns values set read-only false can be inserted in the parent table using Temp tables. |
GuaranteedAdGroups | Create, Read, Update guaranteed ad group and use AdGroup/remove to delete the guaranteed ad group. |
GuaranteedCampaignLabels | Retrieve the details of GuaranteedCampaigns Labels. 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. |
RecommendationAdGroupsForAddingAdsList | Retrieve the detailed information of recommendations about the ad group with recommended image sizes. |
RecommendationAdGroupsForAddingAdsListAdGroupList | Retrieve the detailed information of recommendations about the ad group with recommended image sizes. |
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. |
RecommendationCreateAdCreateAdList | Retrieve the detailed information about a recommendation for creating ads. |
RecommendationCreateAdGroupCreateAdGroupList | Retrieve the detailed information of ads that have recommendation for creating ad groups. |
RecommendationCreateResponsiveDisplayAdCreateResponsiveDisplayAdsList | Retrieve the detailed information about a recommendation for Responsive Ads for Display. |
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. |
RecommendationDailyBudgetSmallCampaignList | Retrieve the detailed information of recommendations about the campaign with less than 5,000 JPY daily budget. |
RecommendationDuplicateTargetingSettingsAdGroupList | Retrieve the detailed information of recommendations about the ad group with duplicate targeting settings. |
RecommendationDuplicateTargetingSettingsAdGroupListAdGroupList | Retrieve the detailed information of recommendations about the ad group with duplicate targeting settings. |
RecommendationEnhancedCpcEnhancedCpcCampaignList | Retrieve the detailed information of ads that have recommendation information about the campaign that is suitable for using enhanced CPC. |
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. |
RecommendationInsufficientAdScheduleTargetingCampaignList | Retrieve the detailed information of recommendations about the campaign that have days of the week with less than six hours available for ad delivery. |
RecommendationInsufficientClicksCampaignList | Retrieve the detailed information of recommendations about the campaign that need to increase clicks. |
RecommendationInsufficientConversionsCampaignList | Retrieve the detailed information of recommendations about the campaign that need to increase conversions. |
RecommendationInsufficientTargetingCampaignList | Retrieve the detailed information about the campaign that too narrow down the targeting. |
RecommendationInsufficientVideoViewsCampaignList | Retrieve the detailed information of Recommendations about the campaign that need to increase video views. |
RecommendationMaximizeClicksMaximizeClicksCampaignList | Retrieve the detailed information of Recommendations about the campaign that is suitable for using autobidding (Maximize Clicks). |
RecommendationMaximizeConversionsMaximizeConversionsCampaignList | Retrieve the detailed information of Recommendations about the campaign that is suitable for using autobidding (Maximize Conversions). |
RecommendationMaximizeVideoViewsMaximizeVideoViewsCampaignList | Retrieve the detailed information of Recommendations about the campaign that is suitable for using autobidding (Maximize Video Views). |
RecommendationNotOptimalAdCountCombinedAdTypeAndImageSizeAdGroupList | Retrieve the detailed information of recommendations about the ad group that have other than 3-5 ads that combine a specific ad type and image size. |
RecommendationNotOptimalAdCountCombinedAdTypeAndImageSizeAdGroupListAdGroupList | Retrieve the detailed information of recommendations about the ad group that have other than 3-5 ads that combine a specific ad type and image size. |
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. |
RecommendationUpdateAdCreativeUpdateAdCreativeList | Retrieve the detailed information of ads that have recommendations for updating images or videos. |
ReportDisplayAdsAd | To view the Ad report. Simple Select statement will create and retrieve last 7 days report |
ReportDisplayAdsAudience_category | To view the Audience_category report. Simple Select statement will create and retrieve last 7 days report |
ReportDisplayAdsConversion_path | To view the Conversion_path report. Simple Select statement will create and retrieve last 7 days report |
ReportDisplayAdsCross_campaign_reaches | To view the Cross_campaign_reaches report. Simple Select statement will create and retrieve last 7 days report |
ReportDisplayAdsLabel | To view the Label report. Simple Select statement will create and retrieve last 7 days report |
ReportDisplayAdsPlacement_target | To view the Placement_target report. Simple Select statement will create and retrieve last 7 days report |
ReportDisplayAdsReach | To view the Reach report. Simple Select statement will create and retrieve last 7 days report |
ReportDisplayAdsSearch_target | To view the Search_target report. Simple Select statement will create and retrieve last 7 days report |
ReportDisplayAdsSite_category | To view the Site_category report. Simple Select statement will create and retrieve last 7 days report |
ReportDisplayAdsUrl | To view the Url report. Simple Select statement will create and retrieve last 7 days report |
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. |
SharedAudienceList | Get the list of shared audience list. |
SharedAudienceListMaster | Get the list of shared audience list master. |
SiteCategories | Get the list of site category. |
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. |
Get account authority information.
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.
SELECT * FROM AccountAuthorities WHERE AccountId = '1002504155'
Name | Type | References | Description |
AccountId [KEY] | Int64 |
DisplayAdsAccounts.AccountId | Account ID. |
Authorities | String | Account authority. |
Represents a description asset to specify in responsive display ads.
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.
SELECT * FROM AdGroupAdResponsiveAdAssetDescriptionAssets WHERE AccountId = '125466' SELECT * FROM AdGroupAdResponsiveAdAssetDescriptionAssets WHERE AccountId = '123436' AND AdId IN ('4561', '6996')
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
使用できる値は次のとおりです。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
使用できる値は次のとおりです。ACTIVE, PAUSED, UNKNOWN | |
Text | String | Description text.. | |
DisapprovalReasonCodes | String | Reject reason on editorial review. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
CampaignGoalFilterType | String | Setting for filtering campaigns (with campaignGoal) or (with no campaignGoal).
使用できる値は次のとおりです。ALL, NON_GOAL, UNKNOWN デフォルト値はALLです。 | |
ContainsLabel | 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. |
Represents a headline asset to specify in responsive display ads.
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.
SELECT * FROM AdGroupAdResponsiveAdAssetHeadlineAssets WHERE AccountId = '125466' SELECT * FROM AdGroupAdResponsiveAdAssetHeadlineAssets WHERE AccountId = '123436' AND AdId IN ('4561', '6996')
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
使用できる値は次のとおりです。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
使用できる値は次のとおりです。ACTIVE, PAUSED, UNKNOWN | |
Text | String | Description text.. | |
DisapprovalReasonCodes | String | Reject reason on editorial review. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
CampaignGoalFilterType | String | Setting for filtering campaigns (with campaignGoal) or (with no campaignGoal).
使用できる値は次のとおりです。ALL, NON_GOAL, UNKNOWN デフォルト値はALLです。 | |
ContainsLabel | 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. |
Represents a media asset to specify in responsive display ads.
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.
SELECT * FROM AdGroupAdResponsiveAdAssetMediaAssets WHERE AccountId = '125466' SELECT * FROM AdGroupAdResponsiveAdAssetMediaAssets WHERE AccountId = '123436' AND AdId IN ('4561', '6996')
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
使用できる値は次のとおりです。APPROVED, APPROVED_WITH_REVIEW, REVIEW, PRE_DISAPPROVED, POST_DISAPPROVED, UNKNOWN | |
CampaignId | Int64 |
DisplayAdsCampaigns.CampaignId | Campaign ID |
MediaId | Int64 |
Media.MediaId | Media ID |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
CampaignGoalFilterType | String | Setting for filtering campaigns (with campaignGoal) or (with no campaignGoal).
使用できる値は次のとおりです。ALL, NON_GOAL, UNKNOWN デフォルト値はALLです。 | |
ContainsLabel | 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. |
Get the app link information.
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.
SELECT * FROM AppLinkService WHERE AccountId = '125466' SELECT * FROM AppLinkService WHERE AccountId = '123436' AND LinkId IN ('4561', '6996')
Name | Type | References | Description |
AppId [KEY] | String | App Id. | |
AccountId | Int64 |
DisplayAdsAccounts.AccountId | Account Id. |
AppLinkStatus | String | It shows AppLink status.
使用できる値は次のとおりです。ENABLED, DISABLED, UNKNOWN | |
AppPlatform | String | It displays the platform of app link.
使用できる値は次のとおりです。IOS, ANDROID, UNKNOWN | |
AppVendor | String | It serves app measurement partner.
使用できる値は次のとおりです。ADJUST, APPSFLYER, BRANCH, KOCHAVA, SINGULAR, METAPS, UNKNOWN | |
CategoryType | String | It displays the category type for app link. | |
LinkId | String | Link Id. |
Get the list of audience category
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.
SELECT * FROM AudienceCategories WHERE Lang = 'EN'
Name | Type | References | Description |
AudienceCategoryType | String | Audience category information
使用できる値は次のとおりです。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
使用できる値は次のとおりです。EN, JA, UNKNOWN |
Retrieve the details of ContentAppUserAudience List Rules. The columns values set read-only false can be inserted in the parent table using Temp tables.
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.
For example:
SELECT * FROM AudienceListContentAppUserAudienceListRules WHERE AccountId = '1234339' SELECT * FROM AudienceListContentAppUserAudienceListRules WHERE AccountId = '1234339' AND AudienceListId = '1003039071'
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. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
SharingStatusFilterType | String | sharing status of the target list.
使用できる値は次のとおりです。ALL, SHARED, NOT_SHARED, UNKNOWN デフォルト値はALLです。 |
Retrieve the details of AudienceListContentAppUserAudienceListRules Rules RuleConditions. The columns values set read-only false can be inserted in the parent table using Temp tables.
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.
For example:
SELECT * FROM AudienceListContentAppUserAudienceListRulesRuleConditions WHERE AccountId = '1234339' SELECT * FROM AudienceListContentAppUserAudienceListRulesRuleConditions WHERE AccountId = '1234339' AND AudienceListId = '1003039071'
Name | Type | References | Description |
AudienceListId | Int64 | Audience List ID. | |
AccountId | Int64 |
DisplayAdsAccounts.AccountId | Account ID. |
CompareOperator | String | Types of rule conditions.
使用できる値は次のとおりです。EQUAL, INCLUDED, START_WITH, END_WITH, NOT_EQUAL, NOT_INCLUDED, NOT_START_WITH, NOT_END_WITH, UNKNOWN | |
RuleType | String | Type of the rule.
使用できる値は次のとおりです。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. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
SharingStatusFilterType | String | sharing status of the target list.
使用できる値は次のとおりです。ALL, SHARED, NOT_SHARED, UNKNOWN デフォルト値はALLです。 |
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.
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.
For example:
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'
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.
使用できる値は次のとおりです。OR, AND, NOTIN, UNKNOWN |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
SharingStatusFilterType | String | Sharing status of the Audience list.
使用できる値は次のとおりです。ALL, SHARED, NOT_SHARED, UNKNOWN デフォルト値はALLです。 |
Retrieve the details of Audience list. The columns values set read-only false can be inserted in the parent table using Temp tables.
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.
For example:
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'
Name | Type | References | Description |
AudienceListId | Int64 | Audience List ID. | |
AccountId | Int64 |
DisplayAdsAccounts.AccountId | Account ID. |
AudienceListName | String | Audience List Names. | |
AudienceListNameEn | String | Audience List Name (Eng) that is subject to the combination. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
SharingStatusFilterType | String | sharing status of the target list.
使用できる値は次のとおりです。ALL, SHARED, NOT_SHARED, UNKNOWN デフォルト値はALLです。 |
Retrieve the details of AudienceList Rules RuleConditions. The columns values set read-only false can be inserted in the parent table using Temp tables.
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.
For example:
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'
Name | Type | References | Description |
AudienceListId | Int64 | Audience List ID. | |
AccountId | Int64 |
DisplayAdsAccounts.AccountId | Account ID. |
CompareOperator | String | Types of rule conditions.
使用できる値は次のとおりです。EQUAL, INCLUDED, START_WITH, END_WITH, NOT_EQUAL, NOT_INCLUDED, NOT_START_WITH, NOT_END_WITH, UNKNOWN | |
RuleType | String | Type of the rule.
使用できる値は次のとおりです。URL, LABEL, REFERER_URL, PAGE_TYPE, ITEM_ID, ITEM_CATEGORY_ID, EVENT_TYPE, UNKNOWN | |
Value | String | Matching Rules Value. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
SharingStatusFilterType | String | sharing status of the target list.
使用できる値は次のとおりです。ALL, SHARED, NOT_SHARED, UNKNOWN デフォルト値はALLです。 |
Retrieve the details of ContentRuleAudience List Rules. The columns values set read-only false can be inserted in the parent table using Temp tables.
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.
For example:
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'
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. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
SharingStatusFilterType | String | sharing status of the target list.
使用できる値は次のとおりです。ALL, SHARED, NOT_SHARED, UNKNOWN デフォルト値はALLです。 |
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.
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.
For example:
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'
Name | Type | References | Description |
AudienceListId | Int64 | Audience List ID. | |
AccountId | Int64 |
DisplayAdsAccounts.AccountId | Account ID. |
AudienceListSize | String | Size of similarity audience list.
使用できる値は次のとおりです。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. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
SharingStatusFilterType | String | sharing status of the target list.
使用できる値は次のとおりです。ALL, SHARED, NOT_SHARED, UNKNOWN デフォルト値はALLです。 |
Retrieve the details of ContentWebsiteVisitorsAudience List Rules. The columns values set read-only false can be inserted in the parent table using Temp tables.
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.
For example:
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'
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. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
SharingStatusFilterType | String | sharing status of the target list.
使用できる値は次のとおりです。ALL, SHARED, NOT_SHARED, UNKNOWN デフォルト値はALLです。 |
Retrieve the details of ContentWebsiteVisistorsAudienceList Rules RuleConditions. The columns values set read-only false can be inserted in the parent table using Temp tables.
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.
For example:
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'
Name | Type | References | Description |
AudienceListId | Int64 | Audience List ID. | |
AccountId | Int64 |
DisplayAdsAccounts.AccountId | Account ID. |
CompareOperator | String | Types of rule conditions.
使用できる値は次のとおりです。EQUAL, INCLUDED, START_WITH, END_WITH, NOT_EQUAL, NOT_INCLUDED, NOT_START_WITH, NOT_END_WITH, UNKNOWN | |
RuleType | String | Type of the rule.
使用できる値は次のとおりです。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. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
SharingStatusFilterType | String | sharing status of the target list.
使用できる値は次のとおりです。ALL, SHARED, NOT_SHARED, UNKNOWN デフォルト値はALLです。 |
Get the BrandLift information.
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.
SELECT * FROM BrandLifts WHERE AccountId = '45896' SELECT * FROM BrandLifts WHERE AccountId = '45896' AND BrandLiftId IN ('23534', '45986') SELECT * FROM BrandLifts WHERE AccountId = '45896' AND CampaignId IN ('48855')
Name | Type | References | Description |
BrandLiftId [KEY] | Int64 | Brand Lift ID. | |
AccountId | Int64 |
DisplayAdsAccounts.AccountId | Account ID. |
ApprovalStatus | String | Approval status of survey information
使用できる値は次のとおりです。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. |
Brand lift survey contents. The columns values set read-only false can be inserted in the parent table using Temp tables.
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.
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')
Name | Type | References | Description |
BrandLiftId | Int64 | Brand Lift ID. | |
AccountId | Int64 |
DisplayAdsAccounts.AccountId | Account ID. |
ApprovalStatus | String | Approval status of survey information
使用できる値は次のとおりです。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. |
Get the list of business category
For example:
SELECT * FROM BusinessCategories;
Name | Type | References | Description |
BusinessCategoryId [KEY] | String | Business category ID. | |
BusinessCategoryName | String | Business category name. |
Retrieves the keyword for contents targeting.
SELECT * FROM ContentsKeywordIdea
Name | Type | References | Description |
ContentsKeyword | String | Contents keyword. | |
ContentsKeywordId | Integer | Contents keyword ID. | |
CreatedDate | String | Created date of keyword. | |
Volume | Integer | Number of impressions. |
Get the contents keyeord list
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.
For example:
SELECT * FROM ContentsKeywordListsContentsKeyword WHERE AccountId = '1002504155' SELECT * FROM ContentsKeywordListsContentsKeyword WHERE ContentsKeywordListId = '1000010795'
Name | Type | References | Description |
AccountId | Int64 |
DisplayAdsAccounts.AccountId | Account ID. |
ContentsKeywordId [KEY] | Integer |
ContentsKeywordIdea.AccountId | Contents keyword ID.This field is required in ADD and SET operation. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
ContentsKeywordListId | Integer | Contents keyword list ID. |
Get ConversionGroup information of specified account
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.
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'
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
使用できる値は次のとおりです。WEB_CONVERSION, APP_CONVERSION, UNKNOWN | |
Status | String | ConversionTracker status.This field is required in ADD operation, and will be optional in SET operation.
使用できる値は次のとおりです。ENABLED, DISABLED, UNKNOWN |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
ConversionGroupId | Int64 | Conversion Group ID. | |
ConversionGroupName | String | Conversion Group Name. |
Get the account link information.
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.
SELECT * FROM DisplayAdsAccountLinks WHERE MccAccountId = '1002513173' SELECT * FROM DisplayAdsAccountLinks WHERE MccAccountId = '1002513173' AND AccountStatus IN ('INPROGRESS','WAIT_DECIDE')
Name | Type | References | Description |
MccAccountId [KEY] | Int64 | MCC Account ID. | |
AccountId | Int64 |
DisplayAdsAccounts.AccountId | Account ID. |
OwnerShipType | String | Describes whether the linked account is an account within the same company. | |
AccountStatus | String | Account registration status
使用できる値は次のとおりです。INPROGRESS, WAIT_DECIDE, SUSPENDED, SERVING, ENDED, UNKNOWN |
Retrieve the information of carousel ad.
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.
SELECT * FROM DisplayAdsAdGroupAdCarouselAdCarousels WHERE AccountId = '1002504155' SELECT * FROM DisplayAdsAdGroupAdCarouselAdCarousels WHERE AccountId = '1002504155' AND AdGroupId = '437264177'
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
使用できる値は次のとおりです。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
使用できる値は次のとおりです。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 |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
CampaignGoalFilterType | String | Setting for filtering campaigns (with campaignGoal) or (with no campaignGoal).
使用できる値は次のとおりです。ALL, NON_GOAL, UNKNOWN デフォルト値はALLです。 | |
ContainsLabel | Boolean | 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. |
Retrieve the details of AdGroupAdService Labels. The columns values set read-only false can be inserted in the parent table using Temp tables
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.
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 ContainsLabel = 'True' AND LabelId IN ('5697122') SELECT * FROM DisplayAdsAdGroupAdServiceLabels WHERE AccountId = '123436' AND StartDate = '2021-06-03' AND EndDate = '2021-06-28'
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
使用できる値は次のとおりです。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
使用できる値は次のとおりです。ACTIVE, PAUSED, UNKNOWN | |
Color | String | Color. | |
Description | String | Description | |
LabelName | String | Label Name |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
CampaignGoalFilterType | String | Setting for filtering campaigns (with campaignGoal) or (with no campaignGoal).
使用できる値は次のとおりです。ALL, NON_GOAL, UNKNOWN デフォルト値はALLです。 | |
ContainsLabel | 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. |
Retrieve the details of AdGroup Labels. The columns values set read-only false can be inserted in the parent table using Temp tables.
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.
SELECT * FROM DisplayAdsAdGroupServiceLabels WHERE AccountId = '1002504155' SELECT * FROM DisplayAdsAdGroupServiceLabels WHERE AccountId = '1002504155' AND AdGroupId = '437264177'
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
使用できる値は次のとおりです。ACTIVE, PAUSED, UNKNOWN | |
Color | String | Color. | |
Description | String | Description | |
LabelName | String | Label Name |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
CampaignGoalFilterType | String | Setting for filtering campaigns (with campaignGoal) or (with no campaignGoal).
使用できる値は次のとおりです。ALL, NON_GOAL, UNKNOWN デフォルト値はALLです。 | |
ContainsLabel | 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. |
Get the account balance.
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.
SELECT * FROM DisplayAdsBalance WHERE AccountId = '1002504155'
Name | Type | References | Description |
AccountId | Int64 |
DisplayAdsAccounts.AccountId | The account ID. |
Balance | Int64 | The balance. |
Get lists of all accounts (MCC and ad accounts).
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.
For example:
SELECT * FROM DisplayAdsBaseAccount SELECT * FROM DisplayAdsBaseAccount WHERE AccountId = '1001987917' SELECT * FROM DisplayAdsBaseAccount WHERE AccountName = 'CData Software Japan 株式会社' SELECT * FROM DisplayAdsBaseAccount WHERE IncludeMccAccount = 'ONLY_MCC'
Name | Type | References | Description |
AccountId [KEY] | Int64 |
DisplayAdsAccounts.AccountId | Account ID. |
AccountName | String | Account name. | |
AccountStatus | String | Displays the account registration status. | |
AuthType | String | Access Roles. | |
HasAdminAuth | String | It indicates whether admin access is available for this account. | |
IsRootMccAccount | String | It indicates whether it is an root MCC account. | |
IsMccAccount | String | It indicates whether it is an MCC account. | |
IsTestAccount | String | It indicates whether it is a test account. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
IncludeAdminAuth | String | It indicates whether to include accounts with admin access for accounts you get.
使用できる値は次のとおりです。ONLY_ADMIN, EXCLUDE_ADMIN, UNKNOWN | |
IncludeMccAccount | String | It represents whether the account to be retrieved includes an MCC account.
使用できる値は次のとおりです。ONLY_MCC, ONLY_ROOT_MCC, ONLY_ADS_ACCOUNT, ALL, UNKNOWN | |
IncludeTestAccount | String | It represents whether the account to be retrieved includes an test account.
使用できる値は次のとおりです。ONLY_TEST, EXCLUDE_TEST, ALL, UNKNOWN |
Retrieve the details of DisplayAdsCampaign Labels. The columns values set read-only false can be inserted in the parent table using Temp tables.
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.
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'
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
使用できる値は次のとおりです。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 |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
CampaignGoalFilterType | String | Campaigns with campaignGoal or with no campaignGoal
使用できる値は次のとおりです。ALL, NON_GOAL, GOAL, UNKNOWN デフォルト値はALLです。 | |
CampaignType | String | Type of campaign
使用できる値は次のとおりです。STANDARD, APP, UNKNOWN | |
ContainsLabel | Boolean | Flag of contains label ID |
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.
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.
SELECT * FROM DisplayAdsConversionTrackerWebConversionSnippets WHERE AccountId = '1002504155' SELECT * FROM DisplayAdsConversionTrackerWebConversionSnippets WHERE AccountId = '1002504155' AND ConversionTrackerId = '1307071'
Name | Type | References | Description |
AccountId | Int64 |
DisplayAdsAccounts.AccountId | Account ID. |
ConversionTrackerId | Int64 | Conversion Tracker ID. | |
AppConversionPlatform | String | Target platform of the app conversion.
使用できる値は次のとおりです。ITUNES, ANDROID_MARKET, UNKNOWN | |
AppId | String | App ID of the object to be tracked. | |
Category | String | Category for ConversionTracker
使用できる値は次のとおりです。NONE, DEFAULT, PAGE_VIEW, PURCHASE, SIGNUP, LEAD, DOWNLOAD, UNKNOWN | |
ConversionTrackerType | String | Conversion type.
使用できる値は次のとおりです。WEB_CONVERSION, APP_CONVERSION, IMPORT_CONVERSION, UNKNOWN | |
CountingType | String | conversion measurement method
使用できる値は次のとおりです。ONE_PER_CLICK, MANY_PER_CLICK, UNKNOWN | |
ExcludeFromBidding | String | use or not for auto bidding.
使用できる値は次のとおりです。FALSE, TRUE, UNKNOWN デフォルト値はFALSEです。 | |
Status | String | ConversionTracker status
使用できる値は次のとおりです。ENABLED, DISABLED, UNKNOWN | |
AdvancedTag | String | The new format of conversion tag avoids the impacts such as changes made to the browser. | |
WebConversionSnippetType | String | Type of tracking script.
使用できる値は次のとおりです。IMG, JS, UNKNOWN |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
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
使用できる値は次のとおりです。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, REALTIME_LAST25MONTH, REALTIME_LAST37MONTH, CUSTOM_DATE, UNKNOWN |
Get the list of response from recommendation with EditorialReason.
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.
SELECT * From DisplayAdsDisapprovalReasons WHERE Lang = 'EN'
Name | Type | References | Description |
Description | String | Description of disapproval reason. | |
DisapprovalReasonCode | String | Disapproval reason code. | |
Lang | String | Language selection of the list.
使用できる値は次のとおりです。EN, JA, UNKNOWN | |
Recommendation | String | Description of recommendation | |
Title | String | Title of disapproval reason. |
Get the information list of geo targeting.
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.
For example:
SELECT * From DisplayAdsGeographicLocations WHERE Lang = 'EN' SELECT * FROM DisplayAdsGeographicLocations WHERE Lang = 'EN' AND GeographicLocationType = 'TARGETING'
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.
使用できる値は次のとおりです。JA, EN, UNKNOWN |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
GeographicLocationType | String | Describes the type of location information.
使用できる値は次のとおりです。TARGETING, FEED, UNKNOWN |
Get registered offline conversion data information.
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.
For example, the following queries are processed server side:
SELECT * FROM DisplayAdsOfflineConversion SELECT * FROM DisplayAdsOfflineConversion WHERE AccountId = '1234339' SELECT * FROM DisplayAdsOfflineConversion WHERE UploadId IN ('16688', '16672') AND AccountId = '1002504155'
Name | Type | References | Description |
AccountId | Int64 |
DisplayAdsAccounts.AccountId | The account ID. |
UploadId | Int64 | Upload ID. | |
UploadFileName | String | Upload file name. | |
UploadedDate | Datetime | Upload date and time. | |
UploadSourceType | String | It describes the operator information of operation history data. | |
ProcessStatus | String | Processing status. |
Retrieve the available report fields for a given report type.
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.
SELECT * FROM DisplayAdsReportFields WHERE ReportType = 'ACCOUNT'
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.
使用できる値は次のとおりです。AD, AUDIENCE_CATEGORY, CONVERSION_PATH, CROSS_CAMPAIGN_REACHES, AUDIENCE_LIST_TARGET, SEARCH_TARGET, PLACEMENT_TARGET, LABEL, SITE_CATEGORY, REACH, URL, MODEL_COMPARISON, CONTENT_KEYWORD_LIST, UNKNOWN |
Retrieve the details of filtering report conditions. The columns values set read-only false can be inserted in the parent table using Temp tables.
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.
SELECT * FROM DisplayAdsReportFilters WHERE AccountId = '123436'
Name | Type | References | Description |
ReportJobId | Int64 | Report Job ID. | |
ReportJobStatus | String | The process status for the defined report.
使用できる値は次のとおりです。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.
使用できる値は次のとおりです。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. |
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.
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.
SELECT * FROM DisplayAdsReportReportTypeConditionConversionPathAccountSettingSubAccounts WHERE AccountId = '123436'
Name | Type | References | Description |
ReportJobId | Int64 | Report Job ID. | |
ReportJobStatus | String | The process status for the defined report.
使用できる値は次のとおりです。WAIT, COMPLETED, IN_PROGRESS, FAILED, UNKNOWN | |
AccountId | Int64 |
DisplayAdsAccounts.AccountId | Account ID. |
ProductType | String | Product type of the account.
使用できる値は次のとおりです。YDA, YSA, UNKNOWN |
Retrieve the details of flag which indicates whether to include view interaction in Conversion Path Report.
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.
For example, the following queries are processed server side:
SELECT * FROM DisplayAdsReportReportTypeConditionConversionPathFilters WHERE AccountId='25687';
Name | Type | References | Description |
AccountId | Int64 |
DisplayAdsAccounts.AccountId | Account ID. |
ConversionPathFilterOperator | String | Indicates the filter condition item of Conversion Path Report.
使用できる値は次のとおりです。EQUALS, NOT_EQUALS, CONTAINS, NOT_CONTAINS, START_WITH, END_WITH, UNKNOWN | |
ConversionPathFilterType | String | Indicates the filter condition item of Conversion Path Report.
使用できる値は次のとおりです。CAMPAIGN_ID, CAMPAIGN_NAME, CAMPAIGN_ID, UNKNOWN | |
Values | String | Condition value. If multiple values are specified, the condition will be 'OR'. |
Retrieve the details of account and campaign goal that is subject to Cross-campaign Reach Report combination.
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.
SELECT * FROM DisplayAdsReportReportTypeConditionCrossCampaignReachesReportConditionCrossCampaignGoals WHERE AccountId = '123436'
Name | Type | References | Description |
ReportJobId | Int64 | Report Job ID. | |
ReportJobStatus | String | The process status for the defined report.
使用できる値は次のとおりです。WAIT, COMPLETED, IN_PROGRESS, FAILED, UNKNOWN | |
AccountId | Int64 |
DisplayAdsAccounts.AccountId | Account ID. |
AccountproductType | String | Product type of the account.
使用できる値は次のとおりです。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. |
Retrieve the details of condition to create each report type
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.
SELECT * FROM DisplayAdsReportReportTypeConditionCrossCampaignReachesReportConditionCrossCampaignIds WHERE AccountId = '123436'
Name | Type | References | Description |
ReportJobId | Int64 | Report Job ID. | |
ReportJobStatus | String | The process status for the defined report.
使用できる値は次のとおりです。WAIT, COMPLETED, IN_PROGRESS, FAILED, UNKNOWN | |
AccountId | Int64 |
DisplayAdsAccounts.AccountId | Account ID. |
AccountproductType | String | Product type of the account.
使用できる値は次のとおりです。DISPLAY, SEARCH, 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. |
Retrieve the sort details of report definition. The columns values set read-only false can be inserted in the parent table using Temp tables.
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.
SELECT * FROM DisplayAdsReportSortFields WHERE AccountId = '123436'
Name | Type | References | Description |
ReportJobId | Int64 | Report Job ID. | |
ReportJobStatus | String | The process status for the defined report.
使用できる値は次のとおりです。WAIT, COMPLETED, IN_PROGRESS, FAILED, UNKNOWN | |
AccountId | Int64 |
DisplayAdsAccounts.AccountId | Account ID. |
Field | String | Field of report definition. | |
ReportSortType | String | Sort condition type.
使用できる値は次のとおりです。ASC, DESC, UNKNOWN |
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.
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.
For example, the following queries are processed server side:
SELECT * FROM DisplayAdsReportTypeConditionCrossCampaignBuyingTypes WHERE AccountId='25687';
Name | Type | References | Description |
ReportJobId | Int64 | Report Job ID. | |
ReportJobStatus | String | The process status for the defined report.
使用できる値は次のとおりです。WAIT, COMPLETED, IN_PROGRESS, FAILED, UNKNOWN | |
AccountId | Int64 |
DisplayAdsAccounts.AccountId | Account ID. |
ProductType | String | Product type of the account
使用できる値は次のとおりです。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.
使用できる値は次のとおりです。AUCTION, GUARANTEED, UNKNOWN |
Get the status of uploaded item list.
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.
For example, the following queries are processed server side:
SELECT * FROM FeedData WHERE AccountId = '96473'
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. | |
FileUploadSource | String | Displays source of item list upload.
使用できる値は次のとおりです。CAMPAIGN_MANAGEMENT_TOOL, API, FTP_SCHEDULE, FTP_DIRECT, UNKNOWN | |
FileUploadStatus | String | Displays status of file upload.
使用できる値は次のとおりです。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.
使用できる値は次のとおりです。UPDATE_PART, UPDATE_ALL, UNKNOWN | |
UploadDate | Date | Upload date. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
StartDate | Date | Start date. | |
EndDate | Date | End date. |
Get Google product category that can be specified for Feed item information.
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.
SELECT * FROM FeedItemGoogleProductCategories WHERE Lang = 'JA';
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.
使用できる値は次のとおりです。EN, JA, UNKNOWN |
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.
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.
SELECT * FROM FeedSetConditionSets WHERE AccountId = '1002504155' AND FeedId = '1132453'
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.
使用できる値は次のとおりです。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. |
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.
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.
SELECT * FROM FeedSetConditionSetsOrCondition WHERE AccountId = '1002504155' AND FeedId = '1132453'
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
使用できる値は次のとおりです。EQUAL, NOT_EQUAL, GREATER_THAN_EQUALS, LESS_THAN_EQUALS, UNKNOWN | |
Value | String | Value. | |
IncludeItemCount | Boolean | number of items of Item Set. |
Get the upload status of the user list.
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.
For example:
SELECT * FROM GetUploadUserListStatus WHERE AccountId = '25647' AND AudienceListId = '25647'
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.
使用できる値は次のとおりです。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.
使用できる値は次のとおりです。IDFA, AAID, MAIL_ADDRESS, UNKNOWN | |
AccountId | Int64 | Account ID. |
Retreived detailed information of Brand Panel Panorama Panel-switch ad.
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.
For example, the following queries are processed server side:
SELECT * FROM GuaranteedAdGroupAdBrandPanelPanoramaPanelSwitchPanels WHERE AccountId = '123436'
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. |
DisplayOrder | Int64 | Panel display order. | |
FinalUrl | String | Final URL. | |
SwitchMediaId | Int64 | Media ID of switch image. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
ContainsLabelIdFlg | Boolean | Flag of contains label ID. |
Retreived detailed information of carousel ad.
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.
For example, the following queries are processed server side:
SELECT * FROM GuaranteedAdGroupAdCarouselAdCarousels WHERE AccountId = '123436'
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. |
DisplayOrder | Int64 | Carousel display order. | |
FinalUrl | String | Final URL. | |
Headline | Int64 | Ad title. | |
Description | Int64 | Ad description. | |
SmartphoneFinalUrl | Int64 | Final URL (smartphone). | |
DisapprovalReasonCodes | Int64 | Reject reason on editorial review. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
ContainsLabelIdFlg | Boolean | Flag of contains label ID. |
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.
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.
For example, the following queries are processed server side:
SELECT * FROM GuaranteedAdGroupAdGroupTargets WHERE AccountId = '123436'
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.
使用できる値は次のとおりです。MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY, UNKNOWN | |
AdScheduleTargetEndHour | Int64 | End time (hour only). | |
AdScheduleTargetStartHour | Int64 | Start time (hour only). | |
AgeTargetAge | String | Ages
使用できる値は次のとおりです。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.
使用できる値は次のとおりです。PAUSED, ACTIVE, UNKNOWN | |
AppTargetDeviceAppType | String | Application types for devices.
使用できる値は次のとおりです。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.
使用できる値は次のとおりです。DESKTOP, WAP_MOBILE, SMARTPHONE, TABLET, UNKNOWN | |
GenderTargetEstimateFlg | String | Advance delivery setting
使用できる値は次のとおりです。PAUSED, ACTIVE, UNKNOWN | |
GenderTargetGender | String | Types of Genders
使用できる値は次のとおりです。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.
使用できる値は次のとおりです。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.
使用できる値は次のとおりです。WHITE_LIST, BLACK_LIST, UNKNOWN | |
PositionTargetPositionType | String | Types of the instream video ads.
使用できる値は次のとおりです。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.
使用できる値は次のとおりです。INCLUDE, EXCLUDE, UNKNOWN | |
AudienceListTargetAudienceListName | String | Audience List name. | |
AudienceListTargetAudienceListType | String | Type of audience list.
使用できる値は次のとおりです。DEFAULT_LIST, RULE, COMBINATION, SIMILARITY, CUSTOM_AUDIENCE, WEBSITE_VISITORS, CUSTOMER_DATA, OFFERED_BY_YAHOO_JAPAN, UNKNOWN | |
SiteRetargetingTargetTargetListDeliverType | String | Type of target list type.
使用できる値は次のとおりです。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.
使用できる値は次のとおりです。NONE, ACTIVE, PAUSED, UNKNOWN | |
TargetId | String | Target ID. | |
TargetType | String | Types of targets.
使用できる値は次のとおりです。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 | |
AudienceListTargetAudienceListNameEn | String | Audience list name (Eng). |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
ContainsLabelIdFlg | Boolean | Flag of contains label ID. | |
LabelId | String | Label ID. |
Retrieve the details of GuaranteedAdGroupAds Labels. The columns values set read-only false can be inserted in the parent table using Temp tables.
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.
For example:
SELECT * FROM GuaranteedAdGroupAdLabels WHERE AccountId = '123436'
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 |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
ContainsLabelIdFlg | Boolean | Flag of contains label ID. |
Create, Read, Update guaranteed ad and use AdGroupAd/remove to delete the guaranteed ad.
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.
For example:
SELECT * FROM GuaranteedAdGroupAds WHERE AccountId = '123436'
Name | Type | References | Description |
AccountId | Integer |
DisplayAdsAccounts.AccountId | Account ID. |
AdGroupId | Integer |
GuaranteedAdGroups.AdGroupId | Ad group ID. |
AdGroupName | String | Ad group name. | |
AdId | Integer | Ad ID. | |
AdName | String | Ad name. | |
AdType | String | Describes the type of ad. | |
BannerAdCustomParametersIsRemove | String | Flag for removing an information item. | |
BannerAdCustomParametersParameters | String | Displays the element of custom parameters. | |
BannerAdDisplayUrl | String | Display URL. | |
BannerAdDisplayUrlLevel | String | Describes a level of URL to display. | |
BannerAdFinalUrl | String | Final URL. | |
BannerAdSmartphoneFinalUrl | String | Final URL (smartphone). | |
BannerAdThumbnailMediaId | Integer | Thumbnail ID. | |
BannerAdTrackingUrl | String | Tracking URL. | |
BannerAdVideo10SecBeaconUrls | String | Viewing beacon URL (10 seconds). | |
BannerAdVideo25PercentBeaconUrls | String | Playback viewing beacon URL (25%). | |
BannerAdVideo3SecBeaconUrls | String | Viewing beacon URL (3 seconds). | |
BannerAdVideo50PercentBeaconUrls | String | Playback viewing beacon URL (50%). | |
BannerAdVideo75PercentBeaconUrls | String | Playback viewing beacon URL (75%). | |
BannerAdVideoCompleteBeaconUrls | String | Viewing beacon URL (complete). | |
BannerAdVideoStartBeaconUrls | String | Viewing beacon URL (start). | |
BrandPanelPanoramaAdShrinkMainMediaId | Integer | Reduced main image. | |
BrandPanelPanoramaCustomParametersIsRemove | String | Flag for removing an information item. | |
BrandPanelPanoramaCustomParametersParameters | String | Displays the element of custom parameters. | |
BrandPanelPanoramaDisplayUrl | String | Display URL. | |
BrandPanelPanoramaDisplayUrlLevel | String | Describes a level of URL to display. | |
BrandPanelPanoramaFinalUrl | String | Final URL. | |
BrandPanelPanoramaThumbnailMediaId | Integer | Thumbnail ID. | |
BrandPanelPanoramaTrackingUrl | String | Tracking URL. | |
BrandPanelPanoramaVideo10SecBeaconUrls | String | Viewing beacon URL (10 seconds). | |
BrandPanelPanoramaVideo25PercentBeaconUrls | String | Playback viewing beacon URL (25%). | |
BrandPanelPanoramaVideo3SecBeaconUrls | String | Viewing beacon URL (3 seconds). | |
BrandPanelPanoramaVideo50PercentBeaconUrls | String | Playback viewing beacon URL (50%). | |
BrandPanelPanoramaVideo75PercentBeaconUrls | String | Playback viewing beacon URL (75%). | |
BrandPanelPanoramaVideoCompleteBeaconUrls | String | Viewing beacon URL (complete). | |
BrandPanelPanoramaVideoStartBeaconUrls | String | Viewing beacon URL (start). | |
BrandPanelPanoramaPanelSwitchAdShrinkMainMediaId | Integer | Reduced main image. | |
BrandPanelPanoramaPanelSwitchCustomParametersIsRemove | String | Flag for removing an information item. | |
BrandPanelPanoramaPanelSwitchCustomParametersParameters | String | Displays the element of custom parameters. | |
BrandPanelPanoramaPanelSwitchDisplayUrlLevel | String | Describes a level of URL to display. | |
BrandPanelPanoramaPanelSwitchFinalUrl | String | Final URL. | |
BrandPanelPanoramaPanelSwitchPanels | String | Describes detailed information of Brand Panel Panorama Panel-switch ad. | |
BrandPanelPanoramaPanelSwitchTrackingUrl | String | Tracking URL. | |
BrandPanelQuintieCustomParametersIsRemove | String | Flag for removing an information item. | |
BrandPanelQuintieCustomParametersParameters | String | Displays the element of custom parameters. | |
BrandPanelQuintieDisplayUrl | String | Display URL. | |
BrandPanelQuintieDisplayUrlLevel | String | Describes a level of URL to display. | |
BrandPanelQuintieFinalUrl | String | Final URL. | |
BrandPanelQuintieThumbnailMediaId | Integer | Thumbnail ID. | |
BrandPanelQuintieTrackingUrl | String | Tracking URL. | |
BrandPanelQuintieVideo10SecBeaconUrls | String | Viewing beacon URL (10 seconds). | |
BrandPanelQuintieVideo25PercentBeaconUrls | String | Playback viewing beacon URL (25%). | |
BrandPanelQuintieVideo3SecBeaconUrls | String | Viewing beacon URL (3 seconds). | |
BrandPanelQuintieVideo50PercentBeaconUrls | String | Playback viewing beacon URL (50%). | |
BrandPanelQuintieVideo75PercentBeaconUrls | String | Playback viewing beacon URL (75%). | |
BrandPanelQuintieVideoCompleteBeaconUrls | String | Viewing beacon URL (complete). | |
BrandPanelQuintieVideoStartBeaconUrls | String | Viewing beacon URL (start). | |
CarouselAdCarousels | String | Describes the detailed information of carousel ad. | |
CarouselAdCustomParametersIsRemove | String | Flag for removing an information item. | |
CarouselAdCustomParametersParameters | String | Displays the element of custom parameters. | |
CarouselAdDisplayUrl | String | Display URL. | |
CarouselAdDisplayUrlLevel | String | Describes a level of URL to display. | |
CarouselAdFinalUrl | String | Final URL. | |
CarouselAdLogoMediaId | Integer | Logo image ID. | |
CarouselAdPrincipal | String | Advertiser Indication of the ad. | |
CarouselAdSmartphoneFinalUrl | String | Final URL (smartphone). | |
CarouselAdTrackingUrl | String | Tracking URL. | |
InstreamAdActionAfterAdClicks | Boolean | Behavior when clicked on the ad. If true, it will transition to the final URL. | |
InstreamAdCustomParametersIsRemove | String | Flag for removing an information item. | |
InstreamAdCustomParametersParameters | String | Displays the element of custom parameters. | |
InstreamAdDisplayUrl | String | Display URL. | |
InstreamAdDisplayUrlLevel | String | Describes a level of URL to display. | |
InstreamAdFinalUrl | String | Final URL. | |
InstreamAdHeadline | String | Headline. | |
InstreamAdSmartphoneFinalUrl | String | Final URL (smartphone). | |
InstreamAdTrackingUrl | String | Tracking URL. | |
InstreamAdVideo25PercentBeaconUrls | String | Playback viewing beacon URL (25%). | |
InstreamAdVideo50PercentBeaconUrls | String | Playback viewing beacon URL (50%). | |
InstreamAdVideo75PercentBeaconUrls | String | Playback viewing beacon URL (75%). | |
InstreamAdVideoCompleteBeaconUrls | String | Viewing beacon URL (complete). | |
InstreamAdVideoStartBeaconUrls | String | Viewing beacon URL (start). | |
MainMediaFormat | String | Displays the main media format. | |
TopImpactPanoramaAdLeftSideMediaId | Integer | Left side image. | |
TopImpactPanoramaAdRightSideMediaId | Integer | Right side image. | |
TopImpactPanoramaAdShrinkMainMediaId | Integer | Reduced main image. | |
TopImpactPanoramaCustomParametersIsRemove | String | Flag for removing an information item. | |
TopImpactPanoramaCustomParametersParameters | String | Displays the element of custom parameters. | |
TopImpactPanoramaDisplayUrl | String | Display URL. | |
TopImpactPanoramaDisplayUrlLevel | String | Describes a level of URL to display. | |
TopImpactPanoramaFinalUrl | String | Final URL. | |
TopImpactPanoramaThumbnailMediaId | Integer | Thumbnail ID. | |
TopImpactPanoramaTrackingUrl | String | Tracking URL. | |
TopImpactPanoramaVideo10SecBeaconUrls | String | Viewing beacon URL (10 seconds). | |
TopImpactPanoramaVideo25PercentBeaconUrls | String | Playback viewing beacon URL (25%). | |
TopImpactPanoramaVideo3SecBeaconUrls | String | Viewing beacon URL (3 seconds). | |
TopImpactPanoramaVideo50PercentBeaconUrls | String | Playback viewing beacon URL (50%). | |
TopImpactPanoramaVideo75PercentBeaconUrls | String | Playback viewing beacon URL (75%). | |
TopImpactPanoramaVideoCompleteBeaconUrls | String | Viewing beacon URL (complete). | |
TopImpactPanoramaVideoStartBeaconUrls | String | Viewing beacon URL (start). | |
TopImpactPanoramaPanelSwitchAdShrinkMainMediaId | Integer | Reduced main image. | |
TopImpactPanoramaPanelSwitchCustomParametersIsRemove | String | Flag for removing an information item. | |
TopImpactPanoramaPanelSwitchCustomParametersParameters | String | Displays the element of custom parameters. | |
TopImpactPanoramaPanelSwitchDisplayUrlLevel | String | Describes a level of URL to display. | |
TopImpactPanoramaPanelSwitchFinalUrl | String | Final URL. | |
TopImpactPanoramaPanelSwitchPanels | String | Describes detailed information of Top Impact Panorama Panel-switch ad. | |
TopImpactPanoramaPanelSwitchTrackingUrl | String | Tracking URL. | |
TopImpactPanoramaSideSwitchAdLeftSideMediaId | Integer | Left side image. | |
TopImpactPanoramaSideSwitchAdLeftSideMediaId2 | Integer | Left side image. | |
TopImpactPanoramaSideSwitchAdRightSideMediaId | Integer | Right side image. | |
TopImpactPanoramaSideSwitchAdRightSideMediaId2 | Integer | Right side image. | |
TopImpactPanoramaSideSwitchAdShrinkMainMediaId | Integer | Reduced main image. | |
TopImpactPanoramaSideSwitchCustomParametersIsRemove | String | Flag for removing an information item. | |
TopImpactPanoramaSideSwitchCustomParametersParameters | String | Displays the element of custom parameters. | |
TopImpactPanoramaSideSwitchDisplayUrl | String | Display URL. | |
TopImpactPanoramaSideSwitchDisplayUrlLevel | String | Describes a level of URL to display. | |
TopImpactPanoramaSideSwitchFinalUrl | String | Final URL. | |
TopImpactPanoramaSideSwitchThumbnailMediaId | Integer | Thumbnail ID. | |
TopImpactPanoramaSideSwitchTrackingUrl | String | Tracking URL. | |
TopImpactPanoramaSideSwitchVideo10SecBeaconUrls | String | Viewing beacon URL (10 seconds). | |
TopImpactPanoramaSideSwitchVideo25PercentBeaconUrls | String | Playback viewing beacon URL (25%). | |
TopImpactPanoramaSideSwitchVideo3SecBeaconUrls | String | Viewing beacon URL (3 seconds). | |
TopImpactPanoramaSideSwitchVideo50PercentBeaconUrls | String | Playback viewing beacon URL (50%). | |
TopImpactPanoramaSideSwitchVideo75PercentBeaconUrls | String | Playback viewing beacon URL (75%). | |
TopImpactPanoramaSideSwitchVideoCompleteBeaconUrls | String | Viewing beacon URL (complete). | |
TopImpactPanoramaSideSwitchVideoStartBeaconUrls | String | Viewing beacon URL (start). | |
TopImpactPanoramaSideVisionAdShrinkMainMediaId | Integer | Reduced main image. | |
TopImpactPanoramaSideVisionCustomParametersIsRemove | String | Flag for removing an information item. | |
TopImpactPanoramaSideVisionCustomParametersParameters | String | Displays the element of custom parameters. | |
TopImpactPanoramaSideVisionDisplayUrl | String | Display URL. | |
TopImpactPanoramaSideVisionDisplayUrlLevel | String | Describes a level of URL to display. | |
TopImpactPanoramaSideVisionFinalUrl | String | Final URL. | |
TopImpactPanoramaSideVisionThumbnailMediaId | Integer | Thumbnail ID. | |
TopImpactPanoramaSideVisionTrackingUrl | String | Tracking URL. | |
TopImpactPanoramaSideVisionVideo25PercentBeaconUrls | String | Playback viewing beacon URL (25%). | |
TopImpactPanoramaSideVisionVideo3SecBeaconUrls | String | Viewing beacon URL (3 seconds). | |
TopImpactPanoramaSideVisionVideo50PercentBeaconUrls | String | Playback viewing beacon URL (50%). | |
TopImpactPanoramaSideVisionVideo75PercentBeaconUrls | String | Playback viewing beacon URL (75%). | |
TopImpactPanoramaSideVisionVideoCompleteBeaconUrls | String | Viewing beacon URL (complete). | |
TopImpactPanoramaSideVisionVideoStartBeaconUrls | String | Viewing beacon URL (start). | |
TopImpactPrimeDisplayDoubleAdLeftSideMediaId | Integer | Left side image. | |
TopImpactPrimeDisplayDoubleAdRightSideMediaId | Integer | Right side image. | |
TopImpactPrimeDisplayDoubleCustomParametersIsRemove | String | Flag for removing an information item. | |
TopImpactPrimeDisplayDoubleCustomParametersParameters | String | Displays the element of custom parameters. | |
TopImpactPrimeDisplayDoubleDisplayUrl | String | Display URL. | |
TopImpactPrimeDisplayDoubleDisplayUrlLevel | String | Describes a level of URL to display. | |
TopImpactPrimeDisplayDoubleFinalUrl | String | Final URL. | |
TopImpactPrimeDisplayDoubleThumbnailMediaId | Integer | Thumbnail ID. | |
TopImpactPrimeDisplayDoubleTrackingUrl | String | Tracking URL. | |
TopImpactPrimeDisplayDoubleVideo10SecBeaconUrls | String | Viewing beacon URL (10 seconds). | |
TopImpactPrimeDisplayDoubleVideo25PercentBeaconUrls | String | Playback viewing beacon URL (25%). | |
TopImpactPrimeDisplayDoubleVideo3SecBeaconUrls | String | Viewing beacon URL (3 seconds). | |
TopImpactPrimeDisplayDoubleVideo50PercentBeaconUrls | String | Playback viewing beacon URL (50%). | |
TopImpactPrimeDisplayDoubleVideo75PercentBeaconUrls | String | Playback viewing beacon URL (75%). | |
TopImpactPrimeDisplayDoubleVideoCompleteBeaconUrls | String | Viewing beacon URL (complete). | |
TopImpactPrimeDisplayDoubleVideoStartBeaconUrls | String | Viewing beacon URL (start). | |
TopImpactQuintieAdCenterMediaId | Integer | Center image. | |
TopImpactQuintieAdLeftSideMediaId | Integer | Left side image. | |
TopImpactQuintieAdRightSideMediaId | Integer | Right side image. | |
TopImpactQuintieCustomParametersIsRemove | String | Flag for removing an information item. | |
TopImpactQuintieCustomParametersParameters | String | Displays the element of custom parameters. | |
TopImpactQuintieDisplayUrl | String | Display URL. | |
TopImpactQuintieDisplayUrlLevel | String | Describes a level of URL to display. | |
TopImpactQuintieFinalUrl | String | Final URL. | |
TopImpactQuintieThumbnailMediaId | Integer | Thumbnail ID. | |
TopImpactQuintieTrackingUrl | String | Tracking URL. | |
TopImpactQuintieVideo10SecBeaconUrls | String | Viewing beacon URL (10 seconds). | |
TopImpactQuintieVideo25PercentBeaconUrls | String | Playback viewing beacon URL (25%). | |
TopImpactQuintieVideo3SecBeaconUrls | String | Viewing beacon URL (3 seconds). | |
TopImpactQuintieVideo50PercentBeaconUrls | String | Playback viewing beacon URL (50%). | |
TopImpactQuintieVideo75PercentBeaconUrls | String | Playback viewing beacon URL (75%). | |
TopImpactQuintieVideoCompleteBeaconUrls | String | Viewing beacon URL (complete). | |
TopImpactQuintieVideoStartBeaconUrls | String | Viewing beacon URL (start). | |
TopImpactSquareAdCenterMediaId | Integer | Center image. | |
TopImpactSquareAdLeftSideMediaId | Integer | Left side image. | |
TopImpactSquareAdRightSideMediaId | Integer | Right side image. | |
TopImpactSquareCustomParametersIsRemove | String | Flag for removing an information item. | |
TopImpactSquareCustomParametersParameters | String | Displays the element of custom parameters. | |
TopImpactSquareDisplayUrl | String | Display URL. | |
TopImpactSquareDisplayUrlLevel | String | Describes a level of URL to display. | |
TopImpactSquareFinalUrl | String | Final URL. | |
TopImpactSquareThumbnailMediaId | Integer | Thumbnail ID. | |
TopImpactSquareTrackingUrl | String | Tracking URL. | |
TopImpactSquareVideo10SecBeaconUrls | String | Viewing beacon URL (10 seconds). | |
TopImpactSquareVideo25PercentBeaconUrls | String | Playback viewing beacon URL (25%). | |
TopImpactSquareVideo3SecBeaconUrls | String | Viewing beacon URL (3 seconds). | |
TopImpactSquareVideo50PercentBeaconUrls | String | Playback viewing beacon URL (50%). | |
TopImpactSquareVideo75PercentBeaconUrls | String | Playback viewing beacon URL (75%). | |
TopImpactSquareVideoCompleteBeaconUrls | String | Viewing beacon URL (complete). | |
TopImpactSquareVideoStartBeaconUrls | String | Viewing beacon URL (start). | |
TopImpactTheaterAdCenterMediaId | Integer | Center image. | |
TopImpactTheaterAdLeftSideMediaId | Integer | Left side image. | |
TopImpactTheaterAdRightSideMediaId | Integer | Right side image. | |
TopImpactTheaterCustomParametersIsRemove | String | Flag for removing an information item. | |
TopImpactTheaterCustomParametersParameters | String | Displays the element of custom parameters. | |
TopImpactTheaterDisplayUrl | String | Display URL. | |
TopImpactTheaterDisplayUrlLevel | String | Describes a level of URL to display. | |
TopImpactTheaterFinalUrl | String | Final URL. | |
TopImpactTheaterThumbnailMediaId | Integer | Thumbnail ID. | |
TopImpactTheaterTrackingUrl | String | Tracking URL. | |
TopImpactTheaterVideo10SecBeaconUrls | String | Viewing beacon URL (10 seconds). | |
TopImpactTheaterVideo25PercentBeaconUrls | String | Playback viewing beacon URL (25%). | |
TopImpactTheaterVideo3SecBeaconUrls | String | Viewing beacon URL (3 seconds). | |
TopImpactTheaterVideo50PercentBeaconUrls | String | Playback viewing beacon URL (50%). | |
TopImpactTheaterVideo75PercentBeaconUrls | String | Playback viewing beacon URL (75%). | |
TopImpactTheaterVideoCompleteBeaconUrls | String | Viewing beacon URL (complete). | |
TopImpactTheaterVideoScreenshot | String | Video start position for video screenshot that appears on both sides of homepage. | |
TopImpactTheaterVideoStartBeaconUrls | String | Viewing beacon URL (start). | |
ApprovalStatus | String | Displays editorial status. | |
CampaignId | Integer | Campaign ID. | |
CampaignName | String | Campaign name. | |
DisapprovalReasonCodes | String | Reject reason on editorial review. | |
DisapprovalReasonDescription | String | Reject reason details on editorial review. | |
ImpressionBeaconUrls | String | Impression beacon URL. | |
Labels | String | Describes label information to be associated. | |
LandingPageStatus | String | Describes the status of the landing page. | |
LandingPageUpdateScheduledTime | String | The scheduled update date and time for the landing page. | |
MediaId | Integer | Media ID. | |
PreApprovalId | String | Pre-approval ID (Only number). | |
ThirdPartyTrackingScriptUrl | String | Third party tracking script URL. | |
ThirdPartyTrackingVendor | String | Third party tracking vendor (Read only). | |
UserStatus | String | Describes delivery settings. | |
ViewableImpressionBeaconUrls | String | Viewable impression beacon URL. | |
TopPageTopicsPRCustomParametersIsRemove | String | A flag for removing an information item. | |
TopPageTopicsPRCustomParametersParameters | String | Displays the element of custom parameters. | |
TopPageTopicsPRDisplayUrl | String | Display URL. | |
TopPageTopicsPRDisplayUrlLevel | String | Describes a level of URL to display. | |
TopPageTopicsPRFinalUrl | String | Final URL. | |
TopPageTopicsPRHeadline | String | Headline. | |
TopPageTopicsPRPrincipal | String | Advertiser Indication of the ad. | |
TopPageTopicsPRSmartPhoneFinalUrl | String | Final URL (smartphone). | |
TopPageTopicsPRTrackingUrl | String | Tracking URL. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
AdGroupAdId | Boolean | Ad ID. | |
ContainsLabelIdFlg | Boolean | Flag of contains label ID. | |
LabelId | String | Label ID. |
Retreived detailed information of top impact Panorama Panel-switch ad.
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.
For example, the following queries are processed server side:
SELECT * FROM GuaranteedAdGroupAdTopImpactPanoramaPanelSwitchPanels WHERE AccountId = '123436'
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. |
DisplayOrder | Int64 | Panel display order. | |
FinalUrl | String | Final URL. | |
SwitchMediaId | Int64 | Media ID of switch image. | |
AdLeftSideMediaId | Int64 | Left side image. | |
AdRightSideMediaId | Int64 | Right side image. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
ContainsLabelIdFlg | Boolean | Flag of contains label ID. |
Retrieve the details of GuaranteedAdGroup Labels. The columns values set read-only false can be inserted in the parent table using Temp tables.
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.
For example:
SELECT * FROM GuaranteedAdGroupLabels WHERE AccountId = '123436'
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 |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
ContainsLabelIdFlg | Boolean | Flag of contains label ID. |
Create, Read, Update guaranteed ad group and use AdGroup/remove to delete the guaranteed ad group.
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.
For example, the following queries are processed server side:
SELECT * FROM GuaranteedAdGroups WHERE AccountId = '123436'
Name | Type | References | Description |
AdGroupId [KEY] | Int64 | Ad Group ID. | |
AccountId | Int64 |
DisplayAdsAccounts.AccountId | Account ID. |
AdGroupName | String | Ad group name. | |
AdGroupTargets | String | Contains targeting information specified in ad group. | |
CampaignId | Int64 |
GuaranteedCampaigns.CampaignId | Campaign ID. |
CampaignName | String | Campaign name. | |
Device | String | Displays types of devices to be posted on. The allowed values are DESKTOP,SMARTPHONE,TABLET,NONE,UNKNOWN | |
DeviceApp | String | Serves application types for devices. The allowed values are APP,WEB,NONE,UNKNOWN | |
DeviceOs | String | Serves OS types for devices to be posted on. The allowed values are IOS,ANDROID,NONE,UNKNOWN | |
IsCreativeProfile | Boolean | If the value of this field is true, it indicates that the ad group was added using a creative profile. | |
Labels | String | Object describes label information to be associated. | |
UserStatus | String | Serves ad delivery status that can be set by an user.
使用できる値は次のとおりです。ACTIVE, PAUSED, UNKNOWN |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
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. |
Retrieve the details of GuaranteedCampaigns Labels. The columns values set read-only false can be inserted in the parent table using Temp tables.
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.
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'
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. |
Get an acceptable format (MediaAdFormat) of ad creatives.
The driver does not support server side filters. The rest of the filters are processed on the client side.
For example:
SELECT * FROM MediaAdFormats
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] |
Get the version of OS.
The Sync App will use the Yahoo! Ads API to process WHERE clause conditions built with the following column and operator.
For example:
SELECT * FROM OsVersions WHERE DeviceOsType = 'ANDROID'
Name | Type | References | Description |
DeviceOsType | String | Serves OS types for devices to be posted on.
使用できる値は次のとおりです。ANDROID, IOS, UNKNOWN | |
Version | String | OS Version. |
Get the candidate URL
The Sync App will use the Yahoo! Ads API to process WHERE clause conditions built with the following column and operator.
SELECT * FROM PlacementUrlIdeas
Name | Type | References | Description |
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) |
Retrieve the details of PlacementUrlLists Urls. The columns values set read-only false can be inserted in the parent table using Temp tables.
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.
For example:
SELECT * FROM PlacementUrlListUrls WHERE AccountId = '1002504155' SELECT * FROM PlacementUrlListUrls WHERE AccountId = '1002504155' AND UrlListId = '1000908843'
Name | Type | References | Description |
UrlListId | Int64 | Url List ID. | |
AccountId | Int64 |
DisplayAdsAccounts.AccountId | Account ID. |
PlacementUrl | String | Url. | |
UrlActiveFlg | String | Placement Url Active Flag.
使用できる値は次のとおりです。ACTIVE, PAUSED, UNKNOWN |
Retrieve the detailed information of recommendations about the ad group with recommended image sizes.
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.
For example:
SELECT * FROM RecommendationAdGroupsForAddingAdsList WHERE AccountId = '1002504155' AND Type = 'DAILY_BUDGET_OVER'
Name | Type | References | Description |
AccountId | Int64 |
DisplayAdsAccounts.AccountId | Account ID. |
RecommendationId | Int64 | Recommendation ID. | |
CampaignId | Int64 | Campaign ID. | |
CampaignName | String | Campaign Name. | |
AdGroupList | String | Ad group information. | |
Type | String | Type of Recommendations
使用できる値は次のとおりです。DAILY_BUDGET_OVER, IMPRESSION_SHARE_BUDGET_LOSS_OVER, BID_STRATEGY_TO_TARGET_CPA, SEARCH_KEYWORD_LIST_IDEA, MAXIMIZE_CONVERSIONS, MAXIMIZE_CLICKS, MAXIMIZE_VIDEO_VIEWS, UPDATE_AD_CREATIVE, DUPLICATE_TARGETING_SETTINGS, NOT_OPTIMAL_AD_COUNT_COMBINED_AD_TYPE_AND_IMAGE_SIZE, ADGROUPS_FOR_ADDING_ADS, DAILY_BUDGET_SMALL, INSUFFICIENT_TARGETING, INSUFFICIENT_AD_SCHEDULE_TARGETING, INSUFFICIENT_CONVERSIONS, INSUFFICIENT_CLICKS, INSUFFICIENT_VIDEO_VIEWS, UNKNOWN |
Retrieve the detailed information of recommendations about the ad group with recommended image sizes.
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.
For example:
SELECT * FROM RecommendationAdGroupsForAddingAdsListAdGroupList WHERE AccountId = '1002504155' AND Type = 'DAILY_BUDGET_OVER'
Name | Type | References | Description |
AccountId | Int64 |
DisplayAdsAccounts.AccountId | Account ID. |
AdGroupId | Int64 | Ad group ID. | |
AdGroupName | Int64 | Ad group name. | |
MediaAdFormat | String | The type of image format. | |
AdCount | String | The number of ads that use this media format. | |
Type | String | Type of Recommendations
使用できる値は次のとおりです。DAILY_BUDGET_OVER, IMPRESSION_SHARE_BUDGET_LOSS_OVER, BID_STRATEGY_TO_TARGET_CPA, SEARCH_KEYWORD_LIST_IDEA, MAXIMIZE_CONVERSIONS, MAXIMIZE_CLICKS, MAXIMIZE_VIDEO_VIEWS, UPDATE_AD_CREATIVE, DUPLICATE_TARGETING_SETTINGS, NOT_OPTIMAL_AD_COUNT_COMBINED_AD_TYPE_AND_IMAGE_SIZE, ADGROUPS_FOR_ADDING_ADS, DAILY_BUDGET_SMALL, INSUFFICIENT_TARGETING, INSUFFICIENT_AD_SCHEDULE_TARGETING, INSUFFICIENT_CONVERSIONS, INSUFFICIENT_CLICKS, INSUFFICIENT_VIDEO_VIEWS, UNKNOWN |
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.
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.
For example:
SELECT * FROM RecommendationCampaignBiddingStrategyToTargetCpaCampaignBiddingStrategyToTargetCpaCampaignList WHERE AccountId = '1002504155' AND Type = 'DAILY_BUDGET_OVER'
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
使用できる値は次のとおりです。DAILY_BUDGET_OVER, IMPRESSION_SHARE_BUDGET_LOSS_OVER, BID_STRATEGY_TO_TARGET_CPA, SEARCH_KEYWORD_LIST_IDEA, MAXIMIZE_CONVERSIONS, MAXIMIZE_CLICKS, MAXIMIZE_VIDEO_VIEWS, UPDATE_AD_CREATIVE, DUPLICATE_TARGETING_SETTINGS, NOT_OPTIMAL_AD_COUNT_COMBINED_AD_TYPE_AND_IMAGE_SIZE, ADGROUPS_FOR_ADDING_ADS, DAILY_BUDGET_SMALL, INSUFFICIENT_TARGETING, INSUFFICIENT_AD_SCHEDULE_TARGETING, INSUFFICIENT_CONVERSIONS, INSUFFICIENT_CLICKS, INSUFFICIENT_VIDEO_VIEWS, UNKNOWN |
Retrieve the detailed information about a recommendation for creating ads.
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.
For example:
SELECT * FROM RecommendationCreateAdCreateAdList WHERE AccountId = '1002504155' AND Type = 'DAILY_BUDGET_OVER'
Name | Type | References | Description |
AccountId | Int64 |
DisplayAdsAccounts.AccountId | Account ID. |
RecommendationId | Int64 | Recommendation ID. | |
CampaignId | Int64 | Campaign ID. | |
CampaignName | String | Campaign Name. | |
AdGroupId | Int64 | Ad group ID without ads. | |
AdGroupName | String | Ad group name without ads. | |
Type | String | Type of Recommendations
使用できる値は次のとおりです。DAILY_BUDGET_OVER, IMPRESSION_SHARE_BUDGET_LOSS_OVER, BID_STRATEGY_TO_TARGET_CPA, SEARCH_KEYWORD_LIST_IDEA, MAXIMIZE_CONVERSIONS, MAXIMIZE_CLICKS, MAXIMIZE_VIDEO_VIEWS, UPDATE_AD_CREATIVE, DUPLICATE_TARGETING_SETTINGS, NOT_OPTIMAL_AD_COUNT_COMBINED_AD_TYPE_AND_IMAGE_SIZE, ADGROUPS_FOR_ADDING_ADS, DAILY_BUDGET_SMALL, INSUFFICIENT_TARGETING, INSUFFICIENT_AD_SCHEDULE_TARGETING, INSUFFICIENT_CONVERSIONS, INSUFFICIENT_CLICKS, INSUFFICIENT_VIDEO_VIEWS, UNKNOWN |
Retrieve the detailed information of ads that have recommendation for creating ad groups.
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.
For example:
SELECT * FROM RecommendationCreateAdGroupCreateAdGroupList WHERE AccountId = '1002504155' AND Type = 'DAILY_BUDGET_OVER'
Name | Type | References | Description |
AccountId | Int64 |
DisplayAdsAccounts.AccountId | Account ID. |
RecommendationId | Int64 | Recommendation ID. | |
CampaignId | Int64 | Campaign ID. | |
CampaignName | String | Campaign Name. | |
Type | String | Type of Recommendations
使用できる値は次のとおりです。DAILY_BUDGET_OVER, IMPRESSION_SHARE_BUDGET_LOSS_OVER, BID_STRATEGY_TO_TARGET_CPA, SEARCH_KEYWORD_LIST_IDEA, MAXIMIZE_CONVERSIONS, MAXIMIZE_CLICKS, MAXIMIZE_VIDEO_VIEWS, UPDATE_AD_CREATIVE, DUPLICATE_TARGETING_SETTINGS, NOT_OPTIMAL_AD_COUNT_COMBINED_AD_TYPE_AND_IMAGE_SIZE, ADGROUPS_FOR_ADDING_ADS, DAILY_BUDGET_SMALL, INSUFFICIENT_TARGETING, INSUFFICIENT_AD_SCHEDULE_TARGETING, INSUFFICIENT_CONVERSIONS, INSUFFICIENT_CLICKS, INSUFFICIENT_VIDEO_VIEWS, UNKNOWN |
Retrieve the detailed information about a recommendation for Responsive Ads for Display.
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.
For example:
SELECT * FROM RecommendationCreateResponsiveDisplayAdCreateResponsiveDisplayAdsList WHERE AccountId = '1002504155' AND Type = 'DAILY_BUDGET_OVER'
Name | Type | References | Description |
AccountId | Int64 |
DisplayAdsAccounts.AccountId | Account ID. |
RecommendationId | Int64 | Recommendation ID. | |
CampaignId | Int64 | Campaign ID. | |
CampaignName | String | Campaign Name. | |
AdGroupId | Int64 | Ad group ID without ads. | |
AdGroupName | String | Ad group name without ads. | |
Type | String | Type of Recommendations
使用できる値は次のとおりです。DAILY_BUDGET_OVER, IMPRESSION_SHARE_BUDGET_LOSS_OVER, BID_STRATEGY_TO_TARGET_CPA, SEARCH_KEYWORD_LIST_IDEA, MAXIMIZE_CONVERSIONS, MAXIMIZE_CLICKS, MAXIMIZE_VIDEO_VIEWS, UPDATE_AD_CREATIVE, DUPLICATE_TARGETING_SETTINGS, NOT_OPTIMAL_AD_COUNT_COMBINED_AD_TYPE_AND_IMAGE_SIZE, ADGROUPS_FOR_ADDING_ADS, DAILY_BUDGET_SMALL, INSUFFICIENT_TARGETING, INSUFFICIENT_AD_SCHEDULE_TARGETING, INSUFFICIENT_CONVERSIONS, INSUFFICIENT_CLICKS, INSUFFICIENT_VIDEO_VIEWS, UNKNOWN |
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.
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.
For example:
SELECT * FROM RecommendationDailyBudgetSmallCampaignList WHERE AccountId = '1002504155' AND Type = 'DAILY_BUDGET_OVER'
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
使用できる値は次のとおりです。DAILY_BUDGET_OVER, IMPRESSION_SHARE_BUDGET_LOSS_OVER, BID_STRATEGY_TO_TARGET_CPA, SEARCH_KEYWORD_LIST_IDEA, MAXIMIZE_CONVERSIONS, MAXIMIZE_CLICKS, MAXIMIZE_VIDEO_VIEWS, UPDATE_AD_CREATIVE, DUPLICATE_TARGETING_SETTINGS, NOT_OPTIMAL_AD_COUNT_COMBINED_AD_TYPE_AND_IMAGE_SIZE, ADGROUPS_FOR_ADDING_ADS, DAILY_BUDGET_SMALL, INSUFFICIENT_TARGETING, INSUFFICIENT_AD_SCHEDULE_TARGETING, INSUFFICIENT_CONVERSIONS, INSUFFICIENT_CLICKS, INSUFFICIENT_VIDEO_VIEWS, UNKNOWN |
Retrieve the detailed information of recommendations about the campaign with less than 5,000 JPY daily budget.
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.
For example:
SELECT * FROM RecommendationDailyBudgetSmallCampaignList WHERE AccountId = '1002504155' AND Type = 'DAILY_BUDGET_OVER'
Name | Type | References | Description |
AccountId | Int64 |
DisplayAdsAccounts.AccountId | Account ID. |
RecommendationId | Int64 | Recommendation ID. | |
CampaignId | Int64 | Campaign ID. | |
CampaignName | String | Campaign Name. | |
CurrentAmount | String | Current campaign budget. | |
Type | String | Type of Recommendations
使用できる値は次のとおりです。DAILY_BUDGET_OVER, IMPRESSION_SHARE_BUDGET_LOSS_OVER, BID_STRATEGY_TO_TARGET_CPA, SEARCH_KEYWORD_LIST_IDEA, MAXIMIZE_CONVERSIONS, MAXIMIZE_CLICKS, MAXIMIZE_VIDEO_VIEWS, UPDATE_AD_CREATIVE, DUPLICATE_TARGETING_SETTINGS, NOT_OPTIMAL_AD_COUNT_COMBINED_AD_TYPE_AND_IMAGE_SIZE, ADGROUPS_FOR_ADDING_ADS, DAILY_BUDGET_SMALL, INSUFFICIENT_TARGETING, INSUFFICIENT_AD_SCHEDULE_TARGETING, INSUFFICIENT_CONVERSIONS, INSUFFICIENT_CLICKS, INSUFFICIENT_VIDEO_VIEWS, UNKNOWN |
Retrieve the detailed information of recommendations about the ad group with duplicate targeting settings.
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.
For example:
SELECT * FROM RecommendationDuplicateTargetingSettingsAdGroupList WHERE AccountId = '1002504155' AND Type = 'DAILY_BUDGET_OVER'
Name | Type | References | Description |
AccountId | Int64 |
DisplayAdsAccounts.AccountId | Account ID. |
RecommendationId | Int64 | Recommendation ID. | |
CampaignId | Int64 | Campaign ID. | |
CampaignName | String | Campaign Name. | |
AdGroupList | String | Ad group information. | |
Type | String | Type of Recommendations
使用できる値は次のとおりです。DAILY_BUDGET_OVER, IMPRESSION_SHARE_BUDGET_LOSS_OVER, BID_STRATEGY_TO_TARGET_CPA, SEARCH_KEYWORD_LIST_IDEA, MAXIMIZE_CONVERSIONS, MAXIMIZE_CLICKS, MAXIMIZE_VIDEO_VIEWS, UPDATE_AD_CREATIVE, DUPLICATE_TARGETING_SETTINGS, NOT_OPTIMAL_AD_COUNT_COMBINED_AD_TYPE_AND_IMAGE_SIZE, ADGROUPS_FOR_ADDING_ADS, DAILY_BUDGET_SMALL, INSUFFICIENT_TARGETING, INSUFFICIENT_AD_SCHEDULE_TARGETING, INSUFFICIENT_CONVERSIONS, INSUFFICIENT_CLICKS, INSUFFICIENT_VIDEO_VIEWS, UNKNOWN |
Retrieve the detailed information of recommendations about the ad group with duplicate targeting settings.
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.
For example:
SELECT * FROM RecommendationDuplicateTargetingSettingsAdGroupListAdGroupList WHERE AccountId = '1002504155' AND Type = 'DAILY_BUDGET_OVER'
Name | Type | References | Description |
AccountId | Int64 |
DisplayAdsAccounts.AccountId | Account ID. |
AdGroupId | Int64 | Ad group ID. | |
AdGroupName | Int64 | Ad group name. | |
MediaAdFormat | String | The type of image format. | |
AdCount | String | The number of ads that use this media format. | |
Type | String | Type of Recommendations
使用できる値は次のとおりです。DAILY_BUDGET_OVER, IMPRESSION_SHARE_BUDGET_LOSS_OVER, BID_STRATEGY_TO_TARGET_CPA, SEARCH_KEYWORD_LIST_IDEA, MAXIMIZE_CONVERSIONS, MAXIMIZE_CLICKS, MAXIMIZE_VIDEO_VIEWS, UPDATE_AD_CREATIVE, DUPLICATE_TARGETING_SETTINGS, NOT_OPTIMAL_AD_COUNT_COMBINED_AD_TYPE_AND_IMAGE_SIZE, ADGROUPS_FOR_ADDING_ADS, DAILY_BUDGET_SMALL, INSUFFICIENT_TARGETING, INSUFFICIENT_AD_SCHEDULE_TARGETING, INSUFFICIENT_CONVERSIONS, INSUFFICIENT_CLICKS, INSUFFICIENT_VIDEO_VIEWS, UNKNOWN |
Retrieve the detailed information of ads that have recommendation information about the campaign that is suitable for using enhanced CPC.
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.
For example:
SELECT * FROM RecommendationEnhancedCpcEnhancedCpcCampaignList WHERE AccountId = '1002504155' AND Type = 'DAILY_BUDGET_OVER'
Name | Type | References | Description |
AccountId | Int64 |
DisplayAdsAccounts.AccountId | Account ID. |
RecommendationId | Int64 | Recommendation ID. | |
CampaignId | Int64 | Campaign ID. | |
CampaignName | String | Campaign Name. | |
CurrentCampaignBiddingStrategyType | String | Current campaign bidding strategy type. | |
CurrentCpcBidValue | Int64 | Current max bid of campaign (CPC). Recommended max bid of campaign is the same as the current value. | |
RecommendedCampaignBiddingStrategyType | String | Recommended campaign bidding strategy type. | |
Type | String | Type of Recommendations
使用できる値は次のとおりです。DAILY_BUDGET_OVER, IMPRESSION_SHARE_BUDGET_LOSS_OVER, BID_STRATEGY_TO_TARGET_CPA, SEARCH_KEYWORD_LIST_IDEA, MAXIMIZE_CONVERSIONS, MAXIMIZE_CLICKS, MAXIMIZE_VIDEO_VIEWS, UPDATE_AD_CREATIVE, DUPLICATE_TARGETING_SETTINGS, NOT_OPTIMAL_AD_COUNT_COMBINED_AD_TYPE_AND_IMAGE_SIZE, ADGROUPS_FOR_ADDING_ADS, DAILY_BUDGET_SMALL, INSUFFICIENT_TARGETING, INSUFFICIENT_AD_SCHEDULE_TARGETING, INSUFFICIENT_CONVERSIONS, INSUFFICIENT_CLICKS, INSUFFICIENT_VIDEO_VIEWS, UNKNOWN |
Retrieve the detailed information of recommendations about the campaign that have days of the week with less than six hours available for ad delivery.
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.
For example:
SELECT * FROM RecommendationInsufficientAdScheduleTargetingCampaignList WHERE AccountId = '1002504155' AND Type = 'DAILY_BUDGET_OVER'
Name | Type | References | Description |
AccountId | Int64 |
DisplayAdsAccounts.AccountId | Account ID. |
RecommendationId | Int64 | Recommendation ID. | |
CampaignId | Int64 | Campaign ID. | |
CampaignName | String | Campaign Name. | |
Type | String | Type of Recommendations
使用できる値は次のとおりです。DAILY_BUDGET_OVER, IMPRESSION_SHARE_BUDGET_LOSS_OVER, BID_STRATEGY_TO_TARGET_CPA, SEARCH_KEYWORD_LIST_IDEA, MAXIMIZE_CONVERSIONS, MAXIMIZE_CLICKS, MAXIMIZE_VIDEO_VIEWS, UPDATE_AD_CREATIVE, DUPLICATE_TARGETING_SETTINGS, NOT_OPTIMAL_AD_COUNT_COMBINED_AD_TYPE_AND_IMAGE_SIZE, ADGROUPS_FOR_ADDING_ADS, DAILY_BUDGET_SMALL, INSUFFICIENT_TARGETING, INSUFFICIENT_AD_SCHEDULE_TARGETING, INSUFFICIENT_CONVERSIONS, INSUFFICIENT_CLICKS, INSUFFICIENT_VIDEO_VIEWS, UNKNOWN |
Retrieve the detailed information of recommendations about the campaign that need to increase clicks.
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.
For example:
SELECT * FROM RecommendationInsufficientClicksCampaignList WHERE AccountId = '1002504155' AND Type = 'DAILY_BUDGET_OVER'
Name | Type | References | Description |
AccountId | Int64 |
DisplayAdsAccounts.AccountId | Account ID. |
RecommendationId | Int64 | Recommendation ID. | |
CampaignId | Int64 | Campaign ID. | |
CampaignName | String | Campaign Name. | |
Type | String | Type of Recommendations
使用できる値は次のとおりです。DAILY_BUDGET_OVER, IMPRESSION_SHARE_BUDGET_LOSS_OVER, BID_STRATEGY_TO_TARGET_CPA, SEARCH_KEYWORD_LIST_IDEA, MAXIMIZE_CONVERSIONS, MAXIMIZE_CLICKS, MAXIMIZE_VIDEO_VIEWS, UPDATE_AD_CREATIVE, DUPLICATE_TARGETING_SETTINGS, NOT_OPTIMAL_AD_COUNT_COMBINED_AD_TYPE_AND_IMAGE_SIZE, ADGROUPS_FOR_ADDING_ADS, DAILY_BUDGET_SMALL, INSUFFICIENT_TARGETING, INSUFFICIENT_AD_SCHEDULE_TARGETING, INSUFFICIENT_CONVERSIONS, INSUFFICIENT_CLICKS, INSUFFICIENT_VIDEO_VIEWS, UNKNOWN |
Retrieve the detailed information of recommendations about the campaign that need to increase conversions.
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.
For example:
SELECT * FROM RecommendationInsufficientConversionsCampaignList WHERE AccountId = '1002504155' AND Type = 'DAILY_BUDGET_OVER'
Name | Type | References | Description |
AccountId | Int64 |
DisplayAdsAccounts.AccountId | Account ID. |
RecommendationId | Int64 | Recommendation ID. | |
CampaignId | Int64 | Campaign ID. | |
CampaignName | String | Campaign Name. | |
Type | String | Type of Recommendations
使用できる値は次のとおりです。DAILY_BUDGET_OVER, IMPRESSION_SHARE_BUDGET_LOSS_OVER, BID_STRATEGY_TO_TARGET_CPA, SEARCH_KEYWORD_LIST_IDEA, MAXIMIZE_CONVERSIONS, MAXIMIZE_CLICKS, MAXIMIZE_VIDEO_VIEWS, UPDATE_AD_CREATIVE, DUPLICATE_TARGETING_SETTINGS, NOT_OPTIMAL_AD_COUNT_COMBINED_AD_TYPE_AND_IMAGE_SIZE, ADGROUPS_FOR_ADDING_ADS, DAILY_BUDGET_SMALL, INSUFFICIENT_TARGETING, INSUFFICIENT_AD_SCHEDULE_TARGETING, INSUFFICIENT_CONVERSIONS, INSUFFICIENT_CLICKS, INSUFFICIENT_VIDEO_VIEWS, UNKNOWN |
Retrieve the detailed information about the campaign that too narrow down the targeting.
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.
For example:
SELECT * FROM RecommendationInsufficientTargetingCampaignList WHERE AccountId = '1002504155' AND Type = 'DAILY_BUDGET_OVER'
Name | Type | References | Description |
AccountId | Int64 |
DisplayAdsAccounts.AccountId | Account ID. |
RecommendationId | Int64 | Recommendation ID. | |
CampaignId | Int64 | Campaign ID. | |
CampaignName | String | Campaign Name. | |
Type | String | Type of Recommendations
使用できる値は次のとおりです。DAILY_BUDGET_OVER, IMPRESSION_SHARE_BUDGET_LOSS_OVER, BID_STRATEGY_TO_TARGET_CPA, SEARCH_KEYWORD_LIST_IDEA, MAXIMIZE_CONVERSIONS, MAXIMIZE_CLICKS, MAXIMIZE_VIDEO_VIEWS, UPDATE_AD_CREATIVE, DUPLICATE_TARGETING_SETTINGS, NOT_OPTIMAL_AD_COUNT_COMBINED_AD_TYPE_AND_IMAGE_SIZE, ADGROUPS_FOR_ADDING_ADS, DAILY_BUDGET_SMALL, INSUFFICIENT_TARGETING, INSUFFICIENT_AD_SCHEDULE_TARGETING, INSUFFICIENT_CONVERSIONS, INSUFFICIENT_CLICKS, INSUFFICIENT_VIDEO_VIEWS, UNKNOWN |
Retrieve the detailed information of Recommendations about the campaign that need to increase video views.
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.
For example:
SELECT * FROM RecommendationInsufficientVideoViewsCampaignList WHERE AccountId = '1002504155' AND Type = 'DAILY_BUDGET_OVER'
Name | Type | References | Description |
AccountId | Int64 |
DisplayAdsAccounts.AccountId | Account ID. |
RecommendationId | Int64 | Recommendation ID. | |
CampaignId | Int64 | Campaign ID. | |
CampaignName | String | Campaign Name. | |
Type | String | Type of Recommendations
使用できる値は次のとおりです。DAILY_BUDGET_OVER, IMPRESSION_SHARE_BUDGET_LOSS_OVER, BID_STRATEGY_TO_TARGET_CPA, SEARCH_KEYWORD_LIST_IDEA, MAXIMIZE_CONVERSIONS, MAXIMIZE_CLICKS, MAXIMIZE_VIDEO_VIEWS, UPDATE_AD_CREATIVE, DUPLICATE_TARGETING_SETTINGS, NOT_OPTIMAL_AD_COUNT_COMBINED_AD_TYPE_AND_IMAGE_SIZE, ADGROUPS_FOR_ADDING_ADS, DAILY_BUDGET_SMALL, INSUFFICIENT_TARGETING, INSUFFICIENT_AD_SCHEDULE_TARGETING, INSUFFICIENT_CONVERSIONS, INSUFFICIENT_CLICKS, INSUFFICIENT_VIDEO_VIEWS, UNKNOWN |
Retrieve the detailed information of Recommendations about the campaign that is suitable for using autobidding (Maximize Clicks).
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.
For example:
SELECT * FROM RecommendationMaximizeClicksMaximizeClicksCampaignList WHERE AccountId = '1002504155' AND Type = 'DAILY_BUDGET_OVER'
Name | Type | References | Description |
AccountId | Int64 |
DisplayAdsAccounts.AccountId | Account ID. |
RecommendationId | Int64 | Recommendation 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). | |
RecommendedCampaignBiddingStrategyType | String | Recommended campaign bidding strategy type. | |
Type | String | Type of Recommendations
使用できる値は次のとおりです。DAILY_BUDGET_OVER, IMPRESSION_SHARE_BUDGET_LOSS_OVER, BID_STRATEGY_TO_TARGET_CPA, SEARCH_KEYWORD_LIST_IDEA, MAXIMIZE_CONVERSIONS, MAXIMIZE_CLICKS, MAXIMIZE_VIDEO_VIEWS, UPDATE_AD_CREATIVE, DUPLICATE_TARGETING_SETTINGS, NOT_OPTIMAL_AD_COUNT_COMBINED_AD_TYPE_AND_IMAGE_SIZE, ADGROUPS_FOR_ADDING_ADS, DAILY_BUDGET_SMALL, INSUFFICIENT_TARGETING, INSUFFICIENT_AD_SCHEDULE_TARGETING, INSUFFICIENT_CONVERSIONS, INSUFFICIENT_CLICKS, INSUFFICIENT_VIDEO_VIEWS, UNKNOWN |
Retrieve the detailed information of Recommendations about the campaign that is suitable for using autobidding (Maximize Conversions).
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.
For example:
SELECT * FROM RecommendationMaximizeConversionsMaximizeConversionsCampaignList WHERE AccountId = '1002504155' AND Type = 'DAILY_BUDGET_OVER'
Name | Type | References | Description |
AccountId | Int64 |
DisplayAdsAccounts.AccountId | Account ID. |
RecommendationId | Int64 | Recommendation 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). | |
RecommendedCampaignBiddingStrategyType | String | Recommended campaign bidding strategy type. | |
Type | String | Type of Recommendations
使用できる値は次のとおりです。DAILY_BUDGET_OVER, IMPRESSION_SHARE_BUDGET_LOSS_OVER, BID_STRATEGY_TO_TARGET_CPA, SEARCH_KEYWORD_LIST_IDEA, MAXIMIZE_CONVERSIONS, MAXIMIZE_CLICKS, MAXIMIZE_VIDEO_VIEWS, UPDATE_AD_CREATIVE, DUPLICATE_TARGETING_SETTINGS, NOT_OPTIMAL_AD_COUNT_COMBINED_AD_TYPE_AND_IMAGE_SIZE, ADGROUPS_FOR_ADDING_ADS, DAILY_BUDGET_SMALL, INSUFFICIENT_TARGETING, INSUFFICIENT_AD_SCHEDULE_TARGETING, INSUFFICIENT_CONVERSIONS, INSUFFICIENT_CLICKS, INSUFFICIENT_VIDEO_VIEWS, UNKNOWN |
Retrieve the detailed information of Recommendations about the campaign that is suitable for using autobidding (Maximize Video Views).
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.
For example:
SELECT * FROM RecommendationMaximizeVideoViewsMaximizeVideoViewsCampaignList WHERE AccountId = '1002504155' AND Type = 'DAILY_BUDGET_OVER'
Name | Type | References | Description |
AccountId | Int64 |
DisplayAdsAccounts.AccountId | Account ID. |
RecommendationId | Int64 | Recommendation 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). | |
RecommendedCampaignBiddingStrategyType | String | Recommended campaign bidding strategy type. | |
Type | String | Type of Recommendations
使用できる値は次のとおりです。DAILY_BUDGET_OVER, IMPRESSION_SHARE_BUDGET_LOSS_OVER, BID_STRATEGY_TO_TARGET_CPA, SEARCH_KEYWORD_LIST_IDEA, MAXIMIZE_CONVERSIONS, MAXIMIZE_CLICKS, MAXIMIZE_VIDEO_VIEWS, UPDATE_AD_CREATIVE, DUPLICATE_TARGETING_SETTINGS, NOT_OPTIMAL_AD_COUNT_COMBINED_AD_TYPE_AND_IMAGE_SIZE, ADGROUPS_FOR_ADDING_ADS, DAILY_BUDGET_SMALL, INSUFFICIENT_TARGETING, INSUFFICIENT_AD_SCHEDULE_TARGETING, INSUFFICIENT_CONVERSIONS, INSUFFICIENT_CLICKS, INSUFFICIENT_VIDEO_VIEWS, UNKNOWN |
Retrieve the detailed information of recommendations about the ad group that have other than 3-5 ads that combine a specific ad type and image size.
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.
For example:
SELECT * FROM RecommendationNotOptimalAdCountCombinedAdTypeAndImageSizeAdGroupList WHERE AccountId = '1002504155' AND Type = 'DAILY_BUDGET_OVER'
Name | Type | References | Description |
AccountId | Int64 |
DisplayAdsAccounts.AccountId | Account ID. |
RecommendationId | Int64 | Recommendation ID. | |
CampaignId | Int64 | Campaign ID. | |
CampaignName | String | Campaign Name. | |
AdGroupList | String | Ad group information. | |
Type | String | Type of Recommendations
使用できる値は次のとおりです。DAILY_BUDGET_OVER, IMPRESSION_SHARE_BUDGET_LOSS_OVER, BID_STRATEGY_TO_TARGET_CPA, SEARCH_KEYWORD_LIST_IDEA, MAXIMIZE_CONVERSIONS, MAXIMIZE_CLICKS, MAXIMIZE_VIDEO_VIEWS, UPDATE_AD_CREATIVE, DUPLICATE_TARGETING_SETTINGS, NOT_OPTIMAL_AD_COUNT_COMBINED_AD_TYPE_AND_IMAGE_SIZE, ADGROUPS_FOR_ADDING_ADS, DAILY_BUDGET_SMALL, INSUFFICIENT_TARGETING, INSUFFICIENT_AD_SCHEDULE_TARGETING, INSUFFICIENT_CONVERSIONS, INSUFFICIENT_CLICKS, INSUFFICIENT_VIDEO_VIEWS, UNKNOWN |
Retrieve the detailed information of recommendations about the ad group that have other than 3-5 ads that combine a specific ad type and image size.
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.
For example:
SELECT * FROM RecommendationNotOptimalAdCountCombinedAdTypeAndImageSizeAdGroupListAdGroupList WHERE AccountId = '1002504155' AND Type = 'DAILY_BUDGET_OVER'
Name | Type | References | Description |
AccountId | Int64 |
DisplayAdsAccounts.AccountId | Account ID. |
AdGroupId | Int64 | Ad group ID. | |
AdGroupName | Int64 | Ad group name. | |
MediaAdFormat | String | The type of image format. | |
AdCount | String | The number of ads that use this media format. | |
Type | String | Type of Recommendations
使用できる値は次のとおりです。DAILY_BUDGET_OVER, IMPRESSION_SHARE_BUDGET_LOSS_OVER, BID_STRATEGY_TO_TARGET_CPA, SEARCH_KEYWORD_LIST_IDEA, MAXIMIZE_CONVERSIONS, MAXIMIZE_CLICKS, MAXIMIZE_VIDEO_VIEWS, UPDATE_AD_CREATIVE, DUPLICATE_TARGETING_SETTINGS, NOT_OPTIMAL_AD_COUNT_COMBINED_AD_TYPE_AND_IMAGE_SIZE, ADGROUPS_FOR_ADDING_ADS, DAILY_BUDGET_SMALL, INSUFFICIENT_TARGETING, INSUFFICIENT_AD_SCHEDULE_TARGETING, INSUFFICIENT_CONVERSIONS, INSUFFICIENT_CLICKS, INSUFFICIENT_VIDEO_VIEWS, UNKNOWN |
Get Recommendations information.
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.
For example:
SELECT * FROM Recommendations WHERE AccountId = '1002504155' AND Type = 'DAILY_BUDGET_OVER'
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. | |
MaximizeConversionsCampaignList | String | This describes detailed information of Recommendations about the campaign that is suitable for using autobidding(Maximize Conversions). | |
MaximizeClicksCampaignList | String | This describes detailed information of Recommendations about the campaign that is suitable for using autobidding(Maximize Clicks). | |
MaximizeVideoViewsCampaignList | String | This describes detailed information of Recommendations about the campaign that is suitable for using autobidding(Maximize video views). | |
UpdateAdCreativeList | String | This describes the detailed information of ads that have recommendations for updating images or videos. | |
DuplicateTargetingSettingsAdGroupList | String | This describes detailed information of recommendations about the ad group with duplicate targeting settings. | |
NotOptimalAdCountCombinedAdTypeAndImageSizeAdGroupList | String | This describes detailed information of recommendations about the ad group that have other than 3-5 ads that combine a specific ad type and image size. | |
AdGroupsForAddingAdsList | String | This describes detailed information of recommendations about the ad group with recommended image sizes. | |
DailyBudgetSmallCampaignList | String | This describes detailed information of recommendations about the campaign with less than 5,000 JPY daily budget. | |
InsufficientTargetingCampaignList | String | This describes detailed information of recommendations about the campaign that too narrow down the targeting. | |
InsufficientAdScheduleTargetingCampaignList | String | This describes detailed information of recommendations about the campaign that have days of the week with less than six hours available for ad delivery. | |
InsufficientConversionsCampaignList | String | This describes detailed information of recommendations about the campaign that need to increase conversions. | |
InsufficientClicksCampaignList | String | This describes detailed information of recommendations about the campaign that need to increase clicks. | |
InsufficientVideoViewsCampaignList | String | This describes detailed information of Recommendations about the campaign that need to increase video views. | |
EnhancedCpcCampaignList | String | This describes recommendation information about the campaign that is suitable for using enhanced CPC. | |
CreateAdGroupList | String | This describes detailed information about a recommendation for creating ad groups. | |
CreateAdList | String | This describes detailed information about a recommendation for creating ads. | |
CreateResponsiveDisplayAdsList | String | This describes detailed information about a recommendation for Responsive Ads for Display. | |
CreateCampaignRecommendationId | Int64 | Recommendation ID. | |
TurnYourAccountOnRecommendationId | Int64 | Recommendation ID. | |
TurnYourAdOnRecommendationId | Int64 | Recommendation ID. | |
InsufficientAccountBalanceRecommendationId | Int64 | Recommendation ID. | |
Type | String | Type of Recommendations.
使用できる値は次のとおりです。DAILY_BUDGET_OVER, IMPRESSION_SHARE_BUDGET_LOSS_OVER, BID_STRATEGY_TO_TARGET_CPA, SEARCH_KEYWORD_LIST_IDEA, MAXIMIZE_CONVERSIONS, MAXIMIZE_CLICKS, MAXIMIZE_VIDEO_VIEWS, UPDATE_AD_CREATIVE, DUPLICATE_TARGETING_SETTINGS, NOT_OPTIMAL_AD_COUNT_COMBINED_AD_TYPE_AND_IMAGE_SIZE, ADGROUPS_FOR_ADDING_ADS, DAILY_BUDGET_SMALL, INSUFFICIENT_TARGETING, INSUFFICIENT_AD_SCHEDULE_TARGETING, INSUFFICIENT_CONVERSIONS, INSUFFICIENT_CLICKS, INSUFFICIENT_VIDEO_VIEWS, UNKNOWN | |
OptimizationScoreLift | Double | Estimated optimization score increase. |
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.
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.
For example:
SELECT * FROM RecommendationSearchKeywordIdeaSearchKeywordIdeaSearchKeywordLists WHERE AccountId = '1002504155' AND Type = 'DAILY_BUDGET_OVER'
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
使用できる値は次のとおりです。DAILY_BUDGET_OVER, IMPRESSION_SHARE_BUDGET_LOSS_OVER, BID_STRATEGY_TO_TARGET_CPA, SEARCH_KEYWORD_LIST_IDEA, MAXIMIZE_CONVERSIONS, MAXIMIZE_CLICKS, MAXIMIZE_VIDEO_VIEWS, UPDATE_AD_CREATIVE, DUPLICATE_TARGETING_SETTINGS, NOT_OPTIMAL_AD_COUNT_COMBINED_AD_TYPE_AND_IMAGE_SIZE, ADGROUPS_FOR_ADDING_ADS, DAILY_BUDGET_SMALL, INSUFFICIENT_TARGETING, INSUFFICIENT_AD_SCHEDULE_TARGETING, INSUFFICIENT_CONVERSIONS, INSUFFICIENT_CLICKS, INSUFFICIENT_VIDEO_VIEWS, UNKNOWN |
Retrieve the detailed information of ads that have recommendations for updating images or videos.
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.
For example:
SELECT * FROM RecommendationUpdateAdCreativeUpdateAdCreativeList WHERE AccountId = '1002504155' AND Type = 'DAILY_BUDGET_OVER'
Name | Type | References | Description |
AccountId | Int64 |
DisplayAdsAccounts.AccountId | Account ID. |
RecommendationId | Int64 | Recommendation ID. | |
CampaignId | Int64 | Campaign ID. | |
CampaignName | String | Campaign Name. | |
AdGroupId | Int64 | Ad group ID. | |
AdGroupName | String | Ad group name. | |
AdId | Int64 | Ad ID. | |
AdName | String | Ad name. | |
PreviousViewableCtr | Double | Viewable CTR 30 to 16 days ago (average). | |
LatestViewableCtr | Double | Latest viewable CTR (monthly average). | |
ViewableCtrDecrease | Double | Viewable CTR decrease. | |
Type | String | Type of Recommendations
使用できる値は次のとおりです。DAILY_BUDGET_OVER, IMPRESSION_SHARE_BUDGET_LOSS_OVER, BID_STRATEGY_TO_TARGET_CPA, SEARCH_KEYWORD_LIST_IDEA, MAXIMIZE_CONVERSIONS, MAXIMIZE_CLICKS, MAXIMIZE_VIDEO_VIEWS, UPDATE_AD_CREATIVE, DUPLICATE_TARGETING_SETTINGS, NOT_OPTIMAL_AD_COUNT_COMBINED_AD_TYPE_AND_IMAGE_SIZE, ADGROUPS_FOR_ADDING_ADS, DAILY_BUDGET_SMALL, INSUFFICIENT_TARGETING, INSUFFICIENT_AD_SCHEDULE_TARGETING, INSUFFICIENT_CONVERSIONS, INSUFFICIENT_CLICKS, INSUFFICIENT_VIDEO_VIEWS, UNKNOWN |
To view the Ad report. Simple Select statement will create and retrieve last 7 days report
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.
SELECT * FROM ReportDisplayAdsAd WHERE AccountId = '125466' SELECT * FROM ReportDisplayAdsAd WHERE AccountId = '125466' AND ReportJobId = '123456' SELECT * FROM ReportDisplayAdsAd WHERE AccountId = '125466' AND ReportDateRangeType = 'LAST_7_DAYS' SELECT * FROM ReportDisplayAdsAd WHERE AccountId = '125466' AND ReportDateRangeType = 'CUSTOM_DATE' and DateRangeStartDate = '2022-02-12' AND DateRangeEndDate = '2022-04-29'
Note: Since the Report is Dynamic, so the columns may vary depending upon the API.
Name | Type | References | Description |
ReportJobId | String | ReportJobId | |
AccountId | Long | アカウントID | |
AccountName | String | アカウント名 | |
CampaignID | Long | キャンペーンID | |
CampaignName | String | キャンペーン名 | |
Campaigndeliverysettings | String | キャンペーン配信設定 | |
AdGroupID | Long | 広告グループID | |
AdGroupName | String | 広告グループ名 | |
Adgroupdeliverysettings | String | 広告グループ配信設定 | |
AdID | Long | 広告ID | |
AdName | String | 広告名 | |
Adtype | String | 広告タイプ | |
Adtype_prev_ | String | 広告タイプ(旧) | |
Addeliverysettings | String | 広告配信設定 | |
DestinationURLID | Long | リンク先URLID | |
DestinationURL | String | リンク先URL | |
PrefectureID | String | 都道府県ID | |
Prefectures | String | 都道府県 | |
CityID | String | 市区郡ID | |
City | String | 市区郡 | |
WardID | String | 行政区ID | |
Ward | String | 行政区 | |
Gender | String | 性別 | |
Age | String | 年齢 | |
Month | String | 月 | |
Daily | String | 日 | |
Hourly | Long | 時間 | |
AdDistribution | String | 広告掲載方式 | |
Device | String | デバイス | |
Mainmediaformat | String | メインメディアの形式 | |
MediaID | String | メディアID | |
MediaName | String | メディア名 | |
FileName | String | ファイル名 | |
PixelSize | String | ピクセルサイズ | |
Title | String | タイトル | |
Description1 | String | 説明文1 | |
Description2 | String | 説明文2 | |
DisplayURL | String | 表示URL | |
SearchKeywordID | Long | サーチキーワードID | |
SearchKeyword | String | サーチキーワード | |
ObjectiveofConversionTracking | String | コンバージョン測定の目的 | |
Carrier | String | キャリア | |
Layout | String | レイアウト | |
DynamicImageExtensions | String | 画像自動付与 | |
CampaignlabelIDs_JSON_ | String | キャンペーンラベルID リスト(JSON) | |
Campaignlabels | String | キャンペーンラベルリスト | |
Campaignlabels_JSON_ | String | キャンペーンラベルリスト(JSON) | |
AdgrouplabelIDs_JSON_ | String | 広告グループラベルID リスト(JSON) | |
Adgrouplabels | String | 広告グループラベルリスト | |
Adgrouplabels_JSON_ | String | 広告グループラベルリスト(JSON) | |
AdlabelIDs_JSON_ | String | 広告ラベルID リスト(JSON) | |
Adlabels | String | 広告ラベルリスト | |
Adlabels_JSON_ | String | 広告ラベルリスト(JSON) | |
ConversionName | String | コンバージョン名 | |
OS | String | OS | |
Web_App | String | ウェブ / アプリ | |
CampaignType | String | キャンペーンタイプ | |
AppID_Packagename | String | アプリID / パッケージ名 | |
AppName | String | アプリ名 | |
AppOS | String | アプリOS | |
Campaigngoals | String | キャンペーン目的 | |
Campaignbuyingtype | String | キャンペーン購入タイプ | |
DestinationURL_campaignbanner_ | String | リンク先URL(キャンペーンバナー) | |
Packagename | String | 商品名 | |
Impressions | Long | インプレッション数 | |
CTR | Double | クリック率 | |
Cost | Double | コスト | |
Clicks | Long | クリック数 | |
Avg_CPC | Double | 平均CPC | |
Avg_position | Double | 平均掲載順位 | |
Viewableimpressions | Long | ビューアブルインプレッション数 | |
Avg_CPV | Double | 平均CPV | |
25_videoviews | Long | 動画の25%再生数 | |
50_videoviews | Long | 動画の50%再生数 | |
75_videoviews | Long | 動画の75%再生数 | |
95_videoviews | Long | 動画の95%再生数 | |
100_videoviews | Long | 動画の100%再生数 | |
Avg_videoviewrate | Double | 動画の平均再生率 | |
Avg_durationofvideoviewed | Double | 動画の平均再生時間(秒) | |
Videoviews | Long | 動画の再生開始数 | |
Paidvideoviews_CPV_ | Long | 課金が発生した動画再生数(CPV 課金キャンペーンのみ) | |
Paidvideoviewrate_CPV_ | Double | 課金が発生した動画再生率(CPV 課金キャンペーンのみ) | |
3secvideoviews | Long | 動画の3秒再生数 | |
Conversions | Long | コンバージョン数 | |
Conv_rate | Double | コンバージョン率 | |
Cost_conv_ | Double | コスト / コンバージョン数 | |
Conv_value | Long | コンバージョンの価値 | |
Conv_value_conv_ | Double | コンバージョンの価値 / コンバージョン数 | |
Conversions_all_ | Long | コンバージョン数(全て) | |
Conv_rate_all_ | Double | コンバージョン率(全て) | |
Cost_conv_all_ | Double | コスト / コンバージョン数(全て) | |
Conv_value_all_ | Long | コンバージョンの価値(全て) | |
Conv_value_all_conv_all_ | Double | コンバージョンの価値(全て) / コンバージョン数(全て) | |
Conversions_viaclick_ | Long | コンバージョン数(クリック経由) | |
Conv_rate_viaclick_ | Double | コンバージョン率(クリック経由) | |
Cost_conv_viaclick_ | Double | コスト / コンバージョン数(クリック経由) | |
Conv_value_viaclick_ | Long | コンバージョンの価値(クリック経由) | |
Conv_value_viaclick_conv_viaclick_ | Double | コンバージョンの価値(クリック経由) / コンバージョン数(クリック経由) | |
Cross_deviceconv_ | Long | クロスデバイスコンバージョン数 | |
Conv_value_cost | Double | コンバージョンの価値 / コスト | |
Conv_value_all_cost | Double | コンバージョンの価値(全て) / コスト | |
Conv_value_viaclick_cost | Double | コンバージョンの価値(クリック経由) / コスト | |
Avg_CPM | Double | 平均CPM | |
Avg_vCPM | Double | 平均vCPM | |
Measuredimpressions | Long | メジャードインプレッション数 | |
Viewableclicks | Long | ビューアブルクリック数 | |
Measuredimpressionrate | Double | メジャードインプレッション測定率 | |
Viewableimpressionrate | Double | ビューアブルインプレッション率 | |
ViewableCTR | Double | ビューアブルクリック率 | |
10secvideoviews | Long | 動画の10秒再生数 | |
Impressionshare | Double | インプレッションシェア | |
Lostimpressionshare_budget_ | Double | インプレッションシェア損失率(予算) | |
Lostimpressionshare_rank_ | Double | インプレッションシェア損失率(ランク) | |
Lifetimebudget | Long | 通期予算 | |
Campaigndeliverytype | String | キャンペーン掲載タイプ | |
View_throughconversions | Long | ビュースルーコンバージョン数 | |
Videoviewthroughrate | Double | 動画の再生完了率 | |
ConversionID | String | コンバージョンID | |
ContentkeywordID | Long | コンテンツキーワードID | |
Contentkeyword | String | コンテンツキーワード | |
Conversiongroupname | String | コンバージョングループ名 | |
ConversiongroupID | Long | コンバージョングループID | |
FinalURL | String | 最終リンク先URL | |
TrackingURL | String | トラッキングURL | |
Targetradius | String | 半径指定範囲 | |
Distancefromtargetlocation | String | 指定地点からの距離 | |
Viewableimpressionsperpanel | Long | パネル別ビューアブルインプレッション数 | |
ViewableCTRperpanel | Double | パネル別ビューアブルクリック率 | |
Responsiveadstype | String | レスポンシブ広告入稿タイプ |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
ReportDateRangeType | String | レポートの集計対象期間
使用できる値は次のとおりです。LAST_7_DAYS, LAST_MONTH, THIS_MONTH, THIS_MONTH_EXCEPT_TODAY, TODAY, YESTERDAY, LAST_30_DAYS, LAST_14_DAYS, CUSTOM_DATE, LAST_WEEK, LAST_BUSINESS_WEEK | |
DateRangeStartDate | String | 集計開始日(yyyy-MM-dd) ReportDateRangeType='CUSTOM_DATE' のとき必須 | |
DateRangeEndDate | String | 集計終了日(yyyy-MM-dd) ReportDateRangeType='CUSTOM_DATE' のとき必須 |
To view the Audience_category report. Simple Select statement will create and retrieve last 7 days report
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.
SELECT * FROM ReportDisplayAdsAudience_category WHERE AccountId = '125466' SELECT * FROM ReportDisplayAdsAudience_category WHERE AccountId = '125466' AND ReportJobId = '123456' SELECT * FROM ReportDisplayAdsAudience_category WHERE AccountId = '125466' AND ReportDateRangeType = 'LAST_7_DAYS' SELECT * FROM ReportDisplayAdsAudience_category WHERE AccountId = '125466' AND ReportDateRangeType = 'CUSTOM_DATE' and DateRangeStartDate = '2022-02-12' AND DateRangeEndDate = '2022-04-29'
Note: Since the Report is Dynamic, so the columns may vary depending upon the API.
Name | Type | References | Description |
ReportJobId | String | ReportJobId | |
AccountId | Long | アカウントID | |
AccountName | String | アカウント名 | |
CampaignID | Long | キャンペーンID | |
CampaignName | String | キャンペーン名 | |
AdGroupID | Long | 広告グループID | |
AdGroupName | String | 広告グループ名 | |
Month | String | 月 | |
Daily | String | 日 | |
AdDistribution | String | 広告掲載方式 | |
Device | String | デバイス | |
Audiencecategory | String | オーディエンスカテゴリー名 | |
Audiencecategorytype | String | オーディエンスカテゴリータイプ | |
ObjectiveofConversionTracking | String | コンバージョン測定の目的 | |
ConversionName | String | コンバージョン名 | |
OS | String | OS | |
Web_App | String | ウェブ / アプリ | |
CampaignType | String | キャンペーンタイプ | |
AppID_Packagename | String | アプリID / パッケージ名 | |
AppName | String | アプリ名 | |
AppOS | String | アプリOS | |
Campaigngoals | String | キャンペーン目的 | |
Campaignbuyingtype | String | キャンペーン購入タイプ | |
Packagename | String | 商品名 | |
Impressions | Long | インプレッション数 | |
CTR | Double | クリック率 | |
Cost | Double | コスト | |
Clicks | Long | クリック数 | |
Avg_CPC | Double | 平均CPC | |
Avg_position | Double | 平均掲載順位 | |
Viewableimpressions | Long | ビューアブルインプレッション数 | |
Avg_CPV | Double | 平均CPV | |
25_videoviews | Long | 動画の25%再生数 | |
50_videoviews | Long | 動画の50%再生数 | |
75_videoviews | Long | 動画の75%再生数 | |
95_videoviews | Long | 動画の95%再生数 | |
100_videoviews | Long | 動画の100%再生数 | |
Avg_videoviewrate | Double | 動画の平均再生率 | |
Avg_durationofvideoviewed | Double | 動画の平均再生時間(秒) | |
Videoviews | Long | 動画の再生開始数 | |
Paidvideoviews_CPV_ | Long | 課金が発生した動画再生数(CPV 課金キャンペーンのみ) | |
Paidvideoviewrate_CPV_ | Double | 課金が発生した動画再生率(CPV 課金キャンペーンのみ) | |
3secvideoviews | Long | 動画の3秒再生数 | |
Conversions | Long | コンバージョン数 | |
Conv_rate | Double | コンバージョン率 | |
Cost_conv_ | Double | コスト / コンバージョン数 | |
Conv_value | Long | コンバージョンの価値 | |
Conv_value_conv_ | Double | コンバージョンの価値 / コンバージョン数 | |
Conversions_all_ | Long | コンバージョン数(全て) | |
Conv_rate_all_ | Double | コンバージョン率(全て) | |
Cost_conv_all_ | Double | コスト / コンバージョン数(全て) | |
Conv_value_all_ | Long | コンバージョンの価値(全て) | |
Conv_value_all_conv_all_ | Double | コンバージョンの価値(全て) / コンバージョン数(全て) | |
Conversions_viaclick_ | Long | コンバージョン数(クリック経由) | |
Conv_rate_viaclick_ | Double | コンバージョン率(クリック経由) | |
Cost_conv_viaclick_ | Double | コスト / コンバージョン数(クリック経由) | |
Conv_value_viaclick_ | Long | コンバージョンの価値(クリック経由) | |
Conv_value_viaclick_conv_viaclick_ | Double | コンバージョンの価値(クリック経由) / コンバージョン数(クリック経由) | |
Cross_deviceconv_ | Long | クロスデバイスコンバージョン数 | |
Conv_value_cost | Double | コンバージョンの価値 / コスト | |
Conv_value_all_cost | Double | コンバージョンの価値(全て) / コスト | |
Conv_value_viaclick_cost | Double | コンバージョンの価値(クリック経由) / コスト | |
Avg_CPM | Double | 平均CPM | |
Avg_vCPM | Double | 平均vCPM | |
Measuredimpressions | Long | メジャードインプレッション数 | |
Viewableclicks | Long | ビューアブルクリック数 | |
Measuredimpressionrate | Double | メジャードインプレッション測定率 | |
Viewableimpressionrate | Double | ビューアブルインプレッション率 | |
ViewableCTR | Double | ビューアブルクリック率 | |
10secvideoviews | Long | 動画の10秒再生数 | |
Lifetimebudget | Long | 通期予算 | |
Campaigndeliverytype | String | キャンペーン掲載タイプ | |
View_throughconversions | Long | ビュースルーコンバージョン数 | |
Videoviewthroughrate | Double | 動画の再生完了率 | |
ConversionID | String | コンバージョンID | |
Campaigndeliverysettings | String | キャンペーン配信設定 | |
Adgroupdeliverysettings | String | 広告グループ配信設定 |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
ReportDateRangeType | String | レポートの集計対象期間
使用できる値は次のとおりです。LAST_7_DAYS, LAST_MONTH, THIS_MONTH, THIS_MONTH_EXCEPT_TODAY, TODAY, YESTERDAY, LAST_30_DAYS, LAST_14_DAYS, CUSTOM_DATE, LAST_WEEK, LAST_BUSINESS_WEEK | |
DateRangeStartDate | String | 集計開始日(yyyy-MM-dd) ReportDateRangeType='CUSTOM_DATE' のとき必須 | |
DateRangeEndDate | String | 集計終了日(yyyy-MM-dd) ReportDateRangeType='CUSTOM_DATE' のとき必須 |
To view the Conversion_path report. Simple Select statement will create and retrieve last 7 days report
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.
SELECT * FROM ReportDisplayAdsConversion_path WHERE AccountId = '125466' SELECT * FROM ReportDisplayAdsConversion_path WHERE AccountId = '125466' AND ReportJobId = '123456' SELECT * FROM ReportDisplayAdsConversion_path WHERE AccountId = '125466' AND ReportDateRangeType = 'LAST_7_DAYS' SELECT * FROM ReportDisplayAdsConversion_path WHERE AccountId = '125466' AND ReportDateRangeType = 'CUSTOM_DATE' and DateRangeStartDate = '2022-02-12' AND DateRangeEndDate = '2022-04-29'
Note: Since the Report is Dynamic, so the columns may vary depending upon the API.
Name | Type | References | Description |
ReportJobId | String | ReportJobId | |
Campaignfortouchpoint1 | String | 接点1のキャンペーン | |
InteractionAtTouchpoint1 | String | 接点1の行動 | |
Touchpoint1Interactions | Long | 接点1の回数 | |
Accountfortouchpoint1 | String | 接点1のアカウント | |
AdGroupfortouchpoint1 | String | 接点1の広告グループ | |
Campaignfortouchpoint2 | String | 接点2のキャンペーン | |
InteractionAtTouchpoint2 | String | 接点2の行動 | |
Touchpoint2Interactions | Long | 接点2の回数 | |
Accountfortouchpoint2 | String | 接点2のアカウント | |
AdGroupfortouchpoint2 | String | 接点2の広告グループ | |
Campaignfortouchpoint3 | String | 接点3のキャンペーン | |
InteractionAtTouchpoint3 | String | 接点3の行動 | |
Touchpoint3Interactions | Long | 接点3の回数 | |
Accountfortouchpoint3 | String | 接点3のアカウント | |
AdGroupfortouchpoint3 | String | 接点3の広告グループ | |
Campaignfortouchpoint4 | String | 接点4のキャンペーン | |
InteractionAtTouchpoint4 | String | 接点4の行動 | |
Touchpoint4Interactions | Long | 接点4の回数 | |
Accountfortouchpoint4 | String | 接点4のアカウント | |
AdGroupfortouchpoint4 | String | 接点4の広告グループ | |
Campaignfortouchpoint5 | String | 接点5のキャンペーン | |
InteractionAtTouchpoint5 | String | 接点5の行動 | |
Touchpoint5Interactions | Long | 接点5の回数 | |
Accountfortouchpoint5 | String | 接点5のアカウント | |
AdGroupfortouchpoint5 | String | 接点5の広告グループ | |
Campaignfortouchpoint6 | String | 接点6のキャンペーン | |
InteractionAtTouchpoint6 | String | 接点6の行動 | |
Touchpoint6Interactions | Long | 接点6の回数 | |
Accountfortouchpoint6 | String | 接点6のアカウント | |
AdGroupfortouchpoint6 | String | 接点6の広告グループ | |
Campaignfortouchpoint7 | String | 接点7のキャンペーン | |
InteractionAtTouchpoint7 | String | 接点7の行動 | |
Touchpoint7Interactions | Long | 接点7の回数 | |
Accountfortouchpoint7 | String | 接点7のアカウント | |
AdGroupfortouchpoint7 | String | 接点7の広告グループ | |
Campaignfortouchpoint8 | String | 接点8のキャンペーン | |
InteractionAtTouchpoint8 | String | 接点8の行動 | |
Touchpoint8Interactions | Long | 接点8の回数 | |
Accountfortouchpoint8 | String | 接点8のアカウント | |
AdGroupfortouchpoint8 | String | 接点8の広告グループ | |
Campaignfortouchpoint9 | String | 接点9のキャンペーン | |
InteractionAtTouchpoint9 | String | 接点9の行動 | |
Touchpoint9Interactions | Long | 接点9の回数 | |
Accountfortouchpoint9 | String | 接点9のアカウント | |
AdGroupfortouchpoint9 | String | 接点9の広告グループ | |
Campaignfortouchpoint10 | String | 接点10のキャンペーン | |
InteractionAtTouchpoint10 | String | 接点10の行動 | |
Touchpoint10Interactions | Long | 接点10の回数 | |
Accountfortouchpoint10 | String | 接点10のアカウント | |
AdGroupfortouchpoint10 | String | 接点10の広告グループ | |
Campaignfortouchpoint11 | String | 接点11のキャンペーン | |
InteractionAtTouchpoint11 | String | 接点11の行動 | |
Touchpoint11Interactions | Long | 接点11の回数 | |
Accountfortouchpoint11 | String | 接点11のアカウント | |
AdGroupfortouchpoint11 | String | 接点11の広告グループ | |
Campaignfortouchpoint12 | String | 接点12のキャンペーン | |
InteractionAtTouchpoint12 | String | 接点12の行動 | |
Touchpoint12Interactions | Long | 接点12の回数 | |
Accountfortouchpoint12 | String | 接点12のアカウント | |
AdGroupfortouchpoint12 | String | 接点12の広告グループ | |
Campaignfortouchpoint13 | String | 接点13のキャンペーン | |
InteractionAtTouchpoint13 | String | 接点13の行動 | |
Touchpoint13Interactions | Long | 接点13の回数 | |
Accountfortouchpoint13 | String | 接点13のアカウント | |
AdGroupfortouchpoint13 | String | 接点13の広告グループ | |
Campaignfortouchpoint14 | String | 接点14のキャンペーン | |
InteractionAtTouchpoint14 | String | 接点14の行動 | |
Touchpoint14Interactions | Long | 接点14の回数 | |
Accountfortouchpoint14 | String | 接点14のアカウント | |
AdGroupfortouchpoint14 | String | 接点14の広告グループ | |
Campaignfortouchpoint15 | String | 接点15のキャンペーン | |
InteractionAtTouchpoint15 | String | 接点15の行動 | |
Touchpoint15Interactions | Long | 接点15の回数 | |
Accountfortouchpoint15 | String | 接点15のアカウント | |
AdGroupfortouchpoint15 | String | 接点15の広告グループ | |
Campaignfortouchpoint16 | String | 接点16のキャンペーン | |
InteractionAtTouchpoint16 | String | 接点16の行動 | |
Touchpoint16Interactions | Long | 接点16の回数 | |
Accountfortouchpoint16 | String | 接点16のアカウント | |
AdGroupfortouchpoint16 | String | 接点16の広告グループ | |
Campaignfortouchpoint17 | String | 接点17のキャンペーン | |
InteractionAtTouchpoint17 | String | 接点17の行動 | |
Touchpoint17Interactions | Long | 接点17の回数 | |
Accountfortouchpoint17 | String | 接点17のアカウント | |
AdGroupfortouchpoint17 | String | 接点17の広告グループ | |
Campaignfortouchpoint18 | String | 接点18のキャンペーン | |
InteractionAtTouchpoint18 | String | 接点18の行動 | |
Touchpoint18Interactions | Long | 接点18の回数 | |
Accountfortouchpoint18 | String | 接点18のアカウント | |
AdGroupfortouchpoint18 | String | 接点18の広告グループ | |
Campaignfortouchpoint19 | String | 接点19のキャンペーン | |
InteractionAtTouchpoint19 | String | 接点19の行動 | |
Touchpoint19Interactions | Long | 接点19の回数 | |
Accountfortouchpoint19 | String | 接点19のアカウント | |
AdGroupfortouchpoint19 | String | 接点19の広告グループ | |
Campaignfortouchpoint20 | String | 接点20のキャンペーン | |
InteractionAtTouchpoint20 | String | 接点20の行動 | |
Touchpoint20Interactions | Long | 接点20の回数 | |
Accountfortouchpoint20 | String | 接点20のアカウント | |
AdGroupfortouchpoint20 | String | 接点20の広告グループ | |
Conversions_incl_view_through_ | Long | コンバージョン数(ビュースルーを含む) | |
Conv_value_incl_view_through_ | Long | コンバージョンの価値(ビュースルーを含む) | |
Conversions | Long | コンバージョン数 | |
Conversions_viaclick_ | Long | コンバージョン数(クリック経由) | |
View_throughconversions | Long | ビュースルーコンバージョン数 | |
AccountId | Long | Account Id |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
ReportDateRangeType | String | レポートの集計対象期間
使用できる値は次のとおりです。LAST_7_DAYS, LAST_MONTH, THIS_MONTH, THIS_MONTH_EXCEPT_TODAY, TODAY, YESTERDAY, LAST_30_DAYS, LAST_14_DAYS, CUSTOM_DATE, LAST_WEEK, LAST_BUSINESS_WEEK | |
DateRangeStartDate | String | 集計開始日(yyyy-MM-dd) ReportDateRangeType='CUSTOM_DATE' のとき必須 | |
DateRangeEndDate | String | 集計終了日(yyyy-MM-dd) ReportDateRangeType='CUSTOM_DATE' のとき必須 |
To view the Cross_campaign_reaches report. Simple Select statement will create and retrieve last 7 days report
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.
SELECT * FROM ReportDisplayAdsCross_campaign_reaches WHERE AccountId = '125466' SELECT * FROM ReportDisplayAdsCross_campaign_reaches WHERE AccountId = '125466' AND ReportJobId = '123456' SELECT * FROM ReportDisplayAdsCross_campaign_reaches WHERE AccountId = '125466' AND CrossCampaignType = 'CAMPAIGN_ID' AND CrossCampaignId IN ('30826572', '30826497') SELECT * FROM ReportDisplayAdsCross_campaign_reaches WHERE AccountId = '125466' AND CrossCampaignType = 'CAMPAIGN_GOAL' AND CrossCampaignGoal IN ('CONVERSION', 'APP_PROMOTION') SELECT * FROM ReportDisplayAdsCross_campaign_reaches WHERE AccountId = '125466' AND ReportDateRangeType = 'LAST_7_DAYS' SELECT * FROM ReportDisplayAdsCross_campaign_reaches WHERE AccountId = '125466' AND ReportDateRangeType = 'CUSTOM_DATE' and DateRangeStartDate = '2022-02-12' AND DateRangeEndDate = '2022-04-29'
Note: Since the Report is Dynamic, so the columns may vary depending upon the API.
Name | Type | References | Description |
ReportJobId | String | ReportJobId | |
Campaign | String | キャンペーン | |
Uniqueuserswithviewableimpressions | Long | ビューアブルインプレッションのユニークユーザー数 | |
Uniqueuserswithclicksorvideoviews | Long | クリックまたは動画再生のユニークユーザー数 | |
Uniqueuserswithconversions_incl_view_through_ | Long | コンバージョン(ビュースルーを含む)のユニークユーザー数 | |
Uniqueuserswithconversions | Long | コンバージョンのユニークユーザー数 | |
Uniqueuserswithconversions_viaclick_ | Long | コンバージョン(クリック経由)のユニークユーザー数 | |
Uniqueuserswithview_throughconversions | Long | ビュースルーコンバージョンのユニークユーザー数 | |
Account | String | アカウント | |
AccountId | Long | Account Id |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
ReportDateRangeType | String | レポートの集計対象期間
使用できる値は次のとおりです。LAST_7_DAYS, LAST_MONTH, THIS_MONTH, THIS_MONTH_EXCEPT_TODAY, TODAY, YESTERDAY, LAST_30_DAYS, LAST_14_DAYS, CUSTOM_DATE, LAST_WEEK, LAST_BUSINESS_WEEK | |
DateRangeStartDate | String | 集計開始日(yyyy-MM-dd) ReportDateRangeType='CUSTOM_DATE' のとき必須 | |
DateRangeEndDate | String | 集計終了日(yyyy-MM-dd) ReportDateRangeType='CUSTOM_DATE' のとき必須 | |
CrossCampaignType | String | 横断リーチレポートの組み合わせの種別
使用できる値は次のとおりです。CAMPAIGN_ID, CAMPAIGN_GOAL, CAMPAIGN_BUYING_TYPE | |
CrossCampaignId | String | 横断リーチレポートの組み合わせの対象となるアカウントおよびキャンペーンID crossCampaignTypeがCAMPAIGN_ID の場合は必須 | |
CrossCampaignGoal | String | 横断リーチレポートの組み合わせの対象となるアカウントおよびキャンペーン目的 crossCampaignTypeがCAMPAIGN_GOAL の場合は必須 |
To view the Label report. Simple Select statement will create and retrieve last 7 days report
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.
SELECT * FROM ReportDisplayAdsLabel WHERE AccountId = '125466' SELECT * FROM ReportDisplayAdsLabel WHERE AccountId = '125466' AND ReportJobId = '123456' SELECT * FROM ReportDisplayAdsLabel WHERE AccountId = '125466' AND ReportDateRangeType = 'LAST_7_DAYS' SELECT * FROM ReportDisplayAdsLabel WHERE AccountId = '125466' AND ReportDateRangeType = 'CUSTOM_DATE' and DateRangeStartDate = '2022-02-12' AND DateRangeEndDate = '2022-04-29'
Note: Since the Report is Dynamic, so the columns may vary depending upon the API.
Name | Type | References | Description |
ReportJobId | String | ReportJobId | |
Month | String | 月 | |
Daily | String | 日 | |
Hourly | Long | 時間 | |
CampaignlabelID | Long | キャンペーンラベルID | |
Campaignlabel | String | キャンペーンラベル | |
AdgrouplabelID | Long | 広告グループラベルID | |
Adgrouplabel | String | 広告グループラベル | |
AdlabelID | Long | 広告ラベルID | |
Adlabel | String | 広告ラベル | |
Impressions | Long | インプレッション数 | |
CTR | Double | クリック率 | |
Cost | Double | コスト | |
Clicks | Long | クリック数 | |
Avg_CPC | Double | 平均CPC | |
Avg_position | Double | 平均掲載順位 | |
Viewableimpressions | Long | ビューアブルインプレッション数 | |
Avg_CPV | Double | 平均CPV | |
25_videoviews | Long | 動画の25%再生数 | |
50_videoviews | Long | 動画の50%再生数 | |
75_videoviews | Long | 動画の75%再生数 | |
95_videoviews | Long | 動画の95%再生数 | |
100_videoviews | Long | 動画の100%再生数 | |
Avg_videoviewrate | Double | 動画の平均再生率 | |
Avg_durationofvideoviewed | Double | 動画の平均再生時間(秒) | |
Videoviews | Long | 動画の再生開始数 | |
Paidvideoviews_CPV_ | Long | 課金が発生した動画再生数(CPV 課金キャンペーンのみ) | |
Paidvideoviewrate_CPV_ | Double | 課金が発生した動画再生率(CPV 課金キャンペーンのみ) | |
3secvideoviews | Long | 動画の3秒再生数 | |
Conversions | Long | コンバージョン数 | |
Conv_rate | Double | コンバージョン率 | |
Cost_conv_ | Double | コスト / コンバージョン数 | |
Conv_value | Long | コンバージョンの価値 | |
Conv_value_conv_ | Double | コンバージョンの価値/コンバージョン数 | |
Conversions_all_ | Long | コンバージョン数(全て) | |
Conv_rate_all_ | Double | コンバージョン率(全て) | |
Cost_conv_all_ | Double | コスト / コンバージョン数(全て) | |
Conv_value_all_ | Long | コンバージョンの価値(全て) | |
Conv_value_all_conv_all_ | Double | コンバージョンの価値(全て) / コンバージョン数(全て) | |
Conversions_viaclick_ | Long | コンバージョン数(クリック経由) | |
Conv_rate_viaclick_ | Double | コンバージョン率(クリック経由) | |
Cost_conv_viaclick_ | Double | コスト / コンバージョン数(クリック経由) | |
Conv_value_viaclick_ | Long | コンバージョンの価値(クリック経由) | |
Conv_value_viaclick_conv_viaclick_ | Double | コンバージョンの価値(クリック経由)/コンバージョン数(クリック経由) | |
Cross_deviceconv_ | Long | クロスデバイスコンバージョン数 | |
Conv_value_cost | Double | コンバージョンの価値 / コスト | |
Conv_value_all_cost | Double | コンバージョンの価値(全て) / コスト | |
Conv_value_viaclick_cost | Double | コンバージョンの価値(クリック経由) / コスト | |
Avg_CPM | Double | 平均CPM | |
Avg_vCPM | Double | 平均vCPM | |
Measuredimpressions | Long | メジャードインプレッション数 | |
Viewableclicks | Long | ビューアブルクリック数 | |
Measuredimpressionrate | Double | メジャードインプレッション測定率 | |
Viewableimpressionrate | Double | ビューアブルインプレッション率 | |
ViewableCTR | Double | ビューアブルクリック率 | |
10secvideoviews | Long | 動画の10秒再生数 | |
View_throughconversions | Long | ビュースルーコンバージョン数 | |
Videoviewthroughrate | Double | 動画の再生完了率 | |
AccountId | Long | Account Id |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
ReportDateRangeType | String | レポートの集計対象期間
使用できる値は次のとおりです。LAST_7_DAYS, LAST_MONTH, THIS_MONTH, THIS_MONTH_EXCEPT_TODAY, TODAY, YESTERDAY, LAST_30_DAYS, LAST_14_DAYS, CUSTOM_DATE, LAST_WEEK, LAST_BUSINESS_WEEK | |
DateRangeStartDate | String | 集計開始日(yyyy-MM-dd) ReportDateRangeType='CUSTOM_DATE' のとき必須 | |
DateRangeEndDate | String | 集計終了日(yyyy-MM-dd) ReportDateRangeType='CUSTOM_DATE' のとき必須 |
To view the Placement_target report. Simple Select statement will create and retrieve last 7 days report
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.
SELECT * FROM ReportDisplayAdsPlacement_target WHERE AccountId = '125466' SELECT * FROM ReportDisplayAdsPlacement_target WHERE AccountId = '125466' AND ReportJobId = '123456' SELECT * FROM ReportDisplayAdsPlacement_target WHERE AccountId = '125466' AND ReportDateRangeType = 'LAST_7_DAYS' SELECT * FROM ReportDisplayAdsPlacement_target WHERE AccountId = '125466' AND ReportDateRangeType = 'CUSTOM_DATE' and DateRangeStartDate = '2022-02-12' AND DateRangeEndDate = '2022-04-29'
Note: Since the Report is Dynamic, so the columns may vary depending upon the API.
Name | Type | References | Description |
ReportJobId | String | ReportJobId | |
PlacementlistID | Long | プレイスメントリストID | |
Placementlistname | String | プレイスメントリスト名 | |
AccountId | Long | アカウントID | |
AccountName | String | アカウント名 | |
CampaignID | Long | キャンペーンID | |
CampaignName | String | キャンペーン名 | |
Campaignbuyingtype | String | キャンペーン購入タイプ | |
Campaigndeliverytype | String | キャンペーン掲載タイプ | |
Campaigngoals | String | キャンペーン目的 | |
AdGroupID | Long | 広告グループID | |
AdGroupName | String | 広告グループ名 | |
Device | String | デバイス | |
OS | String | OS | |
Web_App | String | ウェブ / アプリ | |
Avg_position | Double | 平均掲載順位 | |
Conv_rate | Double | コンバージョン率 | |
Conv_rate_all_ | Double | コンバージョン率(全て) | |
Avg_CPC | Double | 平均CPC | |
Conv_rate_viaclick_ | Double | コンバージョン率(クリック経由) | |
Clicks | Long | クリック数 | |
Conv_value_all_cost | Double | コンバージョンの価値(全て) / コスト | |
Conv_value_cost | Double | コンバージョンの価値 / コスト | |
Conv_value_viaclick_cost | Double | コンバージョンの価値(クリック経由) / コスト | |
Cost_conv_all_ | Double | コスト / コンバージョン数(全て) | |
Cost_conv_ | Double | コスト / コンバージョン数 | |
Cost_conv_viaclick_ | Double | コスト / コンバージョン数(クリック経由) | |
Cost | Double | コスト | |
Paidvideoviewrate_CPV_ | Double | 課金が発生した動画再生率(CPV 課金キャンペーンのみ) | |
Paidvideoviews_CPV_ | Long | 課金が発生した動画再生数(CPV 課金キャンペーンのみ) | |
3secvideoviews | Long | 動画の3秒再生数 | |
10secvideoviews | Long | 動画の10秒再生数 | |
Avg_CPV | Double | 平均CPV | |
Videoviews | Long | 動画の再生開始数 | |
Avg_durationofvideoviewed | Double | 動画の平均再生時間(秒) | |
Avg_videoviewrate | Double | 動画の平均再生率 | |
25_videoviews | Long | 動画の25%再生数 | |
50_videoviews | Long | 動画の50%再生数 | |
75_videoviews | Long | 動画の75%再生数 | |
95_videoviews | Long | 動画の95%再生数 | |
100_videoviews | Long | 動画の100%再生数 | |
Viewableimpressions | Long | ビューアブルインプレッション数 | |
Avg_vCPM | Double | 平均vCPM | |
View_throughconversions | Long | ビュースルーコンバージョン数 | |
Impressions | Long | インプレッション数 | |
Avg_CPM | Double | 平均CPM | |
CTR | Double | クリック率 | |
Measuredimpressions | Long | メジャードインプレッション数 | |
Measuredimpressionrate | Double | メジャードインプレッション測定率 | |
Viewableimpressionrate | Double | ビューアブルインプレッション率 | |
Viewableclicks | Long | ビューアブルクリック数 | |
ViewableCTR | Double | ビューアブルクリック率 | |
Daily | String | 日 | |
ObjectiveofConversionTracking | String | コンバージョン測定の目的 | |
ConversionName | String | コンバージョン名 | |
Cross_deviceconv_ | Long | クロスデバイスコンバージョン数 | |
Conversions_viaclick_ | Long | コンバージョン数(クリック経由) | |
Conversions | Long | コンバージョン数 | |
Conv_value_viaclick_conv_viaclick_ | Double | コンバージョンの価値(クリック経由) / コンバージョン数(クリック経由) | |
Conv_value_viaclick_ | Long | コンバージョンの価値(クリック経由) | |
Conv_value | Long | コンバージョンの価値 | |
Conv_value_conv_ | Double | コンバージョンの価値 / コンバージョン数 | |
Conversions_all_ | Long | コンバージョン数(全て) | |
Conv_value_all_ | Long | コンバージョンの価値(全て) | |
Conv_value_all_conv_all_ | Double | コンバージョンの価値(全て) / コンバージョン数(全て) | |
AppID_Packagename | String | アプリID / パッケージ名 | |
AppName | String | アプリ名 | |
AppOS | String | アプリOS | |
AdDeliveryURL | String | 配信先URL | |
Videoviewthroughrate | Double | 動画の再生完了率 | |
Month | String | 月 | |
ConversionID | String | コンバージョンID | |
Campaigndeliverysettings | String | キャンペーン配信設定 | |
Adgroupdeliverysettings | String | 広告グループ配信設定 |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
ReportDateRangeType | String | レポートの集計対象期間
使用できる値は次のとおりです。LAST_7_DAYS, LAST_MONTH, THIS_MONTH, THIS_MONTH_EXCEPT_TODAY, TODAY, YESTERDAY, LAST_30_DAYS, LAST_14_DAYS, CUSTOM_DATE, LAST_WEEK, LAST_BUSINESS_WEEK | |
DateRangeStartDate | String | 集計開始日(yyyy-MM-dd) ReportDateRangeType='CUSTOM_DATE' のとき必須 | |
DateRangeEndDate | String | 集計終了日(yyyy-MM-dd) ReportDateRangeType='CUSTOM_DATE' のとき必須 |
To view the Reach report. Simple Select statement will create and retrieve last 7 days report
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.
SELECT * FROM ReportDisplayAdsReach WHERE AccountId = '125466' SELECT * FROM ReportDisplayAdsReach WHERE AccountId = '125466' AND ReportJobId = '123456' SELECT * FROM ReportDisplayAdsReach WHERE AccountId = '125466' AND ReportDateRangeType = 'LAST_7_DAYS' SELECT * FROM ReportDisplayAdsReach WHERE AccountId = '125466' AND ReportDateRangeType = 'CUSTOM_DATE' and DateRangeStartDate = '2022-02-12' AND DateRangeEndDate = '2022-04-29'
Note: Since the Report is Dynamic, so the columns may vary depending upon the API.
Name | Type | References | Description |
ReportJobId | String | ReportJobId | |
AccountId | Long | アカウントID | |
AccountName | String | アカウント名 | |
CampaignID | Long | キャンペーンID | |
CampaignName | String | キャンペーン名 | |
AdGroupID | Long | 広告グループID | |
AdGroupName | String | 広告グループ名 | |
AdID | Long | 広告ID | |
AdName | String | 広告名 | |
Daily | String | 日 | |
Campaigngoals | String | キャンペーン目的 | |
Campaignbuyingtype | String | キャンペーン購入タイプ | |
Packagename | String | 商品名 | |
Impressions | Long | インプレッション数 | |
CTR | Double | クリック率 | |
Cost | Double | コスト | |
Clicks | Long | クリック数 | |
Avg_CPC | Double | 平均CPC | |
Avg_CPM | Double | 平均CPM | |
Avg_vCPM | Double | 平均vCPM | |
Viewableimpressions | Long | ビューアブルインプレッション数 | |
Measuredimpressions | Long | メジャードインプレッション数 | |
Viewableclicks | Long | ビューアブルクリック数 | |
Measuredimpressionrate | Double | メジャードインプレッション測定率 | |
Viewableimpressionrate | Double | ビューアブルインプレッション率 | |
ViewableCTR | Double | ビューアブルクリック率 | |
Avg_CPV | Double | 平均CPV | |
25_videoviews | Long | 動画の25%再生数 | |
50_videoviews | Long | 動画の50%再生数 | |
75_videoviews | Long | 動画の75%再生数 | |
95_videoviews | Long | 動画の95%再生数 | |
100_videoviews | Long | 動画の100%再生数 | |
Avg_videoviewrate | Double | 動画の平均再生率 | |
Avg_durationofvideoviewed | Double | 動画の平均再生時間(秒) | |
Videoviews | Long | 動画の再生開始数 | |
Paidvideoviews_CPV_ | Long | 課金が発生した動画再生数(CPV 課金キャンペーンのみ) | |
Paidvideoviewrate_CPV_ | Double | 課金が発生した動画再生率(CPV 課金キャンペーンのみ) | |
3secvideoviews | Long | 動画の3秒再生数 | |
10secvideoviews | Long | 動画の10秒再生数 | |
Conversions | Long | コンバージョン数 | |
Conv_rate | Double | コンバージョン率 | |
Cost_conv_ | Double | コスト/コンバージョン数 | |
Conversions_all_ | Long | コンバージョン数(全て) | |
Conv_rate_all_ | Double | コンバージョン率(全て) | |
Cost_conv_all_ | Double | コスト/コンバージョン数(全て) | |
Conversions_viaclick_ | Long | コンバージョン数(クリック経由) | |
Conv_rate_viaclick_ | Double | コンバージョン率(クリック経由) | |
Cost_conv_viaclick_ | Double | コスト/コンバージョン数(クリック経由) | |
Cross_deviceconv_ | Long | クロスデバイスコンバージョン数 | |
Reaches | Long | リーチ数 | |
Averagefrequency | Double | 平均接触回数 | |
Startdate | String | 開始日 | |
Enddate | String | 終了日 | |
Lifetimebudget | Long | 通期予算 | |
Campaigndeliverytype | String | キャンペーン掲載タイプ | |
View_throughconversions | Long | ビュースルーコンバージョン数 | |
Videoviewthroughrate | Double | 動画の再生完了率 | |
Campaigndeliverysettings | String | キャンペーン配信設定 | |
Adgroupdeliverysettings | String | 広告グループ配信設定 | |
Addeliverysettings | String | 広告配信設定 | |
Reaches_viewableimpression_ | Long | リーチ数(ビューアブルインプレッション) | |
Averagefrequency_viewableimpression_ | Double | 平均接触回数(ビューアブルインプレッション) | |
Reaches_measuredimpression_ | Long | リーチ数(メジャードインプレッション) | |
Averagefrequency_measuredimpression_ | Double | 平均接触回数(メジャードインプレッション) |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
ReportDateRangeType | String | レポートの集計対象期間
使用できる値は次のとおりです。LAST_7_DAYS, LAST_MONTH, THIS_MONTH, THIS_MONTH_EXCEPT_TODAY, TODAY, YESTERDAY, LAST_30_DAYS, LAST_14_DAYS, CUSTOM_DATE, LAST_WEEK, LAST_BUSINESS_WEEK | |
DateRangeStartDate | String | 集計開始日(yyyy-MM-dd) ReportDateRangeType='CUSTOM_DATE' のとき必須 | |
DateRangeEndDate | String | 集計終了日(yyyy-MM-dd) ReportDateRangeType='CUSTOM_DATE' のとき必須 |
To view the Search_target report. Simple Select statement will create and retrieve last 7 days report
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.
SELECT * FROM ReportDisplayAdsSearch_target WHERE AccountId = '125466' SELECT * FROM ReportDisplayAdsSearch_target WHERE AccountId = '125466' AND ReportJobId = '123456' SELECT * FROM ReportDisplayAdsSearch_target WHERE AccountId = '125466' AND ReportDateRangeType = 'LAST_7_DAYS' SELECT * FROM ReportDisplayAdsSearch_target WHERE AccountId = '125466' AND ReportDateRangeType = 'CUSTOM_DATE' and DateRangeStartDate = '2022-02-12' AND DateRangeEndDate = '2022-04-29'
Note: Since the Report is Dynamic, so the columns may vary depending upon the API.
Name | Type | References | Description |
ReportJobId | String | ReportJobId | |
AccountId | Long | アカウントID | |
AccountName | String | アカウント名 | |
AdGroupID | Long | 広告グループID | |
AdGroupName | String | 広告グループ名 | |
Conversions_all_ | Long | コンバージョン数(全て) | |
Conv_rate_all_ | Double | コンバージョン率(全て) | |
Conv_value_all_ | Long | コンバージョンの価値(全て) | |
Conv_value_all_cost | Double | コンバージョンの価値(全て)/コスト | |
AppID_Packagename | String | アプリID / パッケージ名 | |
AppName | String | アプリ名 | |
AppOS | String | アプリOS | |
Web_App | String | ウェブ / アプリ | |
Avg_CPC | Double | 平均CPC | |
Avg_CPM | Double | 平均CPM | |
Avg_CPV | Double | 平均CPV | |
Avg_position | Double | 平均掲載順位 | |
Avg_durationofvideoviewed | Double | 動画の平均再生時間(秒) | |
Avg_videoviewrate | Double | 動画の平均再生率 | |
Avg_vCPM | Double | 平均vCPM | |
Campaignbuyingtype | String | キャンペーン購入タイプ | |
Campaigngoals | String | キャンペーン目的 | |
CampaignID | Long | キャンペーンID | |
CampaignName | String | キャンペーン名 | |
Clicks | Long | クリック数 | |
CTR | Double | クリック率 | |
Conv_rate | Double | コンバージョン率 | |
Conv_value | Long | コンバージョンの価値 | |
Conv_value_cost | Double | コンバージョンの価値 / コスト | |
Conv_value_viaclick_ | Long | コンバージョンの価値(クリック経由) | |
Conv_value_viaclick_cost | Double | コンバージョンの価値(クリック経由) / コスト | |
View_throughconversions | Long | ビュースルーコンバージョン数 | |
ObjectiveofConversionTracking | String | コンバージョン測定の目的 | |
ConversionName | String | コンバージョン名 | |
Conv_rate_viaclick_ | Double | コンバージョン率(クリック経由) | |
Conversions | Long | コンバージョン数 | |
Conversions_viaclick_ | Long | コンバージョン数(クリック経由) | |
Cost | Double | コスト | |
Cost_conv_all_ | Double | コスト/コンバージョン数(全て) | |
Cost_conv_ | Double | コスト/コンバージョン数 | |
Cost_conv_viaclick_ | Double | コスト/コンバージョン数(クリック経由) | |
Cross_deviceconv_ | Long | クロスデバイスコンバージョン数 | |
Daily | String | 日 | |
Device | String | デバイス | |
Impressions | Long | インプレッション数 | |
Month | String | 月 | |
Measuredimpressions | Long | メジャードインプレッション数 | |
Measuredimpressionrate | Double | メジャードインプレッション測定率 | |
OS | String | OS | |
Paidvideoviewrate_CPV_ | Double | 課金が発生した動画再生率(CPV 課金キャンペーンのみ) | |
Paidvideoviews_CPV_ | Long | 課金が発生した動画再生数(CPV 課金キャンペーンのみ) | |
SearchkeywordlistID | Long | サーチキーワードリストID | |
Searchkeywordlistname | String | サーチキーワードリスト名 | |
Campaigndeliverytype | String | キャンペーン掲載タイプ | |
Conv_value_all_conv_all_ | Double | コンバージョンの価値(全て) / コンバージョン数(全て) | |
Conv_value_conv_ | Double | コンバージョンの価値 / コンバージョン数 | |
Conv_value_viaclick_conv_viaclick_ | Double | コンバージョンの価値(クリック経由) / コンバージョン数(クリック経由) | |
Videoviews | Long | 動画の再生開始数 | |
3secvideoviews | Long | 動画の3秒再生数 | |
10secvideoviews | Long | 動画の10秒再生数 | |
25_videoviews | Long | 動画の25%再生数 | |
50_videoviews | Long | 動画の50%再生数 | |
75_videoviews | Long | 動画の75%再生数 | |
95_videoviews | Long | 動画の95%再生数 | |
100_videoviews | Long | 動画の100%再生数 | |
Viewableclicks | Long | ビューアブルクリック数 | |
ViewableCTR | Double | ビューアブルクリック率 | |
Viewableimpressions | Long | ビューアブルインプレッション数 | |
Viewableimpressionrate | Double | ビューアブルインプレッション率 | |
Videoviewthroughrate | Double | 動画の再生完了率 | |
ConversionID | String | コンバージョンID | |
Campaigndeliverysettings | String | キャンペーン配信設定 | |
Adgroupdeliverysettings | String | 広告グループ配信設定 |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
ReportDateRangeType | String | レポートの集計対象期間
使用できる値は次のとおりです。LAST_7_DAYS, LAST_MONTH, THIS_MONTH, THIS_MONTH_EXCEPT_TODAY, TODAY, YESTERDAY, LAST_30_DAYS, LAST_14_DAYS, CUSTOM_DATE, LAST_WEEK, LAST_BUSINESS_WEEK | |
DateRangeStartDate | String | 集計開始日(yyyy-MM-dd) ReportDateRangeType='CUSTOM_DATE' のとき必須 | |
DateRangeEndDate | String | 集計終了日(yyyy-MM-dd) ReportDateRangeType='CUSTOM_DATE' のとき必須 |
To view the Site_category report. Simple Select statement will create and retrieve last 7 days report
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.
SELECT * FROM ReportDisplayAdsSite_category WHERE AccountId = '125466' SELECT * FROM ReportDisplayAdsSite_category WHERE AccountId = '125466' AND ReportJobId = '123456' SELECT * FROM ReportDisplayAdsSite_category WHERE AccountId = '125466' AND ReportDateRangeType = 'LAST_7_DAYS' SELECT * FROM ReportDisplayAdsSite_category WHERE AccountId = '125466' AND ReportDateRangeType = 'CUSTOM_DATE' and DateRangeStartDate = '2022-02-12' AND DateRangeEndDate = '2022-04-29'
Note: Since the Report is Dynamic, so the columns may vary depending upon the API.
Name | Type | References | Description |
ReportJobId | String | ReportJobId | |
AccountId | Long | アカウントID | |
AccountName | String | アカウント名 | |
CampaignID | Long | キャンペーンID | |
CampaignName | String | キャンペーン名 | |
AdGroupID | Long | 広告グループID | |
AdGroupName | String | 広告グループ名 | |
Month | String | 月 | |
Daily | String | 日 | |
AdDistribution | String | 広告掲載方式 | |
Device | String | デバイス | |
SiteCategory | String | サイトカテゴリー名 | |
ObjectiveofConversionTracking | String | コンバージョン測定の目的 | |
Carrier | String | キャリア | |
ConversionName | String | コンバージョン名 | |
OS | String | OS | |
Web_App | String | ウェブ/アプリ | |
CampaignType | String | キャンペーンタイプ | |
AppID_Packagename | String | アプリID / パッケージ名 | |
AppName | String | アプリ名 | |
AppOS | String | アプリOS | |
Campaigngoals | String | キャンペーン目的 | |
Campaignbuyingtype | String | キャンペーン購入タイプ | |
Impressions | Long | インプレッション数 | |
CTR | Double | クリック率 | |
Cost | Double | コスト | |
Clicks | Long | クリック数 | |
Avg_CPC | Double | 平均CPC | |
Avg_position | Double | 平均掲載順位 | |
Viewableimpressions | Long | ビューアブルインプレッション数 | |
Avg_CPV | Double | 平均CPV | |
25_videoviews | Long | 動画の25%再生数 | |
50_videoviews | Long | 動画の50%再生数 | |
75_videoviews | Long | 動画の75%再生数 | |
95_videoviews | Long | 動画の95%再生数 | |
100_videoviews | Long | 動画の100%再生数 | |
Avg_videoviewrate | Double | 動画の平均再生率 | |
Avg_durationofvideoviewed | Double | 動画の平均再生時間(秒) | |
Videoviews | Long | 動画の再生開始数 | |
Paidvideoviews_CPV_ | Long | 課金が発生した動画再生数(CPV 課金キャンペーンのみ) | |
Paidvideoviewrate_CPV_ | Double | 課金が発生した動画再生率(CPV 課金キャンペーンのみ) | |
3secvideoviews | Long | 動画の3秒再生数 | |
Conversions | Long | コンバージョン数 | |
Conv_rate | Double | コンバージョン率 | |
Cost_conv_ | Double | コスト / コンバージョン数 | |
Conv_value | Long | コンバージョンの価値 | |
Conv_value_conv_ | Double | コンバージョンの価値 / コンバージョン数 | |
Conversions_all_ | Long | コンバージョン数(全て) | |
Conv_rate_all_ | Double | コンバージョン率(全て) | |
Cost_conv_all_ | Double | コスト / コンバージョン数(全て) | |
Conv_value_all_ | Long | コンバージョンの価値(全て) | |
Conv_value_all_conv_all_ | Double | コンバージョンの価値(全て)/コンバージョン数(全て) | |
Conversions_viaclick_ | Long | コンバージョン数(クリック経由) | |
Conv_rate_viaclick_ | Double | コンバージョン率(クリック経由) | |
Cost_conv_viaclick_ | Double | コスト / コンバージョン数(クリック経由) | |
Conv_value_viaclick_ | Long | コンバージョンの価値(クリック経由) | |
Conv_value_viaclick_conv_viaclick_ | Double | コンバージョンの価値(クリック経由) / コンバージョン数(クリック経由) | |
Cross_deviceconv_ | Long | クロスデバイスコンバージョン数 | |
Conv_value_cost | Double | コンバージョンの価値 / コスト | |
Conv_value_all_cost | Double | コンバージョンの価値(全て) / コスト | |
Conv_value_viaclick_cost | Double | コンバージョンの価値(クリック経由) / コスト | |
Avg_CPM | Double | 平均CPM | |
Avg_vCPM | Double | 平均vCPM | |
Measuredimpressions | Long | メジャードインプレッション数 | |
Viewableclicks | Long | ビューアブルクリック数 | |
Measuredimpressionrate | Double | メジャードインプレッション測定率 | |
Viewableimpressionrate | Double | ビューアブルインプレッション率 | |
ViewableCTR | Double | ビューアブルクリック率 | |
10secvideoviews | Long | 動画の10秒再生数 | |
Campaigndeliverytype | String | キャンペーン掲載タイプ | |
View_throughconversions | Long | ビュースルーコンバージョン数 | |
Videoviewthroughrate | Double | 動画の再生完了率 | |
ConversionID | String | コンバージョンID | |
Campaigndeliverysettings | String | キャンペーン配信設定 | |
Adgroupdeliverysettings | String | 広告グループ配信設定 |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
ReportDateRangeType | String | レポートの集計対象期間
使用できる値は次のとおりです。LAST_7_DAYS, LAST_MONTH, THIS_MONTH, THIS_MONTH_EXCEPT_TODAY, TODAY, YESTERDAY, LAST_30_DAYS, LAST_14_DAYS, CUSTOM_DATE, LAST_WEEK, LAST_BUSINESS_WEEK | |
DateRangeStartDate | String | 集計開始日(yyyy-MM-dd) ReportDateRangeType='CUSTOM_DATE' のとき必須 | |
DateRangeEndDate | String | 集計終了日(yyyy-MM-dd) ReportDateRangeType='CUSTOM_DATE' のとき必須 |
To view the Url report. Simple Select statement will create and retrieve last 7 days report
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.
SELECT * FROM ReportDisplayAdsUrl WHERE AccountId = '125466' SELECT * FROM ReportDisplayAdsUrl WHERE AccountId = '125466' AND ReportJobId = '123456' SELECT * FROM ReportDisplayAdsUrl WHERE AccountId = '125466' AND ReportDateRangeType = 'LAST_7_DAYS' SELECT * FROM ReportDisplayAdsUrl WHERE AccountId = '125466' AND ReportDateRangeType = 'CUSTOM_DATE' and DateRangeStartDate = '2022-02-12' AND DateRangeEndDate = '2022-04-29'
Note: Since the Report is Dynamic, so the columns may vary depending upon the API.
Name | Type | References | Description |
ReportJobId | String | ReportJobId | |
AccountId | Long | アカウントID | |
AccountName | String | アカウント名 | |
CampaignID | Long | キャンペーンID | |
CampaignName | String | キャンペーン名 | |
AdGroupID | Long | 広告グループID | |
AdGroupName | String | 広告グループ名 | |
Daily | String | 日 | |
AdDistribution | String | 広告掲載方式 | |
Device | String | デバイス | |
AdDeliveryURL | String | 配信先URL | |
ObjectiveofConversionTracking | String | コンバージョン測定の目的 | |
Carrier | String | キャリア | |
ConversionName | String | コンバージョン名 | |
OS | String | OS | |
Web_App | String | ウェブ / アプリ | |
Campaigngoals | String | キャンペーン目的 | |
Campaignbuyingtype | String | キャンペーン購入タイプ | |
Packagename | String | 商品名 | |
Impressions | Long | インプレッション数 | |
CTR | Double | クリック率 | |
Cost | Double | コスト | |
Clicks | Long | クリック数 | |
Avg_CPC | Double | 平均CPC | |
Viewableimpressions | Long | ビューアブルインプレッション数 | |
Avg_CPV | Double | 平均CPV | |
25_videoviews | Long | 動画の25%再生数 | |
50_videoviews | Long | 動画の50%再生数 | |
75_videoviews | Long | 動画の75%再生数 | |
95_videoviews | Long | 動画の95%再生数 | |
100_videoviews | Long | 動画の100%再生数 | |
Avg_videoviewrate | Double | 動画の平均再生率 | |
Avg_durationofvideoviewed | Double | 動画の平均再生時間(秒) | |
Conversions | Long | コンバージョン数 | |
Conv_rate | Double | コンバージョン率 | |
Cost_conv_ | Double | コスト/コンバージョン数 | |
Videoviews | Long | 動画の再生開始数 | |
Paidvideoviews_CPV_ | Long | 課金が発生した動画再生数(CPV 課金キャンペーンのみ) | |
Paidvideoviewrate_CPV_ | Double | 課金が発生した動画再生率(CPV 課金キャンペーンのみ) | |
3secvideoviews | Long | 動画の3秒再生数 | |
Conv_value | Long | コンバージョンの価値 | |
Conv_value_conv_ | Double | コンバージョンの価値 / コンバージョン数 | |
Conversions_all_ | Long | コンバージョン数(全て) | |
Conv_rate_all_ | Double | コンバージョン率(全て) | |
Cost_conv_all_ | Double | コスト / コンバージョン数(全て) | |
Conv_value_all_ | Long | コンバージョンの価値(全て) | |
Conv_value_all_conv_all_ | Double | コンバージョンの価値(全て) / コンバージョン数(全て) | |
Conversions_viaclick_ | Long | コンバージョン数(クリック経由) | |
Conv_rate_viaclick_ | Double | コンバージョン率(クリック経由) | |
Cost_conv_viaclick_ | Double | コスト / コンバージョン数(クリック経由) | |
Conv_value_viaclick_ | Long | コンバージョンの価値(クリック経由) | |
Conv_value_viaclick_conv_viaclick_ | Double | コンバージョンの価値(クリック経由) / コンバージョン数(クリック経由) | |
Cross_deviceconv_ | Long | クロスデバイスコンバージョン数 | |
Conv_value_cost | Double | コンバージョンの価値 / コスト | |
Conv_value_all_cost | Double | コンバージョンの価値(全て) / コスト | |
Conv_value_viaclick_cost | Double | コンバージョンの価値(クリック経由) / コスト | |
Avg_CPM | Double | 平均CPM | |
Avg_vCPM | Double | 平均vCPM | |
Measuredimpressions | Long | メジャードインプレッション数 | |
Viewableclicks | Long | ビューアブルクリック数 | |
Measuredimpressionrate | Double | メジャードインプレッション測定率 | |
Viewableimpressionrate | Double | ビューアブルインプレッション率 | |
ViewableCTR | Double | ビューアブルクリック率 | |
10secvideoviews | Long | 動画の10秒再生数 | |
Lifetimebudget | Long | 通期予算 | |
Campaigndeliverytype | String | キャンペーン掲載タイプ | |
View_throughconversions | Long | ビュースルーコンバージョン数 | |
Videoviewthroughrate | Double | 動画の再生完了率 | |
ConversionID | String | コンバージョンID | |
Campaigndeliverysettings | String | キャンペーン配信設定 | |
Adgroupdeliverysettings | String | 広告グループ配信設定 | |
Avg_position | Double | 平均掲載順位 | |
AppID_Packagename | String | アプリID / パッケージ名 | |
AppName | String | アプリ名 | |
AppOS | String | アプリOS | |
Month | String | 月 |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
ReportDateRangeType | String | レポートの集計対象期間
使用できる値は次のとおりです。LAST_7_DAYS, LAST_MONTH, THIS_MONTH, THIS_MONTH_EXCEPT_TODAY, TODAY, YESTERDAY, LAST_30_DAYS, LAST_14_DAYS, CUSTOM_DATE, LAST_WEEK, LAST_BUSINESS_WEEK | |
DateRangeStartDate | String | 集計開始日(yyyy-MM-dd) ReportDateRangeType='CUSTOM_DATE' のとき必須 | |
DateRangeEndDate | String | 集計終了日(yyyy-MM-dd) ReportDateRangeType='CUSTOM_DATE' のとき必須 |
Get the keyword for search targeting.
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
SELECT * FROM SearchKeywordIdeas WHERE AvailabilityStatus = 'AVAILABLE' LIMIT 10
Name | Type | References | Description |
SearchKeywordId [KEY] | Int64 | Search Keyword ID | |
AvailabilityStatus | String | Availability of keywords for search targeting
使用できる値は次のとおりです。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. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
KeywordFrequency | String | search frequency information on Search Keyword.
使用できる値は次のとおりです。ONCE_OR_MORE, TWICE_OR_MORE, THREE_TIMES_OR_MORE, UNKNOWN | |
KeywordRecency | String | Storing the effective period information of Search Keyword.
使用できる値は次のとおりです。WITHIN_1DAY, WITHIN_3DAYS, WITHIN_7DAYS, WITHIN_14DAYS, WITHIN_30DAYS, UNKNOWN | |
MatchType | String | Search method
使用できる値は次のとおりです。EXACT, BROAD, UNKNOWN |
Retrieve the details of search keyword. The columns values set read-only false can be inserted in the parent table using Temp tables.
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.
For example:
SELECT * FROM SearchKeywordListSearchKeywords WHERE AccountId = '1002504155' SELECT * FROM SearchKeywordListSearchKeywords WHERE AccountId = '1002504155' AND SearchKeywordListId = '1002346070'
Name | Type | References | Description |
AccountId | Int64 |
DisplayAdsAccounts.AccountId | Account ID. |
SearchKeywordListId | Int64 |
SearchKeywordList.SearchKeywordListId | Search keyword list ID. |
SearchKeywordId | Int64 | Search keyword ID. |
Get SearchLift information.
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.
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')
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. |
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.
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.
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')
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
使用できる値は次のとおりです。BRAND, SERVICE, CAMPAIGN, UNKNOWN |
Get the list of site category.
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.
For example:
SELECT * FROM SiteCategories WHERE Lang = 'EN' SELECT * FROM SiteCategories WHERE Lang = 'EN' AND CODE = 'TC-SC-10110100100100'
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.
使用できる値は次のとおりです。EN, JA, UNKNOWN |
Get the stats information of each campaign, ad group, ad, image and video.
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.
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 StartDate = '20210703' SELECT * FROM Stats WHERE AccountId = '1002504155' AND EndDate = '20210703'
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. | |
AdGroupStatsValueStatsAllConvRate | String | Conv. rate (all) | |
AdGroupStatsValueStatsAllConv | Int64 | Conversions (all) | |
AdGroupStatsValueStatsAllConvValue | String | Conv. value (all) | |
AdGroupStatsValueStatsAllConvValuePerCost | String | Conv. value (all)/cost All Conv. | |
AdGroupStatsValueStatsAllCpa | String | Cost/conv. (all) | |
AdGroupStatsValueStatsAvgCpv | String | Avg. CPV | |
AdGroupStatsValueStatsAvgDurationVideoViewed | String | Avg. duration of video viewed | |
AdGroupStatsValueStatsAvgPercentVideoViewed | String | Avg. video view rate | |
AdGroupStatsValueStatsAvgCpc | String | Avg. CPC | |
AdGroupStatsValueStatsAvgDeliverRank | String | Avg. position (the average of eCPM rank on ads delivery) | |
AdGroupStatsValueStatsImpressionShareBudgetLoss | String | Impression share lost rate(budget) | |
AdGroupStatsValueStatsClicks | Int64 | Number of clicks | |
AdGroupStatsValueStatsClickRate | String | Click through rate | |
AdGroupStatsValueStatsClickRatePrev | String | CTR (previous) | |
AdGroupStatsValueStatsConvRate | String | Conv. rate | |
AdGroupStatsValueStatsConversionRateViaAdClick | String | Conv. rate (via click) | |
AdGroupStatsValueStatsConversions | Int64 | Conversions | |
AdGroupStatsValueStatsConversionsViaAdClick | Int64 | Conversions (via click) | |
AdGroupStatsValueStatsConvValue | 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) | |
AdGroupStatsValueStatsImpressionShareRankLoss | String | Impression share lost rate(rank) | |
AdGroupStatsValueStatsTotalVimps | Int64 | Measured impressions (previous) | |
AdGroupStatsValueStatsValuePerAllConv | String | Conv. value (all)/conv. (all) | |
AdGroupStatsValueStatsValuePerConv | 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 | |
AdGroupStatsValueStatsConvValueViaViewThrough | Int64 | View through conversions | |
AdGroupStatsValueStatsViewableImps | 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. | |
AdStatsValueStatsAllConvRate | String | Conv. rate (all) | |
AdStatsValueStatsAllConv | Int64 | Conversions (all) | |
AdStatsValueStatsAllConvValue | String | Conv. value (all) | |
AdStatsValueStatsAllConvValuePerCost | String | Conv. value (all)/cost All Conv. | |
AdStatsValueStatsAllCpa | String | Cost/conv. (all) | |
AdStatsValueStatsAvgCpv | String | Avg. CPV | |
AdStatsValueStatsAvgDurationVideoViewed | String | Avg. duration of video viewed | |
AdStatsValueStatsAvgPercentVideoViewed | String | Avg. video view rate | |
AdStatsValueStatsAvgCpc | String | Avg. CPC | |
AdStatsValueStatsAvgDeliverRank | String | Avg. position (the average of eCPM rank on ads delivery) | |
AdStatsValueStatsImpressionShareBudgetLoss | String | Impression share lost rate(budget) | |
AdStatsValueStatsClicks | Int64 | Number of clicks | |
AdStatsValueStatsClickRate | String | Click through rate | |
AdStatsValueStatsClickRatePrev | String | CTR (previous) | |
AdStatsValueStatsConvRate | String | Conv. rate | |
AdStatsValueStatsConversionRateViaAdClick | String | Conv. rate (via click) | |
AdStatsValueStatsConversions | Int64 | Conversions | |
AdStatsValueStatsConversionsViaAdClick | Int64 | Conversions (via click) | |
AdStatsValueStatsConvValue | String | Conv. value | |
AdStatsValueStatsConvValueViaAdClick | 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) | |
AdStatsValueStatsImpressionShareRankLoss | String | Impression share lost rate(rank) | |
AdStatsValueStatsTotalVimps | Int64 | Measured impressions (previous) | |
AdStatsValueStatsValuePerAllConv | String | Conv. value (all)/conv. (all) | |
AdStatsValueStatsValuePerConv | String | Conv. value/conv. | |
AdStatsValueStatsValuePerConvViaAdClick | 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 | |
AdStatsValueStatsConvValueViaViewThrough | Int64 | View through conversions | |
AdStatsValueStatsViewableImps | Int64 | Viewable impressions | |
CampaignStatsValueCampaignId | Int64 | Campaign ID. | |
CampaignStatsValueCampaignName | String | Campaign name. | |
CampaignStatsValueStatsAllConvRate | String | Conv. rate (all) | |
CampaignStatsValueStatsAllConv | Int64 | Conversions (all) | |
CampaignStatsValueStatsAllConvValue | String | Conv. value (all) | |
CampaignStatsValueStatsAllConvValuePerCost | String | Conv. value (all)/cost All Conv. | |
CampaignStatsValueStatsAllCpa | String | Cost/conv. (all) | |
CampaignStatsValueStatsAvgCpv | String | Avg. CPV | |
CampaignStatsValueStatsAvgDurationVideoViewed | String | Avg. duration of video viewed | |
CampaignStatsValueStatsAvgPercentVideoViewed | String | Avg. video view rate | |
CampaignStatsValueStatsAvgCpc | String | Avg. CPC | |
CampaignStatsValueStatsAvgDeliverRank | String | Avg. position (the average of eCPM rank on ads delivery) | |
CampaignStatsValueStatsImpressionShareBudgetLoss | String | Impression share lost rate(budget) | |
CampaignStatsValueStatsClicks | Int64 | Number of clicks | |
CampaignStatsValueStatsClickRate | String | Click through rate | |
CampaignStatsValueStatsClickRatePrev | String | CTR (previous) | |
CampaignStatsValueStatsConvRate | String | Conv. rate | |
CampaignStatsValueStatsConversionRateViaAdClick | String | Conv. rate (via click) | |
CampaignStatsValueStatsConversions | Int64 | Conversions | |
CampaignStatsValueStatsConversionsViaAdClick | Int64 | Conversions (via click) | |
CampaignStatsValueStatsConvValue | String | Conv. value | |
CampaignStatsValueStatsConvValueViaAdClick | 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) | |
CampaignStatsValueStatsImpressionShareRankLoss | String | Impression share lost rate(rank) | |
CampaignStatsValueStatsTotalVimps | Int64 | Measured impressions (previous) | |
CampaignStatsValueStatsValuePerAllConv | String | Conv. value (all)/conv. (all) | |
CampaignStatsValueStatsValuePerConv | String | Conv. value/conv. | |
CampaignStatsValueStatsValuePerConvViaAdClick | 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 | |
CampaignStatsValueStatsConvValueViaViewThrough | Int64 | View through conversions | |
CampaignStatsValueStatsViewableImps | Int64 | Viewable impressions | |
Errors | String | Error information. | |
ImageStatsValueMediaId | Int64 | Media ID | |
ImageStatsValueMediaName | String | File name | |
ImageStatsValueMediaTitle | String | Media title | |
ImageStatsValueStatsAllConvRate | String | Conv. rate (all) | |
ImageStatsValueStatsAllConv | Int64 | Conversions (all) | |
ImageStatsValueStatsAllConvValue | String | Conv. value (all) | |
ImageStatsValueStatsAllConvValuePerCost | String | Conv. value (all)/cost All Conv. | |
ImageStatsValueStatsAllCpa | String | Cost/conv. (all) | |
ImageStatsValueStatsAvgCpv | String | Avg. CPV | |
ImageStatsValueStatsAvgDurationVideoViewed | String | Avg. duration of video viewed | |
ImageStatsValueStatsAvgPercentVideoViewed | String | Avg. video view rate | |
ImageStatsValueStatsAvgCpc | String | Avg. CPC | |
ImageStatsValueStatsAvgDeliverRank | String | Avg. position (the average of eCPM rank on ads delivery) | |
ImageStatsValueStatsImpressionShareBudgetLoss | String | Impression share lost rate(budget) | |
ImageStatsValueStatsClicks | Int64 | Number of clicks | |
ImageStatsValueStatsClickRate | String | Click through rate | |
ImageStatsValueStatsClickRatePrev | String | CTR (previous) | |
ImageStatsValueStatsConvRate | String | Conv. rate | |
ImageStatsValueStatsConversionRateViaAdClick | String | Conv. rate (via click) | |
ImageStatsValueStatsConversions | Int64 | Conversions | |
ImageStatsValueStatsConversionsViaAdClick | Int64 | Conversions (via click) | |
ImageStatsValueStatsConvValue | String | Conv. value | |
ImageStatsValueStatsConvValueViaAdClick | 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) | |
ImageStatsValueStatsImpressionShareRankLoss | String | Impression share lost rate(rank) | |
ImageStatsValueStatsTotalVimps | Int64 | Measured impressions (previous) | |
ImageStatsValueStatsValuePerAllConv | String | Conv. value (all)/conv. (all) | |
ImageStatsValueStatsValuePerConv | String | Conv. value/conv. | |
ImageStatsValueStatsValuePerConvViaAdClick | 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 | |
ImageStatsValueStatsConvValueViaViewThrough | Int64 | View through conversions | |
ImageStatsValueStatsViewableImps | Int64 | Viewable impressions | |
OperationSucceeded | Boolean | The process results. If true, the process succeeded. If false, the process failed. | |
PeriodCustomDateEndDate | Date | Acquisition end date of stats information. | |
PeriodCustomDateStartDate | Date | Acquisition start date of stats information. | |
StatsPeriod | String | Summarized period of statistics
使用できる値は次のとおりです。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, REALTIME_LAST25MONTH, REALTIME_LAST37MONTH, CUSTOM_DATE, UNKNOWN | |
TargetStatsValueAdGroupId | Int64 | Ad group ID. | |
TargetStatsValueAdGroupName | String | Ad group name. | |
TargetStatsValueCampaignId | Int64 | Campaign ID. | |
TargetStatsValueCampaignName | String | Campaign name. | |
TargetStatsValueStatsAllConRate | String | Conv. rate (all) | |
TargetStatsValueStatsAllConv | Int64 | Conversions (all) | |
TargetStatsValueStatsAllConvValue | String | Conv. value (all) | |
TargetStatsValueStatsAllConvValuePerCost | String | Conv. value (all)/cost All Conv. | |
TargetStatsValueStatsAllCpa | String | Cost/conv. (all) | |
TargetStatsValueStatsAvgCpv | String | Avg. CPV | |
TargetStatsValueStatsAvgDurationVideoViewed | String | Avg. duration of video viewed | |
TargetStatsValueStatsAvgPercentVideoViewed | String | Avg. video view rate | |
TargetStatsValueStatsAvgCpc | String | Avg. CPC | |
TargetStatsValueStatsAvgDeliverRank | String | Avg. position (the average of eCPM rank on ads delivery) | |
TargetStatsValueStatsImpressionShareBudgetLoss | String | Impression share lost rate(budget) | |
TargetStatsValueStatsClicks | Int64 | Number of clicks | |
TargetStatsValueStatsClickRate | String | Click through rate | |
TargetStatsValueStatsClickRatePrev | String | CTR (previous) | |
TargetStatsValueStatsConvRate | String | Conv. rate | |
TargetStatsValueStatsConversionRateViaAdClick | String | Conv. rate (via click) | |
TargetStatsValueStatsConversions | Int64 | Conversions | |
TargetStatsValueStatsConversionsViaAdClick | Int64 | Conversions (via click) | |
TargetStatsValueStatsConvValue | String | Conv. value | |
TargetStatsValueStatsConvValueViaAdClick | 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) | |
TargetStatsValueStatsImpressionShareRankLoss | String | Impression share lost rate(rank) | |
TargetStatsValueStatsTotalVimps | Int64 | Measured impressions (previous) | |
TargetStatsValueStatsValuePerAllConv | String | Conv. value (all)/conv. (all) | |
TargetStatsValueStatsValuePerConv | String | Conv. value/conv. | |
TargetStatsValueStatsValuePerConvViaAdClick | 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 | |
TargetStatsValueStatsConvValueViaViewThrough | Int64 | View through conversions | |
TargetStatsValueStatsViewableImps | Int64 | Viewable impressions | |
TargetStatsValueTargetAdScheduleTargetDayOfWeek | String | Days of the week to deliver.
使用できる値は次のとおりです。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.
使用できる値は次のとおりです。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
使用できる値は次のとおりです。PAUSED, ACTIVE, UNKNOWN | |
TargetStatsValueTargetAppTargetDeviceAppType | String | Type of delivery application.
使用できる値は次のとおりです。APP, WEB, UNKNOWN | |
TargetStatsValueTargetAudienceCategoryTargetAudienceCategoryType | String | Audience category information. | |
TargetStatsValueTargetAudienceCategoryTargetCategoryNameEn | String | Category name (English) | |
TargetStatsValueTargetAudienceCategoryTargetCategoryNameJa | String | Category name (Japanese) | |
TargetStatsValueTargetCarrierTargetCarrierType | String | Stats Service Carrier Type
使用できる値は次のとおりです。DOCOMO, KDDI, SOFTBANK, YMOBILE, OTHERS, UNKNOWN | |
TargetStatsValueTargetDeviceTargetDeviceType | String | Types of target devices.
使用できる値は次のとおりです。DESKTOP, WAP_MOBILE, SMARTPHONE, TABLET, UNKNOWN | |
TargetStatsValueTargetGenderTargetEstimateFlg | String | Extended delivery settings
使用できる値は次のとおりです。PAUSED, ACTIVE, UNKNOWN | |
TargetStatsValueTargetGenderTargetGender | String | Types of gender
使用できる値は次のとおりです。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.
使用できる値は次のとおりです。IOS, ANDROID, UNKNOWN | |
TargetStatsValueTargetOsVersionTargetOsVersion | String | OS Version | |
TargetStatsValueTargetPlacementTargetPlacementUrlListName | String | Placement Url List Name | |
TargetStatsValueTargetPlacementTargetPlacementUrlListType | String | Type of Placement URL list.
使用できる値は次のとおりです。WHITE_LIST, BLACK_LIST, UNKNOWN | |
TargetStatsValueTargetSearchTargetSearchKeywordListName | String | Search Keyword List name | |
TargetStatsValueTargetSiteCategoryTargetCategoryFullNameEn | String | Site category name (English) | |
TargetStatsValueTargetSiteCategoryTargetCategoryFullNameJa | String | Site category name (Japanese) | |
TargetStatsValueTargetAudienceListTargetDeliverType | String | Type of target list
使用できる値は次のとおりです。INCLUDE, EXCLUDE, UNKNOWN | |
TargetStatsValueTargetAudienceListTargetAudienceListName | String | Target list name | |
TargetStatsValueTargetTargetId | String | Stats Service Target ID | |
TargetStatsValueTargetTargetSetting | String | Setting information of target.
使用できる値は次のとおりです。NONE, ACTIVE, PAUSED, UNKNOWN | |
TargetStatsValueTargetTargetType | String | Types of target
使用できる値は次のとおりです。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
使用できる値は次のとおりです。CAMPAIGN, ADGROUP, AD, IMAGE, VIDEO, TARGET, UNKNOWN | |
VideoStatsValueMediaId | Int64 | Media ID | |
VideoStatsValueStatsAllConvRate | String | Conv. rate (all) | |
VideoStatsValueStatsAllConv | Int64 | Conversions (all) | |
VideoStatsValueStatsAllConvValue | String | Conv. value (all) | |
VideoStatsValueStatsAllConvValuePerCost | String | Conv. value (all)/cost All Conv. | |
VideoStatsValueStatsAllCpa | String | Cost/conv. (all) | |
VideoStatsValueStatsAvgCpv | String | Avg. CPV | |
VideoStatsValueStatsAvgDurationVideoViewed | String | Avg. duration of video viewed | |
VideoStatsValueStatsAvgPercentVideoViewed | String | Avg. video view rate | |
VideoStatsValueStatsAvgCpc | String | Avg. CPC | |
VideoStatsValueStatsAvgDeliverRank | String | Avg. position (the average of eCPM rank on ads delivery) | |
VideoStatsValueStatsImpressionShareBudgetLoss | String | Impression share lost rate(budget) | |
VideoStatsValueStatsClicks | Int64 | Number of clicks | |
VideoStatsValueStatsClickRate | String | Click through rate | |
VideoStatsValueStatsClickRatePrev | String | CTR (previous) | |
VideoStatsValueStatsConvRate | String | Conv. rate | |
VideoStatsValueStatsConversionRateViaAdClick | String | Conv. rate (via click) | |
VideoStatsValueStatsConversions | Int64 | Conversions | |
VideoStatsValueStatsConversionsViaAdClick | Int64 | Conversions (via click) | |
VideoStatsValueStatsConvValue | String | Conv. value | |
VideoStatsValueStatsConvValueViaAdClick | 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) | |
VideoStatsValueStatsImpressionShareRankLoss | String | Impression share lost rate(rank) | |
VideoStatsValueStatsTotalVimps | Int64 | Measured impressions (previous) | |
VideoStatsValueStatsValuePerAllConv | String | Conv. value (all)/conv. (all) | |
VideoStatsValueStatsValuePerConv | String | Conv. value/conv. | |
VideoStatsValueStatsValuePerConvViaAdClick | 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 | |
VideoStatsValueStatsConvValueViaViewThrough | Int64 | View through conversions | |
VideoStatsValueStatsViewableImps | Int64 | Viewable impressions | |
VideoStatsValueVideoName | String | File name |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
CampaignId | Int64 | Campaign ID. | |
AdGroupId | Int64 | Ad group ID. | |
AdId | Int64 | Ad ID. | |
MediaId | Int64 | Media ID. | |
EndDate | Date | Acquisition end date of stats information. | |
StartDate | Date | Acquisition start date of stats information. | |
TargetType | String | Types of target
使用できる値は次のとおりです。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 |
Get the domain and vendor name that can be specified for the third-party scripting URL.
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
Name | Type | References | Description |
Domain | String | Domain | |
Vendor | String | Third Party Tracking vendor | |
VendorName | String | Logical name of Third Party Tracking vendor |
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.
SELECT * FROM VideosVideoSettingExtraSpecs WHERE AccountId = '1002504155'; SELECT * FROM VideosVideoSettingExtraSpecs WHERE AccountId = '1002504155' AND MediaId = '123456'
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. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
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. |
このセクションでは、利用可能なAPI オブジェクトを示し、Yahoo! Ads API へのSQL の実行について詳しく説明します。
レポートは、一度作成すると変更ができないビューとして表示されます。ただし、従来のデータベースビューとは異なり、特定のテーブルですべてのメトリクスとディメンションを選択することはあまり役に立ちません。このためプロバイダーは、SELECT * クエリはデフォルトのメトリクスとディメンションのセットが要求されていると解釈します。これは、明示的にすべてのカラムを選択しているクエリにも適用されます。
さらにYahoo! Ads API は、データに投影できるまたは返される結果を制限するために使用する、カラムの数や組み合わせを制限します。
Sync App はYahoo! Ads のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。
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. |
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. |
BiddingSeasonalityAdjustment | Create, Read, Update or Delete the bidding seasonality adjustment. |
BiddingStrategies | Create, Read, Update or Delete auto bidding information. |
CampaignAsset | Provides operation of assets associated with campaign. |
CampaignBudget | Create, Read, Update or Delete the campaign budget. |
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. |
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. |
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. |
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. |
To get, add, or delete, Asset information.
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.
For example:
SELECT * FROM AccountCustomizer WHERE AccountId = '1234339' SELECT * FROM AccountCustomizer WHERE AccountId = '1234339' AND CustomizerAttributeId = '510004'
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 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
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. |
Read or Update related to account tracking.
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.
For example:
SELECT * FROM AccountTrackingUrl WHERE AccountId = '25687'
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'
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. 使用できる値は次のとおりです。DISAPPROVED, NONE, APPROVED, APPROVED_WITH_REVIEW, REVIEW, UNKNOWN |
Provides operation of assets associated with ad groups.
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.
For example:
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'
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. |
Read, Update or Delete bid multiplier of adgroup.
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.
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 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 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'
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. 使用できる値は次のとおりです。SMART_PHONE, TABLET, DESKTOP, UNKNOWN |
Read, add, update or delete targeting conditions (criteria) of Ad group.
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.
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 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 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 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'
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. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。KEYWORD, UNKNOWN | |
KeywordMatchType | String | False |
Describes keyword match type. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。NO_RESTRICTION, CONFLICT_WITH_TRADEMARK, CLAIM_IN_PROGRESS, DISAPPROVED_CLAIM, DISAPPROVED_REVIEWER, UNKNOWN | |
Use | String | False |
Describes criterion to be selected. 使用できる値は次のとおりです。BIDDABLE, NEGATIVE, UNKNOWN |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
PortfolioBiddingId | Int64 |
Portfolio bidding ID. |
ContainsLabelId | String |
Describes acquisition flag of label data. 使用できる値は次のとおりです。TRUE, FALSE, UNKNOWN |
LabelIds | Int64 |
Label ID. |
Min | Int64 |
Minimum value of the search range. |
Max | Int64 |
Maximum value of the search range. |
Get,Add or Delete Asset information.
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.
For example:
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 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 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
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. |
Get,Add or Delete Asset information.
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.
For example:
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 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 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
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. |
Create, Read, Update or Delete information of target list setting in ad group level.
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.
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 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 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 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'
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. 使用できる値は次のとおりです。INCLUDED, EXCLUDED, UNKNOWN |
Create, Read, Update or Delete allowed or excluded settings of PageFeedItem setting in ad group.
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.
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 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 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 can be executed by specifying the AccountId and AdGroupId in the WHERE Clause.
For example:
DELETE FROM AdGroupWebpages WHERE AccountId = '8975' AND AdGroupId = '2369'
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. 使用できる値は次のとおりです。ADGROUP, CRITERION, UNKNOWN | |
KeywordCpc | Int64 | False |
Max bid of keyword. | |
Cpc | Int64 | False |
Max bid.The default value in ADD operation will be 1. デフォルト値は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. 使用できる値は次のとおりです。INCLUDED, EXCLUDED, UNKNOWN デフォルト値はINCLUDEDです。 | |
UserStatus | String | False |
Displays ad delivery status that can be set by an user.This field can be updated when ExcludedType is 'INCLUDED'. 使用できる値は次のとおりです。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. |
Create, Read or Update app link information.
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.
For example:
SELECT * FROM AppLinks WHERE AccountId = '1234339' SELECT * FROM AppLinks WHERE AccountId = '1234339' AND AppLinkId = '73'
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 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'
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. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。ENABLED, DISABLED, UNKNOWN | |
SyncStatus | String | False |
Sync Status. 使用できる値は次のとおりです。IN_PROGRESS, COMPLETED, UNKNOWN |
Get, Add or Update Asset Information.
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.
For example:
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 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 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'
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. |
Create, Read, Update or Delete the bidding seasonality adjustment.
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.
For example, the following queries are processed server side:
SELECT * FROM BiddingSeasonalityAdjustment SELECT * FROM BiddingSeasonalityAdjustment WHERE BiddingSeasonalityAdjustmentId = '244' SELECT * FROM BiddingSeasonalityAdjustment WHERE AccountId = '1234339'
Insert can be executed by specifying the AccountId, BiddingSeasonalityAdjustmentName, Devices, StartDateTime, EndDateTime, ConversionRate and CampaignIds 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 BiddingSeasonalityAdjustment (AccountId, BiddingSeasonalityAdjustmentName, Devices, StartDateTime, EndDateTime, ConversionRate, CampaignIds) VALUES (1234339, 'TestByYogesh', 'MOBILE,TABLET', '2023-12-26', '2023-12-28', 4, '2070631,1840749')
Update can be executed by specifying the BiddingSeasonalityAdjustmentId and AccountId in the WHERE Clause. The columns that are not read-only can be Updated. Following is an example of how to Update into this table:
UPDATE BiddingSeasonalityAdjustment SET Description = 'This is the test description' WHERE BiddingSeasonalityAdjustmentId = '245' AND AccountId = '1234339'
Delete can be executed by specifying the AccountId, BiddingSeasonalityAdjustmentId in the WHERE Clause.
For example:
DELETE FROM BiddingSeasonalityAdjustment WHERE AccountId = '1234339' AND BiddingSeasonalityAdjustmentId = '245'
Name | Type | ReadOnly | References | Description |
BiddingSeasonalityAdjustmentId [KEY] | Int64 | True |
Bidding seasonality adjustment ID. | |
AccountId | Int64 | True |
SearchAdsAccounts.AccountId |
Account ID. |
BiddingSeasonalityAdjustmentName | String | False |
Bidding seasonality adjustment name. | |
Description | String | False |
Bidding Seasonality Adjustment description. | |
Devices | String | False |
It describes target device. The Values are MOBILE,TABLET,DESKTOP,UNKOWN | |
StartDateTime | Datetime | False |
Start date of rule setting. | |
EndDateTime | Datetime | False |
End date of rule setting. | |
ConversionRate | Double | False |
Value to adjust conversion rate. Range limit is 0.1 to 10. | |
CampaignIds | String | False |
Campaign ID. |
Create, Read, Update or Delete auto bidding information.
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.
For example:
SELECT * FROM BiddingStrategies WHERE AccountId ='1234339' SELECT * FROM BiddingStrategies WHERE AccountId ='1234339' AND PortfolioBiddingId ='88272' SELECT * FROM BiddingStrategies WHERE AccountId ='1234339' AND Type='TARGET_SPEND'
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 can be executed by specifying the AccountId and PortfolioBiddingId 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 PortfolioBiddingId = '88272'
Delete can be executed by specifying the AccountId and BiddingStrategyId in the WHERE Clause.
For example:
DELETE FROM BiddingStrategies WHERE AccountId = '1234339' AND PortfolioBiddingId = '88272'
Name | Type | ReadOnly | References | Description |
PortfolioBiddingId [KEY] | Int64 | True |
Portfolio 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. 使用できる値は次のとおりです。ANYWHERE_ON_PAGE, TOP_ON_PAGE, ABSOLUTE_TOP_OF_PAGE, UNKNOWN デフォルト値は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. 使用できる値は次のとおりです。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 | |
PortfolioBiddingName | String | False |
Portfolio bidding name(Can set up to 50 characters). |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
ReferenceNumber | String |
This column will be used in Bulk operations to get specific values from the Temp tables. |
Provides operation of assets associated with campaign.
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.
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'
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. |
Create, Read, Update or Delete the campaign budget.
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.
For example, the following queries are processed server side:
SELECT * FROM CampaignBudget SELECT * FROM CampaignBudget WHERE CampaignBudgetId = '1975453' SELECT * FROM CampaignBudget WHERE AccountId = '1234339'
Insert can be executed by specifying the AccountId, CampaignBudgetName and Amount 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 CampaignBudget (AccountId, CampaignBudgetName, Amount) VALUES (1234339, 'TestYogesh', 1100)
Update can be executed by specifying the CampaignBudgetId and AccountId in the WHERE Clause. The columns that are not read-only can be Updated. Following is an example of how to Update into this table:
UPDATE CampaignBudget SET Amount = 200 WHERE CampaignBudgetId = '1975453' AND AccountId = '1234339'
Delete can be executed by specifying the AccountId, CampaignBudgetId in the WHERE Clause.
For example:
DELETE FROM CampaignBudget WHERE AccountId = '1234339' AND CampaignBudgetId = '1975454'
Name | Type | ReadOnly | References | Description |
CampaignBudgetId [KEY] | Int64 | True |
CampaignBudget ID. | |
AccountId | Int64 | True |
SearchAdsAccounts.AccountId |
Account ID. |
CampaignBudgetName | String | False |
CampaignBudget name. | |
Amount | Int64 | False |
Amount of budget of Campaign. |
Create, Read or Delete negative criteria in campaign-level.
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.
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 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 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'
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. 使用できる値は次のとおりです。KEYWORD, UNKNOWN | |
KeywordKeywordMatchType | String | False |
Describes keyword match type. This field is required when criterionType is 'KEYWORD'. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。NEGATIVE, UNKNOWN |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
ReferenceNumber | String |
This column will be used in Bulk operations to get specific values from the Temp tables. |
Get, Add, or Delete Asset information.
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.
For example:
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 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 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
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. |
Get the status or creates job to register for export.
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.
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 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')
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. 使用できる値は次のとおりです。IN_PROGRESS, COMPLETED, TIMEOUT, SYSTEM_ERROR, UNKNOWN | |
Progress | Int64 | True |
Progress of job setting | |
UserName | String | True |
Name of user who run the job. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
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. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。JA, EN, UNKNOWN |
Output | String |
An output format for exporting data. 使用できる値は次のとおりです。CSV, ZIPPED_CSV, UNKNOWN |
Create, Read, Update or Delete target list setting in campaign level.
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.
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 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 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 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'
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. 使用できる値は次のとおりです。INCLUDED, EXCLUDED, UNKNOWN デフォルト値はINCLUDEDです。 |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
ReferenceNumber | String |
This column will be used in Bulk operations to get specific values from the Temp tables. |
Create, Read, Update or Delete target setting information.
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.
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 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 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 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'
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. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。SMART_PHONE, TABLET, DESKTOP, UNKNOWN | |
ScheduleTargetDayOfWeek | String | False |
A day of the week. If targetType is SCHEDULE, this field is required in ADD operation. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。LOCATION, SCHEDULE, NETWORK, PLATFORM, UNKNOWN |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
ReferenceNumber | String |
This column will be used in Bulk operations to get specific values from the Temp tables. |
Create, Read or Delete excluded settings of PageFeedItem for campaign.
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.
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 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 SearchAdsCampaignWebpageParameterConditions#TEMP (Argument, Operator, Type) VALUES ('url', 'CONTAINS', 'URL') INSERT INTO CampaignWebpages (AccountId, CampaignId, WebpageTargetId, WebpageParameterConditions) VALUES ('4698', '12365', '4312', 'SearchAdsCampaignWebpageParameterConditions#TEMP')
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'
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. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
ReferenceNumber | String |
This column will be used in Bulk operations to get specific values from the Temp tables. |
Get, Add or Delete Customizer Attribute Information.
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.
For example:
SELECT * FROM CustomizerAttribute WHERE AccountId = '1234339' SELECT * FROM CustomizerAttribute WHERE AccountId = '1234339' AND Type = 'TEXT'
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 can be executed by specifying the AccountId and CustomizerAttributeId in the WHERE Clause.
For example:
DELETE FROM CustomizerAttribute WHERE AccountId = 1234339 AND CustomizerAttributeId = 510001
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. |
Get, Add or Remove the Page feed asset set.
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.
For example:
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 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 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 can be executed by specifying the AccountId and PageFeedAssetSetId in the WHERE Clause.
For example.
DELETE FROM PageFeedAssetSet WHERE AccountId = 1234339 AND PageFeedAssetSetId = 1728
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. | |
PageFeedAssetSetName | String | False |
Page Feed Asset Set Name. |
Create, update or Read account information.
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.
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 Status IN ('SUSPENDED') SELECT * FROM SearchAdsAccountManagement WHERE AccountId = '25687' AND IncludeTestAccount IN ('ONLY_TEST')
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')
The columns that are not read-only can be Updated.
For example:
UPDATE SearchAdsAccountManagement SET AccountName = 'TestAccount' WHERE AccountId = '1002504155';
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. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。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 | |
AutoTaggingEnabled | String | False |
The Management flag for whether or not to set auto tag. 使用できる値は次のとおりです。TRUE, FALSE, UNKNOWN デフォルト値は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. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。FRONT, BACK, UNKNOWN | |
ClientPhoneNumber | String | False |
Phone number. In xxxxx-xxxxx-xxxxx format. | |
ClientPrefectureCode | String | False |
Describes the code of prefectures. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。PC, DOCOMO, KDDI, SOFTBANK, OTHER, UNKNOWN | |
ClientZip | String | False |
Zip code in xxx-xxxxx format. | |
ClientType | String | False |
Describes the type of client. 使用できる値は次のとおりです。AGENT, SELF, UNKNOWN | |
ContactBizId | String | False |
Contact Business ID. | |
DeliveryStatus | String | False |
Describes account delivery status. 使用できる値は次のとおりです。ACTIVE, PAUSED, UNKNOWN デフォルト値はACTIVEです。 | |
IsAdultAccount | String | False |
The Adult Account flag. 使用できる値は次のとおりです。TRUE, FALSE, UNKNOWN | |
IsTestAccount | String | False |
Describes whether the account is a test account or not. 使用できる値は次のとおりです。TRUE, FALSE, UNKNOWN | |
Status | String | False |
Describes contract status of account. 使用できる値は次のとおりです。INPROGRESS, WAIT_DECIDE, SUSPENDED, SERVING, ENDED, UNKNOWN | |
ClientCorportateNumber | Int64 | False |
Corporate number. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
IncludeTestAccount | String |
Accounts to retrieve. 使用できる値は次のとおりです。ONLY_TEST, EXCLUDE_TEST, ALL, UNKNOWN |
AccountType | String |
Account Payment Types. |
Read Or Update account information.
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.
For example:
SELECT * FROM SearchAdsAccounts WHERE AccountId='123436' SELECT * FROM SearchAdsAccounts WHERE AccountId='123436' AND AccountName='Test' SELECT * FROM SearchAdsAccounts WHERE AccountId='123436' AND AccountStatus IN ('INPROGRESS') SELECT * FROM SearchAdsAccounts WHERE AccountId='123436' AND AccountType IN ('Regular')
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 SearchAdsAccounts SET AccountName = 'Test Account' WHERE AccountId = '123436'
Name | Type | ReadOnly | References | Description |
AccountId [KEY] | Int64 | True |
Account ID. | |
AccountName | String | False |
Account Name. | |
AccountStatus | String | False |
Account status. 使用できる値は次のとおりです。INPROGRESS, WAIT_DECIDE, SUSPENDED, SERVING, ENDED, UNKNOWN | |
AccountType | String | False |
Payment type of the account. 使用できる値は次のとおりです。PREPAY, INVOICE, 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. | |
IsMccAccount | String | False |
Describes whether it is an MCC account. | |
IsTestAccount | String | False |
Describes whether it is a Test account. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
IncludeTestAccount | String |
Accounts to retrieve. 使用できる値は次のとおりです。ONLY_TEST, EXCLUDE_TEST, ALL, UNKNOWN デフォルト値はEXCLUDE_TESTです。 |
IncludeManagerAccount | String |
Represents whether the account to be retrieved includes an MCC account. 使用できる値は次のとおりです。ONLY_MANAGER, EXCLUDE_MANAGER, ALL, UNKNOWN デフォルト値はEXCLUDE_MANAGERです。 |
Create, Read, Update and Delete Ad group information.
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.
For example:
SELECT * FROM SearchAdsAdGroupAds WHERE AccountId = '25687' SELECT * FROM SearchAdsAdGroupAds WHERE AccountId = '25687' AND AdGroupId = '456971' SELECT * FROM SearchAdsAdGroupAds WHERE AccountId = '25687' AND AdId = '87952' SELECT * FROM SearchAdsAdGroupAds WHERE AccountId = '25687' AND AdType='EXTENDED_TEXT_AD' SELECT * FROM SearchAdsAdGroupAds WHERE AccountId = '25687' AND CampaignId = '0147' SELECT * FROM SearchAdsAdGroupAds WHERE AccountId = '25687' AND ContainsLabel = '89456' SELECT * FROM SearchAdsAdGroupAds WHERE AccountId = '25687' AND Userstatus = 'PAUSED' SELECT * FROM SearchAdsAdGroupAds WHERE AccountId = '25687' AND StartDate = '2021-02-15' SELECT * FROM SearchAdsAdGroupAds WHERE AccountId = '25687' AND EndDate = '2021-06-03'
Insert can be executed by specifying the UserStatus,AccountId, AdGroupId and AdId columns. The columns that are not read-only can be inserted optionally.
INSERT INTO SearchAdsAdGroupAds (UserStatus,AccountId,AdGroupId,AdId) VALUES ('PAUSED','78955','78945','96272')
Update can be executed by specifying the AccountId, AdGroupId and AdId in the WHERE Clause. The columns that are not read-only can be Updated.
For example:
UPDATE SearchAdsAdGroupAds SET UserStatus = 'PAUSED' WHERE AccountId = '78955' AND AdGroupId= '78945' AND AdId ='96272'
Delete can be executed by specifying the AccountId,AdGroupId and AdId in the WHERE Clause.
For example:
DELETE FROM SearchAdsAdGroupAds WHERE AccountId = '78955' AND AdGroupId = '78945' AND AdId = '96272'
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. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。TRUE, FALSE, UNKNOWN | |
CustomParametersParameters | String | False |
displays the element of custom parameters. | |
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. | |
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. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。ACTIVE, PAUSED, UNKNOWN | |
TextAd2Headline | String | False |
Title of the ad. | |
TextAd2Description | String | False |
Description of the ad. | |
AppAdHeadline | String | False |
Title of the ad. | |
AppAdDescription | String | False |
Description of the ad. | |
ExtendedTextAdHeadline | String | False |
Title of the Ad. | |
ExtendedTextAdDescription | String | False |
Description of the Ad. | |
DynamicSearchLinkedAdDescription | String | False |
Description of the Ad. | |
DynamicSearchLinkedAdDescription2 | String | False |
Description2 of the ad. | |
ResponsiveSearchAdReviewDescriptions | String | False |
Displays the text asset for the description under review. | |
ResponsiveSearchAdReviewHeadlines | String | False |
Displays the text asset for the headline under review. | |
ResponsiveSearchAdIsRemovePath1 | String | False |
It is a flag for removing an information item. 使用できる値は次のとおりです。TRUE, FALSE, UNKNOWN | |
ResponsiveSearchAdIsRemovePath2 | String | False |
It is a flag for removing an information item (for path2). 使用できる値は次のとおりです。TRUE, FALSE, UNKNOWN | |
ResponsiveSearchAdReviewPath1 | String | False |
The path information which complements display URL generated automatically (Under review). | |
ResponsiveSearchAdReviewPath2 | String | False |
The path information which complements display URL generated automatically (Under review). | |
ReviewFinalUrl | String | False |
Landing Page URL on editorial review. | |
ReviewSmartphoneFinalUrl | String | False |
Landing Page URL (Smartphone) on editorial review. | |
IsRemoveSmartphoneFinalUrl | String | False |
It is a flag for removing an information item. | |
ReviewTrackingUrl | String | False |
Tracking URL on editorial review. | |
IsReviewTrackingUrl | String | False |
It is a flag for removing an information item. | |
ReviewCustomParametersIsRemove | String | False |
Delete flag. 使用できる値は次のとおりです。TRUE, FALSE, UNKNOWN | |
ReviewCustomParametersParameters | String | False |
Displays the element of custom parameters. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
ContainsLabel | Boolean |
Describes acquisition flag of label data. 使用できる値は次のとおりです。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. |
Create, Read, Update or Delete Ad group.
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.
For example:
SELECT * FROM SearchAdsAdGroups WHERE AccountId = '1234339' SELECT * FROM SearchAdsAdGroupRetargetingLists WHERE AccountId = '1234339' AND AdGroupId IN ('303133212')
Insert can be executed by specifying the AccountId, AdGroupName, CampaignId, UserStatus, CustomParameters and UrlReviewDataInReviewUrlParameters 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 ('Test1','Test2') INSERT INTO UrlReviewDataInReviewUrlParameters#TEMP (Key, Value) VALUES('Test3','Test4') INSERT INTO SearchAdsAdGroups (AccountId, AdGroupName, CampaignId, UserStatus, CustomParameters, UrlReviewDataInReviewUrlParameters) VALUES(1234339, 'Test_Yogesh', '1836854', 'ACTIVE', 'CustomParameters#TEMP', 'UrlReviewDataInReviewUrlParameters#TEMP')
Update can be executed by specifying the AccountId, AdGroupId and CampaignId in the WHERE Clause. The columns that are not read-only can be Updated.
For example:
UPDATE SearchAdsAdGroups SET AdGroupName = 'TestSearchAdsAdGroupRetargetingLists' WHERE AccountId = '1234339' AND AdGroupId = '303133212' AND CampaignId = '1833923'
Delete can be executed by specifying the AccountId,AdGroupId and CampaignId in the WHERE Clause.
For example:
DELETE FROM SearchAdsAdGroups WHERE AccountId = '1234339' AND AdGroupId = '303133212' AND CampaignId = '1833923'
Name | Type | ReadOnly | References | Description |
AdGroupId [KEY] | Int64 | True |
Ad group ID. | |
AccountId | Int64 | True |
SearchAdsAccounts.AccountId |
Account ID. |
AdGroupName | String | False |
Ad Group name. | |
AdGroupTrackId | Int64 | False |
Ad Group ID for tracking. | |
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. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。TARGET_LIST, UNKNOWN デフォルト値はTARGET_LISTです。 | |
SettingsTargetingSettingTargetAll | String | False |
Describes the setting of target(include) users on Site Retargeting. 使用できる値は次のとおりです。ACTIVE, DEACTIVATE, UNKNOWN デフォルト値はACTIVEです。 | |
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. 使用できる値は次のとおりです。REVIEW, DISAPPROVAL, NONE, APPROVED, APPROVED_WITH_REVIEW, UNKNOWN | |
UserStatus | String | False |
Displays ad delivery status that can be set by an user. 使用できる値は次のとおりです。ACTIVE, PAUSED, UNKNOWN | |
CampaignBiddingStrategyType | String | False |
Displays the Auto Bidding type. | |
CpcBiddingSchemeCpc | Int64 | False |
Max bid of ad group (CPC). | |
TargetCpaBiddingSchemeTargetCpa | Int64 | False |
Target CPA (tCPA) of ad group. | |
TargetCpaBiddingSchemeIsRemoveTargetCpa | String | False |
Flag for removing an information item. | |
TargetRoasBiddingSchemeTargerRoas | String | False |
Target ROAS (tROAS) of ad group. | |
TargetRoasBiddingSchemeIsRemoveTargerRoas | String | False |
Flag for removing an information item. | |
MaximizeConversionsBiddingSchemeTargetCpa | Int64 | False |
Target CPA (tCPA) of ad group. | |
MaximizeConversionsBiddingSchemeIsRemoveTargetCpa | String | False |
Flag for removing an information item. | |
MaximizeConversionValueBiddingSchemeTargetRoas | Double | False |
Target ROAS (tROAS) of ad group. | |
MaximizeConversionValueBiddingSchemeIsRemoveTargetRoas | String | False |
Flag for removing an information item. | |
PortfolioBiddingId | Int64 | False |
Portfolio bidding ID. | |
PortfolioBiddingName | String | False |
Portfolio bidding name. | |
FrequentlyRunBetterPerformingAdsMode | String | False |
It represents the preferred display setting for highly effective ads. | |
IsRemoveTrackingUrl | String | False |
Flag for removing an information item. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
PortfolioBiddingIds | Int64 |
Portfolio Bidding 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. |
Get procession status about download operation history data or creates job to register for export.
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.
For example:
SELECT * FROM SearchAdsAuditLogs WHERE AccountId = '25687'; SELECT * FROM SearchAdsAuditLogs WHERE AccountId = '23542' AND JobId = '456971';
Insert can be executed by specifying the AccountId and EventSelector columns. The columns that are not read-only can be inserted optionally. Following is an example of how to inserting into SearchAdsAuditLogs table
INSERT INTO SearchAdsAuditLogEventSelector#TEMP (EntityType) VALUES ('FEED_ITEM') INSERT INTO SearchAdsAuditLogs (AccountId, StartDate, EndDate, EventSelector) VALUES ('1002504155','2023-04-21','2023-04-25', 'SearchAdsAuditLogEventSelector#TEMP')
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. 使用できる値は次のとおりです。SJIS, UTF8, 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. 使用できる値は次のとおりです。SYSTEM_ERROR, IN_PROGRESS, COMPLETED, TIMEOUT, UNKNOWN | |
Lang | String | False |
Describes the language setting of operation history data file. 使用できる値は次のとおりです。EN, JA, UNKNOWN デフォルト値はJAです。 | |
Output | String | False |
Specifies the file format of acruiqred operation history data. 使用できる値は次のとおりです。ZIPPED_CSV, ZIPPED_TSV, CSV, TSV, UNKNOWN デフォルト値はCSVです。 | |
SourceType | String | False |
Desribes the operator information of operation history data. 使用できる値は次のとおりです。API, YAHOO_JAPAN, CAMPAIGN_MANAGEMENT_TOOL, ALL, UNKNOWN デフォルト値はAPIです。 | |
OperationSucceeded | String | False |
Processing result. If true, the operation was successful. If false, the process has failed |
Read or Update budget information for the account.
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.
For example:
SELECT * FROM SearchAdsBudgets WHERE AccountId = '12346'
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'
Name | Type | ReadOnly | References | Description |
AccountId [KEY] | Int64 | True |
SearchAdsAccounts.AccountId |
Account ID. |
AccountType | String | False |
Displays the account charge type. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。SUM, MONTHLY, UNKNOWN |
Create, Read, Update or Delete Campaigns.
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.
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 ContainsLabel = 'TRUE' SELECT * FROM SearchAdsCampaigns WHERE AccountId = '12346' AND MinBudgetAmount = '1' AND MaxBudgetAmount = '1000'
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 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 can be executed by specifying the AccountId,CampaignId in the WHERE Clause.
For example:
DELETE FROM SearchAdsCampaigns WHERE AccountId = '12346' AND CampaignId = '23569'
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. | |
AppOsType | String | False |
It is a setting that allows you to adjust ads to be served or not, depending on the user. 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. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。TRUE, FALSE, UNKNOWN デフォルト値は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. 使用できる値は次のとおりです。ANYWHERE_ON_PAGE, TOP_OF_PAGE, ABSOLUTE_TOP_OF_PAGE, UNKNOWN デフォルト値は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. | |
BiddingStrategyConfigurationPortfolioBiddingId | Int64 | False |
Portfolio 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. | |
BiddingStrategyConfigurationPortfolioBiddingName | String | False |
Portfolio Bidding name. Up to 50 characters. | |
BiddingStrategyConfigurationBiddingStrategySource | String | False |
A source of Auto Bidding. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。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. | |
BudgetCampaignBudgetId | Int64 | False |
CampaignBudget ID. In Insert and Update operation, this field is not allowed when setting individual budgets, and is required when setting shared budgets. This field cannot be set at the same time as amount. | |
BudgetCampaignBudgetName | String | False |
CampaignBudget name. | |
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. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。TRUE, FALSE, UNKNOWN デフォルト値は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. 使用できる値は次のとおりです。ANYWHERE_ON_PAGE, TOP_ON_PAGE, ABSOLUTE_TOP_OF_PAGE, UNKNOWN デフォルト値は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. | |
FailedBiddingStrategyConfigurationPortfolioBiddingId | Int64 | False |
Portfolio 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. | |
FailedBiddingStrategyConfigurationPortfolioBiddingName | String | False |
Portfolio Bidding name. Up to 50 characters. | |
FailedBiddingStrategyConfigurationBiddingStrategySource | String | False |
A source of Auto Bidding. 使用できる値は次のとおりです。CAMPAIGN, UNKNOWN | |
FailedBiddingStrategyConfigurationBiddingStrategyType | String | False |
Displays the Auto Bidding type. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。APPROVED_WITH_REVIEW, REVIEW, DISAPPROVED, NONE, APPROVED, UNKNOWN | |
UserStatus | String | False |
Displays ad delivery status that can be set by an user. 使用できる値は次のとおりです。ACTIVE, PAUSED, UNKNOWN | |
BiddingStrategyConfigurationMaximizeConversionsBiddingSchemeTargetCpa | Int64 | False |
Target CPA (JPY). Range limit: 1 - 800000. | |
BiddingStrategyConfigurationMaximizeConversionsBiddingSchemeIsRemoveTargetCpa | String | False |
It is a flag for removing an information item. 使用できる値は次のとおりです。TRUE, FALSE, UNKNOWN | |
BiddingStrategyConfigurationMaximizeConversionValueBiddingSchemeTargetRoas | Double | False |
Target ROAS (Return on advertising spend). Range limit: 0.01 - 1000. | |
BiddingStrategyConfigurationMaximizeConversionValueBiddingSchemeIsRemoveTargetRoas | String | False |
It is a flag for removing an information item. 使用できる値は次のとおりです。TRUE, FALSE, UNKNOWN | |
FailedBiddingStrategyConfigurationMaximizeConversionsBiddingSchemeIsRemoveTargetCpa | String | False |
It is a flag for removing an information item. 使用できる値は次のとおりです。TRUE, FALSE, UNKNOWN | |
FailedBiddingStrategyConfigurationMaximizeConversionValueBiddingSchemeSchemeIsRemoveTargetRoas | String | False |
It is a flag for removing an information item. 使用できる値は次のとおりです。TRUE, FALSE, UNKNOWN |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
ContainsLabel | String |
acquisition flag of label data 使用できる値は次のとおりです。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. |
Create, Read or Update ConversionTracker information.
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.
For example:
SELECT * FROM SearchAdsConversionTracker WHERE AccountId = '12346'; SELECT * FROM SearchAdsConversionTracker WHERE AccountId = '12346' AND ConversionTrackerId = '12323';
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 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'
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. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。ANDROID_MARKET, UNKNOWN | |
AppConversionAppPostbackUrlIsRemoveUrl | String | False |
The clear flag of postback URL. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。ANDROID, UNKNOWN | |
AppLinkConversionAppVendorId | String | False |
Application Vendor ID. | |
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. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。TRUE, FALSE, UNKNOWN デフォルト値は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. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。HTML, CHTML, XHTML, WML, UNKNOWN | |
WebConversionTrackingCodeType | String | False |
ConversionTrackerServiceTrackingCodeType describes tracking type of web page. If the conversionTrackerType is WEB_CONVERSION, this field will be required in ADD operation. 使用できる値は次のとおりです。WEBPAGE, CLICK_TO_CALL, IMPORT, UNKNOWN |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
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. |
Create, Read, Update or Delete information of label.
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.
For example:
SELECT * FROM SearchAdsLabels WHERE AccountId = '12346' SELECT * FROM SearchAdsLabels WHERE AccountId = '12346' AND LabelId = '26894'
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 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 can be executed by specifying the AccountId and LabelId in the WHERE Clause.
For example:
DELETE FROM SearchAdsLabels WHERE AccountId = '1234' AND LabelId = '15684'
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. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
CountLabeledEntity | String |
Setting of Label number count flag. |
Create, Read or Delete a report.
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
SELECT * FROM SearchAdsReports WHERE AccountId = '125466'
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 can be executed by specifying the AccountId and ReportJobId in the WHERE Clause. For example:
DELETE FROM SearchAdsReports WHERE AccountId = '1234' AND ReportJobId = '89756'
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. 使用できる値は次のとおりです。NONE, ZIP, UNKNOWN | |
ReportDateRangeType | String | False |
Displays a date range of the report. 使用できる値は次のとおりです。TODAY, YESTERDAY, LAST_7_DAYS, LAST_WEEK, LAST_14_DAYS, LAST_30_DAYS, LAST_BUSINESS_WEEK, THIS_MONTH, LAST_MONTH, ALL_TIME, CUSTOM_DATE, UNKNOWN | |
ReportDownloadEncode | String | False |
Displays a character code of the report. 使用できる値は次のとおりです。UTF8, SJIS, EUC, UTF16LE, UNKNOWN | |
ReportDownloadFormat | String | False |
Displays a file format of the report. 使用できる値は次のとおりです。CSV, XML, TSV, UNKNOWN | |
ReportIncludeDeleted | String | False |
Describes whether to output deleted items on the report or not. 使用できる値は次のとおりです。TRUE, FALSE, UNKNOWN | |
ReportIncludeZeroImpressions | String | False |
Describes whether including 0 impression line in the report or not. 使用できる値は次のとおりです。TRUE, FALSE, UNKNOWN | |
ReportJobErrorDetail | String | False |
Error details of Report Job. | |
ReportJobStatus | String | False |
A status of the requested report. 使用できる値は次のとおりです。WAIT, COMPLETED, IN_PROGRESS, FAILED, UNKNOWN | |
ReportLanguage | String | False |
A language selection for report definition. 使用できる値は次のとおりです。JA, EN, UNKNOWN | |
ReportName | String | False |
Name of the report. | |
ReportType | String | False |
Displays a type of available report. 使用できる値は次のとおりです。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. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
ReferenceNumber | String |
This column will be used in Bulk operations to get specific values from the Temp tables. |
Create, Read or Update the target list information.
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.
For example:
SELECT * FROM SearchAdsRetargetingLists WHERE AccountId = '125466' SELECT * FROM SearchAdsRetargetingLists WHERE AccountId = '125466' AND TargetListId = '234234'
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 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'
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. 使用できる値は次のとおりです。UNUSED_LIST, UNKNOWN | |
DefaultTargetListTagAdvancedSnippet | String | False |
The new format of site retargeting tag avoids the impacts such as changes made to the browser. | |
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. 使用できる値は次のとおりです。OPEN, CLOSED, UNKNOWN | |
RetargetingAccountStatusAgreeDate | String | False |
Agreement date. | |
RetargetingAccountStatusReviewRequestDate | String | False |
Re-examination review request date. | |
RetargetingAccountStatusReviewStatus | String | False |
The review status of target list. 使用できる値は次のとおりです。APPROVED, DISAPPROVED, DISAPPROVED_WITH_REVIEW, UNKNOWN | |
RuleBaseTargetListStartDate | String | False |
Start date of rule setting in | |
RuleBaseTargetListEndDate | String | False |
End date of rule setting in | |
RuleBaseTargetListIsAllVisitorRule | String | False |
The rule of visitors. 使用できる値は次のとおりです。TRUE, FALSE, UNKNOWN | |
RuleBaseTargetListIsDateSpecificRule | String | False |
The rule with deadline. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。ONWER, SHARED, UNKNOWN | |
TargetListTrackId | Int64 | False |
Tracking ID of Target list. | |
TargetListType | String | False |
The type of target list. 使用できる値は次のとおりです。DEFAULT, RULE, LOGICAL, UNKNOWN |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
ReferenceNumber | String |
This column will be used in Bulk operations to get specific values from the Temp tables. |
ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。
クエリは、ビューに対して通常のテーブルと同様に実行することができます。
Name | Description |
AdGroupAdAdResponsiveSearchAdReviewDescriptions | Retrieve the details for AdGroupAd ResponsiveSearchAd Review Descriptions.The columns values set read-only false can be inserted in the parent table using Temp tables |
AdGroupAdAdResponsiveSearchAdReviewHeadlines | Retrieve the details of AdGroupAd ReponsiveSearchAd Review Headlines.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 |
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. |
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 |
FeedItems | Create, Read, Update or Delete Feed Item information. |
KeywordForecastMetrics | Get performance information of keywords. |
KeywordPlanIdeas | Suggests new related keywords based on the specified value. |
OfflineConversions.rsd | 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. |
PageFeedAssetServiceJobStatus | Gets processing status about upload or download. |
PageFeedAssetServiceUploadJob | Gets processing status about upload or download. |
ReportSearchAdsAccount | To view the Account report. Simple Select statement will create and retrieve last 7 days report |
ReportSearchAdsAd | To view the Ad report. Simple Select statement will create and retrieve last 7 days report |
ReportSearchAdsAdgroup | To view the Adgroup report. Simple Select statement will create and retrieve last 7 days report |
ReportSearchAdsBid_strategy | To view the Bid_strategy report. Simple Select statement will create and retrieve last 7 days report |
ReportSearchAdsCampaign | To view the Campaign report. Simple Select statement will create and retrieve last 7 days report |
ReportSearchAdsFeed_item | To view the Feed_item report. Simple Select statement will create and retrieve last 7 days report |
ReportSearchAdsGeo | To view the Geo report. Simple Select statement will create and retrieve last 7 days report |
ReportSearchAdsGeo_target | To view the Geo_target report. Simple Select statement will create and retrieve last 7 days report |
ReportSearchAdsKeywordless_query | To view the Keywordless_query report. Simple Select statement will create and retrieve last 7 days report |
ReportSearchAdsKeywords | To view the Keywords report. Simple Select statement will create and retrieve last 7 days report |
ReportSearchAdsLanding_page_url | To view the Landing_page_url report. Simple Select statement will create and retrieve last 7 days report |
ReportSearchAdsSchedule_target | To view the Schedule_target report. Simple Select statement will create and retrieve last 7 days report |
ReportSearchAdsSearch_query | To view the Search_query report. Simple Select statement will create and retrieve last 7 days report |
ReportSearchAdsWebpage_criterion | To view the Webpage_criterion report. Simple Select statement will create and retrieve last 7 days report |
SearchAdsAccountLinks | Get account link information. |
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. |
SearchAdsBaseAccount | Get lists of all accounts (MCC and ad accounts). |
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 |
SearchAdsFeeds | Create, Read, Update or Delete the Feed (Data auto insertion) information. |
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 |
Retrieve the details for AdGroupAd ResponsiveSearchAd Review Descriptions.The columns values set read-only false can be inserted in the parent table using Temp tables
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.
For example, the following queries are processed server side:
SELECT * FROM AdGroupAdAdResponsiveSearchAdReviewDescriptions WHERE AccountId = '25687'; SELECT * FROM AdGroupAdAdResponsiveSearchAdReviewDescriptions WHERE AccountId = '25687' AND AdId IN ('456971'); SELECT * FROM AdGroupAdAdResponsiveSearchAdReviewDescriptions WHERE AccountId = '25687' AND AdGroupId IN ('8520');
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.
使用できる値は次のとおりです。EXTENDED_TEXT_AD, DYNAMIC_SEARCH_LINKED_AD, TEXT_AD2, APP_AD, RESPONSIVE_SEARCH_AD, UNKNOWN | |
ApprovalStatus | String | Displays Editorial Status.
使用できる値は次のとおりです。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.
使用できる値は次のとおりです。SPECIFIED, DESCRIPTION1, DESCRIPTION2, UNKNOWN | |
Text | String | Text of parameter. | |
ActiveStatus | String | Displays the availability of assets appears.
使用できる値は次のとおりです。ACTIVE, DEACTIVE, PENDING_REVIEW, PENDING_DELETE, UNKNOWN |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
ContainsLabel | String | Describes acquisition flag of label data.
使用できる値は次のとおりです。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. |
Retrieve the details of AdGroupAd ReponsiveSearchAd Review Headlines.The columns values set read-only false can be inserted in the parent table using Temp tables
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.
For example, the following queries are processed server side:
SELECT * FROM AdGroupAdAdResponsiveSearchAdReviewHeadlines WHERE AccountId = '25687'; SELECT * FROM AdGroupAdAdResponsiveSearchAdReviewHeadlines WHERE AccountId = '25687' AND AdId IN ('456971'); SELECT * FROM AdGroupAdAdResponsiveSearchAdReviewHeadlines WHERE AccountId = '25687' AND AdGroupId IN ('8520');
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.
使用できる値は次のとおりです。EXTENDED_TEXT_AD, DYNAMIC_SEARCH_LINKED_AD, TEXT_AD2, APP_AD, RESPONSIVE_SEARCH_AD, UNKNOWN | |
ApprovalStatus | String | Displays Editorial Status.
使用できる値は次のとおりです。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.
使用できる値は次のとおりです。SPECIFIED, DESCRIPTION1, DESCRIPTION2, UNKNOWN | |
Text | String | Text of parameter. | |
ActiveStatus | String | Displays the availability of assets appears.
使用できる値は次のとおりです。ACTIVE, DEACTIVE, PENDING_REVIEW, PENDING_DELETE, UNKNOWN |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
ContainsLabel | String | Describes acquisition flag of label data.
使用できる値は次のとおりです。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. |
Retrieve the details of AdGroupCriteria Labels.The columns values set read-only false can be inserted in the parent table using Temp tables
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.
For example:
SELECT * FROM AdGroupCriteriaLabels WHERE AccountId = '1234339' AND USE = 'BIDDABLE' SELECT * FROM AdGroupCriteriaLabels WHERE AccountId = '1234339' AND USE = 'BIDDABLE' AND AdGroupId = '303252478'
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.
使用できる値は次のとおりです。APPROVED, APPROVED_WITH_REVIEW, REVIEW, PRE_DISAPPROVED, POST_DISAPPROVED, UNKNOWN | |
UserStatus | String | Displays ad delivery status that can be set by an user.
使用できる値は次のとおりです。ACTIVE, PAUSED, UNKNOWN | |
CampaignId | Int64 |
SearchAdsCampaigns.CampaignId | Campaign ID. |
KeywordMatchType | String | Describes keyword match type.
使用できる値は次のとおりです。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.
使用できる値は次のとおりです。BIDDABLE, NEGATIVE, UNKNOWN |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
PortfolioBiddingId | Int64 | Auto bidding ID. | |
ContainsLabelId | String | Describes acquisition flag of label data.
使用できる値は次のとおりです。TRUE, FALSE, UNKNOWN | |
LabelIds | Int64 | Label ID. | |
Min | Int64 | Minimum value of the search range. | |
Max | Int64 | Maximum value of the search range.. |
Retrieve the details of AdGroupWebpage WebpageParameterConditions.The columns values set read-only false can be inserted in the parent table using Temp tables
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.
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')
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.
使用できる値は次のとおりです。CONTAINS, EQUALS, UNKNOWN | |
WebpageConditionType | String | Rule type of web page.
使用できる値は次のとおりです。PAGE_CONTENT, CUSTOM_LABEL, ALL_PAGES, URL, PAGE_TITLE, UNKNOWN | |
CampaignId | Int64 | Campaign ID. |
Get AppEventType informations.
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.
For example:
SELECT * FROM AppEventTracker WHERE AccountId = '1234339';
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.
使用できる値は次のとおりです。ANDROID, UNKNOWN | |
ConversionTrackerTrackId | Int64 | ConversionTracker ID for tracking. | |
AccountId | Int64 | Account ID. |
Get App measurement vendor information list.
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
Name | Type | References | Description |
AppVendorId [KEY] | String | App Vendor ID. | |
AppVendorNameEn | String | App Vendor Name in English. | |
AppVendorNameJa | String | App Vendor Name in Japanese. |
Asset value information for phone number options.
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.
For example:
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'
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. |
Asset value information for callout options.
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.
For example:
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'
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. |
Asset value information for quicklink options.
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.
For example:
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'
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. |
Retrieves the details of CampaignWebpage WebpageParameterConditions.The columns values set read-only false can be inserted in the parent table using Temp tables
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.
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 WebpageTargetId IN('8520')
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.
使用できる値は次のとおりです。CONTAINS, EQUALS, UNKNOWN | |
Type | String | Rule type of web page.
使用できる値は次のとおりです。URL, PAGE_TITLE, PAGE_CONTENT, CUSTOM_LABEL, ALL_PAGES, UNKNOWN |
Get custom key information
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.
For example:
SELECT * FROM CustomKeys WHERE AccountId = '1234339' SELECT * FROM CustomKeys WHERE AccountId = '1234339' AND TargetListOwner = 'OWNER'
Name | Type | References | Description |
AccountId | Int64 |
SearchAdsAccounts.AccountId | Account ID. |
TextKey | String | Evaluation items. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
TargetListOwner | String | Describes the owner information of the target list.
使用できる値は次のとおりです。OWNER, SHARED, UNKNOWN |
Create, Read, Update or Delete Feed Item information.
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.
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')
Name | Type | References | Description |
FeedItemId [KEY] | Int64 | Feed Item ID. | |
AccountId | Int64 |
SearchAdsAccounts.AccountId | Account ID. |
ApprovalStatus | String | FeedItemServiceApprovalStatus displays Editorial Status.
使用できる値は次のとおりです。APPROVED, APPROVED_WITH_REVIEW, REVIEW, PRE_DISAPPROVED, POST_DISAPPROVED, UNKNOWN | |
CustomParametersIsRemove | String | Delete flag.
使用できる値は次のとおりです。TRUE, FALSE, UNKNOWN | |
CustomParameters | String | Displays the element of custom parameters. | |
DevicePreference | String | A selection of device to deliver ads in high priority.
使用できる値は次のとおりです。SMART_PHONE, NONE, UNKNOWN デフォルト値はSMART_PHONEです。 | |
DisapprovalReasonCodes | String | Reject reason on editorial review. | |
StartDate | Date | Start date of ad display. | |
EndDate | Date | End date of ad display. | |
FeedId | Int64 |
SearchAdsFeeds.FeedId | Feed ID. |
FeedItemAttribute | String | Object holds the value of Feed Item information. | |
FeedItemTrackId | Int64 | Feed Item ID for tracking. | |
InvalidedTrademarks | String | Invalided trademarks. | |
LocationCriterionTypeFeedItem | String | Describes criteria information of location restriction.
使用できる値は次のとおりです。LOCATION, UNKNOWN デフォルト値はLOCATIONです。 | |
LocationGeoRestriction | String | Controls ad delivery of location restriction.
使用できる値は次のとおりです。NONE, LOCATION_OF_PRESENCE, UNKNOWN デフォルト値はNONEです。 | |
LocationIsRemove | String | Delete flag.
使用できる値は次のとおりです。TRUE, FALSE, UNKNOWN | |
LocationTargetId | String | FeedItemServiceLocation Type Code. | |
PlaceholderType | String | selects FeeItem information type.
使用できる値は次のとおりです。QUICKLINK, CALLEXTENSION, AD_CUSTOMIZER, CALLOUT, STRUCTURED_SNIPPET, UNKNOWN | |
ReviewCustomParametersIsRemove | String | Delete flag.
使用できる値は次のとおりです。TRUE, FALSE, UNKNOWN | |
ReviewCustomParameters | String | Displays the element of custom parameters. | |
SchedulingSchedules | String | Describes display schedule from Ad Display Option. | |
TargetingAdGroupTargetingAdGroupId | Int64 | Targeting Ad group ID. | |
TargetingCampaignTargetingCampaignId | Int64 | Campaign ID used for ad display. | |
TargetingKeywordKeywordMatchType | String | Describes keyword match type.
使用できる値は次のとおりです。EXACT, PHRASE, BROAD, UNKNOWN | |
TargetingKeywordTargetingKeywordId | Int64 | ID to identify the Targeting keyword (text). | |
TargetingKeywordText | String | Keyword text. | |
TrademarkStatus | String | Describes the status of trademark.
使用できる値は次のとおりです。DISAPPROVAL_CLAIM, DISAPPROVAL_REVIEWER, NO_RESTRICTION, CONFLICT_WITH_TRADEMARK, CLAIM_IN_PROGRESS, UNKNOWN |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
ReferenceNumber | String | This column will be used in Bulk operations to get specific values from the Temp tables. |
Get performance information of keywords.
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.
For example:
SELECT * FROM KeywordForecastMetrics WHERE AccountId = '1234339' AND DateInterval = 'NEXT_QUARTER' AND Cpc = '1' AND KeywordPlanAdGroupKeywordText = 'test' AND KeywordPlanAdGroupKeywordMatchType = 'EXACT'
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. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
DateInterval | String | Describes the forecast period. startDate and endDate is required if CUSTOM_DATE is specified.
使用できる値は次のとおりです。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.
使用できる値は次のとおりです。YAHOO_SEARCH, SEARCH_NETWORK, UNKNOWN デフォルト値は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.
使用できる値は次のとおりです。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. |
Suggests new related keywords based on the specified value.
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.
For example:
SELECT * FROM KeywordPlanIdeas WHERE AccountId = '1234339' AND SeedType = 'SITE' AND SiteSeedSite = 'https://cdata.com/'
Name | Type | References | Description |
Text | String | Keyword. | |
AccountId | Int64 | Account ID. | |
SeedType | String | Describes a type of related keywords creation conditions.
使用できる値は次のとおりです。KEYWORD_AND_URL, KEYWORD, URL, SITE, UNKNOWN |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
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. |
Get registered offline conversion data information.
Name | Type | References | Description |
AccountId [KEY] | Int64 |
SearchAdsAccounts.AccountId | Account ID. |
ProcessStatus | String | Processing status
使用できる値は次のとおりです。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.
使用できる値は次のとおりです。API, YAHOO_JAPAN, CAMPAIGN_MANAGEMENT_TOOL, UNKNOWN | |
UploadType | String | Upload type.
使用できる値は次のとおりです。NEW, ADJUSTMENT, UNKNOWN |
Getpage feed asset, upload or bulk download.
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.
For example:
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'
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. |
Gets registered approval records of page feed asset and summary of each status.
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.
For example:
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'
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. |
Gets processing status about upload or download.
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. | |
JobType | String | Job Type.
使用できる値は次のとおりです。UPLOAD, DOWNLOAD, UNKNOWN | |
PageFeedAssetSetId | Int64 | PageFeedAssetSet ID. | |
Progress | Int64 | Progress of page feed asset job. | |
StartDate | String | Start date of job. | |
ErrorCount | Int32 | Count of error occured. |
Gets processing status about upload or download.
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.
For example:
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'
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. |
To view the Account report. Simple Select statement will create and retrieve last 7 days report
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.
SELECT * FROM ReportSearchAdsAccount WHERE AccountId = '125466' SELECT * FROM ReportSearchAdsAccount WHERE AccountId = '125466' AND ReportJobId = '123456' SELECT * FROM ReportSearchAdsAccount WHERE AccountId = '125466' AND ReportDateRangeType = 'LAST_7_DAYS' SELECT * FROM ReportSearchAdsAccount WHERE AccountId = '125466' AND ReportDateRangeType = 'CUSTOM_DATE' and DateRangeStartDate = '2022-02-12' AND DateRangeEndDate = '2022-04-29'
Note: Since the Report is Dynamic, so the columns may vary depending upon the API.
Name | Type | References | Description |
ReportJobId | String | ReportJobId | |
AccountId | String | アカウントID | |
AccountName | String | アカウント名 | |
Cost | Long | コスト | |
Impressions | Long | インプレッション数 | |
Clicks | Long | クリック数 | |
CTR | Double | クリック率 | |
Avg_CPC | Double | 平均CPC | |
InvalidClicks | Long | 無効なクリック | |
InvalidClickRate | Double | 無効なクリック率 | |
ImpressionShare | Double | インプレッションシェア | |
ExactMatchImpressionShare | Double | 完全一致のインプレッションシェア | |
BudgetLostImpressionShare | Double | インプレッション損失率(予算) | |
QualityLostImpressionShare | Double | インプレッション損失率(掲載順位) | |
TrackingURL | String | トラッキングURL | |
Conversions | Double | コンバージョン数 | |
Conv_Rate | Double | コンバージョン率 | |
Conv_Value | Double | コンバージョンの価値 | |
CostPerConv_ | Double | コスト / コンバージョン数 | |
ValuePerConv_ | Double | 価値 / コンバージョン数 | |
AllConv_ | Double | すべてのコンバージョン数 | |
AllConv_Rate | Double | すべてのコンバージョン率 | |
AllConv_Value | Double | すべてのコンバージョンの価値 | |
CostPerAllConv_ | Double | コスト / すべてのコンバージョン数 | |
ValuePerAllConv_ | Double | 価値 / すべてのコンバージョン数 | |
Conversionsacrossdevices | Double | デバイスをまたいだコンバージョン数 | |
Showadson | String | 広告を表示する検索画面 | |
ClickType | String | クリック種別 | |
Device | String | デバイス | |
Day | String | 日 | |
Dayofweek | String | 曜日 | |
Quarter | String | 四半期 | |
Year | String | 年間 | |
Month | String | 毎月 | |
MonthofYear | String | 月 | |
Week | String | 毎週 | |
Hourofday | Long | 時間 | |
ObjectiveofConversionTracking | String | コンバージョン測定の目的 | |
ConversionName | String | コンバージョン名 | |
Conv_ValuePerCost | Double | コンバージョンの価値 / コスト | |
AllConv_ValuePerCost | Double | すべてのコンバージョンの価値 / コスト |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
ReportDateRangeType | String | レポートの集計対象期間
使用できる値は次のとおりです。TODAY, YESTERDAY, LAST_7_DAYS, LAST_WEEK, LAST_14_DAYS, LAST_30_DAYS, LAST_BUSINESS_WEEK, THIS_MONTH, THIS_MONTH_EXCEPT_TODAY, LAST_MONTH, ALL_TIME, CUSTOM_DATE, NO_RANGE | |
DateRangeStartDate | String | 集計開始日(yyyy-MM-dd) ReportDateRangeType='CUSTOM_DATE' のとき必須 | |
DateRangeEndDate | String | 集計終了日(yyyy-MM-dd) ReportDateRangeType='CUSTOM_DATE' のとき必須 |
To view the Ad report. Simple Select statement will create and retrieve last 7 days report
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.
SELECT * FROM ReportSearchAdsAd WHERE AccountId = '125466' SELECT * FROM ReportSearchAdsAd WHERE AccountId = '125466' AND ReportJobId = '123456' SELECT * FROM ReportSearchAdsAd WHERE AccountId = '125466' AND ReportDateRangeType = 'LAST_7_DAYS' SELECT * FROM ReportSearchAdsAd WHERE AccountId = '125466' AND ReportDateRangeType = 'CUSTOM_DATE' and DateRangeStartDate = '2022-02-12' AND DateRangeEndDate = '2022-04-29'
Note: Since the Report is Dynamic, so the columns may vary depending upon the API.
Name | Type | References | Description |
ReportJobId | String | ReportJobId | |
AccountId | String | アカウントID | |
AccountName | String | アカウント名 | |
CampaignID | Long | キャンペーンID | |
AdGroupID | Long | 広告グループID | |
AdID | Long | 広告ID | |
CampaignName | String | キャンペーン名 | |
AdGroupName | String | 広告グループ名 | |
AdName | String | 広告名 | |
DisplayURL | String | 表示URL | |
DestinationURL | String | リンク先URL | |
AdType | String | 広告タイプ | |
DistributionSettings | String | 配信設定 | |
EditorialStatus | String | 審査状況 | |
Cost | Long | コスト | |
Impressions | Long | インプレッション数 | |
Clicks | Long | クリック数 | |
CTR | Double | クリック率 | |
Avg_CPC | Double | 平均CPC | |
Description1 | String | 説明文1 | |
Description2 | String | 説明文2 | |
FocusDevice | String | 優先デバイス | |
TrackingURL | String | トラッキングURL | |
CustomParameters | String | カスタムパラメータ | |
FinalURL | String | 最終リンク先URL | |
SmartphonefinalURL | String | スマートフォン向けURL | |
CampaignTrackingID | Long | キャンペーントラッキングID | |
AdTrackingID | Long | 広告トラッキングID | |
Conversions | Double | コンバージョン数 | |
Conv_Rate | Double | コンバージョン率 | |
Conv_Value | Double | コンバージョンの価値 | |
CostPerConv_ | Double | コスト / コンバージョン数 | |
ValuePerConv_ | Double | 価値 / コンバージョン数 | |
AllConv_ | Double | すべてのコンバージョン数 | |
AllConv_Rate | Double | すべてのコンバージョン率 | |
AllConv_Value | Double | すべてのコンバージョンの価値 | |
CostPerAllConv_ | Double | コスト / すべてのコンバージョン数 | |
ValuePerAllConv_ | Double | 価値 / すべてのコンバージョン数 | |
Conversionsacrossdevices | Double | デバイスをまたいだコンバージョン数 | |
AdGroupTrackingID | Long | 広告グループトラッキングID | |
Showadson | String | 広告を表示する検索画面 | |
ClickType | String | クリック種別 | |
Device | String | デバイス | |
Day | String | 日 | |
Dayofweek | String | 曜日 | |
Quarter | String | 四半期 | |
Year | String | 年間 | |
Month | String | 毎月 | |
MonthofYear | String | 月 | |
Week | String | 毎週 | |
ObjectiveofConversionTracking | String | コンバージョン測定の目的 | |
ConversionName | String | コンバージョン名 | |
KeywordID | Long | キーワードID | |
Title1 | String | タイトル1 | |
Title2 | String | タイトル2 | |
Title3 | String | タイトル3 | |
Directory1 | String | ディレクトリ1 | |
Directory2 | String | ディレクトリ2 | |
Labels | String | ラベル | |
Labels_JSON_ | String | ラベル(JSON) | |
Searchabsolutetopimpressionrate | Double | インプレッションにおけるページ最上部の割合 | |
Searchtopimpressionrate | Double | インプレッションにおけるページ上部の割合 | |
Conv_ValuePerCost | Double | コンバージョンの価値 / コスト | |
AllConv_ValuePerCost | Double | すべてのコンバージョンの価値 / コスト | |
Title1_asset_ | String | タイトル1(アセット) | |
Title2_asset_ | String | タイトル2(アセット) | |
Title3_asset_ | String | タイトル3(アセット) | |
Title4_asset_ | String | タイトル4(アセット) | |
Title5_asset_ | String | タイトル5(アセット) | |
Title6_asset_ | String | タイトル6(アセット) | |
Title7_asset_ | String | タイトル7(アセット) | |
Title8_asset_ | String | タイトル8(アセット) | |
Title9_asset_ | String | タイトル9(アセット) | |
Title10_asset_ | String | タイトル10(アセット) | |
Title11_asset_ | String | タイトル11(アセット) | |
Title12_asset_ | String | タイトル12(アセット) | |
Title13_asset_ | String | タイトル13(アセット) | |
Title14_asset_ | String | タイトル14(アセット) | |
Title15_asset_ | String | タイトル15(アセット) | |
Description1_asset_ | String | 説明文1(アセット) | |
Description2_asset_ | String | 説明文2(アセット) | |
Description3_asset_ | String | 説明文3(アセット) | |
Description4_asset_ | String | 説明文4(アセット) |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
ReportDateRangeType | String | レポートの集計対象期間
使用できる値は次のとおりです。TODAY, YESTERDAY, LAST_7_DAYS, LAST_WEEK, LAST_14_DAYS, LAST_30_DAYS, LAST_BUSINESS_WEEK, THIS_MONTH, THIS_MONTH_EXCEPT_TODAY, LAST_MONTH, ALL_TIME, CUSTOM_DATE, NO_RANGE | |
DateRangeStartDate | String | 集計開始日(yyyy-MM-dd) ReportDateRangeType='CUSTOM_DATE' のとき必須 | |
DateRangeEndDate | String | 集計終了日(yyyy-MM-dd) ReportDateRangeType='CUSTOM_DATE' のとき必須 |
To view the Adgroup report. Simple Select statement will create and retrieve last 7 days report
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.
SELECT * FROM ReportSearchAdsAdgroup WHERE AccountId = '125466' SELECT * FROM ReportSearchAdsAdgroup WHERE AccountId = '125466' AND ReportJobId = '123456' SELECT * FROM ReportSearchAdsAdgroup WHERE AccountId = '125466' AND ReportDateRangeType = 'LAST_7_DAYS' SELECT * FROM ReportSearchAdsAdgroup WHERE AccountId = '125466' AND ReportDateRangeType = 'CUSTOM_DATE' and DateRangeStartDate = '2022-02-12' AND DateRangeEndDate = '2022-04-29'
Note: Since the Report is Dynamic, so the columns may vary depending upon the API.
Name | Type | References | Description |
ReportJobId | String | ReportJobId | |
AccountId | String | アカウントID | |
AccountName | String | アカウント名 | |
CampaignID | Long | キャンペーンID | |
AdGroupID | Long | 広告グループID | |
CampaignName | String | キャンペーン名 | |
AdGroupName | String | 広告グループ名 | |
DistributionSettings | String | 配信設定 | |
AdGroupBid | Long | 広告グループの入札価格 | |
Cost | Long | コスト | |
Impressions | Long | インプレッション数 | |
Clicks | Long | クリック数 | |
CTR | Double | クリック率 | |
Avg_CPC | Double | 平均CPC | |
ImpressionShare | Double | インプレッションシェア | |
ExactMatchImpressionShare | Double | 完全一致のインプレッションシェア | |
QualityLostImpressionShare | Double | インプレッション損失率(掲載順位) | |
TrackingURL | String | トラッキングURL | |
CustomParameters | String | カスタムパラメータ | |
Conversions | Double | コンバージョン数 | |
Conv_Rate | Double | コンバージョン率 | |
Conv_Value | Double | コンバージョンの価値 | |
CostPerConv_ | Double | コスト / コンバージョン数 | |
ValuePerConv_ | Double | 価値 / コンバージョン数 | |
AllConv_ | Double | すべてのコンバージョン数 | |
AllConv_Rate | Double | すべてのコンバージョン率 | |
AllConv_Value | Double | すべてのコンバージョンの価値 | |
CostPerAllConv_ | Double | コスト / すべてのコンバージョン数 | |
ValuePerAllConv_ | Double | 価値 / すべてのコンバージョン数 | |
Conversionsacrossdevices | Double | デバイスをまたいだコンバージョン数 | |
CampaignTrackingID | Long | キャンペーントラッキングID | |
AdGroupTrackingID | Long | 広告グループトラッキングID | |
Showadson | String | 広告を表示する検索画面 | |
ClickType | String | クリック種別 | |
Device | String | デバイス | |
Day | String | 日 | |
Dayofweek | String | 曜日 | |
Quarter | String | 四半期 | |
Year | String | 年間 | |
Month | String | 毎月 | |
MonthofYear | String | 月 | |
Week | String | 毎週 | |
Hourofday | Long | 時間 | |
ObjectiveofConversionTracking | String | コンバージョン測定の目的 | |
ConversionName | String | コンバージョン名 | |
Labels | String | ラベル | |
Labels_JSON_ | String | ラベル(JSON) | |
Searchabsolutetopimpressionrate | Double | インプレッションにおけるページ最上部の割合 | |
Searchtopimpressionrate | Double | インプレッションにおけるページ上部の割合 | |
Searchabsolutetopimpressionshare | Double | ページ最上部のインプレッションシェア | |
Searchtopimpressionshare | Double | ページ上部のインプレッションシェア | |
Searchlostabsolutetopimpressionshare_budget_ | Double | ページ最上部のインプレッション損失率(予算) | |
Searchlostabsolutetopimpressionshare_rank_ | Double | ページ最上部のインプレッション損失率(掲載順位) | |
Searchlosttopimpressionshare_budget_ | Double | ページ上部のインプレッション損失率(予算) | |
Searchlosttopimpressionshare_rank_ | Double | ページ上部のインプレッション損失率(掲載順位) | |
Conv_ValuePerCost | Double | コンバージョンの価値 / コスト | |
AllConv_ValuePerCost | Double | すべてのコンバージョンの価値 / コスト |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
ReportDateRangeType | String | レポートの集計対象期間
使用できる値は次のとおりです。TODAY, YESTERDAY, LAST_7_DAYS, LAST_WEEK, LAST_14_DAYS, LAST_30_DAYS, LAST_BUSINESS_WEEK, THIS_MONTH, THIS_MONTH_EXCEPT_TODAY, LAST_MONTH, ALL_TIME, CUSTOM_DATE, NO_RANGE | |
DateRangeStartDate | String | 集計開始日(yyyy-MM-dd) ReportDateRangeType='CUSTOM_DATE' のとき必須 | |
DateRangeEndDate | String | 集計終了日(yyyy-MM-dd) ReportDateRangeType='CUSTOM_DATE' のとき必須 |
To view the Bid_strategy report. Simple Select statement will create and retrieve last 7 days report
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.
SELECT * FROM ReportSearchAdsBid_strategy WHERE AccountId = '125466' SELECT * FROM ReportSearchAdsBid_strategy WHERE AccountId = '125466' AND ReportJobId = '123456' SELECT * FROM ReportSearchAdsBid_strategy WHERE AccountId = '125466' AND ReportDateRangeType = 'LAST_7_DAYS' SELECT * FROM ReportSearchAdsBid_strategy WHERE AccountId = '125466' AND ReportDateRangeType = 'CUSTOM_DATE' and DateRangeStartDate = '2022-02-12' AND DateRangeEndDate = '2022-04-29'
Note: Since the Report is Dynamic, so the columns may vary depending upon the API.
Name | Type | References | Description |
ReportJobId | String | ReportJobId | |
AccountId | String | アカウントID | |
AccountName | String | アカウント名 | |
Cost | Long | コスト | |
Impressions | Long | インプレッション数 | |
Clicks | Long | クリック数 | |
CTR | Double | クリック率 | |
Avg_CPC | Double | 平均CPC | |
PortfoliobiddingID | Long | ポートフォリオ入札ID | |
Portfoliobiddingname | String | ポートフォリオ入札名 | |
AutoBiddingType | String | 自動入札タイプ | |
Campaigns | Long | キャンペーン数 | |
AdPosition_Targetpositioninsearchresults_ | String | 掲載位置(検索結果ページの目標掲載位置) | |
BiddingAdjustmentMethod_Targetpositioninsearchresults_ | String | 入札調整方法(検索結果ページの目標掲載位置) | |
BiddingAdjustment_Targetpositioninsearchresults_ | Long | 入札価格調整(検索結果ページの目標掲載位置) | |
LimitbyCampaignBudget_Targetpositioninsearchresults_ | String | キャンペーン予算による制限(検索結果ページの目標掲載位置) | |
LowQualityKeyword_Targetpositioninsearchresults_ | String | 品質が低いキーワード(検索結果ページの目標掲載位置) | |
BidLimit_Targetpositioninsearchresults_ | Long | 入札価格の上限(検索結果ページの目標掲載位置) | |
TargetCPA | Double | コンバージョン単価の目標値 | |
BidLimit_TargetCPA_ | Long | 入札価格の上限(コンバージョン単価の目標値) | |
LowerBidLimit_TargetCPA_ | Long | 入札価格の下限(コンバージョン単価の目標値) | |
TargetROAS | Double | 広告費用対効果の目標値 | |
BidLimit_TargetROAS_ | Long | 入札価格の上限(広告費用対効果の目標値) | |
LowerBidLimit_TargetROAS_ | Long | 入札価格の下限(広告費用対効果の目標値) | |
BidLimit_MaximizeClicks_ | Long | 入札価格の上限(クリック数の最大化) | |
Conversions | Double | コンバージョン数 | |
Conv_Rate | Double | コンバージョン率 | |
Conv_Value | Double | コンバージョンの価値 | |
CostPerConv_ | Double | コスト / コンバージョン数 | |
ValuePerConv_ | Double | 価値 / コンバージョン数 | |
AllConv_ | Double | すべてのコンバージョン数 | |
AllConv_Rate | Double | すべてのコンバージョン率 | |
AllConv_Value | Double | すべてのコンバージョンの価値 | |
CostPerAllConv_ | Double | コスト / すべてのコンバージョン数 | |
ValuePerAllConv_ | Double | 価値 / すべてのコンバージョン数 | |
Conversionsacrossdevices | Double | デバイスをまたいだコンバージョン数 | |
Device | String | デバイス | |
Day | String | 日 | |
Dayofweek | String | 曜日 | |
Quarter | String | 四半期 | |
Year | String | 年間 | |
Month | String | 毎月 | |
MonthofYear | String | 月 | |
Week | String | 毎週 | |
Hourofday | Long | 時間 | |
Conv_ValuePerCost | Double | コンバージョンの価値 / コスト | |
AllConv_ValuePerCost | Double | すべてのコンバージョンの価値 / コスト |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
ReportDateRangeType | String | レポートの集計対象期間
使用できる値は次のとおりです。TODAY, YESTERDAY, LAST_7_DAYS, LAST_WEEK, LAST_14_DAYS, LAST_30_DAYS, LAST_BUSINESS_WEEK, THIS_MONTH, THIS_MONTH_EXCEPT_TODAY, LAST_MONTH, ALL_TIME, CUSTOM_DATE, NO_RANGE | |
DateRangeStartDate | String | 集計開始日(yyyy-MM-dd) ReportDateRangeType='CUSTOM_DATE' のとき必須 | |
DateRangeEndDate | String | 集計終了日(yyyy-MM-dd) ReportDateRangeType='CUSTOM_DATE' のとき必須 |
To view the Campaign report. Simple Select statement will create and retrieve last 7 days report
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.
SELECT * FROM ReportSearchAdsCampaign WHERE AccountId = '125466' SELECT * FROM ReportSearchAdsCampaign WHERE AccountId = '125466' AND ReportJobId = '123456' SELECT * FROM ReportSearchAdsCampaign WHERE AccountId = '125466' AND ReportDateRangeType = 'LAST_7_DAYS' SELECT * FROM ReportSearchAdsCampaign WHERE AccountId = '125466' AND ReportDateRangeType = 'CUSTOM_DATE' and DateRangeStartDate = '2022-02-12' AND DateRangeEndDate = '2022-04-29'
Note: Since the Report is Dynamic, so the columns may vary depending upon the API.
Name | Type | References | Description |
ReportJobId | String | ReportJobId | |
AccountId | String | アカウントID | |
AccountName | String | アカウント名 | |
CampaignID | Long | キャンペーンID | |
CampaignName | String | キャンペーン名 | |
DistributionSettings | String | キャンペーン配信設定 | |
DistributionStatus | String | 配信状況 | |
DailySpendingLimit | Long | 1日の予算 | |
StartDate | String | 開始日 | |
EndDate | String | 終了日 | |
Cost | Long | コスト | |
Impressions | Long | インプレッション数 | |
Clicks | Long | クリック数 | |
CTR | Double | クリック率 | |
Avg_CPC | Double | 平均CPC | |
InvalidClicks | Long | 無効なクリック | |
InvalidClickRate | Double | 無効なクリック率 | |
ImpressionShare | Double | インプレッションシェア | |
ExactMatchImpressionShare | Double | 完全一致のインプレッションシェア | |
BudgetLostImpressionShare | Double | インプレッション損失率(予算) | |
QualityLostImpressionShare | Double | インプレッション損失率(掲載順位) | |
TrackingURL | String | トラッキングURL | |
CustomParameters | String | カスタムパラメータ | |
CampaignTrackingID | Long | キャンペーントラッキングID | |
Conversions | Double | コンバージョン数 | |
Conv_Rate | Double | コンバージョン率 | |
Conv_Value | Double | コンバージョンの価値 | |
CostPerConv_ | Double | コスト / コンバージョン数 | |
ValuePerConv_ | Double | 価値 / コンバージョン数 | |
AllConv_ | Double | すべてのコンバージョン数 | |
AllConv_Rate | Double | すべてのコンバージョン率 | |
AllConv_Value | Double | すべてのコンバージョンの価値 | |
CostPerAllConv_ | Double | コスト / すべてのコンバージョン数 | |
ValuePerAllConv_ | Double | 価値 / すべてのコンバージョン数 | |
Conversionsacrossdevices | Double | デバイスをまたいだコンバージョン数 | |
Showadson | String | 広告を表示する検索画面 | |
ClickType | String | クリック種別 | |
Device | String | デバイス | |
Day | String | 日 | |
Dayofweek | String | 曜日 | |
Quarter | String | 四半期 | |
Year | String | 年間 | |
Month | String | 毎月 | |
MonthofYear | String | 月 | |
Week | String | 毎週 | |
Hourofday | Long | 時間 | |
ObjectiveofConversionTracking | String | コンバージョン測定の目的 | |
ConversionName | String | コンバージョン名 | |
Campaigntype | String | キャンペーンタイプ | |
Labels | String | ラベル | |
Labels_JSON_ | String | ラベル(JSON) | |
PortfoliobiddingID | Long | ポートフォリオ入札ID | |
Portfoliobiddingname | String | ポートフォリオ入札名 | |
Bidstrategy | String | 入札戦略 | |
EnhancedCPC | String | 拡張クリック単価設定 | |
Searchabsolutetopimpressionrate | Double | インプレッションにおけるページ最上部の割合 | |
Searchtopimpressionrate | Double | インプレッションにおけるページ上部の割合 | |
Searchabsolutetopimpressionshare | Double | ページ最上部のインプレッションシェア | |
Searchtopimpressionshare | Double | ページ上部のインプレッションシェア | |
Searchlostabsolutetopimpressionshare_budget_ | Double | ページ最上部のインプレッション損失率(予算) | |
Searchlostabsolutetopimpressionshare_rank_ | Double | ページ最上部のインプレッション損失率(掲載順位) | |
Searchlosttopimpressionshare_budget_ | Double | ページ上部のインプレッション損失率(予算) | |
Searchlosttopimpressionshare_rank_ | Double | ページ上部のインプレッション損失率(掲載順位) | |
Conv_ValuePerCost | Double | コンバージョンの価値 / コスト | |
AllConv_ValuePerCost | Double | すべてのコンバージョンの価値 / コスト |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
ReportDateRangeType | String | レポートの集計対象期間
使用できる値は次のとおりです。TODAY, YESTERDAY, LAST_7_DAYS, LAST_WEEK, LAST_14_DAYS, LAST_30_DAYS, LAST_BUSINESS_WEEK, THIS_MONTH, THIS_MONTH_EXCEPT_TODAY, LAST_MONTH, ALL_TIME, CUSTOM_DATE, NO_RANGE | |
DateRangeStartDate | String | 集計開始日(yyyy-MM-dd) ReportDateRangeType='CUSTOM_DATE' のとき必須 | |
DateRangeEndDate | String | 集計終了日(yyyy-MM-dd) ReportDateRangeType='CUSTOM_DATE' のとき必須 |
To view the Feed_item report. Simple Select statement will create and retrieve last 7 days report
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.
SELECT * FROM ReportSearchAdsFeed_item WHERE AccountId = '125466' SELECT * FROM ReportSearchAdsFeed_item WHERE AccountId = '125466' AND ReportJobId = '123456' SELECT * FROM ReportSearchAdsFeed_item WHERE AccountId = '125466' AND ReportDateRangeType = 'LAST_7_DAYS' SELECT * FROM ReportSearchAdsFeed_item WHERE AccountId = '125466' AND ReportDateRangeType = 'CUSTOM_DATE' and DateRangeStartDate = '2022-02-12' AND DateRangeEndDate = '2022-04-29'
Note: Since the Report is Dynamic, so the columns may vary depending upon the API.
Name | Type | References | Description |
ReportJobId | String | ReportJobId | |
AccountId | String | アカウントID | |
AccountName | String | アカウント名 | |
CampaignID | Long | キャンペーンID | |
AdGroupID | Long | 広告グループID | |
AdID | Long | 広告ID | |
CampaignName | String | キャンペーン名 | |
AdGroupName | String | 広告グループ名 | |
AdName | String | 広告名 | |
Cost | Long | コスト | |
Impressions | Long | インプレッション数 | |
Clicks | Long | クリック数 | |
CTR | Double | クリック率 | |
Avg_CPC | Double | 平均CPC | |
EditorialStatus | String | 審査状況 | |
PhoneNumber | String | 電話番号 | |
FocusDevice | String | 優先デバイス | |
FeedID | Long | フィードID | |
AdDisplayOptionID | Long | 広告表示オプションID | |
QuickLinkText | String | クイックリンクテキスト | |
QuickLinkURL | String | クイックリンクURL | |
AdDisplayOptionType | String | 広告表示オプションの種類 | |
StartDate | String | 開始日 | |
EndDate | String | 終了日 | |
TrackingURL | String | トラッキングURL | |
CustomParameters | String | カスタムパラメータ | |
FinalURL | String | 最終リンク先URL | |
SmartphonefinalURL | String | スマートフォン向けURL | |
Callout | String | 補足用テキスト | |
Conversions | Double | コンバージョン数 | |
Conv_Rate | Double | コンバージョン率 | |
Conv_Value | Double | コンバージョンの価値 | |
CostPerConv_ | Double | コスト / コンバージョン数 | |
ValuePerConv_ | Double | 価値 / コンバージョン数 | |
AllConv_ | Double | すべてのコンバージョン数 | |
AllConv_Rate | Double | すべてのコンバージョン率 | |
AllConv_Value | Double | すべてのコンバージョンの価値 | |
CostPerAllConv_ | Double | コスト / すべてのコンバージョン数 | |
ValuePerAllConv_ | Double | 価値 / すべてのコンバージョン数 | |
Conversionsacrossdevices | Double | デバイスをまたいだコンバージョン数 | |
CampaignTrackingID | Long | キャンペーントラッキングID | |
AdGroupTrackingID | Long | 広告グループトラッキングID | |
AdTrackingID | Long | 広告トラッキングID | |
AdDisplayOptionTrackingID | Long | 広告表示オプショントラッキングID | |
Showadson | String | 広告を表示する検索画面 | |
AdDisplayOptionDetail | String | 広告表示オプションの詳細 | |
AdDisplayOptionDetail_JSON_ | String | 広告表示オプションの詳細(JSON) | |
ClickType | String | クリック種別 | |
Device | String | デバイス | |
Day | String | 日 | |
Dayofweek | String | 曜日 | |
Quarter | String | 四半期 | |
Year | String | 年間 | |
Month | String | 毎月 | |
MonthofYear | String | 月 | |
Week | String | 毎週 | |
ObjectiveofConversionTracking | String | コンバージョン測定の目的 | |
ConversionName | String | コンバージョン名 | |
IsSelfAction | String | 当該の広告表示オプションとその他 | |
Conv_ValuePerCost | Double | コンバージョンの価値 / コスト | |
AllConv_ValuePerCost | Double | すべてのコンバージョンの価値 / コスト | |
QuickLinkDescription1 | String | クイックリンク説明文1 | |
QuickLinkDescription2 | String | クイックリンク説明文2 | |
DataAssignmentList | String | データ自動挿入リスト | |
TargetLocation | String | ターゲット地域 | |
TargetKeyword | String | 設定先キーワード | |
TargetKeywordMatchType | String | 設定先キーワードマッチタイプ | |
TargetCampaignID | Long | 設定先キャンペーンID | |
TargetAdGroupID | Long | 設定先広告グループID | |
TargetLocationRestriction | String | ターゲット地域の制限 |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
ReportDateRangeType | String | レポートの集計対象期間
使用できる値は次のとおりです。TODAY, YESTERDAY, LAST_7_DAYS, LAST_WEEK, LAST_14_DAYS, LAST_30_DAYS, LAST_BUSINESS_WEEK, THIS_MONTH, THIS_MONTH_EXCEPT_TODAY, LAST_MONTH, ALL_TIME, CUSTOM_DATE, NO_RANGE | |
DateRangeStartDate | String | 集計開始日(yyyy-MM-dd) ReportDateRangeType='CUSTOM_DATE' のとき必須 | |
DateRangeEndDate | String | 集計終了日(yyyy-MM-dd) ReportDateRangeType='CUSTOM_DATE' のとき必須 |
To view the Geo report. Simple Select statement will create and retrieve last 7 days report
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.
SELECT * FROM ReportSearchAdsGeo WHERE AccountId = '125466' SELECT * FROM ReportSearchAdsGeo WHERE AccountId = '125466' AND ReportJobId = '123456' SELECT * FROM ReportSearchAdsGeo WHERE AccountId = '125466' AND ReportDateRangeType = 'LAST_7_DAYS' SELECT * FROM ReportSearchAdsGeo WHERE AccountId = '125466' AND ReportDateRangeType = 'CUSTOM_DATE' and DateRangeStartDate = '2022-02-12' AND DateRangeEndDate = '2022-04-29'
Note: Since the Report is Dynamic, so the columns may vary depending upon the API.
Name | Type | References | Description |
ReportJobId | String | ReportJobId | |
AccountId | String | アカウントID | |
AccountName | String | アカウント名 | |
CampaignID | Long | キャンペーンID | |
AdGroupID | Long | 広告グループID | |
CampaignName | String | キャンペーン名 | |
AdGroupName | String | 広告グループ名 | |
Cost | Long | コスト | |
Impressions | Long | インプレッション数 | |
Clicks | Long | クリック数 | |
CTR | Double | クリック率 | |
Avg_CPC | Double | 平均CPC | |
Conversions | Double | コンバージョン数 | |
Conv_Rate | Double | コンバージョン率 | |
Conv_Value | Double | コンバージョンの価値 | |
CostPerConv_ | Double | コスト / コンバージョン数 | |
ValuePerConv_ | Double | 価値 / コンバージョン数 | |
AllConv_ | Double | すべてのコンバージョン数 | |
AllConv_Rate | Double | すべてのコンバージョン率 | |
AllConv_Value | Double | すべてのコンバージョンの価値 | |
CostPerAllConv_ | Double | コスト / すべてのコンバージョン数 | |
ValuePerAllConv_ | Double | 価値 / すべてのコンバージョン数 | |
Conversionsacrossdevices | Double | デバイスをまたいだコンバージョン数 | |
CampaignTrackingID | Long | キャンペーントラッキングID | |
AdGroupTrackingID | Long | 広告グループトラッキングID | |
Showadson | String | 広告を表示する検索画面 | |
Device | String | デバイス | |
Day | String | 日 | |
Dayofweek | String | 曜日 | |
Quarter | String | 四半期 | |
Year | String | 年間 | |
Month | String | 毎月 | |
MonthofYear | String | 月 | |
Week | String | 毎週 | |
ObjectiveofConversionTracking | String | コンバージョン測定の目的 | |
ConversionName | String | コンバージョン名 | |
Country_Territory | String | 国 / 地域 | |
Prefecture | String | 都道府県 | |
City | String | 都市 | |
LocationType | String | 地域判定の種類 | |
Conv_ValuePerCost | Double | コンバージョンの価値 / コスト | |
AllConv_ValuePerCost | Double | すべてのコンバージョンの価値 / コスト | |
MetroArea | String | 大都市圏 | |
Location | String | 地域の詳細 |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
ReportDateRangeType | String | レポートの集計対象期間
使用できる値は次のとおりです。TODAY, YESTERDAY, LAST_7_DAYS, LAST_WEEK, LAST_14_DAYS, LAST_30_DAYS, LAST_BUSINESS_WEEK, THIS_MONTH, THIS_MONTH_EXCEPT_TODAY, LAST_MONTH, ALL_TIME, CUSTOM_DATE, NO_RANGE | |
DateRangeStartDate | String | 集計開始日(yyyy-MM-dd) ReportDateRangeType='CUSTOM_DATE' のとき必須 | |
DateRangeEndDate | String | 集計終了日(yyyy-MM-dd) ReportDateRangeType='CUSTOM_DATE' のとき必須 |
To view the Geo_target report. Simple Select statement will create and retrieve last 7 days report
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.
SELECT * FROM ReportSearchAdsGeo_target WHERE AccountId = '125466' SELECT * FROM ReportSearchAdsGeo_target WHERE AccountId = '125466' AND ReportJobId = '123456' SELECT * FROM ReportSearchAdsGeo_target WHERE AccountId = '125466' AND ReportDateRangeType = 'LAST_7_DAYS' SELECT * FROM ReportSearchAdsGeo_target WHERE AccountId = '125466' AND ReportDateRangeType = 'CUSTOM_DATE' and DateRangeStartDate = '2022-02-12' AND DateRangeEndDate = '2022-04-29'
Note: Since the Report is Dynamic, so the columns may vary depending upon the API.
Name | Type | References | Description |
ReportJobId | String | ReportJobId | |
AccountId | String | アカウントID | |
AccountName | String | アカウント名 | |
CampaignID | Long | キャンペーンID | |
CampaignName | String | キャンペーン名 | |
Cost | Long | コスト | |
Impressions | Long | インプレッション数 | |
Clicks | Long | クリック数 | |
CTR | Double | クリック率 | |
Avg_CPC | Double | 平均CPC | |
BidAdjustment_ | Double | 入札価格調整率(%) | |
TargetLocationID | String | 地域ID | |
TargetLocationName | String | 地域 | |
Conversions | Double | コンバージョン数 | |
Conv_Rate | Double | コンバージョン率 | |
Conv_Value | Double | コンバージョンの価値 | |
CostPerConv_ | Double | コスト / コンバージョン数 | |
ValuePerConv_ | Double | 価値 / コンバージョン数 | |
AllConv_ | Double | すべてのコンバージョン数 | |
AllConv_Rate | Double | すべてのコンバージョン率 | |
AllConv_Value | Double | すべてのコンバージョンの価値 | |
CostPerAllConv_ | Double | コスト / すべてのコンバージョン数 | |
ValuePerAllConv_ | Double | 価値 / すべてのコンバージョン数 | |
Conversionsacrossdevices | Double | デバイスをまたいだコンバージョン数 | |
CampaignTrackingID | Long | キャンペーントラッキングID | |
Day | String | 日 | |
Quarter | String | 四半期 | |
Year | String | 年間 | |
Month | String | 毎月 | |
MonthofYear | String | 月 | |
Week | String | 毎週 | |
Conv_ValuePerCost | Double | コンバージョンの価値 / コスト | |
AllConv_ValuePerCost | Double | すべてのコンバージョンの価値 / コスト |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
ReportDateRangeType | String | レポートの集計対象期間
使用できる値は次のとおりです。TODAY, YESTERDAY, LAST_7_DAYS, LAST_WEEK, LAST_14_DAYS, LAST_30_DAYS, LAST_BUSINESS_WEEK, THIS_MONTH, THIS_MONTH_EXCEPT_TODAY, LAST_MONTH, ALL_TIME, CUSTOM_DATE, NO_RANGE | |
DateRangeStartDate | String | 集計開始日(yyyy-MM-dd) ReportDateRangeType='CUSTOM_DATE' のとき必須 | |
DateRangeEndDate | String | 集計終了日(yyyy-MM-dd) ReportDateRangeType='CUSTOM_DATE' のとき必須 |
To view the Keywordless_query report. Simple Select statement will create and retrieve last 7 days report
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.
SELECT * FROM ReportSearchAdsKeywordless_query WHERE AccountId = '125466' SELECT * FROM ReportSearchAdsKeywordless_query WHERE AccountId = '125466' AND ReportJobId = '123456' SELECT * FROM ReportSearchAdsKeywordless_query WHERE AccountId = '125466' AND ReportDateRangeType = 'LAST_7_DAYS' SELECT * FROM ReportSearchAdsKeywordless_query WHERE AccountId = '125466' AND ReportDateRangeType = 'CUSTOM_DATE' and DateRangeStartDate = '2022-02-12' AND DateRangeEndDate = '2022-04-29'
Note: Since the Report is Dynamic, so the columns may vary depending upon the API.
Name | Type | References | Description |
ReportJobId | String | ReportJobId | |
AccountId | String | アカウントID | |
AccountName | String | アカウント名 | |
CampaignID | Long | キャンペーンID | |
AdGroupID | Long | 広告グループID | |
CampaignName | String | キャンペーン名 | |
AdGroupName | String | 広告グループ名 | |
SearchQuery | String | 検索クエリー | |
Cost | Long | コスト | |
Impressions | Long | インプレッション数 | |
Clicks | Long | クリック数 | |
CTR | Double | クリック率 | |
Avg_CPC | Double | 平均CPC | |
Conversions | Double | コンバージョン数 | |
Conv_Rate | Double | コンバージョン率 | |
Conv_Value | Double | コンバージョンの価値 | |
CostPerConv_ | Double | コスト/コンバージョン数 | |
ValuePerConv_ | Double | 価値/コンバージョン数 | |
AllConv_ | Double | すべてのコンバージョン数 | |
AllConv_Rate | Double | すべてのコンバージョン率 | |
AllConv_Value | Double | すべてのコンバージョンの価値 | |
CostPerAllConv_ | Double | コスト/すべてのコンバージョン数 | |
ValuePerAllConv_ | Double | 価値/すべてのコンバージョン数 | |
Conversionsacrossdevices | Double | デバイスをまたいだコンバージョン数 | |
CampaignTrackingID | Long | キャンペーントラッキングID | |
AdGroupTrackingID | Long | 広告グループトラッキングID | |
Titleautocreated | String | 自動的に作成されたタイトル | |
URL | String | URL | |
Day | String | 日 | |
Dayofweek | String | 曜日 | |
Quarter | String | 四半期 | |
Year | String | 年間 | |
Month | String | 毎月 | |
MonthofYear | String | 月 | |
Week | String | 毎週 | |
ObjectiveofConversionTracking | String | コンバージョン測定の目的 | |
ConversionName | String | コンバージョン名 | |
Conv_ValuePerCost | Double | コンバージョンの価値 / コスト | |
AllConv_ValuePerCost | Double | すべてのコンバージョンの価値 / コスト |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
ReportDateRangeType | String | レポートの集計対象期間
使用できる値は次のとおりです。TODAY, YESTERDAY, LAST_7_DAYS, LAST_WEEK, LAST_14_DAYS, LAST_30_DAYS, LAST_BUSINESS_WEEK, THIS_MONTH, THIS_MONTH_EXCEPT_TODAY, LAST_MONTH, ALL_TIME, CUSTOM_DATE, NO_RANGE | |
DateRangeStartDate | String | 集計開始日(yyyy-MM-dd) ReportDateRangeType='CUSTOM_DATE' のとき必須 | |
DateRangeEndDate | String | 集計終了日(yyyy-MM-dd) ReportDateRangeType='CUSTOM_DATE' のとき必須 |
To view the Keywords report. Simple Select statement will create and retrieve last 7 days report
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.
SELECT * FROM ReportSearchAdsKeywords WHERE AccountId = '125466' SELECT * FROM ReportSearchAdsKeywords WHERE AccountId = '125466' AND ReportJobId = '123456' SELECT * FROM ReportSearchAdsKeywords WHERE AccountId = '125466' AND ReportDateRangeType = 'LAST_7_DAYS' SELECT * FROM ReportSearchAdsKeywords WHERE AccountId = '125466' AND ReportDateRangeType = 'CUSTOM_DATE' and DateRangeStartDate = '2022-02-12' AND DateRangeEndDate = '2022-04-29'
Note: Since the Report is Dynamic, so the columns may vary depending upon the API.
Name | Type | References | Description |
ReportJobId | String | ReportJobId | |
AccountId | String | アカウントID | |
AccountName | String | アカウント名 | |
CampaignID | Long | キャンペーンID | |
AdGroupID | Long | 広告グループID | |
KeywordID | Long | キーワードID | |
CampaignName | String | キャンペーン名 | |
AdGroupName | String | 広告グループ名 | |
CustomURL | String | カスタムURL | |
Keyword | String | キーワード | |
DistributionSettings | String | 配信設定 | |
EditorialStatus | String | 審査状況 | |
AdGroupBid | Long | 広告グループの入札価格 | |
Bid_JPY_ | Long | 入札価格 | |
NegativeKeywords | String | 対象外キーワード | |
QualityIndex | Long | 品質インデックス | |
FirstPageBidEstimate | Long | 1ページ目掲載に必要な入札価格 | |
MatchType | String | マッチタイプ | |
Cost | Long | コスト | |
Impressions | Long | インプレッション数 | |
Clicks | Long | クリック数 | |
CTR | Double | クリック率 | |
Avg_CPC | Double | 平均CPC | |
ImpressionShare | Double | インプレッションシェア | |
ExactMatchImpressionShare | Double | 完全一致のインプレッションシェア | |
QualityLostImpressionShare | Double | インプレッション損失率(掲載順位) | |
TopOfPageBidEstimate | Long | 1ページ目上部掲載に必要な入札価格 | |
TrackingURL | String | トラッキングURL | |
CustomParameters | String | カスタムパラメータ | |
FinalURL | String | 最終リンク先URL | |
SmartphonefinalURL | String | スマートフォン向けURL | |
Conversions | Double | コンバージョン数 | |
Conv_Rate | Double | コンバージョン率 | |
Conv_Value | Double | コンバージョンの価値 | |
CostPerConv_ | Double | コスト / コンバージョン数 | |
ValuePerConv_ | Double | 価値 / コンバージョン数 | |
AllConv_ | Double | すべてのコンバージョン数 | |
AllConv_Rate | Double | すべてのコンバージョン率 | |
AllConv_Value | Double | すべてのコンバージョンの価値 | |
CostPerAllConv_ | Double | コスト / すべてのコンバージョン数 | |
ValuePerAllConv_ | Double | 価値 / すべてのコンバージョン数 | |
Conversionsacrossdevices | Double | デバイスをまたいだコンバージョン数 | |
CampaignTrackingID | Long | キャンペーントラッキングID | |
AdGroupTrackingID | Long | 広告グループトラッキングID | |
KeywordTrackingID | Long | キーワードトラッキングID | |
Showadson | String | 広告を表示する検索画面 | |
ClickType | String | クリック種別 | |
Device | String | デバイス | |
Day | String | 日 | |
Dayofweek | String | 曜日 | |
Quarter | String | 四半期 | |
Year | String | 年間 | |
Month | String | 毎月 | |
MonthofYear | String | 月 | |
Week | String | 毎週 | |
ObjectiveofConversionTracking | String | コンバージョン測定の目的 | |
ConversionName | String | コンバージョン名 | |
Labels | String | ラベル | |
Labels_JSON_ | String | ラベル(JSON) | |
Searchabsolutetopimpressionrate | Double | インプレッションにおけるページ最上部の割合 | |
Searchtopimpressionrate | Double | インプレッションにおけるページ上部の割合 | |
Searchabsolutetopimpressionshare | Double | ページ最上部のインプレッションシェア | |
Searchtopimpressionshare | Double | ページ上部のインプレッションシェア | |
Searchlostabsolutetopimpressionshare_budget_ | Double | ページ最上部のインプレッション損失率(予算) | |
Searchlostabsolutetopimpressionshare_rank_ | Double | ページ最上部のインプレッション損失率(掲載順位) | |
Searchlosttopimpressionshare_budget_ | Double | ページ上部のインプレッション損失率(予算) | |
Searchlosttopimpressionshare_rank_ | Double | ページ上部のインプレッション損失率(掲載順位) | |
Keywordstatus | String | キーワードの状況 | |
Conv_ValuePerCost | Double | コンバージョンの価値 / コスト | |
AllConv_ValuePerCost | Double | すべてのコンバージョンの価値 / コスト | |
ExpectedCTR | String | 推定クリック値 | |
Qualityindex_hist_ | Long | 品質インデックス(履歴) | |
ExpectedCTR_hist_ | String | 推定クリック値(履歴) | |
Adrelevance | String | 広告の関連性 | |
Adrelevance_hist_ | String | 広告の関連性(履歴) | |
Landingpageexperience | String | ランディングページの利便性 | |
Landingpageexperience_hist_ | String | ランディングページの利便性(履歴) |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
ReportDateRangeType | String | レポートの集計対象期間
使用できる値は次のとおりです。TODAY, YESTERDAY, LAST_7_DAYS, LAST_WEEK, LAST_14_DAYS, LAST_30_DAYS, LAST_BUSINESS_WEEK, THIS_MONTH, THIS_MONTH_EXCEPT_TODAY, LAST_MONTH, ALL_TIME, CUSTOM_DATE, NO_RANGE | |
DateRangeStartDate | String | 集計開始日(yyyy-MM-dd) ReportDateRangeType='CUSTOM_DATE' のとき必須 | |
DateRangeEndDate | String | 集計終了日(yyyy-MM-dd) ReportDateRangeType='CUSTOM_DATE' のとき必須 |
To view the Landing_page_url report. Simple Select statement will create and retrieve last 7 days report
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.
SELECT * FROM ReportSearchAdsLanding_page_url WHERE AccountId = '125466' SELECT * FROM ReportSearchAdsLanding_page_url WHERE AccountId = '125466' AND ReportJobId = '123456' SELECT * FROM ReportSearchAdsLanding_page_url WHERE AccountId = '125466' AND ReportDateRangeType = 'LAST_7_DAYS' SELECT * FROM ReportSearchAdsLanding_page_url WHERE AccountId = '125466' AND ReportDateRangeType = 'CUSTOM_DATE' and DateRangeStartDate = '2022-02-12' AND DateRangeEndDate = '2022-04-29'
Note: Since the Report is Dynamic, so the columns may vary depending upon the API.
Name | Type | References | Description |
ReportJobId | String | ReportJobId | |
AccountId | String | アカウントID | |
AccountName | String | アカウント名 | |
CampaignID | Long | キャンペーンID | |
AdGroupID | Long | 広告グループID | |
CampaignName | String | キャンペーン名 | |
AdGroupName | String | 広告グループ名 | |
Cost | Long | コスト | |
Impressions | Long | インプレッション数 | |
Clicks | Long | クリック数 | |
CTR | Double | クリック率 | |
Avg_CPC | Double | 平均CPC | |
LandingPageURL | String | ランディングページURL | |
ExpandedLandingPageURL | String | ランディングページURL(詳細) | |
Conversions | Double | コンバージョン数 | |
Conv_Rate | Double | コンバージョン率 | |
Conv_Value | Double | コンバージョンの価値 | |
CostPerConv_ | Double | コスト / コンバージョン数 | |
ValuePerConv_ | Double | 価値 / コンバージョン数 | |
AllConv_ | Double | すべてのコンバージョン数 | |
AllConv_Rate | Double | すべてのコンバージョン率 | |
AllConv_Value | Double | すべてのコンバージョンの価値 | |
CostPerAllConv_ | Double | コスト / すべてのコンバージョン数 | |
ValuePerAllConv_ | Double | 価値 / すべてのコンバージョン数 | |
Conversionsacrossdevices | Double | デバイスをまたいだコンバージョン数 | |
CampaignTrackingID | Long | キャンペーントラッキングID | |
AdGroupTrackingID | Long | 広告グループトラッキングID | |
Showadson | String | 広告を表示する検索画面 | |
Device | String | デバイス | |
Day | String | 日 | |
Dayofweek | String | 曜日 | |
Quarter | String | 四半期 | |
Year | String | 年間 | |
Month | String | 毎月 | |
MonthofYear | String | 月 | |
Week | String | 毎週 | |
ObjectiveofConversionTracking | String | コンバージョン測定の目的 | |
ConversionName | String | コンバージョン名 | |
Conv_ValuePerCost | Double | コンバージョンの価値 / コスト | |
AllConv_ValuePerCost | Double | すべてのコンバージョンの価値 / コスト |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
ReportDateRangeType | String | レポートの集計対象期間
使用できる値は次のとおりです。TODAY, YESTERDAY, LAST_7_DAYS, LAST_WEEK, LAST_14_DAYS, LAST_30_DAYS, LAST_BUSINESS_WEEK, THIS_MONTH, THIS_MONTH_EXCEPT_TODAY, LAST_MONTH, ALL_TIME, CUSTOM_DATE, NO_RANGE | |
DateRangeStartDate | String | 集計開始日(yyyy-MM-dd) ReportDateRangeType='CUSTOM_DATE' のとき必須 | |
DateRangeEndDate | String | 集計終了日(yyyy-MM-dd) ReportDateRangeType='CUSTOM_DATE' のとき必須 |
To view the Schedule_target report. Simple Select statement will create and retrieve last 7 days report
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.
SELECT * FROM ReportSearchAdsSchedule_target WHERE AccountId = '125466' SELECT * FROM ReportSearchAdsSchedule_target WHERE AccountId = '125466' AND ReportJobId = '123456' SELECT * FROM ReportSearchAdsSchedule_target WHERE AccountId = '125466' AND ReportDateRangeType = 'LAST_7_DAYS' SELECT * FROM ReportSearchAdsSchedule_target WHERE AccountId = '125466' AND ReportDateRangeType = 'CUSTOM_DATE' and DateRangeStartDate = '2022-02-12' AND DateRangeEndDate = '2022-04-29'
Note: Since the Report is Dynamic, so the columns may vary depending upon the API.
Name | Type | References | Description |
ReportJobId | String | ReportJobId | |
AccountId | String | アカウントID | |
AccountName | String | アカウント名 | |
CampaignID | Long | キャンペーンID | |
CampaignName | String | キャンペーン名 | |
Cost | Long | コスト | |
Impressions | Long | インプレッション数 | |
Clicks | Long | クリック数 | |
CTR | Double | クリック率 | |
Avg_CPC | Double | 平均CPC | |
BidAdjustment_ | Double | 入札価格調整率(%) | |
TargetScheduleID | Long | 曜日・時間帯ID | |
TargetSchedule | String | 曜日・時間帯 | |
Conversions | Double | コンバージョン数 | |
Conv_Rate | Double | コンバージョン率 | |
Conv_Value | Double | コンバージョンの価値 | |
CostPerConv_ | Double | コスト / コンバージョン数 | |
ValuePerConv_ | Double | 価値 / コンバージョン数 | |
AllConv_ | Double | すべてのコンバージョン数 | |
AllConv_Rate | Double | すべてのコンバージョン率 | |
AllConv_Value | Double | すべてのコンバージョンの価値 | |
CostPerAllConv_ | Double | コスト / すべてのコンバージョン数 | |
ValuePerAllConv_ | Double | 価値 / すべてのコンバージョン数 | |
Conversionsacrossdevices | Double | デバイスをまたいだコンバージョン数 | |
CampaignTrackingID | Long | キャンペーントラッキングID | |
Day | String | 日 | |
Quarter | String | 四半期 | |
Year | String | 年間 | |
Month | String | 毎月 | |
MonthofYear | String | 月 | |
Week | String | 毎週 | |
Conv_ValuePerCost | Double | コンバージョンの価値 / コスト | |
AllConv_ValuePerCost | Double | すべてのコンバージョンの価値 / コスト |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
ReportDateRangeType | String | レポートの集計対象期間
使用できる値は次のとおりです。TODAY, YESTERDAY, LAST_7_DAYS, LAST_WEEK, LAST_14_DAYS, LAST_30_DAYS, LAST_BUSINESS_WEEK, THIS_MONTH, THIS_MONTH_EXCEPT_TODAY, LAST_MONTH, ALL_TIME, CUSTOM_DATE, NO_RANGE | |
DateRangeStartDate | String | 集計開始日(yyyy-MM-dd) ReportDateRangeType='CUSTOM_DATE' のとき必須 | |
DateRangeEndDate | String | 集計終了日(yyyy-MM-dd) ReportDateRangeType='CUSTOM_DATE' のとき必須 |
To view the Search_query report. Simple Select statement will create and retrieve last 7 days report
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.
SELECT * FROM ReportSearchAdsSearch_query WHERE AccountId = '125466' SELECT * FROM ReportSearchAdsSearch_query WHERE AccountId = '125466' AND ReportJobId = '123456' SELECT * FROM ReportSearchAdsSearch_query WHERE AccountId = '125466' AND ReportDateRangeType = 'LAST_7_DAYS' SELECT * FROM ReportSearchAdsSearch_query WHERE AccountId = '125466' AND ReportDateRangeType = 'CUSTOM_DATE' and DateRangeStartDate = '2022-02-12' AND DateRangeEndDate = '2022-04-29'
Note: Since the Report is Dynamic, so the columns may vary depending upon the API.
Name | Type | References | Description |
ReportJobId | String | ReportJobId | |
AccountId | String | アカウントID | |
AccountName | String | アカウント名 | |
CampaignID | Long | キャンペーンID | |
AdGroupID | Long | 広告グループID | |
KeywordID | Long | キーワードID | |
CampaignName | String | キャンペーン名 | |
AdGroupName | String | 広告グループ名 | |
SearchQuery | String | 検索クエリー | |
SearchQueryMatchType | String | 検索クエリーのマッチタイプ | |
Keyword | String | キーワード | |
Cost | Long | コスト | |
Impressions | Long | インプレッション数 | |
Clicks | Long | クリック数 | |
CTR | Double | クリック率 | |
Avg_CPC | Double | 平均CPC | |
TrackingURL | String | トラッキングURL | |
FinalURL | String | 最終リンク先URL | |
Conversions | Double | コンバージョン数 | |
Conv_Rate | Double | コンバージョン率 | |
Conv_Value | Double | コンバージョンの価値 | |
CostPerConv_ | Double | コスト / コンバージョン数 | |
ValuePerConv_ | Double | 価値 / コンバージョン数 | |
AllConv_ | Double | すべてのコンバージョン数 | |
AllConv_Rate | Double | すべてのコンバージョン率 | |
AllConv_Value | Double | すべてのコンバージョンの価値 | |
CostPerAllConv_ | Double | コスト / すべてのコンバージョン数 | |
ValuePerAllConv_ | Double | 価値 / すべてのコンバージョン数 | |
Conversionsacrossdevices | Double | デバイスをまたいだコンバージョン数 | |
CampaignTrackingID | Long | キャンペーントラッキングID | |
AdGroupTrackingID | Long | 広告グループトラッキングID | |
KeywordTrackingID | Long | キーワードトラッキングID | |
Showadson | String | 広告を表示する検索画面 | |
Device | String | デバイス | |
Day | String | 日 | |
Dayofweek | String | 曜日 | |
Quarter | String | 四半期 | |
Year | String | 年間 | |
Month | String | 毎月 | |
MonthofYear | String | 月 | |
Week | String | 毎週 | |
ObjectiveofConversionTracking | String | コンバージョン測定の目的 | |
ConversionName | String | コンバージョン名 | |
Searchabsolutetopimpressionrate | Double | インプレッションにおけるページ最上部の割合 | |
Searchtopimpressionrate | Double | インプレッションにおけるページ上部の割合 | |
Conv_ValuePerCost | Double | コンバージョンの価値 / コスト | |
AllConv_ValuePerCost | Double | すべてのコンバージョンの価値 / コスト | |
Keyword_NegativeKeyword | String | キーワード / 対象外キーワード登録状況 |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
ReportDateRangeType | String | レポートの集計対象期間
使用できる値は次のとおりです。TODAY, YESTERDAY, LAST_7_DAYS, LAST_WEEK, LAST_14_DAYS, LAST_30_DAYS, LAST_BUSINESS_WEEK, THIS_MONTH, THIS_MONTH_EXCEPT_TODAY, LAST_MONTH, ALL_TIME, CUSTOM_DATE, NO_RANGE | |
DateRangeStartDate | String | 集計開始日(yyyy-MM-dd) ReportDateRangeType='CUSTOM_DATE' のとき必須 | |
DateRangeEndDate | String | 集計終了日(yyyy-MM-dd) ReportDateRangeType='CUSTOM_DATE' のとき必須 |
To view the Webpage_criterion report. Simple Select statement will create and retrieve last 7 days report
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.
SELECT * FROM ReportSearchAdsWebpage_criterion WHERE AccountId = '125466' SELECT * FROM ReportSearchAdsWebpage_criterion WHERE AccountId = '125466' AND ReportJobId = '123456' SELECT * FROM ReportSearchAdsWebpage_criterion WHERE AccountId = '125466' AND ReportDateRangeType = 'LAST_7_DAYS' SELECT * FROM ReportSearchAdsWebpage_criterion WHERE AccountId = '125466' AND ReportDateRangeType = 'CUSTOM_DATE' and DateRangeStartDate = '2022-02-12' AND DateRangeEndDate = '2022-04-29'
Note: Since the Report is Dynamic, so the columns may vary depending upon the API.
Name | Type | References | Description |
ReportJobId | String | ReportJobId | |
AccountId | String | アカウントID | |
AccountName | String | アカウント名 | |
CampaignID | Long | キャンペーンID | |
AdGroupID | Long | 広告グループID | |
CampaignName | String | キャンペーン名 | |
AdGroupName | String | 広告グループ名 | |
Cost | Long | コスト | |
Impressions | Long | インプレッション数 | |
Clicks | Long | クリック数 | |
CTR | Double | クリック率 | |
Avg_CPC | Double | 平均CPC | |
BidAdjustment_ | Double | 入札価格調整率(%) | |
TargetpageID | Long | 対象ページID | |
Conversions | Double | コンバージョン数 | |
Conv_Rate | Double | コンバージョン率 | |
Conv_Value | Double | コンバージョンの価値 | |
CostPerConv_ | Double | コスト / コンバージョン数 | |
ValuePerConv_ | Double | 価値 / コンバージョン数 | |
AllConv_ | Double | すべてのコンバージョン数 | |
AllConv_Rate | Double | すべてのコンバージョン率 | |
AllConv_Value | Double | すべてのコンバージョンの価値 | |
CostPerAllConv_ | Double | コスト / すべてのコンバージョン数 | |
ValuePerAllConv_ | Double | 価値 / すべてのコンバージョン数 | |
Conversionsacrossdevices | Double | デバイスをまたいだコンバージョン数 | |
CampaignTrackingID | Long | キャンペーントラッキングID | |
AdGroupTrackingID | Long | 広告グループトラッキングID | |
TargetpagetrackingID | Long | 対象ページトラッキングID | |
Showadson | String | 広告を表示する検索画面 | |
ClickType | String | クリック種別 | |
Device | String | デバイス | |
Day | String | 日 | |
Dayofweek | String | 曜日 | |
Quarter | String | 四半期 | |
Year | String | 年間 | |
Month | String | 毎月 | |
MonthofYear | String | 月 | |
Week | String | 毎週 | |
ObjectiveofConversionTracking | String | コンバージョン測定の目的 | |
ConversionName | String | コンバージョン名 | |
Searchabsolutetopimpressionrate | Double | インプレッションにおけるページ最上部の割合 | |
Searchtopimpressionrate | Double | インプレッションにおけるページ上部の割合 | |
Conv_ValuePerCost | Double | コンバージョンの価値 / コスト | |
AllConv_ValuePerCost | Double | すべてのコンバージョンの価値 / コスト |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
ReportDateRangeType | String | レポートの集計対象期間
使用できる値は次のとおりです。TODAY, YESTERDAY, LAST_7_DAYS, LAST_WEEK, LAST_14_DAYS, LAST_30_DAYS, LAST_BUSINESS_WEEK, THIS_MONTH, THIS_MONTH_EXCEPT_TODAY, LAST_MONTH, ALL_TIME, CUSTOM_DATE, NO_RANGE | |
DateRangeStartDate | String | 集計開始日(yyyy-MM-dd) ReportDateRangeType='CUSTOM_DATE' のとき必須 | |
DateRangeEndDate | String | 集計終了日(yyyy-MM-dd) ReportDateRangeType='CUSTOM_DATE' のとき必須 |
Get account link information.
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.
For example:
SELECT * FROM SearchAdsAccountLinks WHERE MccAccountId = '1002513173' SELECT * FROM SearchAdsAccountLinks WHERE MccAccountId = '1002513173' AND AccountStatus IN ('INPROGRESS','WAIT_DECIDE')
Name | Type | References | Description |
MccAccountId [KEY] | Int64 | MCC Account ID. | |
AccountId | Int64 |
SearchAdsAccounts.AccountId | Account ID. |
OwnerShipType | String | Describes whether the linked account is an account within the same company. | |
AccountStatus | String | Displays the account registration status.
使用できる値は次のとおりです。INPROGRESS, WAIT_DECIDE, SUSPENDED, SERVING, ENDED, UNKNOWN |
Retrieve the details for AdGroupAd ResponsiveSearchAd Descriptions.The columns values set read-only false can be inserted in the parent table using Temp tables
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.
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')
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.
使用できる値は次のとおりです。EXTENDED_TEXT_AD, DYNAMIC_SEARCH_LINKED_AD, TEXT_AD2, APP_AD, RESPONSIVE_SEARCH_AD, UNKNOWN | |
ApprovalStatus | String | Displays Editorial Status.
使用できる値は次のとおりです。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.
使用できる値は次のとおりです。SPECIFIED, DESCRIPTION1, DESCRIPTION2, UNKNOWN | |
Text | String | Text of parameter. | |
ActiveStatus | String | Displays the availability of assets appears.
使用できる値は次のとおりです。ACTIVE, DEACTIVE, PENDING_REVIEW, PENDING_DELETE, UNKNOWN |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
ContainsLabel | String | Describes acquisition flag of label data.
使用できる値は次のとおりです。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. |
Retrieve the details of AdGroupAd ReponsiveSearchAd Headlines.The columns values set read-only false can be inserted in the parent table using Temp tables
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.
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');
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.
使用できる値は次のとおりです。EXTENDED_TEXT_AD, DYNAMIC_SEARCH_LINKED_AD, TEXT_AD2, APP_AD, RESPONSIVE_SEARCH_AD, UNKNOWN | |
ApprovalStatus | String | Displays Editorial Status.
使用できる値は次のとおりです。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.
使用できる値は次のとおりです。SPECIFIED, DESCRIPTION1, DESCRIPTION2, UNKNOWN | |
Text | String | Text of parameter. | |
ActiveStatus | String | Displays the availability of assets appears.
使用できる値は次のとおりです。ACTIVE, DEACTIVE, PENDING_REVIEW, PENDING_DELETE, UNKNOWN |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
ContainsLabel | String | Describes acquisition flag of label data.
使用できる値は次のとおりです。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. |
Retrieve the details of AdGroupAd Labels. The columns values set read-only false can be inserted in the parent table using Temp tables.
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.
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');
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.
使用できる値は次のとおりです。EXTENDED_TEXT_AD, DYNAMIC_SEARCH_LINKED_AD, TEXT_AD2, APP_AD, RESPONSIVE_SEARCH_AD, UNKNOWN | |
ApprovalStatus | String | Displays Editorial Status.
使用できる値は次のとおりです。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.
使用できる値は次のとおりです。ACTIVE, PAUSED, UNKNOWN | |
Color | String | Color. | |
Description | String | Description. | |
LabelName | String | Label name. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
ContainsLabel | String | Describes acquisition flag of label data.
使用できる値は次のとおりです。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. | |
ReferenceNumber | String | This column will be used in Bulk operations to get specific values from the Temp tables. |
Retrieve the details of AdGroup Labels
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.
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'
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.
使用できる値は次のとおりです。ACTIVE, PAUSED, UNKNOWN | |
Color | String | Color. | |
Description | String | Description | |
LabelName | String | Label Name |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
PortfolioBiddingIds | Int64 | Bidding Statery Ids. | |
ContainsLabel | 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. |
Retrieve the details of AuditLog EventSelector.The columns values set read-only false can be inserted in the parent table using Temp tables
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.
For example:
SELECT * FROM SearchAdsAuditLogEventSelector WHERE AccountId = '25687' SELECT * FROM SearchAdsAuditLogEventSelector WHERE AccountId = '23542' AND JobId = '456971'
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.
使用できる値は次のとおりです。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, ASSET, CAMPAIGN_ASSET, AD_GROUP_ASSET, ACCOUNT_CUSTOMIZER, CAMPAIGN_CUSTOMIZER, AD_GROUP_CUSTOMIZER, AD_GROUP_CRITERION_CUSTOMIZER, CUSTOMIZER_ATTRIBUTE, PAGE_FEED_ASSET_SET, PAGE_FEED_ASSET, BIDDING_SEASONALITY_ADJUSTMENT, CAMPAIGN_BUDGET, 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.
使用できる値は次のとおりです。SYSTEM_ERROR, IN_PROGRESS, COMPLETED, TIMEOUT, UNKNOWN |
Get the account balance.
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.
For example:
SELECT * FROM SearchAdsBalance WHERE AccountId = '25687'
Name | Type | References | Description |
AccountId [KEY] | Int64 |
SearchAdsAccounts.AccountId | Account ID. |
Balance | Int64 | Balance. |
Get lists of all accounts (MCC and ad accounts).
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.
For example:
SELECT * FROM SearchAdsBaseAccount SELECT * FROM SearchAdsBaseAccount WHERE AccountId = '1001987917' SELECT * FROM SearchAdsBaseAccount WHERE AccountName = 'CData Software Japan 株式会社' SELECT * FROM SearchAdsBaseAccount WHERE IncludeMccAccount = 'ONLY_MCC'
Name | Type | References | Description |
AccountId [KEY] | Int64 |
SearchAdsAccounts.AccountId | Account ID. |
AccountName | String | Account name. | |
AccountStatus | String | Displays the account registration status. | |
AuthType | String | Access Roles. | |
HasAdminAuth | String | It indicates whether admin access is available for this account. | |
IsRootMccAccount | String | It indicates whether it is an root MCC account. | |
IsMccAccount | String | It indicates whether it is an MCC account. | |
IsTestAccount | String | It indicates whether it is a test account. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
IncludeAdminAuth | String | It indicates whether to include accounts with admin access for accounts you get.
使用できる値は次のとおりです。ONLY_ADMIN, EXCLUDE_ADMIN, UNKNOWN | |
IncludeMccAccount | String | It represents whether the account to be retrieved includes an MCC account.
使用できる値は次のとおりです。ONLY_MCC, ONLY_ROOT_MCC, ONLY_ADS_ACCOUNT, ALL, UNKNOWN | |
IncludeTestAccount | String | It represents whether the account to be retrieved includes an test account.
使用できる値は次のとおりです。ONLY_TEST, EXCLUDE_TEST, ALL, UNKNOWN |
Retrieve the details of Campaign Labels.The columns values set read-only false can be inserted in the parent table using Temp tables
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.
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 ContainsLabel = 'TRUE' SELECT * FROM SearchAdsCampaignServiceLabels WHERE AccountId = '12346' AND MinBudgetAmount = '1' AND MaxBudgetAmount = '1000'
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.
使用できる値は次のとおりです。ACTIVE, PAUSED, UNKNOWN |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
ContainsLabel | String | acquisition flag of label data
使用できる値は次のとおりです。TRUE, FALSE, UNKNOWN | |
MinBudgetAmount | Int64 | Minimum value of the search range. | |
MaxBudgetAmount | Int64 | Maximum value of the search range. |
Retrive the details of campaign settings.The columns values set read-only false can be inserted in the parent table using Temp tables
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.
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 ContainsLabel = 'TRUE'
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.
使用できる値は次のとおりです。ACTIVE, PAUSED, UNKNOWN | |
DynamicAdsForSearchSettingDasUseUrlsType | String | DSA URL usage type.
使用できる値は次のとおりです。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.
使用できる値は次のとおりです。DONT_CARE, AREA_OF_INTENT, LOCATION_OF_PRESENCE, UNKNOWN デフォルト値はDONT_CAREです。 | |
GeoTargetTypeSettingPositiveGeoTargetType | String | Specifies Advanced Location options of Geo Targeting.
使用できる値は次のとおりです。DONT_CARE, AREA_OF_INTENT, LOCATION_OF_PRESENCE, UNKNOWN デフォルト値はDONT_CAREです。 | |
SettingType | String | Describes the setting information of Target on the campaign.
使用できる値は次のとおりです。GEO_TARGET_TYPE_SETTING, TARGET_LIST_SETTING, DYNAMIC_ADS_FOR_SEARCH_SETTING, UNKNOWN デフォルト値はGEO_TARGET_TYPE_SETTINGです。 | |
TargetingSettingTargetAll | String | Describes the setting of target(include) users on Site Retargeting.
使用できる値は次のとおりです。ACTIVE, DEACTIVE, UNKNOWN |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
ContainsLabel | String | acquisition flag of label data
使用できる値は次のとおりです。TRUE, FALSE, UNKNOWN | |
LabelId | Int64 | Label ID. | |
MinBudgetAmount | Int64 | Minimum value of the search range. | |
MaxBudgetAmount | Int64 | Maximum value of the search range. |
Get EditorialReason and recommended resolution list.
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.
For example:
SELECT * FROM SearchAdsDisapprovalReasons WHERE Lang = 'JA';
Name | Type | References | Description |
Description | String | Description of disapproval reason. | |
DisapprovalReasonCode | String | Editorial code. | |
Lang | String | DictionaryServiceLang is a language selection of the list.
使用できる値は次のとおりです。JA, EN, UNKNOWN | |
Recommendation | String | Recommended solution. | |
Title | String | Title of disapproval reason. |
Retrieves the details of FeedItem Scheduling Schedules.The columns values set read-only false can be inserted in the parent table using Temp tables
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.
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')
Name | Type | References | Description |
FeedItemId | Int64 | Feed Item ID. | |
AccountId | Int64 |
SearchAdsAccounts.AccountId | Account ID. |
ApprovalStatus | String | FeedItemServiceApprovalStatus displays Editorial Status.
使用できる値は次のとおりです。APPROVED, APPROVED_WITH_REVIEW, REVIEW, PRE_DISAPPROVED, POST_DISAPPROVED, UNKNOWN | |
FeedId | Int64 |
SearchAdsFeeds.FeedId | Feed ID. |
PlaceholderType | String | selects FeeItem information type.
使用できる値は次のとおりです。QUICKLINK, CALLEXTENSION, AD_CUSTOMIZER, CALLOUT, STRUCTURED_SNIPPET, UNKNOWN | |
DayOfWeek | String | A day of the week.
使用できる値は次のとおりです。MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY, UNKNOWN | |
StartMinute | String | Minutes of an hour.
使用できる値は次のとおりです。ZERO, FIFTEEN, THIRTY, FORTY_FIVE, UNKNOWN | |
EndMinute | String | Minutes of an hour.
使用できる値は次のとおりです。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. |
Retrieves the details of FeedItem FeedItemAttribute.The columns values set read-only false can be inserted in the parent table using Temp tables
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.
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')
Name | Type | References | Description |
FeedItemId | Int64 | Feed Item ID. | |
AccountId | Int64 |
SearchAdsAccounts.AccountId | Account ID. |
ApprovalStatus | String | FeedItemServiceApprovalStatus displays Editorial Status.
使用できる値は次のとおりです。APPROVED, APPROVED_WITH_REVIEW, REVIEW, PRE_DISAPPROVED, POST_DISAPPROVED, UNKNOWN | |
FeedId | Int64 |
SearchAdsFeeds.FeedId | Feed ID. |
PlaceholderType | String | selects FeeItem information type.
使用できる値は次のとおりです。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.
使用できる値は次のとおりです。TRUE, FALSE, UNKNOWN | |
PlaceholderField | String | Selects FeedItem information details.
使用できる値は次のとおりです。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. |
Retrieves the details of FeedItem FeedItemAttribute feedAttributeValues.The columns values set read-only false can be inserted in the parent table using Temp tables
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.
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')
Name | Type | References | Description |
FeedItemId | Int64 | Feed Item ID. | |
AccountId | Int64 |
SearchAdsAccounts.AccountId | Account ID. |
ApprovalStatus | String | FeedItemServiceApprovalStatus displays Editorial Status.
使用できる値は次のとおりです。APPROVED, APPROVED_WITH_REVIEW, REVIEW, PRE_DISAPPROVED, POST_DISAPPROVED, UNKNOWN | |
FeedId | Int64 |
SearchAdsFeeds.FeedId | Feed ID. |
PlaceholderType | String | selects FeeItem information type.
使用できる値は次のとおりです。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. |
Create, Read, Update or Delete the Feed (Data auto insertion) information.
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.
For example, the following queries are processed server side:
SELECT * FROM SearchAdsFeeds WHERE AccountId = '1234339' AND FeedId = '174849'
Name | Type | References | Description |
FeedId [KEY] | Int64 | Feed ID. | |
AccountId | Int64 |
SearchAdsAccounts.AccountId | Account ID. Not required by design change on editorials. |
Domain | String | Domain. | |
FeedAttribute | String | FeedServiceAttribute object contains the attribute of auto data insertion list. | |
FeedName | String | List name of Feed. | |
FeedTrackId | Int64 | Tracking ID of Feed. | |
PlaceholderType | String | FeedServicePlaceholderType (enum) object select the type of Feed Item information.
使用できる値は次のとおりです。AD_CUSTOMIZER, DYNAMIC_AD_FOR_SEARCH_PAGE_FEEDS, UNKNOWN |
Retrieves the details of Feed FeedAttributes.The columns values set read-only false can be inserted in the parent table using Temp tables
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.
For example:
SELECT * FROM SearchAdsFeedServiceFeedAttributes WHERE AccountId = '25687' SELECT * FROM SearchAdsFeedServiceFeedAttributes WHERE AccountId = '1234339' AND FeedAttributeId = '174849'
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.
使用できる値は次のとおりです。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.
使用できる値は次のとおりです。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 |
Get the information list of geo targeting.
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.
For example:
SELECT * FROM SearchAdsGeographicLocations WHERE Lang = 'JA'
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.
使用できる値は次のとおりです。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.
使用できる値は次のとおりです。JA, EN, UNKNOWN |
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
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.
SELECT * FROM SearchAdsReportFields WHERE ReportType = 'ACCOUNT'
Name | Type | References | Description |
ReportType | String | Displays a type of available report.
使用できる値は次のとおりです。ACCOUNT, CAMPAIGN, ADGROUP, AD, KEYWORDS, SEARCH_QUERY, GEO, FEED_ITEM, GEO_TARGET, SCHEDULE_TARGET, BID_STRATEGY, CAMPAIGN_TARGET_LIST, ADGROUP_TARGET_LIST, LANDING_PAGE_URL, KEYWORDLESSS_QUERY, WEBPAGE_CRITERION, BID_MODIFIER, CAMPAIGN_ASSET, ADGROUP_ASSET, RESPONSIVE_ADS_FOR_SEARCH_ASSET, CAMPAIGN_BUDGET, 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. | |
Filterable | Boolean | Indicate if use can filter the fields. | |
Selectable | Boolean | Indicate if user can select the fields. | |
ImpossibleCombinationFields | String | Report fields which cannot be combined. |
Retrieves the details of Report Filters.The columns values set read-only false can be inserted in the parent table using Temp tables
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.
For example:
SELECT * FROM SearchAdsReportFilters WHERE AccountId = '25687' SELECT * FROM SearchAdsReportFilters WHERE AccountId = '25687' AND ReportJobId = '5678'
Name | Type | References | Description |
AccountId | Int64 |
SearchAdsAccounts.AccountId | Account ID. |
ReportJobId | String | Report Job ID. | |
ReportJobStatus | String | A status of the requested report.
使用できる値は次のとおりです。WAIT, COMPLETED, IN_PROGRESS, FAILED, UNKNOWN | |
ReportType | String | Displays a type of available report.
使用できる値は次のとおりです。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.
使用できる値は次のとおりです。EQUALS, NOT_EQUALS, GREATER_THAN, GREATER_THAN_EQUALS, LESS_THAN, LESS_THAN_EQUALS, CONTAINS, IN, UNKNOWN | |
Values | String | Condition values to filter the field. |
Retrieve the sort details of report definition.The columns values set read-only false can be inserted in the parent table using Temp tables
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.
For example:
SELECT * FROM SearchAdsReportSortFields WHERE AccountId = '25687' SELECT * FROM SearchAdsReportSortFields WHERE AccountId = '25687' AND ReportJobId = '5678'
Name | Type | References | Description |
AccountId | Int64 |
SearchAdsAccounts.AccountId | Account ID. |
ReportJobId | String | Report Job ID. | |
ReportJobStatus | String | A status of the requested report.
使用できる値は次のとおりです。WAIT, COMPLETED, IN_PROGRESS, FAILED, UNKNOWN | |
ReportType | String | Displays a type of available report.
使用できる値は次のとおりです。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.
使用できる値は次のとおりです。ASC, DESC, UNKNOWN |
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
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.
For example:
SELECT * FROM SearchAdsRetargetingListLogicalGroupLogicalOperand WHERE AccountId = '125466' SELECT * FROM SearchAdsRetargetingListLogicalGroupLogicalOperand WHERE AccountId = '125466' AND TargetListId = '234234'
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.
使用できる値は次のとおりです。ONWER, SHARED, UNKNOWN | |
TargetListType | String | The type of target list.
使用できる値は次のとおりです。DEFAULT, RULE, LOGICAL, UNKNOWN |
Retrieve the details of RetargetingList LogicalTargetList LogicalGroup.The columns values set read-only false can be inserted in the parent table using Temp tables
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.
For example:
SELECT * FROM SearchAdsRetargetingListLogicalGroups WHERE AccountId = '125466' SELECT * FROM SearchAdsRetargetingListLogicalGroups WHERE AccountId = '125466' AND TargetListId = '234234'
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.
使用できる値は次のとおりです。ONWER, SHARED, UNKNOWN | |
TargetListType | String | The type of target list.
使用できる値は次のとおりです。DEFAULT, RULE, LOGICAL, UNKNOWN | |
LogicalCondition | String | Describes the conditions of combined target list.
使用できる値は次のとおりです。NOT, AND, OR, UNKNOWN | |
LogicalOperand | String | Object that holds target list of combination. |
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
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.
For example:
SELECT * FROM SearchAdsRetargetingListRuleBaseTargetListRuleRuleItems WHERE AccountId = '125466' SELECT * FROM SearchAdsRetargetingListRuleBaseTargetListRuleRuleItems WHERE AccountId = '125466' AND TargetListId = '234234'
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.
使用できる値は次のとおりです。ONWER, SHARED, UNKNOWN | |
TargetListType | String | The type of target list.
使用できる値は次のとおりです。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.
使用できる値は次のとおりです。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.
使用できる値は次のとおりです。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.
使用できる値は次のとおりです。URL, REFFER_URL, UNKNOWN | |
Value | String | Evaluation value. Cannot use: bracket, single quote, double quote, and tab. Can select up to 250 characters. |
Retrieves the details of RetargetingList RuleBaseTargetList Rules.The columns values set read-only false can be inserted in the parent table using Temp tables
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.
For example:
SELECT * FROM SearchAdsRetargetingListRuleBaseTargetListRules WHERE AccountId = '125466' SELECT * FROM SearchAdsRetargetingListRuleBaseTargetListRules WHERE AccountId = '125466' AND TargetListId = '234234'
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.
使用できる値は次のとおりです。ONWER, SHARED, UNKNOWN | |
TargetListType | String | The type of target list.
使用できる値は次のとおりです。DEFAULT, RULE, LOGICAL, UNKNOWN |
プロパティ | 説明 |
DisplayAdsAccountId | DisplayAds アカウントに関連付けられた一意の識別子。 |
SearchAdsAccountId | SearchAds アカウントに関連付けられた一意の識別子。 |
Language | レポート定義サービスReportLanguage は、定義されたカラム名の言語を提供します。 |
プロパティ | 説明 |
OAuthClientId | OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。 |
OAuthClientSecret | OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。 |
プロパティ | 説明 |
SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
プロパティ | 説明 |
FirewallType | プロキシベースのファイアウォールで使われるプロトコル。 |
FirewallServer | プロキシベースのファイアウォールの名前もしくはIP アドレス。 |
FirewallPort | プロキシベースのファイアウォールのTCP ポート。 |
FirewallUser | プロキシベースのファイアウォールに認証するために使うユーザー名。 |
FirewallPassword | プロキシベースのファイアウォールへの認証に使われるパスワード。 |
プロパティ | 説明 |
ProxyAutoDetect | これは、システムプロキシ設定を使用するかどうかを示します。 |
ProxyServer | HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。 |
ProxyPort | ProxyServer プロキシが起動しているTCP ポート。 |
ProxyAuthScheme | ProxyServer プロキシへの認証で使われる認証タイプ。 |
ProxyUser | ProxyServer プロキシへの認証に使われるユーザー名。 |
ProxyPassword | ProxyServer プロキシへの認証に使われるパスワード。 |
ProxySSLType | ProxyServer プロキシへの接続時に使用するSSL タイプ。 |
ProxyExceptions | ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
プロパティ | 説明 |
LogModules | ログファイルに含めるコアモジュール。 |
プロパティ | 説明 |
Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。 |
BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
Tables | このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。 |
Views | 使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。 |
プロパティ | 説明 |
MaxRows | クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。 |
Other | これらの隠しプロパティは特定のユースケースでのみ使用されます。 |
PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
UserDefinedViews | カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。 |
このセクションでは、本プロバイダーの接続文字列で設定可能なConnection プロパティの全リストを提供します。
プロパティ | 説明 |
DisplayAdsAccountId | DisplayAds アカウントに関連付けられた一意の識別子。 |
SearchAdsAccountId | SearchAds アカウントに関連付けられた一意の識別子。 |
Language | レポート定義サービスReportLanguage は、定義されたカラム名の言語を提供します。 |
DisplayAds アカウントに関連付けられた一意の識別子。
リクエストはこのアカウントのデータを返します。
DisplayAdsAccounts をクエリして、これを確認できます。
SELECT AccountId FROM DisplayAdsAccounts
SearchAds アカウントに関連付けられた一意の識別子。
リクエストはこのアカウントのデータを返します。
SearchAdsAccounts をクエリして、これを確認できます。
SELECT AccountId FROM SearchAdsAccounts
レポート定義サービスReportLanguage は、定義されたカラム名の言語を提供します。
このプロパティには次の値の一つを設定できます。
EN(デフォルト) | 英語 |
JA | 日本語 |
このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。
プロパティ | 説明 |
OAuthClientId | OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。 |
OAuthClientSecret | OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。 |
OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId 値、およびクライアントシークレットOAuthClientSecret が提供されます。
OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。
OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId が提供されます。また、コンシューマーシークレットと呼ばれるクライアントシークレットも提供されます。クライアントシークレットをOAuthClientSecret プロパティに設定します。
このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。
プロパティ | 説明 |
SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。
TLS/SSL 接続を使用する場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。コンピュータによって信頼されていない他の証明書はすべて拒否されます。
このプロパティは、次のフォームを取ります:
説明 | 例 |
フルPEM 証明書(例では省略されています) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
証明書を保有するローカルファイルへのパス。 | C:\cert.cer |
公開鍵(例では省略されています) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
MD5 Thumbprint (hex 値はスペースおよびコロン区切り) | ecadbdda5a1529c58a1e9e09828d70e4 |
SHA1 Thumbprint (hex 値はスペースおよびコロン区切り) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。
すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。
このセクションでは、本プロバイダーの接続文字列で設定可能なFirewall プロパティの全リストを提供します。
プロパティ | 説明 |
FirewallType | プロキシベースのファイアウォールで使われるプロトコル。 |
FirewallServer | プロキシベースのファイアウォールの名前もしくはIP アドレス。 |
FirewallPort | プロキシベースのファイアウォールのTCP ポート。 |
FirewallUser | プロキシベースのファイアウォールに認証するために使うユーザー名。 |
FirewallPassword | プロキシベースのファイアウォールへの認証に使われるパスワード。 |
プロキシベースのファイアウォールで使われるプロトコル。
このプロパティは、Sync App がFirewallServer プロキシ経由でトンネルトラフィックを使うためのプロトコルを指定します。デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し次のプロキシタイプのどれかで接続するには、ProxyAutoDetect をfalse に設定します。
タイプ | デフォルトポート | 説明 |
TUNNEL | 80 | これが設定されている場合、Sync App はYahoo! Ads への接続を開き、プロキシを経由して通信が行われます。 |
SOCKS4 | 1080 | これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 4 プロキシ経由で送信し、接続リクエストが許容されるかどうかを決定します。 |
SOCKS5 | 1080 | これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 5 プロキシ経由で送信します。プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。 |
HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthScheme、ProxyUser、およびProxyPassword を使ってください。
プロキシベースのファイアウォールの名前もしくはIP アドレス。
ファイアウォールトラバーサルを許容するために設定するIP アドレス、DNS 名、もしくはプロキシホスト名を指定するプロパティです。プロトコルはFirewallType で指定されます。このプロパティとFirewallServer を使って、SOCKS 経由での接続、もしくはトンネリングが可能です。HTTP プロキシへの接続には、ProxyServer を使用します。
Sync App はデフォルトでシステムプロキシを使うので注意してください。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定してください。
プロキシベースのファイアウォールのTCP ポート。
ファイアウォールトラバーサルを許容するために設定するプロキシベースのファイアウォールのTCP ポート。名前もしくはIP アドレスを指定するには、FirewallServer を使います。FirewallType でプロトコルを指定します。
プロキシベースのファイアウォールに認証するために使うユーザー名。
FirewallUser およびFirewallPassword プロパティは、FirewallType により指定された認証方式に則り、FirewallServer、およびFirewallPort で指定されたプロキシに対しての認証に使われます。
プロキシベースのファイアウォールへの認証に使われるパスワード。
このプロパティは、FirewallType により指定された認証メソッドに則り、FirewallServer およびFirewallPort で指定されたプロキシに渡されます。
このセクションでは、本プロバイダーの接続文字列で設定可能なProxy プロパティの全リストを提供します。
プロパティ | 説明 |
ProxyAutoDetect | これは、システムプロキシ設定を使用するかどうかを示します。 |
ProxyServer | HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。 |
ProxyPort | ProxyServer プロキシが起動しているTCP ポート。 |
ProxyAuthScheme | ProxyServer プロキシへの認証で使われる認証タイプ。 |
ProxyUser | ProxyServer プロキシへの認証に使われるユーザー名。 |
ProxyPassword | ProxyServer プロキシへの認証に使われるパスワード。 |
ProxySSLType | ProxyServer プロキシへの接続時に使用するSSL タイプ。 |
ProxyExceptions | ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
これは、システムプロキシ設定を使用するかどうかを示します。
これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。
HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。
HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。
HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。HTTP プロキシへの認証には、Sync App はHTTP、Windows(NTLM)、もしくはKerberos 認証タイプを使用することができます。
SOCKS プロキシを経由して接続する、もしくは接続をトンネルするには、FirewallType を参照してください。
デフォルトで、Sync App はsystem プロキシを使います。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定します。
ProxyServer プロキシが起動しているTCP ポート。
HTTP トラフィックをリダイレクトするHTTP プロキシが実行されているポート。ProxyServer でHTTP プロキシを指定します。その他のプロキシタイプについては、FirewallType を参照してください。
ProxyServer プロキシへの認証で使われる認証タイプ。
この値は、ProxyServer およびProxyPort で指定されるHTTP プロキシに認証するために使われる認証タイプを指定します。
Sync App は、デフォルトでsystem proxy settings を使い、追加での設定が不要です。他のプロキシへの接続をする場合には、ProxyServer およびProxyPort に加え、ProxyAutoDetect をfalse に設定します。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。
認証タイプは、次のどれかになります。
SOCKS 5 認証のような他の認証タイプを使用するには、FirewallType を参照してください。
ProxyServer プロキシへの認証に使われるユーザー名。
ProxyUser および ProxyPassword オプションは、ProxyServer で指定されたHTTP プロキシに対して接続および認証するために使用されます。
ProxyAuthScheme で使用可能な認証タイプを選択することができます。HTTP 認証を使う場合、これをHTTP プロキシで識別可能なユーザーのユーザー名に設定します。Windows もしくはKerberos 認証を使用する場合、このプロパティを次の形式のどれかでユーザー名に設定します。
user@domain domain\user
ProxyServer プロキシへの認証に使われるパスワード。
このプロパティは、NTLM(Windows)、Kerberos、もしくはHTTP 認証をサポートするHTTP プロキシサーバーに認証するために使われます。HTTP プロキシを指定するためには、ProxyServer およびProxyPort を設定します。認証タイプを指定するためにはProxyAuthScheme を設定します。
HTTP 認証を使う場合、さらにHTTP プロキシにProxyUser およびProxyPassword を設定します。
NTLM 認証を使う場合、Windows パスワードにProxyUser およびProxyPassword を設定します。Kerberos 認証には、これらを入力する必要があります。
SOCKS 5 認証もしくは、トンネリングは、FirewallType を参照してください。
デフォルトで、Sync App はsystem プロキシを使います。他のプロキシに接続する場合には、これをfalse に設定します。
ProxyServer プロキシへの接続時に使用するSSL タイプ。
このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この値は、AUTO、ALWAYS、NEVER、TUNNEL のいずれかです。有効な値は次のとおりです。
AUTO | デフォルト設定。URL がHTTPS URL の場合、Sync App は、TUNNEL オプションを使います。URL がHTTP URL の場合、コンポーネントはNEVER オプションを使います。 |
ALWAYS | 接続は、常にSSL 有効となります。 |
NEVER | 接続は、SSL 有効になりません。 |
TUNNEL | 接続は、トンネリングプロキシを経由します。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。 |
ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。
ProxyServer は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。
Sync App は、追加設定なしにデフォルトでシステムのプロキシ設定を使います。この接続のプロキシ例外を明示的に構成するには、ProxyAutoDetect をfalse に設定して、ProxyServer およびProxyPort を設定する必要があります。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。
ログファイルに含めるコアモジュール。
指定された(';' で区切られた)モジュールのみがログファイルに含まれます。デフォルトではすべてのモジュールが含まれます。
概要はログ ページを参照してください。
このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。
プロパティ | 説明 |
Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。 |
BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
Tables | このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。 |
Views | 使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。 |
テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。
Sync App のスキーマファイル(テーブルとビューの場合は.rsd ファイル、ストアドプロシージャの場合は.rsb ファイル)を含むディレクトリへのパス。このフォルダの場所は、実行ファイルの場所からの相対パスにすることができます。Location プロパティは、定義をカスタマイズしたり(例えば、カラム名を変更する、カラムを無視するなど)、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。
Note: このSync App は複数のスキーマをサポートするため、Yahoo! Ads カスタムスキーマファイルの構造は以下のようになります。
指定しない場合、デフォルトの場所は"%APPDATA%\\CData\\YahooAds Data Provider\\Schema" となり、%APPDATA% はユーザーのコンフィギュレーションディレクトリに設定されます:
Platform | %APPDATA% |
Windows | APPDATA 環境変数の値 |
Linux | ~/.config |
このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
スキーマをデータベースからリストすると、負荷がかかる可能性があります。接続文字列でスキーマのリストを提供すると、 パフォーマンスが向上します。
このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。
テーブルを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でテーブルのリストを提供すると、Sync App のパフォーマンスが向上します。
このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。
カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。
複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。
使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。
ビューを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でビューのリストを提供すると、Sync App のパフォーマンスが向上します。
このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。
カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。
複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。
このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。
プロパティ | 説明 |
MaxRows | クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。 |
Other | これらの隠しプロパティは特定のユースケースでのみ使用されます。 |
PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
UserDefinedViews | カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。 |
クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
これらの隠しプロパティは特定のユースケースでのみ使用されます。
以下にリストされているプロパティは、特定のユースケースで使用可能です。通常のドライバーのユースケースおよび機能では、これらのプロパティは必要ありません。
複数のプロパティをセミコロン区切りリストで指定します。
DefaultColumnSize | データソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。 |
ConvertDateTimeToGMT | 日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換するかどうかを決定します。 |
RecordToFile=filename | 基底のソケットデータ転送を指定のファイルに記録します。 |
このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
Entity Framework ではテーブルカラムでない疑似カラムに値を設定できないため、この設定はEntity Framework で特に便利です。この接続設定の値は、"Table1=Column1, Table1=Column2, Table2=Column3" の形式です。"*=*" のように"*" 文字を使用して、すべてのテーブルとすべてのカラムを含めることができます。
タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
Timeout が0に設定されている場合は、操作がタイムアウトしません。処理が正常に完了するか、エラー状態になるまで実行されます。
Timeout の有効期限が切れても処理が完了していない場合は、Sync App は例外をスローします。
カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。
ユーザー定義ビューは、UserDefinedViews.json というJSON 形式のコンフィギュレーションファイルで定義されています。Sync App は、このファイルで指定されたビューを自動的に検出します。
また、複数のビュー定義を持ち、UserDefinedViews 接続プロパティを使用して制御することも可能です。このプロパティを使用すると、指定されたビューのみがSync App によって検知されます。
このユーザー定義ビューのコンフィギュレーションファイルは、次のようにフォーマットされています。
次に例を示します。
{ "MyView": { "query": "SELECT * FROM [YahooAds].[SearchAds].SearchAdsAdGroups WHERE MyColumn = 'value'" }, "MyView2": { "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)" } }UserDefinedViews 接続プロパティを使用して、JSON コンフィギュレーションファイルの場所を指定します。次に例を示します。
"UserDefinedViews", C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json指定されたパスは引用符で囲まれていないことに注意してください。